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