Pileus Git - ~andy/linux/blob - drivers/scsi/bfa/bfa_ioc.h

   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 #ifndef __BFA_IOC_H__
  19 #define __BFA_IOC_H__
  20
  21 #include "bfad_drv.h"
  22 #include "bfa_cs.h"
  23 #include "bfi.h"
  24
  25 #define BFA_DBG_FWTRC_ENTS      (BFI_IOC_TRC_ENTS)
  26 #define BFA_DBG_FWTRC_LEN                                       \
  27         (BFA_DBG_FWTRC_ENTS * sizeof(struct bfa_trc_s) +        \
  28         (sizeof(struct bfa_trc_mod_s) -                         \
  29         BFA_TRC_MAX * sizeof(struct bfa_trc_s)))
  30 /*
  31  * BFA timer declarations
  32  */
  33 typedef void (*bfa_timer_cbfn_t)(void *);
  34
  35 /*
  36  * BFA timer data structure
  37  */
  38 struct bfa_timer_s {
  39         struct list_head        qe;
  40         bfa_timer_cbfn_t timercb;
  41         void            *arg;
  42         int             timeout;        /* in millisecs */
  43 };
  44
  45 /*
  46  * Timer module structure
  47  */
  48 struct bfa_timer_mod_s {
  49         struct list_head timer_q;
  50 };
  51
  52 #define BFA_TIMER_FREQ 200 /* specified in millisecs */
  53
  54 void bfa_timer_beat(struct bfa_timer_mod_s *mod);
  55 void bfa_timer_begin(struct bfa_timer_mod_s *mod, struct bfa_timer_s *timer,
  56                         bfa_timer_cbfn_t timercb, void *arg,
  57                         unsigned int timeout);
  58 void bfa_timer_stop(struct bfa_timer_s *timer);
  59
  60 /*
  61  * Generic Scatter Gather Element used by driver
  62  */
  63 struct bfa_sge_s {
  64         u32     sg_len;
  65         void            *sg_addr;
  66 };
  67
  68 #define bfa_sge_word_swap(__sge) do {                                        \
  69         ((u32 *)(__sge))[0] = swab32(((u32 *)(__sge))[0]);      \
  70         ((u32 *)(__sge))[1] = swab32(((u32 *)(__sge))[1]);      \
  71         ((u32 *)(__sge))[2] = swab32(((u32 *)(__sge))[2]);      \
  72 } while (0)
  73
  74 #define bfa_swap_words(_x)  (   \
  75         ((_x) << 32) | ((_x) >> 32))
  76
  77 #ifdef __BIG_ENDIAN
  78 #define bfa_sge_to_be(_x)
  79 #define bfa_sge_to_le(_x)       bfa_sge_word_swap(_x)
  80 #define bfa_sgaddr_le(_x)       bfa_swap_words(_x)
  81 #else
  82 #define bfa_sge_to_be(_x)       bfa_sge_word_swap(_x)
  83 #define bfa_sge_to_le(_x)
  84 #define bfa_sgaddr_le(_x)       (_x)
  85 #endif
  86
  87 /*
  88  * BFA memory resources
  89  */
  90 struct bfa_mem_dma_s {
  91         struct list_head qe;            /* Queue of DMA elements */
  92         u32             mem_len;        /* Total Length in Bytes */
  93         u8              *kva;           /* kernel virtual address */
  94         u64             dma;            /* dma address if DMA memory */
  95         u8              *kva_curp;      /* kva allocation cursor */
  96         u64             dma_curp;       /* dma allocation cursor */
  97 };
  98 #define bfa_mem_dma_t struct bfa_mem_dma_s
  99
 100 struct bfa_mem_kva_s {
 101         struct list_head qe;            /* Queue of KVA elements */
 102         u32             mem_len;        /* Total Length in Bytes */
 103         u8              *kva;           /* kernel virtual address */
 104         u8              *kva_curp;      /* kva allocation cursor */
 105 };
 106 #define bfa_mem_kva_t struct bfa_mem_kva_s
 107
 108 struct bfa_meminfo_s {
 109         struct bfa_mem_dma_s dma_info;
 110         struct bfa_mem_kva_s kva_info;
 111 };
 112
 113 /* BFA memory segment setup macros */
 114 #define bfa_mem_dma_setup(_meminfo, _dm_ptr, _seg_sz) do {      \
 115         ((bfa_mem_dma_t *)(_dm_ptr))->mem_len = (_seg_sz);      \
 116         if (_seg_sz)                                            \
 117                 list_add_tail(&((bfa_mem_dma_t *)_dm_ptr)->qe,  \
 118                               &(_meminfo)->dma_info.qe);        \
 119 } while (0)
 120
 121 #define bfa_mem_kva_setup(_meminfo, _kva_ptr, _seg_sz) do {     \
 122         ((bfa_mem_kva_t *)(_kva_ptr))->mem_len = (_seg_sz);     \
 123         if (_seg_sz)                                            \
 124                 list_add_tail(&((bfa_mem_kva_t *)_kva_ptr)->qe, \
 125                               &(_meminfo)->kva_info.qe);        \
 126 } while (0)
 127
 128 /* BFA dma memory segments iterator */
 129 #define bfa_mem_dma_sptr(_mod, _i)      (&(_mod)->dma_seg[(_i)])
 130 #define bfa_mem_dma_seg_iter(_mod, _sptr, _nr, _i)                      \
 131         for (_i = 0, _sptr = bfa_mem_dma_sptr(_mod, _i); _i < (_nr);    \
 132              _i++, _sptr = bfa_mem_dma_sptr(_mod, _i))
 133
 134 #define bfa_mem_kva_curp(_mod)  ((_mod)->kva_seg.kva_curp)
 135 #define bfa_mem_dma_virt(_sptr) ((_sptr)->kva_curp)
 136 #define bfa_mem_dma_phys(_sptr) ((_sptr)->dma_curp)
 137 #define bfa_mem_dma_len(_sptr)  ((_sptr)->mem_len)
 138
 139 /* Get the corresponding dma buf kva for a req - from the tag */
 140 #define bfa_mem_get_dmabuf_kva(_mod, _tag, _rqsz)                             \
 141         (((u8 *)(_mod)->dma_seg[BFI_MEM_SEG_FROM_TAG(_tag, _rqsz)].kva_curp) +\
 142          BFI_MEM_SEG_REQ_OFFSET(_tag, _rqsz) * (_rqsz))
 143
 144 /* Get the corresponding dma buf pa for a req - from the tag */
 145 #define bfa_mem_get_dmabuf_pa(_mod, _tag, _rqsz)                        \
 146         ((_mod)->dma_seg[BFI_MEM_SEG_FROM_TAG(_tag, _rqsz)].dma_curp +  \
 147          BFI_MEM_SEG_REQ_OFFSET(_tag, _rqsz) * (_rqsz))
 148
 149 /*
 150  * PCI device information required by IOC
 151  */
 152 struct bfa_pcidev_s {
 153         int             pci_slot;
 154         u8              pci_func;
 155         u16             device_id;
 156         u16             ssid;
 157         void __iomem    *pci_bar_kva;
 158 };
 159
 160 /*
 161  * Structure used to remember the DMA-able memory block's KVA and Physical
 162  * Address
 163  */
 164 struct bfa_dma_s {
 165         void            *kva;   /* ! Kernel virtual address     */
 166         u64     pa;     /* ! Physical address           */
 167 };
 168
 169 #define BFA_DMA_ALIGN_SZ        256
 170 #define BFA_ROUNDUP(_l, _s)     (((_l) + ((_s) - 1)) & ~((_s) - 1))
 171
 172 /*
 173  * smem size for Crossbow and Catapult
 174  */
 175 #define BFI_SMEM_CB_SIZE        0x200000U       /* ! 2MB for crossbow   */
 176 #define BFI_SMEM_CT_SIZE        0x280000U       /* ! 2.5MB for catapult */
 177
 178 #define bfa_dma_be_addr_set(dma_addr, pa)       \
 179                 __bfa_dma_be_addr_set(&dma_addr, (u64)pa)
 180 static inline void
 181 __bfa_dma_be_addr_set(union bfi_addr_u *dma_addr, u64 pa)
 182 {
 183         dma_addr->a32.addr_lo = cpu_to_be32(pa);
 184         dma_addr->a32.addr_hi = cpu_to_be32(pa >> 32);
 185 }
 186
 187 #define bfa_alen_set(__alen, __len, __pa)       \
 188         __bfa_alen_set(__alen, __len, (u64)__pa)
 189
 190 static inline void
 191 __bfa_alen_set(struct bfi_alen_s *alen, u32 len, u64 pa)
 192 {
 193         alen->al_len = cpu_to_be32(len);
 194         bfa_dma_be_addr_set(alen->al_addr, pa);
 195 }
 196
 197 struct bfa_ioc_regs_s {
 198         void __iomem *hfn_mbox_cmd;
 199         void __iomem *hfn_mbox;
 200         void __iomem *lpu_mbox_cmd;
 201         void __iomem *lpu_mbox;
 202         void __iomem *lpu_read_stat;
 203         void __iomem *pss_ctl_reg;
 204         void __iomem *pss_err_status_reg;
 205         void __iomem *app_pll_fast_ctl_reg;
 206         void __iomem *app_pll_slow_ctl_reg;
 207         void __iomem *ioc_sem_reg;
 208         void __iomem *ioc_usage_sem_reg;
 209         void __iomem *ioc_init_sem_reg;
 210         void __iomem *ioc_usage_reg;
 211         void __iomem *host_page_num_fn;
 212         void __iomem *heartbeat;
 213         void __iomem *ioc_fwstate;
 214         void __iomem *alt_ioc_fwstate;
 215         void __iomem *ll_halt;
 216         void __iomem *alt_ll_halt;
 217         void __iomem *err_set;
 218         void __iomem *ioc_fail_sync;
 219         void __iomem *shirq_isr_next;
 220         void __iomem *shirq_msk_next;
 221         void __iomem *smem_page_start;
 222         u32     smem_pg0;
 223 };
 224
 225 #define bfa_mem_read(_raddr, _off)      swab32(readl(((_raddr) + (_off))))
 226 #define bfa_mem_write(_raddr, _off, _val)       \
 227                         writel(swab32((_val)), ((_raddr) + (_off)))
 228 /*
 229  * IOC Mailbox structures
 230  */
 231 struct bfa_mbox_cmd_s {
 232         struct list_head        qe;
 233         u32     msg[BFI_IOC_MSGSZ];
 234 };
 235
 236 /*
 237  * IOC mailbox module
 238  */
 239 typedef void (*bfa_ioc_mbox_mcfunc_t)(void *cbarg, struct bfi_mbmsg_s *m);
 240 struct bfa_ioc_mbox_mod_s {
 241         struct list_head                cmd_q;  /*  pending mbox queue  */
 242         int                     nmclass;        /*  number of handlers */
 243         struct {
 244                 bfa_ioc_mbox_mcfunc_t   cbfn;   /*  message handlers    */
 245                 void                    *cbarg;
 246         } mbhdlr[BFI_MC_MAX];
 247 };
 248
 249 /*
 250  * IOC callback function interfaces
 251  */
 252 typedef void (*bfa_ioc_enable_cbfn_t)(void *bfa, enum bfa_status status);
 253 typedef void (*bfa_ioc_disable_cbfn_t)(void *bfa);
 254 typedef void (*bfa_ioc_hbfail_cbfn_t)(void *bfa);
 255 typedef void (*bfa_ioc_reset_cbfn_t)(void *bfa);
 256 struct bfa_ioc_cbfn_s {
 257         bfa_ioc_enable_cbfn_t   enable_cbfn;
 258         bfa_ioc_disable_cbfn_t  disable_cbfn;
 259         bfa_ioc_hbfail_cbfn_t   hbfail_cbfn;
 260         bfa_ioc_reset_cbfn_t    reset_cbfn;
 261 };
 262
 263 /*
 264  * IOC event notification mechanism.
 265  */
 266 enum bfa_ioc_event_e {
 267         BFA_IOC_E_ENABLED       = 1,
 268         BFA_IOC_E_DISABLED      = 2,
 269         BFA_IOC_E_FAILED        = 3,
 270 };
 271
 272 typedef void (*bfa_ioc_notify_cbfn_t)(void *, enum bfa_ioc_event_e);
 273
 274 struct bfa_ioc_notify_s {
 275         struct list_head                qe;
 276         bfa_ioc_notify_cbfn_t   cbfn;
 277         void                    *cbarg;
 278 };
 279
 280 /*
 281  * Initialize a IOC event notification structure
 282  */
 283 #define bfa_ioc_notify_init(__notify, __cbfn, __cbarg) do {     \
 284         (__notify)->cbfn = (__cbfn);      \
 285         (__notify)->cbarg = (__cbarg);      \
 286 } while (0)
 287
 288 struct bfa_iocpf_s {
 289         bfa_fsm_t               fsm;
 290         struct bfa_ioc_s        *ioc;
 291         bfa_boolean_t           fw_mismatch_notified;
 292         bfa_boolean_t           auto_recover;
 293         u32                     poll_time;
 294 };
 295
 296 struct bfa_ioc_s {
 297         bfa_fsm_t               fsm;
 298         struct bfa_s            *bfa;
 299         struct bfa_pcidev_s     pcidev;
 300         struct bfa_timer_mod_s  *timer_mod;
 301         struct bfa_timer_s      ioc_timer;
 302         struct bfa_timer_s      sem_timer;
 303         struct bfa_timer_s      hb_timer;
 304         u32             hb_count;
 305         struct list_head        notify_q;
 306         void                    *dbg_fwsave;
 307         int                     dbg_fwsave_len;
 308         bfa_boolean_t           dbg_fwsave_once;
 309         enum bfi_pcifn_class    clscode;
 310         struct bfa_ioc_regs_s   ioc_regs;
 311         struct bfa_trc_mod_s    *trcmod;
 312         struct bfa_ioc_drv_stats_s      stats;
 313         bfa_boolean_t           fcmode;
 314         bfa_boolean_t           pllinit;
 315         bfa_boolean_t           stats_busy;     /*  outstanding stats */
 316         u8                      port_id;
 317         struct bfa_dma_s        attr_dma;
 318         struct bfi_ioc_attr_s   *attr;
 319         struct bfa_ioc_cbfn_s   *cbfn;
 320         struct bfa_ioc_mbox_mod_s mbox_mod;
 321         struct bfa_ioc_hwif_s   *ioc_hwif;
 322         struct bfa_iocpf_s      iocpf;
 323         enum bfi_asic_gen       asic_gen;
 324         enum bfi_asic_mode      asic_mode;
 325         enum bfi_port_mode      port0_mode;
 326         enum bfi_port_mode      port1_mode;
 327         enum bfa_mode_s         port_mode;
 328         u8                      ad_cap_bm;      /* adapter cap bit mask */
 329         u8                      port_mode_cfg;  /* config port mode */
 330 };
 331
 332 struct bfa_ioc_hwif_s {
 333         bfa_status_t (*ioc_pll_init) (void __iomem *rb, enum bfi_asic_mode m);
 334         bfa_boolean_t   (*ioc_firmware_lock)    (struct bfa_ioc_s *ioc);
 335         void            (*ioc_firmware_unlock)  (struct bfa_ioc_s *ioc);
 336         void            (*ioc_reg_init) (struct bfa_ioc_s *ioc);
 337         void            (*ioc_map_port) (struct bfa_ioc_s *ioc);
 338         void            (*ioc_isr_mode_set)     (struct bfa_ioc_s *ioc,
 339                                         bfa_boolean_t msix);
 340         void            (*ioc_notify_fail)      (struct bfa_ioc_s *ioc);
 341         void            (*ioc_ownership_reset)  (struct bfa_ioc_s *ioc);
 342         bfa_boolean_t   (*ioc_sync_start)       (struct bfa_ioc_s *ioc);
 343         void            (*ioc_sync_join)        (struct bfa_ioc_s *ioc);
 344         void            (*ioc_sync_leave)       (struct bfa_ioc_s *ioc);
 345         void            (*ioc_sync_ack)         (struct bfa_ioc_s *ioc);
 346         bfa_boolean_t   (*ioc_sync_complete)    (struct bfa_ioc_s *ioc);
 347         bfa_boolean_t   (*ioc_lpu_read_stat)    (struct bfa_ioc_s *ioc);
 348 };
 349
 350 /*
 351  * Queue element to wait for room in request queue. FIFO order is
 352  * maintained when fullfilling requests.
 353  */
 354 struct bfa_reqq_wait_s {
 355         struct list_head        qe;
 356         void    (*qresume) (void *cbarg);
 357         void    *cbarg;
 358 };
 359
 360 typedef void    (*bfa_cb_cbfn_t) (void *cbarg, bfa_boolean_t complete);
 361
 362 /*
 363  * Generic BFA callback element.
 364  */
 365 struct bfa_cb_qe_s {
 366         struct list_head        qe;
 367         bfa_cb_cbfn_t   cbfn;
 368         bfa_boolean_t   once;
 369         void            *cbarg;
 370 };
 371
 372 /*
 373  * ASIC block configurtion related
 374  */
 375
 376 typedef void (*bfa_ablk_cbfn_t)(void *, enum bfa_status);
 377
 378 struct bfa_ablk_s {
 379         struct bfa_ioc_s        *ioc;
 380         struct bfa_ablk_cfg_s   *cfg;
 381         u16                     *pcifn;
 382         struct bfa_dma_s        dma_addr;
 383         bfa_boolean_t           busy;
 384         struct bfa_mbox_cmd_s   mb;
 385         bfa_ablk_cbfn_t         cbfn;
 386         void                    *cbarg;
 387         struct bfa_ioc_notify_s ioc_notify;
 388         struct bfa_mem_dma_s    ablk_dma;
 389 };
 390 #define BFA_MEM_ABLK_DMA(__bfa)         (&((__bfa)->modules.ablk.ablk_dma))
 391
 392 /*
 393  *      SFP module specific
 394  */
 395 typedef void    (*bfa_cb_sfp_t) (void *cbarg, bfa_status_t status);
 396
 397 struct bfa_sfp_s {
 398         void    *dev;
 399         struct bfa_ioc_s        *ioc;
 400         struct bfa_trc_mod_s    *trcmod;
 401         struct sfp_mem_s        *sfpmem;
 402         bfa_cb_sfp_t            cbfn;
 403         void                    *cbarg;
 404         enum bfi_sfp_mem_e      memtype; /* mem access type   */
 405         u32                     status;
 406         struct bfa_mbox_cmd_s   mbcmd;
 407         u8                      *dbuf_kva; /* dma buf virtual address */
 408         u64                     dbuf_pa;   /* dma buf physical address */
 409         struct bfa_ioc_notify_s ioc_notify;
 410         enum bfa_defs_sfp_media_e *media;
 411         enum bfa_port_speed     portspeed;
 412         bfa_cb_sfp_t            state_query_cbfn;
 413         void                    *state_query_cbarg;
 414         u8                      lock;
 415         u8                      data_valid; /* data in dbuf is valid */
 416         u8                      state;      /* sfp state  */
 417         u8                      state_query_lock;
 418         struct bfa_mem_dma_s    sfp_dma;
 419         u8                      is_elb;     /* eloopback  */
 420 };
 421
 422 #define BFA_SFP_MOD(__bfa)      (&(__bfa)->modules.sfp)
 423 #define BFA_MEM_SFP_DMA(__bfa)  (&(BFA_SFP_MOD(__bfa)->sfp_dma))
 424
 425 u32     bfa_sfp_meminfo(void);
 426
 427 void    bfa_sfp_attach(struct bfa_sfp_s *sfp, struct bfa_ioc_s *ioc,
 428                         void *dev, struct bfa_trc_mod_s *trcmod);
 429
 430 void    bfa_sfp_memclaim(struct bfa_sfp_s *diag, u8 *dm_kva, u64 dm_pa);
 431 void    bfa_sfp_intr(void *bfaarg, struct bfi_mbmsg_s *msg);
 432
 433 bfa_status_t    bfa_sfp_show(struct bfa_sfp_s *sfp, struct sfp_mem_s *sfpmem,
 434                              bfa_cb_sfp_t cbfn, void *cbarg);
 435
 436 bfa_status_t    bfa_sfp_media(struct bfa_sfp_s *sfp,
 437                         enum bfa_defs_sfp_media_e *media,
 438                         bfa_cb_sfp_t cbfn, void *cbarg);
 439
 440 bfa_status_t    bfa_sfp_speed(struct bfa_sfp_s *sfp,
 441                         enum bfa_port_speed portspeed,
 442                         bfa_cb_sfp_t cbfn, void *cbarg);
 443
 444 /*
 445  *      Flash module specific
 446  */
 447 typedef void    (*bfa_cb_flash_t) (void *cbarg, bfa_status_t status);
 448
 449 struct bfa_flash_s {
 450         struct bfa_ioc_s *ioc;          /* back pointer to ioc */
 451         struct bfa_trc_mod_s *trcmod;
 452         u32             type;           /* partition type */
 453         u8              instance;       /* partition instance */
 454         u8              rsv[3];
 455         u32             op_busy;        /*  operation busy flag */
 456         u32             residue;        /*  residual length */
 457         u32             offset;         /*  offset */
 458         bfa_status_t    status;         /*  status */
 459         u8              *dbuf_kva;      /*  dma buf virtual address */
 460         u64             dbuf_pa;        /*  dma buf physical address */
 461         struct bfa_reqq_wait_s  reqq_wait; /*  to wait for room in reqq */
 462         bfa_cb_flash_t  cbfn;           /*  user callback function */
 463         void            *cbarg;         /*  user callback arg */
 464         u8              *ubuf;          /*  user supplied buffer */
 465         struct bfa_cb_qe_s      hcb_qe; /*  comp: BFA callback qelem */
 466         u32             addr_off;       /*  partition address offset */
 467         struct bfa_mbox_cmd_s   mb;       /*  mailbox */
 468         struct bfa_ioc_notify_s ioc_notify; /*  ioc event notify */
 469         struct bfa_mem_dma_s    flash_dma;
 470 };
 471
 472 #define BFA_FLASH(__bfa)                (&(__bfa)->modules.flash)
 473 #define BFA_MEM_FLASH_DMA(__bfa)        (&(BFA_FLASH(__bfa)->flash_dma))
 474
 475 bfa_status_t bfa_flash_get_attr(struct bfa_flash_s *flash,
 476                         struct bfa_flash_attr_s *attr,
 477                         bfa_cb_flash_t cbfn, void *cbarg);
 478 bfa_status_t bfa_flash_erase_part(struct bfa_flash_s *flash,
 479                         enum bfa_flash_part_type type, u8 instance,
 480                         bfa_cb_flash_t cbfn, void *cbarg);
 481 bfa_status_t bfa_flash_update_part(struct bfa_flash_s *flash,
 482                         enum bfa_flash_part_type type, u8 instance,
 483                         void *buf, u32 len, u32 offset,
 484                         bfa_cb_flash_t cbfn, void *cbarg);
 485 bfa_status_t bfa_flash_read_part(struct bfa_flash_s *flash,
 486                         enum bfa_flash_part_type type, u8 instance, void *buf,
 487                         u32 len, u32 offset, bfa_cb_flash_t cbfn, void *cbarg);
 488 u32     bfa_flash_meminfo(bfa_boolean_t mincfg);
 489 void bfa_flash_attach(struct bfa_flash_s *flash, struct bfa_ioc_s *ioc,
 490                 void *dev, struct bfa_trc_mod_s *trcmod, bfa_boolean_t mincfg);
 491 void bfa_flash_memclaim(struct bfa_flash_s *flash,
 492                 u8 *dm_kva, u64 dm_pa, bfa_boolean_t mincfg);
 493
 494 /*
 495  *      DIAG module specific
 496  */
 497
 498 typedef void (*bfa_cb_diag_t) (void *cbarg, bfa_status_t status);
 499 typedef void (*bfa_cb_diag_beacon_t) (void *dev, bfa_boolean_t beacon,
 500                         bfa_boolean_t link_e2e_beacon);
 501
 502 /*
 503  *      Firmware ping test results
 504  */
 505 struct bfa_diag_results_fwping {
 506         u32     data;   /* store the corrupted data */
 507         u32     status;
 508         u32     dmastatus;
 509         u8      rsvd[4];
 510 };
 511
 512 struct bfa_diag_qtest_result_s {
 513         u32     status;
 514         u16     count;  /* sucessful queue test count */
 515         u8      queue;
 516         u8      rsvd;   /* 64-bit align */
 517 };
 518
 519 /*
 520  * Firmware ping test results
 521  */
 522 struct bfa_diag_fwping_s {
 523         struct bfa_diag_results_fwping *result;
 524         bfa_cb_diag_t  cbfn;
 525         void            *cbarg;
 526         u32             data;
 527         u8              lock;
 528         u8              rsv[3];
 529         u32             status;
 530         u32             count;
 531         struct bfa_mbox_cmd_s   mbcmd;
 532         u8              *dbuf_kva;      /* dma buf virtual address */
 533         u64             dbuf_pa;        /* dma buf physical address */
 534 };
 535
 536 /*
 537  *      Temperature sensor query results
 538  */
 539 struct bfa_diag_results_tempsensor_s {
 540         u32     status;
 541         u16     temp;           /* 10-bit A/D value */
 542         u16     brd_temp;       /* 9-bit board temp */
 543         u8      ts_junc;        /* show junction tempsensor   */
 544         u8      ts_brd;         /* show board tempsensor      */
 545         u8      rsvd[6];        /* keep 8 bytes alignment     */
 546 };
 547
 548 struct bfa_diag_tsensor_s {
 549         bfa_cb_diag_t   cbfn;
 550         void            *cbarg;
 551         struct bfa_diag_results_tempsensor_s *temp;
 552         u8              lock;
 553         u8              rsv[3];
 554         u32             status;
 555         struct bfa_mbox_cmd_s   mbcmd;
 556 };
 557
 558 struct bfa_diag_sfpshow_s {
 559         struct sfp_mem_s        *sfpmem;
 560         bfa_cb_diag_t           cbfn;
 561         void                    *cbarg;
 562         u8      lock;
 563         u8      static_data;
 564         u8      rsv[2];
 565         u32     status;
 566         struct bfa_mbox_cmd_s    mbcmd;
 567         u8      *dbuf_kva;      /* dma buf virtual address */
 568         u64     dbuf_pa;        /* dma buf physical address */
 569 };
 570
 571 struct bfa_diag_led_s {
 572         struct bfa_mbox_cmd_s   mbcmd;
 573         bfa_boolean_t   lock;   /* 1: ledtest is operating */
 574 };
 575
 576 struct bfa_diag_beacon_s {
 577         struct bfa_mbox_cmd_s   mbcmd;
 578         bfa_boolean_t   state;          /* port beacon state */
 579         bfa_boolean_t   link_e2e;       /* link beacon state */
 580 };
 581
 582 struct bfa_diag_s {
 583         void    *dev;
 584         struct bfa_ioc_s                *ioc;
 585         struct bfa_trc_mod_s            *trcmod;
 586         struct bfa_diag_fwping_s        fwping;
 587         struct bfa_diag_tsensor_s       tsensor;
 588         struct bfa_diag_sfpshow_s       sfpshow;
 589         struct bfa_diag_led_s           ledtest;
 590         struct bfa_diag_beacon_s        beacon;
 591         void    *result;
 592         struct bfa_timer_s timer;
 593         bfa_cb_diag_beacon_t  cbfn_beacon;
 594         bfa_cb_diag_t  cbfn;
 595         void            *cbarg;
 596         u8              block;
 597         u8              timer_active;
 598         u8              rsvd[2];
 599         u32             status;
 600         struct bfa_ioc_notify_s ioc_notify;
 601         struct bfa_mem_dma_s    diag_dma;
 602 };
 603
 604 #define BFA_DIAG_MOD(__bfa)     (&(__bfa)->modules.diag_mod)
 605 #define BFA_MEM_DIAG_DMA(__bfa) (&(BFA_DIAG_MOD(__bfa)->diag_dma))
 606
 607 u32     bfa_diag_meminfo(void);
 608 void bfa_diag_memclaim(struct bfa_diag_s *diag, u8 *dm_kva, u64 dm_pa);
 609 void bfa_diag_attach(struct bfa_diag_s *diag, struct bfa_ioc_s *ioc, void *dev,
 610                      bfa_cb_diag_beacon_t cbfn_beacon,
 611                      struct bfa_trc_mod_s *trcmod);
 612 bfa_status_t    bfa_diag_reg_read(struct bfa_diag_s *diag, u32 offset,
 613                         u32 len, u32 *buf, u32 force);
 614 bfa_status_t    bfa_diag_reg_write(struct bfa_diag_s *diag, u32 offset,
 615                         u32 len, u32 value, u32 force);
 616 bfa_status_t    bfa_diag_tsensor_query(struct bfa_diag_s *diag,
 617                         struct bfa_diag_results_tempsensor_s *result,
 618                         bfa_cb_diag_t cbfn, void *cbarg);
 619 bfa_status_t    bfa_diag_fwping(struct bfa_diag_s *diag, u32 cnt,
 620                         u32 pattern, struct bfa_diag_results_fwping *result,
 621                         bfa_cb_diag_t cbfn, void *cbarg);
 622 bfa_status_t    bfa_diag_sfpshow(struct bfa_diag_s *diag,
 623                         struct sfp_mem_s *sfpmem, u8 static_data,
 624                         bfa_cb_diag_t cbfn, void *cbarg);
 625 bfa_status_t    bfa_diag_memtest(struct bfa_diag_s *diag,
 626                         struct bfa_diag_memtest_s *memtest, u32 pattern,
 627                         struct bfa_diag_memtest_result *result,
 628                         bfa_cb_diag_t cbfn, void *cbarg);
 629 bfa_status_t    bfa_diag_ledtest(struct bfa_diag_s *diag,
 630                         struct bfa_diag_ledtest_s *ledtest);
 631 bfa_status_t    bfa_diag_beacon_port(struct bfa_diag_s *diag,
 632                         bfa_boolean_t beacon, bfa_boolean_t link_e2e_beacon,
 633                         u32 sec);
 634
 635 /*
 636  *      PHY module specific
 637  */
 638 typedef void (*bfa_cb_phy_t) (void *cbarg, bfa_status_t status);
 639
 640 struct bfa_phy_s {
 641         struct bfa_ioc_s *ioc;          /* back pointer to ioc */
 642         struct bfa_trc_mod_s *trcmod;   /* trace module */
 643         u8      instance;       /* port instance */
 644         u8      op_busy;        /* operation busy flag */
 645         u8      rsv[2];
 646         u32     residue;        /* residual length */
 647         u32     offset;         /* offset */
 648         bfa_status_t    status;         /* status */
 649         u8      *dbuf_kva;      /* dma buf virtual address */
 650         u64     dbuf_pa;        /* dma buf physical address */
 651         struct bfa_reqq_wait_s reqq_wait; /* to wait for room in reqq */
 652         bfa_cb_phy_t    cbfn;           /* user callback function */
 653         void            *cbarg;         /* user callback arg */
 654         u8              *ubuf;          /* user supplied buffer */
 655         struct bfa_cb_qe_s      hcb_qe; /* comp: BFA callback qelem */
 656         u32     addr_off;       /* phy address offset */
 657         struct bfa_mbox_cmd_s   mb;       /* mailbox */
 658         struct bfa_ioc_notify_s ioc_notify; /* ioc event notify */
 659         struct bfa_mem_dma_s    phy_dma;
 660 };
 661
 662 #define BFA_PHY(__bfa)  (&(__bfa)->modules.phy)
 663 #define BFA_MEM_PHY_DMA(__bfa)  (&(BFA_PHY(__bfa)->phy_dma))
 664
 665 bfa_boolean_t bfa_phy_busy(struct bfa_ioc_s *ioc);
 666 bfa_status_t bfa_phy_get_attr(struct bfa_phy_s *phy, u8 instance,
 667                         struct bfa_phy_attr_s *attr,
 668                         bfa_cb_phy_t cbfn, void *cbarg);
 669 bfa_status_t bfa_phy_get_stats(struct bfa_phy_s *phy, u8 instance,
 670                         struct bfa_phy_stats_s *stats,
 671                         bfa_cb_phy_t cbfn, void *cbarg);
 672 bfa_status_t bfa_phy_update(struct bfa_phy_s *phy, u8 instance,
 673                         void *buf, u32 len, u32 offset,
 674                         bfa_cb_phy_t cbfn, void *cbarg);
 675 bfa_status_t bfa_phy_read(struct bfa_phy_s *phy, u8 instance,
 676                         void *buf, u32 len, u32 offset,
 677                         bfa_cb_phy_t cbfn, void *cbarg);
 678
 679 u32     bfa_phy_meminfo(bfa_boolean_t mincfg);
 680 void bfa_phy_attach(struct bfa_phy_s *phy, struct bfa_ioc_s *ioc,
 681                 void *dev, struct bfa_trc_mod_s *trcmod, bfa_boolean_t mincfg);
 682 void bfa_phy_memclaim(struct bfa_phy_s *phy,
 683                 u8 *dm_kva, u64 dm_pa, bfa_boolean_t mincfg);
 684 void bfa_phy_intr(void *phyarg, struct bfi_mbmsg_s *msg);
 685
 686 /*
 687  *      IOC specfic macros
 688  */
 689 #define bfa_ioc_pcifn(__ioc)            ((__ioc)->pcidev.pci_func)
 690 #define bfa_ioc_devid(__ioc)            ((__ioc)->pcidev.device_id)
 691 #define bfa_ioc_bar0(__ioc)             ((__ioc)->pcidev.pci_bar_kva)
 692 #define bfa_ioc_portid(__ioc)           ((__ioc)->port_id)
 693 #define bfa_ioc_asic_gen(__ioc)         ((__ioc)->asic_gen)
 694 #define bfa_ioc_is_cna(__ioc)   \
 695         ((bfa_ioc_get_type(__ioc) == BFA_IOC_TYPE_FCoE) ||      \
 696          (bfa_ioc_get_type(__ioc) == BFA_IOC_TYPE_LL))
 697 #define bfa_ioc_fetch_stats(__ioc, __stats) \
 698                 (((__stats)->drv_stats) = (__ioc)->stats)
 699 #define bfa_ioc_clr_stats(__ioc)        \
 700                 memset(&(__ioc)->stats, 0, sizeof((__ioc)->stats))
 701 #define bfa_ioc_maxfrsize(__ioc)        ((__ioc)->attr->maxfrsize)
 702 #define bfa_ioc_rx_bbcredit(__ioc)      ((__ioc)->attr->rx_bbcredit)
 703 #define bfa_ioc_speed_sup(__ioc)        \
 704         BFI_ADAPTER_GETP(SPEED, (__ioc)->attr->adapter_prop)
 705 #define bfa_ioc_get_nports(__ioc)       \
 706         BFI_ADAPTER_GETP(NPORTS, (__ioc)->attr->adapter_prop)
 707
 708 #define bfa_ioc_stats(_ioc, _stats)     ((_ioc)->stats._stats++)
 709 #define BFA_IOC_FWIMG_MINSZ     (16 * 1024)
 710 #define BFA_IOC_FW_SMEM_SIZE(__ioc)                     \
 711         ((bfa_ioc_asic_gen(__ioc) == BFI_ASIC_GEN_CB)   \
 712          ? BFI_SMEM_CB_SIZE : BFI_SMEM_CT_SIZE)
 713 #define BFA_IOC_FLASH_CHUNK_NO(off)             (off / BFI_FLASH_CHUNK_SZ_WORDS)
 714 #define BFA_IOC_FLASH_OFFSET_IN_CHUNK(off)      (off % BFI_FLASH_CHUNK_SZ_WORDS)
 715 #define BFA_IOC_FLASH_CHUNK_ADDR(chunkno)  (chunkno * BFI_FLASH_CHUNK_SZ_WORDS)
 716
 717 /*
 718  * IOC mailbox interface
 719  */
 720 void bfa_ioc_mbox_queue(struct bfa_ioc_s *ioc, struct bfa_mbox_cmd_s *cmd);
 721 void bfa_ioc_mbox_register(struct bfa_ioc_s *ioc,
 722                 bfa_ioc_mbox_mcfunc_t *mcfuncs);
 723 void bfa_ioc_mbox_isr(struct bfa_ioc_s *ioc);
 724 void bfa_ioc_mbox_send(struct bfa_ioc_s *ioc, void *ioc_msg, int len);
 725 bfa_boolean_t bfa_ioc_msgget(struct bfa_ioc_s *ioc, void *mbmsg);
 726 void bfa_ioc_mbox_regisr(struct bfa_ioc_s *ioc, enum bfi_mclass mc,
 727                 bfa_ioc_mbox_mcfunc_t cbfn, void *cbarg);
 728
 729 /*
 730  * IOC interfaces
 731  */
 732
 733 #define bfa_ioc_pll_init_asic(__ioc) \
 734         ((__ioc)->ioc_hwif->ioc_pll_init((__ioc)->pcidev.pci_bar_kva, \
 735                            (__ioc)->asic_mode))
 736
 737 bfa_status_t bfa_ioc_pll_init(struct bfa_ioc_s *ioc);
 738 bfa_status_t bfa_ioc_cb_pll_init(void __iomem *rb, enum bfi_asic_mode mode);
 739 bfa_status_t bfa_ioc_ct_pll_init(void __iomem *rb, enum bfi_asic_mode mode);
 740 bfa_status_t bfa_ioc_ct2_pll_init(void __iomem *rb, enum bfi_asic_mode mode);
 741
 742 #define bfa_ioc_isr_mode_set(__ioc, __msix) do {                        \
 743         if ((__ioc)->ioc_hwif->ioc_isr_mode_set)                        \
 744                 ((__ioc)->ioc_hwif->ioc_isr_mode_set(__ioc, __msix));   \
 745 } while (0)
 746 #define bfa_ioc_ownership_reset(__ioc)                          \
 747                         ((__ioc)->ioc_hwif->ioc_ownership_reset(__ioc))
 748 #define bfa_ioc_get_fcmode(__ioc)       ((__ioc)->fcmode)
 749 #define bfa_ioc_lpu_read_stat(__ioc) do {                       \
 750         if ((__ioc)->ioc_hwif->ioc_lpu_read_stat)               \
 751                 ((__ioc)->ioc_hwif->ioc_lpu_read_stat(__ioc));  \
 752 } while (0)
 753
 754 void bfa_ioc_set_cb_hwif(struct bfa_ioc_s *ioc);
 755 void bfa_ioc_set_ct_hwif(struct bfa_ioc_s *ioc);
 756 void bfa_ioc_set_ct2_hwif(struct bfa_ioc_s *ioc);
 757 void bfa_ioc_ct2_poweron(struct bfa_ioc_s *ioc);
 758
 759 void bfa_ioc_attach(struct bfa_ioc_s *ioc, void *bfa,
 760                 struct bfa_ioc_cbfn_s *cbfn, struct bfa_timer_mod_s *timer_mod);
 761 void bfa_ioc_auto_recover(bfa_boolean_t auto_recover);
 762 void bfa_ioc_detach(struct bfa_ioc_s *ioc);
 763 void bfa_ioc_pci_init(struct bfa_ioc_s *ioc, struct bfa_pcidev_s *pcidev,
 764                 enum bfi_pcifn_class clscode);
 765 void bfa_ioc_mem_claim(struct bfa_ioc_s *ioc,  u8 *dm_kva, u64 dm_pa);
 766 void bfa_ioc_enable(struct bfa_ioc_s *ioc);
 767 void bfa_ioc_disable(struct bfa_ioc_s *ioc);
 768 bfa_boolean_t bfa_ioc_intx_claim(struct bfa_ioc_s *ioc);
 769
 770 void bfa_ioc_boot(struct bfa_ioc_s *ioc, u32 boot_type,
 771                 u32 boot_env);
 772 void bfa_ioc_isr(struct bfa_ioc_s *ioc, struct bfi_mbmsg_s *msg);
 773 void bfa_ioc_error_isr(struct bfa_ioc_s *ioc);
 774 bfa_boolean_t bfa_ioc_is_operational(struct bfa_ioc_s *ioc);
 775 bfa_boolean_t bfa_ioc_is_initialized(struct bfa_ioc_s *ioc);
 776 bfa_boolean_t bfa_ioc_is_disabled(struct bfa_ioc_s *ioc);
 777 bfa_boolean_t bfa_ioc_is_acq_addr(struct bfa_ioc_s *ioc);
 778 bfa_boolean_t bfa_ioc_fw_mismatch(struct bfa_ioc_s *ioc);
 779 bfa_boolean_t bfa_ioc_adapter_is_disabled(struct bfa_ioc_s *ioc);
 780 void bfa_ioc_reset_fwstate(struct bfa_ioc_s *ioc);
 781 enum bfa_ioc_type_e bfa_ioc_get_type(struct bfa_ioc_s *ioc);
 782 void bfa_ioc_get_adapter_serial_num(struct bfa_ioc_s *ioc, char *serial_num);
 783 void bfa_ioc_get_adapter_fw_ver(struct bfa_ioc_s *ioc, char *fw_ver);
 784 void bfa_ioc_get_adapter_optrom_ver(struct bfa_ioc_s *ioc, char *optrom_ver);
 785 void bfa_ioc_get_adapter_model(struct bfa_ioc_s *ioc, char *model);
 786 void bfa_ioc_get_adapter_manufacturer(struct bfa_ioc_s *ioc,
 787                 char *manufacturer);
 788 void bfa_ioc_get_pci_chip_rev(struct bfa_ioc_s *ioc, char *chip_rev);
 789 enum bfa_ioc_state bfa_ioc_get_state(struct bfa_ioc_s *ioc);
 790
 791 void bfa_ioc_get_attr(struct bfa_ioc_s *ioc, struct bfa_ioc_attr_s *ioc_attr);
 792 void bfa_ioc_get_adapter_attr(struct bfa_ioc_s *ioc,
 793                 struct bfa_adapter_attr_s *ad_attr);
 794 void bfa_ioc_debug_memclaim(struct bfa_ioc_s *ioc, void *dbg_fwsave);
 795 bfa_status_t bfa_ioc_debug_fwsave(struct bfa_ioc_s *ioc, void *trcdata,
 796                 int *trclen);
 797 bfa_status_t bfa_ioc_debug_fwtrc(struct bfa_ioc_s *ioc, void *trcdata,
 798                                  int *trclen);
 799 bfa_status_t bfa_ioc_debug_fwcore(struct bfa_ioc_s *ioc, void *buf,
 800         u32 *offset, int *buflen);
 801 bfa_boolean_t bfa_ioc_sem_get(void __iomem *sem_reg);
 802 void bfa_ioc_fwver_get(struct bfa_ioc_s *ioc,
 803                         struct bfi_ioc_image_hdr_s *fwhdr);
 804 bfa_boolean_t bfa_ioc_fwver_cmp(struct bfa_ioc_s *ioc,
 805                         struct bfi_ioc_image_hdr_s *fwhdr);
 806 bfa_status_t bfa_ioc_fw_stats_get(struct bfa_ioc_s *ioc, void *stats);
 807 bfa_status_t bfa_ioc_fw_stats_clear(struct bfa_ioc_s *ioc);
 808
 809 /*
 810  * asic block configuration related APIs
 811  */
 812 u32     bfa_ablk_meminfo(void);
 813 void bfa_ablk_memclaim(struct bfa_ablk_s *ablk, u8 *dma_kva, u64 dma_pa);
 814 void bfa_ablk_attach(struct bfa_ablk_s *ablk, struct bfa_ioc_s *ioc);
 815 bfa_status_t bfa_ablk_query(struct bfa_ablk_s *ablk,
 816                 struct bfa_ablk_cfg_s *ablk_cfg,
 817                 bfa_ablk_cbfn_t cbfn, void *cbarg);
 818 bfa_status_t bfa_ablk_adapter_config(struct bfa_ablk_s *ablk,
 819                 enum bfa_mode_s mode, int max_pf, int max_vf,
 820                 bfa_ablk_cbfn_t cbfn, void *cbarg);
 821 bfa_status_t bfa_ablk_port_config(struct bfa_ablk_s *ablk, int port,
 822                 enum bfa_mode_s mode, int max_pf, int max_vf,
 823                 bfa_ablk_cbfn_t cbfn, void *cbarg);
 824 bfa_status_t bfa_ablk_pf_create(struct bfa_ablk_s *ablk, u16 *pcifn,
 825                 u8 port, enum bfi_pcifn_class personality, int bw,
 826                 bfa_ablk_cbfn_t cbfn, void *cbarg);
 827 bfa_status_t bfa_ablk_pf_delete(struct bfa_ablk_s *ablk, int pcifn,
 828                 bfa_ablk_cbfn_t cbfn, void *cbarg);
 829 bfa_status_t bfa_ablk_pf_update(struct bfa_ablk_s *ablk, int pcifn, int bw,
 830                 bfa_ablk_cbfn_t cbfn, void *cbarg);
 831 bfa_status_t bfa_ablk_optrom_en(struct bfa_ablk_s *ablk,
 832                 bfa_ablk_cbfn_t cbfn, void *cbarg);
 833 bfa_status_t bfa_ablk_optrom_dis(struct bfa_ablk_s *ablk,
 834                 bfa_ablk_cbfn_t cbfn, void *cbarg);
 835
 836 /*
 837  * bfa mfg wwn API functions
 838  */
 839 mac_t bfa_ioc_get_mac(struct bfa_ioc_s *ioc);
 840 mac_t bfa_ioc_get_mfg_mac(struct bfa_ioc_s *ioc);
 841
 842 /*
 843  * F/W Image Size & Chunk
 844  */
 845 extern u32 bfi_image_cb_size;
 846 extern u32 bfi_image_ct_size;
 847 extern u32 bfi_image_ct2_size;
 848 extern u32 *bfi_image_cb;
 849 extern u32 *bfi_image_ct;
 850 extern u32 *bfi_image_ct2;
 851
 852 static inline u32 *
 853 bfi_image_cb_get_chunk(u32 off)
 854 {
 855         return (u32 *)(bfi_image_cb + off);
 856 }
 857
 858 static inline u32 *
 859 bfi_image_ct_get_chunk(u32 off)
 860 {
 861         return (u32 *)(bfi_image_ct + off);
 862 }
 863
 864 static inline u32 *
 865 bfi_image_ct2_get_chunk(u32 off)
 866 {
 867         return (u32 *)(bfi_image_ct2 + off);
 868 }
 869
 870 static inline u32*
 871 bfa_cb_image_get_chunk(enum bfi_asic_gen asic_gen, u32 off)
 872 {
 873         switch (asic_gen) {
 874         case BFI_ASIC_GEN_CB:
 875                 return bfi_image_cb_get_chunk(off);
 876                 break;
 877         case BFI_ASIC_GEN_CT:
 878                 return bfi_image_ct_get_chunk(off);
 879                 break;
 880         case BFI_ASIC_GEN_CT2:
 881                 return bfi_image_ct2_get_chunk(off);
 882                 break;
 883         default:
 884                 return NULL;
 885         }
 886 }
 887
 888 static inline u32
 889 bfa_cb_image_get_size(enum bfi_asic_gen asic_gen)
 890 {
 891         switch (asic_gen) {
 892         case BFI_ASIC_GEN_CB:
 893                 return bfi_image_cb_size;
 894                 break;
 895         case BFI_ASIC_GEN_CT:
 896                 return bfi_image_ct_size;
 897                 break;
 898         case BFI_ASIC_GEN_CT2:
 899                 return bfi_image_ct2_size;
 900                 break;
 901         default:
 902                 return 0;
 903         }
 904 }
 905
 906 /*
 907  * CNA TRCMOD declaration
 908  */
 909 /*
 910  * !!! Only append to the enums defined here to avoid any versioning
 911  * !!! needed between trace utility and driver version
 912  */
 913 enum {
 914         BFA_TRC_CNA_PORT        = 1,
 915         BFA_TRC_CNA_IOC         = 2,
 916         BFA_TRC_CNA_IOC_CB      = 3,
 917         BFA_TRC_CNA_IOC_CT      = 4,
 918 };
 919
 920 #endif /* __BFA_IOC_H__ */