blob: 27ecee73bd72b35b6ad0029686a278ec3ae26de4 [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
Jeff Garzika341cd02007-10-29 17:15:22 -040053enum scsi_device_event {
54 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
Ewan D. Milne279afdf2013-08-08 15:07:48 -040055 SDEV_EVT_INQUIRY_CHANGE_REPORTED, /* 3F 03 UA reported */
56 SDEV_EVT_CAPACITY_CHANGE_REPORTED, /* 2A 09 UA reported */
57 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED, /* 38 07 UA reported */
58 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED, /* 2A 01 UA reported */
59 SDEV_EVT_LUN_CHANGE_REPORTED, /* 3F 0E UA reported */
Jeff Garzika341cd02007-10-29 17:15:22 -040060
Ewan D. Milne279afdf2013-08-08 15:07:48 -040061 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE,
62 SDEV_EVT_LAST = SDEV_EVT_LUN_CHANGE_REPORTED,
63
Jeff Garzika341cd02007-10-29 17:15:22 -040064 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
65};
66
67struct scsi_event {
68 enum scsi_device_event evt_type;
69 struct list_head node;
70
71 /* put union of data structures, for non-simple event types,
72 * here
73 */
74};
75
Linus Torvalds1da177e2005-04-16 15:20:36 -070076struct scsi_device {
77 struct Scsi_Host *host;
78 struct request_queue *request_queue;
79
80 /* the next two are protected by the host->host_lock */
81 struct list_head siblings; /* list of all devices on this host */
82 struct list_head same_target_siblings; /* just the devices sharing same target id */
83
Christoph Hellwig71e75c92014-04-11 19:07:01 +020084 atomic_t device_busy; /* commands actually active on LLDD */
Christoph Hellwigcd9070c2014-01-23 12:07:41 +010085 atomic_t device_blocked; /* Device returned QUEUE_FULL. */
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 spinlock_t list_lock;
88 struct list_head cmd_list; /* queue of in use SCSI Command structures */
89 struct list_head starved_entry;
90 struct scsi_cmnd *current_cmnd; /* currently active command */
91 unsigned short queue_depth; /* How deep of a queue we want */
Vasu Dev4a840672009-10-22 15:46:33 -070092 unsigned short max_queue_depth; /* max queue depth */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 unsigned short last_queue_full_depth; /* These two are used by */
94 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
Vasu Dev4a840672009-10-22 15:46:33 -070095 unsigned long last_queue_full_time; /* last queue full time */
96 unsigned long queue_ramp_up_period; /* ramp up period in jiffies */
97#define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
98
99 unsigned long last_queue_ramp_up; /* last queue ramp up time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200101 unsigned int id, channel;
102 u64 lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 unsigned int manufacturer; /* Manufacturer of device, for using
104 * vendor-specific cmd's */
105 unsigned sector_size; /* size in bytes */
106
107 void *hostdata; /* available to low-level driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 char type;
109 char scsi_level;
110 char inq_periph_qual; /* PQ from INQUIRY data */
111 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
112 unsigned char * inquiry; /* INQUIRY response data */
James Bottomley7f23e142005-12-01 12:50:13 -0600113 const char * vendor; /* [back_compat] point into 'inquiry' ... */
114 const char * model; /* ... after scan; point to static string */
115 const char * rev; /* ... "nullnullnullnull" before scan */
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100116
117#define SCSI_VPD_PG_LEN 255
118 int vpd_pg83_len;
119 unsigned char *vpd_pg83;
120 int vpd_pg80_len;
121 unsigned char *vpd_pg80;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 unsigned char current_tag; /* current tag */
123 struct scsi_target *sdev_target; /* used only for single_lun */
124
125 unsigned int sdev_bflags; /* black/white flags as also found in
126 * scsi_devinfo.[hc]. For now used only to
127 * pass settings from slave_alloc to scsi
128 * core. */
Martin K. Petersen0816c922013-05-10 10:36:04 -0400129 unsigned int eh_timeout; /* Error handling timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 unsigned removable:1;
131 unsigned changed:1; /* Data invalid due to media change */
132 unsigned busy:1; /* Used to prevent races */
133 unsigned lockable:1; /* Able to prevent media removal */
134 unsigned locked:1; /* Media removal disabled */
135 unsigned borken:1; /* Tell the Seagate driver to be
136 * painfully slow on this device */
137 unsigned disconnect:1; /* can disconnect */
138 unsigned soft_reset:1; /* Uses soft reset option */
139 unsigned sdtr:1; /* Device supports SDTR messages */
140 unsigned wdtr:1; /* Device supports WDTR messages */
141 unsigned ppr:1; /* Device supports PPR messages */
142 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
143 unsigned simple_tags:1; /* simple queue tag messages are enabled */
144 unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 unsigned was_reset:1; /* There was a bus reset on the bus for
146 * this device */
147 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
148 * because we did a bus reset. */
149 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
150 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400151 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400152 unsigned no_write_same:1; /* no WRITE SAME command */
Jason J. Herne53ad5702012-11-14 17:03:22 -0500153 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
155 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
Alan Stern09b6b512012-01-10 13:43:30 -0500156 unsigned skip_vpd_pages:1; /* do not read VPD pages */
Martin K. Petersenc1d40a52014-07-15 12:49:17 -0400157 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
159 unsigned no_start_on_add:1; /* do not issue start on add */
160 unsigned allow_restart:1; /* issue START_UNIT in error handler */
Tejun Heoc3c94c52007-03-21 00:13:59 +0900161 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
Stefan Richterd2886ea2008-05-11 00:34:07 +0200162 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
164 unsigned select_no_atn:1;
165 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
Oliver Neukum61bf54b2007-02-08 09:04:48 +0100166 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
Linus Torvalds18351072008-08-05 21:42:21 -0700168 unsigned last_sector_bug:1; /* do not use multisector accesses on
169 SD_LAST_BUGGY_SECTORS */
Hans de Goede8e04d802010-10-01 14:20:08 -0700170 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
Hans de Goede5ce524b2010-10-01 14:20:10 -0700171 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
Alan Stern6a0bdff2012-06-20 16:04:19 -0400172 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
James Bottomley860dc732009-11-19 17:48:29 -0500173 unsigned is_visible:1; /* is the device visible in sysfs */
Namjae Jeonb81478d2012-07-07 23:05:08 -0400174 unsigned wce_default_on:1; /* Cache is ON by default */
Martin K. Petersend974e422012-08-28 14:29:35 -0400175 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
Alan Sternb14bf2d2014-06-30 11:04:21 -0400176 unsigned broken_fua:1; /* Don't set FUA bit */
Alan Stern50c4e962014-09-02 11:35:50 -0400177 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Aaron Lu6f4c8272013-01-23 15:09:32 +0800179 atomic_t disk_events_disable_depth; /* disable depth for disk events */
180
Jeff Garzika341cd02007-10-29 17:15:22 -0400181 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400182 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
Jeff Garzika341cd02007-10-29 17:15:22 -0400183 struct list_head event_list; /* asserted events */
184 struct work_struct event_work;
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 unsigned int max_device_blocked; /* what device_blocked counts down from */
187#define SCSI_DEFAULT_DEVICE_BLOCKED 3
188
189 atomic_t iorequest_cnt;
190 atomic_t iodone_cnt;
191 atomic_t ioerr_cnt;
192
Tony Jonesee959b02008-02-22 00:13:36 +0100193 struct device sdev_gendev,
194 sdev_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
James Bottomleyffedb452006-02-23 14:27:18 -0600196 struct execute_work ew; /* used to get process context on put */
Jens Axboe9937a5e2011-05-17 11:04:44 +0200197 struct work_struct requeue_work;
James Bottomleyffedb452006-02-23 14:27:18 -0600198
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700199 struct scsi_dh_data *scsi_dh_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 enum scsi_device_state sdev_state;
201 unsigned long sdev_data[0];
202} __attribute__((aligned(sizeof(unsigned long))));
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700203
Hannes Reinecke765cbc62008-07-17 16:52:51 -0700204struct scsi_dh_devlist {
205 char *vendor;
206 char *model;
207};
208
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -0700209typedef void (*activate_complete)(void *, int);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700210struct scsi_device_handler {
211 /* Used by the infrastructure */
212 struct list_head list; /* list of scsi_device_handlers */
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700213
214 /* Filled by the hardware handler */
215 struct module *module;
216 const char *name;
Hannes Reinecke765cbc62008-07-17 16:52:51 -0700217 const struct scsi_dh_devlist *devlist;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700218 int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
Hannes Reinecke765cbc62008-07-17 16:52:51 -0700219 int (*attach)(struct scsi_device *);
220 void (*detach)(struct scsi_device *);
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -0700221 int (*activate)(struct scsi_device *, activate_complete, void *);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700222 int (*prep_fn)(struct scsi_device *, struct request *);
Chandra Seetharaman18ee70c2009-08-03 12:42:33 -0700223 int (*set_params)(struct scsi_device *, const char *);
Hannes Reinecke6c3633d2011-08-24 10:51:15 +0200224 bool (*match)(struct scsi_device *);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700225};
226
227struct scsi_dh_data {
228 struct scsi_device_handler *scsi_dh;
Chandra Seetharaman6c10db72009-06-26 19:30:06 -0700229 struct scsi_device *sdev;
230 struct kref kref;
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700231 char buf[0];
232};
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234#define to_scsi_device(d) \
235 container_of(d, struct scsi_device, sdev_gendev)
236#define class_to_sdev(d) \
Tony Jonesee959b02008-02-22 00:13:36 +0100237 container_of(d, struct scsi_device, sdev_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238#define transport_class_to_sdev(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100239 to_scsi_device(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
James Bottomley9ccfc752005-10-02 11:45:08 -0500241#define sdev_printk(prefix, sdev, fmt, a...) \
242 dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
243
Dan Williams3af74a32014-02-06 12:23:07 -0800244#define sdev_dbg(sdev, fmt, a...) \
245 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
246
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500247#define scmd_printk(prefix, scmd, fmt, a...) \
248 (scmd)->request->rq_disk ? \
249 sdev_printk(prefix, (scmd)->device, "[%s] " fmt, \
250 (scmd)->request->rq_disk->disk_name, ##a) : \
251 sdev_printk(prefix, (scmd)->device, fmt, ##a)
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400252
Dan Williams3af74a32014-02-06 12:23:07 -0800253#define scmd_dbg(scmd, fmt, a...) \
254 do { \
255 if ((scmd)->request->rq_disk) \
256 sdev_dbg((scmd)->device, "[%s] " fmt, \
257 (scmd)->request->rq_disk->disk_name, ##a);\
258 else \
259 sdev_dbg((scmd)->device, fmt, ##a); \
260 } while (0)
261
James Bottomleyffedb452006-02-23 14:27:18 -0600262enum scsi_target_state {
James Bottomley643eb2d2008-03-22 22:42:27 -0500263 STARGET_CREATED = 1,
264 STARGET_RUNNING,
James Bottomleyffedb452006-02-23 14:27:18 -0600265 STARGET_DEL,
266};
267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268/*
269 * scsi_target: representation of a scsi target, for now, this is only
270 * used for single_lun devices. If no one has active IO to the target,
271 * starget_sdev_user is NULL, else it points to the active sdev.
272 */
273struct scsi_target {
274 struct scsi_device *starget_sdev_user;
275 struct list_head siblings;
276 struct list_head devices;
277 struct device dev;
James Bottomleye63ed0d2014-01-21 07:00:50 -0800278 struct kref reap_ref; /* last put renders target invisible */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 unsigned int channel;
280 unsigned int id; /* target id ... replace
281 * scsi_device.id eventually */
Alan Stern1bfc5d92006-02-09 15:26:18 -0500282 unsigned int create:1; /* signal that it needs to be added */
Tony Battersby25d7c362007-11-12 10:00:44 -0500283 unsigned int single_lun:1; /* Indicates we should only
284 * allow I/O to one of the luns
285 * for the device at a time. */
Alan Sternde8c46b2012-01-10 13:43:04 -0500286 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f
287 * means no lun present. */
Alan Stern09b6b512012-01-10 13:43:30 -0500288 unsigned int no_report_luns:1; /* Don't use
289 * REPORT LUNS for scanning. */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400290 unsigned int expecting_lun_change:1; /* A device has reported
291 * a 3F/0E UA, other devices on
292 * the same target will also. */
Christoph Hellwig7ae65c02014-01-22 14:49:41 +0100293 /* commands actually active on LLD. */
294 atomic_t target_busy;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100295 atomic_t target_blocked;
296
Mike Christief0c0a372008-08-17 15:24:38 -0500297 /*
298 * LLDs should set this in the slave_alloc host template callout.
299 * If set to zero then there is not limit.
300 */
301 unsigned int can_queue;
Mike Christief0c0a372008-08-17 15:24:38 -0500302 unsigned int max_target_blocked;
303#define SCSI_DEFAULT_TARGET_BLOCKED 3
Alan Stern1bfc5d92006-02-09 15:26:18 -0500304
James Bottomley6f3a2022005-09-22 20:33:28 -0500305 char scsi_level;
James Bottomleyffedb452006-02-23 14:27:18 -0600306 enum scsi_target_state state;
James Bottomleya283bd32005-05-24 12:06:38 -0500307 void *hostdata; /* available to low-level driver */
308 unsigned long starget_data[0]; /* for the transport */
309 /* starget_data must be the last element!!!! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310} __attribute__((aligned(sizeof(unsigned long))));
311
312#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
313static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
314{
315 return to_scsi_target(sdev->sdev_gendev.parent);
316}
317#define transport_class_to_starget(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100318 to_scsi_target(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
James Bottomley9ccfc752005-10-02 11:45:08 -0500320#define starget_printk(prefix, starget, fmt, a...) \
321 dev_printk(prefix, &(starget)->dev, fmt, ##a)
322
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200324 uint, uint, u64, void *hostdata);
James Bottomley146f7262005-09-10 12:44:09 -0500325extern int scsi_add_device(struct Scsi_Host *host, uint channel,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200326 uint target, u64 lun);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700327extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328extern void scsi_remove_device(struct scsi_device *);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700329extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100330void scsi_attach_vpd(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332extern int scsi_device_get(struct scsi_device *);
333extern void scsi_device_put(struct scsi_device *);
334extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200335 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200337 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200339 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200341 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342extern void starget_for_each_device(struct scsi_target *, void *,
343 void (*fn)(struct scsi_device *, void *));
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800344extern void __starget_for_each_device(struct scsi_target *, void *,
345 void (*fn)(struct scsi_device *,
346 void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348/* only exposed to implement shost_for_each_device */
349extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
350 struct scsi_device *);
351
352/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600353 * shost_for_each_device - iterate over all devices of a host
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. This loop
358 * takes a reference on each device and releases it at the end. If
359 * you break out of the loop, you must call scsi_device_put(sdev).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 */
361#define shost_for_each_device(sdev, shost) \
362 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
363 (sdev); \
364 (sdev) = __scsi_iterate_devices((shost), (sdev)))
365
366/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600367 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
368 * @sdev: the &struct scsi_device to use as a cursor
369 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600371 * Iterator that returns each device attached to @shost. It does _not_
372 * take a reference on the scsi_device, so the whole loop must be
373 * protected by shost->host_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600375 * Note: The only reason to use this is because you need to access the
376 * device list in interrupt context. Otherwise you really want to use
377 * shost_for_each_device instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 */
379#define __shost_for_each_device(sdev, shost) \
380 list_for_each_entry((sdev), &((shost)->__devices), siblings)
381
382extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
383extern int scsi_track_queue_full(struct scsi_device *, int);
384
385extern int scsi_set_medium_removal(struct scsi_device *, char);
386
387extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
388 unsigned char *buffer, int len, int timeout,
James Bottomley1cf72692005-08-28 11:27:01 -0500389 int retries, struct scsi_mode_data *data,
James Bottomleyea73a9f2005-08-28 11:33:52 -0500390 struct scsi_sense_hdr *);
James Bottomley5baba832006-03-18 14:10:35 -0600391extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
392 int modepage, unsigned char *buffer, int len,
393 int timeout, int retries,
394 struct scsi_mode_data *data,
395 struct scsi_sense_hdr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
James Bottomley001aac22007-12-02 19:10:40 +0200397 int retries, struct scsi_sense_hdr *sshdr);
James Bottomleye3deec02009-11-03 12:33:07 -0600398extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
399 int buf_len);
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400400extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
401 unsigned int len, unsigned char opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402extern int scsi_device_set_state(struct scsi_device *sdev,
403 enum scsi_device_state state);
Jeff Garzika341cd02007-10-29 17:15:22 -0400404extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
405 gfp_t gfpflags);
406extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
407extern void sdev_evt_send_simple(struct scsi_device *sdev,
408 enum scsi_device_event evt_type, gfp_t gfpflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409extern int scsi_device_quiesce(struct scsi_device *sdev);
410extern void scsi_device_resume(struct scsi_device *sdev);
411extern void scsi_target_quiesce(struct scsi_target *);
412extern void scsi_target_resume(struct scsi_target *);
413extern void scsi_scan_target(struct device *parent, unsigned int channel,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200414 unsigned int id, u64 lun, int rescan);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415extern void scsi_target_reap(struct scsi_target *);
416extern void scsi_target_block(struct device *);
Mike Christie5d9fb5c2012-05-17 23:56:57 -0500417extern void scsi_target_unblock(struct device *, enum scsi_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418extern void scsi_remove_target(struct device *);
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200419extern void int_to_scsilun(u64, struct scsi_lun *);
420extern u64 scsilun_to_int(struct scsi_lun *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421extern const char *scsi_device_state_name(enum scsi_device_state);
422extern int scsi_is_sdev_device(const struct device *);
423extern int scsi_is_target_device(const struct device *);
James Bottomley33aa6872005-08-28 11:31:14 -0500424extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
425 int data_direction, void *buffer, unsigned bufflen,
426 unsigned char *sense, int timeout, int retries,
Martin K. Petersen2bfad212014-04-09 22:20:48 -0400427 u64 flags, int *resid);
Lin Ming9b214932013-03-23 11:42:25 +0800428extern int scsi_execute_req_flags(struct scsi_device *sdev,
429 const unsigned char *cmd, int data_direction, void *buffer,
430 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
Martin K. Petersen2bfad212014-04-09 22:20:48 -0400431 int retries, int *resid, u64 flags);
Lin Ming9b214932013-03-23 11:42:25 +0800432static inline int scsi_execute_req(struct scsi_device *sdev,
433 const unsigned char *cmd, int data_direction, void *buffer,
434 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
435 int retries, int *resid)
436{
437 return scsi_execute_req_flags(sdev, cmd, data_direction, buffer,
438 bufflen, sshdr, timeout, retries, resid, 0);
439}
Aaron Lu6f4c8272013-01-23 15:09:32 +0800440extern void sdev_disable_disk_events(struct scsi_device *sdev);
441extern void sdev_enable_disk_events(struct scsi_device *sdev);
James Bottomley33aa6872005-08-28 11:31:14 -0500442
Alan Sternbc4f2402010-06-17 10:41:42 -0400443#ifdef CONFIG_PM_RUNTIME
444extern int scsi_autopm_get_device(struct scsi_device *);
445extern void scsi_autopm_put_device(struct scsi_device *);
446#else
447static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
448static inline void scsi_autopm_put_device(struct scsi_device *d) {}
449#endif /* CONFIG_PM_RUNTIME */
450
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400451static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
James Bottomleye28482c2006-03-14 14:24:55 -0600452{
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400453 return device_reprobe(&sdev->sdev_gendev);
James Bottomleye28482c2006-03-14 14:24:55 -0600454}
455
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400456static inline unsigned int sdev_channel(struct scsi_device *sdev)
457{
458 return sdev->channel;
459}
460
461static inline unsigned int sdev_id(struct scsi_device *sdev)
462{
463 return sdev->id;
464}
465
466#define scmd_id(scmd) sdev_id((scmd)->device)
467#define scmd_channel(scmd) sdev_channel((scmd)->device)
468
James Bottomley0f1d87a2008-08-22 16:43:59 -0500469/*
470 * checks for positions of the SCSI state machine
471 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472static inline int scsi_device_online(struct scsi_device *sdev)
473{
Hannes Reinecke0762a482009-01-12 09:28:55 +0100474 return (sdev->sdev_state != SDEV_OFFLINE &&
Mike Christie1b8d2622012-05-17 23:56:56 -0500475 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
Hannes Reinecke0762a482009-01-12 09:28:55 +0100476 sdev->sdev_state != SDEV_DEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477}
James Bottomley0f1d87a2008-08-22 16:43:59 -0500478static inline int scsi_device_blocked(struct scsi_device *sdev)
479{
James Bottomley6f4267e2008-08-22 16:53:31 -0500480 return sdev->sdev_state == SDEV_BLOCK ||
481 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a2008-08-22 16:43:59 -0500482}
483static inline int scsi_device_created(struct scsi_device *sdev)
484{
James Bottomley6f4267e2008-08-22 16:53:31 -0500485 return sdev->sdev_state == SDEV_CREATED ||
486 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a2008-08-22 16:43:59 -0500487}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
489/* accessor functions for the SCSI parameters */
490static inline int scsi_device_sync(struct scsi_device *sdev)
491{
492 return sdev->sdtr;
493}
494static inline int scsi_device_wide(struct scsi_device *sdev)
495{
496 return sdev->wdtr;
497}
498static inline int scsi_device_dt(struct scsi_device *sdev)
499{
500 return sdev->ppr;
501}
502static inline int scsi_device_dt_only(struct scsi_device *sdev)
503{
504 if (sdev->inquiry_len < 57)
505 return 0;
506 return (sdev->inquiry[56] & 0x0c) == 0x04;
507}
508static inline int scsi_device_ius(struct scsi_device *sdev)
509{
510 if (sdev->inquiry_len < 57)
511 return 0;
512 return sdev->inquiry[56] & 0x01;
513}
514static inline int scsi_device_qas(struct scsi_device *sdev)
515{
516 if (sdev->inquiry_len < 57)
517 return 0;
518 return sdev->inquiry[56] & 0x02;
519}
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600520static inline int scsi_device_enclosure(struct scsi_device *sdev)
521{
Krishnasamy, Somasundaramd1e12de2011-02-28 18:13:22 -0500522 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600523}
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400524
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400525static inline int scsi_device_protection(struct scsi_device *sdev)
526{
Martin K. Petersend974e422012-08-28 14:29:35 -0400527 if (sdev->no_dif)
528 return 0;
529
Hugh Dickinsd211f052008-08-06 18:21:18 +0100530 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400531}
532
Hannes Reinecked7c48fe2011-08-24 10:51:13 +0200533static inline int scsi_device_tpgs(struct scsi_device *sdev)
534{
535 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
536}
537
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400538#define MODULE_ALIAS_SCSI_DEVICE(type) \
539 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
540#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542#endif /* _SCSI_SCSI_DEVICE_H */