]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/scsi/scsi_device.h
[SCSI] sd: fix return value of sd_sync_cache()
[mirror_ubuntu-bionic-kernel.git] / include / scsi / scsi_device.h
CommitLineData
1da177e4
LT
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>
ffedb452 7#include <linux/workqueue.h>
a4d04a4c 8#include <linux/blkdev.h>
1da177e4
LT
9#include <asm/atomic.h>
10
11struct request_queue;
12struct scsi_cmnd;
e10fb91c 13struct scsi_lun;
ea73a9f2 14struct scsi_sense_hdr;
1da177e4 15
1cf72699
JB
16struct scsi_mode_data {
17 __u32 length;
18 __u16 block_descriptor_length;
19 __u8 medium_type;
20 __u8 device_specific;
21 __u8 header_length;
22 __u8 longlba:1;
23};
24
1da177e4
LT
25/*
26 * sdev state: If you alter this, you also need to alter scsi_sysfs.c
27 * (for the ascii descriptions) and the state model enforcer:
28 * scsi_lib:scsi_device_set_state().
29 */
30enum scsi_device_state {
31 SDEV_CREATED = 1, /* device created but not added to sysfs
32 * Only internal commands allowed (for inq) */
33 SDEV_RUNNING, /* device properly configured
34 * All commands allowed */
35 SDEV_CANCEL, /* beginning to delete device
36 * Only error handler commands allowed */
37 SDEV_DEL, /* device deleted
38 * no commands allowed */
39 SDEV_QUIESCE, /* Device quiescent. No block commands
40 * will be accepted, only specials (which
41 * originate in the mid-layer) */
42 SDEV_OFFLINE, /* Device offlined (by error handling or
43 * user request */
44 SDEV_BLOCK, /* Device blocked by scsi lld. No scsi
45 * commands from user or midlayer should be issued
46 * to the scsi lld. */
47};
48
49struct scsi_device {
50 struct Scsi_Host *host;
51 struct request_queue *request_queue;
52
53 /* the next two are protected by the host->host_lock */
54 struct list_head siblings; /* list of all devices on this host */
55 struct list_head same_target_siblings; /* just the devices sharing same target id */
56
c2a9331c 57 /* this is now protected by the request_queue->queue_lock */
06f81ea8
TH
58 unsigned int device_busy; /* commands actually active on
59 * low-level. protected by queue_lock. */
1da177e4
LT
60 spinlock_t list_lock;
61 struct list_head cmd_list; /* queue of in use SCSI Command structures */
62 struct list_head starved_entry;
63 struct scsi_cmnd *current_cmnd; /* currently active command */
64 unsigned short queue_depth; /* How deep of a queue we want */
65 unsigned short last_queue_full_depth; /* These two are used by */
66 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
67 unsigned long last_queue_full_time;/* don't let QUEUE_FULLs on the same
68 jiffie count on our counter, they
69 could all be from the same event. */
70
71 unsigned int id, lun, channel;
72
73 unsigned int manufacturer; /* Manufacturer of device, for using
74 * vendor-specific cmd's */
75 unsigned sector_size; /* size in bytes */
76
77 void *hostdata; /* available to low-level driver */
1da177e4
LT
78 char type;
79 char scsi_level;
80 char inq_periph_qual; /* PQ from INQUIRY data */
81 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
82 unsigned char * inquiry; /* INQUIRY response data */
7f23e146
JB
83 const char * vendor; /* [back_compat] point into 'inquiry' ... */
84 const char * model; /* ... after scan; point to static string */
85 const char * rev; /* ... "nullnullnullnull" before scan */
1da177e4
LT
86 unsigned char current_tag; /* current tag */
87 struct scsi_target *sdev_target; /* used only for single_lun */
88
89 unsigned int sdev_bflags; /* black/white flags as also found in
90 * scsi_devinfo.[hc]. For now used only to
91 * pass settings from slave_alloc to scsi
92 * core. */
93 unsigned writeable:1;
94 unsigned removable:1;
95 unsigned changed:1; /* Data invalid due to media change */
96 unsigned busy:1; /* Used to prevent races */
97 unsigned lockable:1; /* Able to prevent media removal */
98 unsigned locked:1; /* Media removal disabled */
99 unsigned borken:1; /* Tell the Seagate driver to be
100 * painfully slow on this device */
101 unsigned disconnect:1; /* can disconnect */
102 unsigned soft_reset:1; /* Uses soft reset option */
103 unsigned sdtr:1; /* Device supports SDTR messages */
104 unsigned wdtr:1; /* Device supports WDTR messages */
105 unsigned ppr:1; /* Device supports PPR messages */
106 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
107 unsigned simple_tags:1; /* simple queue tag messages are enabled */
108 unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
109 unsigned single_lun:1; /* Indicates we should only allow I/O to
110 * one of the luns for the device at a
111 * time. */
112 unsigned was_reset:1; /* There was a bus reset on the bus for
113 * this device */
114 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
115 * because we did a bus reset. */
116 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
117 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
118 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
119 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
120 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
121 unsigned no_start_on_add:1; /* do not issue start on add */
122 unsigned allow_restart:1; /* issue START_UNIT in error handler */
123 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
124 unsigned select_no_atn:1;
125 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
61bf54b7 126 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
1da177e4
LT
127 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
128
129 unsigned int device_blocked; /* Device returned QUEUE_FULL. */
130
131 unsigned int max_device_blocked; /* what device_blocked counts down from */
132#define SCSI_DEFAULT_DEVICE_BLOCKED 3
133
134 atomic_t iorequest_cnt;
135 atomic_t iodone_cnt;
136 atomic_t ioerr_cnt;
137
138 int timeout;
139
140 struct device sdev_gendev;
141 struct class_device sdev_classdev;
142
ffedb452
JB
143 struct execute_work ew; /* used to get process context on put */
144
1da177e4
LT
145 enum scsi_device_state sdev_state;
146 unsigned long sdev_data[0];
147} __attribute__((aligned(sizeof(unsigned long))));
148#define to_scsi_device(d) \
149 container_of(d, struct scsi_device, sdev_gendev)
150#define class_to_sdev(d) \
151 container_of(d, struct scsi_device, sdev_classdev)
152#define transport_class_to_sdev(class_dev) \
153 to_scsi_device(class_dev->dev)
154
9ccfc756
JB
155#define sdev_printk(prefix, sdev, fmt, a...) \
156 dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
157
a4d04a4c
MP
158#define scmd_printk(prefix, scmd, fmt, a...) \
159 (scmd)->request->rq_disk ? \
160 sdev_printk(prefix, (scmd)->device, "[%s] " fmt, \
161 (scmd)->request->rq_disk->disk_name, ##a) : \
162 sdev_printk(prefix, (scmd)->device, fmt, ##a)
01d7b3b8 163
ffedb452
JB
164enum scsi_target_state {
165 STARGET_RUNNING = 1,
166 STARGET_DEL,
167};
168
1da177e4
LT
169/*
170 * scsi_target: representation of a scsi target, for now, this is only
171 * used for single_lun devices. If no one has active IO to the target,
172 * starget_sdev_user is NULL, else it points to the active sdev.
173 */
174struct scsi_target {
175 struct scsi_device *starget_sdev_user;
176 struct list_head siblings;
177 struct list_head devices;
178 struct device dev;
179 unsigned int reap_ref; /* protected by the host lock */
180 unsigned int channel;
181 unsigned int id; /* target id ... replace
182 * scsi_device.id eventually */
1bfc5d9d
AS
183 unsigned int create:1; /* signal that it needs to be added */
184 unsigned int pdt_1f_for_no_lun; /* PDT = 0x1f */
185 /* means no lun present */
186
6f3a2024 187 char scsi_level;
ffedb452
JB
188 struct execute_work ew;
189 enum scsi_target_state state;
a283bd37
JB
190 void *hostdata; /* available to low-level driver */
191 unsigned long starget_data[0]; /* for the transport */
192 /* starget_data must be the last element!!!! */
1da177e4
LT
193} __attribute__((aligned(sizeof(unsigned long))));
194
195#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
196static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
197{
198 return to_scsi_target(sdev->sdev_gendev.parent);
199}
200#define transport_class_to_starget(class_dev) \
201 to_scsi_target(class_dev->dev)
202
9ccfc756
JB
203#define starget_printk(prefix, starget, fmt, a...) \
204 dev_printk(prefix, &(starget)->dev, fmt, ##a)
205
1da177e4
LT
206extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
207 uint, uint, uint, void *hostdata);
146f7262
JB
208extern int scsi_add_device(struct Scsi_Host *host, uint channel,
209 uint target, uint lun);
1da177e4
LT
210extern void scsi_remove_device(struct scsi_device *);
211extern int scsi_device_cancel(struct scsi_device *, int);
212
213extern int scsi_device_get(struct scsi_device *);
214extern void scsi_device_put(struct scsi_device *);
215extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
216 uint, uint, uint);
217extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
218 uint, uint, uint);
219extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
220 uint);
221extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
222 uint);
223extern void starget_for_each_device(struct scsi_target *, void *,
224 void (*fn)(struct scsi_device *, void *));
225
226/* only exposed to implement shost_for_each_device */
227extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
228 struct scsi_device *);
229
230/**
3e082a91
MW
231 * shost_for_each_device - iterate over all devices of a host
232 * @sdev: the &struct scsi_device to use as a cursor
233 * @shost: the &struct scsi_host to iterate over
1da177e4 234 *
3e082a91
MW
235 * Iterator that returns each device attached to @shost. This loop
236 * takes a reference on each device and releases it at the end. If
237 * you break out of the loop, you must call scsi_device_put(sdev).
1da177e4
LT
238 */
239#define shost_for_each_device(sdev, shost) \
240 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
241 (sdev); \
242 (sdev) = __scsi_iterate_devices((shost), (sdev)))
243
244/**
3e082a91
MW
245 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
246 * @sdev: the &struct scsi_device to use as a cursor
247 * @shost: the &struct scsi_host to iterate over
1da177e4 248 *
3e082a91
MW
249 * Iterator that returns each device attached to @shost. It does _not_
250 * take a reference on the scsi_device, so the whole loop must be
251 * protected by shost->host_lock.
1da177e4 252 *
3e082a91
MW
253 * Note: The only reason to use this is because you need to access the
254 * device list in interrupt context. Otherwise you really want to use
255 * shost_for_each_device instead.
1da177e4
LT
256 */
257#define __shost_for_each_device(sdev, shost) \
258 list_for_each_entry((sdev), &((shost)->__devices), siblings)
259
260extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
261extern int scsi_track_queue_full(struct scsi_device *, int);
262
263extern int scsi_set_medium_removal(struct scsi_device *, char);
264
265extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
266 unsigned char *buffer, int len, int timeout,
1cf72699 267 int retries, struct scsi_mode_data *data,
ea73a9f2 268 struct scsi_sense_hdr *);
5baba830
JB
269extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
270 int modepage, unsigned char *buffer, int len,
271 int timeout, int retries,
272 struct scsi_mode_data *data,
273 struct scsi_sense_hdr *);
1da177e4
LT
274extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
275 int retries);
276extern int scsi_device_set_state(struct scsi_device *sdev,
277 enum scsi_device_state state);
278extern int scsi_device_quiesce(struct scsi_device *sdev);
279extern void scsi_device_resume(struct scsi_device *sdev);
280extern void scsi_target_quiesce(struct scsi_target *);
281extern void scsi_target_resume(struct scsi_target *);
282extern void scsi_scan_target(struct device *parent, unsigned int channel,
283 unsigned int id, unsigned int lun, int rescan);
284extern void scsi_target_reap(struct scsi_target *);
285extern void scsi_target_block(struct device *);
286extern void scsi_target_unblock(struct device *);
287extern void scsi_remove_target(struct device *);
2f4701d8 288extern void int_to_scsilun(unsigned int, struct scsi_lun *);
1da177e4
LT
289extern const char *scsi_device_state_name(enum scsi_device_state);
290extern int scsi_is_sdev_device(const struct device *);
291extern int scsi_is_target_device(const struct device *);
33aa687d
JB
292extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
293 int data_direction, void *buffer, unsigned bufflen,
294 unsigned char *sense, int timeout, int retries,
295 int flag);
ea73a9f2
JB
296extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
297 int data_direction, void *buffer, unsigned bufflen,
298 struct scsi_sense_hdr *, int timeout, int retries);
6e68af66 299extern int scsi_execute_async(struct scsi_device *sdev,
bb1d1073 300 const unsigned char *cmd, int cmd_len, int data_direction,
6e68af66
MC
301 void *buffer, unsigned bufflen, int use_sg,
302 int timeout, int retries, void *privdata,
303 void (*done)(void *, char *, int, int),
304 gfp_t gfp);
33aa687d 305
cb5d9e09 306static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
e28482c5 307{
cb5d9e09 308 return device_reprobe(&sdev->sdev_gendev);
e28482c5
JB
309}
310
01d7b3b8
JG
311static inline unsigned int sdev_channel(struct scsi_device *sdev)
312{
313 return sdev->channel;
314}
315
316static inline unsigned int sdev_id(struct scsi_device *sdev)
317{
318 return sdev->id;
319}
320
321#define scmd_id(scmd) sdev_id((scmd)->device)
322#define scmd_channel(scmd) sdev_channel((scmd)->device)
323
1da177e4
LT
324static inline int scsi_device_online(struct scsi_device *sdev)
325{
326 return sdev->sdev_state != SDEV_OFFLINE;
327}
328
329/* accessor functions for the SCSI parameters */
330static inline int scsi_device_sync(struct scsi_device *sdev)
331{
332 return sdev->sdtr;
333}
334static inline int scsi_device_wide(struct scsi_device *sdev)
335{
336 return sdev->wdtr;
337}
338static inline int scsi_device_dt(struct scsi_device *sdev)
339{
340 return sdev->ppr;
341}
342static inline int scsi_device_dt_only(struct scsi_device *sdev)
343{
344 if (sdev->inquiry_len < 57)
345 return 0;
346 return (sdev->inquiry[56] & 0x0c) == 0x04;
347}
348static inline int scsi_device_ius(struct scsi_device *sdev)
349{
350 if (sdev->inquiry_len < 57)
351 return 0;
352 return sdev->inquiry[56] & 0x01;
353}
354static inline int scsi_device_qas(struct scsi_device *sdev)
355{
356 if (sdev->inquiry_len < 57)
357 return 0;
358 return sdev->inquiry[56] & 0x02;
359}
360#endif /* _SCSI_SCSI_DEVICE_H */