1/* 2 * Copyright (c) 2005-2009 Brocade Communications Systems, Inc. 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 18/** 19 * Contains base driver definitions. 20 */ 21 22/** 23 * bfa_drv.h Linux driver data structures. 24 */ 25 26#ifndef __BFAD_DRV_H__ 27#define __BFAD_DRV_H__ 28 29#include "bfa_os_inc.h" 30 31#include <bfa.h> 32#include <bfa_svc.h> 33#include <fcs/bfa_fcs.h> 34#include <defs/bfa_defs_pci.h> 35#include <defs/bfa_defs_port.h> 36#include <defs/bfa_defs_rport.h> 37#include <fcs/bfa_fcs_rport.h> 38#include <defs/bfa_defs_vport.h> 39#include <fcs/bfa_fcs_vport.h> 40 41#include <cs/bfa_plog.h> 42#include "aen/bfa_aen.h" 43#include <log/bfa_log_linux.h> 44 45#define BFAD_DRIVER_NAME "bfa" 46#ifdef BFA_DRIVER_VERSION 47#define BFAD_DRIVER_VERSION BFA_DRIVER_VERSION 48#else 49#define BFAD_DRIVER_VERSION "2.2.2.1" 50#endif 51 52 53#define BFAD_IRQ_FLAGS IRQF_SHARED 54 55/* 56 * BFAD flags 57 */ 58#define BFAD_MSIX_ON 0x00000001 59#define BFAD_HAL_INIT_DONE 0x00000002 60#define BFAD_DRV_INIT_DONE 0x00000004 61#define BFAD_CFG_PPORT_DONE 0x00000008 62#define BFAD_HAL_START_DONE 0x00000010 63#define BFAD_PORT_ONLINE 0x00000020 64#define BFAD_RPORT_ONLINE 0x00000040 65#define BFAD_FCS_INIT_DONE 0x00000080 66#define BFAD_HAL_INIT_FAIL 0x00000100 67#define BFAD_FC4_PROBE_DONE 0x00000200 68#define BFAD_PORT_DELETE 0x00000001 69 70/* 71 * BFAD related definition 72 */ 73#define SCSI_SCAN_DELAY HZ 74#define BFAD_STOP_TIMEOUT 30 75#define BFAD_SUSPEND_TIMEOUT BFAD_STOP_TIMEOUT 76 77/* 78 * BFAD configuration parameter default values 79 */ 80#define BFAD_LUN_QUEUE_DEPTH 32 81#define BFAD_IO_MAX_SGE SG_ALL 82 83#define bfad_isr_t irq_handler_t 84 85#define MAX_MSIX_ENTRY 22 86 87struct bfad_msix_s { 88 struct bfad_s *bfad; 89 struct msix_entry msix; 90}; 91 92enum bfad_port_pvb_type { 93 BFAD_PORT_PHYS_BASE = 0, 94 BFAD_PORT_PHYS_VPORT = 1, 95 BFAD_PORT_VF_BASE = 2, 96 BFAD_PORT_VF_VPORT = 3, 97}; 98 99/* 100 * PORT data structure 101 */ 102struct bfad_port_s { 103 struct list_head list_entry; 104 struct bfad_s *bfad; 105 struct bfa_fcs_port_s *fcs_port; 106 u32 roles; 107 s32 flags; 108 u32 supported_fc4s; 109 u8 ipfc_flags; 110 enum bfad_port_pvb_type pvb_type; 111 struct bfad_im_port_s *im_port; /* IM specific data */ 112 struct bfad_tm_port_s *tm_port; /* TM specific data */ 113 struct bfad_ipfc_port_s *ipfc_port; /* IPFC specific data */ 114 115 /* port debugfs specific data */ 116 struct dentry *port_debugfs_root; 117}; 118 119/* 120 * VPORT data structure 121 */ 122struct bfad_vport_s { 123 struct bfad_port_s drv_port; 124 struct bfa_fcs_vport_s fcs_vport; 125 struct completion *comp_del; 126 struct list_head list_entry; 127 struct bfa_port_cfg_s port_cfg; 128}; 129 130/* 131 * VF data structure 132 */ 133struct bfad_vf_s { 134 bfa_fcs_vf_t fcs_vf; 135 struct bfad_port_s base_port; /* base port for vf */ 136 struct bfad_s *bfad; 137}; 138 139struct bfad_cfg_param_s { 140 u32 rport_del_timeout; 141 u32 ioc_queue_depth; 142 u32 lun_queue_depth; 143 u32 io_max_sge; 144 u32 binding_method; 145}; 146 147/* 148 * BFAD (PCI function) data structure 149 */ 150struct bfad_s { 151 struct list_head list_entry; 152 struct bfa_s bfa; 153 struct bfa_fcs_s bfa_fcs; 154 struct pci_dev *pcidev; 155 const char *pci_name; 156 struct bfa_pcidev_s hal_pcidev; 157 struct bfa_ioc_pci_attr_s pci_attr; 158 void __iomem *pci_bar0_kva; 159 struct completion comp; 160 struct completion suspend; 161 struct completion disable_comp; 162 bfa_boolean_t disable_active; 163 struct bfad_port_s pport; /* physical port of the BFAD */ 164 struct bfa_meminfo_s meminfo; 165 struct bfa_iocfc_cfg_s ioc_cfg; 166 u32 inst_no; /* BFAD instance number */ 167 u32 bfad_flags; 168 spinlock_t bfad_lock; 169 struct task_struct *bfad_tsk; 170 struct bfad_cfg_param_s cfg_data; 171 struct bfad_msix_s msix_tab[MAX_MSIX_ENTRY]; 172 int nvec; 173 char adapter_name[BFA_ADAPTER_SYM_NAME_LEN]; 174 char port_name[BFA_ADAPTER_SYM_NAME_LEN]; 175 struct timer_list hal_tmo; 176 unsigned long hs_start; 177 struct bfad_im_s *im; /* IM specific data */ 178 struct bfad_tm_s *tm; /* TM specific data */ 179 struct bfad_ipfc_s *ipfc; /* IPFC specific data */ 180 struct bfa_log_mod_s log_data; 181 struct bfa_trc_mod_s *trcmod; 182 struct bfa_log_mod_s *logmod; 183 struct bfa_aen_s *aen; 184 struct bfa_aen_s aen_buf; 185 void *file_map[BFA_AEN_MAX_APP]; 186 struct bfa_plog_s plog_buf; 187 int ref_count; 188 bfa_boolean_t ipfc_enabled; 189 struct fc_host_statistics link_stats; 190 struct list_head pbc_pcfg_list; 191 atomic_t wq_reqcnt; 192 /* debugfs specific data */ 193 char *regdata; 194 u32 reglen; 195 struct dentry *bfad_dentry_files[5]; 196}; 197 198struct bfad_pcfg_s { 199 struct list_head list_entry; 200 struct bfa_port_cfg_s port_cfg; 201}; 202 203/* 204 * RPORT data structure 205 */ 206struct bfad_rport_s { 207 struct bfa_fcs_rport_s fcs_rport; 208}; 209 210struct bfad_buf_info { 211 void *virt; 212 dma_addr_t phys; 213 u32 size; 214}; 215 216struct bfad_fcxp { 217 struct bfad_port_s *port; 218 struct bfa_rport_s *bfa_rport; 219 bfa_status_t req_status; 220 u16 tag; 221 u16 rsp_len; 222 u16 rsp_maxlen; 223 u8 use_ireqbuf; 224 u8 use_irspbuf; 225 u32 num_req_sgles; 226 u32 num_rsp_sgles; 227 struct fchs_s fchs; 228 void *reqbuf_info; 229 void *rspbuf_info; 230 struct bfa_sge_s *req_sge; 231 struct bfa_sge_s *rsp_sge; 232 fcxp_send_cb_t send_cbfn; 233 void *send_cbarg; 234 void *bfa_fcxp; 235 struct completion comp; 236}; 237 238struct bfad_hal_comp { 239 bfa_status_t status; 240 struct completion comp; 241}; 242 243/* 244 * Macro to obtain the immediate lower power 245 * of two for the integer. 246 */ 247#define nextLowerInt(x) \ 248do { \ 249 int j; \ 250 (*x)--; \ 251 for (j = 1; j < (sizeof(int) * 8); j <<= 1) \ 252 (*x) = (*x) | (*x) >> j; \ 253 (*x)++; \ 254 (*x) = (*x) >> 1; \ 255} while (0) 256 257 258bfa_status_t bfad_vport_create(struct bfad_s *bfad, u16 vf_id, 259 struct bfa_port_cfg_s *port_cfg, struct device *dev); 260bfa_status_t bfad_vf_create(struct bfad_s *bfad, u16 vf_id, 261 struct bfa_port_cfg_s *port_cfg); 262bfa_status_t bfad_cfg_pport(struct bfad_s *bfad, enum bfa_port_role role); 263bfa_status_t bfad_drv_init(struct bfad_s *bfad); 264bfa_status_t bfad_start_ops(struct bfad_s *bfad); 265void bfad_drv_start(struct bfad_s *bfad); 266void bfad_uncfg_pport(struct bfad_s *bfad); 267void bfad_drv_stop(struct bfad_s *bfad); 268void bfad_remove_intr(struct bfad_s *bfad); 269void bfad_hal_mem_release(struct bfad_s *bfad); 270void bfad_hcb_comp(void *arg, bfa_status_t status); 271 272int bfad_setup_intr(struct bfad_s *bfad); 273void bfad_remove_intr(struct bfad_s *bfad); 274 275void bfad_update_hal_cfg(struct bfa_iocfc_cfg_s *bfa_cfg); 276bfa_status_t bfad_hal_mem_alloc(struct bfad_s *bfad); 277void bfad_bfa_tmo(unsigned long data); 278void bfad_init_timer(struct bfad_s *bfad); 279int bfad_pci_init(struct pci_dev *pdev, struct bfad_s *bfad); 280void bfad_pci_uninit(struct pci_dev *pdev, struct bfad_s *bfad); 281void bfad_fcs_port_cfg(struct bfad_s *bfad); 282void bfad_drv_uninit(struct bfad_s *bfad); 283void bfad_drv_log_level_set(struct bfad_s *bfad); 284bfa_status_t bfad_fc4_module_init(void); 285void bfad_fc4_module_exit(void); 286int bfad_worker(void *ptr); 287void bfad_debugfs_init(struct bfad_port_s *port); 288void bfad_debugfs_exit(struct bfad_port_s *port); 289 290void bfad_pci_remove(struct pci_dev *pdev); 291int bfad_pci_probe(struct pci_dev *pdev, const struct pci_device_id *pid); 292void bfad_os_rport_online_wait(struct bfad_s *bfad); 293int bfad_os_get_linkup_delay(struct bfad_s *bfad); 294int bfad_install_msix_handler(struct bfad_s *bfad); 295 296extern struct idr bfad_im_port_index; 297extern struct list_head bfad_list; 298extern int bfa_lun_queue_depth; 299extern int bfad_supported_fc4s; 300extern int bfa_linkup_delay; 301extern int bfa_debugfs_enable; 302extern struct mutex bfad_mutex; 303 304#endif /* __BFAD_DRV_H__ */ 305