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