]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - include/scsi/scsi_device.h
50c2a363bc8fec46d60240c5af8fe4fd2754f9f7
[mirror_ubuntu-zesty-kernel.git] / include / scsi / scsi_device.h
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
11 struct device;
12 struct request_queue;
13 struct scsi_cmnd;
14 struct scsi_lun;
15 struct scsi_sense_hdr;
16
17 struct 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 * sdev state: If you alter this, you also need to alter scsi_sysfs.c
28 * (for the ascii descriptions) and the state model enforcer:
29 * scsi_lib:scsi_device_set_state().
30 */
31 enum scsi_device_state {
32 SDEV_CREATED = 1, /* device created but not added to sysfs
33 * Only internal commands allowed (for inq) */
34 SDEV_RUNNING, /* device properly configured
35 * All commands allowed */
36 SDEV_CANCEL, /* beginning to delete device
37 * Only error handler commands allowed */
38 SDEV_DEL, /* device deleted
39 * no commands allowed */
40 SDEV_QUIESCE, /* Device quiescent. No block commands
41 * will be accepted, only specials (which
42 * originate in the mid-layer) */
43 SDEV_OFFLINE, /* Device offlined (by error handling or
44 * user request */
45 SDEV_TRANSPORT_OFFLINE, /* Offlined by transport class error handler */
46 SDEV_BLOCK, /* Device blocked by scsi lld. No
47 * scsi commands from user or midlayer
48 * should be issued to the scsi
49 * lld. */
50 SDEV_CREATED_BLOCK, /* same as above but for created devices */
51 };
52
53 enum scsi_device_event {
54 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
55 SDEV_EVT_INQUIRY_CHANGE_REPORTED, /* 3F 03 UA reported */
56 SDEV_EVT_CAPACITY_CHANGE_REPORTED, /* 2A 09 UA reported */
57 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED, /* 38 07 UA reported */
58 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED, /* 2A 01 UA reported */
59 SDEV_EVT_LUN_CHANGE_REPORTED, /* 3F 0E UA reported */
60 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, /* 2A 06 UA 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
68 struct scsi_event {
69 enum scsi_device_event evt_type;
70 struct list_head node;
71
72 /* put union of data structures, for non-simple event types,
73 * here
74 */
75 };
76
77 struct scsi_device {
78 struct Scsi_Host *host;
79 struct request_queue *request_queue;
80
81 /* the next two are protected by the host->host_lock */
82 struct list_head siblings; /* list of all devices on this host */
83 struct list_head same_target_siblings; /* just the devices sharing same target id */
84
85 atomic_t device_busy; /* commands actually active on LLDD */
86 atomic_t device_blocked; /* Device returned QUEUE_FULL. */
87
88 spinlock_t list_lock;
89 struct list_head cmd_list; /* queue of in use SCSI Command structures */
90 struct list_head starved_entry;
91 struct scsi_cmnd *current_cmnd; /* currently active command */
92 unsigned short queue_depth; /* How deep of a queue we want */
93 unsigned short max_queue_depth; /* max queue depth */
94 unsigned short last_queue_full_depth; /* These two are used by */
95 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
96 unsigned long last_queue_full_time; /* last queue full time */
97 unsigned long queue_ramp_up_period; /* ramp up period in jiffies */
98 #define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
99
100 unsigned long last_queue_ramp_up; /* last queue ramp up time */
101
102 unsigned int id, channel;
103 u64 lun;
104 unsigned int manufacturer; /* Manufacturer of device, for using
105 * vendor-specific cmd's */
106 unsigned sector_size; /* size in bytes */
107
108 void *hostdata; /* available to low-level driver */
109 char type;
110 char scsi_level;
111 char inq_periph_qual; /* PQ from INQUIRY data */
112 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
113 unsigned char * inquiry; /* INQUIRY response data */
114 const char * vendor; /* [back_compat] point into 'inquiry' ... */
115 const char * model; /* ... after scan; point to static string */
116 const char * rev; /* ... "nullnullnullnull" before scan */
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; /* current tag */
124 struct scsi_target *sdev_target; /* used only for single_lun */
125
126 unsigned int sdev_bflags; /* black/white flags as also found in
127 * scsi_devinfo.[hc]. For now used only to
128 * pass settings from slave_alloc to scsi
129 * core. */
130 unsigned int eh_timeout; /* Error handling timeout */
131 unsigned removable:1;
132 unsigned changed:1; /* Data invalid due to media change */
133 unsigned busy:1; /* Used to prevent races */
134 unsigned lockable:1; /* Able to prevent media removal */
135 unsigned locked:1; /* Media removal disabled */
136 unsigned borken:1; /* Tell the Seagate driver to be
137 * painfully slow on this device */
138 unsigned disconnect:1; /* can disconnect */
139 unsigned soft_reset:1; /* Uses soft reset option */
140 unsigned sdtr:1; /* Device supports SDTR messages */
141 unsigned wdtr:1; /* Device supports WDTR messages */
142 unsigned ppr:1; /* Device supports PPR messages */
143 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
144 unsigned simple_tags:1; /* simple queue tag messages are enabled */
145 unsigned was_reset:1; /* There was a bus reset on the bus for
146 * this device */
147 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
148 * because we did a bus reset. */
149 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
150 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
151 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
152 unsigned no_write_same:1; /* no WRITE SAME command */
153 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
154 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
155 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
156 unsigned skip_vpd_pages:1; /* do not read VPD pages */
157 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
158 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
159 unsigned no_start_on_add:1; /* do not issue start on add */
160 unsigned allow_restart:1; /* issue START_UNIT in error handler */
161 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
162 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
163 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
164 unsigned select_no_atn:1;
165 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
166 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
167 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
168 unsigned last_sector_bug:1; /* do not use multisector accesses on
169 SD_LAST_BUGGY_SECTORS */
170 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
171 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
172 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
173 unsigned is_visible:1; /* is the device visible in sysfs */
174 unsigned wce_default_on:1; /* Cache is ON by default */
175 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
176 unsigned broken_fua:1; /* Don't set FUA bit */
177 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
178
179 atomic_t disk_events_disable_depth; /* disable depth for disk events */
180
181 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
182 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
183 struct list_head event_list; /* asserted events */
184 struct work_struct event_work;
185
186 unsigned int max_device_blocked; /* what device_blocked counts down from */
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; /* used to get process context on put */
197 struct work_struct requeue_work;
198
199 struct scsi_dh_data *scsi_dh_data;
200 enum scsi_device_state sdev_state;
201 unsigned long sdev_data[0];
202 } __attribute__((aligned(sizeof(unsigned long))));
203
204 typedef void (*activate_complete)(void *, int);
205 struct scsi_device_handler {
206 /* Used by the infrastructure */
207 struct list_head list; /* list of scsi_device_handlers */
208
209 /* Filled by the hardware handler */
210 struct module *module;
211 const char *name;
212 int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
213 struct scsi_dh_data *(*attach)(struct scsi_device *);
214 void (*detach)(struct scsi_device *);
215 int (*activate)(struct scsi_device *, activate_complete, void *);
216 int (*prep_fn)(struct scsi_device *, struct request *);
217 int (*set_params)(struct scsi_device *, const char *);
218 bool (*match)(struct scsi_device *);
219 };
220
221 struct scsi_dh_data {
222 struct scsi_device_handler *scsi_dh;
223 struct scsi_device *sdev;
224 struct kref kref;
225 };
226
227 #define to_scsi_device(d) \
228 container_of(d, struct scsi_device, sdev_gendev)
229 #define class_to_sdev(d) \
230 container_of(d, struct scsi_device, sdev_dev)
231 #define transport_class_to_sdev(class_dev) \
232 to_scsi_device(class_dev->parent)
233
234 #define sdev_dbg(sdev, fmt, a...) \
235 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
236
237 /*
238 * like scmd_printk, but the device name is passed in
239 * as a string pointer
240 */
241 __printf(4, 5) void
242 sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
243 const char *, ...);
244
245 #define sdev_printk(l, sdev, fmt, a...) \
246 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
247
248 __printf(3, 4) void
249 scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...);
250
251 #define scmd_dbg(scmd, fmt, a...) \
252 do { \
253 if ((scmd)->request->rq_disk) \
254 sdev_dbg((scmd)->device, "[%s] " fmt, \
255 (scmd)->request->rq_disk->disk_name, ##a);\
256 else \
257 sdev_dbg((scmd)->device, fmt, ##a); \
258 } while (0)
259
260 enum scsi_target_state {
261 STARGET_CREATED = 1,
262 STARGET_RUNNING,
263 STARGET_DEL,
264 };
265
266 /*
267 * scsi_target: representation of a scsi target, for now, this is only
268 * used for single_lun devices. If no one has active IO to the target,
269 * starget_sdev_user is NULL, else it points to the active sdev.
270 */
271 struct scsi_target {
272 struct scsi_device *starget_sdev_user;
273 struct list_head siblings;
274 struct list_head devices;
275 struct device dev;
276 struct kref reap_ref; /* last put renders target invisible */
277 unsigned int channel;
278 unsigned int id; /* target id ... replace
279 * scsi_device.id eventually */
280 unsigned int create:1; /* signal that it needs to be added */
281 unsigned int single_lun:1; /* Indicates we should only
282 * allow I/O to one of the luns
283 * for the device at a time. */
284 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f
285 * means no lun present. */
286 unsigned int no_report_luns:1; /* Don't use
287 * REPORT LUNS for scanning. */
288 unsigned int expecting_lun_change:1; /* A device has reported
289 * a 3F/0E UA, other devices on
290 * the same target will also. */
291 /* commands actually active on LLD. */
292 atomic_t target_busy;
293 atomic_t target_blocked;
294
295 /*
296 * LLDs should set this in the slave_alloc host template callout.
297 * If set to zero then there is not limit.
298 */
299 unsigned int can_queue;
300 unsigned int max_target_blocked;
301 #define SCSI_DEFAULT_TARGET_BLOCKED 3
302
303 char scsi_level;
304 enum scsi_target_state state;
305 void *hostdata; /* available to low-level driver */
306 unsigned long starget_data[0]; /* for the transport */
307 /* starget_data must be the last element!!!! */
308 } __attribute__((aligned(sizeof(unsigned long))));
309
310 #define to_scsi_target(d) container_of(d, struct scsi_target, dev)
311 static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
312 {
313 return to_scsi_target(sdev->sdev_gendev.parent);
314 }
315 #define transport_class_to_starget(class_dev) \
316 to_scsi_target(class_dev->parent)
317
318 #define starget_printk(prefix, starget, fmt, a...) \
319 dev_printk(prefix, &(starget)->dev, fmt, ##a)
320
321 extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
322 uint, uint, u64, void *hostdata);
323 extern int scsi_add_device(struct Scsi_Host *host, uint channel,
324 uint target, u64 lun);
325 extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
326 extern void scsi_remove_device(struct scsi_device *);
327 extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
328 void scsi_attach_vpd(struct scsi_device *sdev);
329
330 extern int scsi_device_get(struct scsi_device *);
331 extern void scsi_device_put(struct scsi_device *);
332 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
333 uint, uint, u64);
334 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
335 uint, uint, u64);
336 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
337 u64);
338 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
339 u64);
340 extern void starget_for_each_device(struct scsi_target *, void *,
341 void (*fn)(struct scsi_device *, void *));
342 extern void __starget_for_each_device(struct scsi_target *, void *,
343 void (*fn)(struct scsi_device *,
344 void *));
345
346 /* only exposed to implement shost_for_each_device */
347 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
348 struct scsi_device *);
349
350 /**
351 * shost_for_each_device - iterate over all devices of a host
352 * @sdev: the &struct scsi_device to use as a cursor
353 * @shost: the &struct scsi_host to iterate over
354 *
355 * Iterator that returns each device attached to @shost. This loop
356 * takes a reference on each device and releases it at the end. If
357 * you break out of the loop, you must call scsi_device_put(sdev).
358 */
359 #define shost_for_each_device(sdev, shost) \
360 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
361 (sdev); \
362 (sdev) = __scsi_iterate_devices((shost), (sdev)))
363
364 /**
365 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
366 * @sdev: the &struct scsi_device to use as a cursor
367 * @shost: the &struct scsi_host to iterate over
368 *
369 * Iterator that returns each device attached to @shost. It does _not_
370 * take a reference on the scsi_device, so the whole loop must be
371 * protected by shost->host_lock.
372 *
373 * Note: The only reason to use this is because you need to access the
374 * device list in interrupt context. Otherwise you really want to use
375 * shost_for_each_device instead.
376 */
377 #define __shost_for_each_device(sdev, shost) \
378 list_for_each_entry((sdev), &((shost)->__devices), siblings)
379
380 extern int scsi_change_queue_depth(struct scsi_device *, int);
381 extern int scsi_track_queue_full(struct scsi_device *, int);
382
383 extern int scsi_set_medium_removal(struct scsi_device *, char);
384
385 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
386 unsigned char *buffer, int len, int timeout,
387 int retries, struct scsi_mode_data *data,
388 struct scsi_sense_hdr *);
389 extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
390 int modepage, unsigned char *buffer, int len,
391 int timeout, int retries,
392 struct scsi_mode_data *data,
393 struct scsi_sense_hdr *);
394 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
395 int retries, struct scsi_sense_hdr *sshdr);
396 extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
397 int buf_len);
398 extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
399 unsigned int len, unsigned char opcode);
400 extern int scsi_device_set_state(struct scsi_device *sdev,
401 enum scsi_device_state state);
402 extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
403 gfp_t gfpflags);
404 extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
405 extern void sdev_evt_send_simple(struct scsi_device *sdev,
406 enum scsi_device_event evt_type, gfp_t gfpflags);
407 extern int scsi_device_quiesce(struct scsi_device *sdev);
408 extern void scsi_device_resume(struct scsi_device *sdev);
409 extern void scsi_target_quiesce(struct scsi_target *);
410 extern void scsi_target_resume(struct scsi_target *);
411 extern void scsi_scan_target(struct device *parent, unsigned int channel,
412 unsigned int id, u64 lun, int rescan);
413 extern void scsi_target_reap(struct scsi_target *);
414 extern void scsi_target_block(struct device *);
415 extern void scsi_target_unblock(struct device *, enum scsi_device_state);
416 extern void scsi_remove_target(struct device *);
417 extern const char *scsi_device_state_name(enum scsi_device_state);
418 extern int scsi_is_sdev_device(const struct device *);
419 extern int scsi_is_target_device(const struct device *);
420 extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
421 int data_direction, void *buffer, unsigned bufflen,
422 unsigned char *sense, int timeout, int retries,
423 u64 flags, int *resid);
424 extern int scsi_execute_req_flags(struct scsi_device *sdev,
425 const unsigned char *cmd, int data_direction, void *buffer,
426 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
427 int retries, int *resid, u64 flags);
428 static inline int scsi_execute_req(struct scsi_device *sdev,
429 const unsigned char *cmd, int data_direction, void *buffer,
430 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
431 int retries, int *resid)
432 {
433 return scsi_execute_req_flags(sdev, cmd, data_direction, buffer,
434 bufflen, sshdr, timeout, retries, resid, 0);
435 }
436 extern void sdev_disable_disk_events(struct scsi_device *sdev);
437 extern void sdev_enable_disk_events(struct scsi_device *sdev);
438
439 #ifdef CONFIG_PM
440 extern int scsi_autopm_get_device(struct scsi_device *);
441 extern void scsi_autopm_put_device(struct scsi_device *);
442 #else
443 static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
444 static inline void scsi_autopm_put_device(struct scsi_device *d) {}
445 #endif /* CONFIG_PM */
446
447 static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
448 {
449 return device_reprobe(&sdev->sdev_gendev);
450 }
451
452 static inline unsigned int sdev_channel(struct scsi_device *sdev)
453 {
454 return sdev->channel;
455 }
456
457 static inline unsigned int sdev_id(struct scsi_device *sdev)
458 {
459 return sdev->id;
460 }
461
462 #define scmd_id(scmd) sdev_id((scmd)->device)
463 #define scmd_channel(scmd) sdev_channel((scmd)->device)
464
465 /*
466 * checks for positions of the SCSI state machine
467 */
468 static inline int scsi_device_online(struct scsi_device *sdev)
469 {
470 return (sdev->sdev_state != SDEV_OFFLINE &&
471 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
472 sdev->sdev_state != SDEV_DEL);
473 }
474 static inline int scsi_device_blocked(struct scsi_device *sdev)
475 {
476 return sdev->sdev_state == SDEV_BLOCK ||
477 sdev->sdev_state == SDEV_CREATED_BLOCK;
478 }
479 static inline int scsi_device_created(struct scsi_device *sdev)
480 {
481 return sdev->sdev_state == SDEV_CREATED ||
482 sdev->sdev_state == SDEV_CREATED_BLOCK;
483 }
484
485 /* accessor functions for the SCSI parameters */
486 static inline int scsi_device_sync(struct scsi_device *sdev)
487 {
488 return sdev->sdtr;
489 }
490 static inline int scsi_device_wide(struct scsi_device *sdev)
491 {
492 return sdev->wdtr;
493 }
494 static inline int scsi_device_dt(struct scsi_device *sdev)
495 {
496 return sdev->ppr;
497 }
498 static inline int scsi_device_dt_only(struct scsi_device *sdev)
499 {
500 if (sdev->inquiry_len < 57)
501 return 0;
502 return (sdev->inquiry[56] & 0x0c) == 0x04;
503 }
504 static inline int scsi_device_ius(struct scsi_device *sdev)
505 {
506 if (sdev->inquiry_len < 57)
507 return 0;
508 return sdev->inquiry[56] & 0x01;
509 }
510 static inline int scsi_device_qas(struct scsi_device *sdev)
511 {
512 if (sdev->inquiry_len < 57)
513 return 0;
514 return sdev->inquiry[56] & 0x02;
515 }
516 static inline int scsi_device_enclosure(struct scsi_device *sdev)
517 {
518 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
519 }
520
521 static inline int scsi_device_protection(struct scsi_device *sdev)
522 {
523 if (sdev->no_dif)
524 return 0;
525
526 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
527 }
528
529 static inline int scsi_device_tpgs(struct scsi_device *sdev)
530 {
531 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
532 }
533
534 #define MODULE_ALIAS_SCSI_DEVICE(type) \
535 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
536 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
537
538 #endif /* _SCSI_SCSI_DEVICE_H */