blob: 202f4d6a434212bd9914b4b3988aeff32a66dc09 [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 Garzika341cd0f2007-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 Garzika341cd0f2007-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 Garzika341cd0f2007-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;
113 struct list_head cmd_list; /* queue of in use SCSI Command structures */
114 struct list_head starved_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 unsigned short queue_depth; /* How deep of a queue we want */
Vasu Dev4a840672009-10-22 15:46:33 -0700116 unsigned short max_queue_depth; /* max queue depth */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 unsigned short last_queue_full_depth; /* These two are used by */
118 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
Vasu Dev4a840672009-10-22 15:46:33 -0700119 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)
122
123 unsigned long last_queue_ramp_up; /* last queue ramp up time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200125 unsigned int id, channel;
126 u64 lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 unsigned int manufacturer; /* Manufacturer of device, for using
128 * vendor-specific cmd's */
129 unsigned sector_size; /* size in bytes */
130
131 void *hostdata; /* available to low-level driver */
Bart Van Asschec2e872a2017-08-25 13:46:28 -0700132 unsigned char type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 char scsi_level;
134 char inq_periph_qual; /* PQ from INQUIRY data */
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100135 struct mutex inquiry_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
137 unsigned char * inquiry; /* INQUIRY response data */
James Bottomley7f23e142005-12-01 12:50:13 -0600138 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 */
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100141
142#define SCSI_VPD_PG_LEN 255
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700143 struct scsi_vpd __rcu *vpd_pg83;
144 struct scsi_vpd __rcu *vpd_pg80;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 unsigned char current_tag; /* current tag */
146 struct scsi_target *sdev_target; /* used only for single_lun */
147
Hannes Reinecke5ebde462017-11-15 12:07:30 +0100148 blist_flags_t sdev_bflags; /* black/white flags as also found in
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 * scsi_devinfo.[hc]. For now used only to
150 * pass settings from slave_alloc to scsi
151 * core. */
Martin K. Petersen0816c922013-05-10 10:36:04 -0400152 unsigned int eh_timeout; /* Error handling timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 unsigned removable:1;
154 unsigned changed:1; /* Data invalid due to media change */
155 unsigned busy:1; /* Used to prevent races */
156 unsigned lockable:1; /* Able to prevent media removal */
157 unsigned locked:1; /* Media removal disabled */
158 unsigned borken:1; /* Tell the Seagate driver to be
159 * painfully slow on this device */
160 unsigned disconnect:1; /* can disconnect */
161 unsigned soft_reset:1; /* Uses soft reset option */
162 unsigned sdtr:1; /* Device supports SDTR messages */
163 unsigned wdtr:1; /* Device supports WDTR messages */
164 unsigned ppr:1; /* Device supports PPR messages */
165 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
166 unsigned simple_tags:1; /* simple queue tag messages are enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 unsigned was_reset:1; /* There was a bus reset on the bus for
168 * this device */
169 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
170 * because we did a bus reset. */
171 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
172 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400173 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400174 unsigned no_write_same:1; /* no WRITE SAME command */
Jason J. Herne53ad5702012-11-14 17:03:22 -0500175 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
177 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
Alan Stern09b6b512012-01-10 13:43:30 -0500178 unsigned skip_vpd_pages:1; /* do not read VPD pages */
Martin K. Petersenc1d40a52014-07-15 12:49:17 -0400179 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
181 unsigned no_start_on_add:1; /* do not issue start on add */
182 unsigned allow_restart:1; /* issue START_UNIT in error handler */
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900183 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
Stefan Richterd2886ea2008-05-11 00:34:07 +0200184 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
186 unsigned select_no_atn:1;
187 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
Oliver Neukum61bf54b2007-02-08 09:04:48 +0100188 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
Linus Torvalds18351072008-08-05 21:42:21 -0700190 unsigned last_sector_bug:1; /* do not use multisector accesses on
191 SD_LAST_BUGGY_SECTORS */
Hans de Goede8e04d802010-10-01 14:20:08 -0700192 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
Hans de Goede5ce524b2010-10-01 14:20:10 -0700193 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
Alan Stern6a0bdff2012-06-20 16:04:19 -0400194 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
Christoph Hellwigd80210f2017-06-19 14:26:46 +0200195 unsigned security_supported:1; /* Supports Security Protocols */
James Bottomley860dc732009-11-19 17:48:29 -0500196 unsigned is_visible:1; /* is the device visible in sysfs */
Namjae Jeonb81478d2012-07-07 23:05:08 -0400197 unsigned wce_default_on:1; /* Cache is ON by default */
Martin K. Petersend974e422012-08-28 14:29:35 -0400198 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
Alan Sternb14bf2d2014-06-30 11:04:21 -0400199 unsigned broken_fua:1; /* Don't set FUA bit */
Alan Stern50c4e962014-09-02 11:35:50 -0400200 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
Martin K. Petersen28a0bc42017-09-27 21:35:12 -0400201 unsigned unmap_limit_for_ws:1; /* Use the UNMAP limit for WRITE SAME */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Aaron Lu6f4c8272013-01-23 15:09:32 +0800203 atomic_t disk_events_disable_depth; /* disable depth for disk events */
204
Jeff Garzika341cd0f2007-10-29 17:15:22 -0400205 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400206 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
Jeff Garzika341cd0f2007-10-29 17:15:22 -0400207 struct list_head event_list; /* asserted events */
208 struct work_struct event_work;
209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 unsigned int max_device_blocked; /* what device_blocked counts down from */
211#define SCSI_DEFAULT_DEVICE_BLOCKED 3
212
213 atomic_t iorequest_cnt;
214 atomic_t iodone_cnt;
215 atomic_t ioerr_cnt;
216
Tony Jonesee959b02008-02-22 00:13:36 +0100217 struct device sdev_gendev,
218 sdev_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
James Bottomleyffedb452006-02-23 14:27:18 -0600220 struct execute_work ew; /* used to get process context on put */
Jens Axboe9937a5e2011-05-17 11:04:44 +0200221 struct work_struct requeue_work;
James Bottomleyffedb452006-02-23 14:27:18 -0600222
Christoph Hellwigee14c672015-08-27 14:16:59 +0200223 struct scsi_device_handler *handler;
224 void *handler_data;
225
Hannes Reinecke77c9df92016-03-03 07:54:07 +0100226 unsigned char access_state;
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700227 struct mutex state_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 enum scsi_device_state sdev_state;
Bart Van Assche3a0a5292017-11-09 10:49:58 -0800229 struct task_struct *quiesced_by;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 unsigned long sdev_data[0];
231} __attribute__((aligned(sizeof(unsigned long))));
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233#define to_scsi_device(d) \
234 container_of(d, struct scsi_device, sdev_gendev)
235#define class_to_sdev(d) \
Tony Jonesee959b02008-02-22 00:13:36 +0100236 container_of(d, struct scsi_device, sdev_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237#define transport_class_to_sdev(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100238 to_scsi_device(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Dan Williams3af74a32014-02-06 12:23:07 -0800240#define sdev_dbg(sdev, fmt, a...) \
241 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
242
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200243/*
244 * like scmd_printk, but the device name is passed in
245 * as a string pointer
246 */
Hannes Reinecke9c4a6b12015-02-04 08:11:34 +0100247__printf(4, 5) void
Christoph Hellwig6a806cb2015-01-18 16:11:29 +0100248sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
249 const char *, ...);
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200250
Hannes Reineckeded85c192015-01-08 07:43:42 +0100251#define sdev_printk(l, sdev, fmt, a...) \
252 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
253
Hannes Reinecke9c4a6b12015-02-04 08:11:34 +0100254__printf(3, 4) void
Christoph Hellwig6a806cb2015-01-18 16:11:29 +0100255scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...);
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400256
Dan Williams3af74a32014-02-06 12:23:07 -0800257#define scmd_dbg(scmd, fmt, a...) \
258 do { \
259 if ((scmd)->request->rq_disk) \
260 sdev_dbg((scmd)->device, "[%s] " fmt, \
261 (scmd)->request->rq_disk->disk_name, ##a);\
262 else \
263 sdev_dbg((scmd)->device, fmt, ##a); \
264 } while (0)
265
James Bottomleyffedb452006-02-23 14:27:18 -0600266enum scsi_target_state {
James Bottomley643eb2d2008-03-22 22:42:27 -0500267 STARGET_CREATED = 1,
268 STARGET_RUNNING,
Johannes Thumshirnf05795d2016-04-05 11:50:44 +0200269 STARGET_REMOVE,
Ewan D. Milnef9279c92017-06-27 14:55:58 -0400270 STARGET_CREATED_REMOVE,
James Bottomleyffedb452006-02-23 14:27:18 -0600271 STARGET_DEL,
272};
273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274/*
275 * scsi_target: representation of a scsi target, for now, this is only
276 * used for single_lun devices. If no one has active IO to the target,
277 * starget_sdev_user is NULL, else it points to the active sdev.
278 */
279struct scsi_target {
280 struct scsi_device *starget_sdev_user;
281 struct list_head siblings;
282 struct list_head devices;
283 struct device dev;
James Bottomleye63ed0d2014-01-21 07:00:50 -0800284 struct kref reap_ref; /* last put renders target invisible */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 unsigned int channel;
286 unsigned int id; /* target id ... replace
287 * scsi_device.id eventually */
Alan Stern1bfc5d92006-02-09 15:26:18 -0500288 unsigned int create:1; /* signal that it needs to be added */
Tony Battersby25d7c362007-11-12 10:00:44 -0500289 unsigned int single_lun:1; /* Indicates we should only
290 * allow I/O to one of the luns
291 * for the device at a time. */
Alan Sternde8c46b2012-01-10 13:43:04 -0500292 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f
293 * means no lun present. */
Alan Stern09b6b512012-01-10 13:43:30 -0500294 unsigned int no_report_luns:1; /* Don't use
295 * REPORT LUNS for scanning. */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400296 unsigned int expecting_lun_change:1; /* A device has reported
297 * a 3F/0E UA, other devices on
298 * the same target will also. */
Christoph Hellwig7ae65c02014-01-22 14:49:41 +0100299 /* commands actually active on LLD. */
300 atomic_t target_busy;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100301 atomic_t target_blocked;
302
Mike Christief0c0a372008-08-17 15:24:38 -0500303 /*
304 * LLDs should set this in the slave_alloc host template callout.
305 * If set to zero then there is not limit.
306 */
307 unsigned int can_queue;
Mike Christief0c0a372008-08-17 15:24:38 -0500308 unsigned int max_target_blocked;
309#define SCSI_DEFAULT_TARGET_BLOCKED 3
Alan Stern1bfc5d92006-02-09 15:26:18 -0500310
James Bottomley6f3a2022005-09-22 20:33:28 -0500311 char scsi_level;
James Bottomleyffedb452006-02-23 14:27:18 -0600312 enum scsi_target_state state;
James Bottomleya283bd32005-05-24 12:06:38 -0500313 void *hostdata; /* available to low-level driver */
314 unsigned long starget_data[0]; /* for the transport */
315 /* starget_data must be the last element!!!! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316} __attribute__((aligned(sizeof(unsigned long))));
317
318#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
319static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
320{
321 return to_scsi_target(sdev->sdev_gendev.parent);
322}
323#define transport_class_to_starget(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100324 to_scsi_target(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
James Bottomley9ccfc752005-10-02 11:45:08 -0500326#define starget_printk(prefix, starget, fmt, a...) \
327 dev_printk(prefix, &(starget)->dev, fmt, ##a)
328
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200330 uint, uint, u64, void *hostdata);
James Bottomley146f7262005-09-10 12:44:09 -0500331extern int scsi_add_device(struct Scsi_Host *host, uint channel,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200332 uint target, u64 lun);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700333extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334extern void scsi_remove_device(struct scsi_device *);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700335extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100336void scsi_attach_vpd(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Hannes Reinecke857de6e2017-02-17 09:02:45 +0100338extern struct scsi_device *scsi_device_from_queue(struct request_queue *q);
Bart Van Asscheed12e032017-04-05 09:52:50 -0700339extern int __must_check scsi_device_get(struct scsi_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340extern void scsi_device_put(struct scsi_device *);
341extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200342 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200344 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200346 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200348 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349extern void starget_for_each_device(struct scsi_target *, void *,
350 void (*fn)(struct scsi_device *, void *));
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800351extern void __starget_for_each_device(struct scsi_target *, void *,
352 void (*fn)(struct scsi_device *,
353 void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355/* only exposed to implement shost_for_each_device */
356extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
357 struct scsi_device *);
358
359/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600360 * shost_for_each_device - iterate over all devices of a host
361 * @sdev: the &struct scsi_device to use as a cursor
362 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600364 * Iterator that returns each device attached to @shost. This loop
365 * takes a reference on each device and releases it at the end. If
366 * you break out of the loop, you must call scsi_device_put(sdev).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 */
368#define shost_for_each_device(sdev, shost) \
369 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
370 (sdev); \
371 (sdev) = __scsi_iterate_devices((shost), (sdev)))
372
373/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600374 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
375 * @sdev: the &struct scsi_device to use as a cursor
376 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600378 * Iterator that returns each device attached to @shost. It does _not_
379 * take a reference on the scsi_device, so the whole loop must be
380 * protected by shost->host_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600382 * Note: The only reason to use this is because you need to access the
383 * device list in interrupt context. Otherwise you really want to use
384 * shost_for_each_device instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 */
386#define __shost_for_each_device(sdev, shost) \
387 list_for_each_entry((sdev), &((shost)->__devices), siblings)
388
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100389extern int scsi_change_queue_depth(struct scsi_device *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390extern int scsi_track_queue_full(struct scsi_device *, int);
391
392extern int scsi_set_medium_removal(struct scsi_device *, char);
393
394extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
395 unsigned char *buffer, int len, int timeout,
James Bottomley1cf72692005-08-28 11:27:01 -0500396 int retries, struct scsi_mode_data *data,
James Bottomleyea73a9f2005-08-28 11:33:52 -0500397 struct scsi_sense_hdr *);
James Bottomley5baba832006-03-18 14:10:35 -0600398extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
399 int modepage, unsigned char *buffer, int len,
400 int timeout, int retries,
401 struct scsi_mode_data *data,
402 struct scsi_sense_hdr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
James Bottomley001aac22007-12-02 19:10:40 +0200404 int retries, struct scsi_sense_hdr *sshdr);
James Bottomleye3deec02009-11-03 12:33:07 -0600405extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
406 int buf_len);
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400407extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
408 unsigned int len, unsigned char opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409extern int scsi_device_set_state(struct scsi_device *sdev,
410 enum scsi_device_state state);
Jeff Garzika341cd0f2007-10-29 17:15:22 -0400411extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
412 gfp_t gfpflags);
413extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
414extern void sdev_evt_send_simple(struct scsi_device *sdev,
415 enum scsi_device_event evt_type, gfp_t gfpflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416extern int scsi_device_quiesce(struct scsi_device *sdev);
417extern void scsi_device_resume(struct scsi_device *sdev);
418extern void scsi_target_quiesce(struct scsi_target *);
419extern void scsi_target_resume(struct scsi_target *);
420extern void scsi_scan_target(struct device *parent, unsigned int channel,
Hannes Reinecke1d645082016-03-17 08:39:45 +0100421 unsigned int id, u64 lun,
422 enum scsi_scan_mode rescan);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423extern void scsi_target_reap(struct scsi_target *);
424extern void scsi_target_block(struct device *);
Mike Christie5d9fb5c2012-05-17 23:56:57 -0500425extern void scsi_target_unblock(struct device *, enum scsi_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426extern void scsi_remove_target(struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427extern const char *scsi_device_state_name(enum scsi_device_state);
428extern int scsi_is_sdev_device(const struct device *);
429extern int scsi_is_target_device(const struct device *);
Don Brace38464702016-01-27 20:16:26 -0600430extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
Kees Cook704f8392018-07-31 12:51:54 -0700431extern int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500432 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100433 unsigned char *sense, struct scsi_sense_hdr *sshdr,
434 int timeout, int retries, u64 flags,
435 req_flags_t rq_flags, int *resid);
Kees Cook704f8392018-07-31 12:51:54 -0700436/* Make sure any sense buffer is the correct size. */
437#define scsi_execute(sdev, cmd, data_direction, buffer, bufflen, sense, \
438 sshdr, timeout, retries, flags, rq_flags, resid) \
439({ \
440 BUILD_BUG_ON((sense) != NULL && \
441 sizeof(sense) != SCSI_SENSE_BUFFERSIZE); \
442 __scsi_execute(sdev, cmd, data_direction, buffer, bufflen, \
443 sense, sshdr, timeout, retries, flags, rq_flags, \
444 resid); \
445})
Lin Ming9b214932013-03-23 11:42:25 +0800446static inline int scsi_execute_req(struct scsi_device *sdev,
447 const unsigned char *cmd, int data_direction, void *buffer,
448 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
449 int retries, int *resid)
450{
Christoph Hellwigfcbfffe2017-02-23 16:02:37 +0100451 return scsi_execute(sdev, cmd, data_direction, buffer,
452 bufflen, NULL, sshdr, timeout, retries, 0, 0, resid);
Lin Ming9b214932013-03-23 11:42:25 +0800453}
Aaron Lu6f4c8272013-01-23 15:09:32 +0800454extern void sdev_disable_disk_events(struct scsi_device *sdev);
455extern void sdev_enable_disk_events(struct scsi_device *sdev);
Hannes Reinecke9983bed2015-12-01 10:16:55 +0100456extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
Hannes Reineckea8aa3972015-12-01 10:16:57 +0100457extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
James Bottomley33aa6872005-08-28 11:31:14 -0500458
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100459#ifdef CONFIG_PM
Alan Sternbc4f2402010-06-17 10:41:42 -0400460extern int scsi_autopm_get_device(struct scsi_device *);
461extern void scsi_autopm_put_device(struct scsi_device *);
462#else
463static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
464static inline void scsi_autopm_put_device(struct scsi_device *d) {}
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100465#endif /* CONFIG_PM */
Alan Sternbc4f2402010-06-17 10:41:42 -0400466
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400467static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
James Bottomleye28482c2006-03-14 14:24:55 -0600468{
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400469 return device_reprobe(&sdev->sdev_gendev);
James Bottomleye28482c2006-03-14 14:24:55 -0600470}
471
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400472static inline unsigned int sdev_channel(struct scsi_device *sdev)
473{
474 return sdev->channel;
475}
476
477static inline unsigned int sdev_id(struct scsi_device *sdev)
478{
479 return sdev->id;
480}
481
482#define scmd_id(scmd) sdev_id((scmd)->device)
483#define scmd_channel(scmd) sdev_channel((scmd)->device)
484
James Bottomley0f1d87a22008-08-22 16:43:59 -0500485/*
486 * checks for positions of the SCSI state machine
487 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488static inline int scsi_device_online(struct scsi_device *sdev)
489{
Hannes Reinecke0762a482009-01-12 09:28:55 +0100490 return (sdev->sdev_state != SDEV_OFFLINE &&
Mike Christie1b8d2622012-05-17 23:56:56 -0500491 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
Hannes Reinecke0762a482009-01-12 09:28:55 +0100492 sdev->sdev_state != SDEV_DEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493}
James Bottomley0f1d87a22008-08-22 16:43:59 -0500494static inline int scsi_device_blocked(struct scsi_device *sdev)
495{
James Bottomley6f4267e2008-08-22 16:53:31 -0500496 return sdev->sdev_state == SDEV_BLOCK ||
497 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a22008-08-22 16:43:59 -0500498}
499static inline int scsi_device_created(struct scsi_device *sdev)
500{
James Bottomley6f4267e2008-08-22 16:53:31 -0500501 return sdev->sdev_state == SDEV_CREATED ||
502 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a22008-08-22 16:43:59 -0500503}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
Bart Van Assche551eb592017-06-02 14:21:53 -0700505int scsi_internal_device_block_nowait(struct scsi_device *sdev);
Bart Van Assche43f75712017-06-02 14:21:54 -0700506int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
507 enum scsi_device_state new_state);
Bart Van Assche8893cf62017-03-01 09:00:36 -0800508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509/* accessor functions for the SCSI parameters */
510static inline int scsi_device_sync(struct scsi_device *sdev)
511{
512 return sdev->sdtr;
513}
514static inline int scsi_device_wide(struct scsi_device *sdev)
515{
516 return sdev->wdtr;
517}
518static inline int scsi_device_dt(struct scsi_device *sdev)
519{
520 return sdev->ppr;
521}
522static inline int scsi_device_dt_only(struct scsi_device *sdev)
523{
524 if (sdev->inquiry_len < 57)
525 return 0;
526 return (sdev->inquiry[56] & 0x0c) == 0x04;
527}
528static inline int scsi_device_ius(struct scsi_device *sdev)
529{
530 if (sdev->inquiry_len < 57)
531 return 0;
532 return sdev->inquiry[56] & 0x01;
533}
534static inline int scsi_device_qas(struct scsi_device *sdev)
535{
536 if (sdev->inquiry_len < 57)
537 return 0;
538 return sdev->inquiry[56] & 0x02;
539}
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600540static inline int scsi_device_enclosure(struct scsi_device *sdev)
541{
Krishnasamy, Somasundaramd1e12de2011-02-28 18:13:22 -0500542 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600543}
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400544
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400545static inline int scsi_device_protection(struct scsi_device *sdev)
546{
Martin K. Petersend974e422012-08-28 14:29:35 -0400547 if (sdev->no_dif)
548 return 0;
549
Hugh Dickinsd211f052008-08-06 18:21:18 +0100550 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400551}
552
Hannes Reinecked7c48fe2011-08-24 10:51:13 +0200553static inline int scsi_device_tpgs(struct scsi_device *sdev)
554{
555 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
556}
557
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200558/**
559 * scsi_device_supports_vpd - test if a device supports VPD pages
560 * @sdev: the &struct scsi_device to test
561 *
562 * If the 'try_vpd_pages' flag is set it takes precedence.
563 * Otherwise we will assume VPD pages are supported if the
564 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
565 */
566static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
567{
568 /* Attempt VPD inquiry if the device blacklist explicitly calls
569 * for it.
570 */
571 if (sdev->try_vpd_pages)
572 return 1;
573 /*
574 * Although VPD inquiries can go to SCSI-2 type devices,
575 * some USB ones crash on receiving them, and the pages
Hannes Reineckee4c36ad2016-04-01 08:57:37 +0200576 * we currently ask for are mandatory for SPC-2 and beyond
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200577 */
Hannes Reineckee4c36ad2016-04-01 08:57:37 +0200578 if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200579 return 1;
580 return 0;
581}
582
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400583#define MODULE_ALIAS_SCSI_DEVICE(type) \
584 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
585#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587#endif /* _SCSI_SCSI_DEVICE_H */