blob: f6a9fe0ef09c62cf38b28f6cdd9bfd9bad06121a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _SCSI_SCSI_DEVICE_H
2#define _SCSI_SCSI_DEVICE_H
3
4#include <linux/device.h>
5#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <asm/atomic.h>
10
11struct request_queue;
12struct scsi_cmnd;
James Bottomleye10fb912005-07-14 11:54:17 -050013struct scsi_lun;
James Bottomleyea73a9f2005-08-28 11:33:52 -050014struct scsi_sense_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
James Bottomley1cf72692005-08-28 11:27:01 -050016struct scsi_mode_data {
17 __u32 length;
18 __u16 block_descriptor_length;
19 __u8 medium_type;
20 __u8 device_specific;
21 __u8 header_length;
22 __u8 longlba:1;
23};
24
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/*
26 * sdev state: If you alter this, you also need to alter scsi_sysfs.c
27 * (for the ascii descriptions) and the state model enforcer:
28 * scsi_lib:scsi_device_set_state().
29 */
30enum scsi_device_state {
31 SDEV_CREATED = 1, /* device created but not added to sysfs
32 * Only internal commands allowed (for inq) */
33 SDEV_RUNNING, /* device properly configured
34 * All commands allowed */
35 SDEV_CANCEL, /* beginning to delete device
36 * Only error handler commands allowed */
37 SDEV_DEL, /* device deleted
38 * no commands allowed */
39 SDEV_QUIESCE, /* Device quiescent. No block commands
40 * will be accepted, only specials (which
41 * originate in the mid-layer) */
42 SDEV_OFFLINE, /* Device offlined (by error handling or
43 * user request */
44 SDEV_BLOCK, /* Device blocked by scsi lld. No scsi
45 * commands from user or midlayer should be issued
46 * to the scsi lld. */
47};
48
Jeff Garzika341cd02007-10-29 17:15:22 -040049enum scsi_device_event {
50 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
51
52 SDEV_EVT_LAST = SDEV_EVT_MEDIA_CHANGE,
53 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
54};
55
56struct scsi_event {
57 enum scsi_device_event evt_type;
58 struct list_head node;
59
60 /* put union of data structures, for non-simple event types,
61 * here
62 */
63};
64
Linus Torvalds1da177e2005-04-16 15:20:36 -070065struct scsi_device {
66 struct Scsi_Host *host;
67 struct request_queue *request_queue;
68
69 /* the next two are protected by the host->host_lock */
70 struct list_head siblings; /* list of all devices on this host */
71 struct list_head same_target_siblings; /* just the devices sharing same target id */
72
c2a93312005-04-12 16:38:09 -050073 /* this is now protected by the request_queue->queue_lock */
06f81ea2005-04-17 14:57:29 -050074 unsigned int device_busy; /* commands actually active on
75 * low-level. protected by queue_lock. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 spinlock_t list_lock;
77 struct list_head cmd_list; /* queue of in use SCSI Command structures */
78 struct list_head starved_entry;
79 struct scsi_cmnd *current_cmnd; /* currently active command */
80 unsigned short queue_depth; /* How deep of a queue we want */
81 unsigned short last_queue_full_depth; /* These two are used by */
82 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
83 unsigned long last_queue_full_time;/* don't let QUEUE_FULLs on the same
84 jiffie count on our counter, they
85 could all be from the same event. */
86
87 unsigned int id, lun, channel;
88
89 unsigned int manufacturer; /* Manufacturer of device, for using
90 * vendor-specific cmd's */
91 unsigned sector_size; /* size in bytes */
92
93 void *hostdata; /* available to low-level driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 char type;
95 char scsi_level;
96 char inq_periph_qual; /* PQ from INQUIRY data */
97 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
98 unsigned char * inquiry; /* INQUIRY response data */
James Bottomley7f23e142005-12-01 12:50:13 -060099 const char * vendor; /* [back_compat] point into 'inquiry' ... */
100 const char * model; /* ... after scan; point to static string */
101 const char * rev; /* ... "nullnullnullnull" before scan */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 unsigned char current_tag; /* current tag */
103 struct scsi_target *sdev_target; /* used only for single_lun */
104
105 unsigned int sdev_bflags; /* black/white flags as also found in
106 * scsi_devinfo.[hc]. For now used only to
107 * pass settings from slave_alloc to scsi
108 * core. */
109 unsigned writeable:1;
110 unsigned removable:1;
111 unsigned changed:1; /* Data invalid due to media change */
112 unsigned busy:1; /* Used to prevent races */
113 unsigned lockable:1; /* Able to prevent media removal */
114 unsigned locked:1; /* Media removal disabled */
115 unsigned borken:1; /* Tell the Seagate driver to be
116 * painfully slow on this device */
117 unsigned disconnect:1; /* can disconnect */
118 unsigned soft_reset:1; /* Uses soft reset option */
119 unsigned sdtr:1; /* Device supports SDTR messages */
120 unsigned wdtr:1; /* Device supports WDTR messages */
121 unsigned ppr:1; /* Device supports PPR messages */
122 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
123 unsigned simple_tags:1; /* simple queue tag messages are enabled */
124 unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 unsigned was_reset:1; /* There was a bus reset on the bus for
126 * this device */
127 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
128 * because we did a bus reset. */
129 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
130 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
131 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
132 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
133 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
134 unsigned no_start_on_add:1; /* do not issue start on add */
135 unsigned allow_restart:1; /* issue START_UNIT in error handler */
Tejun Heoc3c94c52007-03-21 00:13:59 +0900136 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
138 unsigned select_no_atn:1;
139 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
Oliver Neukum61bf54b2007-02-08 09:04:48 +0100140 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
Hans de Goedea0899d42008-01-20 11:12:26 +0100142 unsigned last_sector_bug:1; /* Always read last sector in a 1 sector read */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Jeff Garzika341cd02007-10-29 17:15:22 -0400144 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
145 struct list_head event_list; /* asserted events */
146 struct work_struct event_work;
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 unsigned int device_blocked; /* Device returned QUEUE_FULL. */
149
150 unsigned int max_device_blocked; /* what device_blocked counts down from */
151#define SCSI_DEFAULT_DEVICE_BLOCKED 3
152
153 atomic_t iorequest_cnt;
154 atomic_t iodone_cnt;
155 atomic_t ioerr_cnt;
156
157 int timeout;
158
Tony Jonesee959b02008-02-22 00:13:36 +0100159 struct device sdev_gendev,
160 sdev_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
James Bottomleyffedb452006-02-23 14:27:18 -0600162 struct execute_work ew; /* used to get process context on put */
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 enum scsi_device_state sdev_state;
165 unsigned long sdev_data[0];
166} __attribute__((aligned(sizeof(unsigned long))));
167#define to_scsi_device(d) \
168 container_of(d, struct scsi_device, sdev_gendev)
169#define class_to_sdev(d) \
Tony Jonesee959b02008-02-22 00:13:36 +0100170 container_of(d, struct scsi_device, sdev_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171#define transport_class_to_sdev(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100172 to_scsi_device(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
James Bottomley9ccfc752005-10-02 11:45:08 -0500174#define sdev_printk(prefix, sdev, fmt, a...) \
175 dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
176
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500177#define scmd_printk(prefix, scmd, fmt, a...) \
178 (scmd)->request->rq_disk ? \
179 sdev_printk(prefix, (scmd)->device, "[%s] " fmt, \
180 (scmd)->request->rq_disk->disk_name, ##a) : \
181 sdev_printk(prefix, (scmd)->device, fmt, ##a)
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400182
James Bottomleyffedb452006-02-23 14:27:18 -0600183enum scsi_target_state {
James Bottomley643eb2d2008-03-22 22:42:27 -0500184 STARGET_CREATED = 1,
185 STARGET_RUNNING,
James Bottomleyffedb452006-02-23 14:27:18 -0600186 STARGET_DEL,
187};
188
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189/*
190 * scsi_target: representation of a scsi target, for now, this is only
191 * used for single_lun devices. If no one has active IO to the target,
192 * starget_sdev_user is NULL, else it points to the active sdev.
193 */
194struct scsi_target {
195 struct scsi_device *starget_sdev_user;
196 struct list_head siblings;
197 struct list_head devices;
198 struct device dev;
199 unsigned int reap_ref; /* protected by the host lock */
200 unsigned int channel;
201 unsigned int id; /* target id ... replace
202 * scsi_device.id eventually */
Alan Stern1bfc5d92006-02-09 15:26:18 -0500203 unsigned int create:1; /* signal that it needs to be added */
Tony Battersby25d7c362007-11-12 10:00:44 -0500204 unsigned int single_lun:1; /* Indicates we should only
205 * allow I/O to one of the luns
206 * for the device at a time. */
Alan Stern1bfc5d92006-02-09 15:26:18 -0500207 unsigned int pdt_1f_for_no_lun; /* PDT = 0x1f */
208 /* means no lun present */
209
James Bottomley6f3a2022005-09-22 20:33:28 -0500210 char scsi_level;
James Bottomleyffedb452006-02-23 14:27:18 -0600211 struct execute_work ew;
212 enum scsi_target_state state;
James Bottomleya283bd32005-05-24 12:06:38 -0500213 void *hostdata; /* available to low-level driver */
214 unsigned long starget_data[0]; /* for the transport */
215 /* starget_data must be the last element!!!! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216} __attribute__((aligned(sizeof(unsigned long))));
217
218#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
219static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
220{
221 return to_scsi_target(sdev->sdev_gendev.parent);
222}
223#define transport_class_to_starget(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100224 to_scsi_target(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
James Bottomley9ccfc752005-10-02 11:45:08 -0500226#define starget_printk(prefix, starget, fmt, a...) \
227 dev_printk(prefix, &(starget)->dev, fmt, ##a)
228
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
230 uint, uint, uint, void *hostdata);
James Bottomley146f7262005-09-10 12:44:09 -0500231extern int scsi_add_device(struct Scsi_Host *host, uint channel,
232 uint target, uint lun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233extern void scsi_remove_device(struct scsi_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235extern int scsi_device_get(struct scsi_device *);
236extern void scsi_device_put(struct scsi_device *);
237extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
238 uint, uint, uint);
239extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
240 uint, uint, uint);
241extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
242 uint);
243extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
244 uint);
245extern void starget_for_each_device(struct scsi_target *, void *,
246 void (*fn)(struct scsi_device *, void *));
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800247extern void __starget_for_each_device(struct scsi_target *, void *,
248 void (*fn)(struct scsi_device *,
249 void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
251/* only exposed to implement shost_for_each_device */
252extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
253 struct scsi_device *);
254
255/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600256 * shost_for_each_device - iterate over all devices of a host
257 * @sdev: the &struct scsi_device to use as a cursor
258 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600260 * Iterator that returns each device attached to @shost. This loop
261 * takes a reference on each device and releases it at the end. If
262 * you break out of the loop, you must call scsi_device_put(sdev).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 */
264#define shost_for_each_device(sdev, shost) \
265 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
266 (sdev); \
267 (sdev) = __scsi_iterate_devices((shost), (sdev)))
268
269/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600270 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
271 * @sdev: the &struct scsi_device to use as a cursor
272 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600274 * Iterator that returns each device attached to @shost. It does _not_
275 * take a reference on the scsi_device, so the whole loop must be
276 * protected by shost->host_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600278 * Note: The only reason to use this is because you need to access the
279 * device list in interrupt context. Otherwise you really want to use
280 * shost_for_each_device instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 */
282#define __shost_for_each_device(sdev, shost) \
283 list_for_each_entry((sdev), &((shost)->__devices), siblings)
284
285extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
286extern int scsi_track_queue_full(struct scsi_device *, int);
287
288extern int scsi_set_medium_removal(struct scsi_device *, char);
289
290extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
291 unsigned char *buffer, int len, int timeout,
James Bottomley1cf72692005-08-28 11:27:01 -0500292 int retries, struct scsi_mode_data *data,
James Bottomleyea73a9f2005-08-28 11:33:52 -0500293 struct scsi_sense_hdr *);
James Bottomley5baba832006-03-18 14:10:35 -0600294extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
295 int modepage, unsigned char *buffer, int len,
296 int timeout, int retries,
297 struct scsi_mode_data *data,
298 struct scsi_sense_hdr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
James Bottomley001aac22007-12-02 19:10:40 +0200300 int retries, struct scsi_sense_hdr *sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301extern int scsi_device_set_state(struct scsi_device *sdev,
302 enum scsi_device_state state);
Jeff Garzika341cd02007-10-29 17:15:22 -0400303extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
304 gfp_t gfpflags);
305extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
306extern void sdev_evt_send_simple(struct scsi_device *sdev,
307 enum scsi_device_event evt_type, gfp_t gfpflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308extern int scsi_device_quiesce(struct scsi_device *sdev);
309extern void scsi_device_resume(struct scsi_device *sdev);
310extern void scsi_target_quiesce(struct scsi_target *);
311extern void scsi_target_resume(struct scsi_target *);
312extern void scsi_scan_target(struct device *parent, unsigned int channel,
313 unsigned int id, unsigned int lun, int rescan);
314extern void scsi_target_reap(struct scsi_target *);
315extern void scsi_target_block(struct device *);
316extern void scsi_target_unblock(struct device *);
317extern void scsi_remove_target(struct device *);
James.Smart@Emulex.Com2f4701d2005-07-13 22:05:03 -0400318extern void int_to_scsilun(unsigned int, struct scsi_lun *);
Christof Schmitt462b7852007-06-19 10:25:30 +0200319extern int scsilun_to_int(struct scsi_lun *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320extern const char *scsi_device_state_name(enum scsi_device_state);
321extern int scsi_is_sdev_device(const struct device *);
322extern int scsi_is_target_device(const struct device *);
James Bottomley33aa6872005-08-28 11:31:14 -0500323extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
324 int data_direction, void *buffer, unsigned bufflen,
325 unsigned char *sense, int timeout, int retries,
326 int flag);
James Bottomleyea73a9f2005-08-28 11:33:52 -0500327extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
328 int data_direction, void *buffer, unsigned bufflen,
329 struct scsi_sense_hdr *, int timeout, int retries);
Mike Christie6e68af62005-11-11 05:30:27 -0600330extern int scsi_execute_async(struct scsi_device *sdev,
brking@us.ibm.combb1d1072006-01-23 15:03:22 -0600331 const unsigned char *cmd, int cmd_len, int data_direction,
Mike Christie6e68af62005-11-11 05:30:27 -0600332 void *buffer, unsigned bufflen, int use_sg,
333 int timeout, int retries, void *privdata,
334 void (*done)(void *, char *, int, int),
335 gfp_t gfp);
James Bottomley33aa6872005-08-28 11:31:14 -0500336
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400337static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
James Bottomleye28482c2006-03-14 14:24:55 -0600338{
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400339 return device_reprobe(&sdev->sdev_gendev);
James Bottomleye28482c2006-03-14 14:24:55 -0600340}
341
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400342static inline unsigned int sdev_channel(struct scsi_device *sdev)
343{
344 return sdev->channel;
345}
346
347static inline unsigned int sdev_id(struct scsi_device *sdev)
348{
349 return sdev->id;
350}
351
352#define scmd_id(scmd) sdev_id((scmd)->device)
353#define scmd_channel(scmd) sdev_channel((scmd)->device)
354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355static inline int scsi_device_online(struct scsi_device *sdev)
356{
357 return sdev->sdev_state != SDEV_OFFLINE;
358}
359
360/* accessor functions for the SCSI parameters */
361static inline int scsi_device_sync(struct scsi_device *sdev)
362{
363 return sdev->sdtr;
364}
365static inline int scsi_device_wide(struct scsi_device *sdev)
366{
367 return sdev->wdtr;
368}
369static inline int scsi_device_dt(struct scsi_device *sdev)
370{
371 return sdev->ppr;
372}
373static inline int scsi_device_dt_only(struct scsi_device *sdev)
374{
375 if (sdev->inquiry_len < 57)
376 return 0;
377 return (sdev->inquiry[56] & 0x0c) == 0x04;
378}
379static inline int scsi_device_ius(struct scsi_device *sdev)
380{
381 if (sdev->inquiry_len < 57)
382 return 0;
383 return sdev->inquiry[56] & 0x01;
384}
385static inline int scsi_device_qas(struct scsi_device *sdev)
386{
387 if (sdev->inquiry_len < 57)
388 return 0;
389 return sdev->inquiry[56] & 0x02;
390}
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600391static inline int scsi_device_enclosure(struct scsi_device *sdev)
392{
393 return sdev->inquiry[6] & (1<<6);
394}
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400395
396#define MODULE_ALIAS_SCSI_DEVICE(type) \
397 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
398#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400#endif /* _SCSI_SCSI_DEVICE_H */