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/blk-mq.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 unsigned int queue_stopped;
211 bool offline_already;
212
213 atomic_t disk_events_disable_depth;
214
215 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS);
216 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS);
217 struct list_head event_list;
218 struct work_struct event_work;
219
220 unsigned int max_device_blocked;
221#define SCSI_DEFAULT_DEVICE_BLOCKED 3
222
223 atomic_t iorequest_cnt;
224 atomic_t iodone_cnt;
225 atomic_t ioerr_cnt;
226
227 struct device sdev_gendev,
228 sdev_dev;
229
230 struct execute_work ew;
231 struct work_struct requeue_work;
232
233 struct scsi_device_handler *handler;
234 void *handler_data;
235
236 size_t dma_drain_len;
237 void *dma_drain_buf;
238
239 unsigned int sg_timeout;
240 unsigned int sg_reserved_size;
241
242 struct bsg_device *bsg_dev;
243 unsigned char access_state;
244 struct mutex state_mutex;
245 enum scsi_device_state sdev_state;
246 struct task_struct *quiesced_by;
247 unsigned long sdev_data[];
248} __attribute__((aligned(sizeof(unsigned long))));
249
250#define to_scsi_device(d) \
251 container_of(d, struct scsi_device, sdev_gendev)
252#define class_to_sdev(d) \
253 container_of(d, struct scsi_device, sdev_dev)
254#define transport_class_to_sdev(class_dev) \
255 to_scsi_device(class_dev->parent)
256
257#define sdev_dbg(sdev, fmt, a...) \
258 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
259
260
261
262
263
264__printf(4, 5) void
265sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
266 const char *, ...);
267
268#define sdev_printk(l, sdev, fmt, a...) \
269 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
270
271__printf(3, 4) void
272scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...);
273
274#define scmd_dbg(scmd, fmt, a...) \
275 do { \
276 struct request *__rq = scsi_cmd_to_rq((scmd)); \
277 \
278 if (__rq->rq_disk) \
279 sdev_dbg((scmd)->device, "[%s] " fmt, \
280 __rq->rq_disk->disk_name, ##a); \
281 else \
282 sdev_dbg((scmd)->device, fmt, ##a); \
283 } while (0)
284
285enum scsi_target_state {
286 STARGET_CREATED = 1,
287 STARGET_RUNNING,
288 STARGET_REMOVE,
289 STARGET_CREATED_REMOVE,
290 STARGET_DEL,
291};
292
293
294
295
296
297
298struct scsi_target {
299 struct scsi_device *starget_sdev_user;
300 struct list_head siblings;
301 struct list_head devices;
302 struct device dev;
303 struct kref reap_ref;
304 unsigned int channel;
305 unsigned int id;
306
307 unsigned int create:1;
308 unsigned int single_lun:1;
309
310
311 unsigned int pdt_1f_for_no_lun:1;
312
313 unsigned int no_report_luns:1;
314
315 unsigned int expecting_lun_change:1;
316
317
318
319 atomic_t target_busy;
320 atomic_t target_blocked;
321
322
323
324
325
326 unsigned int can_queue;
327 unsigned int max_target_blocked;
328#define SCSI_DEFAULT_TARGET_BLOCKED 3
329
330 char scsi_level;
331 enum scsi_target_state state;
332 void *hostdata;
333 unsigned long starget_data[];
334
335} __attribute__((aligned(sizeof(unsigned long))));
336
337#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
338static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
339{
340 return to_scsi_target(sdev->sdev_gendev.parent);
341}
342#define transport_class_to_starget(class_dev) \
343 to_scsi_target(class_dev->parent)
344
345#define starget_printk(prefix, starget, fmt, a...) \
346 dev_printk(prefix, &(starget)->dev, fmt, ##a)
347
348extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
349 uint, uint, u64, void *hostdata);
350extern int scsi_add_device(struct Scsi_Host *host, uint channel,
351 uint target, u64 lun);
352extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
353extern void scsi_remove_device(struct scsi_device *);
354extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
355void scsi_attach_vpd(struct scsi_device *sdev);
356
357extern struct scsi_device *scsi_device_from_queue(struct request_queue *q);
358extern int __must_check scsi_device_get(struct scsi_device *);
359extern void scsi_device_put(struct scsi_device *);
360extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
361 uint, uint, u64);
362extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
363 uint, uint, u64);
364extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
365 u64);
366extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
367 u64);
368extern void starget_for_each_device(struct scsi_target *, void *,
369 void (*fn)(struct scsi_device *, void *));
370extern void __starget_for_each_device(struct scsi_target *, void *,
371 void (*fn)(struct scsi_device *,
372 void *));
373
374
375extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
376 struct scsi_device *);
377
378
379
380
381
382
383
384
385
386
387#define shost_for_each_device(sdev, shost) \
388 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
389 (sdev); \
390 (sdev) = __scsi_iterate_devices((shost), (sdev)))
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405#define __shost_for_each_device(sdev, shost) \
406 list_for_each_entry((sdev), &((shost)->__devices), siblings)
407
408extern int scsi_change_queue_depth(struct scsi_device *, int);
409extern int scsi_track_queue_full(struct scsi_device *, int);
410
411extern int scsi_set_medium_removal(struct scsi_device *, char);
412
413extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
414 unsigned char *buffer, int len, int timeout,
415 int retries, struct scsi_mode_data *data,
416 struct scsi_sense_hdr *);
417extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
418 int modepage, unsigned char *buffer, int len,
419 int timeout, int retries,
420 struct scsi_mode_data *data,
421 struct scsi_sense_hdr *);
422extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
423 int retries, struct scsi_sense_hdr *sshdr);
424extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
425 int buf_len);
426extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
427 unsigned int len, unsigned char opcode);
428extern int scsi_device_set_state(struct scsi_device *sdev,
429 enum scsi_device_state state);
430extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
431 gfp_t gfpflags);
432extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
433extern void sdev_evt_send_simple(struct scsi_device *sdev,
434 enum scsi_device_event evt_type, gfp_t gfpflags);
435extern int scsi_device_quiesce(struct scsi_device *sdev);
436extern void scsi_device_resume(struct scsi_device *sdev);
437extern void scsi_target_quiesce(struct scsi_target *);
438extern void scsi_target_resume(struct scsi_target *);
439extern void scsi_scan_target(struct device *parent, unsigned int channel,
440 unsigned int id, u64 lun,
441 enum scsi_scan_mode rescan);
442extern void scsi_target_reap(struct scsi_target *);
443extern void scsi_target_block(struct device *);
444extern void scsi_target_unblock(struct device *, enum scsi_device_state);
445extern void scsi_remove_target(struct device *);
446extern const char *scsi_device_state_name(enum scsi_device_state);
447extern int scsi_is_sdev_device(const struct device *);
448extern int scsi_is_target_device(const struct device *);
449extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
450extern int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
451 int data_direction, void *buffer, unsigned bufflen,
452 unsigned char *sense, struct scsi_sense_hdr *sshdr,
453 int timeout, int retries, u64 flags,
454 req_flags_t rq_flags, int *resid);
455
456#define scsi_execute(sdev, cmd, data_direction, buffer, bufflen, sense, \
457 sshdr, timeout, retries, flags, rq_flags, resid) \
458({ \
459 BUILD_BUG_ON((sense) != NULL && \
460 sizeof(sense) != SCSI_SENSE_BUFFERSIZE); \
461 __scsi_execute(sdev, cmd, data_direction, buffer, bufflen, \
462 sense, sshdr, timeout, retries, flags, rq_flags, \
463 resid); \
464})
465static inline int scsi_execute_req(struct scsi_device *sdev,
466 const unsigned char *cmd, int data_direction, void *buffer,
467 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
468 int retries, int *resid)
469{
470 return scsi_execute(sdev, cmd, data_direction, buffer,
471 bufflen, NULL, sshdr, timeout, retries, 0, 0, resid);
472}
473extern void sdev_disable_disk_events(struct scsi_device *sdev);
474extern void sdev_enable_disk_events(struct scsi_device *sdev);
475extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
476extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
477
478#ifdef CONFIG_PM
479extern int scsi_autopm_get_device(struct scsi_device *);
480extern void scsi_autopm_put_device(struct scsi_device *);
481#else
482static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
483static inline void scsi_autopm_put_device(struct scsi_device *d) {}
484#endif
485
486static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
487{
488 return device_reprobe(&sdev->sdev_gendev);
489}
490
491static inline unsigned int sdev_channel(struct scsi_device *sdev)
492{
493 return sdev->channel;
494}
495
496static inline unsigned int sdev_id(struct scsi_device *sdev)
497{
498 return sdev->id;
499}
500
501#define scmd_id(scmd) sdev_id((scmd)->device)
502#define scmd_channel(scmd) sdev_channel((scmd)->device)
503
504
505
506
507static inline int scsi_device_online(struct scsi_device *sdev)
508{
509 return (sdev->sdev_state != SDEV_OFFLINE &&
510 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
511 sdev->sdev_state != SDEV_DEL);
512}
513static inline int scsi_device_blocked(struct scsi_device *sdev)
514{
515 return sdev->sdev_state == SDEV_BLOCK ||
516 sdev->sdev_state == SDEV_CREATED_BLOCK;
517}
518static inline int scsi_device_created(struct scsi_device *sdev)
519{
520 return sdev->sdev_state == SDEV_CREATED ||
521 sdev->sdev_state == SDEV_CREATED_BLOCK;
522}
523
524int scsi_internal_device_block_nowait(struct scsi_device *sdev);
525int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
526 enum scsi_device_state new_state);
527
528
529static inline int scsi_device_sync(struct scsi_device *sdev)
530{
531 return sdev->sdtr;
532}
533static inline int scsi_device_wide(struct scsi_device *sdev)
534{
535 return sdev->wdtr;
536}
537static inline int scsi_device_dt(struct scsi_device *sdev)
538{
539 return sdev->ppr;
540}
541static inline int scsi_device_dt_only(struct scsi_device *sdev)
542{
543 if (sdev->inquiry_len < 57)
544 return 0;
545 return (sdev->inquiry[56] & 0x0c) == 0x04;
546}
547static inline int scsi_device_ius(struct scsi_device *sdev)
548{
549 if (sdev->inquiry_len < 57)
550 return 0;
551 return sdev->inquiry[56] & 0x01;
552}
553static inline int scsi_device_qas(struct scsi_device *sdev)
554{
555 if (sdev->inquiry_len < 57)
556 return 0;
557 return sdev->inquiry[56] & 0x02;
558}
559static inline int scsi_device_enclosure(struct scsi_device *sdev)
560{
561 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
562}
563
564static inline int scsi_device_protection(struct scsi_device *sdev)
565{
566 if (sdev->no_dif)
567 return 0;
568
569 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
570}
571
572static inline int scsi_device_tpgs(struct scsi_device *sdev)
573{
574 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
575}
576
577
578
579
580
581
582
583
584
585static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
586{
587
588
589
590 if (sdev->try_vpd_pages)
591 return 1;
592
593
594
595
596
597 if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
598 return 1;
599 return 0;
600}
601
602static inline int scsi_device_busy(struct scsi_device *sdev)
603{
604 return sbitmap_weight(&sdev->budget_map);
605}
606
607#define MODULE_ALIAS_SCSI_DEVICE(type) \
608 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
609#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
610
611#endif
612