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