blob: eaee7c8bc2d28d60e0e0e6ec5dea5d7f6482e9c6 [file] [log] [blame]
Thomas Gleixner52fa7bf2019-05-29 07:18:06 -07001/* SPDX-License-Identifier: GPL-2.0-only */
Jing Huang7725ccf2009-09-23 17:46:15 -07002/*
Anil Gurumurthy889d0d42015-11-26 03:54:45 -05003 * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
4 * Copyright (c) 2014- QLogic Corporation.
Jing Huang7725ccf2009-09-23 17:46:15 -07005 * All rights reserved
Anil Gurumurthy889d0d42015-11-26 03:54:45 -05006 * www.qlogic.com
Jing Huang7725ccf2009-09-23 17:46:15 -07007 *
Anil Gurumurthy31e1d562015-11-26 03:54:46 -05008 * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
Jing Huang7725ccf2009-09-23 17:46:15 -07009 */
10
Jing Huangacdc79a2010-10-18 17:15:55 -070011/*
Jing Huang7725ccf2009-09-23 17:46:15 -070012 * Contains base driver definitions.
13 */
14
Jing Huangacdc79a2010-10-18 17:15:55 -070015/*
Jing Huang7725ccf2009-09-23 17:46:15 -070016 * bfa_drv.h Linux driver data structures.
17 */
18
19#ifndef __BFAD_DRV_H__
20#define __BFAD_DRV_H__
21
Maggie Zhangf16a1752010-12-09 19:12:32 -080022#include <linux/types.h>
Maggie Zhangf16a1752010-12-09 19:12:32 -080023#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>
Krishna Gudipati881c1b32012-08-22 19:52:02 -070033#include <linux/aer.h>
Maggie Zhangf16a1752010-12-09 19:12:32 -080034#include <scsi/scsi.h>
35#include <scsi/scsi_host.h>
36#include <scsi/scsi_tcq.h>
37#include <scsi/scsi_transport_fc.h>
38#include <scsi/scsi_transport.h>
Krishna Gudipatib85daaf2011-06-13 15:55:11 -070039#include <scsi/scsi_bsg_fc.h>
Krishna Gudipati5b7db7a2011-12-20 18:58:32 -080040#include <scsi/scsi_devinfo.h>
Jing Huang7725ccf2009-09-23 17:46:15 -070041
Krishna Gudipatia36c61f2010-09-15 11:50:55 -070042#include "bfa_modules.h"
43#include "bfa_fcs.h"
44#include "bfa_defs_fcs.h"
Jing Huang7725ccf2009-09-23 17:46:15 -070045
Krishna Gudipatia36c61f2010-09-15 11:50:55 -070046#include "bfa_plog.h"
47#include "bfa_cs.h"
Jing Huang7725ccf2009-09-23 17:46:15 -070048
Krishna Gudipatia36c61f2010-09-15 11:50:55 -070049#define BFAD_DRIVER_NAME "bfa"
Jing Huang7725ccf2009-09-23 17:46:15 -070050#ifdef BFA_DRIVER_VERSION
51#define BFAD_DRIVER_VERSION BFA_DRIVER_VERSION
52#else
Benjamin Poirier2d1148f2016-12-23 20:40:19 -080053#define BFAD_DRIVER_VERSION "3.2.25.1"
Jing Huang7725ccf2009-09-23 17:46:15 -070054#endif
55
Krishna Gudipatia36c61f2010-09-15 11:50:55 -070056#define BFAD_PROTO_NAME FCPI_NAME
Jing Huang7725ccf2009-09-23 17:46:15 -070057#define BFAD_IRQ_FLAGS IRQF_SHARED
58
Krishna Gudipatia36c61f2010-09-15 11:50:55 -070059#ifndef FC_PORTSPEED_8GBIT
60#define FC_PORTSPEED_8GBIT 0x10
61#endif
62
Jing Huang7725ccf2009-09-23 17:46:15 -070063/*
64 * BFAD flags
65 */
66#define BFAD_MSIX_ON 0x00000001
67#define BFAD_HAL_INIT_DONE 0x00000002
68#define BFAD_DRV_INIT_DONE 0x00000004
69#define BFAD_CFG_PPORT_DONE 0x00000008
70#define BFAD_HAL_START_DONE 0x00000010
71#define BFAD_PORT_ONLINE 0x00000020
72#define BFAD_RPORT_ONLINE 0x00000040
Krishna Gudipatia36c61f2010-09-15 11:50:55 -070073#define BFAD_FCS_INIT_DONE 0x00000080
74#define BFAD_HAL_INIT_FAIL 0x00000100
75#define BFAD_FC4_PROBE_DONE 0x00000200
Jing Huang7725ccf2009-09-23 17:46:15 -070076#define BFAD_PORT_DELETE 0x00000001
Krishna Gudipati61e62e22011-06-24 20:29:07 -070077#define BFAD_INTX_ON 0x00000400
Krishna Gudipati881c1b32012-08-22 19:52:02 -070078#define BFAD_EEH_BUSY 0x00000800
79#define BFAD_EEH_PCI_CHANNEL_IO_PERM_FAILURE 0x00001000
Jing Huang7725ccf2009-09-23 17:46:15 -070080/*
81 * BFAD related definition
82 */
83#define SCSI_SCAN_DELAY HZ
84#define BFAD_STOP_TIMEOUT 30
85#define BFAD_SUSPEND_TIMEOUT BFAD_STOP_TIMEOUT
86
87/*
88 * BFAD configuration parameter default values
89 */
Krishna Gudipatia36c61f2010-09-15 11:50:55 -070090#define BFAD_LUN_QUEUE_DEPTH 32
91#define BFAD_IO_MAX_SGE SG_ALL
Krishna Gudipati61e62e22011-06-24 20:29:07 -070092#define BFAD_MIN_SECTORS 128 /* 64k */
93#define BFAD_MAX_SECTORS 0xFFFF /* 32 MB */
Jing Huang7725ccf2009-09-23 17:46:15 -070094
95#define bfad_isr_t irq_handler_t
96
97#define MAX_MSIX_ENTRY 22
98
99struct bfad_msix_s {
100 struct bfad_s *bfad;
101 struct msix_entry msix;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700102 char name[32];
103};
104
105/*
106 * Only append to the enums defined here to avoid any versioning
107 * needed between trace utility and driver version
108 */
109enum {
110 BFA_TRC_LDRV_BFAD = 1,
111 BFA_TRC_LDRV_IM = 2,
Krishna Gudipatib85daaf2011-06-13 15:55:11 -0700112 BFA_TRC_LDRV_BSG = 3,
Jing Huang7725ccf2009-09-23 17:46:15 -0700113};
114
115enum bfad_port_pvb_type {
116 BFAD_PORT_PHYS_BASE = 0,
117 BFAD_PORT_PHYS_VPORT = 1,
118 BFAD_PORT_VF_BASE = 2,
119 BFAD_PORT_VF_VPORT = 3,
120};
121
122/*
123 * PORT data structure
124 */
125struct bfad_port_s {
126 struct list_head list_entry;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700127 struct bfad_s *bfad;
128 struct bfa_fcs_lport_s *fcs_port;
129 u32 roles;
130 s32 flags;
131 u32 supported_fc4s;
Jing Huang7725ccf2009-09-23 17:46:15 -0700132 enum bfad_port_pvb_type pvb_type;
133 struct bfad_im_port_s *im_port; /* IM specific data */
Jing Huangab2a9ba2010-07-08 20:02:55 -0700134 /* port debugfs specific data */
135 struct dentry *port_debugfs_root;
Jing Huang7725ccf2009-09-23 17:46:15 -0700136};
137
138/*
139 * VPORT data structure
140 */
141struct bfad_vport_s {
142 struct bfad_port_s drv_port;
143 struct bfa_fcs_vport_s fcs_vport;
144 struct completion *comp_del;
Jing Huangd9883542010-07-08 19:46:26 -0700145 struct list_head list_entry;
Jing Huang7725ccf2009-09-23 17:46:15 -0700146};
147
148/*
149 * VF data structure
150 */
151struct bfad_vf_s {
152 bfa_fcs_vf_t fcs_vf;
153 struct bfad_port_s base_port; /* base port for vf */
154 struct bfad_s *bfad;
155};
156
157struct bfad_cfg_param_s {
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700158 u32 rport_del_timeout;
159 u32 ioc_queue_depth;
160 u32 lun_queue_depth;
161 u32 io_max_sge;
162 u32 binding_method;
163};
164
165union bfad_tmp_buf {
166 /* From struct bfa_adapter_attr_s */
167 char manufacturer[BFA_ADAPTER_MFG_NAME_LEN];
168 char serial_num[BFA_ADAPTER_SERIAL_NUM_LEN];
169 char model[BFA_ADAPTER_MODEL_NAME_LEN];
170 char fw_ver[BFA_VERSION_LEN];
171 char optrom_ver[BFA_VERSION_LEN];
172
173 /* From struct bfa_ioc_pci_attr_s */
174 u8 chip_rev[BFA_IOC_CHIP_REV_LEN]; /* chip revision */
175
176 wwn_t wwn[BFA_FCS_MAX_LPORTS];
Jing Huang7725ccf2009-09-23 17:46:15 -0700177};
178
Jing Huang7725ccf2009-09-23 17:46:15 -0700179/*
180 * BFAD (PCI function) data structure
181 */
182struct bfad_s {
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700183 bfa_sm_t sm; /* state machine */
Jing Huang7725ccf2009-09-23 17:46:15 -0700184 struct list_head list_entry;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700185 struct bfa_s bfa;
186 struct bfa_fcs_s bfa_fcs;
Jing Huang7725ccf2009-09-23 17:46:15 -0700187 struct pci_dev *pcidev;
188 const char *pci_name;
189 struct bfa_pcidev_s hal_pcidev;
190 struct bfa_ioc_pci_attr_s pci_attr;
Jing Huang7725ccf2009-09-23 17:46:15 -0700191 void __iomem *pci_bar0_kva;
Krishna Gudipati11189202011-06-13 15:50:35 -0700192 void __iomem *pci_bar2_kva;
Jing Huang7725ccf2009-09-23 17:46:15 -0700193 struct completion comp;
194 struct completion suspend;
Krishna Gudipati60138062011-06-24 20:25:15 -0700195 struct completion enable_comp;
Jing Huang7725ccf2009-09-23 17:46:15 -0700196 struct completion disable_comp;
197 bfa_boolean_t disable_active;
198 struct bfad_port_s pport; /* physical port of the BFAD */
199 struct bfa_meminfo_s meminfo;
200 struct bfa_iocfc_cfg_s ioc_cfg;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700201 u32 inst_no; /* BFAD instance number */
202 u32 bfad_flags;
Jing Huang7725ccf2009-09-23 17:46:15 -0700203 spinlock_t bfad_lock;
Krishna Gudipatie6714322010-03-03 17:44:02 -0800204 struct task_struct *bfad_tsk;
Jing Huang7725ccf2009-09-23 17:46:15 -0700205 struct bfad_cfg_param_s cfg_data;
206 struct bfad_msix_s msix_tab[MAX_MSIX_ENTRY];
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700207 int nvec;
208 char adapter_name[BFA_ADAPTER_SYM_NAME_LEN];
209 char port_name[BFA_ADAPTER_SYM_NAME_LEN];
Jing Huang7725ccf2009-09-23 17:46:15 -0700210 struct timer_list hal_tmo;
211 unsigned long hs_start;
212 struct bfad_im_s *im; /* IM specific data */
Jing Huang7725ccf2009-09-23 17:46:15 -0700213 struct bfa_trc_mod_s *trcmod;
Jing Huang7725ccf2009-09-23 17:46:15 -0700214 struct bfa_plog_s plog_buf;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700215 int ref_count;
216 union bfad_tmp_buf tmp_buf;
Jing Huang7725ccf2009-09-23 17:46:15 -0700217 struct fc_host_statistics link_stats;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700218 struct list_head pbc_vport_list;
Jing Huangab2a9ba2010-07-08 20:02:55 -0700219 /* debugfs specific data */
220 char *regdata;
221 u32 reglen;
222 struct dentry *bfad_dentry_files[5];
Krishna Gudipati7826f302011-07-20 16:59:13 -0700223 struct list_head free_aen_q;
224 struct list_head active_aen_q;
225 struct bfa_aen_entry_s aen_list[BFA_AEN_MAX_ENTRY];
226 spinlock_t bfad_aen_spinlock;
Krishna Gudipati5b7db7a2011-12-20 18:58:32 -0800227 struct list_head vport_list;
Jing Huangd9883542010-07-08 19:46:26 -0700228};
229
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700230/* BFAD state machine events */
231enum bfad_sm_event {
232 BFAD_E_CREATE = 1,
233 BFAD_E_KTHREAD_CREATE_FAILED = 2,
234 BFAD_E_INIT = 3,
235 BFAD_E_INIT_SUCCESS = 4,
Vijaya Mohan Guvvada3e0be2013-11-21 01:37:33 -0800236 BFAD_E_HAL_INIT_FAILED = 5,
237 BFAD_E_INIT_FAILED = 6,
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700238 BFAD_E_FCS_EXIT_COMP = 7,
239 BFAD_E_EXIT_COMP = 8,
240 BFAD_E_STOP = 9
Jing Huang7725ccf2009-09-23 17:46:15 -0700241};
242
243/*
244 * RPORT data structure
245 */
246struct bfad_rport_s {
247 struct bfa_fcs_rport_s fcs_rport;
248};
249
250struct bfad_buf_info {
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700251 void *virt;
Jing Huang7725ccf2009-09-23 17:46:15 -0700252 dma_addr_t phys;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700253 u32 size;
Jing Huang7725ccf2009-09-23 17:46:15 -0700254};
255
256struct bfad_fcxp {
257 struct bfad_port_s *port;
258 struct bfa_rport_s *bfa_rport;
259 bfa_status_t req_status;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700260 u16 tag;
261 u16 rsp_len;
262 u16 rsp_maxlen;
263 u8 use_ireqbuf;
264 u8 use_irspbuf;
265 u32 num_req_sgles;
266 u32 num_rsp_sgles;
267 struct fchs_s fchs;
268 void *reqbuf_info;
269 void *rspbuf_info;
Jing Huang7725ccf2009-09-23 17:46:15 -0700270 struct bfa_sge_s *req_sge;
271 struct bfa_sge_s *rsp_sge;
272 fcxp_send_cb_t send_cbfn;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700273 void *send_cbarg;
274 void *bfa_fcxp;
Jing Huang7725ccf2009-09-23 17:46:15 -0700275 struct completion comp;
276};
277
278struct bfad_hal_comp {
279 bfa_status_t status;
280 struct completion comp;
281};
282
Maggie Zhangf16a1752010-12-09 19:12:32 -0800283#define BFA_LOG(level, bfad, mask, fmt, arg...) \
284do { \
285 if (((mask) == 4) || (level[1] <= '4')) \
286 dev_printk(level, &((bfad)->pcidev)->dev, fmt, ##arg); \
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700287} while (0)
288
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700289bfa_status_t bfad_vport_create(struct bfad_s *bfad, u16 vf_id,
290 struct bfa_lport_cfg_s *port_cfg,
291 struct device *dev);
292bfa_status_t bfad_vf_create(struct bfad_s *bfad, u16 vf_id,
293 struct bfa_lport_cfg_s *port_cfg);
294bfa_status_t bfad_cfg_pport(struct bfad_s *bfad, enum bfa_lport_role role);
295bfa_status_t bfad_drv_init(struct bfad_s *bfad);
Krishna Gudipatie6714322010-03-03 17:44:02 -0800296bfa_status_t bfad_start_ops(struct bfad_s *bfad);
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700297void bfad_drv_start(struct bfad_s *bfad);
298void bfad_uncfg_pport(struct bfad_s *bfad);
299void bfad_stop(struct bfad_s *bfad);
300void bfad_fcs_stop(struct bfad_s *bfad);
301void bfad_remove_intr(struct bfad_s *bfad);
302void bfad_hal_mem_release(struct bfad_s *bfad);
303void bfad_hcb_comp(void *arg, bfa_status_t status);
Jing Huang7725ccf2009-09-23 17:46:15 -0700304
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700305int bfad_setup_intr(struct bfad_s *bfad);
306void bfad_remove_intr(struct bfad_s *bfad);
Jing Huang7725ccf2009-09-23 17:46:15 -0700307void bfad_update_hal_cfg(struct bfa_iocfc_cfg_s *bfa_cfg);
308bfa_status_t bfad_hal_mem_alloc(struct bfad_s *bfad);
Kees Cooke99e88a2017-10-16 14:43:17 -0700309void bfad_bfa_tmo(struct timer_list *t);
Jing Huang7725ccf2009-09-23 17:46:15 -0700310void bfad_init_timer(struct bfad_s *bfad);
311int bfad_pci_init(struct pci_dev *pdev, struct bfad_s *bfad);
312void bfad_pci_uninit(struct pci_dev *pdev, struct bfad_s *bfad);
Jing Huang7725ccf2009-09-23 17:46:15 -0700313void bfad_drv_uninit(struct bfad_s *bfad);
Jing Huangab2a9ba2010-07-08 20:02:55 -0700314int bfad_worker(void *ptr);
315void bfad_debugfs_init(struct bfad_port_s *port);
316void bfad_debugfs_exit(struct bfad_port_s *port);
Krishna Gudipatie6714322010-03-03 17:44:02 -0800317
Jing Huang7725ccf2009-09-23 17:46:15 -0700318void bfad_pci_remove(struct pci_dev *pdev);
319int bfad_pci_probe(struct pci_dev *pdev, const struct pci_device_id *pid);
Maggie Zhangf16a1752010-12-09 19:12:32 -0800320void bfad_rport_online_wait(struct bfad_s *bfad);
321int bfad_get_linkup_delay(struct bfad_s *bfad);
Jing Huang7725ccf2009-09-23 17:46:15 -0700322int bfad_install_msix_handler(struct bfad_s *bfad);
323
324extern struct idr bfad_im_port_index;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700325extern struct pci_device_id bfad_id_table[];
Jing Huang7725ccf2009-09-23 17:46:15 -0700326extern struct list_head bfad_list;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700327extern char *os_name;
328extern char *os_patch;
329extern char *host_name;
330extern int num_rports;
331extern int num_ios;
332extern int num_tms;
333extern int num_fcxps;
334extern int num_ufbufs;
335extern int reqq_size;
336extern int rspq_size;
337extern int num_sgpgs;
338extern int rport_del_timeout;
339extern int bfa_lun_queue_depth;
340extern int bfa_io_max_sge;
Jing Huang88166242010-12-09 17:11:53 -0800341extern int bfa_log_level;
Krishna Gudipatia36c61f2010-09-15 11:50:55 -0700342extern int ioc_auto_recover;
343extern int bfa_linkup_delay;
344extern int msix_disable_cb;
345extern int msix_disable_ct;
346extern int fdmi_enable;
347extern int supported_fc4s;
348extern int pcie_max_read_reqsz;
Krishna Gudipati61e62e22011-06-24 20:29:07 -0700349extern int max_xfer_size;
Jing Huangab2a9ba2010-07-08 20:02:55 -0700350extern int bfa_debugfs_enable;
Jing Huang42b426e2010-03-19 11:07:09 -0700351extern struct mutex bfad_mutex;
Jing Huang7725ccf2009-09-23 17:46:15 -0700352
353#endif /* __BFAD_DRV_H__ */