File Index
Files and directories
Sign in
FILE

scsi_device.h

File preview with syntax highlighting.

linux-6.19.14/include/scsi/scsi_device.h C
  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
 13struct bsg_device;
 14struct device;
 15struct request_queue;
 16struct scsi_cmnd;
 17struct scsi_lun;
 18struct scsi_sense_hdr;
 19
 20typedef __u64 __bitwise blist_flags_t;
 21
 22#define SCSI_SENSE_BUFFERSIZE	96
 23
 24struct 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 */
 38enum 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
 60enum scsi_scan_mode {
 61	SCSI_SCAN_INITIAL = 0,
 62	SCSI_SCAN_RESCAN,
 63	SCSI_SCAN_MANUAL,
 64};
 65
 66enum 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
 82struct 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 */
 97struct scsi_vpd {
 98	struct rcu_head	rcu;
 99	int		len;
100	unsigned char	data[];
101};
102
103struct 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 true, let the high-level device driver (sd) manage the device
183	 * power state for system restart (reboot) operations.
184	 */
185	unsigned manage_restart:1;
186
187	/*
188	 * If set and if the device is runtime suspended, ask the high-level
189	 * device driver (sd) to force a runtime resume of the device.
190	 */
191	unsigned force_runtime_start_on_system_start:1;
192
193	/*
194	 * Set if the device is an ATA device.
195	 */
196	unsigned is_ata:1;
197
198	unsigned removable:1;
199	unsigned changed:1;	/* Data invalid due to media change */
200	unsigned busy:1;	/* Used to prevent races */
201	unsigned lockable:1;	/* Able to prevent media removal */
202	unsigned locked:1;      /* Media removal disabled */
203	unsigned borken:1;	/* Tell the Seagate driver to be 
204				 * painfully slow on this device */
205	unsigned disconnect:1;	/* can disconnect */
206	unsigned soft_reset:1;	/* Uses soft reset option */
207	unsigned sdtr:1;	/* Device supports SDTR messages */
208	unsigned wdtr:1;	/* Device supports WDTR messages */
209	unsigned ppr:1;		/* Device supports PPR messages */
210	unsigned tagged_supported:1;	/* Supports SCSI-II tagged queuing */
211	unsigned simple_tags:1;	/* simple queue tag messages are enabled */
212	unsigned was_reset:1;	/* There was a bus reset on the bus for 
213				 * this device */
214	unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
215				     * because we did a bus reset. */
216	unsigned use_10_for_rw:1; /* first try 10-byte read / write */
217	unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
218	unsigned set_dbd_for_ms:1; /* Set "DBD" field in mode sense */
219	unsigned read_before_ms:1;	/* perform a READ before MODE SENSE */
220	unsigned no_report_opcodes:1;	/* no REPORT SUPPORTED OPERATION CODES */
221	unsigned no_write_same:1;	/* no WRITE SAME command */
222	unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
223	unsigned use_16_for_sync:1;	/* Use sync (16) over sync (10) */
224	unsigned skip_ms_page_8:1;	/* do not use MODE SENSE page 0x08 */
225	unsigned skip_ms_page_3f:1;	/* do not use MODE SENSE page 0x3f */
226	unsigned skip_vpd_pages:1;	/* do not read VPD pages */
227	unsigned try_vpd_pages:1;	/* attempt to read VPD pages */
228	unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
229	unsigned no_start_on_add:1;	/* do not issue start on add */
230	unsigned allow_restart:1; /* issue START_UNIT in error handler */
231	unsigned start_stop_pwr_cond:1;	/* Set power cond. in START_STOP_UNIT */
232	unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
233	unsigned select_no_atn:1;
234	unsigned fix_capacity:1;	/* READ_CAPACITY is too high by 1 */
235	unsigned guess_capacity:1;	/* READ_CAPACITY might be too high by 1 */
236	unsigned retry_hwerror:1;	/* Retry HARDWARE_ERROR */
237	unsigned last_sector_bug:1;	/* do not use multisector accesses on
238					   SD_LAST_BUGGY_SECTORS */
239	unsigned no_read_disc_info:1;	/* Avoid READ_DISC_INFO cmds */
240	unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
241	unsigned try_rc_10_first:1;	/* Try READ_CAPACACITY_10 first */
242	unsigned security_supported:1;	/* Supports Security Protocols */
243	unsigned is_visible:1;	/* is the device visible in sysfs */
244	unsigned wce_default_on:1;	/* Cache is ON by default */
245	unsigned no_dif:1;	/* T10 PI (DIF) should be disabled */
246	unsigned broken_fua:1;		/* Don't set FUA bit */
247	unsigned lun_in_cdb:1;		/* Store LUN bits in CDB[1] */
248	unsigned unmap_limit_for_ws:1;	/* Use the UNMAP limit for WRITE SAME */
249	unsigned rpm_autosuspend:1;	/* Enable runtime autosuspend at device
250					 * creation time */
251	unsigned ignore_media_change:1; /* Ignore MEDIA CHANGE on resume */
252	unsigned silence_suspend:1;	/* Do not print runtime PM related messages */
253	unsigned no_vpd_size:1;		/* No VPD size reported in header */
254
255	unsigned cdl_supported:1;	/* Command duration limits supported */
256	unsigned cdl_enable:1;		/* Enable/disable Command duration limits */
257
258	unsigned int queue_stopped;	/* request queue is quiesced */
259	bool offline_already;		/* Device offline message logged */
260
261	atomic_t ua_new_media_ctr;	/* Counter for New Media UNIT ATTENTIONs */
262	atomic_t ua_por_ctr;		/* Counter for Power On / Reset UAs */
263
264	atomic_t disk_events_disable_depth; /* disable depth for disk events */
265
266	DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
267	DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
268	struct list_head event_list;	/* asserted events */
269	struct work_struct event_work;
270
271	unsigned int max_device_blocked; /* what device_blocked counts down from  */
272#define SCSI_DEFAULT_DEVICE_BLOCKED	3
273
274	atomic_t iorequest_cnt;
275	atomic_t iodone_cnt;
276	atomic_t ioerr_cnt;
277	atomic_t iotmo_cnt;
278
279	struct device		sdev_gendev,
280				sdev_dev;
281
282	struct work_struct	requeue_work;
283
284	struct scsi_device_handler *handler;
285	void			*handler_data;
286
287	size_t			dma_drain_len;
288	void			*dma_drain_buf;
289
290	unsigned int		sg_timeout;
291	unsigned int		sg_reserved_size;
292
293	struct bsg_device	*bsg_dev;
294	unsigned char		access_state;
295	struct mutex		state_mutex;
296	enum scsi_device_state sdev_state;
297	struct task_struct	*quiesced_by;
298	unsigned long		sdev_data[];
299} __attribute__((aligned(sizeof(unsigned long))));
300
301#define	to_scsi_device(d)	\
302	container_of(d, struct scsi_device, sdev_gendev)
303#define	class_to_sdev(d)	\
304	container_of(d, struct scsi_device, sdev_dev)
305#define transport_class_to_sdev(class_dev) \
306	to_scsi_device(class_dev->parent)
307
308#define sdev_dbg(sdev, fmt, a...) \
309	dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
310
311/*
312 * like scmd_printk, but the device name is passed in
313 * as a string pointer
314 */
315__printf(4, 5) void
316sdev_prefix_printk(const char *, const struct scsi_device *, const char *,
317		const char *, ...);
318
319#define sdev_printk(l, sdev, fmt, a...)				\
320	sdev_prefix_printk(l, sdev, NULL, fmt, ##a)
321
322__printf(3, 4) void scmd_printk(const char *, struct scsi_cmnd *, const char *,
323				...);
324
325#define scmd_dbg(scmd, fmt, a...)					\
326	do {								\
327		struct request *__rq = scsi_cmd_to_rq((scmd));		\
328									\
329		if (__rq->q->disk)					\
330			sdev_dbg((scmd)->device, "[%s] " fmt,		\
331				 __rq->q->disk->disk_name, ##a);	\
332		else							\
333			sdev_dbg((scmd)->device, fmt, ##a);		\
334	} while (0)
335
336enum scsi_target_state {
337	STARGET_CREATED = 1,
338	STARGET_RUNNING,
339	STARGET_REMOVE,
340	STARGET_CREATED_REMOVE,
341	STARGET_DEL,
342};
343
344/*
345 * scsi_target: representation of a scsi target, for now, this is only
346 * used for single_lun devices. If no one has active IO to the target,
347 * starget_sdev_user is NULL, else it points to the active sdev.
348 */
349struct scsi_target {
350	struct scsi_device	*starget_sdev_user;
351	struct list_head	siblings;
352	struct list_head	devices;
353	struct device		dev;
354	struct kref		reap_ref; /* last put renders target invisible */
355	unsigned int		channel;
356	unsigned int		id; /* target id ... replace
357				     * scsi_device.id eventually */
358	unsigned int		create:1; /* signal that it needs to be added */
359	unsigned int		single_lun:1;	/* Indicates we should only
360						 * allow I/O to one of the luns
361						 * for the device at a time. */
362	unsigned int		pdt_1f_for_no_lun:1;	/* PDT = 0x1f
363						 * means no lun present. */
364	unsigned int		no_report_luns:1;	/* Don't use
365						 * REPORT LUNS for scanning. */
366	unsigned int		expecting_lun_change:1;	/* A device has reported
367						 * a 3F/0E UA, other devices on
368						 * the same target will also. */
369	/* commands actually active on LLD. */
370	atomic_t		target_busy;
371	atomic_t		target_blocked;
372
373	/*
374	 * LLDs should set this in the sdev_init host template callout.
375	 * If set to zero then there is not limit.
376	 */
377	unsigned int		can_queue;
378	unsigned int		max_target_blocked;
379#define SCSI_DEFAULT_TARGET_BLOCKED	3
380
381	char			scsi_level;
382	enum scsi_target_state	state;
383	void 			*hostdata; /* available to low-level driver */
384	unsigned long		starget_data[]; /* for the transport */
385	/* starget_data must be the last element!!!! */
386} __attribute__((aligned(sizeof(unsigned long))));
387
388#define to_scsi_target(d)	container_of(d, struct scsi_target, dev)
389static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
390{
391	return to_scsi_target(sdev->sdev_gendev.parent);
392}
393#define transport_class_to_starget(class_dev) \
394	to_scsi_target(class_dev->parent)
395
396#define starget_printk(prefix, starget, fmt, a...)	\
397	dev_printk(prefix, &(starget)->dev, fmt, ##a)
398
399extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
400		uint, uint, u64, void *hostdata);
401extern int scsi_add_device(struct Scsi_Host *host, uint channel,
402			   uint target, u64 lun);
403extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
404extern void scsi_remove_device(struct scsi_device *);
405extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
406void scsi_attach_vpd(struct scsi_device *sdev);
407void scsi_cdl_check(struct scsi_device *sdev);
408int scsi_cdl_enable(struct scsi_device *sdev, bool enable);
409
410extern struct scsi_device *scsi_device_from_queue(struct request_queue *q);
411extern int __must_check scsi_device_get(struct scsi_device *);
412extern void scsi_device_put(struct scsi_device *);
413extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
414					      uint, uint, u64);
415extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
416						uint, uint, u64);
417extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
418							u64);
419extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
420							  u64);
421extern void starget_for_each_device(struct scsi_target *, void *,
422		     void (*fn)(struct scsi_device *, void *));
423extern void __starget_for_each_device(struct scsi_target *, void *,
424				      void (*fn)(struct scsi_device *,
425						 void *));
426
427/* only exposed to implement shost_for_each_device */
428extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
429						  struct scsi_device *);
430
431/**
432 * shost_for_each_device - iterate over all devices of a host
433 * @sdev: the &struct scsi_device to use as a cursor
434 * @shost: the &struct scsi_host to iterate over
435 *
436 * Iterator that returns each device attached to @shost.  This loop
437 * takes a reference on each device and releases it at the end.  If
438 * you break out of the loop, you must call scsi_device_put(sdev).
439 */
440#define shost_for_each_device(sdev, shost) \
441	for ((sdev) = __scsi_iterate_devices((shost), NULL); \
442	     (sdev); \
443	     (sdev) = __scsi_iterate_devices((shost), (sdev)))
444
445/**
446 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
447 * @sdev: the &struct scsi_device to use as a cursor
448 * @shost: the &struct scsi_host to iterate over
449 *
450 * Iterator that returns each device attached to @shost.  It does _not_
451 * take a reference on the scsi_device, so the whole loop must be
452 * protected by shost->host_lock.
453 *
454 * Note: The only reason to use this is because you need to access the
455 * device list in interrupt context.  Otherwise you really want to use
456 * shost_for_each_device instead.
457 */
458#define __shost_for_each_device(sdev, shost) \
459	list_for_each_entry((sdev), &((shost)->__devices), siblings)
460
461extern int scsi_change_queue_depth(struct scsi_device *, int);
462extern int scsi_track_queue_full(struct scsi_device *, int);
463
464extern int scsi_set_medium_removal(struct scsi_device *, char);
465
466int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
467		    int subpage, unsigned char *buffer, int len, int timeout,
468		    int retries, struct scsi_mode_data *data,
469		    struct scsi_sense_hdr *);
470extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
471			    unsigned char *buffer, int len, int timeout,
472			    int retries, struct scsi_mode_data *data,
473			    struct scsi_sense_hdr *);
474extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
475				int retries, struct scsi_sense_hdr *sshdr);
476extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
477			     int buf_len);
478int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
479		       unsigned int len, unsigned char opcode,
480		       unsigned short sa);
481extern int scsi_device_set_state(struct scsi_device *sdev,
482				 enum scsi_device_state state);
483extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
484					  gfp_t gfpflags);
485extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
486extern void sdev_evt_send_simple(struct scsi_device *sdev,
487			  enum scsi_device_event evt_type, gfp_t gfpflags);
488extern int scsi_device_quiesce(struct scsi_device *sdev);
489extern void scsi_device_resume(struct scsi_device *sdev);
490extern void scsi_target_quiesce(struct scsi_target *);
491extern void scsi_target_resume(struct scsi_target *);
492extern void scsi_scan_target(struct device *parent, unsigned int channel,
493			     unsigned int id, u64 lun,
494			     enum scsi_scan_mode rescan);
495extern void scsi_target_reap(struct scsi_target *);
496void scsi_block_targets(struct Scsi_Host *shost, struct device *dev);
497extern void scsi_target_unblock(struct device *, enum scsi_device_state);
498extern void scsi_remove_target(struct device *);
499extern const char *scsi_device_state_name(enum scsi_device_state);
500extern int scsi_is_sdev_device(const struct device *);
501extern int scsi_is_target_device(const struct device *);
502extern void scsi_sanitize_inquiry_string(unsigned char *s, int len);
503
504/*
505 * scsi_execute_cmd users can set scsi_failure.result to have
506 * scsi_check_passthrough fail/retry a command. scsi_failure.result can be a
507 * specific host byte or message code, or SCMD_FAILURE_RESULT_ANY can be used
508 * to match any host or message code.
509 */
510#define SCMD_FAILURE_RESULT_ANY	0x7fffffff
511/*
512 * Set scsi_failure.result to SCMD_FAILURE_STAT_ANY to fail/retry any failure
513 * scsi_status_is_good returns false for.
514 */
515#define SCMD_FAILURE_STAT_ANY	0xff
516/*
517 * The following can be set to the scsi_failure sense, asc and ascq fields to
518 * match on any sense, ASC, or ASCQ value.
519 */
520#define SCMD_FAILURE_SENSE_ANY	0xff
521#define SCMD_FAILURE_ASC_ANY	0xff
522#define SCMD_FAILURE_ASCQ_ANY	0xff
523/* Always retry a matching failure. */
524#define SCMD_FAILURE_NO_LIMIT	-1
525
526struct scsi_failure {
527	int result;
528	u8 sense;
529	u8 asc;
530	u8 ascq;
531	/*
532	 * Number of times scsi_execute_cmd will retry the failure. It does
533	 * not count for the total_allowed.
534	 */
535	s8 allowed;
536	/* Number of times the failure has been retried. */
537	s8 retries;
538};
539
540struct scsi_failures {
541	/*
542	 * If a scsi_failure does not have a retry limit setup this limit will
543	 * be used.
544	 */
545	int total_allowed;
546	int total_retries;
547	struct scsi_failure *failure_definitions;
548};
549
550/* Optional arguments to scsi_execute_cmd */
551struct scsi_exec_args {
552	unsigned char *sense;		/* sense buffer */
553	unsigned int sense_len;		/* sense buffer len */
554	struct scsi_sense_hdr *sshdr;	/* decoded sense header */
555	blk_mq_req_flags_t req_flags;	/* BLK_MQ_REQ flags */
556	int scmd_flags;			/* SCMD flags */
557	int *resid;			/* residual length */
558	struct scsi_failures *failures;	/* failures to retry */
559};
560
561int scsi_execute_cmd(struct scsi_device *sdev, const unsigned char *cmd,
562		     blk_opf_t opf, void *buffer, unsigned int bufflen,
563		     int timeout, int retries,
564		     const struct scsi_exec_args *args);
565void scsi_failures_reset_retries(struct scsi_failures *failures);
566
567struct scsi_cmnd *scsi_get_internal_cmd(struct scsi_device *sdev,
568					enum dma_data_direction data_direction,
569					blk_mq_req_flags_t flags);
570void scsi_put_internal_cmd(struct scsi_cmnd *scmd);
571extern void sdev_disable_disk_events(struct scsi_device *sdev);
572extern void sdev_enable_disk_events(struct scsi_device *sdev);
573extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t);
574extern int scsi_vpd_tpg_id(struct scsi_device *, int *);
575
576#ifdef CONFIG_PM
577extern int scsi_autopm_get_device(struct scsi_device *);
578extern void scsi_autopm_put_device(struct scsi_device *);
579#else
580static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
581static inline void scsi_autopm_put_device(struct scsi_device *d) {}
582#endif /* CONFIG_PM */
583
584static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
585{
586	return device_reprobe(&sdev->sdev_gendev);
587}
588
589static inline unsigned int sdev_channel(struct scsi_device *sdev)
590{
591	return sdev->channel;
592}
593
594static inline unsigned int sdev_id(struct scsi_device *sdev)
595{
596	return sdev->id;
597}
598
599#define scmd_id(scmd) sdev_id((scmd)->device)
600#define scmd_channel(scmd) sdev_channel((scmd)->device)
601
602/**
603 * scsi_device_is_pseudo_dev() - Whether a device is a pseudo SCSI device.
604 * @sdev: SCSI device to examine
605 *
606 * A pseudo SCSI device can be used to allocate SCSI commands but does not show
607 * up in sysfs. Additionally, the logical unit information in *@sdev is made up.
608 *
609 * This function tests the LUN number instead of comparing @sdev with
610 * @sdev->host->pseudo_sdev because this function may be called before
611 * @sdev->host->pseudo_sdev has been initialized.
612 */
613static inline bool scsi_device_is_pseudo_dev(struct scsi_device *sdev)
614{
615	return sdev->lun == U64_MAX;
616}
617
618/*
619 * checks for positions of the SCSI state machine
620 */
621static inline int scsi_device_online(struct scsi_device *sdev)
622{
623	return (sdev->sdev_state != SDEV_OFFLINE &&
624		sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
625		sdev->sdev_state != SDEV_DEL);
626}
627static inline int scsi_device_blocked(struct scsi_device *sdev)
628{
629	return sdev->sdev_state == SDEV_BLOCK ||
630		sdev->sdev_state == SDEV_CREATED_BLOCK;
631}
632static inline int scsi_device_created(struct scsi_device *sdev)
633{
634	return sdev->sdev_state == SDEV_CREATED ||
635		sdev->sdev_state == SDEV_CREATED_BLOCK;
636}
637
638int scsi_internal_device_block_nowait(struct scsi_device *sdev);
639int scsi_internal_device_unblock_nowait(struct scsi_device *sdev,
640					enum scsi_device_state new_state);
641
642/* accessor functions for the SCSI parameters */
643static inline int scsi_device_sync(struct scsi_device *sdev)
644{
645	return sdev->sdtr;
646}
647static inline int scsi_device_wide(struct scsi_device *sdev)
648{
649	return sdev->wdtr;
650}
651static inline int scsi_device_dt(struct scsi_device *sdev)
652{
653	return sdev->ppr;
654}
655static inline int scsi_device_dt_only(struct scsi_device *sdev)
656{
657	if (sdev->inquiry_len < 57)
658		return 0;
659	return (sdev->inquiry[56] & 0x0c) == 0x04;
660}
661static inline int scsi_device_ius(struct scsi_device *sdev)
662{
663	if (sdev->inquiry_len < 57)
664		return 0;
665	return sdev->inquiry[56] & 0x01;
666}
667static inline int scsi_device_qas(struct scsi_device *sdev)
668{
669	if (sdev->inquiry_len < 57)
670		return 0;
671	return sdev->inquiry[56] & 0x02;
672}
673static inline int scsi_device_enclosure(struct scsi_device *sdev)
674{
675	return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
676}
677
678static inline int scsi_device_protection(struct scsi_device *sdev)
679{
680	if (sdev->no_dif)
681		return 0;
682
683	return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
684}
685
686static inline int scsi_device_tpgs(struct scsi_device *sdev)
687{
688	return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
689}
690
691/**
692 * scsi_device_supports_vpd - test if a device supports VPD pages
693 * @sdev: the &struct scsi_device to test
694 *
695 * If the 'try_vpd_pages' flag is set it takes precedence.
696 * Otherwise we will assume VPD pages are supported if the
697 * SCSI level is at least SPC-3 and 'skip_vpd_pages' is not set.
698 */
699static inline int scsi_device_supports_vpd(struct scsi_device *sdev)
700{
701	/* Attempt VPD inquiry if the device blacklist explicitly calls
702	 * for it.
703	 */
704	if (sdev->try_vpd_pages)
705		return 1;
706	/*
707	 * Although VPD inquiries can go to SCSI-2 type devices,
708	 * some USB ones crash on receiving them, and the pages
709	 * we currently ask for are mandatory for SPC-2 and beyond
710	 */
711	if (sdev->scsi_level >= SCSI_SPC_2 && !sdev->skip_vpd_pages)
712		return 1;
713	return 0;
714}
715
716static inline int scsi_device_busy(struct scsi_device *sdev)
717{
718	return sbitmap_weight(&sdev->budget_map);
719}
720
721/* Macros to access the UNIT ATTENTION counters */
722#define scsi_get_ua_new_media_ctr(sdev)	atomic_read(&sdev->ua_new_media_ctr)
723#define scsi_get_ua_por_ctr(sdev)	atomic_read(&sdev->ua_por_ctr)
724
725#define MODULE_ALIAS_SCSI_DEVICE(type) \
726	MODULE_ALIAS("scsi:t-" __stringify(type) "*")
727#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
728
729#endif /* _SCSI_SCSI_DEVICE_H */
~/ Read-only file preview.