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