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.1.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 87 struct bfad_msix_s { 88 struct bfad_s *bfad; 89 struct msix_entry msix; 90 }; 91 92 enum 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 */ 102 struct 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 116 /* 117 * VPORT data structure 118 */ 119 struct bfad_vport_s { 120 struct bfad_port_s drv_port; 121 struct bfa_fcs_vport_s fcs_vport; 122 struct completion *comp_del; 123 }; 124 125 /* 126 * VF data structure 127 */ 128 struct bfad_vf_s { 129 bfa_fcs_vf_t fcs_vf; 130 struct bfad_port_s base_port; /* base port for vf */ 131 struct bfad_s *bfad; 132 }; 133 134 struct bfad_cfg_param_s { 135 u32 rport_del_timeout; 136 u32 ioc_queue_depth; 137 u32 lun_queue_depth; 138 u32 io_max_sge; 139 u32 binding_method; 140 }; 141 142 union bfad_tmp_buf { 143 /* From struct bfa_adapter_attr_s */ 144 char manufacturer[BFA_ADAPTER_MFG_NAME_LEN]; 145 char serial_num[BFA_ADAPTER_SERIAL_NUM_LEN]; 146 char model[BFA_ADAPTER_MODEL_NAME_LEN]; 147 char fw_ver[BFA_VERSION_LEN]; 148 char optrom_ver[BFA_VERSION_LEN]; 149 150 /* From struct bfa_ioc_pci_attr_s */ 151 u8 chip_rev[BFA_IOC_CHIP_REV_LEN]; /* chip revision */ 152 }; 153 154 /* 155 * BFAD (PCI function) data structure 156 */ 157 struct bfad_s { 158 struct list_head list_entry; 159 struct bfa_s bfa; 160 struct bfa_fcs_s bfa_fcs; 161 struct pci_dev *pcidev; 162 const char *pci_name; 163 struct bfa_pcidev_s hal_pcidev; 164 struct bfa_ioc_pci_attr_s pci_attr; 165 void __iomem *pci_bar0_kva; 166 struct completion comp; 167 struct completion suspend; 168 struct completion disable_comp; 169 bfa_boolean_t disable_active; 170 struct bfad_port_s pport; /* physical port of the BFAD */ 171 struct bfa_meminfo_s meminfo; 172 struct bfa_iocfc_cfg_s ioc_cfg; 173 u32 inst_no; /* BFAD instance number */ 174 u32 bfad_flags; 175 spinlock_t bfad_lock; 176 struct task_struct *bfad_tsk; 177 struct bfad_cfg_param_s cfg_data; 178 struct bfad_msix_s msix_tab[MAX_MSIX_ENTRY]; 179 int nvec; 180 char adapter_name[BFA_ADAPTER_SYM_NAME_LEN]; 181 char port_name[BFA_ADAPTER_SYM_NAME_LEN]; 182 struct timer_list hal_tmo; 183 unsigned long hs_start; 184 struct bfad_im_s *im; /* IM specific data */ 185 struct bfad_tm_s *tm; /* TM specific data */ 186 struct bfad_ipfc_s *ipfc; /* IPFC specific data */ 187 struct bfa_log_mod_s log_data; 188 struct bfa_trc_mod_s *trcmod; 189 struct bfa_log_mod_s *logmod; 190 struct bfa_aen_s *aen; 191 struct bfa_aen_s aen_buf; 192 void *file_map[BFA_AEN_MAX_APP]; 193 struct bfa_plog_s plog_buf; 194 int ref_count; 195 bfa_boolean_t ipfc_enabled; 196 union bfad_tmp_buf tmp_buf; 197 struct fc_host_statistics link_stats; 198 }; 199 200 /* 201 * RPORT data structure 202 */ 203 struct bfad_rport_s { 204 struct bfa_fcs_rport_s fcs_rport; 205 }; 206 207 struct bfad_buf_info { 208 void *virt; 209 dma_addr_t phys; 210 u32 size; 211 }; 212 213 struct bfad_fcxp { 214 struct bfad_port_s *port; 215 struct bfa_rport_s *bfa_rport; 216 bfa_status_t req_status; 217 u16 tag; 218 u16 rsp_len; 219 u16 rsp_maxlen; 220 u8 use_ireqbuf; 221 u8 use_irspbuf; 222 u32 num_req_sgles; 223 u32 num_rsp_sgles; 224 struct fchs_s fchs; 225 void *reqbuf_info; 226 void *rspbuf_info; 227 struct bfa_sge_s *req_sge; 228 struct bfa_sge_s *rsp_sge; 229 fcxp_send_cb_t send_cbfn; 230 void *send_cbarg; 231 void *bfa_fcxp; 232 struct completion comp; 233 }; 234 235 struct bfad_hal_comp { 236 bfa_status_t status; 237 struct completion comp; 238 }; 239 240 /* 241 * Macro to obtain the immediate lower power 242 * of two for the integer. 243 */ 244 #define nextLowerInt(x) \ 245 do { \ 246 int j; \ 247 (*x)--; \ 248 for (j = 1; j < (sizeof(int) * 8); j <<= 1) \ 249 (*x) = (*x) | (*x) >> j; \ 250 (*x)++; \ 251 (*x) = (*x) >> 1; \ 252 } while (0) 253 254 255 bfa_status_t bfad_vport_create(struct bfad_s *bfad, u16 vf_id, 256 struct bfa_port_cfg_s *port_cfg, struct device *dev); 257 bfa_status_t bfad_vf_create(struct bfad_s *bfad, u16 vf_id, 258 struct bfa_port_cfg_s *port_cfg); 259 bfa_status_t bfad_cfg_pport(struct bfad_s *bfad, enum bfa_port_role role); 260 bfa_status_t bfad_drv_init(struct bfad_s *bfad); 261 bfa_status_t bfad_start_ops(struct bfad_s *bfad); 262 void bfad_drv_start(struct bfad_s *bfad); 263 void bfad_uncfg_pport(struct bfad_s *bfad); 264 void bfad_drv_stop(struct bfad_s *bfad); 265 void bfad_remove_intr(struct bfad_s *bfad); 266 void bfad_hal_mem_release(struct bfad_s *bfad); 267 void bfad_hcb_comp(void *arg, bfa_status_t status); 268 269 int bfad_setup_intr(struct bfad_s *bfad); 270 void bfad_remove_intr(struct bfad_s *bfad); 271 272 void bfad_update_hal_cfg(struct bfa_iocfc_cfg_s *bfa_cfg); 273 bfa_status_t bfad_hal_mem_alloc(struct bfad_s *bfad); 274 void bfad_bfa_tmo(unsigned long data); 275 void bfad_init_timer(struct bfad_s *bfad); 276 int bfad_pci_init(struct pci_dev *pdev, struct bfad_s *bfad); 277 void bfad_pci_uninit(struct pci_dev *pdev, struct bfad_s *bfad); 278 void bfad_fcs_port_cfg(struct bfad_s *bfad); 279 void bfad_drv_uninit(struct bfad_s *bfad); 280 void bfad_drv_log_level_set(struct bfad_s *bfad); 281 bfa_status_t bfad_fc4_module_init(void); 282 void bfad_fc4_module_exit(void); 283 int bfad_worker (void *ptr); 284 285 void bfad_pci_remove(struct pci_dev *pdev); 286 int bfad_pci_probe(struct pci_dev *pdev, const struct pci_device_id *pid); 287 void bfad_os_rport_online_wait(struct bfad_s *bfad); 288 int bfad_os_get_linkup_delay(struct bfad_s *bfad); 289 int bfad_install_msix_handler(struct bfad_s *bfad); 290 291 extern struct idr bfad_im_port_index; 292 extern struct list_head bfad_list; 293 extern int bfa_lun_queue_depth; 294 extern int bfad_supported_fc4s; 295 extern int bfa_linkup_delay; 296 extern struct mutex bfad_mutex; 297 298 #endif /* __BFAD_DRV_H__ */ 299