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
19/*
20 * Scsi Error Handler Flags
21 */
22#define SCSI_EH_ABORT_SCHEDULED 0x0002 /* Abort has been scheduled */
23
24#define SCSI_SENSE_VALID(scmd) \
25 (((scmd)->sense_buffer[0] & 0x70) == 0x70)
26
27/* hosts.c */
28extern int scsi_init_hosts(void);
29extern void scsi_exit_hosts(void);
30
31/* scsi.c */
32extern bool scsi_use_blk_mq;
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 int scsi_decide_disposition(struct scsi_cmnd *cmd);
77extern void scsi_eh_wakeup(struct Scsi_Host *shost);
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 void scsi_add_cmd_to_list(struct scsi_cmnd *cmd);
88extern void scsi_del_cmd_from_list(struct scsi_cmnd *cmd);
89extern int scsi_maybe_unblock_host(struct scsi_device *sdev);
90extern void scsi_device_unbusy(struct scsi_device *sdev);
91extern void scsi_queue_insert(struct scsi_cmnd *cmd, int reason);
92extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
93extern void scsi_run_host_queues(struct Scsi_Host *shost);
94extern void scsi_requeue_run_queue(struct work_struct *work);
95extern struct request_queue *scsi_mq_alloc_queue(struct scsi_device *sdev);
96extern void scsi_start_queue(struct scsi_device *sdev);
97extern int scsi_mq_setup_tags(struct Scsi_Host *shost);
98extern void scsi_mq_destroy_tags(struct Scsi_Host *shost);
99extern int scsi_init_queue(void);
100extern void scsi_exit_queue(void);
101extern void scsi_evt_thread(struct work_struct *work);
102struct request_queue;
103struct request;
104
105/* scsi_proc.c */
106#ifdef CONFIG_SCSI_PROC_FS
107extern void scsi_proc_hostdir_add(struct scsi_host_template *);
108extern void scsi_proc_hostdir_rm(struct scsi_host_template *);
109extern void scsi_proc_host_add(struct Scsi_Host *);
110extern void scsi_proc_host_rm(struct Scsi_Host *);
111extern int scsi_init_procfs(void);
112extern void scsi_exit_procfs(void);
113#else
114# define scsi_proc_hostdir_add(sht) do { } while (0)
115# define scsi_proc_hostdir_rm(sht) do { } while (0)
116# define scsi_proc_host_add(shost) do { } while (0)
117# define scsi_proc_host_rm(shost) do { } while (0)
118# define scsi_init_procfs() (0)
119# define scsi_exit_procfs() do { } while (0)
120#endif /* CONFIG_PROC_FS */
121
122/* scsi_scan.c */
123extern char scsi_scan_type[];
124extern int scsi_complete_async_scans(void);
125extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int,
126 unsigned int, u64, enum scsi_scan_mode);
127extern void scsi_forget_host(struct Scsi_Host *);
128extern void scsi_rescan_device(struct device *);
129
130/* scsi_sysctl.c */
131#ifdef CONFIG_SYSCTL
132extern int scsi_init_sysctl(void);
133extern void scsi_exit_sysctl(void);
134#else
135# define scsi_init_sysctl() (0)
136# define scsi_exit_sysctl() do { } while (0)
137#endif /* CONFIG_SYSCTL */
138
139/* scsi_sysfs.c */
140extern int scsi_sysfs_add_sdev(struct scsi_device *);
141extern int scsi_sysfs_add_host(struct Scsi_Host *);
142extern int scsi_sysfs_register(void);
143extern void scsi_sysfs_unregister(void);
144extern void scsi_sysfs_device_initialize(struct scsi_device *);
145extern int scsi_sysfs_target_initialize(struct scsi_device *);
146extern struct scsi_transport_template blank_transport_template;
147extern void __scsi_remove_device(struct scsi_device *);
148
149extern struct bus_type scsi_bus_type;
150extern const struct attribute_group *scsi_sysfs_shost_attr_groups[];
151
152/* scsi_netlink.c */
153#ifdef CONFIG_SCSI_NETLINK
154extern void scsi_netlink_init(void);
155extern void scsi_netlink_exit(void);
156extern struct sock *scsi_nl_sock;
157#else
158static inline void scsi_netlink_init(void) {}
159static inline void scsi_netlink_exit(void) {}
160#endif
161
162/* scsi_pm.c */
163#ifdef CONFIG_PM
164extern const struct dev_pm_ops scsi_bus_pm_ops;
165
166extern void scsi_autopm_get_target(struct scsi_target *);
167extern void scsi_autopm_put_target(struct scsi_target *);
168extern int scsi_autopm_get_host(struct Scsi_Host *);
169extern void scsi_autopm_put_host(struct Scsi_Host *);
170#else
171static inline void scsi_autopm_get_target(struct scsi_target *t) {}
172static inline void scsi_autopm_put_target(struct scsi_target *t) {}
173static inline int scsi_autopm_get_host(struct Scsi_Host *h) { return 0; }
174static inline void scsi_autopm_put_host(struct Scsi_Host *h) {}
175#endif /* CONFIG_PM */
176
177extern struct async_domain scsi_sd_pm_domain;
178extern struct async_domain scsi_sd_probe_domain;
179
180/* scsi_dh.c */
181#ifdef CONFIG_SCSI_DH
182void scsi_dh_add_device(struct scsi_device *sdev);
183void scsi_dh_release_device(struct scsi_device *sdev);
184#else
185static inline void scsi_dh_add_device(struct scsi_device *sdev) { }
186static inline void scsi_dh_release_device(struct scsi_device *sdev) { }
187#endif
188
189/*
190 * internal scsi timeout functions: for use by mid-layer and transport
191 * classes.
192 */
193
194#define SCSI_DEVICE_BLOCK_MAX_TIMEOUT 600 /* units in seconds */
195
196#endif /* _SCSI_PRIV_H */
197