zfcp_ext.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * zfcp device driver
  4 *
  5 * External function declarations.
  6 *
  7 * Copyright IBM Corp. 2002, 2023
  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_fsf_reqid(const char *const tag, const int level,
 50				   struct zfcp_adapter *const adapter,
 51				   const u64 req_id);
 52extern void zfcp_dbf_hba_bit_err(char *, struct zfcp_fsf_req *);
 53extern void zfcp_dbf_hba_def_err(struct zfcp_adapter *, u64, u16, void **);
 54extern void zfcp_dbf_san_req(char *, struct zfcp_fsf_req *, u32);
 55extern void zfcp_dbf_san_res(char *, struct zfcp_fsf_req *);
 56extern void zfcp_dbf_san_in_els(char *, struct zfcp_fsf_req *);
 57extern void zfcp_dbf_scsi_common(char *tag, int level, struct scsi_device *sdev,
 58				 struct scsi_cmnd *sc,
 59				 struct zfcp_fsf_req *fsf);
 60extern void zfcp_dbf_scsi_eh(char *tag, struct zfcp_adapter *adapter,
 61			     unsigned int scsi_id, int ret);
 62
 63/* zfcp_erp.c */
 64extern void zfcp_erp_set_adapter_status(struct zfcp_adapter *, u32);
 65extern void zfcp_erp_clear_adapter_status(struct zfcp_adapter *, u32);
 66extern void zfcp_erp_port_forced_no_port_dbf(char *dbftag,
 67					     struct zfcp_adapter *adapter,
 68					     u64 port_name, u32 port_id);
 69extern void zfcp_erp_adapter_reopen(struct zfcp_adapter *, int, char *);
 70extern void zfcp_erp_adapter_shutdown(struct zfcp_adapter *, int, char *);
 71extern void zfcp_erp_set_port_status(struct zfcp_port *, u32);
 72extern void zfcp_erp_clear_port_status(struct zfcp_port *, u32);
 73extern void zfcp_erp_port_reopen(struct zfcp_port *port, int clear,
 74				 char *dbftag);
 75extern void zfcp_erp_port_shutdown(struct zfcp_port *, int, char *);
 76extern void zfcp_erp_port_forced_reopen(struct zfcp_port *, int, char *);
 77extern void zfcp_erp_port_forced_reopen_all(struct zfcp_adapter *adapter,
 78					    int clear, char *dbftag);
 79extern void zfcp_erp_set_lun_status(struct scsi_device *, u32);
 80extern void zfcp_erp_clear_lun_status(struct scsi_device *, u32);
 81extern void zfcp_erp_lun_reopen(struct scsi_device *, int, char *);
 82extern void zfcp_erp_lun_shutdown(struct scsi_device *, int, char *);
 83extern void zfcp_erp_lun_shutdown_wait(struct scsi_device *, char *);
 84extern int  zfcp_erp_thread_setup(struct zfcp_adapter *);
 85extern void zfcp_erp_thread_kill(struct zfcp_adapter *);
 86extern void zfcp_erp_wait(struct zfcp_adapter *);
 87extern void zfcp_erp_notify(struct zfcp_erp_action *, unsigned long);
 88extern void zfcp_erp_timeout_handler(struct timer_list *t);
 89extern void zfcp_erp_adapter_reset_sync(struct zfcp_adapter *adapter,
 90					char *dbftag);
 91
 92/* zfcp_fc.c */
 93extern struct kmem_cache *zfcp_fc_req_cache;
 94extern void zfcp_fc_enqueue_event(struct zfcp_adapter *,
 95				enum fc_host_event_code event_code, u32);
 96extern void zfcp_fc_post_event(struct work_struct *);
 97extern void zfcp_fc_scan_ports(struct work_struct *);
 98extern void zfcp_fc_incoming_els(struct zfcp_fsf_req *);
 99extern void zfcp_fc_port_did_lookup(struct work_struct *);
