blob: 8a95631448905022c8ca3ce5df8c6dc09221d390 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _SCSI_SCSI_DEVICE_H
2#define _SCSI_SCSI_DEVICE_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/list.h>
5#include <linux/spinlock.h>
James Bottomleyffedb452006-02-23 14:27:18 -06006#include <linux/workqueue.h>
Martin K. Petersena4d04a42007-02-27 22:40:27 -05007#include <linux/blkdev.h>
Hugh Dickinsd211f052008-08-06 18:21:18 +01008#include <scsi/scsi.h>
Arun Sharma600634972011-07-26 16:09:06 -07009#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
Paul Gortmaker313162d2012-01-30 11:46:54 -050011struct device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070012struct request_queue;
13struct scsi_cmnd;
James Bottomleye10fb912005-07-14 11:54:17 -050014struct scsi_lun;
James Bottomleyea73a9f2005-08-28 11:33:52 -050015struct scsi_sense_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
James Bottomley1cf72692005-08-28 11:27:01 -050017struct scsi_mode_data {
18 __u32 length;
19 __u16 block_descriptor_length;
20 __u8 medium_type;
21 __u8 device_specific;
22 __u8 header_length;
23 __u8 longlba:1;
24};
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026/*
27 * sdev state: If you alter this, you also need to alter scsi_sysfs.c
28 * (for the ascii descriptions) and the state model enforcer:
29 * scsi_lib:scsi_device_set_state().
30 */
31enum scsi_device_state {
32 SDEV_CREATED = 1, /* device created but not added to sysfs
33 * Only internal commands allowed (for inq) */
34 SDEV_RUNNING, /* device properly configured
35 * All commands allowed */
36 SDEV_CANCEL, /* beginning to delete device
37 * Only error handler commands allowed */
38 SDEV_DEL, /* device deleted
39 * no commands allowed */
40 SDEV_QUIESCE, /* Device quiescent. No block commands
41 * will be accepted, only specials (which
42 * originate in the mid-layer) */
43 SDEV_OFFLINE, /* Device offlined (by error handling or
44 * user request */
Mike Christie1b8d2622012-05-17 23:56:56 -050045 SDEV_TRANSPORT_OFFLINE, /* Offlined by transport class error handler */
James Bottomley6f4267e2008-08-22 16:53:31 -050046 SDEV_BLOCK, /* Device blocked by scsi lld. No
47 * scsi commands from user or midlayer
48 * should be issued to the scsi
49 * lld. */
50 SDEV_CREATED_BLOCK, /* same as above but for created devices */
Linus Torvalds1da177e2005-04-16 15:20:36 -070051};
52
Hannes Reinecke1d645082016-03-17 08:39:45 +010053enum scsi_scan_mode {
54 SCSI_SCAN_INITIAL = 0,
55 SCSI_SCAN_RESCAN,
56 SCSI_SCAN_MANUAL,
57};
58
Jeff Garzika341cd02007-10-29 17:15:22 -040059enum scsi_device_event {
60 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
Ewan D. Milne279afdf2013-08-08 15:07:48 -040061 SDEV_EVT_INQUIRY_CHANGE_REPORTED, /* 3F 03 UA reported */
62 SDEV_EVT_CAPACITY_CHANGE_REPORTED, /* 2A 09 UA reported */
63 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED, /* 38 07 UA reported */
64 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED, /* 2A 01 UA reported */
65 SDEV_EVT_LUN_CHANGE_REPORTED, /* 3F 0E UA reported */
Hannes Reinecke14c3e672015-07-06 13:41:53 +020066 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, /* 2A 06 UA reported */
Jeff Garzika341cd02007-10-29 17:15:22 -040067
Ewan D. Milne279afdf2013-08-08 15:07:48 -040068 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE,
Hannes Reinecke14c3e672015-07-06 13:41:53 +020069 SDEV_EVT_LAST = SDEV_EVT_ALUA_STATE_CHANGE_REPORTED,
Ewan D. Milne279afdf2013-08-08 15:07:48 -040070
Jeff Garzika341cd02007-10-29 17:15:22 -040071 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
72};
73
74struct scsi_event {
75 enum scsi_device_event evt_type;
76 struct list_head node;
77
78 /* put union of data structures, for non-simple event types,
79 * here
80 */
81};
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083struct scsi_device {
84 struct Scsi_Host *host;
85 struct request_queue *request_queue;
86
87 /* the next two are protected by the host->host_lock */
88 struct list_head siblings; /* list of all devices on this host */
89 struct list_head same_target_siblings; /* just the devices sharing same target id */
90
Christoph Hellwig71e75c92014-04-11 19:07:01 +020091 atomic_t device_busy; /* commands actually active on LLDD */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +010092 atomic_t device_blocked; /* Device returned QUEUE_FULL. */
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 spinlock_t list_lock;
95 struct list_head cmd_list; /* queue of in use SCSI Command structures */
96 struct list_head starved_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 unsigned short queue_depth; /* How deep of a queue we want */
Vasu Dev4a840672009-10-22 15:46:33 -070098 unsigned short max_queue_depth; /* max queue depth */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 unsigned short last_queue_full_depth; /* These two are used by */
100 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
Vasu Dev4a840672009-10-22 15:46:33 -0700101 unsigned long last_queue_full_time; /* last queue full time */
102 unsigned long queue_ramp_up_period; /* ramp up period in jiffies */
103#define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
104
105 unsigned long last_queue_ramp_up; /* last queue ramp up time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200107 unsigned int id, channel;
108 u64 lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 unsigned int manufacturer; /* Manufacturer of device, for using
110 * vendor-specific cmd's */
111 unsigned sector_size; /* size in bytes */
112
113 void *hostdata; /* available to low-level driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 char type;
115 char scsi_level;
116 char inq_periph_qual; /* PQ from INQUIRY data */
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100117 struct mutex inquiry_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
119 unsigned char * inquiry; /* INQUIRY response data */
James Bottomley7f23e142005-12-01 12:50:13 -0600120 const char * vendor; /* [back_compat] point into 'inquiry' ... */
121 const char * model; /* ... after scan; point to static string */
122 const char * rev; /* ... "nullnullnullnull" before scan */
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100123
124#define SCSI_VPD_PG_LEN 255
125 int vpd_pg83_len;
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100126 unsigned char __rcu *vpd_pg83;
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100127 int vpd_pg80_len;
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100128 unsigned char __rcu *vpd_pg80;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 unsigned char current_tag; /* current tag */
130 struct scsi_target *sdev_target; /* used only for single_lun */
131
132 unsigned int sdev_bflags; /* black/white flags as also found in
133 * scsi_devinfo.[hc]. For now used only to
134 * pass settings from slave_alloc to scsi
135 * core. */
Martin K. Petersen0816c922013-05-10 10:36:04 -0400136 unsigned int eh_timeout; /* Error handling timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 unsigned removable:1;
138 unsigned changed:1; /* Data invalid due to media change */
139 unsigned busy:1; /* Used to prevent races */
140 unsigned lockable:1; /* Able to prevent media removal */
141 unsigned locked:1; /* Media removal disabled */
142 unsigned borken:1; /* Tell the Seagate driver to be
143 * painfully slow on this device */
144 unsigned disconnect:1; /* can disconnect */
145 unsigned soft_reset:1; /* Uses soft reset option */
146 unsigned sdtr:1; /* Device supports SDTR messages */
147 unsigned wdtr:1; /* Device supports WDTR messages */
148 unsigned ppr:1; /* Device supports PPR messages */
149 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
150 unsigned simple_tags:1; /* simple queue tag messages are enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 unsigned was_reset:1; /* There was a bus reset on the bus for
152 * this device */
153 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
154 * because we did a bus reset. */
155 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
156 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400157 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400158 unsigned no_write_same:1; /* no WRITE SAME command */
Jason J. Herne53ad5702012-11-14 17:03:22 -0500159 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
161 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
Alan Stern09b6b512012-01-10 13:43:30 -0500162 unsigned skip_vpd_pages:1; /* do not read VPD pages */
Martin K. Petersenc1d40a52014-07-15 12:49:17 -0400163 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
165 unsigned no_start_on_add:1; /* do not issue start on add */
166 unsigned allow_restart:1; /* issue START_UNIT in error handler */
Tejun Heoc3c94c52007-03-21 00:13:59 +0900167 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
Stefan Richterd2886ea2008-05-11 00:34:07 +0200168 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
170 unsigned select_no_atn:1;
171 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
Oliver Neukum61bf54b2007-02-08 09:04:48 +0100172 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
Linus Torvalds18351072008-08-05 21:42:21 -0700174 unsigned last_sector_bug:1; /* do not use multisector accesses on
175 SD_LAST_BUGGY_SECTORS */
Hans de Goede8e04d802010-10-01 14:20:08 -0700176 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
Hans de Goede5ce524b2010-10-01 14:20:10 -0700177 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
Alan Stern6a0bdff2012-06-20 16:04:19 -0400178 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
James Bottomley860dc732009-11-19 17:48:29 -0500179 unsigned is_visible:1; /* is the device visible in sysfs */
Namjae Jeonb81478d2012-07-07 23:05:08 -0400180 unsigned wce_default_on:1; /* Cache is ON by default */
Martin K. Petersend974e422012-08-28 14:29:35 -0400181 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
Alan Sternb14bf2d2014-06-30 11:04:21 -0400182 unsigned broken_fua:1; /* Don't set FUA bit */
Alan Stern50c4e962014-09-02 11:35:50 -0400183 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
Hannes Reinecke851cde92016-02-19 09:17:12 +0100184 unsigned synchronous_alua:1; /* Synchronous ALUA commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Aaron Lu6f4c8272013-01-23 15:09:32 +0800186 atomic_t disk_events_disable_depth; /* disable depth for disk events */
187
Jeff Garzika341cd02007-10-29 17:15:22 -0400188 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400189 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
Jeff Garzika341cd02007-10-29 17:15:22 -0400190 struct list_head event_list; /* asserted events */
191 struct work_struct event_work;
192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 unsigned int max_device_blocked; /* what device_blocked counts down from */
194#define SCSI_DEFAULT_DEVICE_BLOCKED 3
195
196 atomic_t iorequest_cnt;
197 atomic_t iodone_cnt;
198 atomic_t ioerr_cnt;
199
Tony Jonesee959b02008-02-22 00:13:36 +0100200 struct device sdev_gendev,
201 sdev_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
James Bottomleyffedb452006-02-23 14:27:18 -0600203 struct execute_work ew; /* used to get process context on put */
Jens Axboe9937a5e2011-05-17 11:04:44 +0200204 struct work_struct requeue_work;
James Bottomleyffedb452006-02-23 14:27:18 -0600205
Christoph Hellwigee14c672015-08-27 14:16:59 +0200206 struct scsi_device_handler *handler;
207 void *handler_data;
208
Hannes Reinecke77c9df92016-03-03 07:54:07 +0100209 unsigned char access_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 enum scsi_device_state sdev_state;
211 unsigned long sdev_data[0];
212} __attribute__((aligned(sizeof(unsigned long))));
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214#define to_scsi_device(d) \
215 container_of(d, struct scsi_device, sdev_gendev)
216#define class_to_sdev(d) \
Tony Jonesee959b02008-02-22 00:13:36 +0100217 container_of(d, struct scsi_device, sdev_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218#define transport_class_to_sdev(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100219 to_scsi_device(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Dan Williams3af74a32014-02-06 12:23:07 -0800221#define sdev_dbg(sdev, fmt, a...) \
222 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
223
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200224/*
225 * like scmd_printk, but the device name is passed in
226 * as a string pointer
227 */
Hannes Reinecke9c4a6b12015-02-04 08:11:34 +0100228__printf(4, 5) void
Christoph Hellwig6a806cb2015-01-18 16:11:29 +0100229sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
230 const char *, ...);
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200231
Hannes Reineckeded85c12015-01-08 07:43:42 +0100232#define sdev_printk(l, sdev, fmt, a...) \
233 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
234
Hannes Reinecke9c4a6b12015-02-04 08:11:34 +0100235__printf(3, 4) void
Christoph Hellwig6a806cb2015-01-18 16:11:29 +0100236scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...);
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400237
Dan Williams3af74a32014-02-06 12:23:07 -0800238#define scmd_dbg(scmd, fmt, a...) \
239 do { \
240 if ((scmd)->request->rq_disk) \
241 sdev_dbg((scmd)->device, "[%s] " fmt, \
242 (scmd)->request->rq_disk->disk_name, ##a);\
243 else \
244 sdev_dbg((scmd)->device, fmt, ##a); \
245 } while (0)
246
James Bottomleyffedb452006-02-23 14:27:18 -0600247enum scsi_target_state {
James Bottomley643eb2d2008-03-22 22:42:27 -0500248 STARGET_CREATED = 1,
249 STARGET_RUNNING,
Johannes Thumshirnf05795d2016-04-05 11:50:44 +0200250 STARGET_REMOVE,
James Bottomleyffedb452006-02-23 14:27:18 -0600251 STARGET_DEL,
252};
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254/*
255 * scsi_target: representation of a scsi target, for now, this is only
256 * used for single_lun devices. If no one has active IO to the target,
257 * starget_sdev_user is NULL, else it points to the active sdev.
258 */
259struct scsi_target {
260 struct scsi_device *starget_sdev_user;
261 struct list_head siblings;
262 struct list_head devices;
263 struct device dev;
James Bottomleye63ed0d2014-01-21 07:00:50 -0800264 struct kref reap_ref; /* last put renders target invisible */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 unsigned int channel;
266 unsigned int id; /* target id ... replace
267 * scsi_device.id eventually */
Alan Stern1bfc5d92006-02-09 15:26:18 -0500268 unsigned int create:1; /* signal that it needs to be added */
Tony Battersby25d7c362007-11-12 10:00:44 -0500269 unsigned int single_lun:1; /* Indicates we should only
270 * allow I/O to one of the luns
271 * for the device at a time. */
Alan Sternde8c46b2012-01-10 13:43:04 -0500272 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f
273 * means no lun present. */
Alan Stern09b6b512012-01-10 13:43:30 -0500274 unsigned int no_report_luns:1; /* Don't use
275 * REPORT LUNS for scanning. */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400276 unsigned int expecting_lun_change:1; /* A device has reported
277 * a 3F/0E UA, other devices on
278 * the same target will also. */
Christoph Hellwig7ae65c02014-01-22 14:49:41 +0100279 /* commands actually active on LLD. */
280 atomic_t target_busy;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100281 atomic_t target_blocked;
282
Mike Christief0c0a372008-08-17 15:24:38 -0500283 /*
284 * LLDs should set this in the slave_alloc host template callout.
285 * If set to zero then there is not limit.
286 */
287 unsigned int can_queue;
Mike Christief0c0a372008-08-17 15:24:38 -0500288 unsigned int max_target_blocked;
289#define SCSI_DEFAULT_TARGET_BLOCKED 3
Alan Stern1bfc5d92006-02-09 15:26:18 -0500290
James Bottomley6f3a2022005-09-22 20:33:28 -0500291 char scsi_level;
James Bottomleyffedb452006-02-23 14:27:18 -0600292 enum scsi_target_state state;
James Bottomleya283bd32005-05-24 12:06:38 -0500293 void *hostdata; /* available to low-level driver */
294 unsigned long starget_data[0]; /* for the transport */
295 /* starget_data must be the last element!!!! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296} __attribute__((aligned(sizeof(unsigned long))));
297
298#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
299static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
300{
301 return to_scsi_target(sdev->sdev_gendev.parent);
302}
303#define transport_class_to_starget(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100304 to_scsi_target(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
James Bottomley9ccfc752005-10-02 11:45:08 -0500306#define starget_printk(prefix, starget, fmt, a...) \
307 dev_printk(prefix, &(starget)->dev, fmt, ##a)
308
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200310 uint, uint, u64, void *hostdata);
James Bottomley146f7262005-09-10 12:44:09 -0500311extern int scsi_add_device(struct Scsi_Host *host, uint channel,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200312 uint target, u64 lun);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700313extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314extern void scsi_remove_device(struct scsi_device *);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700315extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100316void scsi_attach_vpd(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318extern int scsi_device_get(struct scsi_device *);
319extern void scsi_device_put(struct scsi_device *);
320extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200321 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200323 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200325 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200327 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328extern void starget_for_each_device(struct scsi_target *, void *,
329 void (*fn)(struct scsi_device *, void *));
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800330extern void __starget_for_each_device(struct scsi_target *, void *,
331 void (*fn)(struct scsi_device *,
332 void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
334/* only exposed to implement shost_for_each_device */
335extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
336 struct scsi_device *);
337
338/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600339 * shost_for_each_device - iterate over all devices of a host
340 * @sdev: the &struct scsi_device to use as a cursor
341 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600343 * Iterator that returns each device attached to @shost. This loop
344 * takes a reference on each device and releases it at the end. If
345 * you break out of the loop, you must call scsi_device_put(sdev).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 */
347#define shost_for_each_device(sdev, shost) \
348 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
349 (sdev); \
350 (sdev) = __scsi_iterate_devices((shost), (sdev)))
351
352/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600353 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
354 * @sdev: the &struct scsi_device to use as a cursor
355 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600357 * Iterator that returns each device attached to @shost. It does _not_
358 * take a reference on the scsi_device, so the whole loop must be
359 * protected by shost->host_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600361 * Note: The only reason to use this is because you need to access the
362 * device list in interrupt context. Otherwise you really want to use
363 * shost_for_each_device instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 */
365#define __shost_for_each_device(sdev, shost) \
366 list_for_each_entry((sdev), &((shost)->__devices), siblings)
367
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100368extern int scsi_change_queue_depth(struct scsi_device *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369extern int scsi_track_queue_full(struct scsi_device *, int);
370
371extern int scsi_set_medium_removal(struct scsi_device *, char);
372
373extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
374 unsigned char *buffer, int len, int timeout,
James Bottomley1cf72692005-08-28 11:27:01 -0500375 int retries, struct scsi_mode_data *data,
James Bottomleyea73a9f2005-08-28 11:33:52 -0500376 struct scsi_sense_hdr *);
James Bottomley5baba832006-03-18 14:10:35 -0600377extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
378 int modepage, unsigned char *buffer, int len,
379 int timeout, int retries,
380 struct scsi_mode_data *data,
381 struct scsi_sense_hdr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
James Bottomley001aac22007-12-02 19:10:40 +0200383 int retries, struct scsi_sense_hdr *sshdr);
James Bottomleye3deec02009-11-03 12:33:07 -0600384extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
385 int buf_len);
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400386extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
387 unsigned int len, unsigned char opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388extern int scsi_device_set_state(struct scsi_device *sdev,
389 enum scsi_device_state state);
Jeff Garzika341cd02007-10-29 17:15:22 -0400390extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
391 gfp_t gfpflags);
392extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
393extern void sdev_evt_send_simple(struct scsi_device *sdev,
394 enum scsi_device_event evt_type, gfp_t gfpflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395extern int scsi_device_quiesce(struct scsi_device *sdev);
396extern void scsi_device_resume(struct scsi_device *sdev);
397extern void scsi_target_quiesce(struct scsi_target *);
398extern void scsi_target_resume(struct scsi_target *);
399extern void scsi_scan_target(struct device *parent, unsigned int channel,
Hannes Reinecke1d645082016-03-17 08:39:45 +0100400 unsigned int id, u64 lun,
401 enum scsi_scan_mode rescan);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402extern void scsi_target_reap(struct scsi_target *);
403extern void scsi_target_block(struct device *);
Mike Christie5d9fb5c2012-05-17 23:56:57 -0500404extern void scsi_target_unblock(struct device *, enum scsi_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405extern void scsi_remove_target(struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406extern const char *scsi_device_state_name(enum scsi_device_state);
407extern int scsi_is_sdev_device(const struct device *);
408extern int scsi_is_target_device(const struct device *);
Don Brace38464702016-01-27 20:16:26 -0600409extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
James Bottomley33aa6872005-08-28 11:31:14 -0500410extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
411 int data_direction, void *buffer, unsigned bufflen,
412 unsigned char *sense, int timeout, int retries,
Martin K. Petersen2bfad212014-04-09 22:20:48 -0400413 u64 flags, int *resid);
Lin Ming9b214932013-03-23 11:42:25 +0800414extern int scsi_execute_req_flags(struct scsi_device *sdev,
415 const unsigned char *cmd, int data_direction, void *buffer,
416 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
Martin K. Petersen2bfad212014-04-09 22:20:48 -0400417 int retries, int *resid, u64 flags);
Lin Ming9b214932013-03-23 11:42:25 +0800418static inline int scsi_execute_req(struct scsi_device *sdev,
419 const unsigned char *cmd, int data_direction, void *buffer,
420 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
421 int retries, int *resid)
422{
423 return scsi_execute_req_flags(sdev, cmd, data_direction, buffer,
424 bufflen, sshdr, timeout, retries, resid, 0);
425}
Aaron Lu6f4c8272013-01-23 15:09:32 +0800426extern void sdev_disable_disk_events(struct scsi_device *sdev);
427extern void sdev_enable_disk_events(struct scsi_device *sdev);
Hannes Reinecke9983bed2015-12-01 10:16:55 +0100428extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
Hannes Reineckea8aa3972015-12-01 10:16:57 +0100429extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
James Bottomley33aa6872005-08-28 11:31:14 -0500430
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100431#ifdef CONFIG_PM
Alan Sternbc4f2402010-06-17 10:41:42 -0400432extern int scsi_autopm_get_device(struct scsi_device *);
433extern void scsi_autopm_put_device(struct scsi_device *);
434#else
435static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
436static inline void scsi_autopm_put_device(struct scsi_device *d) {}
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100437#endif /* CONFIG_PM */
Alan Sternbc4f2402010-06-17 10:41:42 -0400438
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400439static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
James Bottomleye28482c2006-03-14 14:24:55 -0600440{
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400441 return device_reprobe(&sdev->sdev_gendev);
James Bottomleye28482c2006-03-14 14:24:55 -0600442}
443
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400444static inline unsigned int sdev_channel(struct scsi_device *sdev)
445{
446 return sdev->channel;
447}
448
449static inline unsigned int sdev_id(struct scsi_device *sdev)
450{
451 return sdev->id;
452}
453
454#define scmd_id(scmd) sdev_id((scmd)->device)
455#define scmd_channel(scmd) sdev_channel((scmd)->device)
456
James Bottomley0f1d87a2008-08-22 16:43:59 -0500457/*
458 * checks for positions of the SCSI state machine
459 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460static inline int scsi_device_online(struct scsi_device *sdev)
461{
Hannes Reinecke0762a482009-01-12 09:28:55 +0100462 return (sdev->sdev_state != SDEV_OFFLINE &&
Mike Christie1b8d2622012-05-17 23:56:56 -0500463 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
Hannes Reinecke0762a482009-01-12 09:28:55 +0100464 sdev->sdev_state != SDEV_DEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465}
James Bottomley0f1d87a2008-08-22 16:43:59 -0500466static inline int scsi_device_blocked(struct scsi_device *sdev)
467{
James Bottomley6f4267e2008-08-22 16:53:31 -0500468 return sdev->sdev_state == SDEV_BLOCK ||
469 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a2008-08-22 16:43:59 -0500470}
471static inline int scsi_device_created(struct scsi_device *sdev)
472{
James Bottomley6f4267e2008-08-22 16:53:31 -0500473 return sdev->sdev_state == SDEV_CREATED ||
474 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a2008-08-22 16:43:59 -0500475}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
477/* accessor functions for the SCSI parameters */
478static inline int scsi_device_sync(struct scsi_device *sdev)
479{
480 return sdev->sdtr;
481}
482static inline int scsi_device_wide(struct scsi_device *sdev)
483{
484 return sdev->wdtr;
485}
486static inline int scsi_device_dt(struct scsi_device *sdev)
487{
488 return sdev->ppr;
489}
490static inline int scsi_device_dt_only(struct scsi_device *sdev)
491{
492 if (sdev->inquiry_len < 57)
493 return 0;
494 return (sdev->inquiry[56] & 0x0c) == 0x04;
495}
496static inline int scsi_device_ius(struct scsi_device *sdev)
497{
498 if (sdev->inquiry_len < 57)
499 return 0;
500 return sdev->inquiry[56] & 0x01;
501}
502static inline int scsi_device_qas(struct scsi_device *sdev)
503{
504 if (sdev->inquiry_len < 57)
505 return 0;
506 return sdev->inquiry[56] & 0x02;
507}
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600508static inline int scsi_device_enclosure(struct scsi_device *sdev)
509{
Krishnasamy, Somasundaramd1e12de2011-02-28 18:13:22 -0500510 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600511}
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400512
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400513static inline int scsi_device_protection(struct scsi_device *sdev)
514{
Martin K. Petersend974e422012-08-28 14:29:35 -0400515 if (sdev->no_dif)
516 return 0;
517
Hugh Dickinsd211f052008-08-06 18:21:18 +0100518 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400519}
520
Hannes Reinecked7c48fe2011-08-24 10:51:13 +0200521static inline int scsi_device_tpgs(struct scsi_device *sdev)
522{
523 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
524}
525
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200526/**
527 * scsi_device_supports_vpd - test if a device supports VPD pages
528 * @sdev: the &struct scsi_device to test
529 *
530 * If the 'try_vpd_pages' flag is set it takes precedence.
531 * Otherwise we will assume VPD pages are supported if the
532 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
533 */
534static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
535{
536 /* Attempt VPD inquiry if the device blacklist explicitly calls
537 * for it.
538 */
539 if (sdev->try_vpd_pages)
540 return 1;
541 /*
542 * Although VPD inquiries can go to SCSI-2 type devices,
543 * some USB ones crash on receiving them, and the pages
Hannes Reineckee4c36ad2016-04-01 08:57:37 +0200544 * we currently ask for are mandatory for SPC-2 and beyond
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200545 */
Hannes Reineckee4c36ad2016-04-01 08:57:37 +0200546 if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200547 return 1;
548 return 0;
549}
550
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400551#define MODULE_ALIAS_SCSI_DEVICE(type) \
552 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
553#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
554
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555#endif /* _SCSI_SCSI_DEVICE_H */