projects/linux·blob master · refs

730 lines · 24.9 KiB

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/blk-mq.h>
9#include <scsi/scsi.h>
10#include <scsi/scsi_common.h>
11#include <linux/atomic.h>
12#include <linux/sbitmap.h>
13
14struct bsg_device;
15struct device;
16struct request_queue;
17struct scsi_cmnd;
18struct scsi_lun;
19struct scsi_sense_hdr;
20
21typedef __u64 __bitwise blist_flags_t;
22
23#define SCSI_SENSE_BUFFERSIZE 96
24
25struct scsi_mode_data {
26 __u32 length;
27 __u16 block_descriptor_length;
28 __u8 medium_type;
29 __u8 device_specific;
30 __u8 header_length;
31 __u8 longlba:1;
32};
33
34/*
35 * sdev state: If you alter this, you also need to alter scsi_sysfs.c
36 * (for the ascii descriptions) and the state model enforcer:
37 * scsi_lib:scsi_device_set_state().
38 */
39enum scsi_device_state {
40 SDEV_CREATED = 1, /* device created but not added to sysfs
41 * Only internal commands allowed (for inq) */
42 SDEV_RUNNING, /* device properly configured
43 * All commands allowed */
44 SDEV_CANCEL, /* beginning to delete device
45 * Only error handler commands allowed */
46 SDEV_DEL, /* device deleted
47 * no commands allowed */
48 SDEV_QUIESCE, /* Device quiescent. No block commands
49 * will be accepted, only specials (which
50 * originate in the mid-layer) */
51 SDEV_OFFLINE, /* Device offlined (by error handling or
52 * user request */
53 SDEV_TRANSPORT_OFFLINE, /* Offlined by transport class error handler */
54 SDEV_BLOCK, /* Device blocked by scsi lld. No
55 * scsi commands from user or midlayer
56 * should be issued to the scsi
57 * lld. */
58 SDEV_CREATED_BLOCK, /* same as above but for created devices */
59};
60
61enum scsi_scan_mode {
62 SCSI_SCAN_INITIAL = 0,
63 SCSI_SCAN_RESCAN,
64 SCSI_SCAN_MANUAL,
65};
66
67enum scsi_device_event {
68 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
69 SDEV_EVT_INQUIRY_CHANGE_REPORTED, /* 3F 03 UA reported */
70 SDEV_EVT_CAPACITY_CHANGE_REPORTED, /* 2A 09 UA reported */
71 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED, /* 38 07 UA reported */
72 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED, /* 2A 01 UA reported */
73 SDEV_EVT_LUN_CHANGE_REPORTED, /* 3F 0E UA reported */
74 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, /* 2A 06 UA reported */
75 SDEV_EVT_POWER_ON_RESET_OCCURRED, /* 29 00 UA reported */
76
77 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE,
78 SDEV_EVT_LAST = SDEV_EVT_POWER_ON_RESET_OCCURRED,
79
80 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
81};
82
83struct scsi_event {
84 enum scsi_device_event evt_type;
85 struct list_head node;
86
87 /* put union of data structures, for non-simple event types,
88 * here
89 */
90};
91
92/**
93 * struct scsi_vpd - SCSI Vital Product Data
94 * @rcu: For kfree_rcu().
95 * @len: Length in bytes of @data.
96 * @data: VPD data as defined in various T10 SCSI standard documents.
97 */
98struct scsi_vpd {
99 struct rcu_head rcu;
100 int len;
101 unsigned char data[];
102};
103
104struct scsi_device {
105 struct Scsi_Host *host;
106 struct request_queue *request_queue;
107
108 /* the next two are protected by the host->host_lock */
109 struct list_head siblings; /* list of all devices on this host */
110 struct list_head same_target_siblings; /* just the devices sharing same target id */
111
112 struct sbitmap budget_map;
113 atomic_t device_blocked; /* Device returned QUEUE_FULL. */
114
115 atomic_t restarts;
116 spinlock_t list_lock;
117 struct list_head starved_entry;
118 unsigned short queue_depth; /* How deep of a queue we want */
119 unsigned short max_queue_depth; /* max queue depth */
120 unsigned short last_queue_full_depth; /* These two are used by */
121 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
122 unsigned long last_queue_full_time; /* last queue full time */
123 unsigned long queue_ramp_up_period; /* ramp up period in jiffies */
124#define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
125
126 unsigned long last_queue_ramp_up; /* last queue ramp up time */
127
128 unsigned int id, channel;
129 u64 lun;
130 unsigned int manufacturer; /* Manufacturer of device, for using
131 * vendor-specific cmd's */
132 unsigned sector_size; /* size in bytes */
133
134 void *hostdata; /* available to low-level driver */
135 unsigned char type;
136 char scsi_level;
137 char inq_periph_qual; /* PQ from INQUIRY data */
138 struct mutex inquiry_mutex;
139 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
140 unsigned char * inquiry; /* INQUIRY response data */
141 char vendor[INQUIRY_VENDOR_LEN + 1];
142 char model[INQUIRY_MODEL_LEN + 1];
143 char rev[INQUIRY_REVISION_LEN + 1];
144
145#define SCSI_DEFAULT_VPD_LEN 255 /* default SCSI VPD page size (max) */
146 struct scsi_vpd __rcu *vpd_pg0;
147 struct scsi_vpd __rcu *vpd_pg83;
148 struct scsi_vpd __rcu *vpd_pg80;
149 struct scsi_vpd __rcu *vpd_pg89;
150 struct scsi_vpd __rcu *vpd_pgb0;
151 struct scsi_vpd __rcu *vpd_pgb1;
152 struct scsi_vpd __rcu *vpd_pgb2;
153 struct scsi_vpd __rcu *vpd_pgb7;
154
155 struct scsi_target *sdev_target;
156
157 blist_flags_t sdev_bflags; /* black/white flags as also found in
158 * scsi_devinfo.[hc]. For now used only to
159 * pass settings from sdev_init to scsi
160 * core. */
161 unsigned int eh_timeout; /* Error handling timeout */
162
163 /*
164 * If true, let the high-level device driver (sd) manage the device
165 * power state for system suspend/resume (suspend to RAM and
166 * hibernation) operations.
167 */
168 unsigned manage_system_start_stop:1;
169
170 /*
171 * If true, let the high-level device driver (sd) manage the device
172 * power state for runtime device suspand and resume operations.
173 */
174 unsigned manage_runtime_start_stop:1;
175
176 /*
177 * If true, let the high-level device driver (sd) manage the device
178 * power state for system shutdown (power off) operations.
179 */
180 unsigned manage_shutdown:1;
181
182 /*
183 * If true, let the high-level device driver (sd) manage the device
184 * power state for system restart (reboot) operations.
185 */
186 unsigned manage_restart:1;
187
188 /*
189 * If set and if the device is runtime suspended, ask the high-level
190 * device driver (sd) to force a runtime resume of the device.
191 */
192 unsigned force_runtime_start_on_system_start:1;
193
194 /*
195 * Set if the device is an ATA device.
196 */
197 unsigned is_ata:1;
198
199 unsigned removable:1;
200 unsigned changed:1; /* Data invalid due to media change */
201 unsigned busy:1; /* Used to prevent races */
202 unsigned lockable:1; /* Able to prevent media removal */
203 unsigned locked:1; /* Media removal disabled */
204 unsigned borken:1; /* Tell the Seagate driver to be
205 * painfully slow on this device */
206 unsigned disconnect:1; /* can disconnect */
207 unsigned soft_reset:1; /* Uses soft reset option */
208 unsigned sdtr:1; /* Device supports SDTR messages */
209 unsigned wdtr:1; /* Device supports WDTR messages */
210 unsigned ppr:1; /* Device supports PPR messages */
211 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
212 unsigned simple_tags:1; /* simple queue tag messages are enabled */
213 unsigned was_reset:1; /* There was a bus reset on the bus for
214 * this device */
215 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
216 * because we did a bus reset. */
217 unsigned use_10_for_rw:1; /* first try 10-byte read / write */
218 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
219 unsigned set_dbd_for_ms:1; /* Set "DBD" field in mode sense */
220 unsigned read_before_ms:1; /* perform a READ before MODE SENSE */
221 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
222 unsigned no_write_same:1; /* no WRITE SAME command */
223 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
224 unsigned use_16_for_sync:1; /* Use sync (16) over sync (10) */
225 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
226 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
227 unsigned skip_vpd_pages:1; /* do not read VPD pages */
228 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
229 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
230 unsigned no_start_on_add:1; /* do not issue start on add */
231 unsigned allow_restart:1; /* issue START_UNIT in error handler */
232 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
233 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
234 unsigned select_no_atn:1;
235 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
236 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
237 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
238 unsigned last_sector_bug:1; /* do not use multisector accesses on
239 SD_LAST_BUGGY_SECTORS */
240 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
241 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
242 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
243 unsigned security_supported:1; /* Supports Security Protocols */
244 unsigned is_visible:1; /* is the device visible in sysfs */
245 unsigned wce_default_on:1; /* Cache is ON by default */
246 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
247 unsigned broken_fua:1; /* Don't set FUA bit */
248 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
249 unsigned unmap_limit_for_ws:1; /* Use the UNMAP limit for WRITE SAME */
250 unsigned rpm_autosuspend:1; /* Enable runtime autosuspend at device
251 * creation time */
252 unsigned ignore_media_change:1; /* Ignore MEDIA CHANGE on resume */
253 unsigned silence_suspend:1; /* Do not print runtime PM related messages */
254 unsigned no_vpd_size:1; /* No VPD size reported in header */
255
256 unsigned cdl_supported:1; /* Command duration limits supported */
257 unsigned cdl_enable:1; /* Enable/disable Command duration limits */
258
259 unsigned int queue_stopped; /* request queue is quiesced */
260 bool offline_already; /* Device offline message logged */
261
262 atomic_t ua_new_media_ctr; /* Counter for New Media UNIT ATTENTIONs */
263 atomic_t ua_por_ctr; /* Counter for Power On / Reset UAs */
264
265 atomic_t disk_events_disable_depth; /* disable depth for disk events */
266
267 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
268 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
269 struct list_head event_list; /* asserted events */
270 struct work_struct event_work;
271
272 unsigned int max_device_blocked; /* what device_blocked counts down from */
273#define SCSI_DEFAULT_DEVICE_BLOCKED 3
274
275 atomic_t iorequest_cnt;
276 atomic_t iodone_cnt;
277 atomic_t ioerr_cnt;
278 atomic_t iotmo_cnt;
279
280 struct device sdev_gendev,
281 sdev_dev;
282
283 struct work_struct requeue_work;
284
285 struct scsi_device_handler *handler;
286 void *handler_data;
287
288 size_t dma_drain_len;
289 void *dma_drain_buf;
290
291 unsigned int sg_timeout;
292 unsigned int sg_reserved_size;
293
294 struct bsg_device *bsg_dev;
295 unsigned char access_state;
296 struct mutex state_mutex;
297 enum scsi_device_state sdev_state;
298 struct task_struct *quiesced_by;
299 unsigned long sdev_data[];
300} __attribute__((aligned(sizeof(unsigned long))));
301
302#define to_scsi_device(d) \
303 container_of(d, struct scsi_device, sdev_gendev)
304#define class_to_sdev(d) \
305 container_of(d, struct scsi_device, sdev_dev)
306#define transport_class_to_sdev(class_dev) \
307 to_scsi_device(class_dev->parent)
308
309#define sdev_dbg(sdev, fmt, a...) \
310 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
311
312/*
313 * like scmd_printk, but the device name is passed in
314 * as a string pointer
315 */
316__printf(4, 5) void
317sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
318 const char *, ...);
319
320#define sdev_printk(l, sdev, fmt, a...) \
321 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
322
323__printf(3, 4) void scmd_printk(const char *, struct scsi_cmnd *, const char *,
324 ...);
325
326#define scmd_dbg(scmd, fmt, a...) \
327 do { \
328 struct request *__rq = scsi_cmd_to_rq((scmd)); \
329 \
330 if (__rq->q->disk) \
331 sdev_dbg((scmd)->device, "[%s] " fmt, \
332 __rq->q->disk->disk_name, ##a); \
333 else \
334 sdev_dbg((scmd)->device, fmt, ##a); \
335 } while (0)
336
337enum scsi_target_state {
338 STARGET_CREATED = 1,
339 STARGET_RUNNING,
340 STARGET_REMOVE,
341 STARGET_CREATED_REMOVE,
342 STARGET_DEL,
343};
344
345/*
346 * scsi_target: representation of a scsi target, for now, this is only
347 * used for single_lun devices. If no one has active IO to the target,
348 * starget_sdev_user is NULL, else it points to the active sdev.
349 */
350struct scsi_target {
351 struct scsi_device *starget_sdev_user;
352 struct list_head siblings;
353 struct list_head devices;
354 struct device dev;
355 struct kref reap_ref; /* last put renders target invisible */
356 unsigned int channel;
357 unsigned int id; /* target id ... replace
358 * scsi_device.id eventually */
359 unsigned int create:1; /* signal that it needs to be added */
360 unsigned int single_lun:1; /* Indicates we should only
361 * allow I/O to one of the luns
362 * for the device at a time. */
363 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f
364 * means no lun present. */
365 unsigned int no_report_luns:1; /* Don't use
366 * REPORT LUNS for scanning. */
367 unsigned int expecting_lun_change:1; /* A device has reported
368 * a 3F/0E UA, other devices on
369 * the same target will also. */
370 /* commands actually active on LLD. */
371 atomic_t target_busy;
372 atomic_t target_blocked;
373
374 /*
375 * LLDs should set this in the sdev_init host template callout.
376 * If set to zero then there is not limit.
377 */
378 unsigned int can_queue;
379 unsigned int max_target_blocked;
380#define SCSI_DEFAULT_TARGET_BLOCKED 3
381
382 char scsi_level;
383 enum scsi_target_state state;
384 void *hostdata; /* available to low-level driver */
385 unsigned long starget_data[]; /* for the transport */
386 /* starget_data must be the last element!!!! */
387} __attribute__((aligned(sizeof(unsigned long))));
388
389#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
390static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
391{
392 return to_scsi_target(sdev->sdev_gendev.parent);
393}
394#define transport_class_to_starget(class_dev) \
395 to_scsi_target(class_dev->parent)
396
397#define starget_printk(prefix, starget, fmt, a...) \
398 dev_printk(prefix, &(starget)->dev, fmt, ##a)
399
400extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
401 uint, uint, u64, void *hostdata);
402extern int scsi_add_device(struct Scsi_Host *host, uint channel,
403 uint target, u64 lun);
404extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
405extern void scsi_remove_device(struct scsi_device *);
406extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
407void scsi_attach_vpd(struct scsi_device *sdev);
408void scsi_cdl_check(struct scsi_device *sdev);
409int scsi_cdl_enable(struct scsi_device *sdev, bool enable);
410
411extern int __must_check scsi_device_get(struct scsi_device *);
412extern void scsi_device_put(struct scsi_device *);
413extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
414 uint, uint, u64);
415extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
416 uint, uint, u64);
417extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
418 u64);
419extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
420 u64);
421extern void starget_for_each_device(struct scsi_target *, void *,
422 void (*fn)(struct scsi_device *, void *));
423extern void __starget_for_each_device(struct scsi_target *, void *,
424 void (*fn)(struct scsi_device *,
425 void *));
426
427/* only exposed to implement shost_for_each_device */
428extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
429 struct scsi_device *);
430
431/**
432 * shost_for_each_device - iterate over all devices of a host
433 * @sdev: the &struct scsi_device to use as a cursor
434 * @shost: the &struct scsi_host to iterate over
435 *
436 * Iterator that returns each device attached to @shost. This loop
437 * takes a reference on each device and releases it at the end. If
438 * you break out of the loop, you must call scsi_device_put(sdev).
439 */
440#define shost_for_each_device(sdev, shost) \
441 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
442 (sdev); \
443 (sdev) = __scsi_iterate_devices((shost), (sdev)))
444
445/**
446 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
447 * @sdev: the &struct scsi_device to use as a cursor
448 * @shost: the &struct scsi_host to iterate over
449 *
450 * Iterator that returns each device attached to @shost. It does _not_
451 * take a reference on the scsi_device, so the whole loop must be
452 * protected by shost->host_lock.
453 *
454 * Note: The only reason to use this is because you need to access the
455 * device list in interrupt context. Otherwise you really want to use
456 * shost_for_each_device instead.
457 */
458#define __shost_for_each_device(sdev, shost) \
459 list_for_each_entry((sdev), &((shost)->__devices), siblings)
460
461extern int scsi_change_queue_depth(struct scsi_device *, int);
462extern int scsi_track_queue_full(struct scsi_device *, int);
463
464extern int scsi_set_medium_removal(struct scsi_device *, char);
465
466int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
467 int subpage, unsigned char *buffer, int len, int timeout,
468 int retries, struct scsi_mode_data *data,
469 struct scsi_sense_hdr *);
470extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
471 unsigned char *buffer, int len, int timeout,
472 int retries, struct scsi_mode_data *data,
473 struct scsi_sense_hdr *);
474extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
475 int retries, struct scsi_sense_hdr *sshdr);
476extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
477 int buf_len);
478int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
479 unsigned int len, unsigned char opcode,
480 unsigned short sa);
481extern int scsi_device_set_state(struct scsi_device *sdev,
482 enum scsi_device_state state);
483extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
484 gfp_t gfpflags);
485extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
486extern void sdev_evt_send_simple(struct scsi_device *sdev,
487 enum scsi_device_event evt_type, gfp_t gfpflags);
488extern int scsi_device_quiesce(struct scsi_device *sdev);
489extern void scsi_device_resume(struct scsi_device *sdev);
490extern void scsi_target_quiesce(struct scsi_target *);
491extern void scsi_target_resume(struct scsi_target *);
492extern void scsi_scan_target(struct device *parent, unsigned int channel,
493 unsigned int id, u64 lun,
494 enum scsi_scan_mode rescan);
495extern void scsi_target_reap(struct scsi_target *);
496void scsi_block_targets(struct Scsi_Host *shost, struct device *dev);
497extern void scsi_target_unblock(struct device *, enum scsi_device_state);
498extern void scsi_remove_target(struct device *);
499extern const char *scsi_device_state_name(enum scsi_device_state);
500extern int scsi_is_sdev_device(const struct device *);
501extern int scsi_is_target_device(const struct device *);
502extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
503
504/*
505 * scsi_execute_cmd users can set scsi_failure.result to have
506 * scsi_check_passthrough fail/retry a command. scsi_failure.result can be a
507 * specific host byte or message code, or SCMD_FAILURE_RESULT_ANY can be used
508 * to match any host or message code.
509 */
510#define SCMD_FAILURE_RESULT_ANY 0x7fffffff
511/*
512 * Set scsi_failure.result to SCMD_FAILURE_STAT_ANY to fail/retry any failure
513 * scsi_status_is_good returns false for.
514 */
515#define SCMD_FAILURE_STAT_ANY 0xff
516/*
517 * The following can be set to the scsi_failure sense, asc and ascq fields to
518 * match on any sense, ASC, or ASCQ value.
519 */
520#define SCMD_FAILURE_SENSE_ANY 0xff
521#define SCMD_FAILURE_ASC_ANY 0xff
522#define SCMD_FAILURE_ASCQ_ANY 0xff
523/* Always retry a matching failure. */
524#define SCMD_FAILURE_NO_LIMIT -1
525
526struct scsi_failure {
527 int result;
528 u8 sense;
529 u8 asc;
530 u8 ascq;
531 /*
532 * Number of times scsi_execute_cmd will retry the failure. It does
533 * not count for the total_allowed.
534 */
535 s8 allowed;
536 /* Number of times the failure has been retried. */
537 s8 retries;
538};
539
540struct scsi_failures {
541 /*
542 * If a scsi_failure does not have a retry limit setup this limit will
543 * be used.
544 */
545 int total_allowed;
546 int total_retries;
547 struct scsi_failure *failure_definitions;
548};
549
550/* Optional arguments to scsi_execute_cmd */
551struct scsi_exec_args {
552 unsigned char *sense; /* sense buffer */
553 unsigned int sense_len; /* sense buffer len */
554 struct scsi_sense_hdr *sshdr; /* decoded sense header */
555 blk_mq_req_flags_t req_flags; /* BLK_MQ_REQ flags */
556 int scmd_flags; /* SCMD flags */
557 int *resid; /* residual length */
558 struct scsi_failures *failures; /* failures to retry */
559};
560
561int scsi_execute_cmd(struct scsi_device *sdev, const unsigned char *cmd,
562 blk_opf_t opf, void *buffer, unsigned int bufflen,
563 int timeout, int retries,
564 const struct scsi_exec_args *args);
565void scsi_failures_reset_retries(struct scsi_failures *failures);
566
567struct scsi_cmnd *scsi_get_internal_cmd(struct scsi_device *sdev,
568 enum dma_data_direction data_direction,
569 blk_mq_req_flags_t flags);
570void scsi_put_internal_cmd(struct scsi_cmnd *scmd);
571extern void sdev_disable_disk_events(struct scsi_device *sdev);
572extern void sdev_enable_disk_events(struct scsi_device *sdev);
573extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
574extern int scsi_vpd_lun_serial(struct scsi_device *, char *, size_t);
575extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
576
577#ifdef CONFIG_PM
578extern int scsi_autopm_get_device(struct scsi_device *);
579extern void scsi_autopm_put_device(struct scsi_device *);
580#else
581static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
582static inline void scsi_autopm_put_device(struct scsi_device *d) {}
583#endif /* CONFIG_PM */
584
585static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
586{
587 return device_reprobe(&sdev->sdev_gendev);
588}
589
590static inline unsigned int sdev_channel(struct scsi_device *sdev)
591{
592 return sdev->channel;
593}
594
595static inline unsigned int sdev_id(struct scsi_device *sdev)
596{
597 return sdev->id;
598}
599
600#define scmd_id(scmd) sdev_id((scmd)->device)
601#define scmd_channel(scmd) sdev_channel((scmd)->device)
602
603/**
604 * scsi_device_is_pseudo_dev() - Whether a device is a pseudo SCSI device.
605 * @sdev: SCSI device to examine
606 *
607 * A pseudo SCSI device can be used to allocate SCSI commands but does not show
608 * up in sysfs. Additionally, the logical unit information in *@sdev is made up.
609 *
610 * This function tests the LUN number instead of comparing @sdev with
611 * @sdev->host->pseudo_sdev because this function may be called before
612 * @sdev->host->pseudo_sdev has been initialized.
613 */
614static inline bool scsi_device_is_pseudo_dev(struct scsi_device *sdev)
615{
616 return sdev->lun == U64_MAX;
617}
618
619/*
620 * checks for positions of the SCSI state machine
621 */
622static inline int scsi_device_online(struct scsi_device *sdev)
623{
624 return (sdev->sdev_state != SDEV_OFFLINE &&
625 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
626 sdev->sdev_state != SDEV_DEL);
627}
628static inline int scsi_device_blocked(struct scsi_device *sdev)
629{
630 return sdev->sdev_state == SDEV_BLOCK ||
631 sdev->sdev_state == SDEV_CREATED_BLOCK;
632}
633static inline int scsi_device_created(struct scsi_device *sdev)
634{
635 return sdev->sdev_state == SDEV_CREATED ||
636 sdev->sdev_state == SDEV_CREATED_BLOCK;
637}
638
639int scsi_internal_device_block_nowait(struct scsi_device *sdev);
640int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
641 enum scsi_device_state new_state);
642
643/* accessor functions for the SCSI parameters */
644static inline int scsi_device_sync(struct scsi_device *sdev)
645{
646 return sdev->sdtr;
647}
648static inline int scsi_device_wide(struct scsi_device *sdev)
649{
650 return sdev->wdtr;
651}
652static inline int scsi_device_dt(struct scsi_device *sdev)
653{
654 return sdev->ppr;
655}
656static inline int scsi_device_dt_only(struct scsi_device *sdev)
657{
658 if (sdev->inquiry_len < 57)
659 return 0;
660 return (sdev->inquiry[56] & 0x0c) == 0x04;
661}
662static inline int scsi_device_ius(struct scsi_device *sdev)
663{
664 if (sdev->inquiry_len < 57)
665 return 0;
666 return sdev->inquiry[56] & 0x01;
667}
668static inline int scsi_device_qas(struct scsi_device *sdev)
669{
670 if (sdev->inquiry_len < 57)
671 return 0;
672 return sdev->inquiry[56] & 0x02;
673}
674static inline int scsi_device_enclosure(struct scsi_device *sdev)
675{
676 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
677}
678
679static inline int scsi_device_protection(struct scsi_device *sdev)
680{
681 if (sdev->no_dif)
682 return 0;
683
684 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
685}
686
687static inline int scsi_device_tpgs(struct scsi_device *sdev)
688{
689 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
690}
691
692/**
693 * scsi_device_supports_vpd - test if a device supports VPD pages
694 * @sdev: the &struct scsi_device to test
695 *
696 * If the 'try_vpd_pages' flag is set it takes precedence.
697 * Otherwise we will assume VPD pages are supported if the
698 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
699 */
700static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
701{
702 /* Attempt VPD inquiry if the device blacklist explicitly calls
703 * for it.
704 */
705 if (sdev->try_vpd_pages)
706 return 1;
707 /*
708 * Although VPD inquiries can go to SCSI-2 type devices,
709 * some USB ones crash on receiving them, and the pages
710 * we currently ask for are mandatory for SPC-2 and beyond
711 */
712 if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
713 return 1;
714 return 0;
715}
716
717static inline int scsi_device_busy(struct scsi_device *sdev)
718{
719 return sbitmap_weight(&sdev->budget_map);
720}
721
722/* Macros to access the UNIT ATTENTION counters */
723#define scsi_get_ua_new_media_ctr(sdev) atomic_read(&sdev->ua_new_media_ctr)
724#define scsi_get_ua_por_ctr(sdev) atomic_read(&sdev->ua_por_ctr)
725
726#define MODULE_ALIAS_SCSI_DEVICE(type) \
727 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
728#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
729
730#endif /* _SCSI_SCSI_DEVICE_H */