drivers/scsi/csiostor/csio_hw.h

   1 /*
   2  * This file is part of the Chelsio FCoE driver for Linux.
   3  *
   4  * Copyright (c) 2008-2012 Chelsio Communications, Inc. All rights reserved.
   5  *
   6  * This software is available to you under a choice of one of two
   7  * licenses.  You may choose to be licensed under the terms of the GNU
   8  * General Public License (GPL) Version 2, available from the file
   9  * COPYING in the main directory of this source tree, or the
  10  * OpenIB.org BSD license below:
  11  *
  12  *     Redistribution and use in source and binary forms, with or
  13  *     without modification, are permitted provided that the following
  14  *     conditions are met:
  15  *
  16  *      - Redistributions of source code must retain the above
  17  *        copyright notice, this list of conditions and the following
  18  *        disclaimer.
  19  *
  20  *      - Redistributions in binary form must reproduce the above
  21  *        copyright notice, this list of conditions and the following
  22  *        disclaimer in the documentation and/or other materials
  23  *        provided with the distribution.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  32  * SOFTWARE.
  33  */
  34
  35 #ifndef __CSIO_HW_H__
  36 #define __CSIO_HW_H__
  37
  38 #include <linux/kernel.h>
  39 #include <linux/pci.h>
  40 #include <linux/device.h>
  41 #include <linux/workqueue.h>
  42 #include <linux/compiler.h>
  43 #include <linux/cdev.h>
  44 #include <linux/list.h>
  45 #include <linux/mempool.h>
  46 #include <linux/io.h>
  47 #include <linux/spinlock_types.h>
  48 #include <scsi/scsi_device.h>
  49 #include <scsi/scsi_transport_fc.h>
  50
  51 #include "csio_hw_chip.h"
  52 #include "csio_wr.h"
  53 #include "csio_mb.h"
  54 #include "csio_scsi.h"
  55 #include "csio_defs.h"
  56 #include "t4_regs.h"
  57 #include "t4_msg.h"
  58
  59 /*
  60  * An error value used by host. Should not clash with FW defined return values.
  61  */
  62 #define FW_HOSTERROR                    255
  63
  64 #define CSIO_HW_NAME            "Chelsio FCoE Adapter"
  65 #define CSIO_MAX_PFN            8
  66 #define CSIO_MAX_PPORTS         4
  67
  68 #define CSIO_MAX_LUN            0xFFFF
  69 #define CSIO_MAX_QUEUE          2048
  70 #define CSIO_MAX_CMD_PER_LUN    32
  71 #define CSIO_MAX_DDP_BUF_SIZE   (1024 * 1024)
  72 #define CSIO_MAX_SECTOR_SIZE    128
  73
  74 /* Interrupts */
  75 #define CSIO_EXTRA_MSI_IQS      2       /* Extra iqs for INTX/MSI mode
  76                                          * (Forward intr iq + fw iq) */
  77 #define CSIO_EXTRA_VECS         2       /* non-data + FW evt */
  78 #define CSIO_MAX_SCSI_CPU       128
  79 #define CSIO_MAX_SCSI_QSETS     (CSIO_MAX_SCSI_CPU * CSIO_MAX_PPORTS)
  80 #define CSIO_MAX_MSIX_VECS      (CSIO_MAX_SCSI_QSETS + CSIO_EXTRA_VECS)
  81
  82 /* Queues */
  83 enum {
  84         CSIO_INTR_WRSIZE = 128,
  85         CSIO_INTR_IQSIZE = ((CSIO_MAX_MSIX_VECS + 1) * CSIO_INTR_WRSIZE),
  86         CSIO_FWEVT_WRSIZE = 128,
  87         CSIO_FWEVT_IQLEN = 128,
  88         CSIO_FWEVT_FLBUFS = 64,
  89         CSIO_FWEVT_IQSIZE = (CSIO_FWEVT_WRSIZE * CSIO_FWEVT_IQLEN),
  90         CSIO_HW_NIQ = 1,
  91         CSIO_HW_NFLQ = 1,
  92         CSIO_HW_NEQ = 1,
  93         CSIO_HW_NINTXQ = 1,
  94 };
  95
  96 struct csio_msix_entries {
  97         unsigned short  vector;         /* Assigned MSI-X vector */
  98         void            *dev_id;        /* Priv object associated w/ this msix*/
  99         char            desc[24];       /* Description of this vector */
 100 };
 101
 102 struct csio_scsi_qset {
 103         int             iq_idx;         /* Ingress index */
 104         int             eq_idx;         /* Egress index */
 105         uint32_t        intr_idx;       /* MSIX Vector index */
 106 };
 107
 108 struct csio_scsi_cpu_info {
 109         int16_t max_cpus;
 110 };
 111
 112 extern int csio_dbg_level;
 113 extern unsigned int csio_port_mask;
 114 extern int csio_msi;
 115
 116 #define CSIO_VENDOR_ID                          0x1425
 117 #define CSIO_ASIC_DEVID_PROTO_MASK              0xFF00
 118 #define CSIO_ASIC_DEVID_TYPE_MASK               0x00FF
 119
 120 #define CSIO_GLBL_INTR_MASK             (CIM | MPS | PL | PCIE | MC | EDC0 | \
 121                                          EDC1 | LE | TP | MA | PM_TX | PM_RX | \
 122                                          ULP_RX | CPL_SWITCH | SGE | \
 123                                          ULP_TX | SF)
 124
 125 /*
 126  * Hard parameters used to initialize the card in the absence of a
 127  * configuration file.
 128  */
 129 enum {
 130         /* General */
 131         CSIO_SGE_DBFIFO_INT_THRESH      = 10,
 132
 133         CSIO_SGE_RX_DMA_OFFSET          = 2,
 134
 135         CSIO_SGE_FLBUF_SIZE1            = 65536,
 136         CSIO_SGE_FLBUF_SIZE2            = 1536,
 137         CSIO_SGE_FLBUF_SIZE3            = 9024,
 138         CSIO_SGE_FLBUF_SIZE4            = 9216,
 139         CSIO_SGE_FLBUF_SIZE5            = 2048,
 140         CSIO_SGE_FLBUF_SIZE6            = 128,
 141         CSIO_SGE_FLBUF_SIZE7            = 8192,
 142         CSIO_SGE_FLBUF_SIZE8            = 16384,
 143
 144         CSIO_SGE_TIMER_VAL_0            = 5,
 145         CSIO_SGE_TIMER_VAL_1            = 10,
 146         CSIO_SGE_TIMER_VAL_2            = 20,
 147         CSIO_SGE_TIMER_VAL_3            = 50,
 148         CSIO_SGE_TIMER_VAL_4            = 100,
 149         CSIO_SGE_TIMER_VAL_5            = 200,
 150
 151         CSIO_SGE_INT_CNT_VAL_0          = 1,
 152         CSIO_SGE_INT_CNT_VAL_1          = 4,
 153         CSIO_SGE_INT_CNT_VAL_2          = 8,
 154         CSIO_SGE_INT_CNT_VAL_3          = 16,
 155 };
 156
 157 /* Slowpath events */
 158 enum csio_evt {
 159         CSIO_EVT_FW  = 0,       /* FW event */
 160         CSIO_EVT_MBX,           /* MBX event */
 161         CSIO_EVT_SCN,           /* State change notification */
 162         CSIO_EVT_DEV_LOSS,      /* Device loss event */
 163         CSIO_EVT_MAX,           /* Max supported event */
 164 };
 165
 166 #define CSIO_EVT_MSG_SIZE       512
 167 #define CSIO_EVTQ_SIZE          512
 168
 169 /* Event msg  */
 170 struct csio_evt_msg {
 171         struct list_head        list;   /* evt queue*/
 172         enum csio_evt           type;
 173         uint8_t                 data[CSIO_EVT_MSG_SIZE];
 174 };
 175
 176 enum {
 177         EEPROMVSIZE    = 32768, /* Serial EEPROM virtual address space size */
 178         SERNUM_LEN     = 16,    /* Serial # length */
 179         EC_LEN         = 16,    /* E/C length */
 180         ID_LEN         = 16,    /* ID length */
 181         TRACE_LEN      = 112,   /* length of trace data and mask */
 182 };
 183
 184 enum {
 185         SF_PAGE_SIZE = 256,           /* serial flash page size */
 186         SF_SEC_SIZE = 64 * 1024,      /* serial flash sector size */
 187         SF_SIZE = SF_SEC_SIZE * 16,   /* serial flash size */
 188 };
 189
 190 /* serial flash and firmware constants */
 191 enum {
 192         SF_ATTEMPTS = 10,             /* max retries for SF operations */
 193
 194         /* flash command opcodes */
 195         SF_PROG_PAGE    = 2,          /* program page */
 196         SF_WR_DISABLE   = 4,          /* disable writes */
 197         SF_RD_STATUS    = 5,          /* read status register */
 198         SF_WR_ENABLE    = 6,          /* enable writes */
 199         SF_RD_DATA_FAST = 0xb,        /* read flash */
 200         SF_RD_ID        = 0x9f,       /* read ID */
 201         SF_ERASE_SECTOR = 0xd8,       /* erase sector */
 202
 203         FW_START_SEC = 8,             /* first flash sector for FW */
 204         FW_END_SEC = 15,              /* last flash sector for FW */
 205         FW_IMG_START = FW_START_SEC * SF_SEC_SIZE,
 206         FW_MAX_SIZE = (FW_END_SEC - FW_START_SEC + 1) * SF_SEC_SIZE,
 207
 208         FLASH_CFG_MAX_SIZE    = 0x10000 , /* max size of the flash config file*/
 209         FLASH_CFG_OFFSET      = 0x1f0000,
 210         FLASH_CFG_START_SEC   = FLASH_CFG_OFFSET / SF_SEC_SIZE,
 211 };
 212
 213 /*
 214  * Flash layout.
 215  */
 216 #define FLASH_START(start)      ((start) * SF_SEC_SIZE)
 217 #define FLASH_MAX_SIZE(nsecs)   ((nsecs) * SF_SEC_SIZE)
 218
 219 enum {
 220         /*
 221          * Location of firmware image in FLASH.
 222          */
 223         FLASH_FW_START_SEC = 8,
 224         FLASH_FW_NSECS = 8,
 225         FLASH_FW_START = FLASH_START(FLASH_FW_START_SEC),
 226         FLASH_FW_MAX_SIZE = FLASH_MAX_SIZE(FLASH_FW_NSECS),
 227
 228         /* Location of Firmware Configuration File in FLASH. */
 229         FLASH_CFG_START = FLASH_START(FLASH_CFG_START_SEC),
 230 };
 231
 232 #undef FLASH_START
 233 #undef FLASH_MAX_SIZE
 234
 235 /* Management module */
 236 enum {
 237         CSIO_MGMT_EQ_WRSIZE = 512,
 238         CSIO_MGMT_IQ_WRSIZE = 128,
 239         CSIO_MGMT_EQLEN = 64,
 240         CSIO_MGMT_IQLEN = 64,
 241 };
 242
 243 #define CSIO_MGMT_EQSIZE        (CSIO_MGMT_EQLEN * CSIO_MGMT_EQ_WRSIZE)
 244 #define CSIO_MGMT_IQSIZE        (CSIO_MGMT_IQLEN * CSIO_MGMT_IQ_WRSIZE)
 245
 246 /* mgmt module stats */
 247 struct csio_mgmtm_stats {
 248         uint32_t        n_abort_req;            /* Total abort request */
 249         uint32_t        n_abort_rsp;            /* Total abort response */
 250         uint32_t        n_close_req;            /* Total close request */
 251         uint32_t        n_close_rsp;            /* Total close response */
 252         uint32_t        n_err;                  /* Total Errors */
 253         uint32_t        n_drop;                 /* Total request dropped */
 254         uint32_t        n_active;               /* Count of active_q */
 255         uint32_t        n_cbfn;                 /* Count of cbfn_q */
 256 };
 257
 258 /* MGMT module */
 259 struct csio_mgmtm {
 260         struct  csio_hw         *hw;            /* Pointer to HW moduel */
 261         int                     eq_idx;         /* Egress queue index */
 262         int                     iq_idx;         /* Ingress queue index */
 263         int                     msi_vec;        /* MSI vector */
 264         struct list_head        active_q;       /* Outstanding ELS/CT */
 265         struct list_head        abort_q;        /* Outstanding abort req */
 266         struct list_head        cbfn_q;         /* Completion queue */
 267         struct list_head        mgmt_req_freelist; /* Free poll of reqs */
 268                                                 /* ELSCT request freelist*/
 269         struct timer_list       mgmt_timer;     /* MGMT timer */
 270         struct csio_mgmtm_stats stats;          /* ELS/CT stats */
 271 };
 272
 273 struct csio_adap_desc {
 274         char model_no[16];
 275         char description[32];
 276 };
 277
 278 struct pci_params {
 279         uint16_t   vendor_id;
 280         uint16_t   device_id;
 281         int        vpd_cap_addr;
 282         uint16_t   speed;
 283         uint8_t    width;
 284 };
 285
 286 /* User configurable hw parameters */
 287 struct csio_hw_params {
 288         uint32_t                sf_size;                /* serial flash
 289                                                          * size in bytes
 290                                                          */
 291         uint32_t                sf_nsec;                /* # of flash sectors */
 292         struct pci_params       pci;
 293         uint32_t                log_level;              /* Module-level for
 294                                                          * debug log.
 295                                                          */
 296 };
 297
 298 struct csio_vpd {
 299         uint32_t cclk;
 300         uint8_t ec[EC_LEN + 1];
 301         uint8_t sn[SERNUM_LEN + 1];
 302         uint8_t id[ID_LEN + 1];
 303 };
 304
 305 struct csio_pport {
 306         uint16_t        pcap;
 307         uint8_t         portid;
 308         uint8_t         link_status;
 309         uint16_t        link_speed;
 310         uint8_t         mac[6];
 311         uint8_t         mod_type;
 312         uint8_t         rsvd1;
 313         uint8_t         rsvd2;
 314         uint8_t         rsvd3;
 315 };
 316
 317 /* fcoe resource information */
 318 struct csio_fcoe_res_info {
 319         uint16_t        e_d_tov;
 320         uint16_t        r_a_tov_seq;
 321         uint16_t        r_a_tov_els;
 322         uint16_t        r_r_tov;
 323         uint32_t        max_xchgs;
 324         uint32_t        max_ssns;
 325         uint32_t        used_xchgs;
 326         uint32_t        used_ssns;
 327         uint32_t        max_fcfs;
 328         uint32_t        max_vnps;
 329         uint32_t        used_fcfs;
 330         uint32_t        used_vnps;
 331 };
 332
 333 /* HW State machine Events */
 334 enum csio_hw_ev {
 335         CSIO_HWE_CFG = (uint32_t)1, /* Starts off the State machine */
 336         CSIO_HWE_INIT,           /* Config done, start Init      */
 337         CSIO_HWE_INIT_DONE,      /* Init Mailboxes sent, HW ready */
 338         CSIO_HWE_FATAL,          /* Fatal error during initialization */
 339         CSIO_HWE_PCIERR_DETECTED,/* PCI error recovery detetced */
 340         CSIO_HWE_PCIERR_SLOT_RESET, /* Slot reset after PCI recoviery */
 341         CSIO_HWE_PCIERR_RESUME,  /* Resume after PCI error recovery */
 342         CSIO_HWE_QUIESCED,       /* HBA quiesced */
 343         CSIO_HWE_HBA_RESET,      /* HBA reset requested */
 344         CSIO_HWE_HBA_RESET_DONE, /* HBA reset completed */
 345         CSIO_HWE_FW_DLOAD,       /* FW download requested */
 346         CSIO_HWE_PCI_REMOVE,     /* PCI de-instantiation */
 347         CSIO_HWE_SUSPEND,        /* HW suspend for Online(hot) replacement */
 348         CSIO_HWE_RESUME,         /* HW resume for Online(hot) replacement */
 349         CSIO_HWE_MAX,            /* Max HW event */
 350 };
 351
 352 /* hw stats */
 353 struct csio_hw_stats {
 354         uint32_t        n_evt_activeq;  /* Number of event in active Q */
 355         uint32_t        n_evt_freeq;    /* Number of event in free Q */
 356         uint32_t        n_evt_drop;     /* Number of event droped */
 357         uint32_t        n_evt_unexp;    /* Number of unexpected events */
 358         uint32_t        n_pcich_offline;/* Number of pci channel offline */
 359         uint32_t        n_lnlkup_miss;  /* Number of lnode lookup miss */
 360         uint32_t        n_cpl_fw6_msg;  /* Number of cpl fw6 message*/
 361         uint32_t        n_cpl_fw6_pld;  /* Number of cpl fw6 payload*/
 362         uint32_t        n_cpl_unexp;    /* Number of unexpected cpl */
 363         uint32_t        n_mbint_unexp;  /* Number of unexpected mbox */
 364                                         /* interrupt */
 365         uint32_t        n_plint_unexp;  /* Number of unexpected PL */
 366                                         /* interrupt */
 367         uint32_t        n_plint_cnt;    /* Number of PL interrupt */
 368         uint32_t        n_int_stray;    /* Number of stray interrupt */
 369         uint32_t        n_err;          /* Number of hw errors */
 370         uint32_t        n_err_fatal;    /* Number of fatal errors */
 371         uint32_t        n_err_nomem;    /* Number of memory alloc failure */
 372         uint32_t        n_err_io;       /* Number of IO failure */
 373         enum csio_hw_ev n_evt_sm[CSIO_HWE_MAX]; /* Number of sm events */
 374         uint64_t        n_reset_start;  /* Start time after the reset */
 375         uint32_t        rsvd1;
 376 };
 377
 378 /* Defines for hw->flags */
 379 #define CSIO_HWF_MASTER                 0x00000001      /* This is the Master
 380                                                          * function for the
 381                                                          * card.
 382                                                          */
 383 #define CSIO_HWF_HW_INTR_ENABLED        0x00000002      /* Are HW Interrupt
 384                                                          * enable bit set?
 385                                                          */
 386 #define CSIO_HWF_FWEVT_PENDING          0x00000004      /* FW events pending */
 387 #define CSIO_HWF_Q_MEM_ALLOCED          0x00000008      /* Queues have been
 388                                                          * allocated memory.
 389                                                          */
 390 #define CSIO_HWF_Q_FW_ALLOCED           0x00000010      /* Queues have been
 391                                                          * allocated in FW.
 392                                                          */
 393 #define CSIO_HWF_VPD_VALID              0x00000020      /* Valid VPD copied */
 394 #define CSIO_HWF_DEVID_CACHED           0X00000040      /* PCI vendor & device
 395                                                          * id cached */
 396 #define CSIO_HWF_FWEVT_STOP             0x00000080      /* Stop processing
 397                                                          * FW events
 398                                                          */
 399 #define CSIO_HWF_USING_SOFT_PARAMS      0x00000100      /* Using FW config
 400                                                          * params
 401                                                          */
 402 #define CSIO_HWF_HOST_INTR_ENABLED      0x00000200      /* Are host interrupts
 403                                                          * enabled?
 404                                                          */
 405
 406 #define csio_is_hw_intr_enabled(__hw)   \
 407                                 ((__hw)->flags & CSIO_HWF_HW_INTR_ENABLED)
 408 #define csio_is_host_intr_enabled(__hw) \
 409                                 ((__hw)->flags & CSIO_HWF_HOST_INTR_ENABLED)
 410 #define csio_is_hw_master(__hw)         ((__hw)->flags & CSIO_HWF_MASTER)
 411 #define csio_is_valid_vpd(__hw)         ((__hw)->flags & CSIO_HWF_VPD_VALID)
 412 #define csio_is_dev_id_cached(__hw)     ((__hw)->flags & CSIO_HWF_DEVID_CACHED)
 413 #define csio_valid_vpd_copied(__hw)     ((__hw)->flags |= CSIO_HWF_VPD_VALID)
 414 #define csio_dev_id_cached(__hw)        ((__hw)->flags |= CSIO_HWF_DEVID_CACHED)
 415
 416 /* Defines for intr_mode */
 417 enum csio_intr_mode {
 418         CSIO_IM_NONE = 0,
 419         CSIO_IM_INTX = 1,
 420         CSIO_IM_MSI  = 2,
 421         CSIO_IM_MSIX = 3,
 422 };
 423
 424 /* Master HW structure: One per function */
 425 struct csio_hw {
 426         struct csio_sm          sm;                     /* State machine: should
 427                                                          * be the 1st member.
 428                                                          */
 429         spinlock_t              lock;                   /* Lock for hw */
 430
 431         struct csio_scsim       scsim;                  /* SCSI module*/
 432         struct csio_wrm         wrm;                    /* Work request module*/
 433         struct pci_dev          *pdev;                  /* PCI device */
 434
 435         void __iomem            *regstart;              /* Virtual address of
 436                                                          * register map
 437                                                          */
 438         /* SCSI queue sets */
 439         uint32_t                num_sqsets;             /* Number of SCSI
 440                                                          * queue sets */
 441         uint32_t                num_scsi_msix_cpus;     /* Number of CPUs that
 442                                                          * will be used
 443                                                          * for ingress
 444                                                          * processing.
 445                                                          */
 446
 447         struct csio_scsi_qset   sqset[CSIO_MAX_PPORTS][CSIO_MAX_SCSI_CPU];
 448         struct csio_scsi_cpu_info scsi_cpu_info[CSIO_MAX_PPORTS];
 449
 450         uint32_t                evtflag;                /* Event flag  */
 451         uint32_t                flags;                  /* HW flags */
 452
 453         struct csio_mgmtm       mgmtm;                  /* management module */
 454         struct csio_mbm         mbm;                    /* Mailbox module */
 455
 456         /* Lnodes */
 457         uint32_t                num_lns;                /* Number of lnodes */
 458         struct csio_lnode       *rln;                   /* Root lnode */
 459         struct list_head        sln_head;               /* Sibling node list
 460                                                          * list
 461                                                          */
 462         int                     intr_iq_idx;            /* Forward interrupt
 463                                                          * queue.
 464                                                          */
 465         int                     fwevt_iq_idx;           /* FW evt queue */
 466         struct work_struct      evtq_work;              /* Worker thread for
 467                                                          * HW events.
 468                                                          */
 469         struct list_head        evt_free_q;             /* freelist of evt
 470                                                          * elements
 471                                                          */
 472         struct list_head        evt_active_q;           /* active evt queue*/
 473
 474         /* board related info */
 475         char                    name[32];
 476         char                    hw_ver[16];
 477         char                    model_desc[32];
 478         char                    drv_version[32];
 479         char                    fwrev_str[32];
 480         uint32_t                optrom_ver;
 481         uint32_t                fwrev;
 482         uint32_t                tp_vers;
 483         char                    chip_ver;
 484         uint16_t                chip_id;                /* Tells T4/T5 chip */
 485         uint32_t                cfg_finiver;
 486         uint32_t                cfg_finicsum;
 487         uint32_t                cfg_cfcsum;
 488         uint8_t                 cfg_csum_status;
 489         uint8_t                 cfg_store;
 490         enum csio_dev_state     fw_state;
 491         struct csio_vpd         vpd;
 492
 493         uint8_t                 pfn;                    /* Physical Function
 494                                                          * number
 495                                                          */
 496         uint32_t                port_vec;               /* Port vector */
 497         uint8_t                 num_pports;             /* Number of physical
 498                                                          * ports.
 499                                                          */
 500         uint8_t                 rst_retries;            /* Reset retries */
 501         uint8_t                 cur_evt;                /* current s/m evt */
 502         uint8_t                 prev_evt;               /* Previous s/m evt */
 503         uint32_t                dev_num;                /* device number */
 504         struct csio_pport       pport[CSIO_MAX_PPORTS]; /* Ports (XGMACs) */
 505         struct csio_hw_params   params;                 /* Hw parameters */
 506
 507         struct pci_pool         *scsi_pci_pool;         /* PCI pool for SCSI */
 508         mempool_t               *mb_mempool;            /* Mailbox memory pool*/
 509         mempool_t               *rnode_mempool;         /* rnode memory pool */
 510
 511         /* Interrupt */
 512         enum csio_intr_mode     intr_mode;              /* INTx, MSI, MSIX */
 513         uint32_t                fwevt_intr_idx;         /* FW evt MSIX/interrupt
 514                                                          * index
 515                                                          */
 516         uint32_t                nondata_intr_idx;       /* nondata MSIX/intr
 517                                                          * idx
 518                                                          */
 519
 520         uint8_t                 cfg_neq;                /* FW configured no of
 521                                                          * egress queues
 522                                                          */
 523         uint8_t                 cfg_niq;                /* FW configured no of
 524                                                          * iq queues.
 525                                                          */
 526
 527         struct csio_fcoe_res_info  fres_info;           /* Fcoe resource info */
 528         struct csio_hw_chip_ops *chip_ops;              /* T4/T5 Chip specific
 529                                                          * Operations
 530                                                          */
 531
 532         /* MSIX vectors */
 533         struct csio_msix_entries msix_entries[CSIO_MAX_MSIX_VECS];
 534
 535         struct dentry           *debugfs_root;          /* Debug FS */
 536         struct csio_hw_stats    stats;                  /* Hw statistics */
 537 };
 538
 539 /* Register access macros */
 540 #define csio_reg(_b, _r)                ((_b) + (_r))
 541
 542 #define csio_rd_reg8(_h, _r)            readb(csio_reg((_h)->regstart, (_r)))
 543 #define csio_rd_reg16(_h, _r)           readw(csio_reg((_h)->regstart, (_r)))
 544 #define csio_rd_reg32(_h, _r)           readl(csio_reg((_h)->regstart, (_r)))
 545 #define csio_rd_reg64(_h, _r)           readq(csio_reg((_h)->regstart, (_r)))
 546
 547 #define csio_wr_reg8(_h, _v, _r)        writeb((_v), \
 548                                                 csio_reg((_h)->regstart, (_r)))
 549 #define csio_wr_reg16(_h, _v, _r)       writew((_v), \
 550                                                 csio_reg((_h)->regstart, (_r)))
 551 #define csio_wr_reg32(_h, _v, _r)       writel((_v), \
 552                                                 csio_reg((_h)->regstart, (_r)))
 553 #define csio_wr_reg64(_h, _v, _r)       writeq((_v), \
 554                                                 csio_reg((_h)->regstart, (_r)))
 555
 556 void csio_set_reg_field(struct csio_hw *, uint32_t, uint32_t, uint32_t);
 557
 558 /* Core clocks <==> uSecs */
 559 static inline uint32_t
 560 csio_core_ticks_to_us(struct csio_hw *hw, uint32_t ticks)
 561 {
 562         /* add Core Clock / 2 to round ticks to nearest uS */
 563         return (ticks * 1000 + hw->vpd.cclk/2) / hw->vpd.cclk;
 564 }
 565
 566 static inline uint32_t
 567 csio_us_to_core_ticks(struct csio_hw *hw, uint32_t us)
 568 {
 569         return (us * hw->vpd.cclk) / 1000;
 570 }
 571
 572 /* Easy access macros */
 573 #define csio_hw_to_wrm(hw)              ((struct csio_wrm *)(&(hw)->wrm))
 574 #define csio_hw_to_mbm(hw)              ((struct csio_mbm *)(&(hw)->mbm))
 575 #define csio_hw_to_scsim(hw)            ((struct csio_scsim *)(&(hw)->scsim))
 576 #define csio_hw_to_mgmtm(hw)            ((struct csio_mgmtm *)(&(hw)->mgmtm))
 577
 578 #define CSIO_PCI_BUS(hw)                ((hw)->pdev->bus->number)
 579 #define CSIO_PCI_DEV(hw)                (PCI_SLOT((hw)->pdev->devfn))
 580 #define CSIO_PCI_FUNC(hw)               (PCI_FUNC((hw)->pdev->devfn))
 581
 582 #define csio_set_fwevt_intr_idx(_h, _i)         ((_h)->fwevt_intr_idx = (_i))
 583 #define csio_get_fwevt_intr_idx(_h)             ((_h)->fwevt_intr_idx)
 584 #define csio_set_nondata_intr_idx(_h, _i)       ((_h)->nondata_intr_idx = (_i))
 585 #define csio_get_nondata_intr_idx(_h)           ((_h)->nondata_intr_idx)
 586
 587 /* Printing/logging */
 588 #define CSIO_DEVID(__dev)               ((__dev)->dev_num)
 589 #define CSIO_DEVID_LO(__dev)            (CSIO_DEVID((__dev)) & 0xFFFF)
 590 #define CSIO_DEVID_HI(__dev)            ((CSIO_DEVID((__dev)) >> 16) & 0xFFFF)
 591
 592 #define csio_info(__hw, __fmt, ...)                                     \
 593                         dev_info(&(__hw)->pdev->dev, __fmt, ##__VA_ARGS__)
 594
 595 #define csio_fatal(__hw, __fmt, ...)                                    \
 596                         dev_crit(&(__hw)->pdev->dev, __fmt, ##__VA_ARGS__)
 597
 598 #define csio_err(__hw, __fmt, ...)                                      \
 599                         dev_err(&(__hw)->pdev->dev, __fmt, ##__VA_ARGS__)
 600
 601 #define csio_warn(__hw, __fmt, ...)                                     \
 602                         dev_warn(&(__hw)->pdev->dev, __fmt, ##__VA_ARGS__)
 603
 604 #ifdef __CSIO_DEBUG__
 605 #define csio_dbg(__hw, __fmt, ...)                                      \
 606                         csio_info((__hw), __fmt, ##__VA_ARGS__);
 607 #else
 608 #define csio_dbg(__hw, __fmt, ...)
 609 #endif
 610
 611 int csio_hw_wait_op_done_val(struct csio_hw *, int, uint32_t, int,
 612                              int, int, uint32_t *);
 613 void csio_hw_tp_wr_bits_indirect(struct csio_hw *, unsigned int,
 614                                  unsigned int, unsigned int);
 615 int csio_mgmt_req_lookup(struct csio_mgmtm *, struct csio_ioreq *);
 616 void csio_hw_intr_disable(struct csio_hw *);
 617 int csio_hw_slow_intr_handler(struct csio_hw *);
 618 int csio_handle_intr_status(struct csio_hw *, unsigned int,
 619                             const struct intr_info *);
 620
 621 int csio_hw_start(struct csio_hw *);
 622 int csio_hw_stop(struct csio_hw *);
 623 int csio_hw_reset(struct csio_hw *);
 624 int csio_is_hw_ready(struct csio_hw *);
 625 int csio_is_hw_removing(struct csio_hw *);
 626
 627 int csio_fwevtq_handler(struct csio_hw *);
 628 void csio_evtq_worker(struct work_struct *);
 629 int csio_enqueue_evt(struct csio_hw *, enum csio_evt, void *, uint16_t);
 630 void csio_evtq_flush(struct csio_hw *hw);
 631
 632 int csio_request_irqs(struct csio_hw *);
 633 void csio_intr_enable(struct csio_hw *);
 634 void csio_intr_disable(struct csio_hw *, bool);
 635 void csio_hw_fatal_err(struct csio_hw *);
 636
 637 struct csio_lnode *csio_lnode_alloc(struct csio_hw *);
 638 int csio_config_queues(struct csio_hw *);
 639
 640 int csio_hw_init(struct csio_hw *);
 641 void csio_hw_exit(struct csio_hw *);
 642 #endif /* ifndef __CSIO_HW_H__ */