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