xref: /openbmc/linux/drivers/s390/scsi/zfcp_ext.h (revision fb574682)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * zfcp device driver
4  *
5  * External function declarations.
6  *
7  * Copyright IBM Corp. 2002, 2020
8  */
9 
10 #ifndef ZFCP_EXT_H
11 #define ZFCP_EXT_H
12 
13 #include <linux/types.h>
14 #include <scsi/fc/fc_els.h>
15 #include "zfcp_def.h"
16 #include "zfcp_fc.h"
17 
18 /* zfcp_aux.c */
19 extern struct zfcp_port *zfcp_get_port_by_wwpn(struct zfcp_adapter *, u64);
20 extern struct zfcp_adapter *zfcp_adapter_enqueue(struct ccw_device *);
21 extern struct zfcp_port *zfcp_port_enqueue(struct zfcp_adapter *, u64, u32,
22 					   u32);
23 extern void zfcp_sg_free_table(struct scatterlist *, int);
24 extern int zfcp_sg_setup_table(struct scatterlist *, int);
25 extern void zfcp_adapter_release(struct kref *);
26 extern void zfcp_adapter_unregister(struct zfcp_adapter *);
27 
28 /* zfcp_ccw.c */
29 extern struct ccw_driver zfcp_ccw_driver;
30 extern struct zfcp_adapter *zfcp_ccw_adapter_by_cdev(struct ccw_device *);
31 extern void zfcp_ccw_adapter_put(struct zfcp_adapter *);
32 
33 /* zfcp_dbf.c */
34 extern int zfcp_dbf_adapter_register(struct zfcp_adapter *);
35 extern void zfcp_dbf_adapter_unregister(struct zfcp_adapter *);
36 extern void zfcp_dbf_rec_trig(char *, struct zfcp_adapter *,
37 			      struct zfcp_port *, struct scsi_device *, u8, u8);
38 extern void zfcp_dbf_rec_trig_lock(char *tag, struct zfcp_adapter *adapter,
39 				   struct zfcp_port *port,
40 				   struct scsi_device *sdev, u8 want, u8 need);
41 extern void zfcp_dbf_rec_run(char *, struct zfcp_erp_action *);
42 extern void zfcp_dbf_rec_run_lvl(int level, char *tag,
43 				 struct zfcp_erp_action *erp);
44 extern void zfcp_dbf_rec_run_wka(char *, struct zfcp_fc_wka_port *, u64);
45 extern void zfcp_dbf_hba_fsf_uss(char *, struct zfcp_fsf_req *);
46 extern void zfcp_dbf_hba_fsf_res(char *, int, struct zfcp_fsf_req *);
47 extern void zfcp_dbf_hba_fsf_fces(char *tag, const struct zfcp_fsf_req *req,
48 				  u64 wwpn, u32 fc_security_old,
49 				  u32 fc_security_new);
50 extern void zfcp_dbf_hba_bit_err(char *, struct zfcp_fsf_req *);
51 extern void zfcp_dbf_hba_def_err(struct zfcp_adapter *, u64, u16, void **);
52 extern void zfcp_dbf_hba_basic(char *, struct zfcp_adapter *);
53 extern void zfcp_dbf_san_req(char *, struct zfcp_fsf_req *, u32);
54 extern void zfcp_dbf_san_res(char *, struct zfcp_fsf_req *);
55 extern void zfcp_dbf_san_in_els(char *, struct zfcp_fsf_req *);
56 extern void zfcp_dbf_scsi_common(char *tag, int level, struct scsi_device *sdev,
57 				 struct scsi_cmnd *sc,
58 				 struct zfcp_fsf_req *fsf);
59 extern void zfcp_dbf_scsi_eh(char *tag, struct zfcp_adapter *adapter,
60 			     unsigned int scsi_id, int ret);
61 
62 /* zfcp_erp.c */
63 extern void zfcp_erp_set_adapter_status(struct zfcp_adapter *, u32);
64 extern void zfcp_erp_clear_adapter_status(struct zfcp_adapter *, u32);
65 extern void zfcp_erp_port_forced_no_port_dbf(char *dbftag,
66 					     struct zfcp_adapter *adapter,
67 					     u64 port_name, u32 port_id);
68 extern void zfcp_erp_adapter_reopen(struct zfcp_adapter *, int, char *);
69 extern void zfcp_erp_adapter_shutdown(struct zfcp_adapter *, int, char *);
70 extern void zfcp_erp_set_port_status(struct zfcp_port *, u32);
71 extern void zfcp_erp_clear_port_status(struct zfcp_port *, u32);
72 extern void zfcp_erp_port_reopen(struct zfcp_port *port, int clear,
73 				 char *dbftag);
74 extern void zfcp_erp_port_shutdown(struct zfcp_port *, int, char *);
75 extern void zfcp_erp_port_forced_reopen(struct zfcp_port *, int, char *);
76 extern void zfcp_erp_port_forced_reopen_all(struct zfcp_adapter *adapter,
77 					    int clear, char *dbftag);
78 extern void zfcp_erp_set_lun_status(struct scsi_device *, u32);
79 extern void zfcp_erp_clear_lun_status(struct scsi_device *, u32);
80 extern void zfcp_erp_lun_reopen(struct scsi_device *, int, char *);
81 extern void zfcp_erp_lun_shutdown(struct scsi_device *, int, char *);
82 extern void zfcp_erp_lun_shutdown_wait(struct scsi_device *, char *);
83 extern int  zfcp_erp_thread_setup(struct zfcp_adapter *);
84 extern void zfcp_erp_thread_kill(struct zfcp_adapter *);
85 extern void zfcp_erp_wait(struct zfcp_adapter *);
86 extern void zfcp_erp_notify(struct zfcp_erp_action *, unsigned long);
87 extern void zfcp_erp_timeout_handler(struct timer_list *t);
88 extern void zfcp_erp_adapter_reset_sync(struct zfcp_adapter *adapter,
89 					char *dbftag);
90 
91 /* zfcp_fc.c */
92 extern struct kmem_cache *zfcp_fc_req_cache;
93 extern void zfcp_fc_enqueue_event(struct zfcp_adapter *,
94 				enum fc_host_event_code event_code, u32);
95 extern void zfcp_fc_post_event(struct work_struct *);
96 extern void zfcp_fc_scan_ports(struct work_struct *);
97 extern void zfcp_fc_incoming_els(struct zfcp_fsf_req *);
98 extern void zfcp_fc_port_did_lookup(struct work_struct *);
99 extern void zfcp_fc_trigger_did_lookup(struct zfcp_port *);
100 extern void zfcp_fc_plogi_evaluate(struct zfcp_port *, struct fc_els_flogi *);
101 extern void zfcp_fc_test_link(struct zfcp_port *);
102 extern void zfcp_fc_link_test_work(struct work_struct *);
103 extern void zfcp_fc_wka_ports_force_offline(struct zfcp_fc_wka_ports *);
104 extern int zfcp_fc_gs_setup(struct zfcp_adapter *);
105 extern void zfcp_fc_gs_destroy(struct zfcp_adapter *);
106 extern int zfcp_fc_exec_bsg_job(struct bsg_job *);
107 extern int zfcp_fc_timeout_bsg_job(struct bsg_job *);
108 extern void zfcp_fc_sym_name_update(struct work_struct *);
109 extern unsigned int zfcp_fc_port_scan_backoff(void);
110 extern void zfcp_fc_conditional_port_scan(struct zfcp_adapter *);
111 extern void zfcp_fc_inverse_conditional_port_scan(struct zfcp_adapter *);
112 
113 /* zfcp_fsf.c */
114 extern struct kmem_cache *zfcp_fsf_qtcb_cache;
115 extern int zfcp_fsf_open_port(struct zfcp_erp_action *);
116 extern int zfcp_fsf_open_wka_port(struct zfcp_fc_wka_port *);
117 extern int zfcp_fsf_close_wka_port(struct zfcp_fc_wka_port *);
118 extern int zfcp_fsf_close_port(struct zfcp_erp_action *);
119 extern int zfcp_fsf_close_physical_port(struct zfcp_erp_action *);
120 extern int zfcp_fsf_open_lun(struct zfcp_erp_action *);
121 extern int zfcp_fsf_close_lun(struct zfcp_erp_action *);
122 extern int zfcp_fsf_exchange_config_data(struct zfcp_erp_action *);
123 extern int zfcp_fsf_exchange_config_data_sync(struct zfcp_qdio *,
124 					      struct fsf_qtcb_bottom_config *);
125 extern int zfcp_fsf_exchange_port_data(struct zfcp_erp_action *);
126 extern int zfcp_fsf_exchange_port_data_sync(struct zfcp_qdio *,
127 					    struct fsf_qtcb_bottom_port *);
128 extern u32 zfcp_fsf_convert_portspeed(u32 fsf_speed);
129 extern void zfcp_fsf_req_dismiss_all(struct zfcp_adapter *);
130 extern int zfcp_fsf_status_read(struct zfcp_qdio *);
131 extern int zfcp_status_read_refill(struct zfcp_adapter *adapter);
132 extern int zfcp_fsf_send_ct(struct zfcp_fc_wka_port *, struct zfcp_fsf_ct_els *,
133 			    mempool_t *, unsigned int);
134 extern int zfcp_fsf_send_els(struct zfcp_adapter *, u32,
135 			     struct zfcp_fsf_ct_els *, unsigned int);
136 extern int zfcp_fsf_fcp_cmnd(struct scsi_cmnd *);
137 extern void zfcp_fsf_req_free(struct zfcp_fsf_req *);
138 extern void zfcp_fsf_fc_host_link_down(struct zfcp_adapter *adapter);
139 extern struct zfcp_fsf_req *zfcp_fsf_fcp_task_mgmt(struct scsi_device *sdev,
140 						   u8 tm_flags);
141 extern struct zfcp_fsf_req *zfcp_fsf_abort_fcp_cmnd(struct scsi_cmnd *);
142 extern void zfcp_fsf_reqid_check(struct zfcp_qdio *, int);
143 enum zfcp_fsf_print_fmt {
144 	ZFCP_FSF_PRINT_FMT_LIST,
145 	ZFCP_FSF_PRINT_FMT_SINGLEITEM,
146 };
147 extern ssize_t zfcp_fsf_scnprint_fc_security(char *buf, size_t size,
148 					     u32 fc_security,
149 					     enum zfcp_fsf_print_fmt fmt);
150 
151 /* zfcp_qdio.c */
152 extern int zfcp_qdio_setup(struct zfcp_adapter *);
153 extern void zfcp_qdio_destroy(struct zfcp_qdio *);
154 extern int zfcp_qdio_sbal_get(struct zfcp_qdio *);
155 extern int zfcp_qdio_send(struct zfcp_qdio *, struct zfcp_qdio_req *);
156 extern int zfcp_qdio_sbals_from_sg(struct zfcp_qdio *, struct zfcp_qdio_req *,
157 				   struct scatterlist *);
158 extern void zfcp_qdio_shost_update(struct zfcp_adapter *const adapter,
159 				   const struct zfcp_qdio *const qdio);
160 extern int zfcp_qdio_open(struct zfcp_qdio *);
161 extern void zfcp_qdio_close(struct zfcp_qdio *);
162 extern void zfcp_qdio_siosl(struct zfcp_adapter *);
163 
164 /* zfcp_scsi.c */
165 extern bool zfcp_experimental_dix;
166 extern struct scsi_transport_template *zfcp_scsi_transport_template;
167 extern int zfcp_scsi_adapter_register(struct zfcp_adapter *);
168 extern void zfcp_scsi_adapter_unregister(struct zfcp_adapter *);
169 extern struct fc_function_template zfcp_transport_functions;
170 extern void zfcp_scsi_rport_work(struct work_struct *);
171 extern void zfcp_scsi_schedule_rport_register(struct zfcp_port *);
172 extern void zfcp_scsi_schedule_rport_block(struct zfcp_port *);
173 extern void zfcp_scsi_schedule_rports_block(struct zfcp_adapter *);
174 extern void zfcp_scsi_set_prot(struct zfcp_adapter *);
175 extern void zfcp_scsi_dif_sense_error(struct scsi_cmnd *, int);
176 extern void zfcp_scsi_shost_update_config_data(
177 	struct zfcp_adapter *const adapter,
178 	const struct fsf_qtcb_bottom_config *const bottom,
179 	const bool bottom_incomplete);
180 extern void zfcp_scsi_shost_update_port_data(
181 	struct zfcp_adapter *const adapter,
182 	const struct fsf_qtcb_bottom_port *const bottom);
183 
184 /* zfcp_sysfs.c */
185 extern const struct attribute_group *zfcp_unit_attr_groups[];
186 extern struct attribute_group zfcp_sysfs_adapter_attrs;
187 extern const struct attribute_group *zfcp_port_attr_groups[];
188 extern struct mutex zfcp_sysfs_port_units_mutex;
189 extern struct device_attribute *zfcp_sysfs_sdev_attrs[];
190 extern struct device_attribute *zfcp_sysfs_shost_attrs[];
191 extern const struct attribute_group zfcp_sysfs_diag_attr_group;
192 bool zfcp_sysfs_port_is_removing(const struct zfcp_port *const port);
193 
194 /* zfcp_unit.c */
195 extern int zfcp_unit_add(struct zfcp_port *, u64);
196 extern int zfcp_unit_remove(struct zfcp_port *, u64);
197 extern struct zfcp_unit *zfcp_unit_find(struct zfcp_port *, u64);
198 extern struct scsi_device *zfcp_unit_sdev(struct zfcp_unit *unit);
199 extern void zfcp_unit_scsi_scan(struct zfcp_unit *);
200 extern void zfcp_unit_queue_scsi_scan(struct zfcp_port *);
201 extern unsigned int zfcp_unit_sdev_status(struct zfcp_unit *);
202 
203 #endif	/* ZFCP_EXT_H */
204