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