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