blob: c3cba2aaf934c7b71712aaa5ba6c9bec0c173965 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef _SCSI_SCSI_DEVICE_H
3#define _SCSI_SCSI_DEVICE_H
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/list.h>
6#include <linux/spinlock.h>
James Bottomleyffedb452006-02-23 14:27:18 -06007#include <linux/workqueue.h>
Martin K. Petersena4d04a42007-02-27 22:40:27 -05008#include <linux/blkdev.h>
Hugh Dickinsd211f052008-08-06 18:21:18 +01009#include <scsi/scsi.h>
Arun Sharma600634972011-07-26 16:09:06 -070010#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
Paul Gortmaker313162d2012-01-30 11:46:54 -050012struct device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070013struct request_queue;
14struct scsi_cmnd;
James Bottomleye10fb912005-07-14 11:54:17 -050015struct scsi_lun;
James Bottomleyea73a9f2005-08-28 11:33:52 -050016struct scsi_sense_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Martin Wilck14098802018-04-18 01:35:08 +020018typedef __u64 __bitwise blist_flags_t;
Hannes Reinecke5ebde462017-11-15 12:07:30 +010019
Kees Cook704f8392018-07-31 12:51:54 -070020#define SCSI_SENSE_BUFFERSIZE 96
21
James Bottomley1cf72692005-08-28 11:27:01 -050022struct scsi_mode_data {
23 __u32 length;
24 __u16 block_descriptor_length;
25 __u8 medium_type;
26 __u8 device_specific;
27 __u8 header_length;
28 __u8 longlba:1;
29};
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031/*
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().
35 */
36enum 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
49 * user request */
Mike Christie1b8d2622012-05-17 23:56:56 -050050 SDEV_TRANSPORT_OFFLINE, /* Offlined by transport class error handler */
James Bottomley6f4267e2008-08-22 16:53:31 -050051 SDEV_BLOCK, /* Device blocked by scsi lld. No
52 * scsi commands from user or midlayer
53 * should be issued to the scsi
54 * lld. */
55 SDEV_CREATED_BLOCK, /* same as above but for created devices */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
Hannes Reinecke1d645082016-03-17 08:39:45 +010058enum scsi_scan_mode {
59 SCSI_SCAN_INITIAL = 0,
60 SCSI_SCAN_RESCAN,
61 SCSI_SCAN_MANUAL,
62};
63
Jeff Garzika341cd02007-10-29 17:15:22 -040064enum scsi_device_event {
65 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
Ewan D. Milne279afdf2013-08-08 15:07:48 -040066 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 */
Hannes Reinecke14c3e672015-07-06 13:41:53 +020071 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, /* 2A 06 UA reported */
Hannes Reineckecf3431b2017-10-17 09:11:24 +020072 SDEV_EVT_POWER_ON_RESET_OCCURRED, /* 29 00 UA reported */
Jeff Garzika341cd02007-10-29 17:15:22 -040073
Ewan D. Milne279afdf2013-08-08 15:07:48 -040074 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE,
Hannes Reineckecf3431b2017-10-17 09:11:24 +020075 SDEV_EVT_LAST = SDEV_EVT_POWER_ON_RESET_OCCURRED,
Ewan D. Milne279afdf2013-08-08 15:07:48 -040076
Jeff Garzika341cd02007-10-29 17:15:22 -040077 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
78};
79
80struct scsi_event {
81 enum scsi_device_event evt_type;
82 struct list_head node;
83
84 /* put union of data structures, for non-simple event types,
85 * here
86 */
87};
88
Bart Van Asscheccf1e002017-08-29 08:50:13 -070089/**
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.
94 */
95struct scsi_vpd {
96 struct rcu_head rcu;
97 int len;
98 unsigned char data[];
99};
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101struct scsi_device {
102 struct Scsi_Host *host;
103 struct request_queue *request_queue;
104
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 */
108
Christoph Hellwig71e75c92014-04-11 19:07:01 +0200109 atomic_t device_busy; /* commands actually active on LLDD */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100110 atomic_t device_blocked; /* Device returned QUEUE_FULL. */
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 spinlock_t list_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 struct list_head starved_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 unsigned short queue_depth; /* How deep of a queue we want */
Vasu Dev4a840672009-10-22 15:46:33 -0700115 unsigned short max_queue_depth; /* max queue depth */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 unsigned short last_queue_full_depth; /* These two are used by */
117 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
Vasu Dev4a840672009-10-22 15:46:33 -0700118 unsigned long last_queue_full_time; /* last queue full time */
119 unsigned long queue_ramp_up_period; /* ramp up period in jiffies */
120#define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
121
122 unsigned long last_queue_ramp_up; /* last queue ramp up time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200124 unsigned int id, channel;
125 u64 lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 unsigned int manufacturer; /* Manufacturer of device, for using
127 * vendor-specific cmd's */
128 unsigned sector_size; /* size in bytes */
129
130 void *hostdata; /* available to low-level driver */
Bart Van Asschec2e872a2017-08-25 13:46:28 -0700131 unsigned char type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 char scsi_level;
133 char inq_periph_qual; /* PQ from INQUIRY data */
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100134 struct mutex inquiry_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
136 unsigned char * inquiry; /* INQUIRY response data */
James Bottomley7f23e142005-12-01 12:50:13 -0600137 const char * vendor; /* [back_compat] point into 'inquiry' ... */
138 const char * model; /* ... after scan; point to static string */
139 const char * rev; /* ... "nullnullnullnull" before scan */
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100140
141#define SCSI_VPD_PG_LEN 255
Ryan Attardd188b062019-09-26 11:22:17 -0500142 struct scsi_vpd __rcu *vpd_pg0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700143 struct scsi_vpd __rcu *vpd_pg83;
144 struct scsi_vpd __rcu *vpd_pg80;
Ryan Attardd188b062019-09-26 11:22:17 -0500145 struct scsi_vpd __rcu *vpd_pg89;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 unsigned char current_tag; /* current tag */
147 struct scsi_target *sdev_target; /* used only for single_lun */
148
Hannes Reinecke5ebde462017-11-15 12:07:30 +0100149 blist_flags_t sdev_bflags; /* black/white flags as also found in
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * scsi_devinfo.[hc]. For now used only to
151 * pass settings from slave_alloc to scsi
152 * core. */
Martin K. Petersen0816c922013-05-10 10:36:04 -0400153 unsigned int eh_timeout; /* Error handling timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 unsigned removable:1;
155 unsigned changed:1; /* Data invalid due to media change */
156 unsigned busy:1; /* Used to prevent races */
157 unsigned lockable:1; /* Able to prevent media removal */
158 unsigned locked:1; /* Media removal disabled */
159 unsigned borken:1; /* Tell the Seagate driver to be
160 * painfully slow on this device */
161 unsigned disconnect:1; /* can disconnect */
162 unsigned soft_reset:1; /* Uses soft reset option */
163 unsigned sdtr:1; /* Device supports SDTR messages */
164 unsigned wdtr:1; /* Device supports WDTR messages */
165 unsigned ppr:1; /* Device supports PPR messages */
166 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
167 unsigned simple_tags:1; /* simple queue tag messages are enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 unsigned was_reset:1; /* There was a bus reset on the bus for
169 * this device */
170 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
171 * because we did a bus reset. */
172 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
173 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
Can Guo0ec96912019-12-05 02:14:25 +0000174 unsigned set_dbd_for_ms:1; /* Set "DBD" field in mode sense */
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400175 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400176 unsigned no_write_same:1; /* no WRITE SAME command */
Jason J. Herne53ad5702012-11-14 17:03:22 -0500177 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 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 */
Alan Stern09b6b512012-01-10 13:43:30 -0500180 unsigned skip_vpd_pages:1; /* do not read VPD pages */
Martin K. Petersenc1d40a52014-07-15 12:49:17 -0400181 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 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 */
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900185 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
Stefan Richterd2886ea2008-05-11 00:34:07 +0200186 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 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 */
Oliver Neukum61bf54b2007-02-08 09:04:48 +0100190 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
Linus Torvalds18351072008-08-05 21:42:21 -0700192 unsigned last_sector_bug:1; /* do not use multisector accesses on
193 SD_LAST_BUGGY_SECTORS */
Hans de Goede8e04d802010-10-01 14:20:08 -0700194 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
Hans de Goede5ce524b2010-10-01 14:20:10 -0700195 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
Alan Stern6a0bdff2012-06-20 16:04:19 -0400196 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
Christoph Hellwigd80210f2017-06-19 14:26:46 +0200197 unsigned security_supported:1; /* Supports Security Protocols */
James Bottomley860dc732009-11-19 17:48:29 -0500198 unsigned is_visible:1; /* is the device visible in sysfs */
Namjae Jeonb81478d2012-07-07 23:05:08 -0400199 unsigned wce_default_on:1; /* Cache is ON by default */
Martin K. Petersend974e422012-08-28 14:29:35 -0400200 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
Alan Sternb14bf2d2014-06-30 11:04:21 -0400201 unsigned broken_fua:1; /* Don't set FUA bit */
Alan Stern50c4e962014-09-02 11:35:50 -0400202 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
Martin K. Petersen28a0bc42017-09-27 21:35:12 -0400203 unsigned unmap_limit_for_ws:1; /* Use the UNMAP limit for WRITE SAME */
Stanley Chuc74f8052019-09-16 23:56:49 +0800204 unsigned rpm_autosuspend:1; /* Enable runtime autosuspend at device
205 * creation time */
Ewan D. Milneb0962c52020-03-11 10:39:30 -0400206
207 bool offline_already; /* Device offline message logged */
208
Aaron Lu6f4c8272013-01-23 15:09:32 +0800209 atomic_t disk_events_disable_depth; /* disable depth for disk events */
210
Jeff Garzika341cd02007-10-29 17:15:22 -0400211 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400212 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
Jeff Garzika341cd02007-10-29 17:15:22 -0400213 struct list_head event_list; /* asserted events */
214 struct work_struct event_work;
215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 unsigned int max_device_blocked; /* what device_blocked counts down from */
217#define SCSI_DEFAULT_DEVICE_BLOCKED 3
218
219 atomic_t iorequest_cnt;
220 atomic_t iodone_cnt;
221 atomic_t ioerr_cnt;
222
Tony Jonesee959b02008-02-22 00:13:36 +0100223 struct device sdev_gendev,
224 sdev_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
James Bottomleyffedb452006-02-23 14:27:18 -0600226 struct execute_work ew; /* used to get process context on put */
Jens Axboe9937a5e2011-05-17 11:04:44 +0200227 struct work_struct requeue_work;
James Bottomleyffedb452006-02-23 14:27:18 -0600228
Christoph Hellwigee14c672015-08-27 14:16:59 +0200229 struct scsi_device_handler *handler;
230 void *handler_data;
231
Hannes Reinecke77c9df92016-03-03 07:54:07 +0100232 unsigned char access_state;
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700233 struct mutex state_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 enum scsi_device_state sdev_state;
Bart Van Assche3a0a5292017-11-09 10:49:58 -0800235 struct task_struct *quiesced_by;
Gustavo A. R. Silva5febf6d2020-02-24 10:14:06 -0600236 unsigned long sdev_data[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237} __attribute__((aligned(sizeof(unsigned long))));
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700238
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239#define to_scsi_device(d) \
240 container_of(d, struct scsi_device, sdev_gendev)
241#define class_to_sdev(d) \
Tony Jonesee959b02008-02-22 00:13:36 +0100242 container_of(d, struct scsi_device, sdev_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243#define transport_class_to_sdev(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100244 to_scsi_device(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Dan Williams3af74a32014-02-06 12:23:07 -0800246#define sdev_dbg(sdev, fmt, a...) \
247 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
248
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200249/*
250 * like scmd_printk, but the device name is passed in
251 * as a string pointer
252 */
Hannes Reinecke9c4a6b12015-02-04 08:11:34 +0100253__printf(4, 5) void
Christoph Hellwig6a806cb2015-01-18 16:11:29 +0100254sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
255 const char *, ...);
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200256
Hannes Reineckeded85c12015-01-08 07:43:42 +0100257#define sdev_printk(l, sdev, fmt, a...) \
258 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
259
Hannes Reinecke9c4a6b12015-02-04 08:11:34 +0100260__printf(3, 4) void
Christoph Hellwig6a806cb2015-01-18 16:11:29 +0100261scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...);
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400262
Dan Williams3af74a32014-02-06 12:23:07 -0800263#define scmd_dbg(scmd, fmt, a...) \
264 do { \
265 if ((scmd)->request->rq_disk) \
266 sdev_dbg((scmd)->device, "[%s] " fmt, \
267 (scmd)->request->rq_disk->disk_name, ##a);\
268 else \
269 sdev_dbg((scmd)->device, fmt, ##a); \
270 } while (0)
271
James Bottomleyffedb452006-02-23 14:27:18 -0600272enum scsi_target_state {
James Bottomley643eb2d2008-03-22 22:42:27 -0500273 STARGET_CREATED = 1,
274 STARGET_RUNNING,
Johannes Thumshirnf05795d2016-04-05 11:50:44 +0200275 STARGET_REMOVE,
Ewan D. Milnef9279c92017-06-27 14:55:58 -0400276 STARGET_CREATED_REMOVE,
James Bottomleyffedb452006-02-23 14:27:18 -0600277 STARGET_DEL,
278};
279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280/*
281 * scsi_target: representation of a scsi target, for now, this is only
282 * used for single_lun devices. If no one has active IO to the target,
283 * starget_sdev_user is NULL, else it points to the active sdev.
284 */
285struct scsi_target {
286 struct scsi_device *starget_sdev_user;
287 struct list_head siblings;
288 struct list_head devices;
289 struct device dev;
James Bottomleye63ed0d2014-01-21 07:00:50 -0800290 struct kref reap_ref; /* last put renders target invisible */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 unsigned int channel;
292 unsigned int id; /* target id ... replace
293 * scsi_device.id eventually */
Alan Stern1bfc5d92006-02-09 15:26:18 -0500294 unsigned int create:1; /* signal that it needs to be added */
Tony Battersby25d7c362007-11-12 10:00:44 -0500295 unsigned int single_lun:1; /* Indicates we should only
296 * allow I/O to one of the luns
297 * for the device at a time. */
Alan Sternde8c46b2012-01-10 13:43:04 -0500298 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f
299 * means no lun present. */
Alan Stern09b6b512012-01-10 13:43:30 -0500300 unsigned int no_report_luns:1; /* Don't use
301 * REPORT LUNS for scanning. */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400302 unsigned int expecting_lun_change:1; /* A device has reported
303 * a 3F/0E UA, other devices on
304 * the same target will also. */
Christoph Hellwig7ae65c02014-01-22 14:49:41 +0100305 /* commands actually active on LLD. */
306 atomic_t target_busy;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100307 atomic_t target_blocked;
308
Mike Christief0c0a372008-08-17 15:24:38 -0500309 /*
310 * LLDs should set this in the slave_alloc host template callout.
311 * If set to zero then there is not limit.
312 */
313 unsigned int can_queue;
Mike Christief0c0a372008-08-17 15:24:38 -0500314 unsigned int max_target_blocked;
315#define SCSI_DEFAULT_TARGET_BLOCKED 3
Alan Stern1bfc5d92006-02-09 15:26:18 -0500316
James Bottomley6f3a2022005-09-22 20:33:28 -0500317 char scsi_level;
James Bottomleyffedb452006-02-23 14:27:18 -0600318 enum scsi_target_state state;
James Bottomleya283bd32005-05-24 12:06:38 -0500319 void *hostdata; /* available to low-level driver */
Gustavo A. R. Silva5febf6d2020-02-24 10:14:06 -0600320 unsigned long starget_data[]; /* for the transport */
James Bottomleya283bd32005-05-24 12:06:38 -0500321 /* starget_data must be the last element!!!! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322} __attribute__((aligned(sizeof(unsigned long))));
323
324#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
325static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
326{
327 return to_scsi_target(sdev->sdev_gendev.parent);
328}
329#define transport_class_to_starget(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100330 to_scsi_target(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
James Bottomley9ccfc752005-10-02 11:45:08 -0500332#define starget_printk(prefix, starget, fmt, a...) \
333 dev_printk(prefix, &(starget)->dev, fmt, ##a)
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200336 uint, uint, u64, void *hostdata);
James Bottomley146f7262005-09-10 12:44:09 -0500337extern int scsi_add_device(struct Scsi_Host *host, uint channel,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200338 uint target, u64 lun);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700339extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340extern void scsi_remove_device(struct scsi_device *);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700341extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100342void scsi_attach_vpd(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Hannes Reinecke857de6e2017-02-17 09:02:45 +0100344extern struct scsi_device *scsi_device_from_queue(struct request_queue *q);
Bart Van Asscheed12e032017-04-05 09:52:50 -0700345extern int __must_check scsi_device_get(struct scsi_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346extern void scsi_device_put(struct scsi_device *);
347extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200348 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200350 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200352 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200354 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355extern void starget_for_each_device(struct scsi_target *, void *,
356 void (*fn)(struct scsi_device *, void *));
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800357extern void __starget_for_each_device(struct scsi_target *, void *,
358 void (*fn)(struct scsi_device *,
359 void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
361/* only exposed to implement shost_for_each_device */
362extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
363 struct scsi_device *);
364
365/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600366 * shost_for_each_device - iterate over all devices of a host
367 * @sdev: the &struct scsi_device to use as a cursor
368 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600370 * Iterator that returns each device attached to @shost. This loop
371 * takes a reference on each device and releases it at the end. If
372 * you break out of the loop, you must call scsi_device_put(sdev).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 */
374#define shost_for_each_device(sdev, shost) \
375 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
376 (sdev); \
377 (sdev) = __scsi_iterate_devices((shost), (sdev)))
378
379/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600380 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
381 * @sdev: the &struct scsi_device to use as a cursor
382 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600384 * Iterator that returns each device attached to @shost. It does _not_
385 * take a reference on the scsi_device, so the whole loop must be
386 * protected by shost->host_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600388 * Note: The only reason to use this is because you need to access the
389 * device list in interrupt context. Otherwise you really want to use
390 * shost_for_each_device instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 */
392#define __shost_for_each_device(sdev, shost) \
393 list_for_each_entry((sdev), &((shost)->__devices), siblings)
394
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100395extern int scsi_change_queue_depth(struct scsi_device *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396extern int scsi_track_queue_full(struct scsi_device *, int);
397
398extern int scsi_set_medium_removal(struct scsi_device *, char);
399
400extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
401 unsigned char *buffer, int len, int timeout,
James Bottomley1cf72692005-08-28 11:27:01 -0500402 int retries, struct scsi_mode_data *data,
James Bottomleyea73a9f2005-08-28 11:33:52 -0500403 struct scsi_sense_hdr *);
James Bottomley5baba832006-03-18 14:10:35 -0600404extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
405 int modepage, unsigned char *buffer, int len,
406 int timeout, int retries,
407 struct scsi_mode_data *data,
408 struct scsi_sense_hdr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
James Bottomley001aac22007-12-02 19:10:40 +0200410 int retries, struct scsi_sense_hdr *sshdr);
James Bottomleye3deec02009-11-03 12:33:07 -0600411extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
412 int buf_len);
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400413extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
414 unsigned int len, unsigned char opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415extern int scsi_device_set_state(struct scsi_device *sdev,
416 enum scsi_device_state state);
Jeff Garzika341cd02007-10-29 17:15:22 -0400417extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
418 gfp_t gfpflags);
419extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
420extern void sdev_evt_send_simple(struct scsi_device *sdev,
421 enum scsi_device_event evt_type, gfp_t gfpflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422extern int scsi_device_quiesce(struct scsi_device *sdev);
423extern void scsi_device_resume(struct scsi_device *sdev);
424extern void scsi_target_quiesce(struct scsi_target *);
425extern void scsi_target_resume(struct scsi_target *);
426extern void scsi_scan_target(struct device *parent, unsigned int channel,
Hannes Reinecke1d645082016-03-17 08:39:45 +0100427 unsigned int id, u64 lun,
428 enum scsi_scan_mode rescan);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429extern void scsi_target_reap(struct scsi_target *);
430extern void scsi_target_block(struct device *);
Mike Christie5d9fb5c2012-05-17 23:56:57 -0500431extern void scsi_target_unblock(struct device *, enum scsi_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432extern void scsi_remove_target(struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433extern const char *scsi_device_state_name(enum scsi_device_state);
434extern int scsi_is_sdev_device(const struct device *);
435extern int scsi_is_target_device(const struct device *);
Don Brace38464702016-01-27 20:16:26 -0600436extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
Kees Cook704f8392018-07-31 12:51:54 -0700437extern int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500438 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100439 unsigned char *sense, struct scsi_sense_hdr *sshdr,
440 int timeout, int retries, u64 flags,
441 req_flags_t rq_flags, int *resid);
Kees Cook704f8392018-07-31 12:51:54 -0700442/* Make sure any sense buffer is the correct size. */
443#define scsi_execute(sdev, cmd, data_direction, buffer, bufflen, sense, \
444 sshdr, timeout, retries, flags, rq_flags, resid) \
445({ \
446 BUILD_BUG_ON((sense) != NULL && \
447 sizeof(sense) != SCSI_SENSE_BUFFERSIZE); \
448 __scsi_execute(sdev, cmd, data_direction, buffer, bufflen, \
449 sense, sshdr, timeout, retries, flags, rq_flags, \
450 resid); \
451})
Lin Ming9b214932013-03-23 11:42:25 +0800452static inline int scsi_execute_req(struct scsi_device *sdev,
453 const unsigned char *cmd, int data_direction, void *buffer,
454 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
455 int retries, int *resid)
456{
Christoph Hellwigfcbfffe2017-02-23 16:02:37 +0100457 return scsi_execute(sdev, cmd, data_direction, buffer,
458 bufflen, NULL, sshdr, timeout, retries, 0, 0, resid);
Lin Ming9b214932013-03-23 11:42:25 +0800459}
Aaron Lu6f4c8272013-01-23 15:09:32 +0800460extern void sdev_disable_disk_events(struct scsi_device *sdev);
461extern void sdev_enable_disk_events(struct scsi_device *sdev);
Hannes Reinecke9983bed2015-12-01 10:16:55 +0100462extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
Hannes Reineckea8aa3972015-12-01 10:16:57 +0100463extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
James Bottomley33aa6872005-08-28 11:31:14 -0500464
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100465#ifdef CONFIG_PM
Alan Sternbc4f2402010-06-17 10:41:42 -0400466extern int scsi_autopm_get_device(struct scsi_device *);
467extern void scsi_autopm_put_device(struct scsi_device *);
468#else
469static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
470static inline void scsi_autopm_put_device(struct scsi_device *d) {}
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100471#endif /* CONFIG_PM */
Alan Sternbc4f2402010-06-17 10:41:42 -0400472
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400473static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
James Bottomleye28482c2006-03-14 14:24:55 -0600474{
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400475 return device_reprobe(&sdev->sdev_gendev);
James Bottomleye28482c2006-03-14 14:24:55 -0600476}
477
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400478static inline unsigned int sdev_channel(struct scsi_device *sdev)
479{
480 return sdev->channel;
481}
482
483static inline unsigned int sdev_id(struct scsi_device *sdev)
484{
485 return sdev->id;
486}
487
488#define scmd_id(scmd) sdev_id((scmd)->device)
489#define scmd_channel(scmd) sdev_channel((scmd)->device)
490
James Bottomley0f1d87a2008-08-22 16:43:59 -0500491/*
492 * checks for positions of the SCSI state machine
493 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494static inline int scsi_device_online(struct scsi_device *sdev)
495{
Hannes Reinecke0762a482009-01-12 09:28:55 +0100496 return (sdev->sdev_state != SDEV_OFFLINE &&
Mike Christie1b8d2622012-05-17 23:56:56 -0500497 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
Hannes Reinecke0762a482009-01-12 09:28:55 +0100498 sdev->sdev_state != SDEV_DEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499}
James Bottomley0f1d87a2008-08-22 16:43:59 -0500500static inline int scsi_device_blocked(struct scsi_device *sdev)
501{
James Bottomley6f4267e2008-08-22 16:53:31 -0500502 return sdev->sdev_state == SDEV_BLOCK ||
503 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a2008-08-22 16:43:59 -0500504}
505static inline int scsi_device_created(struct scsi_device *sdev)
506{
James Bottomley6f4267e2008-08-22 16:53:31 -0500507 return sdev->sdev_state == SDEV_CREATED ||
508 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a2008-08-22 16:43:59 -0500509}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Bart Van Assche551eb592017-06-02 14:21:53 -0700511int scsi_internal_device_block_nowait(struct scsi_device *sdev);
Bart Van Assche43f75712017-06-02 14:21:54 -0700512int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
513 enum scsi_device_state new_state);
Bart Van Assche8893cf62017-03-01 09:00:36 -0800514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515/* accessor functions for the SCSI parameters */
516static inline int scsi_device_sync(struct scsi_device *sdev)
517{
518 return sdev->sdtr;
519}
520static inline int scsi_device_wide(struct scsi_device *sdev)
521{
522 return sdev->wdtr;
523}
524static inline int scsi_device_dt(struct scsi_device *sdev)
525{
526 return sdev->ppr;
527}
528static inline int scsi_device_dt_only(struct scsi_device *sdev)
529{
530 if (sdev->inquiry_len < 57)
531 return 0;
532 return (sdev->inquiry[56] & 0x0c) == 0x04;
533}
534static inline int scsi_device_ius(struct scsi_device *sdev)
535{
536 if (sdev->inquiry_len < 57)
537 return 0;
538 return sdev->inquiry[56] & 0x01;
539}
540static inline int scsi_device_qas(struct scsi_device *sdev)
541{
542 if (sdev->inquiry_len < 57)
543 return 0;
544 return sdev->inquiry[56] & 0x02;
545}
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600546static inline int scsi_device_enclosure(struct scsi_device *sdev)
547{
Krishnasamy, Somasundaramd1e12de2011-02-28 18:13:22 -0500548 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600549}
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400550
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400551static inline int scsi_device_protection(struct scsi_device *sdev)
552{
Martin K. Petersend974e422012-08-28 14:29:35 -0400553 if (sdev->no_dif)
554 return 0;
555
Hugh Dickinsd211f052008-08-06 18:21:18 +0100556 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400557}
558
Hannes Reinecked7c48fe2011-08-24 10:51:13 +0200559static inline int scsi_device_tpgs(struct scsi_device *sdev)
560{
561 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
562}
563
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200564/**
565 * scsi_device_supports_vpd - test if a device supports VPD pages
566 * @sdev: the &struct scsi_device to test
567 *
568 * If the 'try_vpd_pages' flag is set it takes precedence.
569 * Otherwise we will assume VPD pages are supported if the
570 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
571 */
572static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
573{
574 /* Attempt VPD inquiry if the device blacklist explicitly calls
575 * for it.
576 */
577 if (sdev->try_vpd_pages)
578 return 1;
579 /*
580 * Although VPD inquiries can go to SCSI-2 type devices,
581 * some USB ones crash on receiving them, and the pages
Hannes Reineckee4c36ad2016-04-01 08:57:37 +0200582 * we currently ask for are mandatory for SPC-2 and beyond
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200583 */
Hannes Reineckee4c36ad2016-04-01 08:57:37 +0200584 if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200585 return 1;
586 return 0;
587}
588
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400589#define MODULE_ALIAS_SCSI_DEVICE(type) \
590 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
591#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593#endif /* _SCSI_SCSI_DEVICE_H */