userns: Make map_id_down a wrapper for map_id_range_down
[cris-mirror.git] / include / scsi / scsi_device.h
blob82e93ee94708c9f7de073b3e6c47826664525075
1 #ifndef _SCSI_SCSI_DEVICE_H
2 #define _SCSI_SCSI_DEVICE_H
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>
11 struct device;
12 struct request_queue;
13 struct scsi_cmnd;
14 struct scsi_lun;
15 struct scsi_sense_hdr;
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;
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().
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 */
53 enum scsi_scan_mode {
54 SCSI_SCAN_INITIAL = 0,
55 SCSI_SCAN_RESCAN,
56 SCSI_SCAN_MANUAL,
59 enum scsi_device_event {
60 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
61 SDEV_EVT_INQUIRY_CHANGE_REPORTED, /* 3F 03 UA reported */
62 SDEV_EVT_CAPACITY_CHANGE_REPORTED, /* 2A 09 UA reported */
63 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED, /* 38 07 UA reported */
64 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED, /* 2A 01 UA reported */
65 SDEV_EVT_LUN_CHANGE_REPORTED, /* 3F 0E UA reported */
66 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, /* 2A 06 UA reported */
68 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE,
69 SDEV_EVT_LAST = SDEV_EVT_ALUA_STATE_CHANGE_REPORTED,
71 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
74 struct scsi_event {
75 enum scsi_device_event evt_type;
76 struct list_head node;
78 /* put union of data structures, for non-simple event types,
79 * here
83 /**
84 * struct scsi_vpd - SCSI Vital Product Data
85 * @rcu: For kfree_rcu().
86 * @len: Length in bytes of @data.
87 * @data: VPD data as defined in various T10 SCSI standard documents.
89 struct scsi_vpd {
90 struct rcu_head rcu;
91 int len;
92 unsigned char data[];
95 struct scsi_device {
96 struct Scsi_Host *host;
97 struct request_queue *request_queue;
99 /* the next two are protected by the host->host_lock */
100 struct list_head siblings; /* list of all devices on this host */
101 struct list_head same_target_siblings; /* just the devices sharing same target id */
103 atomic_t device_busy; /* commands actually active on LLDD */
104 atomic_t device_blocked; /* Device returned QUEUE_FULL. */
106 spinlock_t list_lock;
107 struct list_head cmd_list; /* queue of in use SCSI Command structures */
108 struct list_head starved_entry;
109 unsigned short queue_depth; /* How deep of a queue we want */
110 unsigned short max_queue_depth; /* max queue depth */
111 unsigned short last_queue_full_depth; /* These two are used by */
112 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
113 unsigned long last_queue_full_time; /* last queue full time */
114 unsigned long queue_ramp_up_period; /* ramp up period in jiffies */
115 #define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
117 unsigned long last_queue_ramp_up; /* last queue ramp up time */
119 unsigned int id, channel;
120 u64 lun;
121 unsigned int manufacturer; /* Manufacturer of device, for using
122 * vendor-specific cmd's */
123 unsigned sector_size; /* size in bytes */
125 void *hostdata; /* available to low-level driver */
126 unsigned char type;
127 char scsi_level;
128 char inq_periph_qual; /* PQ from INQUIRY data */
129 struct mutex inquiry_mutex;
130 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
131 unsigned char * inquiry; /* INQUIRY response data */
132 const char * vendor; /* [back_compat] point into 'inquiry' ... */
133 const char * model; /* ... after scan; point to static string */
134 const char * rev; /* ... "nullnullnullnull" before scan */
136 #define SCSI_VPD_PG_LEN 255
137 struct scsi_vpd __rcu *vpd_pg83;
138 struct scsi_vpd __rcu *vpd_pg80;
139 unsigned char current_tag; /* current tag */
140 struct scsi_target *sdev_target; /* used only for single_lun */
142 unsigned int sdev_bflags; /* black/white flags as also found in
143 * scsi_devinfo.[hc]. For now used only to
144 * pass settings from slave_alloc to scsi
145 * core. */
146 unsigned int eh_timeout; /* Error handling timeout */
147 unsigned removable:1;
148 unsigned changed:1; /* Data invalid due to media change */
149 unsigned busy:1; /* Used to prevent races */
150 unsigned lockable:1; /* Able to prevent media removal */
151 unsigned locked:1; /* Media removal disabled */
152 unsigned borken:1; /* Tell the Seagate driver to be
153 * painfully slow on this device */
154 unsigned disconnect:1; /* can disconnect */
155 unsigned soft_reset:1; /* Uses soft reset option */
156 unsigned sdtr:1; /* Device supports SDTR messages */
157 unsigned wdtr:1; /* Device supports WDTR messages */
158 unsigned ppr:1; /* Device supports PPR messages */
159 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
160 unsigned simple_tags:1; /* simple queue tag messages are enabled */
161 unsigned was_reset:1; /* There was a bus reset on the bus for
162 * this device */
163 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
164 * because we did a bus reset. */
165 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
166 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
167 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
168 unsigned no_write_same:1; /* no WRITE SAME command */
169 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
170 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
171 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
172 unsigned skip_vpd_pages:1; /* do not read VPD pages */
173 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
174 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
175 unsigned no_start_on_add:1; /* do not issue start on add */
176 unsigned allow_restart:1; /* issue START_UNIT in error handler */
177 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
178 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
179 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
180 unsigned select_no_atn:1;
181 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
182 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
183 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
184 unsigned last_sector_bug:1; /* do not use multisector accesses on
185 SD_LAST_BUGGY_SECTORS */
186 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
187 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
188 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
189 unsigned security_supported:1; /* Supports Security Protocols */
190 unsigned is_visible:1; /* is the device visible in sysfs */
191 unsigned wce_default_on:1; /* Cache is ON by default */
192 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
193 unsigned broken_fua:1; /* Don't set FUA bit */
194 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
196 atomic_t disk_events_disable_depth; /* disable depth for disk events */
198 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
199 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
200 struct list_head event_list; /* asserted events */
201 struct work_struct event_work;
203 unsigned int max_device_blocked; /* what device_blocked counts down from */
204 #define SCSI_DEFAULT_DEVICE_BLOCKED 3
206 atomic_t iorequest_cnt;
207 atomic_t iodone_cnt;
208 atomic_t ioerr_cnt;
210 struct device sdev_gendev,
211 sdev_dev;
213 struct execute_work ew; /* used to get process context on put */
214 struct work_struct requeue_work;
216 struct scsi_device_handler *handler;
217 void *handler_data;
219 unsigned char access_state;
220 struct mutex state_mutex;
221 enum scsi_device_state sdev_state;
222 unsigned long sdev_data[0];
223 } __attribute__((aligned(sizeof(unsigned long))));
225 #define to_scsi_device(d) \
226 container_of(d, struct scsi_device, sdev_gendev)
227 #define class_to_sdev(d) \
228 container_of(d, struct scsi_device, sdev_dev)
229 #define transport_class_to_sdev(class_dev) \
230 to_scsi_device(class_dev->parent)
232 #define sdev_dbg(sdev, fmt, a...) \
233 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
236 * like scmd_printk, but the device name is passed in
237 * as a string pointer
239 __printf(4, 5) void
240 sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
241 const char *, ...);
243 #define sdev_printk(l, sdev, fmt, a...) \
244 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
246 __printf(3, 4) void
247 scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...);
249 #define scmd_dbg(scmd, fmt, a...) \
250 do { \
251 if ((scmd)->request->rq_disk) \
252 sdev_dbg((scmd)->device, "[%s] " fmt, \
253 (scmd)->request->rq_disk->disk_name, ##a);\
254 else \
255 sdev_dbg((scmd)->device, fmt, ##a); \
256 } while (0)
258 enum scsi_target_state {
259 STARGET_CREATED = 1,
260 STARGET_RUNNING,
261 STARGET_REMOVE,
262 STARGET_CREATED_REMOVE,
263 STARGET_DEL,
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.
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;
296 * LLDs should set this in the slave_alloc host template callout.
297 * If set to zero then there is not limit.
299 unsigned int can_queue;
300 unsigned int max_target_blocked;
301 #define SCSI_DEFAULT_TARGET_BLOCKED 3
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))));
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)
313 return to_scsi_target(sdev->sdev_gendev.parent);
315 #define transport_class_to_starget(class_dev) \
316 to_scsi_target(class_dev->parent)
318 #define starget_printk(prefix, starget, fmt, a...) \
319 dev_printk(prefix, &(starget)->dev, fmt, ##a)
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);
330 extern struct scsi_device *scsi_device_from_queue(struct request_queue *q);
331 extern int __must_check scsi_device_get(struct scsi_device *);
332 extern void scsi_device_put(struct scsi_device *);
333 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
334 uint, uint, u64);
335 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
336 uint, uint, u64);
337 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
338 u64);
339 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
340 u64);
341 extern void starget_for_each_device(struct scsi_target *, void *,
342 void (*fn)(struct scsi_device *, void *));
343 extern void __starget_for_each_device(struct scsi_target *, void *,
344 void (*fn)(struct scsi_device *,
345 void *));
347 /* only exposed to implement shost_for_each_device */
348 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
349 struct scsi_device *);
352 * shost_for_each_device - iterate over all devices of a host
353 * @sdev: the &struct scsi_device to use as a cursor
354 * @shost: the &struct scsi_host to iterate over
356 * Iterator that returns each device attached to @shost. This loop
357 * takes a reference on each device and releases it at the end. If
358 * you break out of the loop, you must call scsi_device_put(sdev).
360 #define shost_for_each_device(sdev, shost) \
361 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
362 (sdev); \
363 (sdev) = __scsi_iterate_devices((shost), (sdev)))
366 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
367 * @sdev: the &struct scsi_device to use as a cursor
368 * @shost: the &struct scsi_host to iterate over
370 * Iterator that returns each device attached to @shost. It does _not_
371 * take a reference on the scsi_device, so the whole loop must be
372 * protected by shost->host_lock.
374 * Note: The only reason to use this is because you need to access the
375 * device list in interrupt context. Otherwise you really want to use
376 * shost_for_each_device instead.
378 #define __shost_for_each_device(sdev, shost) \
379 list_for_each_entry((sdev), &((shost)->__devices), siblings)
381 extern int scsi_change_queue_depth(struct scsi_device *, int);
382 extern int scsi_track_queue_full(struct scsi_device *, int);
384 extern int scsi_set_medium_removal(struct scsi_device *, char);
386 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
387 unsigned char *buffer, int len, int timeout,
388 int retries, struct scsi_mode_data *data,
389 struct scsi_sense_hdr *);
390 extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
391 int modepage, unsigned char *buffer, int len,
392 int timeout, int retries,
393 struct scsi_mode_data *data,
394 struct scsi_sense_hdr *);
395 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
396 int retries, struct scsi_sense_hdr *sshdr);
397 extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
398 int buf_len);
399 extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
400 unsigned int len, unsigned char opcode);
401 extern int scsi_device_set_state(struct scsi_device *sdev,
402 enum scsi_device_state state);
403 extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
404 gfp_t gfpflags);
405 extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
406 extern void sdev_evt_send_simple(struct scsi_device *sdev,
407 enum scsi_device_event evt_type, gfp_t gfpflags);
408 extern int scsi_device_quiesce(struct scsi_device *sdev);
409 extern void scsi_device_resume(struct scsi_device *sdev);
410 extern void scsi_target_quiesce(struct scsi_target *);
411 extern void scsi_target_resume(struct scsi_target *);
412 extern void scsi_scan_target(struct device *parent, unsigned int channel,
413 unsigned int id, u64 lun,
414 enum scsi_scan_mode rescan);
415 extern void scsi_target_reap(struct scsi_target *);
416 extern void scsi_target_block(struct device *);
417 extern void scsi_target_unblock(struct device *, enum scsi_device_state);
418 extern void scsi_remove_target(struct device *);
419 extern const char *scsi_device_state_name(enum scsi_device_state);
420 extern int scsi_is_sdev_device(const struct device *);
421 extern int scsi_is_target_device(const struct device *);
422 extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
423 extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
424 int data_direction, void *buffer, unsigned bufflen,
425 unsigned char *sense, struct scsi_sense_hdr *sshdr,
426 int timeout, int retries, u64 flags,
427 req_flags_t rq_flags, int *resid);
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)
433 return scsi_execute(sdev, cmd, data_direction, buffer,
434 bufflen, NULL, sshdr, timeout, retries, 0, 0, resid);
436 extern void sdev_disable_disk_events(struct scsi_device *sdev);
437 extern void sdev_enable_disk_events(struct scsi_device *sdev);
438 extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
439 extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
441 #ifdef CONFIG_PM
442 extern int scsi_autopm_get_device(struct scsi_device *);
443 extern void scsi_autopm_put_device(struct scsi_device *);
444 #else
445 static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
446 static inline void scsi_autopm_put_device(struct scsi_device *d) {}
447 #endif /* CONFIG_PM */
449 static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
451 return device_reprobe(&sdev->sdev_gendev);
454 static inline unsigned int sdev_channel(struct scsi_device *sdev)
456 return sdev->channel;
459 static inline unsigned int sdev_id(struct scsi_device *sdev)
461 return sdev->id;
464 #define scmd_id(scmd) sdev_id((scmd)->device)
465 #define scmd_channel(scmd) sdev_channel((scmd)->device)
468 * checks for positions of the SCSI state machine
470 static inline int scsi_device_online(struct scsi_device *sdev)
472 return (sdev->sdev_state != SDEV_OFFLINE &&
473 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
474 sdev->sdev_state != SDEV_DEL);
476 static inline int scsi_device_blocked(struct scsi_device *sdev)
478 return sdev->sdev_state == SDEV_BLOCK ||
479 sdev->sdev_state == SDEV_CREATED_BLOCK;
481 static inline int scsi_device_created(struct scsi_device *sdev)
483 return sdev->sdev_state == SDEV_CREATED ||
484 sdev->sdev_state == SDEV_CREATED_BLOCK;
487 int scsi_internal_device_block_nowait(struct scsi_device *sdev);
488 int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
489 enum scsi_device_state new_state);
491 /* accessor functions for the SCSI parameters */
492 static inline int scsi_device_sync(struct scsi_device *sdev)
494 return sdev->sdtr;
496 static inline int scsi_device_wide(struct scsi_device *sdev)
498 return sdev->wdtr;
500 static inline int scsi_device_dt(struct scsi_device *sdev)
502 return sdev->ppr;
504 static inline int scsi_device_dt_only(struct scsi_device *sdev)
506 if (sdev->inquiry_len < 57)
507 return 0;
508 return (sdev->inquiry[56] & 0x0c) == 0x04;
510 static inline int scsi_device_ius(struct scsi_device *sdev)
512 if (sdev->inquiry_len < 57)
513 return 0;
514 return sdev->inquiry[56] & 0x01;
516 static inline int scsi_device_qas(struct scsi_device *sdev)
518 if (sdev->inquiry_len < 57)
519 return 0;
520 return sdev->inquiry[56] & 0x02;
522 static inline int scsi_device_enclosure(struct scsi_device *sdev)
524 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
527 static inline int scsi_device_protection(struct scsi_device *sdev)
529 if (sdev->no_dif)
530 return 0;
532 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
535 static inline int scsi_device_tpgs(struct scsi_device *sdev)
537 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
541 * scsi_device_supports_vpd - test if a device supports VPD pages
542 * @sdev: the &struct scsi_device to test
544 * If the 'try_vpd_pages' flag is set it takes precedence.
545 * Otherwise we will assume VPD pages are supported if the
546 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
548 static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
550 /* Attempt VPD inquiry if the device blacklist explicitly calls
551 * for it.
553 if (sdev->try_vpd_pages)
554 return 1;
556 * Although VPD inquiries can go to SCSI-2 type devices,
557 * some USB ones crash on receiving them, and the pages
558 * we currently ask for are mandatory for SPC-2 and beyond
560 if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
561 return 1;
562 return 0;
565 #define MODULE_ALIAS_SCSI_DEVICE(type) \
566 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
567 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
569 #endif /* _SCSI_SCSI_DEVICE_H */