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 <scsi/scsi_device.h> |
7 | #include <linux/sbitmap.h> |
8 | |
9 | struct bsg_device; |
10 | struct request_queue; |
11 | struct request; |
12 | struct scsi_cmnd; |
13 | struct scsi_device; |
14 | struct scsi_target; |
15 | struct scsi_host_template; |
16 | struct Scsi_Host; |
17 | struct scsi_nl_hdr; |
18 | |
19 | #define SCSI_CMD_RETRIES_NO_LIMIT -1 |
20 | |
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 */ |
30 | SCSIML_STAT_DL_TIMEOUT = 0x05, /* Command Duration Limit timeout */ |
31 | }; |
32 | |
33 | static inline u8 scsi_ml_byte(int result) |
34 | { |
35 | return (result >> 8) & 0xff; |
36 | } |
37 | |
38 | /* |
39 | * Scsi Error Handler Flags |
40 | */ |
41 | #define SCSI_EH_ABORT_SCHEDULED 0x0002 /* Abort has been scheduled */ |
42 | |
43 | #define SCSI_SENSE_VALID(scmd) \ |
44 | (((scmd)->sense_buffer[0] & 0x70) == 0x70) |
45 | |
46 | /* hosts.c */ |
47 | extern int scsi_init_hosts(void); |
48 | extern void scsi_exit_hosts(void); |
49 | |
50 | /* scsi.c */ |
51 | int scsi_init_sense_cache(struct Scsi_Host *shost); |
52 | void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd); |
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 */ |
64 | |
65 | /* list of keys for the lists */ |
66 | enum scsi_devinfo_key { |
67 | SCSI_DEVINFO_GLOBAL = 0, |
68 | SCSI_DEVINFO_SPI, |
69 | }; |
70 | |
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, |
77 | enum scsi_devinfo_key key); |
78 | extern int scsi_dev_info_list_add_keyed(int compatible, char *vendor, |
79 | char *model, char *strflags, |
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); |
86 | |
87 | extern int __init scsi_init_devinfo(void); |
88 | extern void scsi_exit_devinfo(void); |
89 | |
90 | /* scsi_error.c */ |
91 | extern void scmd_eh_abort_handler(struct work_struct *work); |
92 | extern enum blk_eh_timer_return scsi_timeout(struct request *req); |
93 | extern int scsi_error_handler(void *host); |
94 | extern enum scsi_disposition scsi_decide_disposition(struct scsi_cmnd *cmd); |
95 | extern void scsi_eh_wakeup(struct Scsi_Host *shost, unsigned int busy); |
96 | extern void scsi_eh_scmd_add(struct scsi_cmnd *); |
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); |
102 | bool scsi_noretry_cmd(struct scsi_cmnd *scmd); |
103 | void scsi_eh_done(struct scsi_cmnd *scmd); |
104 | |
105 | /* scsi_lib.c */ |
106 | extern void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd); |
107 | extern void scsi_queue_insert(struct scsi_cmnd *cmd, int reason); |
108 | extern void scsi_io_completion(struct scsi_cmnd *, unsigned int); |
109 | extern void scsi_run_host_queues(struct Scsi_Host *shost); |
110 | extern void scsi_requeue_run_queue(struct work_struct *work); |
111 | extern void scsi_start_queue(struct scsi_device *sdev); |
112 | extern int scsi_mq_setup_tags(struct Scsi_Host *shost); |
113 | extern void scsi_mq_free_tags(struct kref *kref); |
114 | extern void scsi_exit_queue(void); |
115 | extern void scsi_evt_thread(struct work_struct *work); |
116 | |
117 | /* scsi_proc.c */ |
118 | #ifdef CONFIG_SCSI_PROC_FS |
119 | extern int scsi_proc_hostdir_add(const struct scsi_host_template *); |
120 | extern void scsi_proc_hostdir_rm(const struct scsi_host_template *); |
121 | extern void scsi_proc_host_add(struct Scsi_Host *); |
122 | extern void scsi_proc_host_rm(struct Scsi_Host *); |
123 | extern int scsi_init_procfs(void); |
124 | extern void scsi_exit_procfs(void); |
125 | #else |
126 | # define scsi_proc_hostdir_add(sht) 0 |
127 | # define scsi_proc_hostdir_rm(sht) do { } while (0) |
128 | # define scsi_proc_host_add(shost) do { } while (0) |
129 | # define scsi_proc_host_rm(shost) do { } while (0) |
130 | # define scsi_init_procfs() (0) |
131 | # define scsi_exit_procfs() do { } while (0) |
132 | #endif /* CONFIG_PROC_FS */ |
133 | |
134 | /* scsi_scan.c */ |
135 | void scsi_enable_async_suspend(struct device *dev); |
136 | extern int scsi_complete_async_scans(void); |
137 | extern int scsi_scan_host_selected(struct Scsi_Host *, unsigned int, |
138 | unsigned int, u64, enum scsi_scan_mode); |
139 | extern void scsi_forget_host(struct Scsi_Host *); |
140 | |
141 | /* scsi_sysctl.c */ |
142 | #ifdef CONFIG_SYSCTL |
143 | extern int scsi_init_sysctl(void); |
144 | extern void scsi_exit_sysctl(void); |
145 | #else |
146 | # define scsi_init_sysctl() (0) |
147 | # define scsi_exit_sysctl() do { } while (0) |
148 | #endif /* CONFIG_SYSCTL */ |
149 | |
150 | /* scsi_sysfs.c */ |
151 | extern int scsi_sysfs_add_sdev(struct scsi_device *); |
152 | extern int scsi_sysfs_add_host(struct Scsi_Host *); |
153 | extern int scsi_sysfs_register(void); |
154 | extern void scsi_sysfs_unregister(void); |
155 | extern void scsi_sysfs_device_initialize(struct scsi_device *); |
156 | extern struct scsi_transport_template blank_transport_template; |
157 | extern void __scsi_remove_device(struct scsi_device *); |
158 | |
159 | extern const struct bus_type scsi_bus_type; |
160 | extern const struct attribute_group *scsi_shost_groups[]; |
161 | |
162 | /* scsi_netlink.c */ |
163 | #ifdef CONFIG_SCSI_NETLINK |
164 | extern void scsi_netlink_init(void); |
165 | extern void scsi_netlink_exit(void); |
166 | extern struct sock *scsi_nl_sock; |
167 | #else |
168 | static inline void scsi_netlink_init(void) {} |
169 | static inline void scsi_netlink_exit(void) {} |
170 | #endif |
171 | |
172 | /* scsi_pm.c */ |
173 | #ifdef CONFIG_PM |
174 | extern const struct dev_pm_ops scsi_bus_pm_ops; |
175 | |
176 | extern void scsi_autopm_get_target(struct scsi_target *); |
177 | extern void scsi_autopm_put_target(struct scsi_target *); |
178 | extern int scsi_autopm_get_host(struct Scsi_Host *); |
179 | extern void scsi_autopm_put_host(struct Scsi_Host *); |
180 | #else |
181 | static inline void scsi_autopm_get_target(struct scsi_target *t) {} |
182 | static inline void scsi_autopm_put_target(struct scsi_target *t) {} |
183 | static inline int scsi_autopm_get_host(struct Scsi_Host *h) { return 0; } |
184 | static inline void scsi_autopm_put_host(struct Scsi_Host *h) {} |
185 | #endif /* CONFIG_PM */ |
186 | |
187 | /* scsi_dh.c */ |
188 | #ifdef CONFIG_SCSI_DH |
189 | void scsi_dh_add_device(struct scsi_device *sdev); |
190 | void scsi_dh_release_device(struct scsi_device *sdev); |
191 | #else |
192 | static inline void scsi_dh_add_device(struct scsi_device *sdev) { } |
193 | static inline void scsi_dh_release_device(struct scsi_device *sdev) { } |
194 | #endif |
195 | |
196 | struct bsg_device *scsi_bsg_register_queue(struct scsi_device *sdev); |
197 | |
198 | extern int scsi_device_max_queue_depth(struct scsi_device *sdev); |
199 | |
200 | /* |
201 | * internal scsi timeout functions: for use by mid-layer and transport |
202 | * classes. |
203 | */ |
204 | |
205 | #define SCSI_DEVICE_BLOCK_MAX_TIMEOUT 600 /* units in seconds */ |
206 | |
207 | #endif /* _SCSI_PRIV_H */ |
208 | |