1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
4 * Copyright (c) 2014- QLogic Corporation.
8 * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
12 * Contains base driver definitions.
16 * bfa_drv.h Linux driver data structures.
19 #ifndef __BFAD_DRV_H__
20 #define __BFAD_DRV_H__
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>
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>
41 #include "bfa_modules.h"
43 #include "bfa_defs_fcs.h"
48 #define BFAD_DRIVER_NAME "bfa"
49 #ifdef BFA_DRIVER_VERSION
50 #define BFAD_DRIVER_VERSION BFA_DRIVER_VERSION
52 #define BFAD_DRIVER_VERSION "3.2.25.1"
55 #define BFAD_PROTO_NAME FCPI_NAME
56 #define BFAD_IRQ_FLAGS IRQF_SHARED
58 #ifndef FC_PORTSPEED_8GBIT
59 #define FC_PORTSPEED_8GBIT 0x10
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
80 * BFAD related definition
82 #define SCSI_SCAN_DELAY HZ
83 #define BFAD_STOP_TIMEOUT 30
84 #define BFAD_SUSPEND_TIMEOUT BFAD_STOP_TIMEOUT
87 * BFAD configuration parameter default values
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 */
94 #define bfad_isr_t irq_handler_t
96 #define MAX_MSIX_ENTRY 22
100 struct msix_entry msix;
105 * Only append to the enums defined here to avoid any versioning
106 * needed between trace utility and driver version
109 BFA_TRC_LDRV_BFAD = 1,
111 BFA_TRC_LDRV_BSG = 3,
114 enum 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,
122 * PORT data structure
125 struct list_head list_entry;
127 struct bfa_fcs_lport_s *fcs_port;
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;
138 * VPORT data structure
140 struct 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;
152 struct bfad_port_s base_port; /* base port for vf */
156 struct bfad_cfg_param_s {
157 u32 rport_del_timeout;
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];
172 /* From struct bfa_ioc_pci_attr_s */
173 u8 chip_rev[BFA_IOC_CHIP_REV_LEN]; /* chip revision */
175 wwn_t wwn[BFA_FCS_MAX_LPORTS];
179 * BFAD (PCI function) data structure
182 bfa_sm_t sm; /* state machine */
183 struct list_head list_entry;
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 */
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];
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;
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 */
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;
229 /* BFAD state machine events */
232 BFAD_E_KTHREAD_CREATE_FAILED = 2,
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,
243 * RPORT data structure
245 struct bfad_rport_s {
246 struct bfa_fcs_rport_s fcs_rport;
249 struct bfad_buf_info {
256 struct bfad_port_s *port;
257 struct bfa_rport_s *bfa_rport;
258 bfa_status_t req_status;
269 struct bfa_sge_s *req_sge;
270 struct bfa_sge_s *rsp_sge;
271 fcxp_send_cb_t send_cbfn;
274 struct completion comp;
277 struct bfad_hal_comp {
279 struct completion comp;
282 #define BFA_LOG(level, bfad, mask, fmt, arg...) \
284 if (((mask) == 4) || (level[1] <= '4')) \
285 dev_printk(level, &((bfad)->pcidev)->dev, fmt, ##arg); \
288 bfa_status_t bfad_vport_create(struct bfad_s *bfad, u16 vf_id,
289 struct bfa_lport_cfg_s *port_cfg,
291 bfa_status_t bfad_vf_create(struct bfad_s *bfad, u16 vf_id,
292 struct bfa_lport_cfg_s *port_cfg);
293 bfa_status_t bfad_cfg_pport(struct bfad_s *bfad, enum bfa_lport_role role);
294 bfa_status_t bfad_drv_init(struct bfad_s *bfad);
295 bfa_status_t bfad_start_ops(struct bfad_s *bfad);
296 void bfad_drv_start(struct bfad_s *bfad);
297 void bfad_uncfg_pport(struct bfad_s *bfad);
298 void bfad_stop(struct bfad_s *bfad);
299 void bfad_fcs_stop(struct bfad_s *bfad);
300 void bfad_remove_intr(struct bfad_s *bfad);
301 void bfad_hal_mem_release(struct bfad_s *bfad);
302 void bfad_hcb_comp(void *arg, bfa_status_t status);
304 int bfad_setup_intr(struct bfad_s *bfad);
305 void bfad_remove_intr(struct bfad_s *bfad);
306 void bfad_update_hal_cfg(struct bfa_iocfc_cfg_s *bfa_cfg);
307 bfa_status_t bfad_hal_mem_alloc(struct bfad_s *bfad);
308 void bfad_bfa_tmo(struct timer_list *t);
309 void bfad_init_timer(struct bfad_s *bfad);
310 int bfad_pci_init(struct pci_dev *pdev, struct bfad_s *bfad);
311 void bfad_pci_uninit(struct pci_dev *pdev, struct bfad_s *bfad);
312 void bfad_drv_uninit(struct bfad_s *bfad);
313 int bfad_worker(void *ptr);
314 void bfad_debugfs_init(struct bfad_port_s *port);
315 void bfad_debugfs_exit(struct bfad_port_s *port);
317 void bfad_pci_remove(struct pci_dev *pdev);
318 int bfad_pci_probe(struct pci_dev *pdev, const struct pci_device_id *pid);
319 void bfad_rport_online_wait(struct bfad_s *bfad);
320 int bfad_get_linkup_delay(struct bfad_s *bfad);
321 int bfad_install_msix_handler(struct bfad_s *bfad);
323 extern struct idr bfad_im_port_index;
324 extern struct pci_device_id bfad_id_table[];
325 extern struct list_head bfad_list;
326 extern char *os_name;
327 extern char *os_patch;
328 extern char *host_name;
329 extern int num_rports;
332 extern int num_fcxps;
333 extern int num_ufbufs;
334 extern int reqq_size;
335 extern int rspq_size;
336 extern int num_sgpgs;
337 extern int rport_del_timeout;
338 extern int bfa_lun_queue_depth;
339 extern int bfa_io_max_sge;
340 extern int bfa_log_level;
341 extern int ioc_auto_recover;
342 extern int bfa_linkup_delay;
343 extern int msix_disable_cb;
344 extern int msix_disable_ct;
345 extern int fdmi_enable;
346 extern int supported_fc4s;
347 extern int pcie_max_read_reqsz;
348 extern int max_xfer_size;
349 extern int bfa_debugfs_enable;
350 extern struct mutex bfad_mutex;
352 #endif /* __BFAD_DRV_H__ */