Merge tag 'device-for-3.4' of git://git.kernel.org/pub/scm/linux/kernel/git/paulg...
[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/list.h>
5 #include <linux/spinlock.h>
6 #include <linux/workqueue.h>
7 #include <linux/blkdev.h>
8 #include <scsi/scsi.h>
9 #include <linux/atomic.h>
10
11 struct device;
12 struct request_queue;
13 struct scsi_cmnd;
14 struct scsi_lun;
15 struct scsi_sense_hdr;
16
17 struct 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
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  */
31 enum 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 */
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 */
50 };
51
52 enum 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
59 struct 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
68 struct 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
76         /* this is now protected by the request_queue->queue_lock */
77         unsigned int device_busy;       /* commands actually active on
78                                          * low-level. protected by queue_lock. */
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 max_queue_depth; /* max queue depth */
85         unsigned short last_queue_full_depth; /* These two are used by */
86         unsigned short last_queue_full_count; /* scsi_track_queue_full() */
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 */
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 */
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 */
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 */
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 */
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 skip_vpd_pages:1;      /* do not read VPD pages */
140         unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
141         unsigned no_start_on_add:1;     /* do not issue start on add */
142         unsigned allow_restart:1; /* issue START_UNIT in error handler */
143         unsigned manage_start_stop:1;   /* Let HLD (sd) manage start/stop */
144         unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
145         unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
146         unsigned select_no_atn:1;
147         unsigned fix_capacity:1;        /* READ_CAPACITY is too high by 1 */
148         unsigned guess_capacity:1;      /* READ_CAPACITY might be too high by 1 */
149         unsigned retry_hwerror:1;       /* Retry HARDWARE_ERROR */
150         unsigned last_sector_bug:1;     /* do not use multisector accesses on
151                                            SD_LAST_BUGGY_SECTORS */
152         unsigned no_read_disc_info:1;   /* Avoid READ_DISC_INFO cmds */
153         unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
154         unsigned is_visible:1;  /* is the device visible in sysfs */
155
156         DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
157         struct list_head event_list;    /* asserted events */
158         struct work_struct event_work;
159
160         unsigned int device_blocked;    /* Device returned QUEUE_FULL. */
161
162         unsigned int max_device_blocked; /* what device_blocked counts down from  */
163 #define SCSI_DEFAULT_DEVICE_BLOCKED     3
164
165         atomic_t iorequest_cnt;
166         atomic_t iodone_cnt;
167         atomic_t ioerr_cnt;
168
169         struct device           sdev_gendev,
170                                 sdev_dev;
171
172         struct execute_work     ew; /* used to get process context on put */
173         struct work_struct      requeue_work;
174
175         struct scsi_dh_data     *scsi_dh_data;
176         enum scsi_device_state sdev_state;
177         unsigned long           sdev_data[0];
178 } __attribute__((aligned(sizeof(unsigned long))));
179
180 struct scsi_dh_devlist {
181         char *vendor;
182         char *model;
183 };
184
185 typedef void (*activate_complete)(void *, int);
186 struct scsi_device_handler {
187         /* Used by the infrastructure */
188         struct list_head list; /* list of scsi_device_handlers */
189
190         /* Filled by the hardware handler */
191         struct module *module;
192         const char *name;
193         const struct scsi_dh_devlist *devlist;
194         int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
195         int (*attach)(struct scsi_device *);
196         void (*detach)(struct scsi_device *);
197         int (*activate)(struct scsi_device *, activate_complete, void *);
198         int (*prep_fn)(struct scsi_device *, struct request *);
199         int (*set_params)(struct scsi_device *, const char *);
200         bool (*match)(struct scsi_device *);
201 };
202
203 struct scsi_dh_data {
204         struct scsi_device_handler *scsi_dh;
205         struct scsi_device *sdev;
206         struct kref kref;
207         char buf[0];
208 };
209
210 #define to_scsi_device(d)       \
211         container_of(d, struct scsi_device, sdev_gendev)
212 #define class_to_sdev(d)        \
213         container_of(d, struct scsi_device, sdev_dev)
214 #define transport_class_to_sdev(class_dev) \
215         to_scsi_device(class_dev->parent)
216
217 #define sdev_printk(prefix, sdev, fmt, a...)    \
218         dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
219
220 #define scmd_printk(prefix, scmd, fmt, a...)                            \
221         (scmd)->request->rq_disk ?                                      \
222         sdev_printk(prefix, (scmd)->device, "[%s] " fmt,                \
223                     (scmd)->request->rq_disk->disk_name, ##a) :         \
224         sdev_printk(prefix, (scmd)->device, fmt, ##a)
225
226 enum scsi_target_state {
227         STARGET_CREATED = 1,
228         STARGET_RUNNING,
229         STARGET_DEL,
230 };
231
232 /*
233  * scsi_target: representation of a scsi target, for now, this is only
234  * used for single_lun devices. If no one has active IO to the target,
235  * starget_sdev_user is NULL, else it points to the active sdev.
236  */
237 struct scsi_target {
238         struct scsi_device      *starget_sdev_user;
239         struct list_head        siblings;
240         struct list_head        devices;
241         struct device           dev;
242         unsigned int            reap_ref; /* protected by the host lock */
243         unsigned int            channel;
244         unsigned int            id; /* target id ... replace
245                                      * scsi_device.id eventually */
246         unsigned int            create:1; /* signal that it needs to be added */
247         unsigned int            single_lun:1;   /* Indicates we should only
248                                                  * allow I/O to one of the luns
249                                                  * for the device at a time. */
250         unsigned int            pdt_1f_for_no_lun:1;    /* PDT = 0x1f
251                                                  * means no lun present. */
252         unsigned int            no_report_luns:1;       /* Don't use
253                                                  * REPORT LUNS for scanning. */
254         /* commands actually active on LLD. protected by host lock. */
255         unsigned int            target_busy;
256         /*
257          * LLDs should set this in the slave_alloc host template callout.
258          * If set to zero then there is not limit.
259          */
260         unsigned int            can_queue;
261         unsigned int            target_blocked;
262         unsigned int            max_target_blocked;
263 #define SCSI_DEFAULT_TARGET_BLOCKED     3
264
265         char                    scsi_level;
266         struct execute_work     ew;
267         enum scsi_target_state  state;
268         void                    *hostdata; /* available to low-level driver */
269         unsigned long           starget_data[0]; /* for the transport */
270         /* starget_data must be the last element!!!! */
271 } __attribute__((aligned(sizeof(unsigned long))));
272
273 #define to_scsi_target(d)       container_of(d, struct scsi_target, dev)
274 static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
275 {
276         return to_scsi_target(sdev->sdev_gendev.parent);
277 }
278 #define transport_class_to_starget(class_dev) \
279         to_scsi_target(class_dev->parent)
280
281 #define starget_printk(prefix, starget, fmt, a...)      \
282         dev_printk(prefix, &(starget)->dev, fmt, ##a)
283
284 extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
285                 uint, uint, uint, void *hostdata);
286 extern int scsi_add_device(struct Scsi_Host *host, uint channel,
287                            uint target, uint lun);
288 extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
289 extern void scsi_remove_device(struct scsi_device *);
290 extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
291
292 extern int scsi_device_get(struct scsi_device *);
293 extern void scsi_device_put(struct scsi_device *);
294 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
295                                               uint, uint, uint);
296 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
297                                                 uint, uint, uint);
298 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
299                                                         uint);
300 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
301                                                           uint);
302 extern void starget_for_each_device(struct scsi_target *, void *,
303                      void (*fn)(struct scsi_device *, void *));
304 extern void __starget_for_each_device(struct scsi_target *, void *,
305                                       void (*fn)(struct scsi_device *,
306                                                  void *));
307
308 /* only exposed to implement shost_for_each_device */
309 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
310                                                   struct scsi_device *);
311
312 /**
313  * shost_for_each_device - iterate over all devices of a host
314  * @sdev: the &struct scsi_device to use as a cursor
315  * @shost: the &struct scsi_host to iterate over
316  *
317  * Iterator that returns each device attached to @shost.  This loop
318  * takes a reference on each device and releases it at the end.  If
319  * you break out of the loop, you must call scsi_device_put(sdev).
320  */
321 #define shost_for_each_device(sdev, shost) \
322         for ((sdev) = __scsi_iterate_devices((shost), NULL); \
323              (sdev); \
324              (sdev) = __scsi_iterate_devices((shost), (sdev)))
325
326 /**
327  * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
328  * @sdev: the &struct scsi_device to use as a cursor
329  * @shost: the &struct scsi_host to iterate over
330  *
331  * Iterator that returns each device attached to @shost.  It does _not_
332  * take a reference on the scsi_device, so the whole loop must be
333  * protected by shost->host_lock.
334  *
335  * Note: The only reason to use this is because you need to access the
336  * device list in interrupt context.  Otherwise you really want to use
337  * shost_for_each_device instead.
338  */
339 #define __shost_for_each_device(sdev, shost) \
340         list_for_each_entry((sdev), &((shost)->__devices), siblings)
341
342 extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
343 extern int scsi_track_queue_full(struct scsi_device *, int);
344
345 extern int scsi_set_medium_removal(struct scsi_device *, char);
346
347 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
348                            unsigned char *buffer, int len, int timeout,
349                            int retries, struct scsi_mode_data *data,
350                            struct scsi_sense_hdr *);
351 extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
352                             int modepage, unsigned char *buffer, int len,
353                             int timeout, int retries,
354                             struct scsi_mode_data *data,
355                             struct scsi_sense_hdr *);
356 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
357                                 int retries, struct scsi_sense_hdr *sshdr);
358 extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
359                              int buf_len);
360 extern int scsi_device_set_state(struct scsi_device *sdev,
361                                  enum scsi_device_state state);
362 extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
363                                           gfp_t gfpflags);
364 extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
365 extern void sdev_evt_send_simple(struct scsi_device *sdev,
366                           enum scsi_device_event evt_type, gfp_t gfpflags);
367 extern int scsi_device_quiesce(struct scsi_device *sdev);
368 extern void scsi_device_resume(struct scsi_device *sdev);
369 extern void scsi_target_quiesce(struct scsi_target *);
370 extern void scsi_target_resume(struct scsi_target *);
371 extern void scsi_scan_target(struct device *parent, unsigned int channel,
372                              unsigned int id, unsigned int lun, int rescan);
373 extern void scsi_target_reap(struct scsi_target *);
374 extern void scsi_target_block(struct device *);
375 extern void scsi_target_unblock(struct device *);
376 extern void scsi_remove_target(struct device *);
377 extern void int_to_scsilun(unsigned int, struct scsi_lun *);
378 extern int scsilun_to_int(struct scsi_lun *);
379 extern const char *scsi_device_state_name(enum scsi_device_state);
380 extern int scsi_is_sdev_device(const struct device *);
381 extern int scsi_is_target_device(const struct device *);
382 extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
383                         int data_direction, void *buffer, unsigned bufflen,
384                         unsigned char *sense, int timeout, int retries,
385                         int flag, int *resid);
386 extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
387                             int data_direction, void *buffer, unsigned bufflen,
388                             struct scsi_sense_hdr *, int timeout, int retries,
389                             int *resid);
390
391 #ifdef CONFIG_PM_RUNTIME
392 extern int scsi_autopm_get_device(struct scsi_device *);
393 extern void scsi_autopm_put_device(struct scsi_device *);
394 #else
395 static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
396 static inline void scsi_autopm_put_device(struct scsi_device *d) {}
397 #endif /* CONFIG_PM_RUNTIME */
398
399 static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
400 {
401         return device_reprobe(&sdev->sdev_gendev);
402 }
403
404 static inline unsigned int sdev_channel(struct scsi_device *sdev)
405 {
406         return sdev->channel;
407 }
408
409 static inline unsigned int sdev_id(struct scsi_device *sdev)
410 {
411         return sdev->id;
412 }
413
414 #define scmd_id(scmd) sdev_id((scmd)->device)
415 #define scmd_channel(scmd) sdev_channel((scmd)->device)
416
417 /*
418  * checks for positions of the SCSI state machine
419  */
420 static inline int scsi_device_online(struct scsi_device *sdev)
421 {
422         return (sdev->sdev_state != SDEV_OFFLINE &&
423                 sdev->sdev_state != SDEV_DEL);
424 }
425 static inline int scsi_device_blocked(struct scsi_device *sdev)
426 {
427         return sdev->sdev_state == SDEV_BLOCK ||
428                 sdev->sdev_state == SDEV_CREATED_BLOCK;
429 }
430 static inline int scsi_device_created(struct scsi_device *sdev)
431 {
432         return sdev->sdev_state == SDEV_CREATED ||
433                 sdev->sdev_state == SDEV_CREATED_BLOCK;
434 }
435
436 /* accessor functions for the SCSI parameters */
437 static inline int scsi_device_sync(struct scsi_device *sdev)
438 {
439         return sdev->sdtr;
440 }
441 static inline int scsi_device_wide(struct scsi_device *sdev)
442 {
443         return sdev->wdtr;
444 }
445 static inline int scsi_device_dt(struct scsi_device *sdev)
446 {
447         return sdev->ppr;
448 }
449 static inline int scsi_device_dt_only(struct scsi_device *sdev)
450 {
451         if (sdev->inquiry_len < 57)
452                 return 0;
453         return (sdev->inquiry[56] & 0x0c) == 0x04;
454 }
455 static inline int scsi_device_ius(struct scsi_device *sdev)
456 {
457         if (sdev->inquiry_len < 57)
458                 return 0;
459         return sdev->inquiry[56] & 0x01;
460 }
461 static inline int scsi_device_qas(struct scsi_device *sdev)
462 {
463         if (sdev->inquiry_len < 57)
464                 return 0;
465         return sdev->inquiry[56] & 0x02;
466 }
467 static inline int scsi_device_enclosure(struct scsi_device *sdev)
468 {
469         return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
470 }
471
472 static inline int scsi_device_protection(struct scsi_device *sdev)
473 {
474         return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
475 }
476
477 static inline int scsi_device_tpgs(struct scsi_device *sdev)
478 {
479         return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
480 }
481
482 #define MODULE_ALIAS_SCSI_DEVICE(type) \
483         MODULE_ALIAS("scsi:t-" __stringify(type) "*")
484 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
485
486 #endif /* _SCSI_SCSI_DEVICE_H */