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