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