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