[linux-block.git] / drivers / scsi / scsi_priv.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _SCSI_PRIV_H
#define _SCSI_PRIV_H

#include <linux/device.h>
#include <scsi/scsi_device.h>
#include <linux/sbitmap.h>

struct bsg_device;
struct request_queue;
struct request;
struct scsi_cmnd;
struct scsi_device;
struct scsi_target;
struct scsi_host_template;
struct Scsi_Host;
struct scsi_nl_hdr;

#define SCSI_CMD_RETRIES_NO_LIMIT -1

/*
 * Error codes used by scsi-ml internally. These must not be used by drivers.
 */
enum scsi_ml_status {
	SCSIML_STAT_OK			= 0x00,
	SCSIML_STAT_RESV_CONFLICT	= 0x01,	/* Reservation conflict */
	SCSIML_STAT_NOSPC		= 0x02,	/* Space allocation on the dev failed */
	SCSIML_STAT_MED_ERROR		= 0x03,	/* Medium error */
	SCSIML_STAT_TGT_FAILURE		= 0x04,	/* Permanent target failure */
	SCSIML_STAT_DL_TIMEOUT		= 0x05, /* Command Duration Limit timeout */
};

static inline u8 scsi_ml_byte(int result)
{
	return (result >> 8) & 0xff;
}

/*
 * Scsi Error Handler Flags
 */
#define SCSI_EH_ABORT_SCHEDULED	0x0002	/* Abort has been scheduled */

#define SCSI_SENSE_VALID(scmd) \
	(((scmd)->sense_buffer[0] & 0x70) == 0x70)

/* hosts.c */
extern int scsi_init_hosts(void);
extern void scsi_exit_hosts(void);

/* scsi.c */
int scsi_init_sense_cache(struct Scsi_Host *shost);
void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd);
#ifdef CONFIG_SCSI_LOGGING
void scsi_log_send(struct scsi_cmnd *cmd);
void scsi_log_completion(struct scsi_cmnd *cmd, int disposition);
#else
static inline void scsi_log_send(struct scsi_cmnd *cmd) 
	{ };
static inline void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
	{ };
#endif

/* scsi_devinfo.c */

/* list of keys for the lists */
enum scsi_devinfo_key {
	SCSI_DEVINFO_GLOBAL = 0,
	SCSI_DEVINFO_SPI,
};

extern blist_flags_t scsi_get_device_flags(struct scsi_device *sdev,
					   const unsigned char *vendor,
					   const unsigned char *model);
extern blist_flags_t scsi_get_device_flags_keyed(struct scsi_device *sdev,
						 const unsigned char *vendor,
						 const unsigned char *model,
						 enum scsi_devinfo_key key);
extern int scsi_dev_info_list_add_keyed(int compatible, char *vendor,
					char *model, char *strflags,
					blist_flags_t flags,
					enum scsi_devinfo_key key);
extern int scsi_dev_info_list_del_keyed(char *vendor, char *model,
					enum scsi_devinfo_key key);
extern int scsi_dev_info_add_list(enum scsi_devinfo_key key, const char *name);
extern int scsi_dev_info_remove_list(enum scsi_devinfo_key key);

extern int __init scsi_init_devinfo(void);
extern void scsi_exit_devinfo(void);

/* scsi_error.c */
extern void scmd_eh_abort_handler(struct work_struct *work);
extern enum blk_eh_timer_return scsi_timeout(struct request *req);
extern int scsi_error_handler(void *host);
extern enum scsi_disposition scsi_decide_disposition(struct scsi_cmnd *cmd);
extern void scsi_eh_wakeup(struct Scsi_Host *shost);
extern void scsi_eh_scmd_add(struct scsi_cmnd *);
void scsi_eh_ready_devs(struct Scsi_Host *shost,
			struct list_head *work_q,
			struct list_head *done_q);
int scsi_eh_get_sense(struct list_head *work_q,
		      struct list_head *done_q);
bool scsi_noretry_cmd(struct scsi_cmnd *scmd);
void scsi_eh_done(struct scsi_cmnd *scmd);

