drivers/net/ethernet/brocade/bna/bfa_ioc.h

   1 /*
   2  * Linux network driver for Brocade Converged Network Adapter.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License (GPL) Version 2 as
   6  * published by the Free Software Foundation
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  */
  13 /*
  14  * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
  15  * All rights reserved
  16  * www.brocade.com
  17  */
  18
  19 #ifndef __BFA_IOC_H__
  20 #define __BFA_IOC_H__
  21
  22 #include "bfa_cs.h"
  23 #include "bfi.h"
  24 #include "cna.h"
  25
  26 #define BFA_IOC_TOV             3000    /* msecs */
  27 #define BFA_IOC_HWSEM_TOV       500     /* msecs */
  28 #define BFA_IOC_HB_TOV          500     /* msecs */
  29 #define BFA_IOC_POLL_TOV        200     /* msecs */
  30
  31 /**
  32  * PCI device information required by IOC
  33  */
  34 struct bfa_pcidev {
  35         int     pci_slot;
  36         u8      pci_func;
  37         u16     device_id;
  38         u16     ssid;
  39         void    __iomem *pci_bar_kva;
  40 };
  41
  42 /**
  43  * Structure used to remember the DMA-able memory block's KVA and Physical
  44  * Address
  45  */
  46 struct bfa_dma {
  47         void    *kva;   /* ! Kernel virtual address     */
  48         u64     pa;     /* ! Physical address           */
  49 };
  50
  51 #define BFA_DMA_ALIGN_SZ        256
  52
  53 /**
  54  * smem size for Crossbow and Catapult
  55  */
  56 #define BFI_SMEM_CB_SIZE        0x200000U       /* ! 2MB for crossbow   */
  57 #define BFI_SMEM_CT_SIZE        0x280000U       /* ! 2.5MB for catapult */
  58
  59 /**
  60  * @brief BFA dma address assignment macro. (big endian format)
  61  */
  62 #define bfa_dma_be_addr_set(dma_addr, pa)       \
  63                 __bfa_dma_be_addr_set(&dma_addr, (u64)pa)
  64 static inline void
  65 __bfa_dma_be_addr_set(union bfi_addr_u *dma_addr, u64 pa)
  66 {
  67         dma_addr->a32.addr_lo = (u32) htonl(pa);
  68         dma_addr->a32.addr_hi = (u32) htonl(upper_32_bits(pa));
  69 }
  70
  71 struct bfa_ioc_regs {
  72         void __iomem *hfn_mbox_cmd;
  73         void __iomem *hfn_mbox;
  74         void __iomem *lpu_mbox_cmd;
  75         void __iomem *lpu_mbox;
  76         void __iomem *lpu_read_stat;
  77         void __iomem *pss_ctl_reg;
  78         void __iomem *pss_err_status_reg;
  79         void __iomem *app_pll_fast_ctl_reg;
  80         void __iomem *app_pll_slow_ctl_reg;
  81         void __iomem *ioc_sem_reg;
  82         void __iomem *ioc_usage_sem_reg;
  83         void __iomem *ioc_init_sem_reg;
  84         void __iomem *ioc_usage_reg;
  85         void __iomem *host_page_num_fn;
  86         void __iomem *heartbeat;
  87         void __iomem *ioc_fwstate;
  88         void __iomem *alt_ioc_fwstate;
  89         void __iomem *ll_halt;
  90         void __iomem *alt_ll_halt;
  91         void __iomem *err_set;
  92         void __iomem *ioc_fail_sync;
  93         void __iomem *shirq_isr_next;
  94         void __iomem *shirq_msk_next;
  95         void __iomem *smem_page_start;
  96         u32     smem_pg0;
  97 };
  98
  99 /**
 100  * IOC Mailbox structures
 101  */
 102 typedef void (*bfa_mbox_cmd_cbfn_t)(void *cbarg);
 103 struct bfa_mbox_cmd {
 104         struct list_head        qe;
 105         bfa_mbox_cmd_cbfn_t     cbfn;
 106         void                *cbarg;
 107         u32     msg[BFI_IOC_MSGSZ];
 108 };
 109
 110 /**
 111  * IOC mailbox module
 112  */
 113 typedef void (*bfa_ioc_mbox_mcfunc_t)(void *cbarg, struct bfi_mbmsg *m);
 114 struct bfa_ioc_mbox_mod {
 115         struct list_head        cmd_q;          /*!< pending mbox queue */
 116         int                     nmclass;        /*!< number of handlers */
 117         struct {
 118                 bfa_ioc_mbox_mcfunc_t   cbfn;   /*!< message handlers   */
 119                 void                    *cbarg;
 120         } mbhdlr[BFI_MC_MAX];
 121 };
 122
 123 /**
 124  * IOC callback function interfaces
 125  */
 126 typedef void (*bfa_ioc_enable_cbfn_t)(void *bfa, enum bfa_status status);
 127 typedef void (*bfa_ioc_disable_cbfn_t)(void *bfa);
 128 typedef void (*bfa_ioc_hbfail_cbfn_t)(void *bfa);
 129 typedef void (*bfa_ioc_reset_cbfn_t)(void *bfa);
 130 struct bfa_ioc_cbfn {
 131         bfa_ioc_enable_cbfn_t   enable_cbfn;
 132         bfa_ioc_disable_cbfn_t  disable_cbfn;
 133         bfa_ioc_hbfail_cbfn_t   hbfail_cbfn;
 134         bfa_ioc_reset_cbfn_t    reset_cbfn;
 135 };
 136
 137 /**
 138  * IOC event notification mechanism.
 139  */
 140 enum bfa_ioc_event {
 141         BFA_IOC_E_ENABLED       = 1,
 142         BFA_IOC_E_DISABLED      = 2,
 143         BFA_IOC_E_FAILED        = 3,
 144 };
 145
 146 typedef void (*bfa_ioc_notify_cbfn_t)(void *, enum bfa_ioc_event);
 147
 148 struct bfa_ioc_notify {
 149         struct list_head        qe;
 150         bfa_ioc_notify_cbfn_t   cbfn;
 151         void                    *cbarg;
 152 };
 153
 154 /**
 155  * Initialize a IOC event notification structure
 156  */
 157 #define bfa_ioc_notify_init(__notify, __cbfn, __cbarg) do {     \
 158         (__notify)->cbfn = (__cbfn);                            \
 159         (__notify)->cbarg = (__cbarg);                          \
 160 } while (0)
 161
 162 struct bfa_iocpf {
 163         bfa_fsm_t               fsm;
 164         struct bfa_ioc          *ioc;
 165         bool                    fw_mismatch_notified;
 166         bool                    auto_recover;
 167         u32                     poll_time;
 168 };
 169
 170 struct bfa_ioc {
 171         bfa_fsm_t               fsm;
 172         struct bfa              *bfa;
 173         struct bfa_pcidev       pcidev;
 174         struct timer_list       ioc_timer;
 175         struct timer_list       iocpf_timer;
 176         struct timer_list       sem_timer;
 177         struct timer_list       hb_timer;
 178         u32                     hb_count;
 179         struct list_head        notify_q;
 180         void                    *dbg_fwsave;
 181         int                     dbg_fwsave_len;
 182         bool                    dbg_fwsave_once;
 183         enum bfi_pcifn_class    clscode;
 184         struct bfa_ioc_regs     ioc_regs;
 185         struct bfa_ioc_drv_stats stats;
 186         bool                    fcmode;
 187         bool                    pllinit;
 188         bool                    stats_busy;     /*!< outstanding stats */
 189         u8                      port_id;
 190
 191         struct bfa_dma          attr_dma;
 192         struct bfi_ioc_attr     *attr;
 193         struct bfa_ioc_cbfn     *cbfn;
 194         struct bfa_ioc_mbox_mod mbox_mod;
 195         const struct bfa_ioc_hwif *ioc_hwif;
 196         struct bfa_iocpf        iocpf;
 197         enum bfi_asic_gen       asic_gen;
 198         enum bfi_asic_mode      asic_mode;
 199         enum bfi_port_mode      port0_mode;
 200         enum bfi_port_mode      port1_mode;
 201         enum bfa_mode           port_mode;
 202         u8                      ad_cap_bm;      /*!< adapter cap bit mask */
 203         u8                      port_mode_cfg;  /*!< config port mode */
 204 };
 205
 206 struct bfa_ioc_hwif {
 207         enum bfa_status (*ioc_pll_init) (void __iomem *rb,
 208                                                 enum bfi_asic_mode m);
 209         bool            (*ioc_firmware_lock)    (struct bfa_ioc *ioc);
 210         void            (*ioc_firmware_unlock)  (struct bfa_ioc *ioc);
 211         void            (*ioc_reg_init) (struct bfa_ioc *ioc);
 212         void            (*ioc_map_port) (struct bfa_ioc *ioc);
 213         void            (*ioc_isr_mode_set)     (struct bfa_ioc *ioc,
 214                                         bool msix);
 215         void            (*ioc_notify_fail)      (struct bfa_ioc *ioc);
 216         void            (*ioc_ownership_reset)  (struct bfa_ioc *ioc);
 217         bool            (*ioc_sync_start)       (struct bfa_ioc *ioc);
 218         void            (*ioc_sync_join)        (struct bfa_ioc *ioc);
 219         void            (*ioc_sync_leave)       (struct bfa_ioc *ioc);
 220         void            (*ioc_sync_ack)         (struct bfa_ioc *ioc);
 221         bool            (*ioc_sync_complete)    (struct bfa_ioc *ioc);
 222         bool            (*ioc_lpu_read_stat)    (struct bfa_ioc *ioc);
 223 };
 224
 225 #define bfa_ioc_pcifn(__ioc)            ((__ioc)->pcidev.pci_func)
 226 #define bfa_ioc_devid(__ioc)            ((__ioc)->pcidev.device_id)
 227 #define bfa_ioc_bar0(__ioc)             ((__ioc)->pcidev.pci_bar_kva)
 228 #define bfa_ioc_portid(__ioc)           ((__ioc)->port_id)
 229 #define bfa_ioc_asic_gen(__ioc)         ((__ioc)->asic_gen)
 230 #define bfa_ioc_fetch_stats(__ioc, __stats) \
 231                 (((__stats)->drv_stats) = (__ioc)->stats)
 232 #define bfa_ioc_clr_stats(__ioc)        \
 233                 memset(&(__ioc)->stats, 0, sizeof((__ioc)->stats))
 234 #define bfa_ioc_maxfrsize(__ioc)        ((__ioc)->attr->maxfrsize)
 235 #define bfa_ioc_rx_bbcredit(__ioc)      ((__ioc)->attr->rx_bbcredit)
 236 #define bfa_ioc_speed_sup(__ioc)        \
 237         BFI_ADAPTER_GETP(SPEED, (__ioc)->attr->adapter_prop)
 238 #define bfa_ioc_get_nports(__ioc)       \
 239         BFI_ADAPTER_GETP(NPORTS, (__ioc)->attr->adapter_prop)
 240
 241 #define bfa_ioc_stats(_ioc, _stats)     ((_ioc)->stats._stats++)
 242 #define bfa_ioc_stats_hb_count(_ioc, _hb_count) \
 243         ((_ioc)->stats.hb_count = (_hb_count))
 244 #define BFA_IOC_FWIMG_MINSZ     (16 * 1024)
 245 #define BFA_IOC_FW_SMEM_SIZE(__ioc)                                     \
 246         ((bfa_ioc_asic_gen(__ioc) == BFI_ASIC_GEN_CB)                   \
 247         ? BFI_SMEM_CB_SIZE : BFI_SMEM_CT_SIZE)
 248 #define BFA_IOC_FLASH_CHUNK_NO(off)             (off / BFI_FLASH_CHUNK_SZ_WORDS)
 249 #define BFA_IOC_FLASH_OFFSET_IN_CHUNK(off)      (off % BFI_FLASH_CHUNK_SZ_WORDS)
 250 #define BFA_IOC_FLASH_CHUNK_ADDR(chunkno)  (chunkno * BFI_FLASH_CHUNK_SZ_WORDS)
 251
 252 /**
 253  * IOC mailbox interface
 254  */
 255 bool bfa_nw_ioc_mbox_queue(struct bfa_ioc *ioc,
 256                         struct bfa_mbox_cmd *cmd,
 257                         bfa_mbox_cmd_cbfn_t cbfn, void *cbarg);
 258 void bfa_nw_ioc_mbox_isr(struct bfa_ioc *ioc);
 259 void bfa_nw_ioc_mbox_regisr(struct bfa_ioc *ioc, enum bfi_mclass mc,
 260                 bfa_ioc_mbox_mcfunc_t cbfn, void *cbarg);
 261
 262 /**
 263  * IOC interfaces
 264  */
 265
 266 #define bfa_ioc_pll_init_asic(__ioc) \
 267         ((__ioc)->ioc_hwif->ioc_pll_init((__ioc)->pcidev.pci_bar_kva, \
 268                            (__ioc)->asic_mode))
 269
 270 #define bfa_ioc_isr_mode_set(__ioc, __msix) do {                        \
 271         if ((__ioc)->ioc_hwif->ioc_isr_mode_set)                        \
 272                 ((__ioc)->ioc_hwif->ioc_isr_mode_set(__ioc, __msix));   \
 273 } while (0)
 274 #define bfa_ioc_ownership_reset(__ioc)                          \
 275                         ((__ioc)->ioc_hwif->ioc_ownership_reset(__ioc))
 276
 277 #define bfa_ioc_lpu_read_stat(__ioc) do {                               \
 278                 if ((__ioc)->ioc_hwif->ioc_lpu_read_stat)               \
 279                         ((__ioc)->ioc_hwif->ioc_lpu_read_stat(__ioc));  \
 280 } while (0)
 281
 282 void bfa_nw_ioc_set_ct_hwif(struct bfa_ioc *ioc);
 283 void bfa_nw_ioc_set_ct2_hwif(struct bfa_ioc *ioc);
 284 void bfa_nw_ioc_ct2_poweron(struct bfa_ioc *ioc);
 285
 286 void bfa_nw_ioc_attach(struct bfa_ioc *ioc, void *bfa,
 287                 struct bfa_ioc_cbfn *cbfn);
 288 void bfa_nw_ioc_auto_recover(bool auto_recover);
 289 void bfa_nw_ioc_detach(struct bfa_ioc *ioc);
 290 void bfa_nw_ioc_pci_init(struct bfa_ioc *ioc, struct bfa_pcidev *pcidev,
 291                 enum bfi_pcifn_class clscode);
 292 u32 bfa_nw_ioc_meminfo(void);
 293 void bfa_nw_ioc_mem_claim(struct bfa_ioc *ioc,  u8 *dm_kva, u64 dm_pa);
 294 void bfa_nw_ioc_enable(struct bfa_ioc *ioc);
 295 void bfa_nw_ioc_disable(struct bfa_ioc *ioc);
 296
 297 void bfa_nw_ioc_error_isr(struct bfa_ioc *ioc);
 298 bool bfa_nw_ioc_is_disabled(struct bfa_ioc *ioc);
 299 void bfa_nw_ioc_get_attr(struct bfa_ioc *ioc, struct bfa_ioc_attr *ioc_attr);
 300 void bfa_nw_ioc_notify_register(struct bfa_ioc *ioc,
 301         struct bfa_ioc_notify *notify);
 302 bool bfa_nw_ioc_sem_get(void __iomem *sem_reg);
 303 void bfa_nw_ioc_sem_release(void __iomem *sem_reg);
 304 void bfa_nw_ioc_hw_sem_release(struct bfa_ioc *ioc);
 305 void bfa_nw_ioc_fwver_get(struct bfa_ioc *ioc,
 306                         struct bfi_ioc_image_hdr *fwhdr);
 307 bool bfa_nw_ioc_fwver_cmp(struct bfa_ioc *ioc,
 308                         struct bfi_ioc_image_hdr *fwhdr);
 309 mac_t bfa_nw_ioc_get_mac(struct bfa_ioc *ioc);
 310
 311 /*
 312  * Timeout APIs
 313  */
 314 void bfa_nw_ioc_timeout(void *ioc);
 315 void bfa_nw_ioc_hb_check(void *ioc);
 316 void bfa_nw_iocpf_timeout(void *ioc);
 317 void bfa_nw_iocpf_sem_timeout(void *ioc);
 318
 319 /*
 320  * F/W Image Size & Chunk
 321  */
 322 u32 *bfa_cb_image_get_chunk(enum bfi_asic_gen asic_gen, u32 off);
 323 u32 bfa_cb_image_get_size(enum bfi_asic_gen asic_gen);
 324
 325 #endif /* __BFA_IOC_H__ */