100extern void zfcp_fc_trigger_did_lookup(struct zfcp_port *);
101extern void zfcp_fc_plogi_evaluate(struct zfcp_port *, struct fc_els_flogi *);
102extern void zfcp_fc_test_link(struct zfcp_port *);
103extern void zfcp_fc_link_test_work(struct work_struct *);
104extern void zfcp_fc_wka_ports_force_offline(struct zfcp_fc_wka_ports *);
105extern int zfcp_fc_gs_setup(struct zfcp_adapter *);
106extern void zfcp_fc_gs_destroy(struct zfcp_adapter *);
107extern int zfcp_fc_exec_bsg_job(struct bsg_job *);
108extern int zfcp_fc_timeout_bsg_job(struct bsg_job *);
109extern void zfcp_fc_sym_name_update(struct work_struct *);
110extern unsigned int zfcp_fc_port_scan_backoff(void);
111extern void zfcp_fc_conditional_port_scan(struct zfcp_adapter *);
112extern void zfcp_fc_inverse_conditional_port_scan(struct zfcp_adapter *);
113
114/* zfcp_fsf.c */
115extern struct kmem_cache *zfcp_fsf_qtcb_cache;
116extern int zfcp_fsf_open_port(struct zfcp_erp_action *);
117extern int zfcp_fsf_open_wka_port(struct zfcp_fc_wka_port *);
118extern int zfcp_fsf_close_wka_port(struct zfcp_fc_wka_port *);
119extern int zfcp_fsf_close_port(struct zfcp_erp_action *);
120extern int zfcp_fsf_close_physical_port(struct zfcp_erp_action *);
121extern int zfcp_fsf_open_lun(struct zfcp_erp_action *);
122extern int zfcp_fsf_close_lun(struct zfcp_erp_action *);
123extern int zfcp_fsf_exchange_config_data(struct zfcp_erp_action *);
124extern int zfcp_fsf_exchange_config_data_sync(struct zfcp_qdio *,
125					      struct fsf_qtcb_bottom_config *);
126extern int zfcp_fsf_exchange_port_data(struct zfcp_erp_action *);
127extern int zfcp_fsf_exchange_port_data_sync(struct zfcp_qdio *,
128					    struct fsf_qtcb_bottom_port *);
129extern u32 zfcp_fsf_convert_portspeed(u32 fsf_speed);
130extern void zfcp_fsf_req_dismiss_all(struct zfcp_adapter *);
131extern int zfcp_fsf_status_read(struct zfcp_qdio *);
132extern int zfcp_status_read_refill(struct zfcp_adapter *adapter);
133extern int zfcp_fsf_send_ct(struct zfcp_fc_wka_port *, struct zfcp_fsf_ct_els *,
134			    mempool_t *, unsigned int);
135extern int zfcp_fsf_send_els(struct zfcp_adapter *, u32,
136			     struct zfcp_fsf_ct_els *, unsigned int);
137extern int zfcp_fsf_fcp_cmnd(struct scsi_cmnd *);
138extern void zfcp_fsf_req_free(struct zfcp_fsf_req *);
139extern void zfcp_fsf_fc_host_link_down(struct zfcp_adapter *adapter);
140extern struct zfcp_fsf_req *zfcp_fsf_fcp_task_mgmt(struct scsi_device *sdev,
141						   u8 tm_flags);
142extern struct zfcp_fsf_req *zfcp_fsf_abort_fcp_cmnd(struct scsi_cmnd *);
143extern void zfcp_fsf_reqid_check(struct zfcp_qdio *, int);
144enum zfcp_fsf_print_fmt {
145	ZFCP_FSF_PRINT_FMT_LIST,
146	ZFCP_FSF_PRINT_FMT_SINGLEITEM,
147};
148extern ssize_t zfcp_fsf_scnprint_fc_security(char *buf, size_t size,
149					     u32 fc_security,
150					     enum zfcp_fsf_print_fmt fmt);
151
152/* zfcp_qdio.c */
153extern int zfcp_qdio_setup(struct zfcp_adapter *);
154extern void zfcp_qdio_destroy(struct zfcp_qdio *);
155extern int zfcp_qdio_sbal_get(struct zfcp_qdio *);
156extern int zfcp_qdio_send(struct zfcp_qdio *, struct zfcp_qdio_req *);
157extern int zfcp_qdio_sbals_from_sg(struct zfcp_qdio *, struct zfcp_qdio_req *,
158				   struct scatterlist *);
159extern void zfcp_qdio_shost_update(struct zfcp_adapter *const adapter,
160				   const struct zfcp_qdio *const qdio);
161extern int zfcp_qdio_open(struct zfcp_qdio *);
162extern void zfcp_qdio_close(struct zfcp_qdio *);
163extern void zfcp_qdio_siosl(struct zfcp_adapter *);
164
165/* zfcp_scsi.c */
166extern bool zfcp_experimental_dix;
167extern struct scsi_transport_template *zfcp_scsi_transport_template;
168extern int zfcp_scsi_adapter_register(struct zfcp_adapter *);
169extern void zfcp_scsi_adapter_unregister(struct zfcp_adapter *);
170extern struct fc_function_template zfcp_transport_functions;
171extern void zfcp_scsi_rport_work(struct work_struct *);
172extern void zfcp_scsi_schedule_rport_register(struct zfcp_port *);
173extern void zfcp_scsi_schedule_rport_block(struct zfcp_port *);
174extern void zfcp_scsi_schedule_rports_block(struct zfcp_adapter *);
175extern void zfcp_scsi_set_prot(struct zfcp_adapter *);
176extern void zfcp_scsi_dif_sense_error(struct scsi_cmnd *, int);
177extern void zfcp_scsi_shost_update_config_data(
178	struct zfcp_adapter *const adapter,
179	const struct fsf_qtcb_bottom_config *const bottom,
180	const bool bottom_incomplete);
181extern void zfcp_scsi_shost_update_port_data(
182	struct zfcp_adapter *const adapter,
183	const struct fsf_qtcb_bottom_port *const bottom);
184
185/* zfcp_sysfs.c */
186extern const struct attribute_group *zfcp_sysfs_adapter_attr_groups[];
187extern const struct attribute_group *zfcp_unit_attr_groups[];
188extern const struct attribute_group *zfcp_port_attr_groups[];
189extern struct mutex zfcp_sysfs_port_units_mutex;
190extern const struct attribute_group *zfcp_sysfs_sdev_attr_groups[];
191extern const struct attribute_group *zfcp_sysfs_shost_attr_groups[];
192bool zfcp_sysfs_port_is_removing(const struct zfcp_port *const port);
193
194/* zfcp_unit.c */
195extern int zfcp_unit_add(struct zfcp_port *, u64);
196extern int zfcp_unit_remove(struct zfcp_port *, u64);
197extern struct zfcp_unit *zfcp_unit_find(struct zfcp_port *, u64);
198extern struct scsi_device *zfcp_unit_sdev(struct zfcp_unit *unit);
199extern void zfcp_unit_scsi_scan(struct zfcp_unit *);
200extern void zfcp_unit_queue_scsi_scan(struct zfcp_port *);
201extern unsigned int zfcp_unit_sdev_status(struct zfcp_unit *);
202
203#endif	/* ZFCP_EXT_H */