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