linux/drivers/scsi/bfa/bfad_drv.h
<<
>>
Prefs
   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.0.0.0"
  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
  66#define BFAD_PORT_DELETE                        0x00000001
  67
  68/*
  69 * BFAD related definition
  70 */
  71#define SCSI_SCAN_DELAY         HZ
  72#define BFAD_STOP_TIMEOUT       30
  73#define BFAD_SUSPEND_TIMEOUT    BFAD_STOP_TIMEOUT
  74
  75/*
  76 * BFAD configuration parameter default values
  77 */
  78#define BFAD_LUN_QUEUE_DEPTH            32
  79#define BFAD_IO_MAX_SGE                 SG_ALL
  80
  81#define bfad_isr_t irq_handler_t
  82
  83#define MAX_MSIX_ENTRY 22
  84
  85struct bfad_msix_s {
  86        struct bfad_s *bfad;
  87        struct msix_entry msix;
  88};
  89
  90enum bfad_port_pvb_type {
  91        BFAD_PORT_PHYS_BASE = 0,
  92        BFAD_PORT_PHYS_VPORT = 1,
  93        BFAD_PORT_VF_BASE = 2,
  94        BFAD_PORT_VF_VPORT = 3,
  95};
  96
  97/*
  98 * PORT data structure
  99 */
 100struct bfad_port_s {
 101        struct list_head list_entry;
 102        struct bfad_s         *bfad;
 103        struct bfa_fcs_port_s *fcs_port;
 104        u32        roles;
 105        s32         flags;
 106        u32        supported_fc4s;
 107        u8              ipfc_flags;
 108        enum bfad_port_pvb_type pvb_type;
 109        struct bfad_im_port_s *im_port; /* IM specific data */
 110        struct bfad_tm_port_s *tm_port; /* TM specific data */
 111        struct bfad_ipfc_port_s *ipfc_port;     /* IPFC specific data */
 112};
 113
 114/*
 115 * VPORT data structure
 116 */
 117struct bfad_vport_s {
 118        struct bfad_port_s     drv_port;
 119        struct bfa_fcs_vport_s fcs_vport;
 120        struct completion *comp_del;
 121};
 122
 123/*
 124 * VF data structure
 125 */
 126struct bfad_vf_s {
 127        bfa_fcs_vf_t    fcs_vf;
 128        struct bfad_port_s    base_port;        /* base port for vf */
 129        struct bfad_s   *bfad;
 130};
 131
 132struct bfad_cfg_param_s {
 133        u32        rport_del_timeout;
 134        u32        ioc_queue_depth;
 135        u32        lun_queue_depth;
 136        u32        io_max_sge;
 137        u32        binding_method;
 138};
 139
 140#define BFAD_AEN_MAX_APPS 8
 141struct bfad_aen_file_s {
 142        struct list_head  qe;
 143        struct bfad_s *bfad;
 144        s32 ri;
 145        s32 app_id;
 146};
 147
 148/*
 149 * BFAD (PCI function) data structure
 150 */
 151struct bfad_s {
 152        struct list_head list_entry;
 153        struct bfa_s       bfa;
 154        struct bfa_fcs_s       bfa_fcs;
 155        struct pci_dev *pcidev;
 156        const char *pci_name;
 157        struct bfa_pcidev_s hal_pcidev;
 158        struct bfa_ioc_pci_attr_s pci_attr;
 159        unsigned long   pci_bar0_map;
 160        void __iomem   *pci_bar0_kva;
 161        struct completion comp;
 162        struct completion suspend;
 163        struct completion disable_comp;
 164        bfa_boolean_t   disable_active;
 165        struct bfad_port_s     pport;   /* physical port of the BFAD */
 166        struct bfa_meminfo_s meminfo;
 167        struct bfa_iocfc_cfg_s   ioc_cfg;
 168        u32        inst_no;     /* BFAD instance number */
 169        u32        bfad_flags;
 170        spinlock_t      bfad_lock;
 171        struct bfad_cfg_param_s cfg_data;
 172        struct bfad_msix_s msix_tab[MAX_MSIX_ENTRY];
 173        int             nvec;
 174        char            adapter_name[BFA_ADAPTER_SYM_NAME_LEN];
 175        char            port_name[BFA_ADAPTER_SYM_NAME_LEN];
 176        struct timer_list hal_tmo;
 177        unsigned long   hs_start;
 178        struct bfad_im_s *im;           /* IM specific data */
 179        struct bfad_tm_s *tm;           /* TM specific data */
 180        struct bfad_ipfc_s *ipfc;       /* IPFC specific data */
 181        struct bfa_log_mod_s   log_data;
 182        struct bfa_trc_mod_s  *trcmod;
 183        struct bfa_log_mod_s  *logmod;
 184        struct bfa_aen_s      *aen;
 185        struct bfa_aen_s       aen_buf;
 186        struct bfad_aen_file_s file_buf[BFAD_AEN_MAX_APPS];
 187        struct list_head         file_q;
 188        struct list_head         file_free_q;
 189        struct bfa_plog_s      plog_buf;
 190        int             ref_count;
 191        bfa_boolean_t   ipfc_enabled;
 192        struct fc_host_statistics link_stats;
 193
 194        struct kobject *bfa_kobj;
 195        struct kobject *ioc_kobj;
 196        struct kobject *pport_kobj;
 197        struct kobject *lport_kobj;
 198};
 199
 200/*
 201 * RPORT data structure
 202 */
 203struct bfad_rport_s {
 204        struct bfa_fcs_rport_s fcs_rport;
 205};
 206
 207struct bfad_buf_info {
 208        void           *virt;
 209        dma_addr_t      phys;
 210        u32        size;
 211};
 212
 213struct 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
 235struct 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)                                 \
 245do {                                                    \
 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
 255bfa_status_t    bfad_vport_create(struct bfad_s *bfad, u16 vf_id,
 256                                  struct bfa_port_cfg_s *port_cfg);
 257bfa_status_t    bfad_vf_create(struct bfad_s *bfad, u16 vf_id,
 258                               struct bfa_port_cfg_s *port_cfg);
 259bfa_status_t    bfad_cfg_pport(struct bfad_s *bfad, enum bfa_port_role role);
 260bfa_status_t    bfad_drv_init(struct bfad_s *bfad);
 261void            bfad_drv_start(struct bfad_s *bfad);
 262void            bfad_uncfg_pport(struct bfad_s *bfad);
 263void            bfad_drv_stop(struct bfad_s *bfad);
 264void            bfad_remove_intr(struct bfad_s *bfad);
 265void            bfad_hal_mem_release(struct bfad_s *bfad);
 266void            bfad_hcb_comp(void *arg, bfa_status_t status);
 267
 268int             bfad_setup_intr(struct bfad_s *bfad);
 269void            bfad_remove_intr(struct bfad_s *bfad);
 270
 271void            bfad_update_hal_cfg(struct bfa_iocfc_cfg_s *bfa_cfg);
 272bfa_status_t    bfad_hal_mem_alloc(struct bfad_s *bfad);
 273void            bfad_bfa_tmo(unsigned long data);
 274void            bfad_init_timer(struct bfad_s *bfad);
 275int             bfad_pci_init(struct pci_dev *pdev, struct bfad_s *bfad);
 276void            bfad_pci_uninit(struct pci_dev *pdev, struct bfad_s *bfad);
 277void            bfad_fcs_port_cfg(struct bfad_s *bfad);
 278void            bfad_drv_uninit(struct bfad_s *bfad);
 279void            bfad_drv_log_level_set(struct bfad_s *bfad);
 280bfa_status_t    bfad_fc4_module_init(void);
 281void            bfad_fc4_module_exit(void);
 282
 283void bfad_pci_remove(struct pci_dev *pdev);
 284int bfad_pci_probe(struct pci_dev *pdev, const struct pci_device_id *pid);
 285void bfad_os_rport_online_wait(struct bfad_s *bfad);
 286int bfad_os_get_linkup_delay(struct bfad_s *bfad);
 287int bfad_install_msix_handler(struct bfad_s *bfad);
 288
 289extern struct idr bfad_im_port_index;
 290extern struct list_head bfad_list;
 291extern int bfa_lun_queue_depth;
 292extern int bfad_supported_fc4s;
 293extern int bfa_linkup_delay;
 294
 295#endif /* __BFAD_DRV_H__ */
 296