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
11struct device;
12struct request_queue;
13struct scsi_cmnd;
14struct scsi_lun;
15struct scsi_sense_hdr;
16
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
26
27
28
29
30
31enum scsi_device_state {
32 SDEV_CREATED = 1,
33
34 SDEV_RUNNING,
35
36 SDEV_CANCEL,
37
38 SDEV_DEL,
39
40 SDEV_QUIESCE,
41
42
43 SDEV_OFFLINE,
44
45 SDEV_TRANSPORT_OFFLINE,
46 SDEV_BLOCK,
47
48
49
50 SDEV_CREATED_BLOCK,
51};
52
53enum scsi_device_event {
54 SDEV_EVT_MEDIA_CHANGE = 1,
55 SDEV_EVT_INQUIRY_CHANGE_REPORTED,
56 SDEV_EVT_CAPACITY_CHANGE_REPORTED,
57 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED,
58 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED,
59 SDEV_EVT_LUN_CHANGE_REPORTED,
60
61 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE,
62 SDEV_EVT_LAST = SDEV_EVT_LUN_CHANGE_REPORTED,
63
64 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
65};
66
67struct scsi_event {
68 enum scsi_device_event evt_type;
69 struct list_head node;
70
71
72
73
74};
75
76struct scsi_device {
77 struct Scsi_Host *host;
78 struct request_queue *request_queue;
79
80
81 struct list_head siblings;
82 struct list_head same_target_siblings;
83
84
85 unsigned int device_busy;
86
87 spinlock_t list_lock;
88 struct list_head cmd_list;
89 struct list_head starved_entry;
90 struct scsi_cmnd *current_cmnd;
91 unsigned short queue_depth;
92 unsigned short max_queue_depth;
93 unsigned short last_queue_full_depth;
94 unsigned short last_queue_full_count;
95 unsigned long last_queue_full_time;
96 unsigned long queue_ramp_up_period;
97#define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
98
99 unsigned long last_queue_ramp_up;
100
101 unsigned int id, lun, channel;
102
103 unsigned int manufacturer;
104
105 unsigned sector_size;
106
107 void *hostdata;
108 char type;
109 char scsi_level;
110 char inq_periph_qual;
111 unsigned char inquiry_len;
112 unsigned char * inquiry;
113 const char * vendor;
114 const char * model;
115 const char * rev;
116 unsigned char current_tag;
117 struct scsi_target *sdev_target;
118
119 unsigned int sdev_bflags;
120
121
122
123 unsigned int eh_timeout;
124 unsigned writeable:1;
125 unsigned removable:1;
126 unsigned changed:1;
127 unsigned busy:1;
128 unsigned lockable:1;
129 unsigned locked:1;
130 unsigned borken:1;
131
132 unsigned disconnect:1;
133 unsigned soft_reset:1;
134 unsigned sdtr:1;
135 unsigned wdtr:1;
136 unsigned ppr:1;
137 unsigned tagged_supported:1;
138 unsigned simple_tags:1;
139 unsigned ordered_tags:1;
140 unsigned was_reset:1;
141
142 unsigned expecting_cc_ua:1;
143
144 unsigned use_10_for_rw:1;
145 unsigned use_10_for_ms:1;
146 unsigned no_report_opcodes:1;
147 unsigned no_write_same:1;
148 unsigned use_16_for_rw:1;
149 unsigned skip_ms_page_8:1;
150 unsigned skip_ms_page_3f:1;
151 unsigned skip_vpd_pages:1;
152 unsigned use_192_bytes_for_3f:1;
153 unsigned no_start_on_add:1;
154 unsigned allow_restart:1;
155 unsigned manage_start_stop:1;
156 unsigned start_stop_pwr_cond:1;
157 unsigned no_uld_attach:1;
158 unsigned select_no_atn:1;
159 unsigned fix_capacity:1;
160 unsigned guess_capacity:1;
161 unsigned retry_hwerror:1;
162 unsigned last_sector_bug:1;
163
164 unsigned no_read_disc_info:1;
165 unsigned no_read_capacity_16:1;
166 unsigned try_rc_10_first:1;
167 unsigned is_visible:1;
168 unsigned wce_default_on:1;
169 unsigned no_dif:1;
170
171 atomic_t disk_events_disable_depth;
172
173 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS);
174 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS);
175 struct list_head event_list;
176 struct work_struct event_work;
177
178 unsigned int device_blocked;
179
180 unsigned int max_device_blocked;
181#define SCSI_DEFAULT_DEVICE_BLOCKED 3
182
183 atomic_t iorequest_cnt;
184 atomic_t iodone_cnt;
185 atomic_t ioerr_cnt;
186
187 struct device sdev_gendev,
188 sdev_dev;
189
190 struct execute_work ew;
191 struct work_struct requeue_work;
192
193 struct scsi_dh_data *scsi_dh_data;
194 enum scsi_device_state sdev_state;
195 unsigned long sdev_data[0];
196} __attribute__((aligned(sizeof(unsigned long))));
197
198struct scsi_dh_devlist {
199 char *vendor;
200 char *model;
201};
202
203typedef void (*activate_complete)(void *, int);
204struct scsi_device_handler {
205
206 struct list_head list;
207
208
209 struct module *module;
210 const char *name;
211 const struct scsi_dh_devlist *devlist;
212 int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
213 int (*attach)(struct scsi_device *);
214 void (*detach)(struct scsi_device *);
215 int (*activate)(struct scsi_device *, activate_complete, void *);
216 int (*prep_fn)(struct scsi_device *, struct request *);
217 int (*set_params)(struct scsi_device *, const char *);
218 bool (*match)(struct scsi_device *);
219};
220
221struct scsi_dh_data {
222 struct scsi_device_handler *scsi_dh;
223 struct scsi_device *sdev;
224 struct kref kref;
225 char buf[0];
226};
227
228#define to_scsi_device(d) \
229 container_of(d, struct scsi_device, sdev_gendev)
230#define class_to_sdev(d) \
231 container_of(d, struct scsi_device, sdev_dev)
232#define transport_class_to_sdev(class_dev) \
233 to_scsi_device(class_dev->parent)
234
235#define sdev_printk(prefix, sdev, fmt, a...) \
236 dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
237
238#define scmd_printk(prefix, scmd, fmt, a...) \
239 (scmd)->request->rq_disk ? \
240 sdev_printk(prefix, (scmd)->device, "[%s] " fmt, \
241 (scmd)->request->rq_disk->disk_name, ##a) : \
242 sdev_printk(prefix, (scmd)->device, fmt, ##a)
243
244enum scsi_target_state {
245 STARGET_CREATED = 1,
246 STARGET_RUNNING,
247 STARGET_DEL,
248};
249
250
251
252
253
254
255struct scsi_target {
256 struct scsi_device *starget_sdev_user;
257 struct list_head siblings;
258 struct list_head devices;
259 struct device dev;
260 unsigned int reap_ref;
261 unsigned int channel;
262 unsigned int id;
263
264 unsigned int create:1;
265 unsigned int single_lun:1;
266
267
268 unsigned int pdt_1f_for_no_lun:1;
269
270 unsigned int no_report_luns:1;
271
272 unsigned int expecting_lun_change:1;
273
274
275
276 unsigned int target_busy;
277
278
279
280
281 unsigned int can_queue;
282 unsigned int target_blocked;
283 unsigned int max_target_blocked;
284#define SCSI_DEFAULT_TARGET_BLOCKED 3
285
286 char scsi_level;
287 struct execute_work ew;
288 enum scsi_target_state state;
289 void *hostdata;
290 unsigned long starget_data[0];
291
292} __attribute__((aligned(sizeof(unsigned long))));
293
294#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
295static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
296{
297 return to_scsi_target(sdev->sdev_gendev.parent);
298}
299#define transport_class_to_starget(class_dev) \
300 to_scsi_target(class_dev->parent)
301
302#define starget_printk(prefix, starget, fmt, a...) \
303 dev_printk(prefix, &(starget)->dev, fmt, ##a)
304
305extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
306 uint, uint, uint, void *hostdata);
307extern int scsi_add_device(struct Scsi_Host *host, uint channel,
308 uint target, uint lun);
309extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
310extern void scsi_remove_device(struct scsi_device *);
311extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
312
313extern int scsi_device_get(struct scsi_device *);
314extern void scsi_device_put(struct scsi_device *);
315extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
316 uint, uint, uint);
317extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
318 uint, uint, uint);
319extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
320 uint);
321extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
322 uint);
323extern void starget_for_each_device(struct scsi_target *, void *,
324 void (*fn)(struct scsi_device *, void *));
325extern void __starget_for_each_device(struct scsi_target *, void *,
326 void (*fn)(struct scsi_device *,
327 void *));
328
329
330extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
331 struct scsi_device *);
332
333
334
335
336
337
338
339
340
341
342#define shost_for_each_device(sdev, shost) \
343 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
344 (sdev); \
345 (sdev) = __scsi_iterate_devices((shost), (sdev)))
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360#define __shost_for_each_device(sdev, shost) \
361 list_for_each_entry((sdev), &((shost)->__devices), siblings)
362
363extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
364extern int scsi_track_queue_full(struct scsi_device *, int);
365
366extern int scsi_set_medium_removal(struct scsi_device *, char);
367
368extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
369 unsigned char *buffer, int len, int timeout,
370 int retries, struct scsi_mode_data *data,
371 struct scsi_sense_hdr *);
372extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
373 int modepage, unsigned char *buffer, int len,
374 int timeout, int retries,
375 struct scsi_mode_data *data,
376 struct scsi_sense_hdr *);
377extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
378 int retries, struct scsi_sense_hdr *sshdr);
379extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
380 int buf_len);
381extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
382 unsigned int len, unsigned char opcode);
383extern int scsi_device_set_state(struct scsi_device *sdev,
384 enum scsi_device_state state);
385extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
386 gfp_t gfpflags);
387extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
388extern void sdev_evt_send_simple(struct scsi_device *sdev,
389 enum scsi_device_event evt_type, gfp_t gfpflags);
390extern int scsi_device_quiesce(struct scsi_device *sdev);
391extern void scsi_device_resume(struct scsi_device *sdev);
392extern void scsi_target_quiesce(struct scsi_target *);
393extern void scsi_target_resume(struct scsi_target *);
394extern void scsi_scan_target(struct device *parent, unsigned int channel,
395 unsigned int id, unsigned int lun, int rescan);
396extern void scsi_target_reap(struct scsi_target *);
397extern void scsi_target_block(struct device *);
398extern void scsi_target_unblock(struct device *, enum scsi_device_state);
399extern void scsi_remove_target(struct device *);
400extern void int_to_scsilun(unsigned int, struct scsi_lun *);
401extern int scsilun_to_int(struct scsi_lun *);
402extern const char *scsi_device_state_name(enum scsi_device_state);
403extern int scsi_is_sdev_device(const struct device *);
404extern int scsi_is_target_device(const struct device *);
405extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
406 int data_direction, void *buffer, unsigned bufflen,
407 unsigned char *sense, int timeout, int retries,
408 int flag, int *resid);
409extern int scsi_execute_req_flags(struct scsi_device *sdev,
410 const unsigned char *cmd, int data_direction, void *buffer,
411 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
412 int retries, int *resid, int flags);
413static inline int scsi_execute_req(struct scsi_device *sdev,
414 const unsigned char *cmd, int data_direction, void *buffer,
415 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
416 int retries, int *resid)
417{
418 return scsi_execute_req_flags(sdev, cmd, data_direction, buffer,
419 bufflen, sshdr, timeout, retries, resid, 0);
420}
421extern void sdev_disable_disk_events(struct scsi_device *sdev);
422extern void sdev_enable_disk_events(struct scsi_device *sdev);
423
424#ifdef CONFIG_PM_RUNTIME
425extern int scsi_autopm_get_device(struct scsi_device *);
426extern void scsi_autopm_put_device(struct scsi_device *);
427#else
428static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
429static inline void scsi_autopm_put_device(struct scsi_device *d) {}
430#endif
431
432static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
433{
434 return device_reprobe(&sdev->sdev_gendev);
435}
436
437static inline unsigned int sdev_channel(struct scsi_device *sdev)
438{
439 return sdev->channel;
440}
441
442static inline unsigned int sdev_id(struct scsi_device *sdev)
443{
444 return sdev->id;
445}
446
447#define scmd_id(scmd) sdev_id((scmd)->device)
448#define scmd_channel(scmd) sdev_channel((scmd)->device)
449
450
451
452
453static inline int scsi_device_online(struct scsi_device *sdev)
454{
455 return (sdev->sdev_state != SDEV_OFFLINE &&
456 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
457 sdev->sdev_state != SDEV_DEL);
458}
459static inline int scsi_device_blocked(struct scsi_device *sdev)
460{
461 return sdev->sdev_state == SDEV_BLOCK ||
462 sdev->sdev_state == SDEV_CREATED_BLOCK;
463}
464static inline int scsi_device_created(struct scsi_device *sdev)
465{
466 return sdev->sdev_state == SDEV_CREATED ||
467 sdev->sdev_state == SDEV_CREATED_BLOCK;
468}
469
470
471static inline int scsi_device_sync(struct scsi_device *sdev)
472{
473 return sdev->sdtr;
474}
475static inline int scsi_device_wide(struct scsi_device *sdev)
476{
477 return sdev->wdtr;
478}
479static inline int scsi_device_dt(struct scsi_device *sdev)
480{
481 return sdev->ppr;
482}
483static inline int scsi_device_dt_only(struct scsi_device *sdev)
484{
485 if (sdev->inquiry_len < 57)
486 return 0;
487 return (sdev->inquiry[56] & 0x0c) == 0x04;
488}
489static inline int scsi_device_ius(struct scsi_device *sdev)
490{
491 if (sdev->inquiry_len < 57)
492 return 0;
493 return sdev->inquiry[56] & 0x01;
494}
495static inline int scsi_device_qas(struct scsi_device *sdev)
496{
497 if (sdev->inquiry_len < 57)
498 return 0;
499 return sdev->inquiry[56] & 0x02;
500}
501static inline int scsi_device_enclosure(struct scsi_device *sdev)
502{
503 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
504}
505
506static inline int scsi_device_protection(struct scsi_device *sdev)
507{
508 if (sdev->no_dif)
509 return 0;
510
511 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
512}
513
514static inline int scsi_device_tpgs(struct scsi_device *sdev)
515{
516 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
517}
518
519#define MODULE_ALIAS_SCSI_DEVICE(type) \
520 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
521#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
522
523#endif
524