blob: 83a7890f1479f866ae7d16e585a375d23958d195 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef _SCSI_SCSI_DEVICE_H
3#define _SCSI_SCSI_DEVICE_H
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/list.h>
6#include <linux/spinlock.h>
James Bottomleyffedb452006-02-23 14:27:18 -06007#include <linux/workqueue.h>
Christoph Hellwig24b83de2021-09-20 14:33:28 +02008#include <linux/blk-mq.h>
Hugh Dickinsd211f052008-08-06 18:21:18 +01009#include <scsi/scsi.h>
Arun Sharma600634972011-07-26 16:09:06 -070010#include <linux/atomic.h>
Ming Lei020b0f02021-01-22 10:33:17 +080011#include <linux/sbitmap.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
Christoph Hellwigead09dd2021-07-29 08:48:42 +020013struct bsg_device;
Paul Gortmaker313162d2012-01-30 11:46:54 -050014struct device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070015struct request_queue;
16struct scsi_cmnd;
James Bottomleye10fb912005-07-14 11:54:17 -050017struct scsi_lun;
James Bottomleyea73a9f2005-08-28 11:33:52 -050018struct scsi_sense_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
Martin Wilck14098802018-04-18 01:35:08 +020020typedef __u64 __bitwise blist_flags_t;
Hannes Reinecke5ebde462017-11-15 12:07:30 +010021
Kees Cook704f8392018-07-31 12:51:54 -070022#define SCSI_SENSE_BUFFERSIZE 96
23
James Bottomley1cf72692005-08-28 11:27:01 -050024struct 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070033/*
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 */
Mike Christie1b8d2622012-05-17 23:56:56 -050052 SDEV_TRANSPORT_OFFLINE, /* Offlined by transport class error handler */
James Bottomley6f4267e2008-08-22 16:53:31 -050053 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058};
59
Hannes Reinecke1d645082016-03-17 08:39:45 +010060enum scsi_scan_mode {
61 SCSI_SCAN_INITIAL = 0,
62 SCSI_SCAN_RESCAN,
63 SCSI_SCAN_MANUAL,
64};
65
Jeff Garzika341cd02007-10-29 17:15:22 -040066enum scsi_device_event {
67 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
Ewan D. Milne279afdf2013-08-08 15:07:48 -040068 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 */
Hannes Reinecke14c3e672015-07-06 13:41:53 +020073 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, /* 2A 06 UA reported */
Hannes Reineckecf3431b2017-10-17 09:11:24 +020074 SDEV_EVT_POWER_ON_RESET_OCCURRED, /* 29 00 UA reported */
Jeff Garzika341cd02007-10-29 17:15:22 -040075
Ewan D. Milne279afdf2013-08-08 15:07:48 -040076 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE,
Hannes Reineckecf3431b2017-10-17 09:11:24 +020077 SDEV_EVT_LAST = SDEV_EVT_POWER_ON_RESET_OCCURRED,
Ewan D. Milne279afdf2013-08-08 15:07:48 -040078
Jeff Garzika341cd02007-10-29 17:15:22 -040079 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
Bart Van Asscheccf1e002017-08-29 08:50:13 -070091/**
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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103struct 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
Ming Lei020b0f02021-01-22 10:33:17 +0800111 struct sbitmap budget_map;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100112 atomic_t device_blocked; /* Device returned QUEUE_FULL. */
113
Ming Leied5dd6a2020-09-10 15:50:56 +0800114 atomic_t restarts;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 spinlock_t list_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 struct list_head starved_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 unsigned short queue_depth; /* How deep of a queue we want */
Vasu Dev4a840672009-10-22 15:46:33 -0700118 unsigned short max_queue_depth; /* max queue depth */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 unsigned short last_queue_full_depth; /* These two are used by */
120 unsigned short last_queue_full_count; /* scsi_track_queue_full() */
Vasu Dev4a840672009-10-22 15:46:33 -0700121 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200127 unsigned int id, channel;
128 u64 lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 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 */
Bart Van Asschec2e872a2017-08-25 13:46:28 -0700134 unsigned char type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 char scsi_level;
136 char inq_periph_qual; /* PQ from INQUIRY data */
Hannes Reinecke09e2b0b2015-11-09 13:24:28 +0100137 struct mutex inquiry_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 unsigned char inquiry_len; /* valid bytes in 'inquiry' */
139 unsigned char * inquiry; /* INQUIRY response data */
James Bottomley7f23e142005-12-01 12:50:13 -0600140 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 */
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100143
144#define SCSI_VPD_PG_LEN 255
Ryan Attardd188b062019-09-26 11:22:17 -0500145 struct scsi_vpd __rcu *vpd_pg0;
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700146 struct scsi_vpd __rcu *vpd_pg83;
147 struct scsi_vpd __rcu *vpd_pg80;
Ryan Attardd188b062019-09-26 11:22:17 -0500148 struct scsi_vpd __rcu *vpd_pg89;
Bart Van Assche886874a2021-04-15 15:08:08 -0700149 struct scsi_target *sdev_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Hannes Reinecke5ebde462017-11-15 12:07:30 +0100151 blist_flags_t sdev_bflags; /* black/white flags as also found in
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 * scsi_devinfo.[hc]. For now used only to
153 * pass settings from slave_alloc to scsi
154 * core. */
Martin K. Petersen0816c922013-05-10 10:36:04 -0400155 unsigned int eh_timeout; /* Error handling timeout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 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 */
Can Guo0ec96912019-12-05 02:14:25 +0000176 unsigned set_dbd_for_ms:1; /* Set "DBD" field in mode sense */
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400177 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */
Martin K. Petersen5db44862012-09-18 12:19:32 -0400178 unsigned no_write_same:1; /* no WRITE SAME command */
Jason J. Herne53ad5702012-11-14 17:03:22 -0500179 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 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 */
Alan Stern09b6b512012-01-10 13:43:30 -0500182 unsigned skip_vpd_pages:1; /* do not read VPD pages */
Martin K. Petersenc1d40a52014-07-15 12:49:17 -0400183 unsigned try_vpd_pages:1; /* attempt to read VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 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 */
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900187 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
Stefan Richterd2886ea2008-05-11 00:34:07 +0200188 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 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 */
Oliver Neukum61bf54b2007-02-08 09:04:48 +0100192 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
Linus Torvalds18351072008-08-05 21:42:21 -0700194 unsigned last_sector_bug:1; /* do not use multisector accesses on
195 SD_LAST_BUGGY_SECTORS */
Hans de Goede8e04d802010-10-01 14:20:08 -0700196 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */
Hans de Goede5ce524b2010-10-01 14:20:10 -0700197 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
Alan Stern6a0bdff2012-06-20 16:04:19 -0400198 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */
Christoph Hellwigd80210f2017-06-19 14:26:46 +0200199 unsigned security_supported:1; /* Supports Security Protocols */
James Bottomley860dc732009-11-19 17:48:29 -0500200 unsigned is_visible:1; /* is the device visible in sysfs */
Namjae Jeonb81478d2012-07-07 23:05:08 -0400201 unsigned wce_default_on:1; /* Cache is ON by default */
Martin K. Petersend974e422012-08-28 14:29:35 -0400202 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */
Alan Sternb14bf2d2014-06-30 11:04:21 -0400203 unsigned broken_fua:1; /* Don't set FUA bit */
Alan Stern50c4e962014-09-02 11:35:50 -0400204 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */
Martin K. Petersen28a0bc42017-09-27 21:35:12 -0400205 unsigned unmap_limit_for_ws:1; /* Use the UNMAP limit for WRITE SAME */
Stanley Chuc74f8052019-09-16 23:56:49 +0800206 unsigned rpm_autosuspend:1; /* Enable runtime autosuspend at device
207 * creation time */
Martin Kepplingerf591a2e2021-07-04 09:54:01 +0200208 unsigned ignore_media_change:1; /* Ignore MEDIA CHANGE on resume */
Ewan D. Milneb0962c52020-03-11 10:39:30 -0400209
Ming Lei93542fb2021-11-09 15:11:43 +0800210 unsigned int queue_stopped; /* request queue is quiesced */
Ewan D. Milneb0962c52020-03-11 10:39:30 -0400211 bool offline_already; /* Device offline message logged */
212
Aaron Lu6f4c8272013-01-23 15:09:32 +0800213 atomic_t disk_events_disable_depth; /* disable depth for disk events */
214
Jeff Garzika341cd02007-10-29 17:15:22 -0400215 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400216 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
Jeff Garzika341cd02007-10-29 17:15:22 -0400217 struct list_head event_list; /* asserted events */
218 struct work_struct event_work;
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 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
Tony Jonesee959b02008-02-22 00:13:36 +0100227 struct device sdev_gendev,
228 sdev_dev;
Bart Van Assche92c4b582021-10-12 16:35:13 -0700229 /*
230 * The array size 6 provides space for one attribute group for the
231 * SCSI core, four attribute groups defined by SCSI LLDs and one
232 * terminating NULL pointer.
233 */
234 const struct attribute_group *gendev_attr_groups[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
James Bottomleyffedb452006-02-23 14:27:18 -0600236 struct execute_work ew; /* used to get process context on put */
Jens Axboe9937a5e2011-05-17 11:04:44 +0200237 struct work_struct requeue_work;
James Bottomleyffedb452006-02-23 14:27:18 -0600238
Christoph Hellwigee14c672015-08-27 14:16:59 +0200239 struct scsi_device_handler *handler;
240 void *handler_data;
241
Christoph Hellwigcc979232020-04-14 09:42:24 +0200242 size_t dma_drain_len;
243 void *dma_drain_buf;
244
Christoph Hellwig1e61c1a2021-07-29 08:48:44 +0200245 unsigned int sg_timeout;
246 unsigned int sg_reserved_size;
247
Christoph Hellwigead09dd2021-07-29 08:48:42 +0200248 struct bsg_device *bsg_dev;
Hannes Reinecke77c9df92016-03-03 07:54:07 +0100249 unsigned char access_state;
Bart Van Assche0db6ca82017-06-02 14:21:55 -0700250 struct mutex state_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 enum scsi_device_state sdev_state;
Bart Van Assche3a0a5292017-11-09 10:49:58 -0800252 struct task_struct *quiesced_by;
Gustavo A. R. Silva5febf6d2020-02-24 10:14:06 -0600253 unsigned long sdev_data[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254} __attribute__((aligned(sizeof(unsigned long))));
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256#define to_scsi_device(d) \
257 container_of(d, struct scsi_device, sdev_gendev)
258#define class_to_sdev(d) \
Tony Jonesee959b02008-02-22 00:13:36 +0100259 container_of(d, struct scsi_device, sdev_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260#define transport_class_to_sdev(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100261 to_scsi_device(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Dan Williams3af74a32014-02-06 12:23:07 -0800263#define sdev_dbg(sdev, fmt, a...) \
264 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
265
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200266/*
267 * like scmd_printk, but the device name is passed in
268 * as a string pointer
269 */
Hannes Reinecke9c4a6b12015-02-04 08:11:34 +0100270__printf(4, 5) void
Christoph Hellwig6a806cb2015-01-18 16:11:29 +0100271sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
272 const char *, ...);
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200273
Hannes Reineckeded85c12015-01-08 07:43:42 +0100274#define sdev_printk(l, sdev, fmt, a...) \
275 sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
276
Hannes Reinecke9c4a6b12015-02-04 08:11:34 +0100277__printf(3, 4) void
Christoph Hellwig6a806cb2015-01-18 16:11:29 +0100278scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...);
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400279
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700280#define scmd_dbg(scmd, fmt, a...) \
281 do { \
282 struct request *__rq = scsi_cmd_to_rq((scmd)); \
283 \
284 if (__rq->rq_disk) \
285 sdev_dbg((scmd)->device, "[%s] " fmt, \
286 __rq->rq_disk->disk_name, ##a); \
287 else \
288 sdev_dbg((scmd)->device, fmt, ##a); \
Dan Williams3af74a32014-02-06 12:23:07 -0800289 } while (0)
290
James Bottomleyffedb452006-02-23 14:27:18 -0600291enum scsi_target_state {
James Bottomley643eb2d2008-03-22 22:42:27 -0500292 STARGET_CREATED = 1,
293 STARGET_RUNNING,
Johannes Thumshirnf05795d2016-04-05 11:50:44 +0200294 STARGET_REMOVE,
Ewan D. Milnef9279c92017-06-27 14:55:58 -0400295 STARGET_CREATED_REMOVE,
James Bottomleyffedb452006-02-23 14:27:18 -0600296 STARGET_DEL,
297};
298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299/*
300 * scsi_target: representation of a scsi target, for now, this is only
301 * used for single_lun devices. If no one has active IO to the target,
302 * starget_sdev_user is NULL, else it points to the active sdev.
303 */
304struct scsi_target {
305 struct scsi_device *starget_sdev_user;
306 struct list_head siblings;
307 struct list_head devices;
308 struct device dev;
James Bottomleye63ed0d2014-01-21 07:00:50 -0800309 struct kref reap_ref; /* last put renders target invisible */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 unsigned int channel;
311 unsigned int id; /* target id ... replace
312 * scsi_device.id eventually */
Alan Stern1bfc5d92006-02-09 15:26:18 -0500313 unsigned int create:1; /* signal that it needs to be added */
Tony Battersby25d7c362007-11-12 10:00:44 -0500314 unsigned int single_lun:1; /* Indicates we should only
315 * allow I/O to one of the luns
316 * for the device at a time. */
Alan Sternde8c46b2012-01-10 13:43:04 -0500317 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f
318 * means no lun present. */
Alan Stern09b6b512012-01-10 13:43:30 -0500319 unsigned int no_report_luns:1; /* Don't use
320 * REPORT LUNS for scanning. */
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400321 unsigned int expecting_lun_change:1; /* A device has reported
322 * a 3F/0E UA, other devices on
323 * the same target will also. */
Christoph Hellwig7ae65c02014-01-22 14:49:41 +0100324 /* commands actually active on LLD. */
325 atomic_t target_busy;
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100326 atomic_t target_blocked;
327
Mike Christief0c0a372008-08-17 15:24:38 -0500328 /*
329 * LLDs should set this in the slave_alloc host template callout.
330 * If set to zero then there is not limit.
331 */
332 unsigned int can_queue;
Mike Christief0c0a372008-08-17 15:24:38 -0500333 unsigned int max_target_blocked;
334#define SCSI_DEFAULT_TARGET_BLOCKED 3
Alan Stern1bfc5d92006-02-09 15:26:18 -0500335
James Bottomley6f3a2022005-09-22 20:33:28 -0500336 char scsi_level;
James Bottomleyffedb452006-02-23 14:27:18 -0600337 enum scsi_target_state state;
James Bottomleya283bd32005-05-24 12:06:38 -0500338 void *hostdata; /* available to low-level driver */
Gustavo A. R. Silva5febf6d2020-02-24 10:14:06 -0600339 unsigned long starget_data[]; /* for the transport */
James Bottomleya283bd32005-05-24 12:06:38 -0500340 /* starget_data must be the last element!!!! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341} __attribute__((aligned(sizeof(unsigned long))));
342
343#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
344static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
345{
346 return to_scsi_target(sdev->sdev_gendev.parent);
347}
348#define transport_class_to_starget(class_dev) \
Tony Jonesee959b02008-02-22 00:13:36 +0100349 to_scsi_target(class_dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
James Bottomley9ccfc752005-10-02 11:45:08 -0500351#define starget_printk(prefix, starget, fmt, a...) \
352 dev_printk(prefix, &(starget)->dev, fmt, ##a)
353
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200355 uint, uint, u64, void *hostdata);
James Bottomley146f7262005-09-10 12:44:09 -0500356extern int scsi_add_device(struct Scsi_Host *host, uint channel,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200357 uint target, u64 lun);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700358extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359extern void scsi_remove_device(struct scsi_device *);
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700360extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100361void scsi_attach_vpd(struct scsi_device *sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Hannes Reinecke857de6e2017-02-17 09:02:45 +0100363extern struct scsi_device *scsi_device_from_queue(struct request_queue *q);
Bart Van Asscheed12e032017-04-05 09:52:50 -0700364extern int __must_check scsi_device_get(struct scsi_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365extern void scsi_device_put(struct scsi_device *);
366extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200367 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200369 uint, uint, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200371 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200373 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374extern void starget_for_each_device(struct scsi_target *, void *,
375 void (*fn)(struct scsi_device *, void *));
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800376extern void __starget_for_each_device(struct scsi_target *, void *,
377 void (*fn)(struct scsi_device *,
378 void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380/* only exposed to implement shost_for_each_device */
381extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
382 struct scsi_device *);
383
384/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600385 * shost_for_each_device - iterate over all devices of a host
386 * @sdev: the &struct scsi_device to use as a cursor
387 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600389 * Iterator that returns each device attached to @shost. This loop
390 * takes a reference on each device and releases it at the end. If
391 * you break out of the loop, you must call scsi_device_put(sdev).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 */
393#define shost_for_each_device(sdev, shost) \
394 for ((sdev) = __scsi_iterate_devices((shost), NULL); \
395 (sdev); \
396 (sdev) = __scsi_iterate_devices((shost), (sdev)))
397
398/**
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600399 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
400 * @sdev: the &struct scsi_device to use as a cursor
401 * @shost: the &struct scsi_host to iterate over
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600403 * Iterator that returns each device attached to @shost. It does _not_
404 * take a reference on the scsi_device, so the whole loop must be
405 * protected by shost->host_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 *
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600407 * Note: The only reason to use this is because you need to access the
408 * device list in interrupt context. Otherwise you really want to use
409 * shost_for_each_device instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 */
411#define __shost_for_each_device(sdev, shost) \
412 list_for_each_entry((sdev), &((shost)->__devices), siblings)
413
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100414extern int scsi_change_queue_depth(struct scsi_device *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415extern int scsi_track_queue_full(struct scsi_device *, int);
416
417extern int scsi_set_medium_removal(struct scsi_device *, char);
418
419extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
420 unsigned char *buffer, int len, int timeout,
James Bottomley1cf72692005-08-28 11:27:01 -0500421 int retries, struct scsi_mode_data *data,
James Bottomleyea73a9f2005-08-28 11:33:52 -0500422 struct scsi_sense_hdr *);
James Bottomley5baba832006-03-18 14:10:35 -0600423extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
424 int modepage, unsigned char *buffer, int len,
425 int timeout, int retries,
426 struct scsi_mode_data *data,
427 struct scsi_sense_hdr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
James Bottomley001aac22007-12-02 19:10:40 +0200429 int retries, struct scsi_sense_hdr *sshdr);
James Bottomleye3deec02009-11-03 12:33:07 -0600430extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
431 int buf_len);
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400432extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
433 unsigned int len, unsigned char opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434extern int scsi_device_set_state(struct scsi_device *sdev,
435 enum scsi_device_state state);
Jeff Garzika341cd02007-10-29 17:15:22 -0400436extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
437 gfp_t gfpflags);
438extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
439extern void sdev_evt_send_simple(struct scsi_device *sdev,
440 enum scsi_device_event evt_type, gfp_t gfpflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441extern int scsi_device_quiesce(struct scsi_device *sdev);
442extern void scsi_device_resume(struct scsi_device *sdev);
443extern void scsi_target_quiesce(struct scsi_target *);
444extern void scsi_target_resume(struct scsi_target *);
445extern void scsi_scan_target(struct device *parent, unsigned int channel,
Hannes Reinecke1d645082016-03-17 08:39:45 +0100446 unsigned int id, u64 lun,
447 enum scsi_scan_mode rescan);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448extern void scsi_target_reap(struct scsi_target *);
449extern void scsi_target_block(struct device *);
Mike Christie5d9fb5c2012-05-17 23:56:57 -0500450extern void scsi_target_unblock(struct device *, enum scsi_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451extern void scsi_remove_target(struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452extern const char *scsi_device_state_name(enum scsi_device_state);
453extern int scsi_is_sdev_device(const struct device *);
454extern int scsi_is_target_device(const struct device *);
Don Brace38464702016-01-27 20:16:26 -0600455extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
Kees Cook704f8392018-07-31 12:51:54 -0700456extern int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
James Bottomley33aa6872005-08-28 11:31:14 -0500457 int data_direction, void *buffer, unsigned bufflen,
Christoph Hellwig76aaf872017-02-23 16:02:36 +0100458 unsigned char *sense, struct scsi_sense_hdr *sshdr,
459 int timeout, int retries, u64 flags,
460 req_flags_t rq_flags, int *resid);
Kees Cook704f8392018-07-31 12:51:54 -0700461/* Make sure any sense buffer is the correct size. */
462#define scsi_execute(sdev, cmd, data_direction, buffer, bufflen, sense, \
463 sshdr, timeout, retries, flags, rq_flags, resid) \
464({ \
465 BUILD_BUG_ON((sense) != NULL && \
466 sizeof(sense) != SCSI_SENSE_BUFFERSIZE); \
467 __scsi_execute(sdev, cmd, data_direction, buffer, bufflen, \
468 sense, sshdr, timeout, retries, flags, rq_flags, \
469 resid); \
470})
Lin Ming9b214932013-03-23 11:42:25 +0800471static inline int scsi_execute_req(struct scsi_device *sdev,
472 const unsigned char *cmd, int data_direction, void *buffer,
473 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
474 int retries, int *resid)
475{
Christoph Hellwigfcbfffe2017-02-23 16:02:37 +0100476 return scsi_execute(sdev, cmd, data_direction, buffer,
477 bufflen, NULL, sshdr, timeout, retries, 0, 0, resid);
Lin Ming9b214932013-03-23 11:42:25 +0800478}
Aaron Lu6f4c8272013-01-23 15:09:32 +0800479extern void sdev_disable_disk_events(struct scsi_device *sdev);
480extern void sdev_enable_disk_events(struct scsi_device *sdev);
Hannes Reinecke9983bed2015-12-01 10:16:55 +0100481extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
Hannes Reineckea8aa3972015-12-01 10:16:57 +0100482extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
James Bottomley33aa6872005-08-28 11:31:14 -0500483
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100484#ifdef CONFIG_PM
Alan Sternbc4f2402010-06-17 10:41:42 -0400485extern int scsi_autopm_get_device(struct scsi_device *);
486extern void scsi_autopm_put_device(struct scsi_device *);
487#else
488static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
489static inline void scsi_autopm_put_device(struct scsi_device *d) {}
Rafael J. Wysocki4f7ad522014-12-14 23:13:55 +0100490#endif /* CONFIG_PM */
Alan Sternbc4f2402010-06-17 10:41:42 -0400491
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400492static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
James Bottomleye28482c2006-03-14 14:24:55 -0600493{
Andrew Mortoncb5d9e02006-09-30 21:23:44 -0400494 return device_reprobe(&sdev->sdev_gendev);
James Bottomleye28482c2006-03-14 14:24:55 -0600495}
496
Jeff Garzik01d7b3b2005-10-24 18:03:34 -0400497static inline unsigned int sdev_channel(struct scsi_device *sdev)
498{
499 return sdev->channel;
500}
501
502static inline unsigned int sdev_id(struct scsi_device *sdev)
503{
504 return sdev->id;
505}
506
507#define scmd_id(scmd) sdev_id((scmd)->device)
508#define scmd_channel(scmd) sdev_channel((scmd)->device)
509
James Bottomley0f1d87a2008-08-22 16:43:59 -0500510/*
511 * checks for positions of the SCSI state machine
512 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513static inline int scsi_device_online(struct scsi_device *sdev)
514{
Hannes Reinecke0762a482009-01-12 09:28:55 +0100515 return (sdev->sdev_state != SDEV_OFFLINE &&
Mike Christie1b8d2622012-05-17 23:56:56 -0500516 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
Hannes Reinecke0762a482009-01-12 09:28:55 +0100517 sdev->sdev_state != SDEV_DEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518}
James Bottomley0f1d87a2008-08-22 16:43:59 -0500519static inline int scsi_device_blocked(struct scsi_device *sdev)
520{
James Bottomley6f4267e2008-08-22 16:53:31 -0500521 return sdev->sdev_state == SDEV_BLOCK ||
522 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a2008-08-22 16:43:59 -0500523}
524static inline int scsi_device_created(struct scsi_device *sdev)
525{
James Bottomley6f4267e2008-08-22 16:53:31 -0500526 return sdev->sdev_state == SDEV_CREATED ||
527 sdev->sdev_state == SDEV_CREATED_BLOCK;
James Bottomley0f1d87a2008-08-22 16:43:59 -0500528}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Bart Van Assche551eb592017-06-02 14:21:53 -0700530int scsi_internal_device_block_nowait(struct scsi_device *sdev);
Bart Van Assche43f75712017-06-02 14:21:54 -0700531int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
532 enum scsi_device_state new_state);
Bart Van Assche8893cf62017-03-01 09:00:36 -0800533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534/* accessor functions for the SCSI parameters */
535static inline int scsi_device_sync(struct scsi_device *sdev)
536{
537 return sdev->sdtr;
538}
539static inline int scsi_device_wide(struct scsi_device *sdev)
540{
541 return sdev->wdtr;
542}
543static inline int scsi_device_dt(struct scsi_device *sdev)
544{
545 return sdev->ppr;
546}
547static inline int scsi_device_dt_only(struct scsi_device *sdev)
548{
549 if (sdev->inquiry_len < 57)
550 return 0;
551 return (sdev->inquiry[56] & 0x0c) == 0x04;
552}
553static inline int scsi_device_ius(struct scsi_device *sdev)
554{
555 if (sdev->inquiry_len < 57)
556 return 0;
557 return sdev->inquiry[56] & 0x01;
558}
559static inline int scsi_device_qas(struct scsi_device *sdev)
560{
561 if (sdev->inquiry_len < 57)
562 return 0;
563 return sdev->inquiry[56] & 0x02;
564}
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600565static inline int scsi_device_enclosure(struct scsi_device *sdev)
566{
Krishnasamy, Somasundaramd1e12de2011-02-28 18:13:22 -0500567 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
James Bottomleyb30c2fc2008-01-20 09:09:40 -0600568}
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400569
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400570static inline int scsi_device_protection(struct scsi_device *sdev)
571{
Martin K. Petersend974e422012-08-28 14:29:35 -0400572 if (sdev->no_dif)
573 return 0;
574
Hugh Dickinsd211f052008-08-06 18:21:18 +0100575 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400576}
577
Hannes Reinecked7c48fe2011-08-24 10:51:13 +0200578static inline int scsi_device_tpgs(struct scsi_device *sdev)
579{
580 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
581}
582
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200583/**
584 * scsi_device_supports_vpd - test if a device supports VPD pages
585 * @sdev: the &struct scsi_device to test
586 *
587 * If the 'try_vpd_pages' flag is set it takes precedence.
588 * Otherwise we will assume VPD pages are supported if the
589 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
590 */
591static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
592{
593 /* Attempt VPD inquiry if the device blacklist explicitly calls
594 * for it.
595 */
596 if (sdev->try_vpd_pages)
597 return 1;
598 /*
599 * Although VPD inquiries can go to SCSI-2 type devices,
600 * some USB ones crash on receiving them, and the pages
Hannes Reineckee4c36ad2016-04-01 08:57:37 +0200601 * we currently ask for are mandatory for SPC-2 and beyond
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200602 */
Hannes Reineckee4c36ad2016-04-01 08:57:37 +0200603 if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200604 return 1;
605 return 0;
606}
607
Ming Lei82788072021-01-22 10:33:15 +0800608static inline int scsi_device_busy(struct scsi_device *sdev)
609{
Ming Lei020b0f02021-01-22 10:33:17 +0800610 return sbitmap_weight(&sdev->budget_map);
Ming Lei82788072021-01-22 10:33:15 +0800611}
612
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +0400613#define MODULE_ALIAS_SCSI_DEVICE(type) \
614 MODULE_ALIAS("scsi:t-" __stringify(type) "*")
615#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
616
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617#endif /* _SCSI_SCSI_DEVICE_H */