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