/* scsi_lib.c */
extern int scsi_maybe_unblock_host(struct scsi_device *sdev);
extern void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd);
extern void scsi_queue_insert(struct scsi_cmnd *cmd, int reason);
extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
extern void scsi_run_host_queues(struct Scsi_Host *shost);
extern void scsi_requeue_run_queue(struct work_struct *work);
extern void scsi_start_queue(struct scsi_device *sdev);
extern int scsi_mq_setup_tags(struct Scsi_Host *shost);
extern void scsi_mq_free_tags(struct kref *kref);
extern void scsi_exit_queue(void);
extern void scsi_evt_thread(struct work_struct *work);

/* scsi_proc.c */
#ifdef CONFIG_SCSI_PROC_FS
extern int scsi_proc_hostdir_add(const struct scsi_host_template *);
extern void scsi_proc_hostdir_rm(const struct scsi_host_template *);
extern void scsi_proc_host_add(struct Scsi_Host *);
extern void scsi_proc_host_rm(struct Scsi_Host *);
extern int scsi_init_procfs(void);
extern void scsi_exit_procfs(void);
#else
# define scsi_proc_hostdir_add(sht)	0
# define scsi_proc_hostdir_rm(sht)	do { } while (0)
# define scsi_proc_host_add(shost)	do { } while (0)
# define scsi_proc_host_rm(shost)	do { } while (0)
# define scsi_init_procfs()		(0)
# define scsi_exit_procfs()		do { } while (0)
#endif /* CONFIG_PROC_FS */

/* scsi_scan.c */
void scsi_enable_async_suspend(struct device *dev);
extern int scsi_complete_async_scans(void);
extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int,
				   unsigned int, u64, enum scsi_scan_mode);
extern void scsi_forget_host(struct Scsi_Host *);
extern void scsi_rescan_device(struct device *);

/* scsi_sysctl.c */
#ifdef CONFIG_SYSCTL
extern int scsi_init_sysctl(void);
extern void scsi_exit_sysctl(void);
#else
# define scsi_init_sysctl()		(0)
# define scsi_exit_sysctl()		do { } while (0)
#endif /* CONFIG_SYSCTL */

/* scsi_sysfs.c */
extern int scsi_sysfs_add_sdev(struct scsi_device *);
extern int scsi_sysfs_add_host(struct Scsi_Host *);
extern int scsi_sysfs_register(void);
extern void scsi_sysfs_unregister(void);
extern void scsi_sysfs_device_initialize(struct scsi_device *);
extern int scsi_sysfs_target_initialize(struct scsi_device *);
extern struct scsi_transport_template blank_transport_template;
extern void __scsi_remove_device(struct scsi_device *);

extern struct bus_type scsi_bus_type;
extern const struct attribute_group *scsi_shost_groups[];

/* scsi_netlink.c */
#ifdef CONFIG_SCSI_NETLINK
extern void scsi_netlink_init(void);
extern void scsi_netlink_exit(void);
extern struct sock *scsi_nl_sock;
#else
static inline void scsi_netlink_init(void) {}
static inline void scsi_netlink_exit(void) {}
#endif

/* scsi_pm.c */
#ifdef CONFIG_PM
extern const struct dev_pm_ops scsi_bus_pm_ops;

extern void scsi_autopm_get_target(struct scsi_target *);
extern void scsi_autopm_put_target(struct scsi_target *);
extern int scsi_autopm_get_host(struct Scsi_Host *);
extern void scsi_autopm_put_host(struct Scsi_Host *);
#else
static inline void scsi_autopm_get_target(struct scsi_target *t) {}
static inline void scsi_autopm_put_target(struct scsi_target *t) {}
static inline int scsi_autopm_get_host(struct Scsi_Host *h) { return 0; }
static inline void scsi_autopm_put_host(struct Scsi_Host *h) {}
#endif /* CONFIG_PM */

/* scsi_dh.c */
#ifdef CONFIG_SCSI_DH
void scsi_dh_add_device(struct scsi_device *sdev);
void scsi_dh_release_device(struct scsi_device *sdev);
#else
static inline void scsi_dh_add_device(struct scsi_device *sdev) { }
static inline void scsi_dh_release_device(struct scsi_device *sdev) { }
#endif

