1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
4 * Copyright (c) 2014- QLogic Corporation.
5 * All rights reserved
6 * www.qlogic.com
7 *
8 * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
9 */
10
11/*
12 * Contains base driver definitions.
13 */
14
15/*
16 *  bfa_drv.h Linux driver data structures.
17 */
18
19#ifndef __BFAD_DRV_H__
20#define __BFAD_DRV_H__
21
22#include <linux/types.h>
23#include <linux/pci.h>
24#include <linux/dma-mapping.h>
25#include <linux/idr.h>
26#include <linux/interrupt.h>
27#include <linux/cdev.h>
28#include <linux/fs.h>
29#include <linux/delay.h>
30#include <linux/vmalloc.h>
31#include <linux/workqueue.h>
32#include <linux/bitops.h>
33#include <scsi/scsi.h>
34#include <scsi/scsi_host.h>
35#include <scsi/scsi_tcq.h>
36#include <scsi/scsi_transport_fc.h>
37#include <scsi/scsi_transport.h>
38#include <scsi/scsi_bsg_fc.h>
39#include <scsi/scsi_devinfo.h>
40
41#include "bfa_modules.h"
42#include "bfa_fcs.h"
43#include "bfa_defs_fcs.h"
44
45#include "bfa_plog.h"
46#include "bfa_cs.h"
47
48#define BFAD_DRIVER_NAME	"bfa"
49#ifdef BFA_DRIVER_VERSION
50#define BFAD_DRIVER_VERSION    BFA_DRIVER_VERSION
51#else
52#define BFAD_DRIVER_VERSION    "3.2.25.1"
53#endif
54
55#define BFAD_PROTO_NAME FCPI_NAME
56#define BFAD_IRQ_FLAGS IRQF_SHARED
57
58#ifndef FC_PORTSPEED_8GBIT
59#define FC_PORTSPEED_8GBIT 0x10
60#endif
61
62/*
63 * BFAD flags
64 */
65#define BFAD_MSIX_ON				0x00000001
66#define BFAD_HAL_INIT_DONE			0x00000002
67#define BFAD_DRV_INIT_DONE			0x00000004
68#define BFAD_CFG_PPORT_DONE			0x00000008
69#define BFAD_HAL_START_DONE			0x00000010
70#define BFAD_PORT_ONLINE			0x00000020
71#define BFAD_RPORT_ONLINE			0x00000040
72#define BFAD_FCS_INIT_DONE			0x00000080
73#define BFAD_HAL_INIT_FAIL			0x00000100
74#define BFAD_FC4_PROBE_DONE			0x00000200
75#define BFAD_PORT_DELETE			0x00000001
76#define BFAD_INTX_ON				0x00000400
77#define BFAD_EEH_BUSY				0x00000800
78#define BFAD_EEH_PCI_CHANNEL_IO_PERM_FAILURE	0x00001000
79/*
80 * BFAD related definition
81 */
82#define SCSI_SCAN_DELAY		HZ
83#define BFAD_STOP_TIMEOUT	30
84#define BFAD_SUSPEND_TIMEOUT	BFAD_STOP_TIMEOUT
85
86/*
87 * BFAD configuration parameter default values
88 */
89#define BFAD_LUN_QUEUE_DEPTH	32
90#define BFAD_IO_MAX_SGE		SG_ALL
91#define BFAD_MIN_SECTORS	128 /* 64k   */
92#define BFAD_MAX_SECTORS	0xFFFF  /* 32 MB */
93
94#define bfad_isr_t irq_handler_t
95
96#define MAX_MSIX_ENTRY 22
97
98struct bfad_msix_s {
99	struct bfad_s *bfad;
100	struct msix_entry msix;
101	char name[32];
102};
103
104/*
105 * Only append to the enums defined here to avoid any versioning
106 * needed between trace utility and driver version
107 */
108enum {
109	BFA_TRC_LDRV_BFAD		= 1,
110	BFA_TRC_LDRV_IM			= 2,
111	BFA_TRC_LDRV_BSG		= 3,
112};
113
114enum bfad_port_pvb_type {
115	BFAD_PORT_PHYS_BASE = 0,
116	BFAD_PORT_PHYS_VPORT = 1,
117	BFAD_PORT_VF_BASE = 2,
118	BFAD_PORT_VF_VPORT = 3,
119};
120
121/*
122 * PORT data structure
123 */
124struct bfad_port_s {
125	struct list_head list_entry;
126	struct bfad_s	*bfad;
127	struct bfa_fcs_lport_s *fcs_port;
128	u32	roles;
129	s32		flags;
130	u32	supported_fc4s;
131	enum bfad_port_pvb_type pvb_type;
132	struct bfad_im_port_s *im_port;	/* IM specific data */
133	/* port debugfs specific data */
134	struct dentry *port_debugfs_root;
135};
136
137/*
138 * VPORT data structure
139 */
140struct bfad_vport_s {
141	struct bfad_port_s     drv_port;
142	struct bfa_fcs_vport_s fcs_vport;
143	struct completion *comp_del;
144	struct list_head list_entry;
145};
146
147/*
148 * VF data structure
149 */
150struct bfad_vf_s {
151	bfa_fcs_vf_t    fcs_vf;
152	struct bfad_port_s    base_port;	/* base port for vf */
153	struct bfad_s   *bfad;
154};
155
156struct bfad_cfg_param_s {
157	u32	rport_del_timeout;
158	u32	ioc_queue_depth;
159	u32	lun_queue_depth;
160	u32	io_max_sge;
161	u32	binding_method;
162};
163
164union bfad_tmp_buf {
165	/* From struct bfa_adapter_attr_s */
166	char		manufacturer[BFA_ADAPTER_MFG_NAME_LEN];
167	char		serial_num[BFA_ADAPTER_SERIAL_NUM_LEN];
168	char		model[BFA_ADAPTER_MODEL_NAME_LEN];
169	char		fw_ver[BFA_VERSION_LEN];
170	char		optrom_ver[BFA_VERSION_LEN];
171
172	/* From struct bfa_ioc_pci_attr_s */
173	u8		chip_rev[BFA_IOC_CHIP_REV_LEN];  /*  chip revision */
174
175	wwn_t		wwn[BFA_FCS_MAX_LPORTS];
176};
177
178/*
179 * BFAD (PCI function) data structure
180 */
181struct bfad_s {
182	bfa_sm_t	sm;	/* state machine */
183	struct list_head list_entry;
184	struct bfa_s	bfa;
185	struct bfa_fcs_s bfa_fcs;
186	struct pci_dev *pcidev;
187	const char *pci_name;
188	struct bfa_pcidev_s hal_pcidev;
189	struct bfa_ioc_pci_attr_s pci_attr;
190	void __iomem   *pci_bar0_kva;
191	void __iomem   *pci_bar2_kva;
192	struct completion comp;
193	struct completion suspend;
194	struct completion enable_comp;
195	struct completion disable_comp;
196	bfa_boolean_t   disable_active;
197	struct bfad_port_s     pport;	/* physical port of the BFAD */
198	struct bfa_meminfo_s meminfo;
199	struct bfa_iocfc_cfg_s   ioc_cfg;
200	u32	inst_no;	/* BFAD instance number */
201	u32	bfad_flags;
202	spinlock_t      bfad_lock;
203	struct task_struct *bfad_tsk;
204	struct bfad_cfg_param_s cfg_data;
205	struct bfad_msix_s msix_tab[MAX_MSIX_ENTRY];
206	int		nvec;
207	char	adapter_name[BFA_ADAPTER_SYM_NAME_LEN];
208	char	port_name[BFA_ADAPTER_SYM_NAME_LEN];
209	struct timer_list hal_tmo;
210	unsigned long   hs_start;
211	struct bfad_im_s *im;		/* IM specific data */
212	struct bfa_trc_mod_s  *trcmod;
213	struct bfa_plog_s      plog_buf;
214	int		ref_count;
215	union bfad_tmp_buf tmp_buf;
216	struct fc_host_statistics link_stats;
217	struct list_head pbc_vport_list;
218	/* debugfs specific data */
219	char *regdata;
220	u32 reglen;
221	struct dentry *bfad_dentry_files[5];
222	struct list_head	free_aen_q;
223	struct list_head	active_aen_q;
224	struct bfa_aen_entry_s	aen_list[BFA_AEN_MAX_ENTRY];
225	spinlock_t		bfad_aen_spinlock;
226	struct list_head	vport_list;
227};
228
229/* BFAD state machine events */
230enum bfad_sm_event {
231	BFAD_E_CREATE			= 1,
232	BFAD_E_KTHREAD_CREATE_FAILED	= 2,
233	BFAD_E_INIT			= 3,
234	BFAD_E_INIT_SUCCESS		= 4,
235	BFAD_E_HAL_INIT_FAILED		= 5,
236	BFAD_E_INIT_FAILED		= 6,
237	BFAD_E_FCS_EXIT_COMP		= 7,
238	BFAD_E_EXIT_COMP		= 8,
239	BFAD_E_STOP			= 9
240};
241
242/*
243 * RPORT data structure
244 */
245struct bfad_rport_s {
246	struct bfa_fcs_rport_s fcs_rport;
247};
248
249struct bfad_buf_info {
250	void		*virt;
251	dma_addr_t      phys;
252	u32	size;
253};
254
255struct bfad_fcxp {
256	struct bfad_port_s    *port;
257	struct bfa_rport_s *bfa_rport;
258	bfa_status_t    req_status;
259	u16	tag;
260	u16	rsp_len;
261	u16	rsp_maxlen;
262	u8		use_ireqbuf;
263	u8		use_irspbuf;
264	u32	num_req_sgles;
265	u32	num_rsp_sgles;
266	struct fchs_s	fchs;
267	void		*reqbuf_info;
268	void		*rspbuf_info;
269	struct bfa_sge_s  *req_sge;
270	struct bfa_sge_s  *rsp_sge;
271	fcxp_send_cb_t  send_cbfn;
272	void		*send_cbarg;
273	void		*bfa_fcxp;
274	struct completion comp;
275};
276
277struct bfad_hal_comp {
278	bfa_status_t    status;
279	struct completion comp;
280};
281
282#define BFA_LOG(level, bfad, mask, fmt, arg...)				\
283do {									\
284	if (((mask) == 4) || (level[1] <= '4'))				\
285		dev_printk(level, &((bfad)->pcidev)->dev, fmt, ##arg);	\
286} while (0)
287
288bfa_status_t	bfad_vport_create(struct bfad_s *bfad, u16 vf_id,
289				  struct bfa_lport_cfg_s *port_cfg,
290				  struct device *dev);
291bfa_status_t	bfad_vf_create(struct bfad_s *bfad, u16 vf_id,
292			       struct bfa_lport_cfg_s *port_cfg);
293bfa_status_t	bfad_cfg_pport(struct bfad_s *bfad, enum bfa_lport_role role);
294bfa_status_t	bfad_drv_init(struct bfad_s *bfad);
295bfa_status_t	bfad_start_ops(struct bfad_s *bfad);
296void		bfad_drv_start(struct bfad_s *bfad);
297void		bfad_uncfg_pport(struct bfad_s *bfad);
298void		bfad_stop(struct bfad_s *bfad);
299void		bfad_fcs_stop(struct bfad_s *bfad);
300void		bfad_remove_intr(struct bfad_s *bfad);
301void		bfad_hal_mem_release(struct bfad_s *bfad);
302void		bfad_hcb_comp(void *arg, bfa_status_t status);
303
304int		bfad_setup_intr(struct bfad_s *bfad);
305void		bfad_remove_intr(struct bfad_s *bfad);
306void		bfad_update_hal_cfg(struct bfa_iocfc_cfg_s *bfa_cfg);
307bfa_status_t	bfad_hal_mem_alloc(struct bfad_s *bfad);
308void		bfad_bfa_tmo(struct timer_list *t);
309void		bfad_init_timer(struct bfad_s *bfad);
310int		bfad_pci_init(struct pci_dev *pdev, struct bfad_s *bfad);
311void		bfad_pci_uninit(struct pci_dev *pdev, struct bfad_s *bfad);
312void		bfad_drv_uninit(struct bfad_s *bfad);
313int		bfad_worker(void *ptr);
314void		bfad_debugfs_init(struct bfad_port_s *port);
315void		bfad_debugfs_exit(struct bfad_port_s *port);
316
317void bfad_pci_remove(struct pci_dev *pdev);
318int bfad_pci_probe(struct pci_dev *pdev, const struct pci_device_id *pid);
319void bfad_rport_online_wait(struct bfad_s *bfad);
320int bfad_get_linkup_delay(struct bfad_s *bfad);
321int bfad_install_msix_handler(struct bfad_s *bfad);
322
323extern struct idr bfad_im_port_index;
324extern struct pci_device_id bfad_id_table[];
325extern struct list_head bfad_list;
326extern char	*os_name;
327extern char	*os_patch;
328extern char	*host_name;
329extern int	num_rports;
330extern int	num_ios;
331extern int	num_tms;
332extern int	num_fcxps;
333extern int	num_ufbufs;
334extern int	reqq_size;
335extern int	rspq_size;
336extern int	num_sgpgs;
337extern int      rport_del_timeout;
338extern int      bfa_lun_queue_depth;
339extern int      bfa_io_max_sge;
340extern int      bfa_log_level;
341extern int      ioc_auto_recover;
342extern int      bfa_linkup_delay;
343extern int      msix_disable_cb;
344extern int      msix_disable_ct;
345extern int      fdmi_enable;
346extern int      supported_fc4s;
347extern int	pcie_max_read_reqsz;
348extern int	max_xfer_size;
349extern int bfa_debugfs_enable;
350extern struct mutex bfad_mutex;
351
352#endif /* __BFAD_DRV_H__ */
353