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