struct bsg_device *scsi_bsg_register_queue(struct scsi_device *sdev);

extern int scsi_device_max_queue_depth(struct scsi_device *sdev);

/* 
 * internal scsi timeout functions: for use by mid-layer and transport
 * classes.
 */

#define SCSI_DEVICE_BLOCK_MAX_TIMEOUT	600	/* units in seconds */

#endif /* _SCSI_PRIV_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _SCSI_PRIV_H
	3	#define _SCSI_PRIV_H
	4
1da177e4	5	#include <linux/device.h>
5d9fb5cc	6	#include <scsi/scsi_device.h>
020b0f0a	7	#include <linux/sbitmap.h>
1da177e4	8
ead09dd3	9	struct bsg_device;
1da177e4	10	struct request_queue;
242f9dcb	11	struct request;
1da177e4 LT	12	struct scsi_cmnd;
1da177e4 LT	13	struct scsi_device;
bc4f2401	14	struct scsi_target;
1da177e4	15	struct scsi_host_template;
1da177e4	16	struct Scsi_Host;
84314fd4	17	struct scsi_nl_hdr;
1da177e4	18
2a242d59	19	#define SCSI_CMD_RETRIES_NO_LIMIT -1
1da177e4	20
36ebf1e2 MC	21	/*
	22	* Error codes used by scsi-ml internally. These must not be used by drivers.
	23	*/
	24	enum scsi_ml_status {
	25	SCSIML_STAT_OK = 0x00,
	26	SCSIML_STAT_RESV_CONFLICT = 0x01, /* Reservation conflict */
	27	SCSIML_STAT_NOSPC = 0x02, /* Space allocation on the dev failed */
	28	SCSIML_STAT_MED_ERROR = 0x03, /* Medium error */
	29	SCSIML_STAT_TGT_FAILURE = 0x04, /* Permanent target failure */
390e2d1a	30	SCSIML_STAT_DL_TIMEOUT = 0x05, /* Command Duration Limit timeout */
36ebf1e2 MC	31	};
36ebf1e2 MC	32
73432693 NC	33	static inline u8 scsi_ml_byte(int result)
	34	{
	35	return (result >> 8) & 0xff;
	36	}
	37
1da177e4 LT	38	/*
	39	* Scsi Error Handler Flags
	40	*/
e494f6a7	41	#define SCSI_EH_ABORT_SCHEDULED 0x0002 /* Abort has been scheduled */
1da177e4 LT	42
	43	#define SCSI_SENSE_VALID(scmd) \
	44	(((scmd)->sense_buffer[0] & 0x70) == 0x70)
	45
1da177e4 LT	46	/* hosts.c */
	47	extern int scsi_init_hosts(void);
	48	extern void scsi_exit_hosts(void);
	49
	50	/* scsi.c */
0a6ac4ee	51	int scsi_init_sense_cache(struct Scsi_Host *shost);
e9c787e6	52	void scsi_init_command(struct scsi_device dev, struct scsi_cmnd cmd);
1da177e4 LT	53	#ifdef CONFIG_SCSI_LOGGING
	54	void scsi_log_send(struct scsi_cmnd *cmd);
	55	void scsi_log_completion(struct scsi_cmnd *cmd, int disposition);
	56	#else
	57	static inline void scsi_log_send(struct scsi_cmnd *cmd)
	58	{ };
	59	static inline void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
	60	{ };
	61	#endif
	62
	63	/* scsi_devinfo.c */
