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