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