598fa4b7 JB	64
598fa4b7 JB	65	/* list of keys for the lists */
4b1d8e78	66	enum scsi_devinfo_key {
598fa4b7	67	SCSI_DEVINFO_GLOBAL = 0,
a9e0edb6	68	SCSI_DEVINFO_SPI,
598fa4b7 JB	69	};
598fa4b7 JB	70
5ebde469 HR	71	extern blist_flags_t scsi_get_device_flags(struct scsi_device *sdev,
	72	const unsigned char *vendor,
	73	const unsigned char *model);
	74	extern blist_flags_t scsi_get_device_flags_keyed(struct scsi_device *sdev,
	75	const unsigned char *vendor,
	76	const unsigned char *model,
4b1d8e78	77	enum scsi_devinfo_key key);
598fa4b7 JB	78	extern int scsi_dev_info_list_add_keyed(int compatible, char *vendor,
598fa4b7 JB	79	char model, char strflags,
4b1d8e78 BVA	80	blist_flags_t flags,
	81	enum scsi_devinfo_key key);
	82	extern int scsi_dev_info_list_del_keyed(char vendor, char model,
	83	enum scsi_devinfo_key key);
	84	extern int scsi_dev_info_add_list(enum scsi_devinfo_key key, const char *name);
	85	extern int scsi_dev_info_remove_list(enum scsi_devinfo_key key);
598fa4b7	86
1da177e4 LT	87	extern int __init scsi_init_devinfo(void);
	88	extern void scsi_exit_devinfo(void);
	89
	90	/* scsi_error.c */
e494f6a7	91	extern void scmd_eh_abort_handler(struct work_struct *work);
9bdb4833	92	extern enum blk_eh_timer_return scsi_timeout(struct request *req);
1da177e4	93	extern int scsi_error_handler(void *host);
b8e162f9	94	extern enum scsi_disposition scsi_decide_disposition(struct scsi_cmnd *cmd);
1da177e4	95	extern void scsi_eh_wakeup(struct Scsi_Host *shost);
a0658632	96	extern void scsi_eh_scmd_add(struct scsi_cmnd *);
dca84e46 DW	97	void scsi_eh_ready_devs(struct Scsi_Host *shost,
	98	struct list_head *work_q,
	99	struct list_head *done_q);
	100	int scsi_eh_get_sense(struct list_head *work_q,
	101	struct list_head *done_q);
88b32c3c	102	bool scsi_noretry_cmd(struct scsi_cmnd *scmd);
bf23e619	103	void scsi_eh_done(struct scsi_cmnd *scmd);
1da177e4 LT	104
	105	/* scsi_lib.c */
	106	extern int scsi_maybe_unblock_host(struct scsi_device *sdev);
6eb045e0	107	extern void scsi_device_unbusy(struct scsi_device sdev, struct scsi_cmnd cmd);
84feb166	108	extern void scsi_queue_insert(struct scsi_cmnd *cmd, int reason);
7b3d9545	109	extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
1da177e4	110	extern void scsi_run_host_queues(struct Scsi_Host *shost);
d67e8b38	111	extern void scsi_requeue_run_queue(struct work_struct *work);
66483a4a	112	extern void scsi_start_queue(struct scsi_device *sdev);
d285203c	113	extern int scsi_mq_setup_tags(struct Scsi_Host *shost);
8fe4ce58	114	extern void scsi_mq_free_tags(struct kref *kref);
1da177e4	115	extern void scsi_exit_queue(void);
d67e8b38	116	extern void scsi_evt_thread(struct work_struct *work);
1da177e4 LT	117
	118	/* scsi_proc.c */
	119	#ifdef CONFIG_SCSI_PROC_FS
036abd61 BVA	120	extern int scsi_proc_hostdir_add(const struct scsi_host_template *);
036abd61 BVA	121	extern void scsi_proc_hostdir_rm(const struct scsi_host_template *);
1da177e4 LT	122	extern void scsi_proc_host_add(struct Scsi_Host *);
	123	extern void scsi_proc_host_rm(struct Scsi_Host *);
	124	extern int scsi_init_procfs(void);
	125	extern void scsi_exit_procfs(void);
	126	#else
ecca3f9b	127	# define scsi_proc_hostdir_add(sht) 0
1da177e4 LT	128	# define scsi_proc_hostdir_rm(sht) do { } while (0)
	129	# define scsi_proc_host_add(shost) do { } while (0)
	130	# define scsi_proc_host_rm(shost) do { } while (0)
	131	# define scsi_init_procfs() (0)
	132	# define scsi_exit_procfs() do { } while (0)
	133	#endif /* CONFIG_PROC_FS */
	134
	135	/* scsi_scan.c */
