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