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