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