[mirror_ubuntu-hirsute-kernel.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 <linux/async.h>
#include <scsi/scsi_device.h>

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

/*
 * 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_times_out(struct request *req);
extern int scsi_error_handler(void *host);
extern int 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);
int scsi_noretry_cmd(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 struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev);
extern void scsi_start_queue(struct scsi_device *sdev);
extern int scsi_mq_setup_tags(struct Scsi_Host *shost);
extern void scsi_mq_destroy_tags(struct Scsi_Host *shost);
extern void scsi_exit_queue(void);
extern void scsi_evt_thread(struct work_struct *work);
struct request_queue;
struct request;

/* scsi_proc.c */
#ifdef CONFIG_SCSI_PROC_FS
extern void scsi_proc_hostdir_add(struct scsi_host_template *);
extern void scsi_proc_hostdir_rm(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)	do { } while (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 */
extern char scsi_scan_type[];
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_sysfs_shost_attr_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 */

extern struct async_domain scsi_sd_pm_domain;

/* 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

/* 
 * 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>
2955b47d	6	#include <linux/async.h>
5d9fb5cc	7	#include <scsi/scsi_device.h>
1da177e4 LT	8
1da177e4 LT	9	struct request_queue;
242f9dcb	10	struct request;
1da177e4 LT	11	struct scsi_cmnd;
1da177e4 LT	12	struct scsi_device;
bc4f2401	13	struct scsi_target;
1da177e4	14	struct scsi_host_template;
1da177e4	15	struct Scsi_Host;
84314fd4	16	struct scsi_nl_hdr;
1da177e4	17
2a242d59	18	#define SCSI_CMD_RETRIES_NO_LIMIT -1
1da177e4	19
1da177e4 LT	20	/*
	21	* Scsi Error Handler Flags
	22	*/
e494f6a7	23	#define SCSI_EH_ABORT_SCHEDULED 0x0002 /* Abort has been scheduled */
1da177e4 LT	24
	25	#define SCSI_SENSE_VALID(scmd) \
	26	(((scmd)->sense_buffer[0] & 0x70) == 0x70)
	27
1da177e4 LT	28	/* hosts.c */
	29	extern int scsi_init_hosts(void);
	30	extern void scsi_exit_hosts(void);
	31
	32	/* scsi.c */
0a6ac4ee	33	int scsi_init_sense_cache(struct Scsi_Host *shost);
e9c787e6	34	void scsi_init_command(struct scsi_device dev, struct scsi_cmnd cmd);
1da177e4 LT	35	#ifdef CONFIG_SCSI_LOGGING
	36	void scsi_log_send(struct scsi_cmnd *cmd);
	37	void scsi_log_completion(struct scsi_cmnd *cmd, int disposition);
	38	#else
	39	static inline void scsi_log_send(struct scsi_cmnd *cmd)
	40	{ };
	41	static inline void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
	42	{ };
	43	#endif
	44
	45	/* scsi_devinfo.c */
598fa4b7 JB	46
598fa4b7 JB	47	/* list of keys for the lists */
4b1d8e78	48	enum scsi_devinfo_key {
598fa4b7	49	SCSI_DEVINFO_GLOBAL = 0,
a9e0edb6	50	SCSI_DEVINFO_SPI,
598fa4b7 JB	51	};
598fa4b7 JB	52
5ebde469 HR	53	extern blist_flags_t scsi_get_device_flags(struct scsi_device *sdev,
	54	const unsigned char *vendor,
	55	const unsigned char *model);
	56	extern blist_flags_t scsi_get_device_flags_keyed(struct scsi_device *sdev,
	57	const unsigned char *vendor,
	58	const unsigned char *model,
4b1d8e78	59	enum scsi_devinfo_key key);
598fa4b7 JB	60	extern int scsi_dev_info_list_add_keyed(int compatible, char *vendor,
598fa4b7 JB	61	char model, char strflags,
4b1d8e78 BVA	62	blist_flags_t flags,
	63	enum scsi_devinfo_key key);
	64	extern int scsi_dev_info_list_del_keyed(char vendor, char model,
	65	enum scsi_devinfo_key key);
	66	extern int scsi_dev_info_add_list(enum scsi_devinfo_key key, const char *name);
	67	extern int scsi_dev_info_remove_list(enum scsi_devinfo_key key);
598fa4b7	68
1da177e4 LT	69	extern int __init scsi_init_devinfo(void);
	70	extern void scsi_exit_devinfo(void);
	71
	72	/* scsi_error.c */
e494f6a7	73	extern void scmd_eh_abort_handler(struct work_struct *work);
242f9dcb	74	extern enum blk_eh_timer_return scsi_times_out(struct request *req);
1da177e4 LT	75	extern int scsi_error_handler(void *host);
	76	extern int scsi_decide_disposition(struct scsi_cmnd *cmd);
	77	extern void scsi_eh_wakeup(struct Scsi_Host *shost);
a0658632	78	extern void scsi_eh_scmd_add(struct scsi_cmnd *);
dca84e46 DW	79	void scsi_eh_ready_devs(struct Scsi_Host *shost,
	80	struct list_head *work_q,
	81	struct list_head *done_q);
	82	int scsi_eh_get_sense(struct list_head *work_q,
	83	struct list_head *done_q);
4a27446f	84	int scsi_noretry_cmd(struct scsi_cmnd *scmd);
1da177e4 LT	85
	86	/* scsi_lib.c */
	87	extern int scsi_maybe_unblock_host(struct scsi_device *sdev);
6eb045e0	88	extern void scsi_device_unbusy(struct scsi_device sdev, struct scsi_cmnd cmd);
84feb166	89	extern void scsi_queue_insert(struct scsi_cmnd *cmd, int reason);
7b3d9545	90	extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
1da177e4	91	extern void scsi_run_host_queues(struct Scsi_Host *shost);
d67e8b38	92	extern void scsi_requeue_run_queue(struct work_struct *work);
d285203c	93	extern struct request_queue scsi_mq_alloc_queue(struct scsi_device sdev);
66483a4a	94	extern void scsi_start_queue(struct scsi_device *sdev);
d285203c CH	95	extern int scsi_mq_setup_tags(struct Scsi_Host *shost);
d285203c CH	96	extern void scsi_mq_destroy_tags(struct Scsi_Host *shost);
1da177e4	97	extern void scsi_exit_queue(void);
d67e8b38	98	extern void scsi_evt_thread(struct work_struct *work);
751bf4d7 JB	99	struct request_queue;
751bf4d7 JB	100	struct request;
1da177e4 LT	101
	102	/* scsi_proc.c */
	103	#ifdef CONFIG_SCSI_PROC_FS
	104	extern void scsi_proc_hostdir_add(struct scsi_host_template *);
	105	extern void scsi_proc_hostdir_rm(struct scsi_host_template *);
	106	extern void scsi_proc_host_add(struct Scsi_Host *);
	107	extern void scsi_proc_host_rm(struct Scsi_Host *);
	108	extern int scsi_init_procfs(void);
	109	extern void scsi_exit_procfs(void);
	110	#else
	111	# define scsi_proc_hostdir_add(sht) do { } while (0)
	112	# define scsi_proc_hostdir_rm(sht) do { } while (0)
	113	# define scsi_proc_host_add(shost) do { } while (0)
	114	# define scsi_proc_host_rm(shost) do { } while (0)
	115	# define scsi_init_procfs() (0)
	116	# define scsi_exit_procfs() do { } while (0)
	117	#endif /* CONFIG_PROC_FS */
	118
	119	/* scsi_scan.c */
3c31b52f	120	extern char scsi_scan_type[];
fea6d607	121	extern int scsi_complete_async_scans(void);
1da177e4	122	extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int,
1d645088	123	unsigned int, u64, enum scsi_scan_mode);
1da177e4 LT	124	extern void scsi_forget_host(struct Scsi_Host *);
	125	extern void scsi_rescan_device(struct device *);
	126
	127	/* scsi_sysctl.c */
	128	#ifdef CONFIG_SYSCTL
	129	extern int scsi_init_sysctl(void);
	130	extern void scsi_exit_sysctl(void);
	131	#else
	132	# define scsi_init_sysctl() (0)
	133	# define scsi_exit_sysctl() do { } while (0)
	134	#endif /* CONFIG_SYSCTL */
	135
	136	/* scsi_sysfs.c */
1da177e4 LT	137	extern int scsi_sysfs_add_sdev(struct scsi_device *);
	138	extern int scsi_sysfs_add_host(struct Scsi_Host *);
	139	extern int scsi_sysfs_register(void);
	140	extern void scsi_sysfs_unregister(void);
	141	extern void scsi_sysfs_device_initialize(struct scsi_device *);
	142	extern int scsi_sysfs_target_initialize(struct scsi_device *);
	143	extern struct scsi_transport_template blank_transport_template;
903f4fed	144	extern void __scsi_remove_device(struct scsi_device *);
1da177e4	145
1da177e4	146	extern struct bus_type scsi_bus_type;
a4dbd674	147	extern const struct attribute_group *scsi_sysfs_shost_attr_groups[];
1da177e4	148
84314fd4 JS	149	/* scsi_netlink.c */
	150	#ifdef CONFIG_SCSI_NETLINK
	151	extern void scsi_netlink_init(void);
	152	extern void scsi_netlink_exit(void);
	153	extern struct sock *scsi_nl_sock;
	154	#else
	155	static inline void scsi_netlink_init(void) {}
	156	static inline void scsi_netlink_exit(void) {}
	157	#endif
	158
db5bd1e0	159	/* scsi_pm.c */
aa338601	160	#ifdef CONFIG_PM
db5bd1e0	161	extern const struct dev_pm_ops scsi_bus_pm_ops;
4f7ad521	162
bc4f2401 AS	163	extern void scsi_autopm_get_target(struct scsi_target *);
	164	extern void scsi_autopm_put_target(struct scsi_target *);
	165	extern int scsi_autopm_get_host(struct Scsi_Host *);
	166	extern void scsi_autopm_put_host(struct Scsi_Host *);
	167	#else
	168	static inline void scsi_autopm_get_target(struct scsi_target *t) {}
	169	static inline void scsi_autopm_put_target(struct scsi_target *t) {}
	170	static inline int scsi_autopm_get_host(struct Scsi_Host *h) { return 0; }
	171	static inline void scsi_autopm_put_host(struct Scsi_Host *h) {}
4f7ad521	172	#endif /* CONFIG_PM */
db5bd1e0	173
3c31b52f	174	extern struct async_domain scsi_sd_pm_domain;
a7a20d10	175
086b91d0 CH	176	/* scsi_dh.c */
086b91d0 CH	177	#ifdef CONFIG_SCSI_DH
2930f817	178	void scsi_dh_add_device(struct scsi_device *sdev);
23695e41	179	void scsi_dh_release_device(struct scsi_device *sdev);
086b91d0	180	#else
2930f817	181	static inline void scsi_dh_add_device(struct scsi_device *sdev) { }
23695e41	182	static inline void scsi_dh_release_device(struct scsi_device *sdev) { }
086b91d0 CH	183	#endif
086b91d0 CH	184
1da177e4 LT	185	/*
	186	* internal scsi timeout functions: for use by mid-layer and transport
	187	* classes.
	188	*/
	189
1c9e16e4	190	#define SCSI_DEVICE_BLOCK_MAX_TIMEOUT 600 /* units in seconds */
1da177e4 LT	191
1da177e4 LT	192	#endif /* _SCSI_PRIV_H */