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