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