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