1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _SCSI_SCSI_DEVICE_H
3 #define _SCSI_SCSI_DEVICE_H
5 #include <linux/list.h>
6 #include <linux/spinlock.h>
7 #include <linux/workqueue.h>
8 #include <linux/blkdev.h>
10 #include <linux/atomic.h>
11 #include <linux/sbitmap.h>
18 struct scsi_sense_hdr;
20 typedef __u64 __bitwise blist_flags_t;
22 #define SCSI_SENSE_BUFFERSIZE 96
24 struct scsi_mode_data {
26 __u16 block_descriptor_length;
34 * sdev state: If you alter this, you also need to alter scsi_sysfs.c
35 * (for the ascii descriptions) and the state model enforcer:
36 * scsi_lib:scsi_device_set_state().
38 enum scsi_device_state {
39 SDEV_CREATED = 1, /* device created but not added to sysfs
40 * Only internal commands allowed (for inq) */
41 SDEV_RUNNING, /* device properly configured
42 * All commands allowed */
43 SDEV_CANCEL, /* beginning to delete device
44 * Only error handler commands allowed */
45 SDEV_DEL, /* device deleted
46 * no commands allowed */
47 SDEV_QUIESCE, /* Device quiescent. No block commands
48 * will be accepted, only specials (which
49 * originate in the mid-layer) */
50 SDEV_OFFLINE, /* Device offlined (by error handling or
52 SDEV_TRANSPORT_OFFLINE, /* Offlined by transport class error handler */
53 SDEV_BLOCK, /* Device blocked by scsi lld. No
54 * scsi commands from user or midlayer
55 * should be issued to the scsi
57 SDEV_CREATED_BLOCK, /* same as above but for created devices */
61 SCSI_SCAN_INITIAL = 0,
66 enum scsi_device_event {
67 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
68 SDEV_EVT_INQUIRY_CHANGE_REPORTED, /* 3F 03 UA reported */
69 SDEV_EVT_CAPACITY_CHANGE_REPORTED, /* 2A 09 UA reported */
70 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED, /* 38 07 UA reported */
71 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED, /* 2A 01 UA reported */
72 SDEV_EVT_LUN_CHANGE_REPORTED, /* 3F 0E UA reported */
73 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, /* 2A 06 UA reported */
74 SDEV_EVT_POWER_ON_RESET_OCCURRED, /* 29 00 UA reported */
76 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE,
77 SDEV_EVT_LAST = SDEV_EVT_POWER_ON_RESET_OCCURRED,
79 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
83 enum scsi_device_event evt_type;
84 struct list_head node;
86 /* put union of data structures, for non-simple event types,
92 * struct scsi_vpd - SCSI Vital Product Data
93 * @rcu: For kfree_rcu().
94 * @len: Length in bytes of @data.
95 * @data: VPD data as defined in various T10 SCSI standard documents.
100 unsigned char data[];
104 struct Scsi_Host *host;
105 struct request_queue *request_queue;
107 /* the next two are protected by the host->host_lock */
108 struct list_head siblings; /* list of all devices on this host */
109 struct list_head same_target_siblings; /* just the devices sharing same target id */
111 struct sbitmap budget_map;
112 atomic_t device_blocked; /* Device returned QUEUE_FULL. */
115 spinlock_t list_lock;
116 struct list_head starved_entry;
117 unsigned short queue_depth; /* How deep of a queue we want */
118 unsigned short max_queue_depth; /* max queue depth */
119 unsigned short last_queue_full_depth; /* These two are used by */
120 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
121 unsigned long last_queue_full_time; /* last queue full time */
122 unsigned long queue_ramp_up_period; /* ramp up period in jiffies */
123 #define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
125 unsigned long last_queue_ramp_up; /* last queue ramp up time */
127 unsigned int id, channel;
129 unsigned int manufacturer; /* Manufacturer of device, for using
130 * vendor-specific cmd's */
131 unsigned sector_size; /* size in bytes */
133 void *hostdata; /* available to low-level driver */
136 char inq_periph_qual; /* PQ from INQUIRY data */
137 struct mutex inquiry_mutex;
138 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
139 unsigned char * inquiry; /* INQUIRY response data */
140 const char * vendor; /* [back_compat] point into 'inquiry' ... */
141 const char * model; /* ... after scan; point to static string */
142 const char * rev; /* ... "nullnullnullnull" before scan */
144 #define SCSI_VPD_PG_LEN 255
145 struct scsi_vpd __rcu *vpd_pg0;
146 struct scsi_vpd __rcu *vpd_pg83;
147 struct scsi_vpd __rcu *vpd_pg80;
148 struct scsi_vpd __rcu *vpd_pg89;
149 struct scsi_target *sdev_target;
151 blist_flags_t sdev_bflags; /* black/white flags as also found in
152 * scsi_devinfo.[hc]. For now used only to
153 * pass settings from slave_alloc to scsi
155 unsigned int eh_timeout; /* Error handling timeout */
156 unsigned removable:1;
157 unsigned changed:1; /* Data invalid due to media change */
158 unsigned busy:1; /* Used to prevent races */
159 unsigned lockable:1; /* Able to prevent media removal */
160 unsigned locked:1; /* Media removal disabled */
161 unsigned borken:1; /* Tell the Seagate driver to be
162 * painfully slow on this device */
163 unsigned disconnect:1; /* can disconnect */
164 unsigned soft_reset:1; /* Uses soft reset option */
165 unsigned sdtr:1; /* Device supports SDTR messages */
166 unsigned wdtr:1; /* Device supports WDTR messages */
167 unsigned ppr:1; /* Device supports PPR messages */
168 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
169 unsigned simple_tags:1; /* simple queue tag messages are enabled */
170 unsigned was_reset:1; /* There was a bus reset on the bus for
172 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
173 * because we did a bus reset. */
174 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
175 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
176 unsigned set_dbd_for_ms:1; /* Set "DBD" field in mode sense */
177 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
178 unsigned no_write_same:1; /* no WRITE SAME command */
179 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
180 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
181 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
182 unsigned skip_vpd_pages:1; /* do not read VPD pages */
183 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
184 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
185 unsigned no_start_on_add:1; /* do not issue start on add */
186 unsigned allow_restart:1; /* issue START_UNIT in error handler */
187 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
188 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
189 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
190 unsigned select_no_atn:1;
191 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
192 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
193 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
194 unsigned last_sector_bug:1; /* do not use multisector accesses on
195 SD_LAST_BUGGY_SECTORS */
196 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
197 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
198 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
199 unsigned security_supported:1; /* Supports Security Protocols */
200 unsigned is_visible:1; /* is the device visible in sysfs */
201 unsigned wce_default_on:1; /* Cache is ON by default */
202 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
203 unsigned broken_fua:1; /* Don't set FUA bit */
204 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
205 unsigned unmap_limit_for_ws:1; /* Use the UNMAP limit for WRITE SAME */
206 unsigned rpm_autosuspend:1; /* Enable runtime autosuspend at device
208 unsigned ignore_media_change:1; /* Ignore MEDIA CHANGE on resume */
210 bool offline_already; /* Device offline message logged */
212 atomic_t disk_events_disable_depth; /* disable depth for disk events */
214 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
215 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
216 struct list_head event_list; /* asserted events */
217 struct work_struct event_work;
219 unsigned int max_device_blocked; /* what device_blocked counts down from */
220 #define SCSI_DEFAULT_DEVICE_BLOCKED 3
222 atomic_t iorequest_cnt;
226 struct device sdev_gendev,
229 struct execute_work ew; /* used to get process context on put */
230 struct work_struct requeue_work;
232 struct scsi_device_handler *handler;
235 size_t dma_drain_len;
238 unsigned int sg_timeout;
239 unsigned int sg_reserved_size;
241 struct bsg_device *bsg_dev;
242 unsigned char access_state;
243 struct mutex state_mutex;
244 enum scsi_device_state sdev_state;
245 struct task_struct *quiesced_by;
246 unsigned long sdev_data[];
247 } __attribute__((aligned(sizeof(unsigned long))));
249 #define to_scsi_device(d) \
250 container_of(d, struct scsi_device, sdev_gendev)
251 #define class_to_sdev(d) \
252 container_of(d, struct scsi_device, sdev_dev)
253 #define transport_class_to_sdev(class_dev) \
254 to_scsi_device(class_dev->parent)
256 #define sdev_dbg(sdev, fmt, a...) \
257 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
260 * like scmd_printk, but the device name is passed in
261 * as a string pointer
264 sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
267 #define sdev_printk(l, sdev, fmt, a...) \
268 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
271 scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...);
273 #define scmd_dbg(scmd, fmt, a...) \
275 struct request *__rq = scsi_cmd_to_rq((scmd)); \
278 sdev_dbg((scmd)->device, "[%s] " fmt, \
279 __rq->rq_disk->disk_name, ##a); \
281 sdev_dbg((scmd)->device, fmt, ##a); \
284 enum scsi_target_state {
288 STARGET_CREATED_REMOVE,
293 * scsi_target: representation of a scsi target, for now, this is only
294 * used for single_lun devices. If no one has active IO to the target,
295 * starget_sdev_user is NULL, else it points to the active sdev.
298 struct scsi_device *starget_sdev_user;
299 struct list_head siblings;
300 struct list_head devices;
302 struct kref reap_ref; /* last put renders target invisible */
303 unsigned int channel;
304 unsigned int id; /* target id ... replace
305 * scsi_device.id eventually */
306 unsigned int create:1; /* signal that it needs to be added */
307 unsigned int single_lun:1; /* Indicates we should only
308 * allow I/O to one of the luns
309 * for the device at a time. */
310 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f
311 * means no lun present. */
312 unsigned int no_report_luns:1; /* Don't use
313 * REPORT LUNS for scanning. */
314 unsigned int expecting_lun_change:1; /* A device has reported
315 * a 3F/0E UA, other devices on
316 * the same target will also. */
317 /* commands actually active on LLD. */
318 atomic_t target_busy;
319 atomic_t target_blocked;
322 * LLDs should set this in the slave_alloc host template callout.
323 * If set to zero then there is not limit.
325 unsigned int can_queue;
326 unsigned int max_target_blocked;
327 #define SCSI_DEFAULT_TARGET_BLOCKED 3
330 enum scsi_target_state state;
331 void *hostdata; /* available to low-level driver */
332 unsigned long starget_data[]; /* for the transport */
333 /* starget_data must be the last element!!!! */
334 } __attribute__((aligned(sizeof(unsigned long))));
336 #define to_scsi_target(d) container_of(d, struct scsi_target, dev)
337 static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
339 return to_scsi_target(sdev->sdev_gendev.parent);
341 #define transport_class_to_starget(class_dev) \
342 to_scsi_target(class_dev->parent)
344 #define starget_printk(prefix, starget, fmt, a...) \
345 dev_printk(prefix, &(starget)->dev, fmt, ##a)
347 extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
348 uint, uint, u64, void *hostdata);
349 extern int scsi_add_device(struct Scsi_Host *host, uint channel,
350 uint target, u64 lun);
351 extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
352 extern void scsi_remove_device(struct scsi_device *);
353 extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
354 void scsi_attach_vpd(struct scsi_device *sdev);
356 extern struct scsi_device *scsi_device_from_queue(struct request_queue *q);
357 extern int __must_check scsi_device_get(struct scsi_device *);
358 extern void scsi_device_put(struct scsi_device *);
359 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
361 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
363 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
365 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
367 extern void starget_for_each_device(struct scsi_target *, void *,
368 void (*fn)(struct scsi_device *, void *));
369 extern void __starget_for_each_device(struct scsi_target *, void *,
370 void (*fn)(struct scsi_device *,
373 /* only exposed to implement shost_for_each_device */
374 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
375 struct scsi_device *);
378 * shost_for_each_device - iterate over all devices of a host
379 * @sdev: the &struct scsi_device to use as a cursor
380 * @shost: the &struct scsi_host to iterate over
382 * Iterator that returns each device attached to @shost. This loop
383 * takes a reference on each device and releases it at the end. If
384 * you break out of the loop, you must call scsi_device_put(sdev).
386 #define shost_for_each_device(sdev, shost) \
387 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
389 (sdev) = __scsi_iterate_devices((shost), (sdev)))
392 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
393 * @sdev: the &struct scsi_device to use as a cursor
394 * @shost: the &struct scsi_host to iterate over
396 * Iterator that returns each device attached to @shost. It does _not_
397 * take a reference on the scsi_device, so the whole loop must be
398 * protected by shost->host_lock.
400 * Note: The only reason to use this is because you need to access the
401 * device list in interrupt context. Otherwise you really want to use
402 * shost_for_each_device instead.
404 #define __shost_for_each_device(sdev, shost) \
405 list_for_each_entry((sdev), &((shost)->__devices), siblings)
407 extern int scsi_change_queue_depth(struct scsi_device *, int);
408 extern int scsi_track_queue_full(struct scsi_device *, int);
410 extern int scsi_set_medium_removal(struct scsi_device *, char);
412 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
413 unsigned char *buffer, int len, int timeout,
414 int retries, struct scsi_mode_data *data,
415 struct scsi_sense_hdr *);
416 extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
417 int modepage, unsigned char *buffer, int len,
418 int timeout, int retries,
419 struct scsi_mode_data *data,
420 struct scsi_sense_hdr *);
421 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
422 int retries, struct scsi_sense_hdr *sshdr);
423 extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
425 extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
426 unsigned int len, unsigned char opcode);
427 extern int scsi_device_set_state(struct scsi_device *sdev,
428 enum scsi_device_state state);
429 extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
431 extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
432 extern void sdev_evt_send_simple(struct scsi_device *sdev,
433 enum scsi_device_event evt_type, gfp_t gfpflags);
434 extern int scsi_device_quiesce(struct scsi_device *sdev);
435 extern void scsi_device_resume(struct scsi_device *sdev);
436 extern void scsi_target_quiesce(struct scsi_target *);
437 extern void scsi_target_resume(struct scsi_target *);
438 extern void scsi_scan_target(struct device *parent, unsigned int channel,
439 unsigned int id, u64 lun,
440 enum scsi_scan_mode rescan);
441 extern void scsi_target_reap(struct scsi_target *);
442 extern void scsi_target_block(struct device *);
443 extern void scsi_target_unblock(struct device *, enum scsi_device_state);
444 extern void scsi_remove_target(struct device *);
445 extern const char *scsi_device_state_name(enum scsi_device_state);
446 extern int scsi_is_sdev_device(const struct device *);
447 extern int scsi_is_target_device(const struct device *);
448 extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
449 extern int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
450 int data_direction, void *buffer, unsigned bufflen,
451 unsigned char *sense, struct scsi_sense_hdr *sshdr,
452 int timeout, int retries, u64 flags,
453 req_flags_t rq_flags, int *resid);
454 /* Make sure any sense buffer is the correct size. */
455 #define scsi_execute(sdev, cmd, data_direction, buffer, bufflen, sense, \
456 sshdr, timeout, retries, flags, rq_flags, resid) \
458 BUILD_BUG_ON((sense) != NULL && \
459 sizeof(sense) != SCSI_SENSE_BUFFERSIZE); \
460 __scsi_execute(sdev, cmd, data_direction, buffer, bufflen, \
461 sense, sshdr, timeout, retries, flags, rq_flags, \
464 static inline int scsi_execute_req(struct scsi_device *sdev,
465 const unsigned char *cmd, int data_direction, void *buffer,
466 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
467 int retries, int *resid)
469 return scsi_execute(sdev, cmd, data_direction, buffer,
470 bufflen, NULL, sshdr, timeout, retries, 0, 0, resid);
472 extern void sdev_disable_disk_events(struct scsi_device *sdev);
473 extern void sdev_enable_disk_events(struct scsi_device *sdev);
474 extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
475 extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
478 extern int scsi_autopm_get_device(struct scsi_device *);
479 extern void scsi_autopm_put_device(struct scsi_device *);
481 static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
482 static inline void scsi_autopm_put_device(struct scsi_device *d) {}
483 #endif /* CONFIG_PM */
485 static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
487 return device_reprobe(&sdev->sdev_gendev);
490 static inline unsigned int sdev_channel(struct scsi_device *sdev)
492 return sdev->channel;
495 static inline unsigned int sdev_id(struct scsi_device *sdev)
500 #define scmd_id(scmd) sdev_id((scmd)->device)
501 #define scmd_channel(scmd) sdev_channel((scmd)->device)
504 * checks for positions of the SCSI state machine
506 static inline int scsi_device_online(struct scsi_device *sdev)
508 return (sdev->sdev_state != SDEV_OFFLINE &&
509 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
510 sdev->sdev_state != SDEV_DEL);
512 static inline int scsi_device_blocked(struct scsi_device *sdev)
514 return sdev->sdev_state == SDEV_BLOCK ||
515 sdev->sdev_state == SDEV_CREATED_BLOCK;
517 static inline int scsi_device_created(struct scsi_device *sdev)
519 return sdev->sdev_state == SDEV_CREATED ||
520 sdev->sdev_state == SDEV_CREATED_BLOCK;
523 int scsi_internal_device_block_nowait(struct scsi_device *sdev);
524 int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
525 enum scsi_device_state new_state);
527 /* accessor functions for the SCSI parameters */
528 static inline int scsi_device_sync(struct scsi_device *sdev)
532 static inline int scsi_device_wide(struct scsi_device *sdev)
536 static inline int scsi_device_dt(struct scsi_device *sdev)
540 static inline int scsi_device_dt_only(struct scsi_device *sdev)
542 if (sdev->inquiry_len < 57)
544 return (sdev->inquiry[56] & 0x0c) == 0x04;
546 static inline int scsi_device_ius(struct scsi_device *sdev)
548 if (sdev->inquiry_len < 57)
550 return sdev->inquiry[56] & 0x01;
552 static inline int scsi_device_qas(struct scsi_device *sdev)
554 if (sdev->inquiry_len < 57)
556 return sdev->inquiry[56] & 0x02;
558 static inline int scsi_device_enclosure(struct scsi_device *sdev)
560 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
563 static inline int scsi_device_protection(struct scsi_device *sdev)
568 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
571 static inline int scsi_device_tpgs(struct scsi_device *sdev)
573 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
577 * scsi_device_supports_vpd - test if a device supports VPD pages
578 * @sdev: the &struct scsi_device to test
580 * If the 'try_vpd_pages' flag is set it takes precedence.
581 * Otherwise we will assume VPD pages are supported if the
582 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
584 static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
586 /* Attempt VPD inquiry if the device blacklist explicitly calls
589 if (sdev->try_vpd_pages)
592 * Although VPD inquiries can go to SCSI-2 type devices,
593 * some USB ones crash on receiving them, and the pages
594 * we currently ask for are mandatory for SPC-2 and beyond
596 if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
601 static inline int scsi_device_busy(struct scsi_device *sdev)
603 return sbitmap_weight(&sdev->budget_map);
606 #define MODULE_ALIAS_SCSI_DEVICE(type) \
607 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
608 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
610 #endif /* _SCSI_SCSI_DEVICE_H */