xref: /linux/include/scsi/scsi_device.h (revision 2e3fcbcc3b0eb9b96d2912cdac920f0ae8d1c8f2)
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 struct scsi_device {
104 	struct Scsi_Host *host;
105 	struct request_queue *request_queue;
106 
107 	/* the next two are protected by the host->host_lock */
108 	struct list_head    siblings;   /* list of all devices on this host */
109 	struct list_head    same_target_siblings; /* just the devices sharing same target id */
110 
111 	struct sbitmap budget_map;
112 	atomic_t device_blocked;	/* Device returned QUEUE_FULL. */
113 
114 	atomic_t restarts;
115 	spinlock_t list_lock;
116 	struct list_head starved_entry;
117 	unsigned short queue_depth;	/* How deep of a queue we want */
118 	unsigned short max_queue_depth;	/* max queue depth */
119 	unsigned short last_queue_full_depth; /* These two are used by */
120 	unsigned short last_queue_full_count; /* scsi_track_queue_full() */
121 	unsigned long last_queue_full_time;	/* last queue full time */
122 	unsigned long queue_ramp_up_period;	/* ramp up period in jiffies */
123 #define SCSI_DEFAULT_RAMP_UP_PERIOD	(120 * HZ)
124 
125 	unsigned long last_queue_ramp_up;	/* last queue ramp up time */
126 
127 	unsigned int id, channel;
128 	u64 lun;
129 	unsigned int manufacturer;	/* Manufacturer of device, for using
130 					 * vendor-specific cmd's */
131 	unsigned sector_size;	/* size in bytes */
132 
133 	void *hostdata;		/* available to low-level driver */
134 	unsigned char type;
135 	char scsi_level;
136 	char inq_periph_qual;	/* PQ from INQUIRY data */
137 	struct mutex inquiry_mutex;
138 	unsigned char inquiry_len;	/* valid bytes in 'inquiry' */
139 	unsigned char * inquiry;	/* INQUIRY response data */
140 	const char * vendor;		/* [back_compat] point into 'inquiry' ... */
141 	const char * model;		/* ... after scan; point to static string */
142 	const char * rev;		/* ... "nullnullnullnull" before scan */
143 
144 #define SCSI_DEFAULT_VPD_LEN	255	/* default SCSI VPD page size (max) */
145 	struct scsi_vpd __rcu *vpd_pg0;
146 	struct scsi_vpd __rcu *vpd_pg83;
147 	struct scsi_vpd __rcu *vpd_pg80;
148 	struct scsi_vpd __rcu *vpd_pg89;
149 	struct scsi_vpd __rcu *vpd_pgb0;
150 	struct scsi_vpd __rcu *vpd_pgb1;
151 	struct scsi_vpd __rcu *vpd_pgb2;
152 	struct scsi_vpd __rcu *vpd_pgb7;
153 
154 	struct scsi_target      *sdev_target;
155 
156 	blist_flags_t		sdev_bflags; /* black/white flags as also found in
157 				 * scsi_devinfo.[hc]. For now used only to
158 				 * pass settings from sdev_init to scsi
159 				 * core. */
160 	unsigned int eh_timeout; /* Error handling timeout */
161 
162 	/*
163 	 * If true, let the high-level device driver (sd) manage the device
164 	 * power state for system suspend/resume (suspend to RAM and
165 	 * hibernation) operations.
166 	 */
167 	unsigned manage_system_start_stop:1;
168 
169 	/*
170 	 * If true, let the high-level device driver (sd) manage the device
171 	 * power state for runtime device suspand and resume operations.
172 	 */
173 	unsigned manage_runtime_start_stop:1;
174 
175 	/*
176 	 * If true, let the high-level device driver (sd) manage the device
177 	 * power state for system shutdown (power off) operations.
178 	 */
179 	unsigned manage_shutdown:1;
180 
181 	/*
182 	 * If set and if the device is runtime suspended, ask the high-level
183 	 * device driver (sd) to force a runtime resume of the device.
184 	 */
185 	unsigned force_runtime_start_on_system_start:1;
186 
187 	unsigned removable:1;
188 	unsigned changed:1;	/* Data invalid due to media change */
189 	unsigned busy:1;	/* Used to prevent races */
190 	unsigned lockable:1;	/* Able to prevent media removal */
191 	unsigned locked:1;      /* Media removal disabled */
192 	unsigned borken:1;	/* Tell the Seagate driver to be
193 				 * painfully slow on this device */
194 	unsigned disconnect:1;	/* can disconnect */
195 	unsigned soft_reset:1;	/* Uses soft reset option */
196 	unsigned sdtr:1;	/* Device supports SDTR messages */
197 	unsigned wdtr:1;	/* Device supports WDTR messages */
198 	unsigned ppr:1;		/* Device supports PPR messages */
199 	unsigned tagged_supported:1;	/* Supports SCSI-II tagged queuing */
200 	unsigned simple_tags:1;	/* simple queue tag messages are enabled */
201 	unsigned was_reset:1;	/* There was a bus reset on the bus for
202 				 * this device */
203 	unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
204 				     * because we did a bus reset. */
205 	unsigned use_10_for_rw:1; /* first try 10-byte read / write */
206 	unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
207 	unsigned set_dbd_for_ms:1; /* Set "DBD" field in mode sense */
208 	unsigned read_before_ms:1;	/* perform a READ before MODE SENSE */
209 	unsigned no_report_opcodes:1;	/* no REPORT SUPPORTED OPERATION CODES */
210 	unsigned no_write_same:1;	/* no WRITE SAME command */
211 	unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
212 	unsigned use_16_for_sync:1;	/* Use sync (16) over sync (10) */
213 	unsigned skip_ms_page_8:1;	/* do not use MODE SENSE page 0x08 */
214 	unsigned skip_ms_page_3f:1;	/* do not use MODE SENSE page 0x3f */
215 	unsigned skip_vpd_pages:1;	/* do not read VPD pages */
216 	unsigned try_vpd_pages:1;	/* attempt to read VPD pages */
217 	unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
218 	unsigned no_start_on_add:1;	/* do not issue start on add */
219 	unsigned allow_restart:1; /* issue START_UNIT in error handler */
220 	unsigned start_stop_pwr_cond:1;	/* Set power cond. in START_STOP_UNIT */
221 	unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
222 	unsigned select_no_atn:1;
223 	unsigned fix_capacity:1;	/* READ_CAPACITY is too high by 1 */
224 	unsigned guess_capacity:1;	/* READ_CAPACITY might be too high by 1 */
225 	unsigned retry_hwerror:1;	/* Retry HARDWARE_ERROR */
226 	unsigned last_sector_bug:1;	/* do not use multisector accesses on
227 					   SD_LAST_BUGGY_SECTORS */
228 	unsigned no_read_disc_info:1;	/* Avoid READ_DISC_INFO cmds */
229 	unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
230 	unsigned try_rc_10_first:1;	/* Try READ_CAPACACITY_10 first */
231 	unsigned security_supported:1;	/* Supports Security Protocols */
232 	unsigned is_visible:1;	/* is the device visible in sysfs */
233 	unsigned wce_default_on:1;	/* Cache is ON by default */
234 	unsigned no_dif:1;	/* T10 PI (DIF) should be disabled */
235 	unsigned broken_fua:1;		/* Don't set FUA bit */
236 	unsigned lun_in_cdb:1;		/* Store LUN bits in CDB[1] */
237 	unsigned unmap_limit_for_ws:1;	/* Use the UNMAP limit for WRITE SAME */
238 	unsigned rpm_autosuspend:1;	/* Enable runtime autosuspend at device
239 					 * creation time */
240 	unsigned ignore_media_change:1; /* Ignore MEDIA CHANGE on resume */
241 	unsigned silence_suspend:1;	/* Do not print runtime PM related messages */
242 	unsigned no_vpd_size:1;		/* No VPD size reported in header */
243 
244 	unsigned cdl_supported:1;	/* Command duration limits supported */
245 	unsigned cdl_enable:1;		/* Enable/disable Command duration limits */
246 
247 	unsigned int queue_stopped;	/* request queue is quiesced */
248 	bool offline_already;		/* Device offline message logged */
249 
250 	unsigned int ua_new_media_ctr;	/* Counter for New Media UNIT ATTENTIONs */
251 	unsigned int ua_por_ctr;	/* Counter for Power On / Reset UAs */
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 sdev_init 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)
scsi_target(struct scsi_device * sdev)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 /*
494  * scsi_execute_cmd users can set scsi_failure.result to have
495  * scsi_check_passthrough fail/retry a command. scsi_failure.result can be a
496  * specific host byte or message code, or SCMD_FAILURE_RESULT_ANY can be used
497  * to match any host or message code.
498  */
499 #define SCMD_FAILURE_RESULT_ANY	0x7fffffff
500 /*
501  * Set scsi_failure.result to SCMD_FAILURE_STAT_ANY to fail/retry any failure
502  * scsi_status_is_good returns false for.
503  */
504 #define SCMD_FAILURE_STAT_ANY	0xff
505 /*
506  * The following can be set to the scsi_failure sense, asc and ascq fields to
507  * match on any sense, ASC, or ASCQ value.
508  */
509 #define SCMD_FAILURE_SENSE_ANY	0xff
510 #define SCMD_FAILURE_ASC_ANY	0xff
511 #define SCMD_FAILURE_ASCQ_ANY	0xff
512 /* Always retry a matching failure. */
513 #define SCMD_FAILURE_NO_LIMIT	-1
514 
515 struct scsi_failure {
516 	int result;
517 	u8 sense;
518 	u8 asc;
519 	u8 ascq;
520 	/*
521 	 * Number of times scsi_execute_cmd will retry the failure. It does
522 	 * not count for the total_allowed.
523 	 */
524 	s8 allowed;
525 	/* Number of times the failure has been retried. */
526 	s8 retries;
527 };
528 
529 struct scsi_failures {
530 	/*
531 	 * If a scsi_failure does not have a retry limit setup this limit will
532 	 * be used.
533 	 */
534 	int total_allowed;
535 	int total_retries;
536 	struct scsi_failure *failure_definitions;
537 };
538 
539 /* Optional arguments to scsi_execute_cmd */
540 struct scsi_exec_args {
541 	unsigned char *sense;		/* sense buffer */
542 	unsigned int sense_len;		/* sense buffer len */
543 	struct scsi_sense_hdr *sshdr;	/* decoded sense header */
544 	blk_mq_req_flags_t req_flags;	/* BLK_MQ_REQ flags */
545 	int scmd_flags;			/* SCMD flags */
546 	int *resid;			/* residual length */
547 	struct scsi_failures *failures;	/* failures to retry */
548 };
549 
550 int scsi_execute_cmd(struct scsi_device *sdev, const unsigned char *cmd,
551 		     blk_opf_t opf, void *buffer, unsigned int bufflen,
552 		     int timeout, int retries,
553 		     const struct scsi_exec_args *args);
554 void scsi_failures_reset_retries(struct scsi_failures *failures);
555 
556 extern void sdev_disable_disk_events(struct scsi_device *sdev);
557 extern void sdev_enable_disk_events(struct scsi_device *sdev);
558 extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
559 extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
560 
561 #ifdef CONFIG_PM
562 extern int scsi_autopm_get_device(struct scsi_device *);
563 extern void scsi_autopm_put_device(struct scsi_device *);
564 #else
scsi_autopm_get_device(struct scsi_device * d)565 static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
scsi_autopm_put_device(struct scsi_device * d)566 static inline void scsi_autopm_put_device(struct scsi_device *d) {}
567 #endif /* CONFIG_PM */
568 
scsi_device_reprobe(struct scsi_device * sdev)569 static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
570 {
571 	return device_reprobe(&sdev->sdev_gendev);
572 }
573 
sdev_channel(struct scsi_device * sdev)574 static inline unsigned int sdev_channel(struct scsi_device *sdev)
575 {
576 	return sdev->channel;
577 }
578 
sdev_id(struct scsi_device * sdev)579 static inline unsigned int sdev_id(struct scsi_device *sdev)
580 {
581 	return sdev->id;
582 }
583 
584 #define scmd_id(scmd) sdev_id((scmd)->device)
585 #define scmd_channel(scmd) sdev_channel((scmd)->device)
586 
587 /*
588  * checks for positions of the SCSI state machine
589  */
scsi_device_online(struct scsi_device * sdev)590 static inline int scsi_device_online(struct scsi_device *sdev)
591 {
592 	return (sdev->sdev_state != SDEV_OFFLINE &&
593 		sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
594 		sdev->sdev_state != SDEV_DEL);
595 }
scsi_device_blocked(struct scsi_device * sdev)596 static inline int scsi_device_blocked(struct scsi_device *sdev)
597 {
598 	return sdev->sdev_state == SDEV_BLOCK ||
599 		sdev->sdev_state == SDEV_CREATED_BLOCK;
600 }
scsi_device_created(struct scsi_device * sdev)601 static inline int scsi_device_created(struct scsi_device *sdev)
602 {
603 	return sdev->sdev_state == SDEV_CREATED ||
604 		sdev->sdev_state == SDEV_CREATED_BLOCK;
605 }
606 
607 int scsi_internal_device_block_nowait(struct scsi_device *sdev);
608 int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
609 					enum scsi_device_state new_state);
610 
611 /* accessor functions for the SCSI parameters */
scsi_device_sync(struct scsi_device * sdev)612 static inline int scsi_device_sync(struct scsi_device *sdev)
613 {
614 	return sdev->sdtr;
615 }
scsi_device_wide(struct scsi_device * sdev)616 static inline int scsi_device_wide(struct scsi_device *sdev)
617 {
618 	return sdev->wdtr;
619 }
scsi_device_dt(struct scsi_device * sdev)620 static inline int scsi_device_dt(struct scsi_device *sdev)
621 {
622 	return sdev->ppr;
623 }
scsi_device_dt_only(struct scsi_device * sdev)624 static inline int scsi_device_dt_only(struct scsi_device *sdev)
625 {
626 	if (sdev->inquiry_len < 57)
627 		return 0;
628 	return (sdev->inquiry[56] & 0x0c) == 0x04;
629 }
scsi_device_ius(struct scsi_device * sdev)630 static inline int scsi_device_ius(struct scsi_device *sdev)
631 {
632 	if (sdev->inquiry_len < 57)
633 		return 0;
634 	return sdev->inquiry[56] & 0x01;
635 }
scsi_device_qas(struct scsi_device * sdev)636 static inline int scsi_device_qas(struct scsi_device *sdev)
637 {
638 	if (sdev->inquiry_len < 57)
639 		return 0;
640 	return sdev->inquiry[56] & 0x02;
641 }
scsi_device_enclosure(struct scsi_device * sdev)642 static inline int scsi_device_enclosure(struct scsi_device *sdev)
643 {
644 	return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
645 }
646 
scsi_device_protection(struct scsi_device * sdev)647 static inline int scsi_device_protection(struct scsi_device *sdev)
648 {
649 	if (sdev->no_dif)
650 		return 0;
651 
652 	return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
653 }
654 
scsi_device_tpgs(struct scsi_device * sdev)655 static inline int scsi_device_tpgs(struct scsi_device *sdev)
656 {
657 	return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
658 }
659 
660 /**
661  * scsi_device_supports_vpd - test if a device supports VPD pages
662  * @sdev: the &struct scsi_device to test
663  *
664  * If the 'try_vpd_pages' flag is set it takes precedence.
665  * Otherwise we will assume VPD pages are supported if the
666  * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
667  */
scsi_device_supports_vpd(struct scsi_device * sdev)668 static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
669 {
670 	/* Attempt VPD inquiry if the device blacklist explicitly calls
671 	 * for it.
672 	 */
673 	if (sdev->try_vpd_pages)
674 		return 1;
675 	/*
676 	 * Although VPD inquiries can go to SCSI-2 type devices,
677 	 * some USB ones crash on receiving them, and the pages
678 	 * we currently ask for are mandatory for SPC-2 and beyond
679 	 */
680 	if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
681 		return 1;
682 	return 0;
683 }
684 
scsi_device_busy(struct scsi_device * sdev)685 static inline int scsi_device_busy(struct scsi_device *sdev)
686 {
687 	return sbitmap_weight(&sdev->budget_map);
688 }
689 
690 /* Macros to access the UNIT ATTENTION counters */
691 #define scsi_get_ua_new_media_ctr(sdev) \
692 	((const unsigned int)(sdev->ua_new_media_ctr))
693 #define scsi_get_ua_por_ctr(sdev) \
694 	((const unsigned int)(sdev->ua_por_ctr))
695 
696 #define MODULE_ALIAS_SCSI_DEVICE(type) \
697 	MODULE_ALIAS("scsi:t-" __stringify(type) "*")
698 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
699 
700 #endif /* _SCSI_SCSI_DEVICE_H */
701