[SCSI] scsi_dh: add infrastructure for SCSI Device Handlers
[linux-2.6.git] / include / scsi / scsi_device.h
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>
7 #include <linux/workqueue.h>
8 #include <linux/blkdev.h>
9 #include <asm/atomic.h>
10
11 struct request_queue;
12 struct scsi_cmnd;
13 struct scsi_lun;
14 struct scsi_sense_hdr;
15
16 struct 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
25 /*
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  */
30 enum 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
49 enum 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
56 struct 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
65 struct 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
73         /* this is now protected by the request_queue->queue_lock */
74         unsigned int device_busy;       /* commands actually active on
75                                          * low-level. protected by queue_lock. */
76         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 */
94         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 */
99         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 */
102         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 */
125         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 */
136         unsigned manage_start_stop:1;   /* Let HLD (sd) manage start/stop */
137         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 */
140         unsigned guess_capacity:1;      /* READ_CAPACITY might be too high by 1 */
141         unsigned retry_hwerror:1;       /* Retry HARDWARE_ERROR */
142         unsigned last_sector_bug:1;     /* Always read last sector in a 1 sector read */
143
144         DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
145         struct list_head event_list;    /* asserted events */
146         struct work_struct event_work;
147
148         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
159         struct device           sdev_gendev,
160                                 sdev_dev;
161
162         struct execute_work     ew; /* used to get process context on put */
163
164         struct scsi_dh_data     *scsi_dh_data;
165         enum scsi_device_state sdev_state;
166         unsigned long           sdev_data[0];
167 } __attribute__((aligned(sizeof(unsigned long))));
168
169 struct scsi_device_handler {
170         /* Used by the infrastructure */
171         struct list_head list; /* list of scsi_device_handlers */
172         struct notifier_block nb;
173
174         /* Filled by the hardware handler */
175         struct module *module;
176         const char *name;
177         int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
178         int (*activate)(struct scsi_device *);
179         int (*prep_fn)(struct scsi_device *, struct request *);
180 };
181
182 struct scsi_dh_data {
183         struct scsi_device_handler *scsi_dh;
184         char buf[0];
185 };
186
187 #define to_scsi_device(d)       \
188         container_of(d, struct scsi_device, sdev_gendev)
189 #define class_to_sdev(d)        \
190         container_of(d, struct scsi_device, sdev_dev)
191 #define transport_class_to_sdev(class_dev) \
192         to_scsi_device(class_dev->parent)
193
194 #define sdev_printk(prefix, sdev, fmt, a...)    \
195         dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
196
197 #define scmd_printk(prefix, scmd, fmt, a...)                            \
198         (scmd)->request->rq_disk ?                                      \
199         sdev_printk(prefix, (scmd)->device, "[%s] " fmt,                \
200                     (scmd)->request->rq_disk->disk_name, ##a) :         \
201         sdev_printk(prefix, (scmd)->device, fmt, ##a)
202
203 enum scsi_target_state {
204         STARGET_CREATED = 1,
205         STARGET_RUNNING,
206         STARGET_DEL,
207 };
208
209 /*
210  * scsi_target: representation of a scsi target, for now, this is only
211  * used for single_lun devices. If no one has active IO to the target,
212  * starget_sdev_user is NULL, else it points to the active sdev.
213  */
214 struct scsi_target {
215         struct scsi_device      *starget_sdev_user;
216         struct list_head        siblings;
217         struct list_head        devices;
218         struct device           dev;
219         unsigned int            reap_ref; /* protected by the host lock */
220         unsigned int            channel;
221         unsigned int            id; /* target id ... replace
222                                      * scsi_device.id eventually */
223         unsigned int            create:1; /* signal that it needs to be added */
224         unsigned int            single_lun:1;   /* Indicates we should only
225                                                  * allow I/O to one of the luns
226                                                  * for the device at a time. */
227         unsigned int            pdt_1f_for_no_lun;      /* PDT = 0x1f */
228                                                 /* means no lun present */
229
230         char                    scsi_level;
231         struct execute_work     ew;
232         enum scsi_target_state  state;
233         void                    *hostdata; /* available to low-level driver */
234         unsigned long           starget_data[0]; /* for the transport */
235         /* starget_data must be the last element!!!! */
236 } __attribute__((aligned(sizeof(unsigned long))));
237
238 #define to_scsi_target(d)       container_of(d, struct scsi_target, dev)
239 static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
240 {
241         return to_scsi_target(sdev->sdev_gendev.parent);
242 }
243 #define transport_class_to_starget(class_dev) \
244         to_scsi_target(class_dev->parent)
245
246 #define starget_printk(prefix, starget, fmt, a...)      \
247         dev_printk(prefix, &(starget)->dev, fmt, ##a)
248
249 extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
250                 uint, uint, uint, void *hostdata);
251 extern int scsi_add_device(struct Scsi_Host *host, uint channel,
252                            uint target, uint lun);
253 extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
254 extern void scsi_remove_device(struct scsi_device *);
255 extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
256
257 extern int scsi_device_get(struct scsi_device *);
258 extern void scsi_device_put(struct scsi_device *);
259 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
260                                               uint, uint, uint);
261 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
262                                                 uint, uint, uint);
263 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
264                                                         uint);
265 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
266                                                           uint);
267 extern void starget_for_each_device(struct scsi_target *, void *,
268                      void (*fn)(struct scsi_device *, void *));
269 extern void __starget_for_each_device(struct scsi_target *, void *,
270                                       void (*fn)(struct scsi_device *,
271                                                  void *));
272
273 /* only exposed to implement shost_for_each_device */
274 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
275                                                   struct scsi_device *);
276
277 /**
278  * shost_for_each_device - iterate over all devices of a host
279  * @sdev: the &struct scsi_device to use as a cursor
280  * @shost: the &struct scsi_host to iterate over
281  *
282  * Iterator that returns each device attached to @shost.  This loop
283  * takes a reference on each device and releases it at the end.  If
284  * you break out of the loop, you must call scsi_device_put(sdev).
285  */
286 #define shost_for_each_device(sdev, shost) \
287         for ((sdev) = __scsi_iterate_devices((shost), NULL); \
288              (sdev); \
289              (sdev) = __scsi_iterate_devices((shost), (sdev)))
290
291 /**
292  * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
293  * @sdev: the &struct scsi_device to use as a cursor
294  * @shost: the &struct scsi_host to iterate over
295  *
296  * Iterator that returns each device attached to @shost.  It does _not_
297  * take a reference on the scsi_device, so the whole loop must be
298  * protected by shost->host_lock.
299  *
300  * Note: The only reason to use this is because you need to access the
301  * device list in interrupt context.  Otherwise you really want to use
302  * shost_for_each_device instead.
303  */
304 #define __shost_for_each_device(sdev, shost) \
305         list_for_each_entry((sdev), &((shost)->__devices), siblings)
306
307 extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
308 extern int scsi_track_queue_full(struct scsi_device *, int);
309
310 extern int scsi_set_medium_removal(struct scsi_device *, char);
311
312 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
313                            unsigned char *buffer, int len, int timeout,
314                            int retries, struct scsi_mode_data *data,
315                            struct scsi_sense_hdr *);
316 extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
317                             int modepage, unsigned char *buffer, int len,
318                             int timeout, int retries,
319                             struct scsi_mode_data *data,
320                             struct scsi_sense_hdr *);
321 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
322                                 int retries, struct scsi_sense_hdr *sshdr);
323 extern int scsi_device_set_state(struct scsi_device *sdev,
324                                  enum scsi_device_state state);
325 extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
326                                           gfp_t gfpflags);
327 extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
328 extern void sdev_evt_send_simple(struct scsi_device *sdev,
329                           enum scsi_device_event evt_type, gfp_t gfpflags);
330 extern int scsi_device_quiesce(struct scsi_device *sdev);
331 extern void scsi_device_resume(struct scsi_device *sdev);
332 extern void scsi_target_quiesce(struct scsi_target *);
333 extern void scsi_target_resume(struct scsi_target *);
334 extern void scsi_scan_target(struct device *parent, unsigned int channel,
335                              unsigned int id, unsigned int lun, int rescan);
336 extern void scsi_target_reap(struct scsi_target *);
337 extern void scsi_target_block(struct device *);
338 extern void scsi_target_unblock(struct device *);
339 extern void scsi_remove_target(struct device *);
340 extern void int_to_scsilun(unsigned int, struct scsi_lun *);
341 extern int scsilun_to_int(struct scsi_lun *);
342 extern const char *scsi_device_state_name(enum scsi_device_state);
343 extern int scsi_is_sdev_device(const struct device *);
344 extern int scsi_is_target_device(const struct device *);
345 extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
346                         int data_direction, void *buffer, unsigned bufflen,
347                         unsigned char *sense, int timeout, int retries,
348                         int flag);
349 extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
350                             int data_direction, void *buffer, unsigned bufflen,
351                             struct scsi_sense_hdr *, int timeout, int retries);
352 extern int scsi_execute_async(struct scsi_device *sdev,
353                               const unsigned char *cmd, int cmd_len, int data_direction,
354                               void *buffer, unsigned bufflen, int use_sg,
355                               int timeout, int retries, void *privdata,
356                               void (*done)(void *, char *, int, int),
357                               gfp_t gfp);
358
359 static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
360 {
361         return device_reprobe(&sdev->sdev_gendev);
362 }
363
364 static inline unsigned int sdev_channel(struct scsi_device *sdev)
365 {
366         return sdev->channel;
367 }
368
369 static inline unsigned int sdev_id(struct scsi_device *sdev)
370 {
371         return sdev->id;
372 }
373
374 #define scmd_id(scmd) sdev_id((scmd)->device)
375 #define scmd_channel(scmd) sdev_channel((scmd)->device)
376
377 static inline int scsi_device_online(struct scsi_device *sdev)
378 {
379         return sdev->sdev_state != SDEV_OFFLINE;
380 }
381
382 /* accessor functions for the SCSI parameters */
383 static inline int scsi_device_sync(struct scsi_device *sdev)
384 {
385         return sdev->sdtr;
386 }
387 static inline int scsi_device_wide(struct scsi_device *sdev)
388 {
389         return sdev->wdtr;
390 }
391 static inline int scsi_device_dt(struct scsi_device *sdev)
392 {
393         return sdev->ppr;
394 }
395 static inline int scsi_device_dt_only(struct scsi_device *sdev)
396 {
397         if (sdev->inquiry_len < 57)
398                 return 0;
399         return (sdev->inquiry[56] & 0x0c) == 0x04;
400 }
401 static inline int scsi_device_ius(struct scsi_device *sdev)
402 {
403         if (sdev->inquiry_len < 57)
404                 return 0;
405         return sdev->inquiry[56] & 0x01;
406 }
407 static inline int scsi_device_qas(struct scsi_device *sdev)
408 {
409         if (sdev->inquiry_len < 57)
410                 return 0;
411         return sdev->inquiry[56] & 0x02;
412 }
413 static inline int scsi_device_enclosure(struct scsi_device *sdev)
414 {
415         return sdev->inquiry[6] & (1<<6);
416 }
417
418 #define MODULE_ALIAS_SCSI_DEVICE(type) \
419         MODULE_ALIAS("scsi:t-" __stringify(type) "*")
420 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
421
422 #endif /* _SCSI_SCSI_DEVICE_H */