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