a19a93e4	136	void scsi_enable_async_suspend(struct device *dev);
fea6d607	137	extern int scsi_complete_async_scans(void);
1da177e4	138	extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int,
1d645088	139	unsigned int, u64, enum scsi_scan_mode);
1da177e4 LT	140	extern void scsi_forget_host(struct Scsi_Host *);
	141	extern void scsi_rescan_device(struct device *);
	142
	143	/* scsi_sysctl.c */
	144	#ifdef CONFIG_SYSCTL
	145	extern int scsi_init_sysctl(void);
	146	extern void scsi_exit_sysctl(void);
	147	#else
	148	# define scsi_init_sysctl() (0)
	149	# define scsi_exit_sysctl() do { } while (0)
	150	#endif /* CONFIG_SYSCTL */
	151
	152	/* scsi_sysfs.c */
1da177e4 LT	153	extern int scsi_sysfs_add_sdev(struct scsi_device *);
	154	extern int scsi_sysfs_add_host(struct Scsi_Host *);
	155	extern int scsi_sysfs_register(void);
	156	extern void scsi_sysfs_unregister(void);
	157	extern void scsi_sysfs_device_initialize(struct scsi_device *);
	158	extern int scsi_sysfs_target_initialize(struct scsi_device *);
	159	extern struct scsi_transport_template blank_transport_template;
903f4fed	160	extern void __scsi_remove_device(struct scsi_device *);
1da177e4	161
1da177e4	162	extern struct bus_type scsi_bus_type;
0a84486d	163	extern const struct attribute_group *scsi_shost_groups[];
1da177e4	164
84314fd4 JS	165	/* scsi_netlink.c */
	166	#ifdef CONFIG_SCSI_NETLINK
	167	extern void scsi_netlink_init(void);
	168	extern void scsi_netlink_exit(void);
	169	extern struct sock *scsi_nl_sock;
	170	#else
	171	static inline void scsi_netlink_init(void) {}
	172	static inline void scsi_netlink_exit(void) {}
	173	#endif
	174
db5bd1e0	175	/* scsi_pm.c */
aa338601	176	#ifdef CONFIG_PM
db5bd1e0	177	extern const struct dev_pm_ops scsi_bus_pm_ops;
4f7ad521	178
bc4f2401 AS	179	extern void scsi_autopm_get_target(struct scsi_target *);
	180	extern void scsi_autopm_put_target(struct scsi_target *);
	181	extern int scsi_autopm_get_host(struct Scsi_Host *);
	182	extern void scsi_autopm_put_host(struct Scsi_Host *);
	183	#else
	184	static inline void scsi_autopm_get_target(struct scsi_target *t) {}
	185	static inline void scsi_autopm_put_target(struct scsi_target *t) {}
	186	static inline int scsi_autopm_get_host(struct Scsi_Host *h) { return 0; }
	187	static inline void scsi_autopm_put_host(struct Scsi_Host *h) {}
4f7ad521	188	#endif /* CONFIG_PM */
db5bd1e0	189
086b91d0 CH	190	/* scsi_dh.c */
086b91d0 CH	191	#ifdef CONFIG_SCSI_DH
2930f817	192	void scsi_dh_add_device(struct scsi_device *sdev);
23695e41	193	void scsi_dh_release_device(struct scsi_device *sdev);
086b91d0	194	#else
2930f817	195	static inline void scsi_dh_add_device(struct scsi_device *sdev) { }
23695e41	196	static inline void scsi_dh_release_device(struct scsi_device *sdev) { }
086b91d0 CH	197	#endif
086b91d0 CH	198
ead09dd3	199	struct bsg_device scsi_bsg_register_queue(struct scsi_device sdev);
78011042	200
020b0f0a ML	201	extern int scsi_device_max_queue_depth(struct scsi_device *sdev);
020b0f0a ML	202
1da177e4 LT	203	/*
	204	* internal scsi timeout functions: for use by mid-layer and transport
	205	* classes.
	206	*/
	207
1c9e16e4	208	#define SCSI_DEVICE_BLOCK_MAX_TIMEOUT 600 /* units in seconds */
1da177e4 LT	209
1da177e4 LT	210	#endif /* _SCSI_PRIV_H */