1 #ifndef _SCSI_SCSI_DEVICE_H
2 #define _SCSI_SCSI_DEVICE_H
4 #include <linux/list.h>
5 #include <linux/spinlock.h>
6 #include <linux/workqueue.h>
7 #include <linux/blkdev.h>
9 #include <linux/atomic.h>
15 struct scsi_sense_hdr
;
17 struct scsi_mode_data
{
19 __u16 block_descriptor_length
;
27 * sdev state: If you alter this, you also need to alter scsi_sysfs.c
28 * (for the ascii descriptions) and the state model enforcer:
29 * scsi_lib:scsi_device_set_state().
31 enum scsi_device_state
{
32 SDEV_CREATED
= 1, /* device created but not added to sysfs
33 * Only internal commands allowed (for inq) */
34 SDEV_RUNNING
, /* device properly configured
35 * All commands allowed */
36 SDEV_CANCEL
, /* beginning to delete device
37 * Only error handler commands allowed */
38 SDEV_DEL
, /* device deleted
39 * no commands allowed */
40 SDEV_QUIESCE
, /* Device quiescent. No block commands
41 * will be accepted, only specials (which
42 * originate in the mid-layer) */
43 SDEV_OFFLINE
, /* Device offlined (by error handling or
45 SDEV_TRANSPORT_OFFLINE
, /* Offlined by transport class error handler */
46 SDEV_BLOCK
, /* Device blocked by scsi lld. No
47 * scsi commands from user or midlayer
48 * should be issued to the scsi
50 SDEV_CREATED_BLOCK
, /* same as above but for created devices */
54 SCSI_SCAN_INITIAL
= 0,
59 enum scsi_device_event
{
60 SDEV_EVT_MEDIA_CHANGE
= 1, /* media has changed */
61 SDEV_EVT_INQUIRY_CHANGE_REPORTED
, /* 3F 03 UA reported */
62 SDEV_EVT_CAPACITY_CHANGE_REPORTED
, /* 2A 09 UA reported */
63 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED
, /* 38 07 UA reported */
64 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED
, /* 2A 01 UA reported */
65 SDEV_EVT_LUN_CHANGE_REPORTED
, /* 3F 0E UA reported */
66 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED
, /* 2A 06 UA reported */
68 SDEV_EVT_FIRST
= SDEV_EVT_MEDIA_CHANGE
,
69 SDEV_EVT_LAST
= SDEV_EVT_ALUA_STATE_CHANGE_REPORTED
,
71 SDEV_EVT_MAXBITS
= SDEV_EVT_LAST
+ 1
75 enum scsi_device_event evt_type
;
76 struct list_head node
;
78 /* put union of data structures, for non-simple event types,
84 struct Scsi_Host
*host
;
85 struct request_queue
*request_queue
;
87 /* the next two are protected by the host->host_lock */
88 struct list_head siblings
; /* list of all devices on this host */
89 struct list_head same_target_siblings
; /* just the devices sharing same target id */
91 atomic_t device_busy
; /* commands actually active on LLDD */
92 atomic_t device_blocked
; /* Device returned QUEUE_FULL. */
95 struct list_head cmd_list
; /* queue of in use SCSI Command structures */
96 struct list_head starved_entry
;
97 struct scsi_cmnd
*current_cmnd
; /* currently active command */
98 unsigned short queue_depth
; /* How deep of a queue we want */
99 unsigned short max_queue_depth
; /* max queue depth */
100 unsigned short last_queue_full_depth
; /* These two are used by */
101 unsigned short last_queue_full_count
; /* scsi_track_queue_full() */
102 unsigned long last_queue_full_time
; /* last queue full time */
103 unsigned long queue_ramp_up_period
; /* ramp up period in jiffies */
104 #define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
106 unsigned long last_queue_ramp_up
; /* last queue ramp up time */
108 unsigned int id
, channel
;
110 unsigned int manufacturer
; /* Manufacturer of device, for using
111 * vendor-specific cmd's */
112 unsigned sector_size
; /* size in bytes */
114 void *hostdata
; /* available to low-level driver */
117 char inq_periph_qual
; /* PQ from INQUIRY data */
118 struct mutex inquiry_mutex
;
119 unsigned char inquiry_len
; /* valid bytes in 'inquiry' */
120 unsigned char * inquiry
; /* INQUIRY response data */
121 const char * vendor
; /* [back_compat] point into 'inquiry' ... */
122 const char * model
; /* ... after scan; point to static string */
123 const char * rev
; /* ... "nullnullnullnull" before scan */
125 #define SCSI_VPD_PG_LEN 255
127 unsigned char __rcu
*vpd_pg83
;
129 unsigned char __rcu
*vpd_pg80
;
130 unsigned char current_tag
; /* current tag */
131 struct scsi_target
*sdev_target
; /* used only for single_lun */
133 unsigned int sdev_bflags
; /* black/white flags as also found in
134 * scsi_devinfo.[hc]. For now used only to
135 * pass settings from slave_alloc to scsi
137 unsigned int eh_timeout
; /* Error handling timeout */
138 unsigned removable
:1;
139 unsigned changed
:1; /* Data invalid due to media change */
140 unsigned busy
:1; /* Used to prevent races */
141 unsigned lockable
:1; /* Able to prevent media removal */
142 unsigned locked
:1; /* Media removal disabled */
143 unsigned borken
:1; /* Tell the Seagate driver to be
144 * painfully slow on this device */
145 unsigned disconnect
:1; /* can disconnect */
146 unsigned soft_reset
:1; /* Uses soft reset option */
147 unsigned sdtr
:1; /* Device supports SDTR messages */
148 unsigned wdtr
:1; /* Device supports WDTR messages */
149 unsigned ppr
:1; /* Device supports PPR messages */
150 unsigned tagged_supported
:1; /* Supports SCSI-II tagged queuing */
151 unsigned simple_tags
:1; /* simple queue tag messages are enabled */
152 unsigned was_reset
:1; /* There was a bus reset on the bus for
154 unsigned expecting_cc_ua
:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
155 * because we did a bus reset. */
156 unsigned use_10_for_rw
:1; /* first try 10-byte read / write */
157 unsigned use_10_for_ms
:1; /* first try 10-byte mode sense/select */
158 unsigned no_report_opcodes
:1; /* no REPORT SUPPORTED OPERATION CODES */
159 unsigned no_write_same
:1; /* no WRITE SAME command */
160 unsigned use_16_for_rw
:1; /* Use read/write(16) over read/write(10) */
161 unsigned skip_ms_page_8
:1; /* do not use MODE SENSE page 0x08 */
162 unsigned skip_ms_page_3f
:1; /* do not use MODE SENSE page 0x3f */
163 unsigned skip_vpd_pages
:1; /* do not read VPD pages */
164 unsigned try_vpd_pages
:1; /* attempt to read VPD pages */
165 unsigned use_192_bytes_for_3f
:1; /* ask for 192 bytes from page 0x3f */
166 unsigned no_start_on_add
:1; /* do not issue start on add */
167 unsigned allow_restart
:1; /* issue START_UNIT in error handler */
168 unsigned manage_start_stop
:1; /* Let HLD (sd) manage start/stop */
169 unsigned start_stop_pwr_cond
:1; /* Set power cond. in START_STOP_UNIT */
170 unsigned no_uld_attach
:1; /* disable connecting to upper level drivers */
171 unsigned select_no_atn
:1;
172 unsigned fix_capacity
:1; /* READ_CAPACITY is too high by 1 */
173 unsigned guess_capacity
:1; /* READ_CAPACITY might be too high by 1 */
174 unsigned retry_hwerror
:1; /* Retry HARDWARE_ERROR */
175 unsigned last_sector_bug
:1; /* do not use multisector accesses on
176 SD_LAST_BUGGY_SECTORS */
177 unsigned no_read_disc_info
:1; /* Avoid READ_DISC_INFO cmds */
178 unsigned no_read_capacity_16
:1; /* Avoid READ_CAPACITY_16 cmds */
179 unsigned try_rc_10_first
:1; /* Try READ_CAPACACITY_10 first */
180 unsigned is_visible
:1; /* is the device visible in sysfs */
181 unsigned wce_default_on
:1; /* Cache is ON by default */
182 unsigned no_dif
:1; /* T10 PI (DIF) should be disabled */
183 unsigned broken_fua
:1; /* Don't set FUA bit */
184 unsigned lun_in_cdb
:1; /* Store LUN bits in CDB[1] */
185 unsigned synchronous_alua
:1; /* Synchronous ALUA commands */
187 atomic_t disk_events_disable_depth
; /* disable depth for disk events */
189 DECLARE_BITMAP(supported_events
, SDEV_EVT_MAXBITS
); /* supported events */
190 DECLARE_BITMAP(pending_events
, SDEV_EVT_MAXBITS
); /* pending events */
191 struct list_head event_list
; /* asserted events */
192 struct work_struct event_work
;
194 unsigned int max_device_blocked
; /* what device_blocked counts down from */
195 #define SCSI_DEFAULT_DEVICE_BLOCKED 3
197 atomic_t iorequest_cnt
;
201 struct device sdev_gendev
,
204 struct execute_work ew
; /* used to get process context on put */
205 struct work_struct requeue_work
;
207 struct scsi_device_handler
*handler
;
210 unsigned char access_state
;
211 enum scsi_device_state sdev_state
;
212 unsigned long sdev_data
[0];
213 } __attribute__((aligned(sizeof(unsigned long))));
215 #define to_scsi_device(d) \
216 container_of(d, struct scsi_device, sdev_gendev)
217 #define class_to_sdev(d) \
218 container_of(d, struct scsi_device, sdev_dev)
219 #define transport_class_to_sdev(class_dev) \
220 to_scsi_device(class_dev->parent)
222 #define sdev_dbg(sdev, fmt, a...) \
223 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
226 * like scmd_printk, but the device name is passed in
227 * as a string pointer
230 sdev_prefix_printk(const char *, const struct scsi_device
*, const char *,
233 #define sdev_printk(l, sdev, fmt, a...) \
234 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
237 scmd_printk(const char *, const struct scsi_cmnd
*, const char *, ...);
239 #define scmd_dbg(scmd, fmt, a...) \
241 if ((scmd)->request->rq_disk) \
242 sdev_dbg((scmd)->device, "[%s] " fmt, \
243 (scmd)->request->rq_disk->disk_name, ##a);\
245 sdev_dbg((scmd)->device, fmt, ##a); \
248 enum scsi_target_state
{
256 * scsi_target: representation of a scsi target, for now, this is only
257 * used for single_lun devices. If no one has active IO to the target,
258 * starget_sdev_user is NULL, else it points to the active sdev.
261 struct scsi_device
*starget_sdev_user
;
262 struct list_head siblings
;
263 struct list_head devices
;
265 struct kref reap_ref
; /* last put renders target invisible */
266 unsigned int channel
;
267 unsigned int id
; /* target id ... replace
268 * scsi_device.id eventually */
269 unsigned int create
:1; /* signal that it needs to be added */
270 unsigned int single_lun
:1; /* Indicates we should only
271 * allow I/O to one of the luns
272 * for the device at a time. */
273 unsigned int pdt_1f_for_no_lun
:1; /* PDT = 0x1f
274 * means no lun present. */
275 unsigned int no_report_luns
:1; /* Don't use
276 * REPORT LUNS for scanning. */
277 unsigned int expecting_lun_change
:1; /* A device has reported
278 * a 3F/0E UA, other devices on
279 * the same target will also. */
280 /* commands actually active on LLD. */
281 atomic_t target_busy
;
282 atomic_t target_blocked
;
285 * LLDs should set this in the slave_alloc host template callout.
286 * If set to zero then there is not limit.
288 unsigned int can_queue
;
289 unsigned int max_target_blocked
;
290 #define SCSI_DEFAULT_TARGET_BLOCKED 3
293 enum scsi_target_state state
;
294 void *hostdata
; /* available to low-level driver */
295 unsigned long starget_data
[0]; /* for the transport */
296 /* starget_data must be the last element!!!! */
297 } __attribute__((aligned(sizeof(unsigned long))));
299 #define to_scsi_target(d) container_of(d, struct scsi_target, dev)
300 static inline struct scsi_target
*scsi_target(struct scsi_device
*sdev
)
302 return to_scsi_target(sdev
->sdev_gendev
.parent
);
304 #define transport_class_to_starget(class_dev) \
305 to_scsi_target(class_dev->parent)
307 #define starget_printk(prefix, starget, fmt, a...) \
308 dev_printk(prefix, &(starget)->dev, fmt, ##a)
310 extern struct scsi_device
*__scsi_add_device(struct Scsi_Host
*,
311 uint
, uint
, u64
, void *hostdata
);
312 extern int scsi_add_device(struct Scsi_Host
*host
, uint channel
,
313 uint target
, u64 lun
);
314 extern int scsi_register_device_handler(struct scsi_device_handler
*scsi_dh
);
315 extern void scsi_remove_device(struct scsi_device
*);
316 extern int scsi_unregister_device_handler(struct scsi_device_handler
*scsi_dh
);
317 void scsi_attach_vpd(struct scsi_device
*sdev
);
319 extern int scsi_device_get(struct scsi_device
*);
320 extern void scsi_device_put(struct scsi_device
*);
321 extern struct scsi_device
*scsi_device_lookup(struct Scsi_Host
*,
323 extern struct scsi_device
*__scsi_device_lookup(struct Scsi_Host
*,
325 extern struct scsi_device
*scsi_device_lookup_by_target(struct scsi_target
*,
327 extern struct scsi_device
*__scsi_device_lookup_by_target(struct scsi_target
*,
329 extern void starget_for_each_device(struct scsi_target
*, void *,
330 void (*fn
)(struct scsi_device
*, void *));
331 extern void __starget_for_each_device(struct scsi_target
*, void *,
332 void (*fn
)(struct scsi_device
*,
335 /* only exposed to implement shost_for_each_device */
336 extern struct scsi_device
*__scsi_iterate_devices(struct Scsi_Host
*,
337 struct scsi_device
*);
340 * shost_for_each_device - iterate over all devices of a host
341 * @sdev: the &struct scsi_device to use as a cursor
342 * @shost: the &struct scsi_host to iterate over
344 * Iterator that returns each device attached to @shost. This loop
345 * takes a reference on each device and releases it at the end. If
346 * you break out of the loop, you must call scsi_device_put(sdev).
348 #define shost_for_each_device(sdev, shost) \
349 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
351 (sdev) = __scsi_iterate_devices((shost), (sdev)))
354 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
355 * @sdev: the &struct scsi_device to use as a cursor
356 * @shost: the &struct scsi_host to iterate over
358 * Iterator that returns each device attached to @shost. It does _not_
359 * take a reference on the scsi_device, so the whole loop must be
360 * protected by shost->host_lock.
362 * Note: The only reason to use this is because you need to access the
363 * device list in interrupt context. Otherwise you really want to use
364 * shost_for_each_device instead.
366 #define __shost_for_each_device(sdev, shost) \
367 list_for_each_entry((sdev), &((shost)->__devices), siblings)
369 extern int scsi_change_queue_depth(struct scsi_device
*, int);
370 extern int scsi_track_queue_full(struct scsi_device
*, int);
372 extern int scsi_set_medium_removal(struct scsi_device
*, char);
374 extern int scsi_mode_sense(struct scsi_device
*sdev
, int dbd
, int modepage
,
375 unsigned char *buffer
, int len
, int timeout
,
376 int retries
, struct scsi_mode_data
*data
,
377 struct scsi_sense_hdr
*);
378 extern int scsi_mode_select(struct scsi_device
*sdev
, int pf
, int sp
,
379 int modepage
, unsigned char *buffer
, int len
,
380 int timeout
, int retries
,
381 struct scsi_mode_data
*data
,
382 struct scsi_sense_hdr
*);
383 extern int scsi_test_unit_ready(struct scsi_device
*sdev
, int timeout
,
384 int retries
, struct scsi_sense_hdr
*sshdr
);
385 extern int scsi_get_vpd_page(struct scsi_device
*, u8 page
, unsigned char *buf
,
387 extern int scsi_report_opcode(struct scsi_device
*sdev
, unsigned char *buffer
,
388 unsigned int len
, unsigned char opcode
);
389 extern int scsi_device_set_state(struct scsi_device
*sdev
,
390 enum scsi_device_state state
);
391 extern struct scsi_event
*sdev_evt_alloc(enum scsi_device_event evt_type
,
393 extern void sdev_evt_send(struct scsi_device
*sdev
, struct scsi_event
*evt
);
394 extern void sdev_evt_send_simple(struct scsi_device
*sdev
,
395 enum scsi_device_event evt_type
, gfp_t gfpflags
);
396 extern int scsi_device_quiesce(struct scsi_device
*sdev
);
397 extern void scsi_device_resume(struct scsi_device
*sdev
);
398 extern void scsi_target_quiesce(struct scsi_target
*);
399 extern void scsi_target_resume(struct scsi_target
*);
400 extern void scsi_scan_target(struct device
*parent
, unsigned int channel
,
401 unsigned int id
, u64 lun
,
402 enum scsi_scan_mode rescan
);
403 extern void scsi_target_reap(struct scsi_target
*);
404 extern void scsi_target_block(struct device
*);
405 extern void scsi_target_unblock(struct device
*, enum scsi_device_state
);
406 extern void scsi_remove_target(struct device
*);
407 extern const char *scsi_device_state_name(enum scsi_device_state
);
408 extern int scsi_is_sdev_device(const struct device
*);
409 extern int scsi_is_target_device(const struct device
*);
410 extern void scsi_sanitize_inquiry_string(unsigned char *s
, int len
);
411 extern int scsi_execute(struct scsi_device
*sdev
, const unsigned char *cmd
,
412 int data_direction
, void *buffer
, unsigned bufflen
,
413 unsigned char *sense
, int timeout
, int retries
,
414 u64 flags
, int *resid
);
415 extern int scsi_execute_req_flags(struct scsi_device
*sdev
,
416 const unsigned char *cmd
, int data_direction
, void *buffer
,
417 unsigned bufflen
, struct scsi_sense_hdr
*sshdr
, int timeout
,
418 int retries
, int *resid
, u64 flags
);
419 static inline int scsi_execute_req(struct scsi_device
*sdev
,
420 const unsigned char *cmd
, int data_direction
, void *buffer
,
421 unsigned bufflen
, struct scsi_sense_hdr
*sshdr
, int timeout
,
422 int retries
, int *resid
)
424 return scsi_execute_req_flags(sdev
, cmd
, data_direction
, buffer
,
425 bufflen
, sshdr
, timeout
, retries
, resid
, 0);
427 extern void sdev_disable_disk_events(struct scsi_device
*sdev
);
428 extern void sdev_enable_disk_events(struct scsi_device
*sdev
);
429 extern int scsi_vpd_lun_id(struct scsi_device
*, char *, size_t);
430 extern int scsi_vpd_tpg_id(struct scsi_device
*, int *);
433 extern int scsi_autopm_get_device(struct scsi_device
*);
434 extern void scsi_autopm_put_device(struct scsi_device
*);
436 static inline int scsi_autopm_get_device(struct scsi_device
*d
) { return 0; }
437 static inline void scsi_autopm_put_device(struct scsi_device
*d
) {}
438 #endif /* CONFIG_PM */
440 static inline int __must_check
scsi_device_reprobe(struct scsi_device
*sdev
)
442 return device_reprobe(&sdev
->sdev_gendev
);
445 static inline unsigned int sdev_channel(struct scsi_device
*sdev
)
447 return sdev
->channel
;
450 static inline unsigned int sdev_id(struct scsi_device
*sdev
)
455 #define scmd_id(scmd) sdev_id((scmd)->device)
456 #define scmd_channel(scmd) sdev_channel((scmd)->device)
459 * checks for positions of the SCSI state machine
461 static inline int scsi_device_online(struct scsi_device
*sdev
)
463 return (sdev
->sdev_state
!= SDEV_OFFLINE
&&
464 sdev
->sdev_state
!= SDEV_TRANSPORT_OFFLINE
&&
465 sdev
->sdev_state
!= SDEV_DEL
);
467 static inline int scsi_device_blocked(struct scsi_device
*sdev
)
469 return sdev
->sdev_state
== SDEV_BLOCK
||
470 sdev
->sdev_state
== SDEV_CREATED_BLOCK
;
472 static inline int scsi_device_created(struct scsi_device
*sdev
)
474 return sdev
->sdev_state
== SDEV_CREATED
||
475 sdev
->sdev_state
== SDEV_CREATED_BLOCK
;
478 /* accessor functions for the SCSI parameters */
479 static inline int scsi_device_sync(struct scsi_device
*sdev
)
483 static inline int scsi_device_wide(struct scsi_device
*sdev
)
487 static inline int scsi_device_dt(struct scsi_device
*sdev
)
491 static inline int scsi_device_dt_only(struct scsi_device
*sdev
)
493 if (sdev
->inquiry_len
< 57)
495 return (sdev
->inquiry
[56] & 0x0c) == 0x04;
497 static inline int scsi_device_ius(struct scsi_device
*sdev
)
499 if (sdev
->inquiry_len
< 57)
501 return sdev
->inquiry
[56] & 0x01;
503 static inline int scsi_device_qas(struct scsi_device
*sdev
)
505 if (sdev
->inquiry_len
< 57)
507 return sdev
->inquiry
[56] & 0x02;
509 static inline int scsi_device_enclosure(struct scsi_device
*sdev
)
511 return sdev
->inquiry
? (sdev
->inquiry
[6] & (1<<6)) : 1;
514 static inline int scsi_device_protection(struct scsi_device
*sdev
)
519 return sdev
->scsi_level
> SCSI_2
&& sdev
->inquiry
[5] & (1<<0);
522 static inline int scsi_device_tpgs(struct scsi_device
*sdev
)
524 return sdev
->inquiry
? (sdev
->inquiry
[5] >> 4) & 0x3 : 0;
528 * scsi_device_supports_vpd - test if a device supports VPD pages
529 * @sdev: the &struct scsi_device to test
531 * If the 'try_vpd_pages' flag is set it takes precedence.
532 * Otherwise we will assume VPD pages are supported if the
533 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
535 static inline int scsi_device_supports_vpd(struct scsi_device
*sdev
)
537 /* Attempt VPD inquiry if the device blacklist explicitly calls
540 if (sdev
->try_vpd_pages
)
543 * Although VPD inquiries can go to SCSI-2 type devices,
544 * some USB ones crash on receiving them, and the pages
545 * we currently ask for are mandatory for SPC-2 and beyond
547 if (sdev
->scsi_level
>= SCSI_SPC_2
&& !sdev
->skip_vpd_pages
)
552 #define MODULE_ALIAS_SCSI_DEVICE(type) \
553 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
554 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
556 #endif /* _SCSI_SCSI_DEVICE_H */