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 #define bfa_alen_set(__alen, __len, __pa)       \
  72         __bfa_alen_set(__alen, __len, (u64)__pa)
  73
  74 static inline void
  75 __bfa_alen_set(struct bfi_alen *alen, u32 len, u64 pa)
  76 {
  77         alen->al_len = cpu_to_be32(len);
  78         bfa_dma_be_addr_set(alen->al_addr, pa);
  79 }
  80
  81 struct bfa_ioc_regs {
  82         void __iomem *hfn_mbox_cmd;
  83         void __iomem *hfn_mbox;
  84         void __iomem *lpu_mbox_cmd;
  85         void __iomem *lpu_mbox;
  86         void __iomem *lpu_read_stat;
  87         void __iomem *pss_ctl_reg;
  88         void __iomem *pss_err_status_reg;
  89         void __iomem *app_pll_fast_ctl_reg;
  90         void __iomem *app_pll_slow_ctl_reg;
  91         void __iomem *ioc_sem_reg;
  92         void __iomem *ioc_usage_sem_reg;
  93         void __iomem *ioc_init_sem_reg;
  94         void __iomem *ioc_usage_reg;
  95         void __iomem *host_page_num_fn;
  96         void __iomem *heartbeat;
  97         void __iomem *ioc_fwstate;
  98         void __iomem *alt_ioc_fwstate;
  99         void __iomem *ll_halt;
 100         void __iomem *alt_ll_halt;
 101         void __iomem *err_set;
 102         void __iomem *ioc_fail_sync;
 103         void __iomem *shirq_isr_next;
 104         void __iomem *shirq_msk_next;
 105         void __iomem *smem_page_start;
 106         u32     smem_pg0;
 107 };
 108
 109 /**
 110  * IOC Mailbox structures
 111  */
 112 typedef void (*bfa_mbox_cmd_cbfn_t)(void *cbarg);
 113 struct bfa_mbox_cmd {
 114         struct list_head        qe;
 115         bfa_mbox_cmd_cbfn_t     cbfn;
 116         void                *cbarg;
 117         u32     msg[BFI_IOC_MSGSZ];
 118 };
 119
 120 /**
 121  * IOC mailbox module
 122  */
 123 typedef void (*bfa_ioc_mbox_mcfunc_t)(void *cbarg, struct bfi_mbmsg *m);
 124 struct bfa_ioc_mbox_mod {
 125         struct list_head        cmd_q;          /*!< pending mbox queue */
 126         int                     nmclass;        /*!< number of handlers */
 127         struct {
 128                 bfa_ioc_mbox_mcfunc_t   cbfn;   /*!< message handlers   */
 129                 void                    *cbarg;
 130         } mbhdlr[BFI_MC_MAX];
 131 };
 132
 133 /**
 134  * IOC callback function interfaces
 135  */
 136 typedef void (*bfa_ioc_enable_cbfn_t)(void *bfa, enum bfa_status status);
 137 typedef void (*bfa_ioc_disable_cbfn_t)(void *bfa);
 138 typedef void (*bfa_ioc_hbfail_cbfn_t)(void *bfa);
 139 typedef void (*bfa_ioc_reset_cbfn_t)(void *bfa);
 140 struct bfa_ioc_cbfn {
 141         bfa_ioc_enable_cbfn_t   enable_cbfn;
 142         bfa_ioc_disable_cbfn_t  disable_cbfn;
 143         bfa_ioc_hbfail_cbfn_t   hbfail_cbfn;
 144         bfa_ioc_reset_cbfn_t    reset_cbfn;
 145 };
 146
 147 /**
 148  * IOC event notification mechanism.
 149  */
 150 enum bfa_ioc_event {
 151         BFA_IOC_E_ENABLED       = 1,
 152         BFA_IOC_E_DISABLED      = 2,
 153         BFA_IOC_E_FAILED        = 3,
 154 };
 155
 156 typedef void (*bfa_ioc_notify_cbfn_t)(void *, enum bfa_ioc_event);
 157
 158 struct bfa_ioc_notify {
 159         struct list_head        qe;
 160         bfa_ioc_notify_cbfn_t   cbfn;
 161         void                    *cbarg;
 162 };
 163
 164 /**
 165  * Initialize a IOC event notification structure
 166  */
 167 #define bfa_ioc_notify_init(__notify, __cbfn, __cbarg) do {     \
 168         (__notify)->cbfn = (__cbfn);                            \
 169         (__notify)->cbarg = (__cbarg);                          \
 170 } while (0)
 171
 172 struct bfa_iocpf {
 173         bfa_fsm_t               fsm;
 174         struct bfa_ioc          *ioc;
 175         bool                    fw_mismatch_notified;
 176         bool                    auto_recover;
 177         u32                     poll_time;
 178 };
 179
 180 struct bfa_ioc {
 181         bfa_fsm_t               fsm;
 182         struct bfa              *bfa;
 183         struct bfa_pcidev       pcidev;
 184         struct timer_list       ioc_timer;
 185         struct timer_list       iocpf_timer;
 186         struct timer_list       sem_timer;
 187         struct timer_list       hb_timer;
 188         u32                     hb_count;
 189         struct list_head        notify_q;
 190         void                    *dbg_fwsave;
 191         int                     dbg_fwsave_len;
 192         bool                    dbg_fwsave_once;
 193         enum bfi_pcifn_class    clscode;
 194         struct bfa_ioc_regs     ioc_regs;
 195         struct bfa_ioc_drv_stats stats;
 196         bool                    fcmode;
 197         bool                    pllinit;
 198         bool                    stats_busy;     /*!< outstanding stats */
 199         u8                      port_id;
 200
 201         struct bfa_dma          attr_dma;
 202         struct bfi_ioc_attr     *attr;
 203         struct bfa_ioc_cbfn     *cbfn;
 204         struct bfa_ioc_mbox_mod mbox_mod;
 205         const struct bfa_ioc_hwif *ioc_hwif;
 206         struct bfa_iocpf        iocpf;
 207         enum bfi_asic_gen       asic_gen;
 208         enum bfi_asic_mode      asic_mode;
 209         enum bfi_port_mode      port0_mode;
 210         enum bfi_port_mode      port1_mode;
 211         enum bfa_mode           port_mode;
 212         u8                      ad_cap_bm;      /*!< adapter cap bit mask */
 213         u8                      port_mode_cfg;  /*!< config port mode */
 214 };
 215
 216 struct bfa_ioc_hwif {
 217         enum bfa_status (*ioc_pll_init) (void __iomem *rb,
 218                                                 enum bfi_asic_mode m);
 219         bool            (*ioc_firmware_lock)    (struct bfa_ioc *ioc);
 220         void            (*ioc_firmware_unlock)  (struct bfa_ioc *ioc);
 221         void            (*ioc_reg_init) (struct bfa_ioc *ioc);
 222         void            (*ioc_map_port) (struct bfa_ioc *ioc);
 223         void            (*ioc_isr_mode_set)     (struct bfa_ioc *ioc,
 224                                         bool msix);
 225         void            (*ioc_notify_fail)      (struct bfa_ioc *ioc);
 226         void            (*ioc_ownership_reset)  (struct bfa_ioc *ioc);
 227         bool            (*ioc_sync_start)       (struct bfa_ioc *ioc);
 228         void            (*ioc_sync_join)        (struct bfa_ioc *ioc);
 229         void            (*ioc_sync_leave)       (struct bfa_ioc *ioc);
 230         void            (*ioc_sync_ack)         (struct bfa_ioc *ioc);
 231         bool            (*ioc_sync_complete)    (struct bfa_ioc *ioc);
 232         bool            (*ioc_lpu_read_stat)    (struct bfa_ioc *ioc);
 233 };
 234
 235 #define bfa_ioc_pcifn(__ioc)            ((__ioc)->pcidev.pci_func)
 236 #define bfa_ioc_devid(__ioc)            ((__ioc)->pcidev.device_id)
 237 #define bfa_ioc_bar0(__ioc)             ((__ioc)->pcidev.pci_bar_kva)
 238 #define bfa_ioc_portid(__ioc)           ((__ioc)->port_id)
 239 #define bfa_ioc_asic_gen(__ioc)         ((__ioc)->asic_gen)
 240 #define bfa_ioc_fetch_stats(__ioc, __stats) \
 241                 (((__stats)->drv_stats) = (__ioc)->stats)
 242 #define bfa_ioc_clr_stats(__ioc)        \
 243                 memset(&(__ioc)->stats, 0, sizeof((__ioc)->stats))
 244 #define bfa_ioc_maxfrsize(__ioc)        ((__ioc)->attr->maxfrsize)
 245 #define bfa_ioc_rx_bbcredit(__ioc)      ((__ioc)->attr->rx_bbcredit)
 246 #define bfa_ioc_speed_sup(__ioc)        \
 247         BFI_ADAPTER_GETP(SPEED, (__ioc)->attr->adapter_prop)
 248 #define bfa_ioc_get_nports(__ioc)       \
 249         BFI_ADAPTER_GETP(NPORTS, (__ioc)->attr->adapter_prop)
 250
 251 #define bfa_ioc_stats(_ioc, _stats)     ((_ioc)->stats._stats++)
 252 #define bfa_ioc_stats_hb_count(_ioc, _hb_count) \
 253         ((_ioc)->stats.hb_count = (_hb_count))
 254 #define BFA_IOC_FWIMG_MINSZ     (16 * 1024)
 255 #define BFA_IOC_FW_SMEM_SIZE(__ioc)                                     \
 256         ((bfa_ioc_asic_gen(__ioc) == BFI_ASIC_GEN_CB)                   \
 257         ? BFI_SMEM_CB_SIZE : BFI_SMEM_CT_SIZE)
 258 #define BFA_IOC_FLASH_CHUNK_NO(off)             (off / BFI_FLASH_CHUNK_SZ_WORDS)
 259 #define BFA_IOC_FLASH_OFFSET_IN_CHUNK(off)      (off % BFI_FLASH_CHUNK_SZ_WORDS)
 260 #define BFA_IOC_FLASH_CHUNK_ADDR(chunkno)  (chunkno * BFI_FLASH_CHUNK_SZ_WORDS)
 261
 262 /**
 263  * IOC mailbox interface
 264  */
 265 bool bfa_nw_ioc_mbox_queue(struct bfa_ioc *ioc,
 266                         struct bfa_mbox_cmd *cmd,
 267                         bfa_mbox_cmd_cbfn_t cbfn, void *cbarg);
 268 void bfa_nw_ioc_mbox_isr(struct bfa_ioc *ioc);
 269 void bfa_nw_ioc_mbox_regisr(struct bfa_ioc *ioc, enum bfi_mclass mc,
 270                 bfa_ioc_mbox_mcfunc_t cbfn, void *cbarg);
 271
 272 /**
 273  * IOC interfaces
 274  */
 275
 276 #define bfa_ioc_pll_init_asic(__ioc) \
 277         ((__ioc)->ioc_hwif->ioc_pll_init((__ioc)->pcidev.pci_bar_kva, \
 278                            (__ioc)->asic_mode))
 279
 280 #define bfa_ioc_isr_mode_set(__ioc, __msix) do {                        \
 281         if ((__ioc)->ioc_hwif->ioc_isr_mode_set)                        \
 282                 ((__ioc)->ioc_hwif->ioc_isr_mode_set(__ioc, __msix));   \
 283 } while (0)
 284 #define bfa_ioc_ownership_reset(__ioc)                          \
 285                         ((__ioc)->ioc_hwif->ioc_ownership_reset(__ioc))
 286
 287 #define bfa_ioc_lpu_read_stat(__ioc) do {                               \
 288                 if ((__ioc)->ioc_hwif->ioc_lpu_read_stat)               \
 289                         ((__ioc)->ioc_hwif->ioc_lpu_read_stat(__ioc));  \
 290 } while (0)
 291
 292 void bfa_nw_ioc_set_ct_hwif(struct bfa_ioc *ioc);
 293 void bfa_nw_ioc_set_ct2_hwif(struct bfa_ioc *ioc);
 294 void bfa_nw_ioc_ct2_poweron(struct bfa_ioc *ioc);
 295
 296 void bfa_nw_ioc_attach(struct bfa_ioc *ioc, void *bfa,
 297                 struct bfa_ioc_cbfn *cbfn);
 298 void bfa_nw_ioc_auto_recover(bool auto_recover);
 299 void bfa_nw_ioc_detach(struct bfa_ioc *ioc);
 300 void bfa_nw_ioc_pci_init(struct bfa_ioc *ioc, struct bfa_pcidev *pcidev,
 301                 enum bfi_pcifn_class clscode);
 302 u32 bfa_nw_ioc_meminfo(void);
 303 void bfa_nw_ioc_mem_claim(struct bfa_ioc *ioc,  u8 *dm_kva, u64 dm_pa);
 304 void bfa_nw_ioc_enable(struct bfa_ioc *ioc);
 305 void bfa_nw_ioc_disable(struct bfa_ioc *ioc);
 306
 307 void bfa_nw_ioc_error_isr(struct bfa_ioc *ioc);
 308 bool bfa_nw_ioc_is_disabled(struct bfa_ioc *ioc);
 309 void bfa_nw_ioc_get_attr(struct bfa_ioc *ioc, struct bfa_ioc_attr *ioc_attr);
 310 void bfa_nw_ioc_notify_register(struct bfa_ioc *ioc,
 311         struct bfa_ioc_notify *notify);
 312 bool bfa_nw_ioc_sem_get(void __iomem *sem_reg);
 313 void bfa_nw_ioc_sem_release(void __iomem *sem_reg);
 314 void bfa_nw_ioc_hw_sem_release(struct bfa_ioc *ioc);
 315 void bfa_nw_ioc_fwver_get(struct bfa_ioc *ioc,
 316                         struct bfi_ioc_image_hdr *fwhdr);
 317 bool bfa_nw_ioc_fwver_cmp(struct bfa_ioc *ioc,
 318                         struct bfi_ioc_image_hdr *fwhdr);
 319 mac_t bfa_nw_ioc_get_mac(struct bfa_ioc *ioc);
 320
 321 /*
 322  * Timeout APIs
 323  */
 324 void bfa_nw_ioc_timeout(void *ioc);
 325 void bfa_nw_ioc_hb_check(void *ioc);
 326 void bfa_nw_iocpf_timeout(void *ioc);
 327 void bfa_nw_iocpf_sem_timeout(void *ioc);
 328
 329 /*
 330  * F/W Image Size & Chunk
 331  */
 332 u32 *bfa_cb_image_get_chunk(enum bfi_asic_gen asic_gen, u32 off);
 333 u32 bfa_cb_image_get_size(enum bfi_asic_gen asic_gen);
 334
 335 /*
 336  *      Flash module specific
 337  */
 338 typedef void    (*bfa_cb_flash) (void *cbarg, enum bfa_status status);
 339
 340 struct bfa_flash {
 341         struct bfa_ioc *ioc;            /* back pointer to ioc */
 342         u32             type;           /* partition type */
 343         u8              instance;       /* partition instance */
 344         u8              rsv[3];
 345         u32             op_busy;        /*  operation busy flag */
 346         u32             residue;        /*  residual length */
 347         u32             offset;         /*  offset */
 348         enum bfa_status status;         /*  status */
 349         u8              *dbuf_kva;      /*  dma buf virtual address */
 350         u64             dbuf_pa;        /*  dma buf physical address */
 351         bfa_cb_flash    cbfn;           /*  user callback function */
 352         void            *cbarg;         /*  user callback arg */
 353         u8              *ubuf;          /*  user supplied buffer */
 354         u32             addr_off;       /*  partition address offset */
 355         struct bfa_mbox_cmd mb;         /*  mailbox */
 356         struct bfa_ioc_notify ioc_notify; /*  ioc event notify */
 357 };
 358
 359 enum bfa_status bfa_nw_flash_get_attr(struct bfa_flash *flash,
 360                         struct bfa_flash_attr *attr,
 361                         bfa_cb_flash cbfn, void *cbarg);
 362 enum bfa_status bfa_nw_flash_update_part(struct bfa_flash *flash,
 363                         u32 type, u8 instance, void *buf, u32 len, u32 offset,
 364                         bfa_cb_flash cbfn, void *cbarg);
 365 enum bfa_status bfa_nw_flash_read_part(struct bfa_flash *flash,
 366                         u32 type, u8 instance, void *buf, u32 len, u32 offset,
 367                         bfa_cb_flash cbfn, void *cbarg);
 368 u32     bfa_nw_flash_meminfo(void);
 369 void    bfa_nw_flash_attach(struct bfa_flash *flash,
 370                             struct bfa_ioc *ioc, void *dev);
 371 void    bfa_nw_flash_memclaim(struct bfa_flash *flash, u8 *dm_kva, u64 dm_pa);
 372
 373 #endif /* __BFA_IOC_H__ */