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