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