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>
16 struct scsi_sense_hdr;
18 typedef __u64 __bitwise blist_flags_t;
20 #define SCSI_SENSE_BUFFERSIZE 96
22 struct scsi_mode_data {
24 __u16 block_descriptor_length;
32 * sdev state: If you alter this, you also need to alter scsi_sysfs.c
33 * (for the ascii descriptions) and the state model enforcer:
34 * scsi_lib:scsi_device_set_state().
36 enum scsi_device_state {
37 SDEV_CREATED = 1, /* device created but not added to sysfs
38 * Only internal commands allowed (for inq) */
39 SDEV_RUNNING, /* device properly configured
40 * All commands allowed */
41 SDEV_CANCEL, /* beginning to delete device
42 * Only error handler commands allowed */
43 SDEV_DEL, /* device deleted
44 * no commands allowed */
45 SDEV_QUIESCE, /* Device quiescent. No block commands
46 * will be accepted, only specials (which
47 * originate in the mid-layer) */
48 SDEV_OFFLINE, /* Device offlined (by error handling or
50 SDEV_TRANSPORT_OFFLINE, /* Offlined by transport class error handler */
51 SDEV_BLOCK, /* Device blocked by scsi lld. No
52 * scsi commands from user or midlayer
53 * should be issued to the scsi
55 SDEV_CREATED_BLOCK, /* same as above but for created devices */
59 SCSI_SCAN_INITIAL = 0,
64 enum scsi_device_event {
65 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
66 SDEV_EVT_INQUIRY_CHANGE_REPORTED, /* 3F 03 UA reported */
67 SDEV_EVT_CAPACITY_CHANGE_REPORTED, /* 2A 09 UA reported */
68 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED, /* 38 07 UA reported */
69 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED, /* 2A 01 UA reported */
70 SDEV_EVT_LUN_CHANGE_REPORTED, /* 3F 0E UA reported */
71 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, /* 2A 06 UA reported */
72 SDEV_EVT_POWER_ON_RESET_OCCURRED, /* 29 00 UA reported */
74 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE,
75 SDEV_EVT_LAST = SDEV_EVT_POWER_ON_RESET_OCCURRED,
77 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
81 enum scsi_device_event evt_type;
82 struct list_head node;
84 /* put union of data structures, for non-simple event types,
90 * struct scsi_vpd - SCSI Vital Product Data
91 * @rcu: For kfree_rcu().
92 * @len: Length in bytes of @data.
93 * @data: VPD data as defined in various T10 SCSI standard documents.
102 struct Scsi_Host *host;
103 struct request_queue *request_queue;
105 /* the next two are protected by the host->host_lock */
106 struct list_head siblings; /* list of all devices on this host */
107 struct list_head same_target_siblings; /* just the devices sharing same target id */
109 atomic_t device_busy; /* commands actually active on LLDD */
110 atomic_t device_blocked; /* Device returned QUEUE_FULL. */
112 spinlock_t list_lock;
113 struct list_head cmd_list; /* queue of in use SCSI Command structures */
114 struct list_head starved_entry;
115 unsigned short queue_depth; /* How deep of a queue we want */
116 unsigned short max_queue_depth; /* max queue depth */
117 unsigned short last_queue_full_depth; /* These two are used by */
118 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
119 unsigned long last_queue_full_time; /* last queue full time */
120 unsigned long queue_ramp_up_period; /* ramp up period in jiffies */
121 #define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
123 unsigned long last_queue_ramp_up; /* last queue ramp up time */
125 unsigned int id, channel;
127 unsigned int manufacturer; /* Manufacturer of device, for using
128 * vendor-specific cmd's */
129 unsigned sector_size; /* size in bytes */
131 void *hostdata; /* available to low-level driver */
134 char inq_periph_qual; /* PQ from INQUIRY data */
135 struct mutex inquiry_mutex;
136 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
137 unsigned char * inquiry; /* INQUIRY response data */
138 const char * vendor; /* [back_compat] point into 'inquiry' ... */
139 const char * model; /* ... after scan; point to static string */
140 const char * rev; /* ... "nullnullnullnull" before scan */
142 #define SCSI_VPD_PG_LEN 255
143 struct scsi_vpd __rcu *vpd_pg0;
144 struct scsi_vpd __rcu *vpd_pg83;
145 struct scsi_vpd __rcu *vpd_pg80;
146 struct scsi_vpd __rcu *vpd_pg89;
147 unsigned char current_tag; /* current tag */
148 struct scsi_target *sdev_target; /* used only for single_lun */
150 blist_flags_t sdev_bflags; /* black/white flags as also found in
151 * scsi_devinfo.[hc]. For now used only to
152 * pass settings from slave_alloc to scsi
154 unsigned int eh_timeout; /* Error handling timeout */
155 unsigned removable:1;
156 unsigned changed:1; /* Data invalid due to media change */
157 unsigned busy:1; /* Used to prevent races */
158 unsigned lockable:1; /* Able to prevent media removal */
159 unsigned locked:1; /* Media removal disabled */
160 unsigned borken:1; /* Tell the Seagate driver to be
161 * painfully slow on this device */
162 unsigned disconnect:1; /* can disconnect */
163 unsigned soft_reset:1; /* Uses soft reset option */
164 unsigned sdtr:1; /* Device supports SDTR messages */
165 unsigned wdtr:1; /* Device supports WDTR messages */
166 unsigned ppr:1; /* Device supports PPR messages */
167 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
168 unsigned simple_tags:1; /* simple queue tag messages are enabled */
169 unsigned was_reset:1; /* There was a bus reset on the bus for
171 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
172 * because we did a bus reset. */
173 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
174 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
175 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
176 unsigned no_write_same:1; /* no WRITE SAME command */
177 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
178 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
179 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
180 unsigned skip_vpd_pages:1; /* do not read VPD pages */
181 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
182 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
183 unsigned no_start_on_add:1; /* do not issue start on add */
184 unsigned allow_restart:1; /* issue START_UNIT in error handler */
185 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
186 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
187 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
188 unsigned select_no_atn:1;
189 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
190 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
191 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
192 unsigned last_sector_bug:1; /* do not use multisector accesses on
193 SD_LAST_BUGGY_SECTORS */
194 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
195 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
196 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
197 unsigned security_supported:1; /* Supports Security Protocols */
198 unsigned is_visible:1; /* is the device visible in sysfs */
199 unsigned wce_default_on:1; /* Cache is ON by default */
200 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
201 unsigned broken_fua:1; /* Don't set FUA bit */
202 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
203 unsigned unmap_limit_for_ws:1; /* Use the UNMAP limit for WRITE SAME */
204 unsigned rpm_autosuspend:1; /* Enable runtime autosuspend at device
206 atomic_t disk_events_disable_depth; /* disable depth for disk events */
208 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
209 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
210 struct list_head event_list; /* asserted events */
211 struct work_struct event_work;
213 unsigned int max_device_blocked; /* what device_blocked counts down from */
214 #define SCSI_DEFAULT_DEVICE_BLOCKED 3
216 atomic_t iorequest_cnt;
220 struct device sdev_gendev,
223 struct execute_work ew; /* used to get process context on put */
224 struct work_struct requeue_work;
226 struct scsi_device_handler *handler;
229 unsigned char access_state;
230 struct mutex state_mutex;
231 enum scsi_device_state sdev_state;
232 struct task_struct *quiesced_by;
233 unsigned long sdev_data[0];
234 } __attribute__((aligned(sizeof(unsigned long))));
236 #define to_scsi_device(d) \
237 container_of(d, struct scsi_device, sdev_gendev)
238 #define class_to_sdev(d) \
239 container_of(d, struct scsi_device, sdev_dev)
240 #define transport_class_to_sdev(class_dev) \
241 to_scsi_device(class_dev->parent)
243 #define sdev_dbg(sdev, fmt, a...) \
244 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
247 * like scmd_printk, but the device name is passed in
248 * as a string pointer
251 sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
254 #define sdev_printk(l, sdev, fmt, a...) \
255 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
258 scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...);
260 #define scmd_dbg(scmd, fmt, a...) \
262 if ((scmd)->request->rq_disk) \
263 sdev_dbg((scmd)->device, "[%s] " fmt, \
264 (scmd)->request->rq_disk->disk_name, ##a);\
266 sdev_dbg((scmd)->device, fmt, ##a); \
269 enum scsi_target_state {
273 STARGET_CREATED_REMOVE,
278 * scsi_target: representation of a scsi target, for now, this is only
279 * used for single_lun devices. If no one has active IO to the target,
280 * starget_sdev_user is NULL, else it points to the active sdev.
283 struct scsi_device *starget_sdev_user;
284 struct list_head siblings;
285 struct list_head devices;
287 struct kref reap_ref; /* last put renders target invisible */
288 unsigned int channel;
289 unsigned int id; /* target id ... replace
290 * scsi_device.id eventually */
291 unsigned int create:1; /* signal that it needs to be added */
292 unsigned int single_lun:1; /* Indicates we should only
293 * allow I/O to one of the luns
294 * for the device at a time. */
295 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f
296 * means no lun present. */
297 unsigned int no_report_luns:1; /* Don't use
298 * REPORT LUNS for scanning. */
299 unsigned int expecting_lun_change:1; /* A device has reported
300 * a 3F/0E UA, other devices on
301 * the same target will also. */
302 /* commands actually active on LLD. */
303 atomic_t target_busy;
304 atomic_t target_blocked;
307 * LLDs should set this in the slave_alloc host template callout.
308 * If set to zero then there is not limit.
310 unsigned int can_queue;
311 unsigned int max_target_blocked;
312 #define SCSI_DEFAULT_TARGET_BLOCKED 3
315 enum scsi_target_state state;
316 void *hostdata; /* available to low-level driver */
317 unsigned long starget_data[0]; /* for the transport */
318 /* starget_data must be the last element!!!! */
319 } __attribute__((aligned(sizeof(unsigned long))));
321 #define to_scsi_target(d) container_of(d, struct scsi_target, dev)
322 static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
324 return to_scsi_target(sdev->sdev_gendev.parent);
326 #define transport_class_to_starget(class_dev) \
327 to_scsi_target(class_dev->parent)
329 #define starget_printk(prefix, starget, fmt, a...) \
330 dev_printk(prefix, &(starget)->dev, fmt, ##a)
332 extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
333 uint, uint, u64, void *hostdata);
334 extern int scsi_add_device(struct Scsi_Host *host, uint channel,
335 uint target, u64 lun);
336 extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
337 extern void scsi_remove_device(struct scsi_device *);
338 extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
339 void scsi_attach_vpd(struct scsi_device *sdev);
341 extern struct scsi_device *scsi_device_from_queue(struct request_queue *q);
342 extern int __must_check scsi_device_get(struct scsi_device *);
343 extern void scsi_device_put(struct scsi_device *);
344 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
346 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
348 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
350 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
352 extern void starget_for_each_device(struct scsi_target *, void *,
353 void (*fn)(struct scsi_device *, void *));
354 extern void __starget_for_each_device(struct scsi_target *, void *,
355 void (*fn)(struct scsi_device *,
358 /* only exposed to implement shost_for_each_device */
359 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
360 struct scsi_device *);
363 * shost_for_each_device - iterate over all devices of a host
364 * @sdev: the &struct scsi_device to use as a cursor
365 * @shost: the &struct scsi_host to iterate over
367 * Iterator that returns each device attached to @shost. This loop
368 * takes a reference on each device and releases it at the end. If
369 * you break out of the loop, you must call scsi_device_put(sdev).
371 #define shost_for_each_device(sdev, shost) \
372 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
374 (sdev) = __scsi_iterate_devices((shost), (sdev)))
377 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
378 * @sdev: the &struct scsi_device to use as a cursor
379 * @shost: the &struct scsi_host to iterate over
381 * Iterator that returns each device attached to @shost. It does _not_
382 * take a reference on the scsi_device, so the whole loop must be
383 * protected by shost->host_lock.
385 * Note: The only reason to use this is because you need to access the
386 * device list in interrupt context. Otherwise you really want to use
387 * shost_for_each_device instead.
389 #define __shost_for_each_device(sdev, shost) \
390 list_for_each_entry((sdev), &((shost)->__devices), siblings)
392 extern int scsi_change_queue_depth(struct scsi_device *, int);
393 extern int scsi_track_queue_full(struct scsi_device *, int);
395 extern int scsi_set_medium_removal(struct scsi_device *, char);
397 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
398 unsigned char *buffer, int len, int timeout,
399 int retries, struct scsi_mode_data *data,
400 struct scsi_sense_hdr *);
401 extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
402 int modepage, unsigned char *buffer, int len,
403 int timeout, int retries,
404 struct scsi_mode_data *data,
405 struct scsi_sense_hdr *);
406 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
407 int retries, struct scsi_sense_hdr *sshdr);
408 extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
410 extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
411 unsigned int len, unsigned char opcode);
412 extern int scsi_device_set_state(struct scsi_device *sdev,
413 enum scsi_device_state state);
414 extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
416 extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
417 extern void sdev_evt_send_simple(struct scsi_device *sdev,
418 enum scsi_device_event evt_type, gfp_t gfpflags);
419 extern int scsi_device_quiesce(struct scsi_device *sdev);
420 extern void scsi_device_resume(struct scsi_device *sdev);
421 extern void scsi_target_quiesce(struct scsi_target *);
422 extern void scsi_target_resume(struct scsi_target *);
423 extern void scsi_scan_target(struct device *parent, unsigned int channel,
424 unsigned int id, u64 lun,
425 enum scsi_scan_mode rescan);
426 extern void scsi_target_reap(struct scsi_target *);
427 extern void scsi_target_block(struct device *);
428 extern void scsi_target_unblock(struct device *, enum scsi_device_state);
429 extern void scsi_remove_target(struct device *);
430 extern const char *scsi_device_state_name(enum scsi_device_state);
431 extern int scsi_is_sdev_device(const struct device *);
432 extern int scsi_is_target_device(const struct device *);
433 extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
434 extern int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
435 int data_direction, void *buffer, unsigned bufflen,
436 unsigned char *sense, struct scsi_sense_hdr *sshdr,
437 int timeout, int retries, u64 flags,
438 req_flags_t rq_flags, int *resid);
439 /* Make sure any sense buffer is the correct size. */
440 #define scsi_execute(sdev, cmd, data_direction, buffer, bufflen, sense, \
441 sshdr, timeout, retries, flags, rq_flags, resid) \
443 BUILD_BUG_ON((sense) != NULL && \
444 sizeof(sense) != SCSI_SENSE_BUFFERSIZE); \
445 __scsi_execute(sdev, cmd, data_direction, buffer, bufflen, \
446 sense, sshdr, timeout, retries, flags, rq_flags, \
449 static inline int scsi_execute_req(struct scsi_device *sdev,
450 const unsigned char *cmd, int data_direction, void *buffer,
451 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
452 int retries, int *resid)
454 return scsi_execute(sdev, cmd, data_direction, buffer,
455 bufflen, NULL, sshdr, timeout, retries, 0, 0, resid);
457 extern void sdev_disable_disk_events(struct scsi_device *sdev);
458 extern void sdev_enable_disk_events(struct scsi_device *sdev);
459 extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
460 extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
463 extern int scsi_autopm_get_device(struct scsi_device *);
464 extern void scsi_autopm_put_device(struct scsi_device *);
466 static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
467 static inline void scsi_autopm_put_device(struct scsi_device *d) {}
468 #endif /* CONFIG_PM */
470 static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
472 return device_reprobe(&sdev->sdev_gendev);
475 static inline unsigned int sdev_channel(struct scsi_device *sdev)
477 return sdev->channel;
480 static inline unsigned int sdev_id(struct scsi_device *sdev)
485 #define scmd_id(scmd) sdev_id((scmd)->device)
486 #define scmd_channel(scmd) sdev_channel((scmd)->device)
489 * checks for positions of the SCSI state machine
491 static inline int scsi_device_online(struct scsi_device *sdev)
493 return (sdev->sdev_state != SDEV_OFFLINE &&
494 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
495 sdev->sdev_state != SDEV_DEL);
497 static inline int scsi_device_blocked(struct scsi_device *sdev)
499 return sdev->sdev_state == SDEV_BLOCK ||
500 sdev->sdev_state == SDEV_CREATED_BLOCK;
502 static inline int scsi_device_created(struct scsi_device *sdev)
504 return sdev->sdev_state == SDEV_CREATED ||
505 sdev->sdev_state == SDEV_CREATED_BLOCK;
508 int scsi_internal_device_block_nowait(struct scsi_device *sdev);
509 int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
510 enum scsi_device_state new_state);
512 /* accessor functions for the SCSI parameters */
513 static inline int scsi_device_sync(struct scsi_device *sdev)
517 static inline int scsi_device_wide(struct scsi_device *sdev)
521 static inline int scsi_device_dt(struct scsi_device *sdev)
525 static inline int scsi_device_dt_only(struct scsi_device *sdev)
527 if (sdev->inquiry_len < 57)
529 return (sdev->inquiry[56] & 0x0c) == 0x04;
531 static inline int scsi_device_ius(struct scsi_device *sdev)
533 if (sdev->inquiry_len < 57)
535 return sdev->inquiry[56] & 0x01;
537 static inline int scsi_device_qas(struct scsi_device *sdev)
539 if (sdev->inquiry_len < 57)
541 return sdev->inquiry[56] & 0x02;
543 static inline int scsi_device_enclosure(struct scsi_device *sdev)
545 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
548 static inline int scsi_device_protection(struct scsi_device *sdev)
553 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
556 static inline int scsi_device_tpgs(struct scsi_device *sdev)
558 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
562 * scsi_device_supports_vpd - test if a device supports VPD pages
563 * @sdev: the &struct scsi_device to test
565 * If the 'try_vpd_pages' flag is set it takes precedence.
566 * Otherwise we will assume VPD pages are supported if the
567 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
569 static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
571 /* Attempt VPD inquiry if the device blacklist explicitly calls
574 if (sdev->try_vpd_pages)
577 * Although VPD inquiries can go to SCSI-2 type devices,
578 * some USB ones crash on receiving them, and the pages
579 * we currently ask for are mandatory for SPC-2 and beyond
581 if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
586 #define MODULE_ALIAS_SCSI_DEVICE(type) \
587 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
588 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
590 #endif /* _SCSI_SCSI_DEVICE_H */