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