5ad08b70763c622a838805f8635c6f1980daff2b
[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 <asm/atomic.h>
8
9 struct request_queue;
10 struct scsi_cmnd;
11 struct scsi_lun;
12
13 struct scsi_mode_data {
14         __u32   length;
15         __u16   block_descriptor_length;
16         __u8    medium_type;
17         __u8    device_specific;
18         __u8    header_length;
19         __u8    longlba:1;
20 };
21
22 /*
23  * sdev state: If you alter this, you also need to alter scsi_sysfs.c
24  * (for the ascii descriptions) and the state model enforcer:
25  * scsi_lib:scsi_device_set_state().
26  */
27 enum scsi_device_state {
28         SDEV_CREATED = 1,       /* device created but not added to sysfs
29                                  * Only internal commands allowed (for inq) */
30         SDEV_RUNNING,           /* device properly configured
31                                  * All commands allowed */
32         SDEV_CANCEL,            /* beginning to delete device
33                                  * Only error handler commands allowed */
34         SDEV_DEL,               /* device deleted 
35                                  * no commands allowed */
36         SDEV_QUIESCE,           /* Device quiescent.  No block commands
37                                  * will be accepted, only specials (which
38                                  * originate in the mid-layer) */
39         SDEV_OFFLINE,           /* Device offlined (by error handling or
40                                  * user request */
41         SDEV_BLOCK,             /* Device blocked by scsi lld.  No scsi 
42                                  * commands from user or midlayer should be issued
43                                  * to the scsi lld. */
44 };
45
46 struct scsi_device {
47         struct Scsi_Host *host;
48         struct request_queue *request_queue;
49
50         /* the next two are protected by the host->host_lock */
51         struct list_head    siblings;   /* list of all devices on this host */
52         struct list_head    same_target_siblings; /* just the devices sharing same target id */
53
54         /* this is now protected by the request_queue->queue_lock */
55         unsigned int device_busy;       /* commands actually active on
56                                          * low-level. protected by queue_lock. */
57         spinlock_t list_lock;
58         struct list_head cmd_list;      /* queue of in use SCSI Command structures */
59         struct list_head starved_entry;
60         struct scsi_cmnd *current_cmnd; /* currently active command */
61         unsigned short queue_depth;     /* How deep of a queue we want */
62         unsigned short last_queue_full_depth; /* These two are used by */
63         unsigned short last_queue_full_count; /* scsi_track_queue_full() */
64         unsigned long last_queue_full_time;/* don't let QUEUE_FULLs on the same
65                                            jiffie count on our counter, they
66                                            could all be from the same event. */
67
68         unsigned int id, lun, channel;
69
70         unsigned int manufacturer;      /* Manufacturer of device, for using 
71                                          * vendor-specific cmd's */
72         unsigned sector_size;   /* size in bytes */
73
74         void *hostdata;         /* available to low-level driver */
75         char devfs_name[256];   /* devfs junk */
76         char type;
77         char scsi_level;
78         char inq_periph_qual;   /* PQ from INQUIRY data */      
79         unsigned char inquiry_len;      /* valid bytes in 'inquiry' */
80         unsigned char * inquiry;        /* INQUIRY response data */
81         char * vendor;          /* [back_compat] point into 'inquiry' ... */
82         char * model;           /* ... after scan; point to static string */
83         char * rev;             /* ... "nullnullnullnull" before scan */
84         unsigned char current_tag;      /* current tag */
85         struct scsi_target      *sdev_target;   /* used only for single_lun */
86
87         unsigned int    sdev_bflags; /* black/white flags as also found in
88                                  * scsi_devinfo.[hc]. For now used only to
89                                  * pass settings from slave_alloc to scsi
90                                  * core. */
91         unsigned writeable:1;
92         unsigned removable:1;
93         unsigned changed:1;     /* Data invalid due to media change */
94         unsigned busy:1;        /* Used to prevent races */
95         unsigned lockable:1;    /* Able to prevent media removal */
96         unsigned locked:1;      /* Media removal disabled */
97         unsigned borken:1;      /* Tell the Seagate driver to be 
98                                  * painfully slow on this device */
99         unsigned disconnect:1;  /* can disconnect */
100         unsigned soft_reset:1;  /* Uses soft reset option */
101         unsigned sdtr:1;        /* Device supports SDTR messages */
102         unsigned wdtr:1;        /* Device supports WDTR messages */
103         unsigned ppr:1;         /* Device supports PPR messages */
104         unsigned tagged_supported:1;    /* Supports SCSI-II tagged queuing */
105         unsigned simple_tags:1; /* simple queue tag messages are enabled */
106         unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
107         unsigned single_lun:1;  /* Indicates we should only allow I/O to
108                                  * one of the luns for the device at a 
109                                  * time. */
110         unsigned was_reset:1;   /* There was a bus reset on the bus for 
111                                  * this device */
112         unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
113                                      * because we did a bus reset. */
114         unsigned use_10_for_rw:1; /* first try 10-byte read / write */
115         unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
116         unsigned skip_ms_page_8:1;      /* do not use MODE SENSE page 0x08 */
117         unsigned skip_ms_page_3f:1;     /* do not use MODE SENSE page 0x3f */
118         unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
119         unsigned no_start_on_add:1;     /* do not issue start on add */
120         unsigned allow_restart:1; /* issue START_UNIT in error handler */
121         unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
122         unsigned select_no_atn:1;
123         unsigned fix_capacity:1;        /* READ_CAPACITY is too high by 1 */
124         unsigned retry_hwerror:1;       /* Retry HARDWARE_ERROR */
125
126         unsigned int device_blocked;    /* Device returned QUEUE_FULL. */
127
128         unsigned int max_device_blocked; /* what device_blocked counts down from  */
129 #define SCSI_DEFAULT_DEVICE_BLOCKED     3
130
131         atomic_t iorequest_cnt;
132         atomic_t iodone_cnt;
133         atomic_t ioerr_cnt;
134
135         int timeout;
136
137         struct device           sdev_gendev;
138         struct class_device     sdev_classdev;
139
140         enum scsi_device_state sdev_state;
141         unsigned long           sdev_data[0];
142 } __attribute__((aligned(sizeof(unsigned long))));
143 #define to_scsi_device(d)       \
144         container_of(d, struct scsi_device, sdev_gendev)
145 #define class_to_sdev(d)        \
146         container_of(d, struct scsi_device, sdev_classdev)
147 #define transport_class_to_sdev(class_dev) \
148         to_scsi_device(class_dev->dev)
149
150 /*
151  * scsi_target: representation of a scsi target, for now, this is only
152  * used for single_lun devices. If no one has active IO to the target,
153  * starget_sdev_user is NULL, else it points to the active sdev.
154  */
155 struct scsi_target {
156         struct scsi_device      *starget_sdev_user;
157         struct list_head        siblings;
158         struct list_head        devices;
159         struct device           dev;
160         unsigned int            reap_ref; /* protected by the host lock */
161         unsigned int            channel;
162         unsigned int            id; /* target id ... replace
163                                      * scsi_device.id eventually */
164         unsigned long           create:1; /* signal that it needs to be added */
165         void                    *hostdata; /* available to low-level driver */
166         unsigned long           starget_data[0]; /* for the transport */
167         /* starget_data must be the last element!!!! */
168 } __attribute__((aligned(sizeof(unsigned long))));
169
170 #define to_scsi_target(d)       container_of(d, struct scsi_target, dev)
171 static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
172 {
173         return to_scsi_target(sdev->sdev_gendev.parent);
174 }
175 #define transport_class_to_starget(class_dev) \
176         to_scsi_target(class_dev->dev)
177
178 extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
179                 uint, uint, uint, void *hostdata);
180 #define scsi_add_device(host, channel, target, lun) \
181         __scsi_add_device(host, channel, target, lun, NULL)
182 extern void scsi_remove_device(struct scsi_device *);
183 extern int scsi_device_cancel(struct scsi_device *, int);
184
185 extern int scsi_device_get(struct scsi_device *);
186 extern void scsi_device_put(struct scsi_device *);
187 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
188                                               uint, uint, uint);
189 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
190                                                 uint, uint, uint);
191 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
192                                                         uint);
193 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
194                                                           uint);
195 extern void starget_for_each_device(struct scsi_target *, void *,
196                      void (*fn)(struct scsi_device *, void *));
197
198 /* only exposed to implement shost_for_each_device */
199 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
200                                                   struct scsi_device *);
201
202 /**
203  * shost_for_each_device  -  iterate over all devices of a host
204  * @sdev:       iterator
205  * @host:       host whiches devices we want to iterate over
206  *
207  * This traverses over each devices of @shost.  The devices have
208  * a reference that must be released by scsi_host_put when breaking
209  * out of the loop.
210  */
211 #define shost_for_each_device(sdev, shost) \
212         for ((sdev) = __scsi_iterate_devices((shost), NULL); \
213              (sdev); \
214              (sdev) = __scsi_iterate_devices((shost), (sdev)))
215
216 /**
217  * __shost_for_each_device  -  iterate over all devices of a host (UNLOCKED)
218  * @sdev:       iterator
219  * @host:       host whiches devices we want to iterate over
220  *
221  * This traverses over each devices of @shost.  It does _not_ take a
222  * reference on the scsi_device, thus it the whole loop must be protected
223  * by shost->host_lock.
224  *
225  * Note:  The only reason why drivers would want to use this is because
226  * they're need to access the device list in irq context.  Otherwise you
227  * really want to use shost_for_each_device instead.
228  */
229 #define __shost_for_each_device(sdev, shost) \
230         list_for_each_entry((sdev), &((shost)->__devices), siblings)
231
232 extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
233 extern int scsi_track_queue_full(struct scsi_device *, int);
234
235 extern int scsi_set_medium_removal(struct scsi_device *, char);
236
237 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
238                            unsigned char *buffer, int len, int timeout,
239                            int retries, struct scsi_mode_data *data,
240                            char *sense);
241 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
242                                 int retries);
243 extern int scsi_device_set_state(struct scsi_device *sdev,
244                                  enum scsi_device_state state);
245 extern int scsi_device_quiesce(struct scsi_device *sdev);
246 extern void scsi_device_resume(struct scsi_device *sdev);
247 extern void scsi_target_quiesce(struct scsi_target *);
248 extern void scsi_target_resume(struct scsi_target *);
249 extern void scsi_scan_target(struct device *parent, unsigned int channel,
250                              unsigned int id, unsigned int lun, int rescan);
251 extern void scsi_target_reap(struct scsi_target *);
252 extern void scsi_target_block(struct device *);
253 extern void scsi_target_unblock(struct device *);
254 extern void scsi_remove_target(struct device *);
255 extern void int_to_scsilun(unsigned int, struct scsi_lun *);
256 extern const char *scsi_device_state_name(enum scsi_device_state);
257 extern int scsi_is_sdev_device(const struct device *);
258 extern int scsi_is_target_device(const struct device *);
259 extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
260                         int data_direction, void *buffer, unsigned bufflen,
261                         unsigned char *sense, int timeout, int retries,
262                         int flag);
263
264 static inline int
265 scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
266                  int data_direction, void *buffer, unsigned bufflen,
267                  unsigned char *sense, int timeout, int retries)
268 {
269         return scsi_execute(sdev, cmd, data_direction, buffer, bufflen, sense,
270                             timeout, retries, 0);
271 }
272 static inline int scsi_device_online(struct scsi_device *sdev)
273 {
274         return sdev->sdev_state != SDEV_OFFLINE;
275 }
276
277 /* accessor functions for the SCSI parameters */
278 static inline int scsi_device_sync(struct scsi_device *sdev)
279 {
280         return sdev->sdtr;
281 }
282 static inline int scsi_device_wide(struct scsi_device *sdev)
283 {
284         return sdev->wdtr;
285 }
286 static inline int scsi_device_dt(struct scsi_device *sdev)
287 {
288         return sdev->ppr;
289 }
290 static inline int scsi_device_dt_only(struct scsi_device *sdev)
291 {
292         if (sdev->inquiry_len < 57)
293                 return 0;
294         return (sdev->inquiry[56] & 0x0c) == 0x04;
295 }
296 static inline int scsi_device_ius(struct scsi_device *sdev)
297 {
298         if (sdev->inquiry_len < 57)
299                 return 0;
300         return sdev->inquiry[56] & 0x01;
301 }
302 static inline int scsi_device_qas(struct scsi_device *sdev)
303 {
304         if (sdev->inquiry_len < 57)
305                 return 0;
306         return sdev->inquiry[56] & 0x02;
307 }
308 #endif /* _SCSI_SCSI_DEVICE_H */