xref: /openbmc/linux/drivers/scsi/scsi_priv.h (revision a1117495)
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 #include <linux/sbitmap.h>
9 
10 struct bsg_device;
11 struct request_queue;
12 struct request;
13 struct scsi_cmnd;
14 struct scsi_device;
15 struct scsi_target;
16 struct scsi_host_template;
17 struct Scsi_Host;
18 struct scsi_nl_hdr;
19 
20 #define SCSI_CMD_RETRIES_NO_LIMIT -1
21 
22 /*
23  * Scsi Error Handler Flags
24  */
25 #define SCSI_EH_ABORT_SCHEDULED	0x0002	/* Abort has been scheduled */
26 
27 #define SCSI_SENSE_VALID(scmd) \
28 	(((scmd)->sense_buffer[0] & 0x70) == 0x70)
29 
30 /* hosts.c */
31 extern int scsi_init_hosts(void);
32 extern void scsi_exit_hosts(void);
33 
34 /* scsi.c */
35 int scsi_init_sense_cache(struct Scsi_Host *shost);
36 void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd);
37 #ifdef CONFIG_SCSI_LOGGING
38 void scsi_log_send(struct scsi_cmnd *cmd);
39 void scsi_log_completion(struct scsi_cmnd *cmd, int disposition);
40 #else
41 static inline void scsi_log_send(struct scsi_cmnd *cmd)
42 	{ };
43 static inline void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
44 	{ };
45 #endif
46 
47 /* scsi_devinfo.c */
48 
49 /* list of keys for the lists */
50 enum scsi_devinfo_key {
51 	SCSI_DEVINFO_GLOBAL = 0,
52 	SCSI_DEVINFO_SPI,
53 };
54 
55 extern blist_flags_t scsi_get_device_flags(struct scsi_device *sdev,
56 					   const unsigned char *vendor,
57 					   const unsigned char *model);
58 extern blist_flags_t scsi_get_device_flags_keyed(struct scsi_device *sdev,
59 						 const unsigned char *vendor,
60 						 const unsigned char *model,
61 						 enum scsi_devinfo_key key);
62 extern int scsi_dev_info_list_add_keyed(int compatible, char *vendor,
63 					char *model, char *strflags,
64 					blist_flags_t flags,
65 					enum scsi_devinfo_key key);
66 extern int scsi_dev_info_list_del_keyed(char *vendor, char *model,
67 					enum scsi_devinfo_key key);
68 extern int scsi_dev_info_add_list(enum scsi_devinfo_key key, const char *name);
69 extern int scsi_dev_info_remove_list(enum scsi_devinfo_key key);
70 
71 extern int __init scsi_init_devinfo(void);
72 extern void scsi_exit_devinfo(void);
73 
74 /* scsi_error.c */
75 extern void scmd_eh_abort_handler(struct work_struct *work);
76 extern enum blk_eh_timer_return scsi_times_out(struct request *req);
77 extern int scsi_error_handler(void *host);
78 extern enum scsi_disposition scsi_decide_disposition(struct scsi_cmnd *cmd);
79 extern void scsi_eh_wakeup(struct Scsi_Host *shost);
80 extern void scsi_eh_scmd_add(struct scsi_cmnd *);
81 void scsi_eh_ready_devs(struct Scsi_Host *shost,
82 			struct list_head *work_q,
83 			struct list_head *done_q);
84 int scsi_eh_get_sense(struct list_head *work_q,
85 		      struct list_head *done_q);
86 int scsi_noretry_cmd(struct scsi_cmnd *scmd);
87 void scsi_eh_done(struct scsi_cmnd *scmd);
88 
89 /* scsi_lib.c */
90 extern int scsi_maybe_unblock_host(struct scsi_device *sdev);
91 extern void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd);
92 extern void scsi_queue_insert(struct scsi_cmnd *cmd, int reason);
93 extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
94 extern void scsi_run_host_queues(struct Scsi_Host *shost);
95 extern void scsi_requeue_run_queue(struct work_struct *work);
96 extern void scsi_start_queue(struct scsi_device *sdev);
97 extern int scsi_mq_setup_tags(struct Scsi_Host *shost);
98 extern void scsi_mq_destroy_tags(struct Scsi_Host *shost);
99 extern void scsi_exit_queue(void);
100 extern void scsi_evt_thread(struct work_struct *work);
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 */
120 void scsi_enable_async_suspend(struct device *dev);
121 extern int scsi_complete_async_scans(void);
122 extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int,
123 				   unsigned int, u64, enum scsi_scan_mode);
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 */
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;
144 extern void __scsi_remove_device(struct scsi_device *);
145 
146 extern struct bus_type scsi_bus_type;
147 extern const struct attribute_group scsi_shost_attr_group;
148 
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 
159 /* scsi_pm.c */
160 #ifdef CONFIG_PM
161 extern const struct dev_pm_ops scsi_bus_pm_ops;
162 
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) {}
172 #endif /* CONFIG_PM */
173 
174 /* scsi_dh.c */
175 #ifdef CONFIG_SCSI_DH
176 void scsi_dh_add_device(struct scsi_device *sdev);
177 void scsi_dh_release_device(struct scsi_device *sdev);
178 #else
179 static inline void scsi_dh_add_device(struct scsi_device *sdev) { }
180 static inline void scsi_dh_release_device(struct scsi_device *sdev) { }
181 #endif
182 
183 struct bsg_device *scsi_bsg_register_queue(struct scsi_device *sdev);
184 
185 extern int scsi_device_max_queue_depth(struct scsi_device *sdev);
186 
187 /*
188  * internal scsi timeout functions: for use by mid-layer and transport
189  * classes.
190  */
191 
192 #define SCSI_DEVICE_BLOCK_MAX_TIMEOUT	600	/* units in seconds */
193 
194 #endif /* _SCSI_PRIV_H */
195