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