V4L/DVB (12248): v4l: vpfe capture bridge driver for DM355 and DM6446
[linux-2.6-block.git] / include / scsi / scsi_device.h
CommitLineData
1da177e4
LT
1#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>
ffedb452 7#include <linux/workqueue.h>
a4d04a4c 8#include <linux/blkdev.h>
d211f052 9#include <scsi/scsi.h>
1da177e4
LT
10#include <asm/atomic.h>
11
12struct request_queue;
13struct scsi_cmnd;
e10fb91c 14struct scsi_lun;
ea73a9f2 15struct scsi_sense_hdr;
1da177e4 16
1cf72699
JB
17struct 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
1da177e4
LT
26/*
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 */
6f4267e3
JB
45 SDEV_BLOCK, /* Device blocked by scsi lld. No
46 * scsi commands from user or midlayer
47 * should be issued to the scsi
48 * lld. */
49 SDEV_CREATED_BLOCK, /* same as above but for created devices */
1da177e4
LT
50};
51
a341cd0f
JG
52enum scsi_device_event {
53 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
54
55 SDEV_EVT_LAST = SDEV_EVT_MEDIA_CHANGE,
56 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
57};
58
59struct scsi_event {
60 enum scsi_device_event evt_type;
61 struct list_head node;
62
63 /* put union of data structures, for non-simple event types,
64 * here
65 */
66};
67
1da177e4
LT
68struct scsi_device {
69 struct Scsi_Host *host;
70 struct request_queue *request_queue;
71
72 /* the next two are protected by the host->host_lock */
73 struct list_head siblings; /* list of all devices on this host */
74 struct list_head same_target_siblings; /* just the devices sharing same target id */
75
c2a9331c 76 /* this is now protected by the request_queue->queue_lock */
06f81ea8 77 unsigned int device_busy; /* commands actually active on
78 * low-level. protected by queue_lock. */
1da177e4
LT
79 spinlock_t list_lock;
80 struct list_head cmd_list; /* queue of in use SCSI Command structures */
81 struct list_head starved_entry;
82 struct scsi_cmnd *current_cmnd; /* currently active command */
83 unsigned short queue_depth; /* How deep of a queue we want */
84 unsigned short last_queue_full_depth; /* These two are used by */
85 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
86 unsigned long last_queue_full_time;/* don't let QUEUE_FULLs on the same
87 jiffie count on our counter, they
88 could all be from the same event. */
89
90 unsigned int id, lun, channel;
91
92 unsigned int manufacturer; /* Manufacturer of device, for using
93 * vendor-specific cmd's */
94 unsigned sector_size; /* size in bytes */
95
96 void *hostdata; /* available to low-level driver */
1da177e4
LT
97 char type;
98 char scsi_level;
99 char inq_periph_qual; /* PQ from INQUIRY data */
100 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
101 unsigned char * inquiry; /* INQUIRY response data */
7f23e146
JB
102 const char * vendor; /* [back_compat] point into 'inquiry' ... */
103 const char * model; /* ... after scan; point to static string */
104 const char * rev; /* ... "nullnullnullnull" before scan */
1da177e4
LT
105 unsigned char current_tag; /* current tag */
106 struct scsi_target *sdev_target; /* used only for single_lun */
107
108 unsigned int sdev_bflags; /* black/white flags as also found in
109 * scsi_devinfo.[hc]. For now used only to
110 * pass settings from slave_alloc to scsi
111 * core. */
112 unsigned writeable:1;
113 unsigned removable:1;
114 unsigned changed:1; /* Data invalid due to media change */
115 unsigned busy:1; /* Used to prevent races */
116 unsigned lockable:1; /* Able to prevent media removal */
117 unsigned locked:1; /* Media removal disabled */
118 unsigned borken:1; /* Tell the Seagate driver to be
119 * painfully slow on this device */
120 unsigned disconnect:1; /* can disconnect */
121 unsigned soft_reset:1; /* Uses soft reset option */
122 unsigned sdtr:1; /* Device supports SDTR messages */
123 unsigned wdtr:1; /* Device supports WDTR messages */
124 unsigned ppr:1; /* Device supports PPR messages */
125 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
126 unsigned simple_tags:1; /* simple queue tag messages are enabled */
127 unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
1da177e4
LT
128 unsigned was_reset:1; /* There was a bus reset on the bus for
129 * this device */
130 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
131 * because we did a bus reset. */
132 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
133 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
134 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
135 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
136 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
137 unsigned no_start_on_add:1; /* do not issue start on add */
138 unsigned allow_restart:1; /* issue START_UNIT in error handler */
c3c94c5a 139 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
d2886ea3 140 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
1da177e4
LT
141 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
142 unsigned select_no_atn:1;
143 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
61bf54b7 144 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
1da177e4 145 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
18351070
LT
146 unsigned last_sector_bug:1; /* do not use multisector accesses on
147 SD_LAST_BUGGY_SECTORS */
1da177e4 148
a341cd0f
JG
149 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
150 struct list_head event_list; /* asserted events */
151 struct work_struct event_work;
152
1da177e4
LT
153 unsigned int device_blocked; /* Device returned QUEUE_FULL. */
154
155 unsigned int max_device_blocked; /* what device_blocked counts down from */
156#define SCSI_DEFAULT_DEVICE_BLOCKED 3
157
158 atomic_t iorequest_cnt;
159 atomic_t iodone_cnt;
160 atomic_t ioerr_cnt;
161
ee959b00
TJ
162 struct device sdev_gendev,
163 sdev_dev;
1da177e4 164
ffedb452
JB
165 struct execute_work ew; /* used to get process context on put */
166
a6a8d9f8 167 struct scsi_dh_data *scsi_dh_data;
1da177e4
LT
168 enum scsi_device_state sdev_state;
169 unsigned long sdev_data[0];
170} __attribute__((aligned(sizeof(unsigned long))));
a6a8d9f8 171
765cbc6d
HR
172struct scsi_dh_devlist {
173 char *vendor;
174 char *model;
175};
176
a6a8d9f8
CS
177struct scsi_device_handler {
178 /* Used by the infrastructure */
179 struct list_head list; /* list of scsi_device_handlers */
a6a8d9f8
CS
180
181 /* Filled by the hardware handler */
182 struct module *module;
183 const char *name;
765cbc6d 184 const struct scsi_dh_devlist *devlist;
a6a8d9f8 185 int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
765cbc6d
HR
186 int (*attach)(struct scsi_device *);
187 void (*detach)(struct scsi_device *);
a6a8d9f8
CS
188 int (*activate)(struct scsi_device *);
189 int (*prep_fn)(struct scsi_device *, struct request *);
18ee70c9 190 int (*set_params)(struct scsi_device *, const char *);
a6a8d9f8
CS
191};
192
193struct scsi_dh_data {
194 struct scsi_device_handler *scsi_dh;
6c10db72
CS
195 struct scsi_device *sdev;
196 struct kref kref;
a6a8d9f8
CS
197 char buf[0];
198};
199
1da177e4
LT
200#define to_scsi_device(d) \
201 container_of(d, struct scsi_device, sdev_gendev)
202#define class_to_sdev(d) \
ee959b00 203 container_of(d, struct scsi_device, sdev_dev)
1da177e4 204#define transport_class_to_sdev(class_dev) \
ee959b00 205 to_scsi_device(class_dev->parent)
1da177e4 206
9ccfc756
JB
207#define sdev_printk(prefix, sdev, fmt, a...) \
208 dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
209
a4d04a4c
MP
210#define scmd_printk(prefix, scmd, fmt, a...) \
211 (scmd)->request->rq_disk ? \
212 sdev_printk(prefix, (scmd)->device, "[%s] " fmt, \
213 (scmd)->request->rq_disk->disk_name, ##a) : \
214 sdev_printk(prefix, (scmd)->device, fmt, ##a)
01d7b3b8 215
ffedb452 216enum scsi_target_state {
643eb2d9
JB
217 STARGET_CREATED = 1,
218 STARGET_RUNNING,
ffedb452
JB
219 STARGET_DEL,
220};
221
1da177e4
LT
222/*
223 * scsi_target: representation of a scsi target, for now, this is only
224 * used for single_lun devices. If no one has active IO to the target,
225 * starget_sdev_user is NULL, else it points to the active sdev.
226 */
227struct scsi_target {
228 struct scsi_device *starget_sdev_user;
229 struct list_head siblings;
230 struct list_head devices;
231 struct device dev;
232 unsigned int reap_ref; /* protected by the host lock */
233 unsigned int channel;
234 unsigned int id; /* target id ... replace
235 * scsi_device.id eventually */
1bfc5d9d 236 unsigned int create:1; /* signal that it needs to be added */
25d7c363
TB
237 unsigned int single_lun:1; /* Indicates we should only
238 * allow I/O to one of the luns
239 * for the device at a time. */
1bfc5d9d
AS
240 unsigned int pdt_1f_for_no_lun; /* PDT = 0x1f */
241 /* means no lun present */
f0c0a376
MC
242 /* commands actually active on LLD. protected by host lock. */
243 unsigned int target_busy;
244 /*
245 * LLDs should set this in the slave_alloc host template callout.
246 * If set to zero then there is not limit.
247 */
248 unsigned int can_queue;
249 unsigned int target_blocked;
250 unsigned int max_target_blocked;
251#define SCSI_DEFAULT_TARGET_BLOCKED 3
1bfc5d9d 252
6f3a2024 253 char scsi_level;
ffedb452
JB
254 struct execute_work ew;
255 enum scsi_target_state state;
a283bd37
JB
256 void *hostdata; /* available to low-level driver */
257 unsigned long starget_data[0]; /* for the transport */
258 /* starget_data must be the last element!!!! */
1da177e4
LT
259} __attribute__((aligned(sizeof(unsigned long))));
260
261#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
262static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
263{
264 return to_scsi_target(sdev->sdev_gendev.parent);
265}
266#define transport_class_to_starget(class_dev) \
ee959b00 267 to_scsi_target(class_dev->parent)
1da177e4 268
9ccfc756
JB
269#define starget_printk(prefix, starget, fmt, a...) \
270 dev_printk(prefix, &(starget)->dev, fmt, ##a)
271
1da177e4
LT
272extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
273 uint, uint, uint, void *hostdata);
146f7262
JB
274extern int scsi_add_device(struct Scsi_Host *host, uint channel,
275 uint target, uint lun);
a6a8d9f8 276extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
1da177e4 277extern void scsi_remove_device(struct scsi_device *);
a6a8d9f8 278extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
1da177e4
LT
279
280extern int scsi_device_get(struct scsi_device *);
281extern void scsi_device_put(struct scsi_device *);
282extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
283 uint, uint, uint);
284extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
285 uint, uint, uint);
286extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
287 uint);
288extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
289 uint);
290extern void starget_for_each_device(struct scsi_target *, void *,
291 void (*fn)(struct scsi_device *, void *));
522939d4
MR
292extern void __starget_for_each_device(struct scsi_target *, void *,
293 void (*fn)(struct scsi_device *,
294 void *));
1da177e4
LT
295
296/* only exposed to implement shost_for_each_device */
297extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
298 struct scsi_device *);
299
300/**
3e082a91
MW
301 * shost_for_each_device - iterate over all devices of a host
302 * @sdev: the &struct scsi_device to use as a cursor
303 * @shost: the &struct scsi_host to iterate over
1da177e4 304 *
3e082a91
MW
305 * Iterator that returns each device attached to @shost. This loop
306 * takes a reference on each device and releases it at the end. If
307 * you break out of the loop, you must call scsi_device_put(sdev).
1da177e4
LT
308 */
309#define shost_for_each_device(sdev, shost) \
310 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
311 (sdev); \
312 (sdev) = __scsi_iterate_devices((shost), (sdev)))
313
314/**
3e082a91
MW
315 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
316 * @sdev: the &struct scsi_device to use as a cursor
317 * @shost: the &struct scsi_host to iterate over
1da177e4 318 *
3e082a91
MW
319 * Iterator that returns each device attached to @shost. It does _not_
320 * take a reference on the scsi_device, so the whole loop must be
321 * protected by shost->host_lock.
1da177e4 322 *
3e082a91
MW
323 * Note: The only reason to use this is because you need to access the
324 * device list in interrupt context. Otherwise you really want to use
325 * shost_for_each_device instead.
1da177e4
LT
326 */
327#define __shost_for_each_device(sdev, shost) \
328 list_for_each_entry((sdev), &((shost)->__devices), siblings)
329
330extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
331extern int scsi_track_queue_full(struct scsi_device *, int);
332
333extern int scsi_set_medium_removal(struct scsi_device *, char);
334
335extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
336 unsigned char *buffer, int len, int timeout,
1cf72699 337 int retries, struct scsi_mode_data *data,
ea73a9f2 338 struct scsi_sense_hdr *);
5baba830
JB
339extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
340 int modepage, unsigned char *buffer, int len,
341 int timeout, int retries,
342 struct scsi_mode_data *data,
343 struct scsi_sense_hdr *);
1da177e4 344extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
001aac25 345 int retries, struct scsi_sense_hdr *sshdr);
881a256d 346extern unsigned char *scsi_get_vpd_page(struct scsi_device *, u8 page);
1da177e4
LT
347extern int scsi_device_set_state(struct scsi_device *sdev,
348 enum scsi_device_state state);
a341cd0f
JG
349extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
350 gfp_t gfpflags);
351extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
352extern void sdev_evt_send_simple(struct scsi_device *sdev,
353 enum scsi_device_event evt_type, gfp_t gfpflags);
1da177e4
LT
354extern int scsi_device_quiesce(struct scsi_device *sdev);
355extern void scsi_device_resume(struct scsi_device *sdev);
356extern void scsi_target_quiesce(struct scsi_target *);
357extern void scsi_target_resume(struct scsi_target *);
358extern void scsi_scan_target(struct device *parent, unsigned int channel,
359 unsigned int id, unsigned int lun, int rescan);
360extern void scsi_target_reap(struct scsi_target *);
361extern void scsi_target_block(struct device *);
362extern void scsi_target_unblock(struct device *);
363extern void scsi_remove_target(struct device *);
2f4701d8 364extern void int_to_scsilun(unsigned int, struct scsi_lun *);
462b7859 365extern int scsilun_to_int(struct scsi_lun *);
1da177e4
LT
366extern const char *scsi_device_state_name(enum scsi_device_state);
367extern int scsi_is_sdev_device(const struct device *);
368extern int scsi_is_target_device(const struct device *);
33aa687d
JB
369extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
370 int data_direction, void *buffer, unsigned bufflen,
371 unsigned char *sense, int timeout, int retries,
f4f4e47e 372 int flag, int *resid);
ea73a9f2
JB
373extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
374 int data_direction, void *buffer, unsigned bufflen,
f4f4e47e
FT
375 struct scsi_sense_hdr *, int timeout, int retries,
376 int *resid);
33aa687d 377
cb5d9e09 378static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
e28482c5 379{
cb5d9e09 380 return device_reprobe(&sdev->sdev_gendev);
e28482c5
JB
381}
382
01d7b3b8
JG
383static inline unsigned int sdev_channel(struct scsi_device *sdev)
384{
385 return sdev->channel;
386}
387
388static inline unsigned int sdev_id(struct scsi_device *sdev)
389{
390 return sdev->id;
391}
392
393#define scmd_id(scmd) sdev_id((scmd)->device)
394#define scmd_channel(scmd) sdev_channel((scmd)->device)
395
0f1d87a2
JB
396/*
397 * checks for positions of the SCSI state machine
398 */
1da177e4
LT
399static inline int scsi_device_online(struct scsi_device *sdev)
400{
0762a482
HR
401 return (sdev->sdev_state != SDEV_OFFLINE &&
402 sdev->sdev_state != SDEV_DEL);
1da177e4 403}
0f1d87a2
JB
404static inline int scsi_device_blocked(struct scsi_device *sdev)
405{
6f4267e3
JB
406 return sdev->sdev_state == SDEV_BLOCK ||
407 sdev->sdev_state == SDEV_CREATED_BLOCK;
0f1d87a2
JB
408}
409static inline int scsi_device_created(struct scsi_device *sdev)
410{
6f4267e3
JB
411 return sdev->sdev_state == SDEV_CREATED ||
412 sdev->sdev_state == SDEV_CREATED_BLOCK;
0f1d87a2 413}
1da177e4
LT
414
415/* accessor functions for the SCSI parameters */
416static inline int scsi_device_sync(struct scsi_device *sdev)
417{
418 return sdev->sdtr;
419}
420static inline int scsi_device_wide(struct scsi_device *sdev)
421{
422 return sdev->wdtr;
423}
424static inline int scsi_device_dt(struct scsi_device *sdev)
425{
426 return sdev->ppr;
427}
428static inline int scsi_device_dt_only(struct scsi_device *sdev)
429{
430 if (sdev->inquiry_len < 57)
431 return 0;
432 return (sdev->inquiry[56] & 0x0c) == 0x04;
433}
434static inline int scsi_device_ius(struct scsi_device *sdev)
435{
436 if (sdev->inquiry_len < 57)
437 return 0;
438 return sdev->inquiry[56] & 0x01;
439}
440static inline int scsi_device_qas(struct scsi_device *sdev)
441{
442 if (sdev->inquiry_len < 57)
443 return 0;
444 return sdev->inquiry[56] & 0x02;
445}
b30c2fc1
JB
446static inline int scsi_device_enclosure(struct scsi_device *sdev)
447{
448 return sdev->inquiry[6] & (1<<6);
449}
d7b8bcb0 450
7027ad72
MP
451static inline int scsi_device_protection(struct scsi_device *sdev)
452{
d211f052 453 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
7027ad72
MP
454}
455
d7b8bcb0
MT
456#define MODULE_ALIAS_SCSI_DEVICE(type) \
457 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
458#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
459
1da177e4 460#endif /* _SCSI_SCSI_DEVICE_H */