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