drivers/net/bnxt/hsi_struct_def_dpdk.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) Broadcom Limited.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Broadcom Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _HSI_STRUCT_DEF_EXTERNAL_H_
  35 #define _HSI_STRUCT_DEF_EXTERNAL_H_
  36
  37 /*
  38  * per-context HW statistics -- chip view
  39  */
  40
  41 struct ctx_hw_stats64 {
  42         uint64_t rx_ucast_pkts;
  43         uint64_t rx_mcast_pkts;
  44         uint64_t rx_bcast_pkts;
  45         uint64_t rx_drop_pkts;
  46         uint64_t rx_err_pkts;
  47         uint64_t rx_ucast_bytes;
  48         uint64_t rx_mcast_bytes;
  49         uint64_t rx_bcast_bytes;
  50
  51         uint64_t tx_ucast_pkts;
  52         uint64_t tx_mcast_pkts;
  53         uint64_t tx_bcast_pkts;
  54         uint64_t tx_drop_pkts;
  55         uint64_t tx_err_pkts;
  56         uint64_t tx_ucast_bytes;
  57         uint64_t tx_mcast_bytes;
  58         uint64_t tx_bcast_bytes;
  59
  60         uint64_t tpa_pkts;
  61         uint64_t tpa_bytes;
  62         uint64_t tpa_events;
  63         uint64_t tpa_aborts;
  64 } ctx_hw_stats64_t;
  65
  66 /* HW Resource Manager Specification 1.2.0 */
  67 #define HWRM_VERSION_MAJOR      1
  68 #define HWRM_VERSION_MINOR      2
  69 #define HWRM_VERSION_UPDATE     0
  70
  71 /*
  72  * Following is the signature for HWRM message field that indicates not
  73  * applicable (All F's). Need to cast it the size of the field if needed.
  74  */
  75 #define HWRM_NA_SIGNATURE        ((uint32_t)(-1))
  76 #define HWRM_MAX_REQ_LEN        (128)  /* hwrm_func_buf_rgtr */
  77 #define HWRM_MAX_RESP_LEN       (176)  /* hwrm_func_qstats */
  78 #define HW_HASH_INDEX_SIZE      0x80    /* 7 bit indirection table index. */
  79 #define HW_HASH_KEY_SIZE        40
  80 #define HWRM_RESP_VALID_KEY     1 /* valid key for HWRM response */
  81
  82 /*
  83  * Request types
  84  */
  85 #define HWRM_VER_GET                    (UINT32_C(0x0))
  86 #define HWRM_FUNC_RESET                 (UINT32_C(0x11))
  87 #define HWRM_FUNC_QCAPS                 (UINT32_C(0x15))
  88 #define HWRM_FUNC_DRV_UNRGTR            (UINT32_C(0x1a))
  89 #define HWRM_FUNC_DRV_RGTR              (UINT32_C(0x1d))
  90 #define HWRM_PORT_PHY_CFG               (UINT32_C(0x20))
  91 #define HWRM_QUEUE_QPORTCFG             (UINT32_C(0x30))
  92 #define HWRM_VNIC_ALLOC                 (UINT32_C(0x40))
  93 #define HWRM_VNIC_FREE                  (UINT32_C(0x41))
  94 #define HWRM_VNIC_CFG                   (UINT32_C(0x42))
  95 #define HWRM_VNIC_RSS_CFG               (UINT32_C(0x46))
  96 #define HWRM_VNIC_RSS_COS_LB_CTX_ALLOC  (UINT32_C(0x70))
  97 #define HWRM_VNIC_RSS_COS_LB_CTX_FREE   (UINT32_C(0x71))
  98 #define HWRM_CFA_L2_FILTER_ALLOC        (UINT32_C(0x90))
  99 #define HWRM_CFA_L2_FILTER_FREE         (UINT32_C(0x91))
 100 #define HWRM_CFA_L2_FILTER_CFG          (UINT32_C(0x92))
 101 #define HWRM_CFA_L2_SET_RX_MASK         (UINT32_C(0x93))
 102 #define HWRM_STAT_CTX_CLR_STATS         (UINT32_C(0xb3))
 103 #define HWRM_EXEC_FWD_RESP              (UINT32_C(0xd0))
 104
 105 /* Return Codes */
 106 #define HWRM_ERR_CODE_INVALID_PARAMS                      (UINT32_C(0x2))
 107 #define HWRM_ERR_CODE_RESOURCE_ACCESS_DENIED              (UINT32_C(0x3))
 108
 109 /* Short TX BD (16 bytes) */
 110 struct tx_bd_short {
 111         /*
 112          * All bits in this field must be valid on the first BD of a packet.
 113          * Only the packet_end bit must be valid for the remaining BDs of a
 114          * packet.
 115          */
 116         /* This value identifies the type of buffer descriptor. */
 117         #define TX_BD_SHORT_TYPE_MASK                   UINT32_C(0x3f)
 118         #define TX_BD_SHORT_TYPE_SFT                    0
 119                 /*
 120                  * Indicates that this BD is 16B long and is used for normal L2
 121                  * packet transmission.
 122                  */
 123         #define TX_BD_SHORT_TYPE_TX_BD_SHORT            (UINT32_C(0x0) << 0)
 124         /*
 125          * If set to 1, the packet ends with the data in the buffer pointed to
 126          * by this descriptor. This flag must be valid on every BD.
 127          */
 128         #define TX_BD_SHORT_FLAGS_PACKET_END            UINT32_C(0x40)
 129         /*
 130          * If set to 1, the device will not generate a completion for this
 131          * transmit packet unless there is an error in it's processing. If this
 132          * bit is set to 0, then the packet will be completed normally. This bit
 133          * must be valid only on the first BD of a packet.
 134          */
 135         #define TX_BD_SHORT_FLAGS_NO_CMPL               UINT32_C(0x80)
 136         /*
 137          * This value indicates how many 16B BD locations are consumed in the
 138          * ring by this packet. A value of 1 indicates that this BD is the only
 139          * BD (and that the it is a short BD). A value of 3 indicates either 3
 140          * short BDs or 1 long BD and one short BD in the packet. A value of 0
 141          * indicates that there are 32 BD locations in the packet (the maximum).
 142          * This field is valid only on the first BD of a packet.
 143          */
 144         #define TX_BD_SHORT_FLAGS_BD_CNT_MASK           UINT32_C(0x1f00)
 145         #define TX_BD_SHORT_FLAGS_BD_CNT_SFT            8
 146         /*
 147          * This value is a hint for the length of the entire packet. It is used
 148          * by the chip to optimize internal processing. The packet will be
 149          * dropped if the hint is too short. This field is valid only on the
 150          * first BD of a packet.
 151          */
 152         #define TX_BD_SHORT_FLAGS_LHINT_MASK            UINT32_C(0x6000)
 153         #define TX_BD_SHORT_FLAGS_LHINT_SFT             13
 154                 /* indicates packet length < 512B */
 155         #define TX_BD_SHORT_FLAGS_LHINT_LT512           (UINT32_C(0x0) << 13)
 156                 /* indicates 512 <= packet length < 1KB */
 157         #define TX_BD_SHORT_FLAGS_LHINT_LT1K            (UINT32_C(0x1) << 13)
 158                 /* indicates 1KB <= packet length < 2KB */
 159         #define TX_BD_SHORT_FLAGS_LHINT_LT2K            (UINT32_C(0x2) << 13)
 160                 /* indicates packet length >= 2KB */
 161         #define TX_BD_SHORT_FLAGS_LHINT_GTE2K           (UINT32_C(0x3) << 13)
 162         #define TX_BD_SHORT_FLAGS_LHINT_LAST    TX_BD_SHORT_FLAGS_LHINT_GTE2K
 163         /*
 164          * If set to 1, the device immediately updates the Send Consumer Index
 165          * after the buffer associated with this descriptor has been transferred
 166          * via DMA to NIC memory from host memory. An interrupt may or may not
 167          * be generated according to the state of the interrupt avoidance
 168          * mechanisms. If this bit is set to 0, then the Consumer Index is only
 169          * updated as soon as one of the host interrupt coalescing conditions
 170          * has been met. This bit must be valid on the first BD of a packet.
 171          */
 172         #define TX_BD_SHORT_FLAGS_COAL_NOW              UINT32_C(0x8000)
 173         /*
 174          * All bits in this field must be valid on the first BD of a packet.
 175          * Only the packet_end bit must be valid for the remaining BDs of a
 176          * packet.
 177          */
 178         #define TX_BD_SHORT_FLAGS_MASK                  UINT32_C(0xffc0)
 179         #define TX_BD_SHORT_FLAGS_SFT                   6
 180         uint16_t flags_type;
 181
 182         /*
 183          * This is the length of the host physical buffer this BD describes in
 184          * bytes. This field must be valid on all BDs of a packet.
 185          */
 186         uint16_t len;
 187         /*
 188          * The opaque data field is pass through to the completion and can be
 189          * used for any data that the driver wants to associate with the
 190          * transmit BD. This field must be valid on the first BD of a packet.
 191          */
 192         uint32_t opaque;
 193
 194         /*
 195          * This is the host physical address for the portion of the packet
 196          * described by this TX BD. This value must be valid on all BDs of a
 197          * packet.
 198          */
 199         uint64_t addr;
 200 } __attribute__((packed));
 201
 202 /* Long TX BD (32 bytes split to 2 16-byte struct) */
 203 struct tx_bd_long {
 204         /*
 205          * All bits in this field must be valid on the first BD of a packet.
 206          * Only the packet_end bit must be valid for the remaining BDs of a
 207          * packet.
 208          */
 209         /* This value identifies the type of buffer descriptor. */
 210         #define TX_BD_LONG_TYPE_MASK                    UINT32_C(0x3f)
 211         #define TX_BD_LONG_TYPE_SFT                     0
 212                 /*
 213                  * Indicates that this BD is 32B long and is used for normal L2
 214                  * packet transmission.
 215                  */
 216         #define TX_BD_LONG_TYPE_TX_BD_LONG              (UINT32_C(0x10) << 0)
 217         /*
 218          * If set to 1, the packet ends with the data in the buffer pointed to
 219          * by this descriptor. This flag must be valid on every BD.
 220          */
 221         #define TX_BD_LONG_FLAGS_PACKET_END             UINT32_C(0x40)
 222         /*
 223          * If set to 1, the device will not generate a completion for this
 224          * transmit packet unless there is an error in it's processing. If this
 225          * bit is set to 0, then the packet will be completed normally. This bit
 226          * must be valid only on the first BD of a packet.
 227          */
 228         #define TX_BD_LONG_FLAGS_NO_CMPL                UINT32_C(0x80)
 229         /*
 230          * This value indicates how many 16B BD locations are consumed in the
 231          * ring by this packet. A value of 1 indicates that this BD is the only
 232          * BD (and that the it is a short BD). A value of 3 indicates either 3
 233          * short BDs or 1 long BD and one short BD in the packet. A value of 0
 234          * indicates that there are 32 BD locations in the packet (the maximum).
 235          * This field is valid only on the first BD of a packet.
 236          */
 237         #define TX_BD_LONG_FLAGS_BD_CNT_MASK            UINT32_C(0x1f00)
 238         #define TX_BD_LONG_FLAGS_BD_CNT_SFT             8
 239         /*
 240          * This value is a hint for the length of the entire packet. It is used
 241          * by the chip to optimize internal processing. The packet will be
 242          * dropped if the hint is too short. This field is valid only on the
 243          * first BD of a packet.
 244          */
 245         #define TX_BD_LONG_FLAGS_LHINT_MASK             UINT32_C(0x6000)
 246         #define TX_BD_LONG_FLAGS_LHINT_SFT              13
 247                 /* indicates packet length < 512B */
 248         #define TX_BD_LONG_FLAGS_LHINT_LT512            (UINT32_C(0x0) << 13)
 249                 /* indicates 512 <= packet length < 1KB */
 250         #define TX_BD_LONG_FLAGS_LHINT_LT1K             (UINT32_C(0x1) << 13)
 251                 /* indicates 1KB <= packet length < 2KB */
 252         #define TX_BD_LONG_FLAGS_LHINT_LT2K             (UINT32_C(0x2) << 13)
 253                 /* indicates packet length >= 2KB */
 254         #define TX_BD_LONG_FLAGS_LHINT_GTE2K            (UINT32_C(0x3) << 13)
 255         #define TX_BD_LONG_FLAGS_LHINT_LAST     TX_BD_LONG_FLAGS_LHINT_GTE2K
 256         /*
 257          * If set to 1, the device immediately updates the Send Consumer Index
 258          * after the buffer associated with this descriptor has been transferred
 259          * via DMA to NIC memory from host memory. An interrupt may or may not
 260          * be generated according to the state of the interrupt avoidance
 261          * mechanisms. If this bit is set to 0, then the Consumer Index is only
 262          * updated as soon as one of the host interrupt coalescing conditions
 263          * has been met. This bit must be valid on the first BD of a packet.
 264          */
 265         #define TX_BD_LONG_FLAGS_COAL_NOW               UINT32_C(0x8000)
 266         /*
 267          * All bits in this field must be valid on the first BD of a packet.
 268          * Only the packet_end bit must be valid for the remaining BDs of a
 269          * packet.
 270          */
 271         #define TX_BD_LONG_FLAGS_MASK                   UINT32_C(0xffc0)
 272         #define TX_BD_LONG_FLAGS_SFT                    6
 273         uint16_t flags_type;
 274
 275         /*
 276          * This is the length of the host physical buffer this BD describes in
 277          * bytes. This field must be valid on all BDs of a packet.
 278          */
 279         uint16_t len;
 280
 281         /*
 282          * The opaque data field is pass through to the completion and can be
 283          * used for any data that the driver wants to associate with the
 284          * transmit BD. This field must be valid on the first BD of a packet.
 285          */
 286         uint32_t opaque;
 287
 288         /*
 289          * This is the host physical address for the portion of the packet
 290          * described by this TX BD. This value must be valid on all BDs of a
 291          * packet.
 292          */
 293         uint64_t addr;
 294 } __attribute__((packed));
 295
 296 /* last 16 bytes of Long TX BD */
 297
 298 struct tx_bd_long_hi {
 299         /*
 300          * All bits in this field must be valid on the first BD of a packet.
 301          * Their value on other BDs of the packet will be ignored.
 302          */
 303         /*
 304          * If set to 1, the controller replaces the TCP/UPD checksum fields of
 305          * normal TCP/UPD checksum, or the inner TCP/UDP checksum field of the
 306          * encapsulated TCP/UDP packets with the hardware calculated TCP/UDP
 307          * checksum for the packet associated with this descriptor. This bit
 308          * must be valid on the first BD of a packet.
 309          */
 310         #define TX_BD_LONG_LFLAGS_TCP_UDP_CHKSUM        UINT32_C(0x1)
 311         /*
 312          * If set to 1, the controller replaces the IP checksum of the normal
 313          * packets, or the inner IP checksum of the encapsulated packets with
 314          * the hardware calculated IP checksum for the packet associated with
 315          * this descriptor. This bit must be valid on the first BD of a packet.
 316          */
 317         #define TX_BD_LONG_LFLAGS_IP_CHKSUM             UINT32_C(0x2)
 318         /*
 319          * If set to 1, the controller will not append an Ethernet CRC to the
 320          * end of the frame. This bit must be valid on the first BD of a packet.
 321          * Packet must be 64B or longer when this flag is set. It is not useful
 322          * to use this bit with any form of TX offload such as CSO or LSO. The
 323          * intent is that the packet from the host already has a valid Ethernet
 324          * CRC on the packet.
 325          */
 326         #define TX_BD_LONG_LFLAGS_NOCRC                 UINT32_C(0x4)
 327         /*
 328          * If set to 1, the device will record the time at which the packet was
 329          * actually transmitted at the TX MAC. This bit must be valid on the
 330          * first BD of a packet.
 331          */
 332         #define TX_BD_LONG_LFLAGS_STAMP                 UINT32_C(0x8)
 333         /*
 334          * If set to 1, The controller replaces the tunnel IP checksum field
 335          * with hardware calculated IP checksum for the IP header of the packet
 336          * associated with this descriptor. In case of VXLAN, the controller
 337          * also replaces the outer header UDP checksum with hardware calculated
 338          * UDP checksum for the packet associated with this descriptor.
 339          */
 340         #define TX_BD_LONG_LFLAGS_T_IP_CHKSUM           UINT32_C(0x10)
 341         /*
 342          * If set to 1, the device will treat this packet with LSO(Large Send
 343          * Offload) processing for both normal or encapsulated packets, which is
 344          * a form of TCP segmentation. When this bit is 1, the hdr_size and mss
 345          * fields must be valid. The driver doesn't need to set t_ip_chksum,
 346          * ip_chksum, and tcp_udp_chksum flags since the controller will replace
 347          * the appropriate checksum fields for segmented packets. When this bit
 348          * is 1, the hdr_size and mss fields must be valid.
 349          */
 350         #define TX_BD_LONG_LFLAGS_LSO                   UINT32_C(0x20)
 351         /*
 352          * If set to zero when LSO is '1', then the IPID will be treated as a
 353          * 16b number and will be wrapped if it exceeds a value of 0xffff. If
 354          * set to one when LSO is '1', then the IPID will be treated as a 15b
 355          * number and will be wrapped if it exceeds a value 0f 0x7fff.
 356          */
 357         #define TX_BD_LONG_LFLAGS_IPID_FMT              UINT32_C(0x40)
 358         /*
 359          * If set to zero when LSO is '1', then the IPID of the tunnel IP header
 360          * will not be modified during LSO operations. If set to one when LSO is
 361          * '1', then the IPID of the tunnel IP header will be incremented for
 362          * each subsequent segment of an LSO operation.
 363          */
 364         #define TX_BD_LONG_LFLAGS_T_IPID                UINT32_C(0x80)
 365         /*
 366          * If set to '1', then the RoCE ICRC will be appended to the packet.
 367          * Packet must be a valid RoCE format packet.
 368          */
 369         #define TX_BD_LONG_LFLAGS_ROCE_CRC              UINT32_C(0x100)
 370         /*
 371          * If set to '1', then the FCoE CRC will be appended to the packet.
 372          * Packet must be a valid FCoE format packet.
 373          */
 374         #define TX_BD_LONG_LFLAGS_FCOE_CRC              UINT32_C(0x200)
 375         uint16_t lflags;
 376
 377         /*
 378          * When LSO is '1', this field must contain the offset of the TCP
 379          * payload from the beginning of the packet in as 16b words. In case of
 380          * encapsulated/tunneling packet, this field contains the offset of the
 381          * inner TCP payload from beginning of the packet as 16-bit words. This
 382          * value must be valid on the first BD of a packet.
 383          */
 384         #define TX_BD_LONG_HDR_SIZE_MASK                UINT32_C(0x1ff)
 385         #define TX_BD_LONG_HDR_SIZE_SFT                 0
 386         uint16_t hdr_size;
 387
 388         /*
 389          * This is the MSS value that will be used to do the LSO processing. The
 390          * value is the length in bytes of the TCP payload for each segment
 391          * generated by the LSO operation. This value must be valid on the first
 392          * BD of a packet.
 393          */
 394         #define TX_BD_LONG_MSS_MASK                     UINT32_C(0x7fff)
 395         #define TX_BD_LONG_MSS_SFT                      0
 396         uint32_t mss;
 397
 398         uint16_t unused_2;
 399
 400         /*
 401          * This value selects a CFA action to perform on the packet. Set this
 402          * value to zero if no CFA action is desired. This value must be valid
 403          * on the first BD of a packet.
 404          */
 405         uint16_t cfa_action;
 406
 407         /*
 408          * This value is action meta-data that defines CFA edit operations that
 409          * are done in addition to any action editing.
 410          */
 411         /* When key=1, This is the VLAN tag VID value. */
 412         #define TX_BD_LONG_CFA_META_VLAN_VID_MASK       UINT32_C(0xfff)
 413         #define TX_BD_LONG_CFA_META_VLAN_VID_SFT        0
 414         /* When key=1, This is the VLAN tag DE value. */
 415         #define TX_BD_LONG_CFA_META_VLAN_DE             UINT32_C(0x1000)
 416         /* When key=1, This is the VLAN tag PRI value. */
 417         #define TX_BD_LONG_CFA_META_VLAN_PRI_MASK       UINT32_C(0xe000)
 418         #define TX_BD_LONG_CFA_META_VLAN_PRI_SFT        13
 419         /* When key=1, This is the VLAN tag TPID select value. */
 420         #define TX_BD_LONG_CFA_META_VLAN_TPID_MASK      UINT32_C(0x70000)
 421         #define TX_BD_LONG_CFA_META_VLAN_TPID_SFT       16
 422                 /* 0x88a8 */
 423         #define TX_BD_LONG_CFA_META_VLAN_TPID_TPID88A8  (UINT32_C(0x0) << 16)
 424                 /* 0x8100 */
 425         #define TX_BD_LONG_CFA_META_VLAN_TPID_TPID8100  (UINT32_C(0x1) << 16)
 426                 /* 0x9100 */
 427         #define TX_BD_LONG_CFA_META_VLAN_TPID_TPID9100  (UINT32_C(0x2) << 16)
 428                 /* 0x9200 */
 429         #define TX_BD_LONG_CFA_META_VLAN_TPID_TPID9200  (UINT32_C(0x3) << 16)
 430                 /* 0x9300 */
 431         #define TX_BD_LONG_CFA_META_VLAN_TPID_TPID9300  (UINT32_C(0x4) << 16)
 432                 /* Value programmed in CFA VLANTPID register. */
 433         #define TX_BD_LONG_CFA_META_VLAN_TPID_TPIDCFG   (UINT32_C(0x5) << 16)
 434         #define TX_BD_LONG_CFA_META_VLAN_TPID_LAST \
 435                                         TX_BD_LONG_CFA_META_VLAN_TPID_TPIDCFG
 436         /* When key=1, This is the VLAN tag TPID select value. */
 437         #define TX_BD_LONG_CFA_META_VLAN_RESERVED_MASK  UINT32_C(0xff80000)
 438         #define TX_BD_LONG_CFA_META_VLAN_RESERVED_SFT   19
 439         /*
 440          * This field identifies the type of edit to be performed on the packet.
 441          * This value must be valid on the first BD of a packet.
 442          */
 443         #define TX_BD_LONG_CFA_META_KEY_MASK            UINT32_C(0xf0000000)
 444         #define TX_BD_LONG_CFA_META_KEY_SFT             28
 445                 /* No editing */
 446         #define TX_BD_LONG_CFA_META_KEY_NONE            (UINT32_C(0x0) << 28)
 447                 /*
 448                  * - meta[17:16] - TPID select value (0 = 0x8100). - meta[15:12]
 449                  * - PRI/DE value. - meta[11:0] - VID value.
 450                  */
 451         #define TX_BD_LONG_CFA_META_KEY_VLAN_TAG        (UINT32_C(0x1) << 28)
 452         #define TX_BD_LONG_CFA_META_KEY_LAST    TX_BD_LONG_CFA_META_KEY_VLAN_TAG
 453         uint32_t cfa_meta;
 454 } __attribute__((packed));
 455
 456 /* RX Producer Packet BD (16 bytes) */
 457 struct rx_prod_pkt_bd {
 458         /* This value identifies the type of buffer descriptor. */
 459         #define RX_PROD_PKT_BD_TYPE_MASK                UINT32_C(0x3f)
 460         #define RX_PROD_PKT_BD_TYPE_SFT                 0
 461                 /*
 462                  * Indicates that this BD is 16B long and is an RX Producer (ie.
 463                  * empty) buffer descriptor.
 464                  */
 465         #define RX_PROD_PKT_BD_TYPE_RX_PROD_PKT         (UINT32_C(0x4) << 0)
 466         /*
 467          * If set to 1, the packet will be placed at the address plus 2B. The 2
 468          * Bytes of padding will be written as zero.
 469          */
 470         /*
 471          * This is intended to be used when the host buffer is cache-line
 472          * aligned to produce packets that are easy to parse in host memory
 473          * while still allowing writes to be cache line aligned.
 474          */
 475         #define RX_PROD_PKT_BD_FLAGS_SOP_PAD            UINT32_C(0x40)
 476         /*
 477          * If set to 1, the packet write will be padded out to the nearest
 478          * cache-line with zero value padding.
 479          */
 480         /*
 481          * If receive buffers start/end on cache-line boundaries, this feature
 482          * will ensure that all data writes on the PCI bus start/end on cache
 483          * line boundaries.
 484          */
 485         #define RX_PROD_PKT_BD_FLAGS_EOP_PAD            UINT32_C(0x80)
 486         /*
 487          * This value is the number of additional buffers in the ring that
 488          * describe the buffer space to be consumed for the this packet. If the
 489          * value is zero, then the packet must fit within the space described by
 490          * this BD. If this value is 1 or more, it indicates how many additional
 491          * "buffer" BDs are in the ring immediately following this BD to be used
 492          * for the same network packet. Even if the packet to be placed does not
 493          * need all the additional buffers, they will be consumed anyway.
 494          */
 495         #define RX_PROD_PKT_BD_FLAGS_BUFFERS_MASK       UINT32_C(0x300)
 496         #define RX_PROD_PKT_BD_FLAGS_BUFFERS_SFT        8
 497         #define RX_PROD_PKT_BD_FLAGS_MASK               UINT32_C(0xffc0)
 498         #define RX_PROD_PKT_BD_FLAGS_SFT                6
 499         uint16_t flags_type;
 500
 501         /*
 502          * This is the length in Bytes of the host physical buffer where data
 503          * for the packet may be placed in host memory.
 504          */
 505         /*
 506          * While this is a Byte resolution value, it is often advantageous to
 507          * ensure that the buffers provided end on a host cache line.
 508          */
 509         uint16_t len;
 510
 511         /*
 512          * The opaque data field is pass through to the completion and can be
 513          * used for any data that the driver wants to associate with this
 514          * receive buffer set.
 515          */
 516         uint32_t opaque;
 517
 518         /*
 519          * This is the host physical address where data for the packet may by
 520          * placed in host memory.
 521          */
 522         /*
 523          * While this is a Byte resolution value, it is often advantageous to
 524          * ensure that the buffers provide start on a host cache line.
 525          */
 526         uint64_t addr;
 527 } __attribute__((packed));
 528
 529 /* Completion Ring Structures */
 530 /* Note: This structure is used by the HWRM to communicate HWRM Error. */
 531 /* Base Completion Record (16 bytes) */
 532 struct cmpl_base {
 533         /* unused is 10 b */
 534         /*
 535          * This field indicates the exact type of the completion. By convention,
 536          * the LSB identifies the length of the record in 16B units. Even values
 537          * indicate 16B records. Odd values indicate 32B records.
 538          */
 539         #define CMPL_BASE_TYPE_MASK                     UINT32_C(0x3f)
 540         #define CMPL_BASE_TYPE_SFT                      0
 541                 /* TX L2 completion: Completion of TX packet. Length = 16B */
 542         #define CMPL_BASE_TYPE_TX_L2                    (UINT32_C(0x0) << 0)
 543                 /*
 544                  * RX L2 completion: Completion of and L2 RX packet.
 545                  * Length = 32B
 546                 */
 547         #define CMPL_BASE_TYPE_RX_L2                    (UINT32_C(0x11) << 0)
 548                 /*
 549                  * RX Aggregation Buffer completion : Completion of an L2
 550                  * aggregation buffer in support of TPA, HDS, or Jumbo packet
 551                  * completion. Length = 16B
 552                  */
 553         #define CMPL_BASE_TYPE_RX_AGG                   (UINT32_C(0x12) << 0)
 554                 /*
 555                  * RX L2 TPA Start Completion: Completion at the beginning of a
 556                  * TPA operation. Length = 32B
 557                  */
 558         #define CMPL_BASE_TYPE_RX_TPA_START             (UINT32_C(0x13) << 0)
 559                 /*
 560                  * RX L2 TPA End Completion: Completion at the end of a TPA
 561                  * operation. Length = 32B
 562                  */
 563         #define CMPL_BASE_TYPE_RX_TPA_END               (UINT32_C(0x15) << 0)
 564                 /*
 565                  * Statistics Ejection Completion: Completion of statistics data
 566                  * ejection buffer. Length = 16B
 567                  */
 568         #define CMPL_BASE_TYPE_STAT_EJECT               (UINT32_C(0x1a) << 0)
 569                 /* HWRM Command Completion: Completion of an HWRM command. */
 570         #define CMPL_BASE_TYPE_HWRM_DONE                (UINT32_C(0x20) << 0)
 571                 /* Forwarded HWRM Request */
 572         #define CMPL_BASE_TYPE_HWRM_FWD_REQ             (UINT32_C(0x22) << 0)
 573                 /* Forwarded HWRM Response */
 574         #define CMPL_BASE_TYPE_HWRM_FWD_RESP            (UINT32_C(0x24) << 0)
 575                 /* HWRM Asynchronous Event Information */
 576         #define CMPL_BASE_TYPE_HWRM_ASYNC_EVENT         (UINT32_C(0x2e) << 0)
 577                 /* CQ Notification */
 578         #define CMPL_BASE_TYPE_CQ_NOTIFICATION          (UINT32_C(0x30) << 0)
 579                 /* SRQ Threshold Event */
 580         #define CMPL_BASE_TYPE_SRQ_EVENT                (UINT32_C(0x32) << 0)
 581                 /* DBQ Threshold Event */
 582         #define CMPL_BASE_TYPE_DBQ_EVENT                (UINT32_C(0x34) << 0)
 583                 /* QP Async Notification */
 584         #define CMPL_BASE_TYPE_QP_EVENT                 (UINT32_C(0x38) << 0)
 585                 /* Function Async Notification */
 586         #define CMPL_BASE_TYPE_FUNC_EVENT               (UINT32_C(0x3a) << 0)
 587         uint16_t type;
 588
 589         uint16_t info1;
 590         uint32_t info2;
 591
 592         /*
 593          * This value is written by the NIC such that it will be different for
 594          * each pass through the completion queue. The even passes will write 1.
 595          * The odd passes will write 0.
 596          */
 597         #define CMPL_BASE_V                             UINT32_C(0x1)
 598         /* info3 is 31 b */
 599         #define CMPL_BASE_INFO3_MASK                    UINT32_C(0xfffffffe)
 600         #define CMPL_BASE_INFO3_SFT                     1
 601         uint32_t info3_v;
 602
 603         uint32_t info4;
 604 } __attribute__((packed));
 605
 606 /* TX Completion Record (16 bytes) */
 607 struct tx_cmpl {
 608         /*
 609          * This field indicates the exact type of the completion. By convention,
 610          * the LSB identifies the length of the record in 16B units. Even values
 611          * indicate 16B records. Odd values indicate 32B records.
 612          */
 613         #define TX_CMPL_TYPE_MASK                       UINT32_C(0x3f)
 614         #define TX_CMPL_TYPE_SFT                        0
 615                 /* TX L2 completion: Completion of TX packet. Length = 16B */
 616         #define TX_CMPL_TYPE_TX_L2                      (UINT32_C(0x0) << 0)
 617         /*
 618          * When this bit is '1', it indicates a packet that has an error of some
 619          * type. Type of error is indicated in error_flags.
 620          */
 621         #define TX_CMPL_FLAGS_ERROR                     UINT32_C(0x40)
 622         /*
 623          * When this bit is '1', it indicates that the packet completed was
 624          * transmitted using the push acceleration data provided by the driver.
 625          * When this bit is '0', it indicates that the packet had not push
 626          * acceleration data written or was executed as a normal packet even
 627          * though push data was provided.
 628          */
 629         #define TX_CMPL_FLAGS_PUSH                      UINT32_C(0x80)
 630         #define TX_CMPL_FLAGS_MASK                      UINT32_C(0xffc0)
 631         #define TX_CMPL_FLAGS_SFT                       6
 632         uint16_t flags_type;
 633
 634         uint16_t unused_0;
 635
 636         /*
 637          * This is a copy of the opaque field from the first TX BD of this
 638          * transmitted packet.
 639          */
 640         uint32_t opaque;
 641
 642         /*
 643          * This value is written by the NIC such that it will be different for
 644          * each pass through the completion queue. The even passes will write 1.
 645          * The odd passes will write 0.
 646          */
 647         #define TX_CMPL_V                               UINT32_C(0x1)
 648         /*
 649          * This error indicates that there was some sort of problem with the BDs
 650          * for the packet.
 651          */
 652         #define TX_CMPL_ERRORS_BUFFER_ERROR_MASK        UINT32_C(0xe)
 653         #define TX_CMPL_ERRORS_BUFFER_ERROR_SFT         1
 654                 /* No error */
 655         #define TX_CMPL_ERRORS_BUFFER_ERROR_NO_ERROR    (UINT32_C(0x0) << 1)
 656                 /* Bad Format: BDs were not formatted correctly. */
 657         #define TX_CMPL_ERRORS_BUFFER_ERROR_BAD_FMT     (UINT32_C(0x2) << 1)
 658         #define TX_CMPL_ERRORS_BUFFER_ERROR_LAST \
 659                                         TX_CMPL_ERRORS_BUFFER_ERROR_BAD_FMT
 660         /*
 661          * When this bit is '1', it indicates that the length of the packet was
 662          * zero. No packet was transmitted.
 663          */
 664         #define TX_CMPL_ERRORS_ZERO_LENGTH_PKT          UINT32_C(0x10)
 665         /*
 666          * When this bit is '1', it indicates that the packet was longer than
 667          * the programmed limit in TDI. No packet was transmitted.
 668          */
 669         #define TX_CMPL_ERRORS_EXCESSIVE_BD_LENGTH      UINT32_C(0x20)
 670         /*
 671          * When this bit is '1', it indicates that one or more of the BDs
 672          * associated with this packet generated a PCI error. This probably
 673          * means the address was not valid.
 674          */
 675         #define TX_CMPL_ERRORS_DMA_ERROR                UINT32_C(0x40)
 676         /*
 677          * When this bit is '1', it indicates that the packet was longer than
 678          * indicated by the hint. No packet was transmitted.
 679          */
 680         #define TX_CMPL_ERRORS_HINT_TOO_SHORT           UINT32_C(0x80)
 681         /*
 682          * When this bit is '1', it indicates that the packet was dropped due to
 683          * Poison TLP error on one or more of the TLPs in the PXP completion.
 684          */
 685         #define TX_CMPL_ERRORS_POISON_TLP_ERROR         UINT32_C(0x100)
 686         #define TX_CMPL_ERRORS_MASK                     UINT32_C(0xfffe)
 687         #define TX_CMPL_ERRORS_SFT                      1
 688         uint16_t errors_v;
 689
 690         uint16_t unused_1;
 691         uint32_t unused_2;
 692 } __attribute__((packed)) tx_cmpl_t, *ptx_cmpl_t;
 693
 694 /* RX Packet Completion Record (32 bytes split to 2 16-byte struct) */
 695 struct rx_pkt_cmpl {
 696         /*
 697          * This field indicates the exact type of the completion. By convention,
 698          * the LSB identifies the length of the record in 16B units. Even values
 699          * indicate 16B records. Odd values indicate 32B records.
 700          */
 701         #define RX_PKT_CMPL_TYPE_MASK                   UINT32_C(0x3f)
 702         #define RX_PKT_CMPL_TYPE_SFT                    0
 703                 /*
 704                  * RX L2 completion: Completion of and L2 RX packet.
 705                  * Length = 32B
 706                  */
 707         #define RX_PKT_CMPL_TYPE_RX_L2                  (UINT32_C(0x11) << 0)
 708         /*
 709          * When this bit is '1', it indicates a packet that has an error of some
 710          * type. Type of error is indicated in error_flags.
 711          */
 712         #define RX_PKT_CMPL_FLAGS_ERROR                 UINT32_C(0x40)
 713         /* This field indicates how the packet was placed in the buffer. */
 714         #define RX_PKT_CMPL_FLAGS_PLACEMENT_MASK        UINT32_C(0x380)
 715         #define RX_PKT_CMPL_FLAGS_PLACEMENT_SFT         7
 716                 /* Normal: Packet was placed using normal algorithm. */
 717         #define RX_PKT_CMPL_FLAGS_PLACEMENT_NORMAL      (UINT32_C(0x0) << 7)
 718                 /* Jumbo: Packet was placed using jumbo algorithm. */
 719         #define RX_PKT_CMPL_FLAGS_PLACEMENT_JUMBO       (UINT32_C(0x1) << 7)
 720                 /*
 721                  * Header/Data Separation: Packet was placed using Header/Data
 722                  * separation algorithm. The separation location is indicated by
 723                  * the itype field.
 724                  */
 725         #define RX_PKT_CMPL_FLAGS_PLACEMENT_HDS         (UINT32_C(0x2) << 7)
 726         #define RX_PKT_CMPL_FLAGS_PLACEMENT_LAST \
 727                                                 RX_PKT_CMPL_FLAGS_PLACEMENT_HDS
 728         /* This bit is '1' if the RSS field in this completion is valid. */
 729         #define RX_PKT_CMPL_FLAGS_RSS_VALID             UINT32_C(0x400)
 730         /*
 731          * This value indicates what the inner packet determined for the packet
 732          * was.
 733          */
 734         #define RX_PKT_CMPL_FLAGS_ITYPE_MASK            UINT32_C(0xf000)
 735         #define RX_PKT_CMPL_FLAGS_ITYPE_SFT             12
 736                 /* Not Known: Indicates that the packet type was not known. */
 737         #define RX_PKT_CMPL_FLAGS_ITYPE_NOT_KNOWN       (UINT32_C(0x0) << 12)
 738                 /*
 739                  * IP Packet: Indicates that the packet was an IP packet, but
 740                  * further classification was not possible.
 741                  */
 742         #define RX_PKT_CMPL_FLAGS_ITYPE_IP              (UINT32_C(0x1) << 12)
 743                 /*
 744                  * TCP Packet: Indicates that the packet was IP and TCP. This
 745                  * indicates that the payload_offset field is valid.
 746                  */
 747         #define RX_PKT_CMPL_FLAGS_ITYPE_TCP             (UINT32_C(0x2) << 12)
 748                 /*
 749                  * UDP Packet: Indicates that the packet was IP and UDP. This
 750                  * indicates that the payload_offset field is valid.
 751                  */
 752         #define RX_PKT_CMPL_FLAGS_ITYPE_UDP             (UINT32_C(0x3) << 12)
 753                 /*
 754                  * FCoE Packet: Indicates that the packet was recognized as a
 755                  * FCoE. This also indicates that the payload_offset field is
 756                  * valid.
 757                  */
 758         #define RX_PKT_CMPL_FLAGS_ITYPE_FCOE            (UINT32_C(0x4) << 12)
 759                 /*
 760                  * RoCE Packet: Indicates that the packet was recognized as a
 761                  * RoCE. This also indicates that the payload_offset field is
 762                  * valid.
 763                  */
 764         #define RX_PKT_CMPL_FLAGS_ITYPE_ROCE            (UINT32_C(0x5) << 12)
 765                 /*
 766                  * ICMP Packet: Indicates that the packet was recognized as
 767                  * ICMP. This indicates that the payload_offset field is valid.
 768                  */
 769         #define RX_PKT_CMPL_FLAGS_ITYPE_ICMP            (UINT32_C(0x7) << 12)
 770                 /*
 771                  * PtP packet wo/timestamp: Indicates that the packet was
 772                  * recognized as a PtP packet.
 773                  */
 774         #define RX_PKT_CMPL_FLAGS_ITYPE_PTP_WO_TIMESTAMP \
 775                                                         (UINT32_C(0x8) << 12)
 776                 /*
 777                  * PtP packet w/timestamp: Indicates that the packet was
 778                  * recognized as a PtP packet and that a timestamp was taken for
 779                  * the packet.
 780                  */
 781         #define RX_PKT_CMPL_FLAGS_ITYPE_PTP_W_TIMESTAMP (UINT32_C(0x9) << 12)
 782         #define RX_PKT_CMPL_FLAGS_ITYPE_LAST \
 783                                         RX_PKT_CMPL_FLAGS_ITYPE_PTP_W_TIMESTAMP
 784         #define RX_PKT_CMPL_FLAGS_MASK                  UINT32_C(0xffc0)
 785         #define RX_PKT_CMPL_FLAGS_SFT                   6
 786         uint16_t flags_type;
 787
 788         /*
 789          * This is the length of the data for the packet stored in the buffer(s)
 790          * identified by the opaque value. This includes the packet BD and any
 791          * associated buffer BDs. This does not include the the length of any
 792          * data places in aggregation BDs.
 793          */
 794         uint16_t len;
 795
 796         /*
 797          * This is a copy of the opaque field from the RX BD this completion
 798          * corresponds to.
 799          */
 800         uint32_t opaque;
 801
 802         /*
 803          * This value is written by the NIC such that it will be different for
 804          * each pass through the completion queue. The even passes will write 1.
 805          * The odd passes will write 0.
 806          */
 807         #define RX_PKT_CMPL_V1                          UINT32_C(0x1)
 808         /*
 809          * This value is the number of aggregation buffers that follow this
 810          * entry in the completion ring that are a part of this packet. If the
 811          * value is zero, then the packet is completely contained in the buffer
 812          * space provided for the packet in the RX ring.
 813          */
 814         #define RX_PKT_CMPL_AGG_BUFS_MASK               UINT32_C(0x3e)
 815         #define RX_PKT_CMPL_AGG_BUFS_SFT                1
 816         uint8_t agg_bufs_v1;
 817
 818         /*
 819          * This is the RSS hash type for the packet. The value is packed
 820          * {tuple_extrac_op[1:0],rss_profile_id[4:0],tuple_extrac_op[2]}.
 821          */
 822         uint8_t rss_hash_type;
 823
 824         /*
 825          * This value indicates the offset from the beginning of the packet
 826          * where the inner payload starts. This value is valid for TCP, UDP,
 827          * FCoE, and RoCE packets.
 828          */
 829         uint8_t payload_offset;
 830
 831         uint8_t unused_1;
 832
 833         /*
 834          * This value is the RSS hash value calculated for the packet based on
 835          * the mode bits and key value in the VNIC.
 836          */
 837         uint32_t rss_hash;
 838 } __attribute__((packed));
 839
 840 /* last 16 bytes of RX Packet Completion Record */
 841 struct rx_pkt_cmpl_hi {
 842         /*
 843          * This indicates that the ip checksum was calculated for the inner
 844          * packet and that the ip_cs_error field indicates if there was an
 845          * error.
 846          */
 847         #define RX_PKT_CMPL_FLAGS2_IP_CS_CALC           UINT32_C(0x1)
 848         /*
 849          * This indicates that the TCP, UDP or ICMP checksum was calculated for
 850          * the inner packet and that the l4_cs_error field indicates if there
 851          * was an error.
 852          */
 853         #define RX_PKT_CMPL_FLAGS2_L4_CS_CALC           UINT32_C(0x2)
 854         /*
 855          * This indicates that the ip checksum was calculated for the tunnel
 856          * header and that the t_ip_cs_error field indicates if there was an
 857          * error.
 858          */
 859         #define RX_PKT_CMPL_FLAGS2_T_IP_CS_CALC         UINT32_C(0x4)
 860         /*
 861          * This indicates that the UDP checksum was calculated for the tunnel
 862          * packet and that the t_l4_cs_error field indicates if there was an
 863          * error.
 864          */
 865         #define RX_PKT_CMPL_FLAGS2_T_L4_CS_CALC         UINT32_C(0x8)
 866         /* This value indicates what format the metadata field is. */
 867         #define RX_PKT_CMPL_FLAGS2_META_FORMAT_MASK     UINT32_C(0xf0)
 868         #define RX_PKT_CMPL_FLAGS2_META_FORMAT_SFT      4
 869                 /* No metadata informtaion. Value is zero. */
 870         #define RX_PKT_CMPL_FLAGS2_META_FORMAT_NONE     (UINT32_C(0x0) << 4)
 871                 /*
 872                  * The metadata field contains the VLAN tag and TPID value. -
 873                  * metadata[11:0] contains the vlan VID value. - metadata[12]
 874                  * contains the vlan DE value. - metadata[15:13] contains the
 875                  * vlan PRI value. - metadata[31:16] contains the vlan TPID
 876                  * value.
 877                  */
 878         #define RX_PKT_CMPL_FLAGS2_META_FORMAT_VLAN     (UINT32_C(0x1) << 4)
 879         #define RX_PKT_CMPL_FLAGS2_META_FORMAT_LAST \
 880                                         RX_PKT_CMPL_FLAGS2_META_FORMAT_VLAN
 881         /*
 882          * This field indicates the IP type for the inner-most IP header. A
 883          * value of '0' indicates IPv4. A value of '1' indicates IPv6. This
 884          * value is only valid if itype indicates a packet with an IP header.
 885          */
 886         #define RX_PKT_CMPL_FLAGS2_IP_TYPE              UINT32_C(0x100)
 887         uint32_t flags2;
 888
 889         /*
 890          * This is data from the CFA block as indicated by the meta_format
 891          * field.
 892          */
 893         /* When meta_format=1, this value is the VLAN VID. */
 894         #define RX_PKT_CMPL_METADATA_VID_MASK           UINT32_C(0xfff)
 895         #define RX_PKT_CMPL_METADATA_VID_SFT            0
 896         /* When meta_format=1, this value is the VLAN DE. */
 897         #define RX_PKT_CMPL_METADATA_DE                 UINT32_C(0x1000)
 898         /* When meta_format=1, this value is the VLAN PRI. */
 899         #define RX_PKT_CMPL_METADATA_PRI_MASK           UINT32_C(0xe000)
 900         #define RX_PKT_CMPL_METADATA_PRI_SFT            13
 901         /* When meta_format=1, this value is the VLAN TPID. */
 902         #define RX_PKT_CMPL_METADATA_TPID_MASK          UINT32_C(0xffff0000)
 903         #define RX_PKT_CMPL_METADATA_TPID_SFT           16
 904         uint32_t metadata;
 905
 906         /*
 907          * This value is written by the NIC such that it will be different for
 908          * each pass through the completion queue. The even passes will write 1.
 909          * The odd passes will write 0.
 910          */
 911         #define RX_PKT_CMPL_V2                          UINT32_C(0x1)
 912         /*
 913          * This error indicates that there was some sort of problem with the BDs
 914          * for the packet that was found after part of the packet was already
 915          * placed. The packet should be treated as invalid.
 916          */
 917         #define RX_PKT_CMPL_ERRORS_BUFFER_ERROR_MASK    UINT32_C(0xe)
 918         #define RX_PKT_CMPL_ERRORS_BUFFER_ERROR_SFT     1
 919                 /* No buffer error */
 920         #define RX_PKT_CMPL_ERRORS_BUFFER_ERROR_NO_BUFFER \
 921                                                         (UINT32_C(0x0) << 1)
 922                 /*
 923                  * Did Not Fit: Packet did not fit into packet buffer provided.
 924                  * For regular placement, this means the packet did not fit in
 925                  * the buffer provided. For HDS and jumbo placement, this means
 926                  * that the packet could not be placed into 7 physical buffers
 927                  * or less.
 928                  */
 929         #define RX_PKT_CMPL_ERRORS_BUFFER_ERROR_DID_NOT_FIT \
 930                                                         (UINT32_C(0x1) << 1)
 931                 /*
 932                  * Not On Chip: All BDs needed for the packet were not on-chip
 933                  * when the packet arrived.
 934                  */
 935         #define RX_PKT_CMPL_ERRORS_BUFFER_ERROR_NOT_ON_CHIP \
 936                                                         (UINT32_C(0x2) << 1)
 937                 /* Bad Format: BDs were not formatted correctly. */
 938         #define RX_PKT_CMPL_ERRORS_BUFFER_ERROR_BAD_FORMAT \
 939                                                         (UINT32_C(0x3) << 1)
 940         #define RX_PKT_CMPL_ERRORS_BUFFER_ERROR_LAST \
 941                                 RX_PKT_CMPL_ERRORS_BUFFER_ERROR_BAD_FORMAT
 942         /* This indicates that there was an error in the IP header checksum. */
 943         #define RX_PKT_CMPL_ERRORS_IP_CS_ERROR          UINT32_C(0x10)
 944         /*
 945          * This indicates that there was an error in the TCP, UDP or ICMP
 946          * checksum.
 947          */
 948         #define RX_PKT_CMPL_ERRORS_L4_CS_ERROR          UINT32_C(0x20)
 949         /*
 950          * This indicates that there was an error in the tunnel IP header
 951          * checksum.
 952          */
 953         #define RX_PKT_CMPL_ERRORS_T_IP_CS_ERROR        UINT32_C(0x40)
 954         /* This indicates that there was an error in the tunnel UDP checksum. */
 955         #define RX_PKT_CMPL_ERRORS_T_L4_CS_ERROR        UINT32_C(0x80)
 956         /*
 957          * This indicates that there was a CRC error on either an FCoE or RoCE
 958          * packet. The itype indicates the packet type.
 959          */
 960         #define RX_PKT_CMPL_ERRORS_CRC_ERROR            UINT32_C(0x100)
 961         /*
 962          * This indicates that there was an error in the tunnel portion of the
 963          * packet when this field is non-zero.
 964          */
 965         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_MASK     UINT32_C(0xe00)
 966         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_SFT      9
 967                 /*
 968                  * No additional error occurred on the tunnel portion of the
 969                  * packet of the packet does not have a tunnel.
 970                  */
 971         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_NO_ERROR (UINT32_C(0x0) << 9)
 972                 /*
 973                  * Indicates that IP header version does not match expectation
 974                  * from L2 Ethertype for IPv4 and IPv6 in the tunnel header.
 975                  */
 976         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_T_L3_BAD_VERSION \
 977                                                         (UINT32_C(0x1) << 9)
 978                 /*
 979                  * Indicates that header length is out of range in the tunnel
 980                  * header. Valid for IPv4.
 981                  */
 982         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_T_L3_BAD_HDR_LEN \
 983                                                         (UINT32_C(0x2) << 9)
 984                 /*
 985                  * Indicates that the physical packet is shorter than that
 986                  * claimed by the PPPoE header length for a tunnel PPPoE packet.
 987                  */
 988         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_TUNNEL_TOTAL_ERROR \
 989                                                         (UINT32_C(0x3) << 9)
 990                 /*
 991                  * Indicates that physical packet is shorter than that claimed
 992                  * by the tunnel l3 header length. Valid for IPv4, or IPv6
 993                  * tunnel packet packets.
 994                  */
 995         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_T_IP_TOTAL_ERROR \
 996                                                         (UINT32_C(0x4) << 9)
 997                 /*
 998                  * Indicates that the physical packet is shorter than that
 999                  * claimed by the tunnel UDP header length for a tunnel UDP
1000                  * packet that is not fragmented.
1001                  */
1002         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_T_UDP_TOTAL_ERROR \
1003                                                         (UINT32_C(0x5) << 9)
1004                 /*
1005                  * indicates that the IPv4 TTL or IPv6 hop limit check have
1006                  * failed (e.g. TTL = 0) in the tunnel header. Valid for IPv4,
1007                  * and IPv6.
1008                  */
1009         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_T_L3_BAD_TTL \
1010                                                         (UINT32_C(0x6) << 9)
1011         #define RX_PKT_CMPL_ERRORS_T_PKT_ERROR_LAST \
1012                                 RX_PKT_CMPL_ERRORS_T_PKT_ERROR_T_L3_BAD_TTL
1013         /*
1014          * This indicates that there was an error in the inner portion of the
1015          * packet when this field is non-zero.
1016          */
1017         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_MASK       UINT32_C(0xf000)
1018         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_SFT        12
1019                 /*
1020                  * No additional error occurred on the tunnel portion of the
1021                  * packet of the packet does not have a tunnel.
1022                  */
1023         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_NO_ERROR   (UINT32_C(0x0) << 12)
1024                 /*
1025                  * Indicates that IP header version does not match expectation
1026                  * from L2 Ethertype for IPv4 and IPv6 or that option other than
1027                  * VFT was parsed on FCoE packet.
1028                  */
1029         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_L3_BAD_VERSION \
1030                                                         (UINT32_C(0x1) << 12)
1031                 /*
1032                  * indicates that header length is out of range. Valid for IPv4
1033                  * and RoCE
1034                  */
1035         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_L3_BAD_HDR_LEN \
1036                                                         (UINT32_C(0x2) << 12)
1037                 /*
1038                  * indicates that the IPv4 TTL or IPv6 hop limit check have
1039                  * failed (e.g. TTL = 0). Valid for IPv4, and IPv6
1040                  */
1041         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_L3_BAD_TTL (UINT32_C(0x3) << 12)
1042                 /*
1043                  * Indicates that physical packet is shorter than that claimed
1044                  * by the l3 header length. Valid for IPv4, IPv6 packet or RoCE
1045                  * packets.
1046                  */
1047         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_IP_TOTAL_ERROR \
1048                                                         (UINT32_C(0x4) << 12)
1049                 /*
1050                  * Indicates that the physical packet is shorter than that
1051                  * claimed by the UDP header length for a UDP packet that is not
1052                  * fragmented.
1053                  */
1054         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_UDP_TOTAL_ERROR \
1055                                                         (UINT32_C(0x5) << 12)
1056                 /*
1057                  * Indicates that TCP header length > IP payload. Valid for TCP
1058                  * packets only.
1059                  */
1060         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_L4_BAD_HDR_LEN \
1061                                                         (UINT32_C(0x6) << 12)
1062                 /* Indicates that TCP header length < 5. Valid for TCP. */
1063         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_L4_BAD_HDR_LEN_TOO_SMALL \
1064                                                         (UINT32_C(0x7) << 12)
1065                 /*
1066                  * Indicates that TCP option headers result in a TCP header size
1067                  * that does not match data offset in TCP header. Valid for TCP.
1068                  */
1069         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_L4_BAD_OPT_LEN \
1070                                                         (UINT32_C(0x8) << 12)
1071         #define RX_PKT_CMPL_ERRORS_PKT_ERROR_LAST \
1072                                 RX_PKT_CMPL_ERRORS_PKT_ERROR_L4_BAD_OPT_LEN
1073         #define RX_PKT_CMPL_ERRORS_MASK                 UINT32_C(0xfffe)
1074         #define RX_PKT_CMPL_ERRORS_SFT                  1
1075         uint16_t errors_v2;
1076
1077         /*
1078          * This field identifies the CFA action rule that was used for this
1079          * packet.
1080          */
1081         uint16_t cfa_code;
1082
1083         /*
1084          * This value holds the reordering sequence number for the packet. If
1085          * the reordering sequence is not valid, then this value is zero. The
1086          * reordering domain for the packet is in the bottom 8 to 10b of the
1087          * rss_hash value. The bottom 20b of this value contain the ordering
1088          * domain value for the packet.
1089          */
1090         #define RX_PKT_CMPL_REORDER_MASK                UINT32_C(0xffffff)
1091         #define RX_PKT_CMPL_REORDER_SFT                 0
1092         uint32_t reorder;
1093 } __attribute__((packed));
1094
1095 /* HWRM Forwarded Request (16 bytes) */
1096 struct hwrm_fwd_req_cmpl {
1097         /* Length of forwarded request in bytes. */
1098         /*
1099          * This field indicates the exact type of the completion. By convention,
1100          * the LSB identifies the length of the record in 16B units. Even values
1101          * indicate 16B records. Odd values indicate 32B records.
1102          */
1103         #define HWRM_FWD_REQ_CMPL_TYPE_MASK             UINT32_C(0x3f)
1104         #define HWRM_FWD_REQ_CMPL_TYPE_SFT              0
1105                 /* Forwarded HWRM Request */
1106         #define HWRM_FWD_REQ_CMPL_TYPE_HWRM_FWD_REQ     (UINT32_C(0x22) << 0)
1107         /* Length of forwarded request in bytes. */
1108         #define HWRM_FWD_REQ_CMPL_REQ_LEN_MASK          UINT32_C(0xffc0)
1109         #define HWRM_FWD_REQ_CMPL_REQ_LEN_SFT           6
1110         uint16_t req_len_type;
1111
1112         /*
1113          * Source ID of this request. Typically used in forwarding requests and
1114          * responses. 0x0 - 0xFFF8 - Used for function ids 0xFFF8 - 0xFFFE -
1115          * Reserved for internal processors 0xFFFF - HWRM
1116          */
1117         uint16_t source_id;
1118
1119         uint32_t unused_0;
1120
1121         /* Address of forwarded request. */
1122         /*
1123          * This value is written by the NIC such that it will be different for
1124          * each pass through the completion queue. The even passes will write 1.
1125          * The odd passes will write 0.
1126          */
1127         #define HWRM_FWD_REQ_CMPL_V                     UINT32_C(0x1)
1128         /* Address of forwarded request. */
1129         #define HWRM_FWD_REQ_CMPL_REQ_BUF_ADDR_MASK     UINT32_C(0xfffffffe)
1130         #define HWRM_FWD_REQ_CMPL_REQ_BUF_ADDR_SFT      1
1131         uint64_t req_buf_addr_v;
1132 } __attribute__((packed));
1133
1134 /* HWRM Asynchronous Event Completion Record (16 bytes) */
1135 struct hwrm_async_event_cmpl {
1136         /*
1137          * This field indicates the exact type of the completion. By convention,
1138          * the LSB identifies the length of the record in 16B units. Even values
1139          * indicate 16B records. Odd values indicate 32B records.
1140          */
1141         #define HWRM_ASYNC_EVENT_CMPL_TYPE_MASK         UINT32_C(0x3f)
1142         #define HWRM_ASYNC_EVENT_CMPL_TYPE_SFT          0
1143                 /* HWRM Asynchronous Event Information */
1144         #define HWRM_ASYNC_EVENT_CMPL_TYPE_HWRM_ASYNC_EVENT \
1145                                                         (UINT32_C(0x2e) << 0)
1146         uint16_t type;
1147
1148         /* Identifiers of events. */
1149                 /* Link status changed */
1150         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_LINK_STATUS_CHANGE \
1151                                                         (UINT32_C(0x0) << 0)
1152                 /* Link MTU changed */
1153         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_LINK_MTU_CHANGE \
1154                                                         (UINT32_C(0x1) << 0)
1155                 /* Link speed changed */
1156         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_LINK_SPEED_CHANGE \
1157                                                         (UINT32_C(0x2) << 0)
1158                 /* DCB Configuration changed */
1159         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_DCB_CONFIG_CHANGE \
1160                                                         (UINT32_C(0x3) << 0)
1161                 /* Port connection not allowed */
1162         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_PORT_CONN_NOT_ALLOWED \
1163                                                         (UINT32_C(0x4) << 0)
1164                 /* Link speed configuration was not allowed */
1165         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_LINK_SPEED_CFG_NOT_ALLOWED \
1166                                                         (UINT32_C(0x5) << 0)
1167                 /* Function driver unloaded */
1168         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_FUNC_DRVR_UNLOAD \
1169                                                         (UINT32_C(0x10) << 0)
1170                 /* Function driver loaded */
1171         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_FUNC_DRVR_LOAD \
1172                                                         (UINT32_C(0x11) << 0)
1173                 /* PF driver unloaded */
1174         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_PF_DRVR_UNLOAD \
1175                                                         (UINT32_C(0x20) << 0)
1176                 /* PF driver loaded */
1177         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_PF_DRVR_LOAD \
1178                                                         (UINT32_C(0x21) << 0)
1179                 /* VF Function Level Reset (FLR) */
1180         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_VF_FLR   (UINT32_C(0x30) << 0)
1181                 /* VF MAC Address Change */
1182         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_VF_MAC_ADDR_CHANGE \
1183                                                         (UINT32_C(0x31) << 0)
1184                 /* PF-VF communication channel status change. */
1185         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_PF_VF_COMM_STATUS_CHANGE \
1186                                                         (UINT32_C(0x32) << 0)
1187                 /* HWRM Error */
1188         #define HWRM_ASYNC_EVENT_CMPL_EVENT_ID_HWRM_ERROR \
1189                                                         (UINT32_C(0xff) << 0)
1190         uint16_t event_id;
1191
1192         /* Event specific data */
1193         uint32_t event_data2;
1194
1195         /* opaque is 7 b */
1196         /*
1197          * This value is written by the NIC such that it will be different for
1198          * each pass through the completion queue. The even passes will write 1.
1199          * The odd passes will write 0.
1200          */
1201         #define HWRM_ASYNC_EVENT_CMPL_V                         UINT32_C(0x1)
1202         /* opaque is 7 b */
1203         #define HWRM_ASYNC_EVENT_CMPL_OPAQUE_MASK               UINT32_C(0xfe)
1204         #define HWRM_ASYNC_EVENT_CMPL_OPAQUE_SFT                1
1205         uint8_t opaque_v;
1206
1207         /* 8-lsb timestamp from POR (100-msec resolution) */
1208         uint8_t timestamp_lo;
1209
1210         /* 16-lsb timestamp from POR (100-msec resolution) */
1211         uint16_t timestamp_hi;
1212
1213         /* Event specific data */
1214         uint32_t event_data1;
1215 } __attribute__((packed));
1216
1217 /*
1218  * Note: The Hardware Resource Manager (HWRM) manages various hardware resources
1219  * inside the chip. The HWRM is implemented in firmware, and runs on embedded
1220  * processors inside the chip. This firmware is vital part of the chip's
1221  * hardware. The chip can not be used by driver without it.
1222  */
1223
1224 /* Input (16 bytes) */
1225 struct input {
1226         /*
1227          * This value indicates what type of request this is. The format for the
1228          * rest of the command is determined by this field.
1229          */
1230         uint16_t req_type;
1231
1232         /*
1233          * This value indicates the what completion ring the request will be
1234          * optionally completed on. If the value is -1, then no CR completion
1235          * will be generated. Any other value must be a valid CR ring_id value
1236          * for this function.
1237          */
1238         uint16_t cmpl_ring;
1239
1240         /* This value indicates the command sequence number. */
1241         uint16_t seq_id;
1242
1243         /*
1244          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
1245          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
1246          */
1247         uint16_t target_id;
1248
1249         /*
1250          * This is the host address where the response will be written when the
1251          * request is complete. This area must be 16B aligned and must be
1252          * cleared to zero before the request is made.
1253          */
1254         uint64_t resp_addr;
1255 } __attribute__((packed));
1256
1257 /* Output (8 bytes) */
1258 struct output {
1259         /*
1260          * Pass/Fail or error type Note: receiver to verify the in parameters,
1261          * and fail the call with an error when appropriate
1262          */
1263         uint16_t error_code;
1264
1265         /* This field returns the type of original request. */
1266         uint16_t req_type;
1267
1268         /* This field provides original sequence number of the command. */
1269         uint16_t seq_id;
1270
1271         /*
1272          * This field is the length of the response in bytes. The last byte of
1273          * the response is a valid flag that will read as '1' when the command
1274          * has been completely written to memory.
1275          */
1276         uint16_t resp_len;
1277 } __attribute__((packed));
1278
1279 /* hwrm_cfa_l2_filter_alloc */
1280 /*
1281  * A filter is used to identify traffic that contains a matching set of
1282  * parameters like unicast or broadcast MAC address or a VLAN tag amongst
1283  * other things which then allows the ASIC to direct the  incoming traffic
1284  * to an appropriate VNIC or Rx ring.
1285  */
1286
1287 /* Input (96 bytes) */
1288 struct hwrm_cfa_l2_filter_alloc_input {
1289         /*
1290          * This value indicates what type of request this is. The format for the
1291          * rest of the command is determined by this field.
1292          */
1293         uint16_t req_type;
1294
1295         /*
1296          * This value indicates the what completion ring the request will be
1297          * optionally completed on. If the value is -1, then no CR completion
1298          * will be generated. Any other value must be a valid CR ring_id value
1299          * for this function.
1300          */
1301         uint16_t cmpl_ring;
1302
1303         /* This value indicates the command sequence number. */
1304         uint16_t seq_id;
1305
1306         /*
1307          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
1308          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
1309          */
1310         uint16_t target_id;
1311
1312         /*
1313          * This is the host address where the response will be written when the
1314          * request is complete. This area must be 16B aligned and must be
1315          * cleared to zero before the request is made.
1316          */
1317         uint64_t resp_addr;
1318
1319         /*
1320          * Enumeration denoting the RX, TX type of the resource. This
1321          * enumeration is used for resources that are similar for both TX and RX
1322          * paths of the chip.
1323          */
1324         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_FLAGS_PATH \
1325                                                         UINT32_C(0x1)
1326                 /* tx path */
1327         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_FLAGS_PATH_TX \
1328                                                         (UINT32_C(0x0) << 0)
1329                 /* rx path */
1330         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_FLAGS_PATH_RX \
1331                                                         (UINT32_C(0x1) << 0)
1332         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_FLAGS_PATH_LAST \
1333                                 HWRM_CFA_L2_FILTER_ALLOC_INPUT_FLAGS_PATH_RX
1334         /*
1335          * Setting of this flag indicates the applicability to the loopback
1336          * path.
1337          */
1338         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_FLAGS_LOOPBACK \
1339                                                         UINT32_C(0x2)
1340         /*
1341          * Setting of this flag indicates drop action. If this flag is not set,
1342          * then it should be considered accept action.
1343          */
1344         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_FLAGS_DROP \
1345                                                         UINT32_C(0x4)
1346         /*
1347          * If this flag is set, all t_l2_* fields are invalid and they should
1348          * not be specified. If this flag is set, then l2_* fields refer to
1349          * fields of outermost L2 header.
1350          */
1351         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_FLAGS_OUTERMOST \
1352                                                         UINT32_C(0x8)
1353         uint32_t flags;
1354
1355         /* This bit must be '1' for the l2_addr field to be configured. */
1356         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_L2_ADDR \
1357                                                         UINT32_C(0x1)
1358         /* This bit must be '1' for the l2_addr_mask field to be configured. */
1359         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_L2_ADDR_MASK \
1360                                                         UINT32_C(0x2)
1361         /* This bit must be '1' for the l2_ovlan field to be configured. */
1362         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_L2_OVLAN \
1363                                                         UINT32_C(0x4)
1364         /* This bit must be '1' for the l2_ovlan_mask field to be configured. */
1365         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_L2_OVLAN_MASK \
1366                                                         UINT32_C(0x8)
1367         /* This bit must be '1' for the l2_ivlan field to be configured. */
1368         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_L2_IVLAN \
1369                                                         UINT32_C(0x10)
1370         /* This bit must be '1' for the l2_ivlan_mask field to be configured. */
1371         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_L2_IVLAN_MASK \
1372                                                         UINT32_C(0x20)
1373         /* This bit must be '1' for the t_l2_addr field to be configured. */
1374         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_T_L2_ADDR \
1375                                                         UINT32_C(0x40)
1376         /*
1377          * This bit must be '1' for the t_l2_addr_mask field to be configured.
1378          */
1379         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_T_L2_ADDR_MASK \
1380                                                         UINT32_C(0x80)
1381         /* This bit must be '1' for the t_l2_ovlan field to be configured. */
1382         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_T_L2_OVLAN \
1383                                                         UINT32_C(0x100)
1384         /*
1385          * This bit must be '1' for the t_l2_ovlan_mask field to be configured.
1386          */
1387         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_T_L2_OVLAN_MASK \
1388                                                         UINT32_C(0x200)
1389         /* This bit must be '1' for the t_l2_ivlan field to be configured. */
1390         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_T_L2_IVLAN \
1391                                                         UINT32_C(0x400)
1392         /*
1393          * This bit must be '1' for the t_l2_ivlan_mask field to be configured.
1394          */
1395         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_T_L2_IVLAN_MASK \
1396                                                         UINT32_C(0x800)
1397         /* This bit must be '1' for the src_type field to be configured. */
1398         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_SRC_TYPE \
1399                                                         UINT32_C(0x1000)
1400         /* This bit must be '1' for the src_id field to be configured. */
1401         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_SRC_ID \
1402                                                         UINT32_C(0x2000)
1403         /* This bit must be '1' for the tunnel_type field to be configured. */
1404         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_TUNNEL_TYPE \
1405                                                         UINT32_C(0x4000)
1406         /* This bit must be '1' for the dst_id field to be configured. */
1407         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_DST_ID \
1408                                                         UINT32_C(0x8000)
1409         /*
1410          * This bit must be '1' for the mirror_vnic_id field to be configured.
1411          */
1412         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_ENABLES_MIRROR_VNIC_ID \
1413                                                         UINT32_C(0x10000)
1414         uint32_t enables;
1415
1416         /*
1417          * This value sets the match value for the L2 MAC address. Destination
1418          * MAC address for RX path. Source MAC address for TX path.
1419          */
1420         uint8_t l2_addr[6];
1421
1422         uint8_t unused_0;
1423         uint8_t unused_1;
1424
1425         /*
1426          * This value sets the mask value for the L2 address. A value of 0 will
1427          * mask the corresponding bit from compare.
1428          */
1429         uint8_t l2_addr_mask[6];
1430
1431         /* This value sets VLAN ID value for outer VLAN. */
1432         uint16_t l2_ovlan;
1433
1434         /*
1435          * This value sets the mask value for the ovlan id. A value of 0 will
1436          * mask the corresponding bit from compare.
1437          */
1438         uint16_t l2_ovlan_mask;
1439
1440         /* This value sets VLAN ID value for inner VLAN. */
1441         uint16_t l2_ivlan;
1442
1443         /*
1444          * This value sets the mask value for the ivlan id. A value of 0 will
1445          * mask the corresponding bit from compare.
1446          */
1447         uint16_t l2_ivlan_mask;
1448
1449         uint8_t unused_2;
1450         uint8_t unused_3;
1451
1452         /*
1453          * This value sets the match value for the tunnel L2 MAC address.
1454          * Destination MAC address for RX path. Source MAC address for TX path.
1455          */
1456         uint8_t t_l2_addr[6];
1457
1458         uint8_t unused_4;
1459         uint8_t unused_5;
1460
1461         /*
1462          * This value sets the mask value for the tunnel L2 address. A value of
1463          * 0 will mask the corresponding bit from compare.
1464          */
1465         uint8_t t_l2_addr_mask[6];
1466
1467         /* This value sets VLAN ID value for tunnel outer VLAN. */
1468         uint16_t t_l2_ovlan;
1469
1470         /*
1471          * This value sets the mask value for the tunnel ovlan id. A value of 0
1472          * will mask the corresponding bit from compare.
1473          */
1474         uint16_t t_l2_ovlan_mask;
1475
1476         /* This value sets VLAN ID value for tunnel inner VLAN. */
1477         uint16_t t_l2_ivlan;
1478
1479         /*
1480          * This value sets the mask value for the tunnel ivlan id. A value of 0
1481          * will mask the corresponding bit from compare.
1482          */
1483         uint16_t t_l2_ivlan_mask;
1484
1485         /* This value identifies the type of source of the packet. */
1486                 /* Network port */
1487         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_SRC_TYPE_NPORT \
1488                                                         (UINT32_C(0x0) << 0)
1489                 /* Physical function */
1490         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_SRC_TYPE_PF \
1491                                                         (UINT32_C(0x1) << 0)
1492                 /* Virtual function */
1493         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_SRC_TYPE_VF \
1494                                                         (UINT32_C(0x2) << 0)
1495                 /* Virtual NIC of a function */
1496         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_SRC_TYPE_VNIC \
1497                                                         (UINT32_C(0x3) << 0)
1498                 /* Embedded processor for CFA management */
1499         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_SRC_TYPE_KONG \
1500                                                         (UINT32_C(0x4) << 0)
1501                 /* Embedded processor for OOB management */
1502         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_SRC_TYPE_APE \
1503                                                         (UINT32_C(0x5) << 0)
1504                 /* Embedded processor for RoCE */
1505         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_SRC_TYPE_BONO \
1506                                                         (UINT32_C(0x6) << 0)
1507                 /* Embedded processor for network proxy functions */
1508         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_SRC_TYPE_TANG \
1509                                                         (UINT32_C(0x7) << 0)
1510         uint8_t src_type;
1511
1512         uint8_t unused_6;
1513         /*
1514          * This value is the id of the source. For a network port, it represents
1515          * port_id. For a physical function, it represents fid. For a virtual
1516          * function, it represents vf_id. For a vnic, it represents vnic_id. For
1517          * embedded processors, this id is not valid. Notes: 1. The function ID
1518          * is implied if it src_id is not provided for a src_type that is either
1519          */
1520         uint32_t src_id;
1521
1522         /* Tunnel Type. */
1523                 /* Non-tunnel */
1524         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_NONTUNNEL \
1525                                                         (UINT32_C(0x0) << 0)
1526                 /* Virtual eXtensible Local Area Network (VXLAN) */
1527         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_VXLAN \
1528                                                         (UINT32_C(0x1) << 0)
1529                 /*
1530                  * Network Virtualization Generic Routing Encapsulation (NVGRE)
1531                  */
1532         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_NVGRE \
1533                                                         (UINT32_C(0x2) << 0)
1534                 /*
1535                  * Generic Routing Encapsulation (GRE) inside Ethernet payload
1536                  */
1537         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_L2GRE \
1538                                                         (UINT32_C(0x3) << 0)
1539                 /* IP in IP */
1540         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_IPIP \
1541                                                         (UINT32_C(0x4) << 0)
1542                 /* Generic Network Virtualization Encapsulation (Geneve) */
1543         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_GENEVE \
1544                                                         (UINT32_C(0x5) << 0)
1545                 /* Multi-Protocol Lable Switching (MPLS) */
1546         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_MPLS \
1547                                                         (UINT32_C(0x6) << 0)
1548                 /* Stateless Transport Tunnel (STT) */
1549         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_STT \
1550                                                         (UINT32_C(0x7) << 0)
1551                 /*
1552                  * Generic Routing Encapsulation (GRE) inside IP datagram
1553                  * payload
1554                  */
1555         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_IPGRE \
1556                                                         (UINT32_C(0x8) << 0)
1557                 /* Any tunneled traffic */
1558         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_TUNNEL_TYPE_ANYTUNNEL \
1559                                                         (UINT32_C(0xff) << 0)
1560         uint8_t tunnel_type;
1561
1562         uint8_t unused_7;
1563
1564         /*
1565          * If set, this value shall represent the Logical VNIC ID of the
1566          * destination VNIC for the RX path and network port id of the
1567          * destination port for the TX path.
1568          */
1569         uint16_t dst_id;
1570
1571         /* Logical VNIC ID of the VNIC where traffic is mirrored. */
1572         uint16_t mirror_vnic_id;
1573
1574         /*
1575          * This hint is provided to help in placing the filter in the filter
1576          * table.
1577          */
1578                 /* No preference */
1579         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_PRI_HINT_NO_PREFER \
1580                                                         (UINT32_C(0x0) << 0)
1581                 /* Above the given filter */
1582         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_PRI_HINT_ABOVE_FILTER \
1583                                                         (UINT32_C(0x1) << 0)
1584                 /* Below the given filter */
1585         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_PRI_HINT_BELOW_FILTER \
1586                                                         (UINT32_C(0x2) << 0)
1587                 /* As high as possible */
1588         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_PRI_HINT_MAX \
1589                                                         (UINT32_C(0x3) << 0)
1590                 /* As low as possible */
1591         #define HWRM_CFA_L2_FILTER_ALLOC_INPUT_PRI_HINT_MIN \
1592                                                         (UINT32_C(0x4) << 0)
1593         uint8_t pri_hint;
1594
1595         uint8_t unused_8;
1596         uint32_t unused_9;
1597
1598         /*
1599          * This is the ID of the filter that goes along with the pri_hint. This
1600          * field is valid only for the following values. 1 - Above the given
1601          * filter 2 - Below the given filter
1602          */
1603         uint64_t l2_filter_id_hint;
1604 } __attribute__((packed));
1605
1606 /* Output (24 bytes) */
1607 struct hwrm_cfa_l2_filter_alloc_output {
1608         /*
1609          * Pass/Fail or error type Note: receiver to verify the in parameters,
1610          * and fail the call with an error when appropriate
1611          */
1612         uint16_t error_code;
1613
1614         /* This field returns the type of original request. */
1615         uint16_t req_type;
1616
1617         /* This field provides original sequence number of the command. */
1618         uint16_t seq_id;
1619
1620         /*
1621          * This field is the length of the response in bytes. The last byte of
1622          * the response is a valid flag that will read as '1' when the command
1623          * has been completely written to memory.
1624          */
1625         uint16_t resp_len;
1626
1627         /*
1628          * This value identifies a set of CFA data structures used for an L2
1629          * context.
1630          */
1631         uint64_t l2_filter_id;
1632
1633         /*
1634          * This is the ID of the flow associated with this filter. This value
1635          * shall be used to match and associate the flow identifier returned in
1636          * completion records. A value of 0xFFFFFFFF shall indicate no flow id.
1637          */
1638         uint32_t flow_id;
1639
1640         uint8_t unused_0;
1641         uint8_t unused_1;
1642         uint8_t unused_2;
1643
1644         /*
1645          * This field is used in Output records to indicate that the output is
1646          * completely written to RAM. This field should be read as '1' to
1647          * indicate that the output has been completely written. When writing a
1648          * command completion or response to an internal processor, the order of
1649          * writes has to be such that this field is written last.
1650          */
1651         uint8_t valid;
1652 } __attribute__((packed));
1653
1654 /* hwrm_cfa_l2_filter_free */
1655 /*
1656  * Description: Free a L2 filter. The HWRM shall free all associated filter
1657  * resources with the L2 filter.
1658  */
1659
1660 /* Input (24 bytes) */
1661 struct hwrm_cfa_l2_filter_free_input {
1662         /*
1663          * This value indicates what type of request this is. The format for the
1664          * rest of the command is determined by this field.
1665          */
1666         uint16_t req_type;
1667
1668         /*
1669          * This value indicates the what completion ring the request will be
1670          * optionally completed on. If the value is -1, then no CR completion
1671          * will be generated. Any other value must be a valid CR ring_id value
1672          * for this function.
1673          */
1674         uint16_t cmpl_ring;
1675
1676         /* This value indicates the command sequence number. */
1677         uint16_t seq_id;
1678
1679         /*
1680          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
1681          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
1682          */
1683         uint16_t target_id;
1684
1685         /*
1686          * This is the host address where the response will be written when the
1687          * request is complete. This area must be 16B aligned and must be
1688          * cleared to zero before the request is made.
1689          */
1690         uint64_t resp_addr;
1691
1692         /*
1693          * This value identifies a set of CFA data structures used for an L2
1694          * context.
1695          */
1696         uint64_t l2_filter_id;
1697 } __attribute__((packed));
1698
1699 /* Output (16 bytes) */
1700 struct hwrm_cfa_l2_filter_free_output {
1701         /*
1702          * Pass/Fail or error type Note: receiver to verify the in parameters,
1703          * and fail the call with an error when appropriate
1704          */
1705         uint16_t error_code;
1706
1707         /* This field returns the type of original request. */
1708         uint16_t req_type;
1709
1710         /* This field provides original sequence number of the command. */
1711         uint16_t seq_id;
1712
1713         /*
1714          * This field is the length of the response in bytes. The last byte of
1715          * the response is a valid flag that will read as '1' when the command
1716          * has been completely written to memory.
1717          */
1718         uint16_t resp_len;
1719
1720         uint32_t unused_0;
1721         uint8_t unused_1;
1722         uint8_t unused_2;
1723         uint8_t unused_3;
1724
1725         /*
1726          * This field is used in Output records to indicate that the output is
1727          * completely written to RAM. This field should be read as '1' to
1728          * indicate that the output has been completely written. When writing a
1729          * command completion or response to an internal processor, the order of
1730          * writes has to be such that this field is written last.
1731          */
1732         uint8_t valid;
1733 } __attribute__((packed));
1734
1735 /* hwrm_cfa_l2_set_rx_mask */
1736 /* Description: This command will set rx mask of the function. */
1737
1738 /* Input (40 bytes) */
1739 struct hwrm_cfa_l2_set_rx_mask_input {
1740         /*
1741          * This value indicates what type of request this is. The format for the
1742          * rest of the command is determined by this field.
1743          */
1744         uint16_t req_type;
1745
1746         /*
1747          * This value indicates the what completion ring the request will be
1748          * optionally completed on. If the value is -1, then no CR completion
1749          * will be generated. Any other value must be a valid CR ring_id value
1750          * for this function.
1751          */
1752         uint16_t cmpl_ring;
1753
1754         /* This value indicates the command sequence number. */
1755         uint16_t seq_id;
1756
1757         /*
1758          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
1759          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
1760          */
1761         uint16_t target_id;
1762
1763         /*
1764          * This is the host address where the response will be written when the
1765          * request is complete. This area must be 16B aligned and must be
1766          * cleared to zero before the request is made.
1767          */
1768         uint64_t resp_addr;
1769
1770         /* VNIC ID */
1771         uint32_t vnic_id;
1772
1773         /* Reserved for future use. */
1774         #define HWRM_CFA_L2_SET_RX_MASK_INPUT_MASK_RESERVED     UINT32_C(0x1)
1775         /*
1776          * When this bit is '1', the function is requested to accept multi-cast
1777          * packets specified by the multicast addr table.
1778          */
1779         #define HWRM_CFA_L2_SET_RX_MASK_INPUT_MASK_MCAST        UINT32_C(0x2)
1780         /*
1781          * When this bit is '1', the function is requested to accept all multi-
1782          * cast packets.
1783          */
1784         #define HWRM_CFA_L2_SET_RX_MASK_INPUT_MASK_ALL_MCAST    UINT32_C(0x4)
1785         /*
1786          * When this bit is '1', the function is requested to accept broadcast
1787          * packets.
1788          */
1789         #define HWRM_CFA_L2_SET_RX_MASK_INPUT_MASK_BCAST        UINT32_C(0x8)
1790         /*
1791          * When this bit is '1', the function is requested to be put in the
1792          * promiscuous mode. The HWRM should accept any function to set up
1793          * promiscuous mode. The HWRM shall follow the semantics below for the
1794          * promiscuous mode support. # When partitioning is not enabled on a
1795          * port (i.e. single PF on the port), then the PF shall be allowed to be
1796          * in the promiscuous mode. When the PF is in the promiscuous mode, then
1797          * it shall receive all host bound traffic on that port. # When
1798          * partitioning is enabled on a port (i.e. multiple PFs per port) and a
1799          * PF on that port is in the promiscuous mode, then the PF receives all
1800          * traffic within that partition as identified by a unique identifier
1801          * for the PF (e.g. S-Tag). If a unique outer VLAN for the PF is
1802          * specified, then the setting of promiscuous mode on that PF shall
1803          * result in the PF receiving all host bound traffic with matching outer
1804          * VLAN. # A VF shall can be set in the promiscuous mode. In the
1805          * promiscuous mode, the VF does not receive any traffic unless a unique
1806          * outer VLAN for the VF is specified. If a unique outer VLAN for the VF
1807          * is specified, then the setting of promiscuous mode on that VF shall
1808          * result in the VF receiving all host bound traffic with the matching
1809          * outer VLAN. # The HWRM shall allow the setting of promiscuous mode on
1810          * a function independently from the promiscuous mode settings on other
1811          * functions.
1812          */
1813         #define HWRM_CFA_L2_SET_RX_MASK_INPUT_MASK_PROMISCUOUS  UINT32_C(0x10)
1814         /*
1815          * If this flag is set, the corresponding RX filters shall be set up to
1816          * cover multicast/broadcast filters for the outermost Layer 2
1817          * destination MAC address field.
1818          */
1819         #define HWRM_CFA_L2_SET_RX_MASK_INPUT_MASK_OUTERMOST    UINT32_C(0x20)
1820         uint32_t mask;
1821
1822         /* This is the address for mcast address tbl. */
1823         uint64_t mc_tbl_addr;
1824
1825         /*
1826          * This value indicates how many entries in mc_tbl are valid. Each entry
1827          * is 6 bytes.
1828          */
1829         uint32_t num_mc_entries;
1830
1831         uint32_t unused_0;
1832 } __attribute__((packed));
1833
1834 /* Output (16 bytes) */
1835 struct hwrm_cfa_l2_set_rx_mask_output {
1836         /*
1837          * Pass/Fail or error type Note: receiver to verify the in parameters,
1838          * and fail the call with an error when appropriate
1839          */
1840         uint16_t error_code;
1841
1842         /* This field returns the type of original request. */
1843         uint16_t req_type;
1844
1845         /* This field provides original sequence number of the command. */
1846         uint16_t seq_id;
1847
1848         /*
1849          * This field is the length of the response in bytes. The last byte of
1850          * the response is a valid flag that will read as '1' when the command
1851          * has been completely written to memory.
1852          */
1853         uint16_t resp_len;
1854
1855         uint32_t unused_0;
1856         uint8_t unused_1;
1857         uint8_t unused_2;
1858         uint8_t unused_3;
1859
1860         /*
1861          * This field is used in Output records to indicate that the output is
1862          * completely written to RAM. This field should be read as '1' to
1863          * indicate that the output has been completely written. When writing a
1864          * command completion or response to an internal processor, the order of
1865          * writes has to be such that this field is written last.
1866          */
1867         uint8_t valid;
1868 } __attribute__((packed));
1869
1870 /* hwrm_exec_fwd_resp */
1871 /*
1872  * Description: This command is used to send an encapsulated request to the
1873  * HWRM. This command instructs the HWRM to execute the request and forward the
1874  * response of the encapsulated request to the location specified in the
1875  * original request that is encapsulated. The target id of this command shall be
1876  * set to 0xFFFF (HWRM). The response location in this command shall be used to
1877  * acknowledge the receipt of the encapsulated request and forwarding of the
1878  * response.
1879  */
1880
1881 /* Input (128 bytes) */
1882 struct hwrm_exec_fwd_resp_input {
1883         /*
1884          * This value indicates what type of request this is. The format for the
1885          * rest of the command is determined by this field.
1886          */
1887         uint16_t req_type;
1888
1889         /*
1890          * This value indicates the what completion ring the request will be
1891          * optionally completed on. If the value is -1, then no CR completion
1892          * will be generated. Any other value must be a valid CR ring_id value
1893          * for this function.
1894          */
1895         uint16_t cmpl_ring;
1896
1897         /* This value indicates the command sequence number. */
1898         uint16_t seq_id;
1899
1900         /*
1901          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
1902          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
1903          */
1904         uint16_t target_id;
1905
1906         /*
1907          * This is the host address where the response will be written when the
1908          * request is complete. This area must be 16B aligned and must be
1909          * cleared to zero before the request is made.
1910          */
1911         uint64_t resp_addr;
1912
1913         /*
1914          * This is an encapsulated request. This request should be executed by
1915          * the HWRM and the response should be provided in the response buffer
1916          * inside the encapsulated request.
1917          */
1918         uint32_t encap_request[26];
1919
1920         /*
1921          * This value indicates the target id of the response to the
1922          * encapsulated request. 0x0 - 0xFFF8 - Used for function ids 0xFFF8 -
1923          * 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
1924          */
1925         uint16_t encap_resp_target_id;
1926
1927         uint16_t unused_0[3];
1928 } __attribute__((packed));
1929
1930 /* Output (16 bytes) */
1931 struct hwrm_exec_fwd_resp_output {
1932         /*
1933          * Pass/Fail or error type Note: receiver to verify the in parameters,
1934          * and fail the call with an error when appropriate
1935          */
1936         uint16_t error_code;
1937
1938         /* This field returns the type of original request. */
1939         uint16_t req_type;
1940
1941         /* This field provides original sequence number of the command. */
1942         uint16_t seq_id;
1943
1944         /*
1945          * This field is the length of the response in bytes. The last byte of
1946          * the response is a valid flag that will read as '1' when the command
1947          * has been completely written to memory.
1948          */
1949         uint16_t resp_len;
1950
1951         uint32_t unused_0;
1952         uint8_t unused_1;
1953         uint8_t unused_2;
1954         uint8_t unused_3;
1955
1956         /*
1957          * This field is used in Output records to indicate that the output is
1958          * completely written to RAM. This field should be read as '1' to
1959          * indicate that the output has been completely written. When writing a
1960          * command completion or response to an internal processor, the order of
1961          * writes has to be such that this field is written last.
1962          */
1963         uint8_t valid;
1964 } __attribute__((packed));
1965
1966 /* hwrm_func_qcaps */
1967 /*
1968  * Description: This command returns capabilities of a function. The input FID
1969  * value is used to indicate what function is being queried. This allows a
1970  * physical function driver to query virtual functions that are children of the
1971  * physical function. The output FID value is needed to configure Rings and
1972  * MSI-X vectors so their DMA operations appear correctly on the PCI bus.
1973  */
1974
1975 /* Input (24 bytes) */
1976 struct hwrm_func_qcaps_input {
1977         /*
1978          * This value indicates what type of request this is. The format for the
1979          * rest of the command is determined by this field.
1980          */
1981         uint16_t req_type;
1982
1983         /*
1984          * This value indicates the what completion ring the request will be
1985          * optionally completed on. If the value is -1, then no CR completion
1986          * will be generated. Any other value must be a valid CR ring_id value
1987          * for this function.
1988          */
1989         uint16_t cmpl_ring;
1990
1991         /* This value indicates the command sequence number. */
1992         uint16_t seq_id;
1993
1994         /*
1995          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
1996          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
1997          */
1998         uint16_t target_id;
1999
2000         /*
2001          * This is the host address where the response will be written when the
2002          * request is complete. This area must be 16B aligned and must be
2003          * cleared to zero before the request is made.
2004          */
2005         uint64_t resp_addr;
2006
2007         /*
2008          * Function ID of the function that is being queried. 0xFF... (All Fs)
2009          * if the query is for the requesting function.
2010          */
2011         uint16_t fid;
2012
2013         uint16_t unused_0[3];
2014 } __attribute__((packed));
2015
2016 /* Output (80 bytes) */
2017 struct hwrm_func_qcaps_output {
2018         /*
2019          * Pass/Fail or error type Note: receiver to verify the in parameters,
2020          * and fail the call with an error when appropriate
2021          */
2022         uint16_t error_code;
2023
2024         /* This field returns the type of original request. */
2025         uint16_t req_type;
2026
2027         /* This field provides original sequence number of the command. */
2028         uint16_t seq_id;
2029
2030         /*
2031          * This field is the length of the response in bytes. The last byte of
2032          * the response is a valid flag that will read as '1' when the command
2033          * has been completely written to memory.
2034          */
2035         uint16_t resp_len;
2036
2037         /*
2038          * FID value. This value is used to identify operations on the PCI bus
2039          * as belonging to a particular PCI function.
2040          */
2041         uint16_t fid;
2042
2043         /*
2044          * Port ID of port that this function is associated with. Valid only for
2045          * the PF. 0xFF... (All Fs) if this function is not associated with any
2046          * port. 0xFF... (All Fs) if this function is called from a VF.
2047          */
2048         uint16_t port_id;
2049
2050         /* If 1, then Push mode is supported on this function. */
2051         #define HWRM_FUNC_QCAPS_OUTPUT_FLAGS_PUSH_MODE_SUPPORTED   UINT32_C(0x1)
2052         /*
2053          * If 1, then the global MSI-X auto-masking is enabled for the device.
2054          */
2055         #define HWRM_FUNC_QCAPS_OUTPUT_FLAGS_GLOBAL_MSIX_AUTOMASKING \
2056                                                                 UINT32_C(0x2)
2057         /*
2058          * If 1, then the Precision Time Protocol (PTP) processing is supported
2059          * on this function. The HWRM should enable PTP on only a single
2060          * Physical Function (PF) per port.
2061          */
2062         #define HWRM_FUNC_QCAPS_OUTPUT_FLAGS_PTP_SUPPORTED         UINT32_C(0x4)
2063         uint32_t flags;
2064
2065         /*
2066          * This value is current MAC address configured for this function. A
2067          * value of 00-00-00-00-00-00 indicates no MAC address is currently
2068          * configured.
2069          */
2070         uint8_t perm_mac_address[6];
2071
2072         /*
2073          * The maximum number of RSS/COS contexts that can be allocated to the
2074          * function.
2075          */
2076         uint16_t max_rsscos_ctx;
2077
2078         /*
2079          * The maximum number of completion rings that can be allocated to the
2080          * function.
2081          */
2082         uint16_t max_cmpl_rings;
2083
2084         /*
2085          * The maximum number of transmit rings that can be allocated to the
2086          * function.
2087          */
2088         uint16_t max_tx_rings;
2089
2090         /*
2091          * The maximum number of receive rings that can be allocated to the
2092          * function.
2093          */
2094         uint16_t max_rx_rings;
2095
2096         /*
2097          * The maximum number of L2 contexts that can be allocated to the
2098          * function.
2099          */
2100         uint16_t max_l2_ctxs;
2101
2102         /* The maximum number of VNICs that can be allocated to the function. */
2103         uint16_t max_vnics;
2104
2105         /*
2106          * The identifier for the first VF enabled on a PF. This is valid only
2107          * on the PF with SR-IOV enabled. 0xFF... (All Fs) if this command is
2108          * called on a PF with SR-IOV disabled or on a VF.
2109          */
2110         uint16_t first_vf_id;
2111
2112         /*
2113          * The maximum number of VFs that can be allocated to the function. This
2114          * is valid only on the PF with SR-IOV enabled. 0xFF... (All Fs) if this
2115          * command is called on a PF with SR-IOV disabled or on a VF.
2116          */
2117         uint16_t max_vfs;
2118
2119         /*
2120          * The maximum number of statistic contexts that can be allocated to the
2121          * function.
2122          */
2123         uint16_t max_stat_ctx;
2124
2125         /*
2126          * The maximum number of Encapsulation records that can be offloaded by
2127          * this function.
2128          */
2129         uint32_t max_encap_records;
2130
2131         /*
2132          * The maximum number of decapsulation records that can be offloaded by
2133          * this function.
2134          */
2135         uint32_t max_decap_records;
2136
2137         /*
2138          * The maximum number of Exact Match (EM) flows that can be offloaded by
2139          * this function on the TX side.
2140          */
2141         uint32_t max_tx_em_flows;
2142
2143         /*
2144          * The maximum number of Wildcard Match (WM) flows that can be offloaded
2145          * by this function on the TX side.
2146          */
2147         uint32_t max_tx_wm_flows;
2148
2149         /*
2150          * The maximum number of Exact Match (EM) flows that can be offloaded by
2151          * this function on the RX side.
2152          */
2153         uint32_t max_rx_em_flows;
2154
2155         /*
2156          * The maximum number of Wildcard Match (WM) flows that can be offloaded
2157          * by this function on the RX side.
2158          */
2159         uint32_t max_rx_wm_flows;
2160
2161         /*
2162          * The maximum number of multicast filters that can be supported by this
2163          * function on the RX side.
2164          */
2165         uint32_t max_mcast_filters;
2166
2167         /*
2168          * The maximum value of flow_id that can be supported in completion
2169          * records.
2170          */
2171         uint32_t max_flow_id;
2172
2173         /*
2174          * The maximum number of HW ring groups that can be supported on this
2175          * function.
2176          */
2177         uint32_t max_hw_ring_grps;
2178
2179         uint8_t unused_0;
2180         uint8_t unused_1;
2181         uint8_t unused_2;
2182
2183         /*
2184          * This field is used in Output records to indicate that the output is
2185          * completely written to RAM. This field should be read as '1' to
2186          * indicate that the output has been completely written. When writing a
2187          * command completion or response to an internal processor, the order of
2188          * writes has to be such that this field is written last.
2189          */
2190         uint8_t valid;
2191 } __attribute__((packed));
2192
2193 /* hwrm_func_reset */
2194 /*
2195  * Description: This command resets a hardware function (PCIe function) and
2196  * frees any resources used by the function. This command shall be initiated by
2197  * the driver after an FLR has occurred to prepare the function for re-use. This
2198  * command may also be initiated by a driver prior to doing it's own
2199  * configuration. This command puts the function into the reset state. In the
2200  * reset state, global and port related features of the chip are not available.
2201  */
2202 /*
2203  * Note: This command will reset a function that has already been disabled or
2204  * idled. The command returns all the resources owned by the function so a new
2205  * driver may allocate and configure resources normally.
2206  */
2207
2208 /* Input (24 bytes) */
2209 struct hwrm_func_reset_input {
2210         /*
2211          * This value indicates what type of request this is. The format for the
2212          * rest of the command is determined by this field.
2213          */
2214         uint16_t req_type;
2215
2216         /*
2217          * This value indicates the what completion ring the request will be
2218          * optionally completed on. If the value is -1, then no CR completion
2219          * will be generated. Any other value must be a valid CR ring_id value
2220          * for this function.
2221          */
2222         uint16_t cmpl_ring;
2223
2224         /* This value indicates the command sequence number. */
2225         uint16_t seq_id;
2226
2227         /*
2228          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
2229          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
2230          */
2231         uint16_t target_id;
2232
2233         /*
2234          * This is the host address where the response will be written when the
2235          * request is complete. This area must be 16B aligned and must be
2236          * cleared to zero before the request is made.
2237          */
2238         uint64_t resp_addr;
2239
2240         /* This bit must be '1' for the vf_id_valid field to be configured. */
2241         #define HWRM_FUNC_RESET_INPUT_ENABLES_VF_ID_VALID \
2242                                                         UINT32_C(0x1)
2243         uint32_t enables;
2244
2245         /*
2246          * The ID of the VF that this PF is trying to reset. Only the parent PF
2247          * shall be allowed to reset a child VF. A parent PF driver shall use
2248          * this field only when a specific child VF is requested to be reset.
2249          */
2250         uint16_t vf_id;
2251
2252         /* This value indicates the level of a function reset. */
2253                 /*
2254                  * Reset the caller function and its children VFs (if any). If
2255                  * no children functions exist, then reset the caller function
2256                  * only.
2257                  */
2258         #define HWRM_FUNC_RESET_INPUT_FUNC_RESET_LEVEL_RESETALL \
2259                                                         (UINT32_C(0x0) << 0)
2260                 /* Reset the caller function only */
2261         #define HWRM_FUNC_RESET_INPUT_FUNC_RESET_LEVEL_RESETME \
2262                                                         (UINT32_C(0x1) << 0)
2263                 /*
2264                  * Reset all children VFs of the caller function driver if the
2265                  * caller is a PF driver. It is an error to specify this level
2266                  * by a VF driver. It is an error to specify this level by a PF
2267                  * driver with no children VFs.
2268                  */
2269         #define HWRM_FUNC_RESET_INPUT_FUNC_RESET_LEVEL_RESETCHILDREN \
2270                                                         (UINT32_C(0x2) << 0)
2271                 /*
2272                  * Reset a specific VF of the caller function driver if the
2273                  * caller is the parent PF driver. It is an error to specify
2274                  * this level by a VF driver. It is an error to specify this
2275                  * level by a PF driver that is not the parent of the VF that is
2276                  * being requested to reset.
2277                  */
2278         #define HWRM_FUNC_RESET_INPUT_FUNC_RESET_LEVEL_RESETVF \
2279                                                         (UINT32_C(0x3) << 0)
2280         uint8_t func_reset_level;
2281
2282         uint8_t unused_0;
2283 } __attribute__((packed));
2284
2285 /* Output (16 bytes) */
2286 struct hwrm_func_reset_output {
2287         /*
2288          * Pass/Fail or error type Note: receiver to verify the in parameters,
2289          * and fail the call with an error when appropriate
2290          */
2291         uint16_t error_code;
2292
2293         /* This field returns the type of original request. */
2294         uint16_t req_type;
2295
2296         /* This field provides original sequence number of the command. */
2297         uint16_t seq_id;
2298
2299         /*
2300          * This field is the length of the response in bytes. The last byte of
2301          * the response is a valid flag that will read as '1' when the command
2302          * has been completely written to memory.
2303          */
2304         uint16_t resp_len;
2305
2306         uint32_t unused_0;
2307         uint8_t unused_1;
2308         uint8_t unused_2;
2309         uint8_t unused_3;
2310
2311         /*
2312          * This field is used in Output records to indicate that the output is
2313          * completely written to RAM. This field should be read as '1' to
2314          * indicate that the output has been completely written. When writing a
2315          * command completion or response to an internal processor, the order of
2316          * writes has to be such that this field is written last.
2317          */
2318         uint8_t valid;
2319 } __attribute__((packed));
2320
2321 /* hwrm_port_phy_cfg */
2322 /*
2323  * Description: This command configures the PHY device for the port. It allows
2324  * setting of the most generic settings for the PHY. The HWRM shall complete
2325  * this command as soon as PHY settings are configured. They may not be applied
2326  * when the command response is provided. A VF driver shall not be allowed to
2327  * configure PHY using this command. In a network partition mode, a PF driver
2328  * shall not be allowed to configure PHY using this command.
2329  */
2330
2331 /* Input (56 bytes) */
2332 struct hwrm_port_phy_cfg_input {
2333         /*
2334          * This value indicates what type of request this is. The format for the
2335          * rest of the command is determined by this field.
2336          */
2337         uint16_t req_type;
2338
2339         /*
2340          * This value indicates the what completion ring the request will be
2341          * optionally completed on. If the value is -1, then no CR completion
2342          * will be generated. Any other value must be a valid CR ring_id value
2343          * for this function.
2344          */
2345         uint16_t cmpl_ring;
2346
2347         /* This value indicates the command sequence number. */
2348         uint16_t seq_id;
2349
2350         /*
2351          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
2352          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
2353          */
2354         uint16_t target_id;
2355
2356         /*
2357          * This is the host address where the response will be written when the
2358          * request is complete. This area must be 16B aligned and must be
2359          * cleared to zero before the request is made.
2360          */
2361         uint64_t resp_addr;
2362
2363         /*
2364          * When this bit is set to '1', the PHY for the port shall be reset. #
2365          * If this bit is set to 1, then the HWRM shall reset the PHY after
2366          * applying PHY configuration changes specified in this command. # In
2367          * order to guarantee that PHY configuration changes specified in this
2368          * command take effect, the HWRM client should set this flag to 1. # If
2369          * this bit is not set to 1, then the HWRM may reset the PHY depending
2370          * on the current PHY configuration and settings specified in this
2371          * command.
2372          */
2373         #define HWRM_PORT_PHY_CFG_INPUT_FLAGS_RESET_PHY            UINT32_C(0x1)
2374         /*
2375          * When this bit is set to '1', the link shall be forced to be taken
2376          * down. # When this bit is set to '1", all other command input settings
2377          * related to the link speed shall be ignored. Once the link state is
2378          * forced down, it can be explicitly cleared from that state by setting
2379          * this flag to '0'. # If this flag is set to '0', then the link shall
2380          * be cleared from forced down state if the link is in forced down
2381          * state. There may be conditions (e.g. out-of-band or sideband
2382          * configuration changes for the link) outside the scope of the HWRM
2383          * implementation that may clear forced down link state.
2384          */
2385         #define HWRM_PORT_PHY_CFG_INPUT_FLAGS_FORCE_LINK_DOWN      UINT32_C(0x2)
2386         /*
2387          * When this bit is set to '1', the link shall be forced to the
2388          * force_link_speed value. When this bit is set to '1', the HWRM client
2389          * should not enable any of the auto negotiation related fields
2390          * represented by auto_XXX fields in this command. When this bit is set
2391          * to '1' and the HWRM client has enabled a auto_XXX field in this
2392          * command, then the HWRM shall ignore the enabled auto_XXX field. When
2393          * this bit is set to zero, the link shall be allowed to autoneg.
2394          */
2395         #define HWRM_PORT_PHY_CFG_INPUT_FLAGS_FORCE                UINT32_C(0x4)
2396         /*
2397          * When this bit is set to '1', the auto-negotiation process shall be
2398          * restarted on the link.
2399          */
2400         #define HWRM_PORT_PHY_CFG_INPUT_FLAGS_RESTART_AUTONEG      UINT32_C(0x8)
2401         /*
2402          * When this bit is set to '1', Energy Efficient Ethernet (EEE) is
2403          * requested to be enabled on this link. If EEE is not supported on this
2404          * port, then this flag shall be ignored by the HWRM.
2405          */
2406         #define HWRM_PORT_PHY_CFG_INPUT_FLAGS_EEE_ENABLE        UINT32_C(0x10)
2407         /*
2408          * When this bit is set to '1', Energy Efficient Ethernet (EEE) is
2409          * requested to be disabled on this link. If EEE is not supported on
2410          * this port, then this flag shall be ignored by the HWRM.
2411          */
2412         #define HWRM_PORT_PHY_CFG_INPUT_FLAGS_EEE_DISABLE       UINT32_C(0x20)
2413         /*
2414          * When this bit is set to '1' and EEE is enabled on this link, then TX
2415          * LPI is requested to be enabled on the link. If EEE is not supported
2416          * on this port, then this flag shall be ignored by the HWRM. If EEE is
2417          * disabled on this port, then this flag shall be ignored by the HWRM.
2418          */
2419         #define HWRM_PORT_PHY_CFG_INPUT_FLAGS_EEE_TX_LPI        UINT32_C(0x40)
2420         uint32_t flags;
2421
2422         /* This bit must be '1' for the auto_mode field to be configured. */
2423         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_AUTO_MODE          UINT32_C(0x1)
2424         /* This bit must be '1' for the auto_duplex field to be configured. */
2425         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_AUTO_DUPLEX        UINT32_C(0x2)
2426         /* This bit must be '1' for the auto_pause field to be configured. */
2427         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_AUTO_PAUSE         UINT32_C(0x4)
2428         /*
2429          * This bit must be '1' for the auto_link_speed field to be configured.
2430          */
2431         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_AUTO_LINK_SPEED    UINT32_C(0x8)
2432         /*
2433          * This bit must be '1' for the auto_link_speed_mask field to be
2434          * configured.
2435          */
2436         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_AUTO_LINK_SPEED_MASK \
2437                                                                 UINT32_C(0x10)
2438         /* This bit must be '1' for the wirespeed field to be configured. */
2439         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_WIRESPEED       UINT32_C(0x20)
2440         /* This bit must be '1' for the lpbk field to be configured. */
2441         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_LPBK            UINT32_C(0x40)
2442         /* This bit must be '1' for the preemphasis field to be configured. */
2443         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_PREEMPHASIS     UINT32_C(0x80)
2444         /* This bit must be '1' for the force_pause field to be configured. */
2445         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_FORCE_PAUSE     UINT32_C(0x100)
2446         /*
2447          * This bit must be '1' for the eee_link_speed_mask field to be
2448          * configured.
2449          */
2450         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_EEE_LINK_SPEED_MASK \
2451                                                                 UINT32_C(0x200)
2452         /* This bit must be '1' for the tx_lpi_timer field to be configured. */
2453         #define HWRM_PORT_PHY_CFG_INPUT_ENABLES_TX_LPI_TIMER    UINT32_C(0x400)
2454         uint32_t enables;
2455
2456         /* Port ID of port that is to be configured. */
2457         uint16_t port_id;
2458
2459         /*
2460          * This is the speed that will be used if the force bit is '1'. If
2461          * unsupported speed is selected, an error will be generated.
2462          */
2463                 /* 100Mb link speed */
2464         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_100MB \
2465                                                         (UINT32_C(0x1) << 0)
2466                 /* 1Gb link speed */
2467         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_1GB \
2468                                                         (UINT32_C(0xa) << 0)
2469                 /* 2Gb link speed */
2470         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_2GB \
2471                                                         (UINT32_C(0x14) << 0)
2472                 /* 2.5Gb link speed */
2473         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_2_5GB \
2474                                                         (UINT32_C(0x19) << 0)
2475                 /* 10Gb link speed */
2476         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_10GB \
2477                                                         (UINT32_C(0x64) << 0)
2478                 /* 20Mb link speed */
2479         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_20GB \
2480                                                         (UINT32_C(0xc8) << 0)
2481                 /* 25Gb link speed */
2482         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_25GB \
2483                                                         (UINT32_C(0xfa) << 0)
2484                 /* 40Gb link speed */
2485         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_40GB \
2486                                                         (UINT32_C(0x190) << 0)
2487                 /* 50Gb link speed */
2488         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_50GB \
2489                                                         (UINT32_C(0x1f4) << 0)
2490                 /* 100Gb link speed */
2491         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_100GB \
2492                                                         (UINT32_C(0x3e8) << 0)
2493                 /* 10Mb link speed */
2494         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_LINK_SPEED_10MB \
2495                                                         (UINT32_C(0xffff) << 0)
2496         uint16_t force_link_speed;
2497
2498         /*
2499          * This value is used to identify what autoneg mode is used when the
2500          * link speed is not being forced.
2501          */
2502                 /*
2503                  * Disable autoneg or autoneg disabled. No speeds are selected.
2504                  */
2505         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_MODE_NONE  (UINT32_C(0x0) << 0)
2506                 /* Select all possible speeds for autoneg mode. */
2507         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_MODE_ALL_SPEEDS \
2508                                                         (UINT32_C(0x1) << 0)
2509                 /*
2510                  * Select only the auto_link_speed speed for autoneg mode. This
2511                  * mode has been DEPRECATED. An HWRM client should not use this
2512                  * mode.
2513                  */
2514         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_MODE_ONE_SPEED \
2515                                                         (UINT32_C(0x2) << 0)
2516                 /*
2517                  * Select the auto_link_speed or any speed below that speed for
2518                  * autoneg. This mode has been DEPRECATED. An HWRM client should
2519                  * not use this mode.
2520                  */
2521         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_MODE_ONE_OR_BELOW \
2522                                                         (UINT32_C(0x3) << 0)
2523                 /*
2524                  * Select the speeds based on the corresponding link speed mask
2525                  * value that is provided.
2526                  */
2527         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_MODE_SPEED_MASK \
2528                                                         (UINT32_C(0x4) << 0)
2529         uint8_t auto_mode;
2530
2531         /*
2532          * This is the duplex setting that will be used if the autoneg_mode is
2533          * "one_speed" or "one_or_below".
2534          */
2535                 /* Half Duplex will be requested. */
2536         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_DUPLEX_HALF \
2537                                                         (UINT32_C(0x0) << 0)
2538                 /* Full duplex will be requested. */
2539         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_DUPLEX_FULL \
2540                                                         (UINT32_C(0x1) << 0)
2541                 /* Both Half and Full dupex will be requested. */
2542         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_DUPLEX_BOTH \
2543                                                         (UINT32_C(0x2) << 0)
2544         uint8_t auto_duplex;
2545
2546         /*
2547          * This value is used to configure the pause that will be used for
2548          * autonegotiation. Add text on the usage of auto_pause and force_pause.
2549          */
2550         /*
2551          * When this bit is '1', Generation of tx pause messages has been
2552          * requested. Disabled otherwise.
2553          */
2554         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_PAUSE_TX              UINT32_C(0x1)
2555         /*
2556          * When this bit is '1', Reception of rx pause messages has been
2557          * requested. Disabled otherwise.
2558          */
2559         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_PAUSE_RX              UINT32_C(0x2)
2560         /*
2561          * When set to 1, the advertisement of pause is enabled. # When the
2562          * auto_mode is not set to none and this flag is set to 1, then the
2563          * auto_pause bits on this port are being advertised and autoneg pause
2564          * results are being interpreted. # When the auto_mode is not set to
2565          * none and this flag is set to 0, the pause is forced as indicated in
2566          * force_pause, and also advertised as auto_pause bits, but the autoneg
2567          * results are not interpreted since the pause configuration is being
2568          * forced. # When the auto_mode is set to none and this flag is set to
2569          * 1, auto_pause bits should be ignored and should be set to 0.
2570          */
2571         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_PAUSE_AUTONEG_PAUSE   UINT32_C(0x4)
2572         uint8_t auto_pause;
2573
2574         uint8_t unused_0;
2575
2576         /*
2577          * This is the speed that will be used if the autoneg_mode is
2578          * "one_speed" or "one_or_below". If an unsupported speed is selected,
2579          * an error will be generated.
2580          */
2581                 /* 100Mb link speed */
2582         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_100MB \
2583                                                         (UINT32_C(0x1) << 0)
2584                 /* 1Gb link speed */
2585         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_1GB \
2586                                                         (UINT32_C(0xa) << 0)
2587                 /* 2Gb link speed */
2588         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_2GB \
2589                                                         (UINT32_C(0x14) << 0)
2590                 /* 2.5Gb link speed */
2591         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_2_5GB \
2592                                                         (UINT32_C(0x19) << 0)
2593                 /* 10Gb link speed */
2594         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_10GB \
2595                                                         (UINT32_C(0x64) << 0)
2596                 /* 20Mb link speed */
2597         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_20GB \
2598                                                         (UINT32_C(0xc8) << 0)
2599                 /* 25Gb link speed */
2600         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_25GB \
2601                                                         (UINT32_C(0xfa) << 0)
2602                 /* 40Gb link speed */
2603         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_40GB \
2604                                                         (UINT32_C(0x190) << 0)
2605                 /* 50Gb link speed */
2606         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_50GB \
2607                                                         (UINT32_C(0x1f4) << 0)
2608                 /* 100Gb link speed */
2609         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_100GB \
2610                                                         (UINT32_C(0x3e8) << 0)
2611                 /* 10Mb link speed */
2612         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_10MB \
2613                                                         (UINT32_C(0xffff) << 0)
2614         uint16_t auto_link_speed;
2615
2616         /*
2617          * This is a mask of link speeds that will be used if autoneg_mode is
2618          * "mask". If unsupported speed is enabled an error will be generated.
2619          */
2620         /* 100Mb link speed (Half-duplex) */
2621         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_100MBHD \
2622                                                         UINT32_C(0x1)
2623         /* 100Mb link speed (Full-duplex) */
2624         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_100MB \
2625                                                         UINT32_C(0x2)
2626         /* 1Gb link speed (Half-duplex) */
2627         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_1GBHD \
2628                                                         UINT32_C(0x4)
2629         /* 1Gb link speed (Full-duplex) */
2630         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_1GB \
2631                                                         UINT32_C(0x8)
2632         /* 2Gb link speed */
2633         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_2GB \
2634                                                         UINT32_C(0x10)
2635         /* 2.5Gb link speed */
2636         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_2_5GB \
2637                                                         UINT32_C(0x20)
2638         /* 10Gb link speed */
2639         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_10GB \
2640                                                         UINT32_C(0x40)
2641         /* 20Gb link speed */
2642         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_20GB \
2643                                                         UINT32_C(0x80)
2644         /* 25Gb link speed */
2645         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_25GB \
2646                                                         UINT32_C(0x100)
2647         /* 40Gb link speed */
2648         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_40GB \
2649                                                         UINT32_C(0x200)
2650         /* 50Gb link speed */
2651         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_50GB \
2652                                                         UINT32_C(0x400)
2653         /* 100Gb link speed */
2654         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_100GB \
2655                                                         UINT32_C(0x800)
2656         /* 10Mb link speed (Half-duplex) */
2657         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_10MBHD \
2658                                                         UINT32_C(0x1000)
2659         /* 10Mb link speed (Full-duplex) */
2660         #define HWRM_PORT_PHY_CFG_INPUT_AUTO_LINK_SPEED_MASK_10MB \
2661                                                         UINT32_C(0x2000)
2662         uint16_t auto_link_speed_mask;
2663
2664         /* This value controls the wirespeed feature. */
2665                 /* Wirespeed feature is disabled. */
2666         #define HWRM_PORT_PHY_CFG_INPUT_WIRESPEED_OFF   (UINT32_C(0x0) << 0)
2667                 /* Wirespeed feature is enabled. */
2668         #define HWRM_PORT_PHY_CFG_INPUT_WIRESPEED_ON    (UINT32_C(0x1) << 0)
2669         uint8_t wirespeed;
2670
2671         /* This value controls the loopback setting for the PHY. */
2672                 /* No loopback is selected. Normal operation. */
2673         #define HWRM_PORT_PHY_CFG_INPUT_LPBK_NONE       (UINT32_C(0x0) << 0)
2674                 /*
2675                  * The HW will be configured with local loopback such that host
2676                  * data is sent back to the host without modification.
2677                  */
2678         #define HWRM_PORT_PHY_CFG_INPUT_LPBK_LOCAL      (UINT32_C(0x1) << 0)
2679                 /*
2680                  * The HW will be configured with remote loopback such that port
2681                  * logic will send packets back out the transmitter that are
2682                  * received.
2683                  */
2684         #define HWRM_PORT_PHY_CFG_INPUT_LPBK_REMOTE     (UINT32_C(0x2) << 0)
2685         uint8_t lpbk;
2686
2687         /*
2688          * This value is used to configure the pause that will be used for force
2689          * mode.
2690          */
2691         /*
2692          * When this bit is '1', Generation of tx pause messages is supported.
2693          * Disabled otherwise.
2694          */
2695         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_PAUSE_TX             UINT32_C(0x1)
2696         /*
2697          * When this bit is '1', Reception of rx pause messages is supported.
2698          * Disabled otherwise.
2699          */
2700         #define HWRM_PORT_PHY_CFG_INPUT_FORCE_PAUSE_RX             UINT32_C(0x2)
2701         uint8_t force_pause;
2702
2703         uint8_t unused_1;
2704
2705         /*
2706          * This value controls the pre-emphasis to be used for the link. Driver
2707          * should not set this value (use enable.preemphasis = 0) unless driver
2708          * is sure of setting. Normally HWRM FW will determine proper pre-
2709          * emphasis.
2710          */
2711         uint32_t preemphasis;
2712
2713         /*
2714          * Setting for link speed mask that is used to advertise speeds during
2715          * autonegotiation when EEE is enabled. This field is valid only when
2716          * EEE is enabled. The speeds specified in this field shall be a subset
2717          * of speeds specified in auto_link_speed_mask. If EEE is enabled,then
2718          * at least one speed shall be provided in this mask.
2719          */
2720         /* Reserved */
2721         #define HWRM_PORT_PHY_CFG_INPUT_EEE_LINK_SPEED_MASK_RSVD1  UINT32_C(0x1)
2722         /* 100Mb link speed (Full-duplex) */
2723         #define HWRM_PORT_PHY_CFG_INPUT_EEE_LINK_SPEED_MASK_100MB  UINT32_C(0x2)
2724         /* Reserved */
2725         #define HWRM_PORT_PHY_CFG_INPUT_EEE_LINK_SPEED_MASK_RSVD2  UINT32_C(0x4)
2726         /* 1Gb link speed (Full-duplex) */
2727         #define HWRM_PORT_PHY_CFG_INPUT_EEE_LINK_SPEED_MASK_1GB    UINT32_C(0x8)
2728         /* Reserved */
2729         #define HWRM_PORT_PHY_CFG_INPUT_EEE_LINK_SPEED_MASK_RSVD3 \
2730                                                                 UINT32_C(0x10)
2731         /* Reserved */
2732         #define HWRM_PORT_PHY_CFG_INPUT_EEE_LINK_SPEED_MASK_RSVD4 \
2733                                                                 UINT32_C(0x20)
2734         /* 10Gb link speed */
2735         #define HWRM_PORT_PHY_CFG_INPUT_EEE_LINK_SPEED_MASK_10GB \
2736                                                                 UINT32_C(0x40)
2737         uint16_t eee_link_speed_mask;
2738
2739         uint8_t unused_2;
2740         uint8_t unused_3;
2741
2742         /*
2743          * Reuested setting of TX LPI timer in microseconds. This field is valid
2744          * only when EEE is enabled and TX LPI is enabled.
2745          */
2746         #define HWRM_PORT_PHY_CFG_INPUT_TX_LPI_TIMER_MASK \
2747                                                         UINT32_C(0xffffff)
2748         #define HWRM_PORT_PHY_CFG_INPUT_TX_LPI_TIMER_SFT           0
2749         uint32_t tx_lpi_timer;
2750
2751         uint32_t unused_4;
2752 } __attribute__((packed));
2753
2754 /* Output (16 bytes) */
2755 struct hwrm_port_phy_cfg_output {
2756         /*
2757          * Pass/Fail or error type Note: receiver to verify the in parameters,
2758          * and fail the call with an error when appropriate
2759          */
2760         uint16_t error_code;
2761
2762         /* This field returns the type of original request. */
2763         uint16_t req_type;
2764
2765         /* This field provides original sequence number of the command. */
2766         uint16_t seq_id;
2767
2768         /*
2769          * This field is the length of the response in bytes. The last byte of
2770          * the response is a valid flag that will read as '1' when the command
2771          * has been completely written to memory.
2772          */
2773         uint16_t resp_len;
2774
2775         uint32_t unused_0;
2776         uint8_t unused_1;
2777         uint8_t unused_2;
2778         uint8_t unused_3;
2779
2780         /*
2781          * This field is used in Output records to indicate that the output is
2782          * completely written to RAM. This field should be read as '1' to
2783          * indicate that the output has been completely written. When writing a
2784          * command completion or response to an internal processor, the order of
2785          * writes has to be such that this field is written last.
2786          */
2787         uint8_t valid;
2788 } __attribute__((packed));
2789
2790 /* hwrm_ver_get */
2791 /*
2792  * Description: This function is called by a driver to determine the HWRM
2793  * interface version supported by the HWRM firmware, the version of HWRM
2794  * firmware implementation, the name of HWRM firmware, the versions of other
2795  * embedded firmwares, and the names of other embedded firmwares, etc. Any
2796  * interface or firmware version with major = 0, minor = 0, and update = 0 shall
2797  * be considered an invalid version.
2798  */
2799
2800 /* Input (24 bytes) */
2801 struct hwrm_ver_get_input {
2802         /*
2803          * This value indicates what type of request this is. The format for the
2804          * rest of the command is determined by this field.
2805          */
2806         uint16_t req_type;
2807
2808         /*
2809          * This value indicates the what completion ring the request will be
2810          * optionally completed on. If the value is -1, then no CR completion
2811          * will be generated. Any other value must be a valid CR ring_id value
2812          * for this function.
2813          */
2814         uint16_t cmpl_ring;
2815
2816         /* This value indicates the command sequence number. */
2817         uint16_t seq_id;
2818
2819         /*
2820          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
2821          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
2822          */
2823         uint16_t target_id;
2824
2825         /*
2826          * This is the host address where the response will be written when the
2827          * request is complete. This area must be 16B aligned and must be
2828          * cleared to zero before the request is made.
2829          */
2830         uint64_t resp_addr;
2831
2832         /*
2833          * This field represents the major version of HWRM interface
2834          * specification supported by the driver HWRM implementation. The
2835          * interface major version is intended to change only when non backward
2836          * compatible changes are made to the HWRM interface specification.
2837          */
2838         uint8_t hwrm_intf_maj;
2839
2840         /*
2841          * This field represents the minor version of HWRM interface
2842          * specification supported by the driver HWRM implementation. A change
2843          * in interface minor version is used to reflect significant backward
2844          * compatible modification to HWRM interface specification. This can be
2845          * due to addition or removal of functionality. HWRM interface
2846          * specifications with the same major version but different minor
2847          * versions are compatible.
2848          */
2849         uint8_t hwrm_intf_min;
2850
2851         /*
2852          * This field represents the update version of HWRM interface
2853          * specification supported by the driver HWRM implementation. The
2854          * interface update version is used to reflect minor changes or bug
2855          * fixes to a released HWRM interface specification.
2856          */
2857         uint8_t hwrm_intf_upd;
2858
2859         uint8_t unused_0[5];
2860 } __attribute__((packed));
2861
2862 /* Output (128 bytes) */
2863 struct hwrm_ver_get_output {
2864         /*
2865          * Pass/Fail or error type Note: receiver to verify the in parameters,
2866          * and fail the call with an error when appropriate
2867          */
2868         uint16_t error_code;
2869
2870         /* This field returns the type of original request. */
2871         uint16_t req_type;
2872
2873         /* This field provides original sequence number of the command. */
2874         uint16_t seq_id;
2875
2876         /*
2877          * This field is the length of the response in bytes. The last byte of
2878          * the response is a valid flag that will read as '1' when the command
2879          * has been completely written to memory.
2880          */
2881         uint16_t resp_len;
2882
2883         /*
2884          * This field represents the major version of HWRM interface
2885          * specification supported by the HWRM implementation. The interface
2886          * major version is intended to change only when non backward compatible
2887          * changes are made to the HWRM interface specification. A HWRM
2888          * implementation that is compliant with this specification shall
2889          * provide value of 1 in this field.
2890          */
2891         uint8_t hwrm_intf_maj;
2892
2893         /*
2894          * This field represents the minor version of HWRM interface
2895          * specification supported by the HWRM implementation. A change in
2896          * interface minor version is used to reflect significant backward
2897          * compatible modification to HWRM interface specification. This can be
2898          * due to addition or removal of functionality. HWRM interface
2899          * specifications with the same major version but different minor
2900          * versions are compatible. A HWRM implementation that is compliant with
2901          * this specification shall provide value of 0 in this field.
2902          */
2903         uint8_t hwrm_intf_min;
2904
2905         /*
2906          * This field represents the update version of HWRM interface
2907          * specification supported by the HWRM implementation. The interface
2908          * update version is used to reflect minor changes or bug fixes to a
2909          * released HWRM interface specification. A HWRM implementation that is
2910          * compliant with this specification shall provide value of 1 in this
2911          * field.
2912          */
2913         uint8_t hwrm_intf_upd;
2914
2915         uint8_t hwrm_intf_rsvd;
2916
2917         /*
2918          * This field represents the major version of HWRM firmware. A change in
2919          * firmware major version represents a major firmware release.
2920          */
2921         uint8_t hwrm_fw_maj;
2922
2923         /*
2924          * This field represents the minor version of HWRM firmware. A change in
2925          * firmware minor version represents significant firmware functionality
2926          * changes.
2927          */
2928         uint8_t hwrm_fw_min;
2929
2930         /*
2931          * This field represents the build version of HWRM firmware. A change in
2932          * firmware build version represents bug fixes to a released firmware.
2933          */
2934         uint8_t hwrm_fw_bld;
2935
2936         /*
2937          * This field is a reserved field. This field can be used to represent
2938          * firmware branches or customer specific releases tied to a specific
2939          * (major,minor,update) version of the HWRM firmware.
2940          */
2941         uint8_t hwrm_fw_rsvd;
2942
2943         /*
2944          * This field represents the major version of mgmt firmware. A change in
2945          * major version represents a major release.
2946          */
2947         uint8_t mgmt_fw_maj;
2948
2949         /*
2950          * This field represents the minor version of mgmt firmware. A change in
2951          * minor version represents significant functionality changes.
2952          */
2953         uint8_t mgmt_fw_min;
2954
2955         /*
2956          * This field represents the build version of mgmt firmware. A change in
2957          * update version represents bug fixes.
2958          */
2959         uint8_t mgmt_fw_bld;
2960
2961         /*
2962          * This field is a reserved field. This field can be used to represent
2963          * firmware branches or customer specific releases tied to a specific
2964          * (major,minor,update) version
2965          */
2966         uint8_t mgmt_fw_rsvd;
2967
2968         /*
2969          * This field represents the major version of network control firmware.
2970          * A change in major version represents a major release.
2971          */
2972         uint8_t netctrl_fw_maj;
2973
2974         /*
2975          * This field represents the minor version of network control firmware.
2976          * A change in minor version represents significant functionality
2977          * changes.
2978          */
2979         uint8_t netctrl_fw_min;
2980
2981         /*
2982          * This field represents the build version of network control firmware.
2983          * A change in update version represents bug fixes.
2984          */
2985         uint8_t netctrl_fw_bld;
2986
2987         /*
2988          * This field is a reserved field. This field can be used to represent
2989          * firmware branches or customer specific releases tied to a specific
2990          * (major,minor,update) version
2991          */
2992         uint8_t netctrl_fw_rsvd;
2993
2994         /*
2995          * This field is reserved for future use. The responder should set it to
2996          * 0. The requester should ignore this field.
2997          */
2998         uint32_t reserved1;
2999
3000         /*
3001          * This field represents the major version of RoCE firmware. A change in
3002          * major version represents a major release.
3003          */
3004         uint8_t roce_fw_maj;
3005
3006         /*
3007          * This field represents the minor version of RoCE firmware. A change in
3008          * minor version represents significant functionality changes.
3009          */
3010         uint8_t roce_fw_min;
3011
3012         /*
3013          * This field represents the build version of RoCE firmware. A change in
3014          * update version represents bug fixes.
3015          */
3016         uint8_t roce_fw_bld;
3017
3018         /*
3019          * This field is a reserved field. This field can be used to represent
3020          * firmware branches or customer specific releases tied to a specific
3021          * (major,minor,update) version
3022          */
3023         uint8_t roce_fw_rsvd;
3024
3025         /*
3026          * This field represents the name of HWRM FW (ASCII chars without NULL
3027          * at the end).
3028          */
3029         char hwrm_fw_name[16];
3030
3031         /*
3032          * This field represents the name of mgmt FW (ASCII chars without NULL
3033          * at the end).
3034          */
3035         char mgmt_fw_name[16];
3036
3037         /*
3038          * This field represents the name of network control firmware (ASCII
3039          * chars without NULL at the end).
3040          */
3041         char netctrl_fw_name[16];
3042
3043         /*
3044          * This field is reserved for future use. The responder should set it to
3045          * 0. The requester should ignore this field.
3046          */
3047         uint32_t reserved2[4];
3048
3049         /*
3050          * This field represents the name of RoCE FW (ASCII chars without NULL
3051          * at the end).
3052          */
3053         char roce_fw_name[16];
3054
3055         /* This field returns the chip number. */
3056         uint16_t chip_num;
3057
3058         /* This field returns the revision of chip. */
3059         uint8_t chip_rev;
3060
3061         /* This field returns the chip metal number. */
3062         uint8_t chip_metal;
3063
3064         /* This field returns the bond id of the chip. */
3065         uint8_t chip_bond_id;
3066
3067         /*
3068          * This value indicates the type of platform used for chip
3069          * implementation.
3070          */
3071         /* ASIC */
3072         #define HWRM_VER_GET_OUTPUT_CHIP_PLATFORM_TYPE_ASIC \
3073                                                         (UINT32_C(0x0) << 0)
3074         /* FPGA platform of the chip. */
3075         #define HWRM_VER_GET_OUTPUT_CHIP_PLATFORM_TYPE_FPGA \
3076                                                         (UINT32_C(0x1) << 0)
3077         /* Palladium platform of the chip. */
3078         #define HWRM_VER_GET_OUTPUT_CHIP_PLATFORM_TYPE_PALLADIUM \
3079                                                         (UINT32_C(0x2) << 0)
3080         uint8_t chip_platform_type;
3081
3082         /*
3083          * This field returns the maximum value of request window that is
3084          * supported by the HWRM. The request window is mapped into device
3085          * address space using MMIO.
3086          */
3087         uint16_t max_req_win_len;
3088
3089         /*
3090          * This field returns the maximum value of response buffer in bytes. If
3091          * a request specifies the response buffer length that is greater than
3092          * this value, then the HWRM should fail it. The value of this field
3093          * shall be 4KB or more.
3094          */
3095         uint16_t max_resp_len;
3096
3097         /*
3098          * This field returns the default request timeout value in milliseconds.
3099          */
3100         uint16_t def_req_timeout;
3101
3102         uint8_t unused_0;
3103         uint8_t unused_1;
3104         uint8_t unused_2;
3105
3106         /*
3107          * This field is used in Output records to indicate that the output is
3108          * completely written to RAM. This field should be read as '1' to
3109          * indicate that the output has been completely written. When writing a
3110          * command completion or response to an internal processor, the order of
3111          * writes has to be such that this field is written last.
3112          */
3113         uint8_t valid;
3114 } __attribute__((packed));
3115
3116 /* hwrm_queue_qportcfg */
3117 /*
3118  * Description: This function is called by a driver to query queue configuration
3119  * of a port. # The HWRM shall at least advertise one queue with lossy service
3120  * profile. # The driver shall use this command to query queue ids before
3121  * configuring or using any queues. # If a service profile is not set for a
3122  * queue, then the driver shall not use that queue without configuring a service
3123  * profile for it. # If the driver is not allowed to configure service profiles,
3124  * then the driver shall only use queues for which service profiles are pre-
3125  * configured.
3126  */
3127
3128 /* Input (24 bytes) */
3129 struct hwrm_queue_qportcfg_input {
3130         /*
3131          * This value indicates what type of request this is. The format for the
3132          * rest of the command is determined by this field.
3133          */
3134         uint16_t req_type;
3135
3136         /*
3137          * This value indicates the what completion ring the request will be
3138          * optionally completed on. If the value is -1, then no CR completion
3139          * will be generated. Any other value must be a valid CR ring_id value
3140          * for this function.
3141          */
3142         uint16_t cmpl_ring;
3143
3144         /* This value indicates the command sequence number. */
3145         uint16_t seq_id;
3146
3147         /*
3148          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
3149          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
3150          */
3151         uint16_t target_id;
3152
3153         /*
3154          * This is the host address where the response will be written when the
3155          * request is complete. This area must be 16B aligned and must be
3156          * cleared to zero before the request is made.
3157          */
3158         uint64_t resp_addr;
3159
3160         /*
3161          * Enumeration denoting the RX, TX type of the resource. This
3162          * enumeration is used for resources that are similar for both TX and RX
3163          * paths of the chip.
3164          */
3165         #define HWRM_QUEUE_QPORTCFG_INPUT_FLAGS_PATH \
3166                                                         UINT32_C(0x1)
3167                 /* tx path */
3168         #define HWRM_QUEUE_QPORTCFG_INPUT_FLAGS_PATH_TX \
3169                                                         (UINT32_C(0x0) << 0)
3170                 /* rx path */
3171         #define HWRM_QUEUE_QPORTCFG_INPUT_FLAGS_PATH_RX \
3172                                                         (UINT32_C(0x1) << 0)
3173         #define HWRM_QUEUE_QPORTCFG_INPUT_FLAGS_PATH_LAST \
3174                                         HWRM_QUEUE_QPORTCFG_INPUT_FLAGS_PATH_RX
3175         uint32_t flags;
3176
3177         /*
3178          * Port ID of port for which the queue configuration is being queried.
3179          * This field is only required when sent by IPC.
3180          */
3181         uint16_t port_id;
3182
3183         uint16_t unused_0;
3184 } __attribute__((packed));
3185
3186 /* hwrm_stat_ctx_clr_stats */
3187 /* Description: This command clears statistics of a context. */
3188
3189 /* Input (24 bytes) */
3190 struct hwrm_stat_ctx_clr_stats_input {
3191         /*
3192          * This value indicates what type of request this is. The format for the
3193          * rest of the command is determined by this field.
3194          */
3195         uint16_t req_type;
3196
3197         /*
3198          * This value indicates the what completion ring the request will be
3199          * optionally completed on. If the value is -1, then no CR completion
3200          * will be generated. Any other value must be a valid CR ring_id value
3201          * for this function.
3202          */
3203         uint16_t cmpl_ring;
3204
3205         /* This value indicates the command sequence number. */
3206         uint16_t seq_id;
3207
3208         /*
3209          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
3210          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
3211          */
3212         uint16_t target_id;
3213
3214         /*
3215          * This is the host address where the response will be written when the
3216          * request is complete. This area must be 16B aligned and must be
3217          * cleared to zero before the request is made.
3218          */
3219         uint64_t resp_addr;
3220
3221         /* ID of the statistics context that is being queried. */
3222         uint32_t stat_ctx_id;
3223
3224         uint32_t unused_0;
3225 } __attribute__((packed));
3226
3227 /* Output (16 bytes) */
3228 struct hwrm_stat_ctx_clr_stats_output {
3229         /*
3230          * Pass/Fail or error type Note: receiver to verify the in parameters,
3231          * and fail the call with an error when appropriate
3232          */
3233         uint16_t error_code;
3234
3235         /* This field returns the type of original request. */
3236         uint16_t req_type;
3237
3238         /* This field provides original sequence number of the command. */
3239         uint16_t seq_id;
3240
3241         /*
3242          * This field is the length of the response in bytes. The last byte of
3243          * the response is a valid flag that will read as '1' when the command
3244          * has been completely written to memory.
3245          */
3246         uint16_t resp_len;
3247
3248         uint32_t unused_0;
3249         uint8_t unused_1;
3250         uint8_t unused_2;
3251         uint8_t unused_3;
3252
3253         /*
3254          * This field is used in Output records to indicate that the output is
3255          * completely written to RAM. This field should be read as '1' to
3256          * indicate that the output has been completely written. When writing a
3257          * command completion or response to an internal processor, the order of
3258          * writes has to be such that this field is written last.
3259          */
3260         uint8_t valid;
3261 } __attribute__((packed));
3262
3263 /* hwrm_vnic_alloc */
3264 /*
3265  * Description: This VNIC is a resource in the RX side of the chip that is used
3266  * to represent a virtual host "interface". # At the time of VNIC allocation or
3267  * configuration, the function can specify whether it wants the requested VNIC
3268  * to be the default VNIC for the function or not. # If a function requests
3269  * allocation of a VNIC for the first time and a VNIC is successfully allocated
3270  * by the HWRM, then the HWRM shall make the allocated VNIC as the default VNIC
3271  * for that function. # The default VNIC shall be used for the default action
3272  * for a partition or function. # For each VNIC allocated on a function, a
3273  * mapping on the RX side to map the allocated VNIC to source virtual interface
3274  * shall be performed by the HWRM. This should be hidden to the function driver
3275  * requesting the VNIC allocation. This enables broadcast/multicast replication
3276  * with source knockout. # If multicast replication with source knockout is
3277  * enabled, then the internal VNIC to SVIF mapping data structures shall be
3278  * programmed at the time of VNIC allocation.
3279  */
3280
3281 /* Input (24 bytes) */
3282 struct hwrm_vnic_alloc_input {
3283         /*
3284          * This value indicates what type of request this is. The format for the
3285          * rest of the command is determined by this field.
3286          */
3287         uint16_t req_type;
3288
3289         /*
3290          * This value indicates the what completion ring the request will be
3291          * optionally completed on. If the value is -1, then no CR completion
3292          * will be generated. Any other value must be a valid CR ring_id value
3293          * for this function.
3294          */
3295         uint16_t cmpl_ring;
3296
3297         /* This value indicates the command sequence number. */
3298         uint16_t seq_id;
3299
3300         /*
3301          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
3302          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
3303          */
3304         uint16_t target_id;
3305
3306         /*
3307          * This is the host address where the response will be written when the
3308          * request is complete. This area must be 16B aligned and must be
3309          * cleared to zero before the request is made.
3310          */
3311         uint64_t resp_addr;
3312
3313         /*
3314          * When this bit is '1', this VNIC is requested to be the default VNIC
3315          * for this function.
3316          */
3317         #define HWRM_VNIC_ALLOC_INPUT_FLAGS_DEFAULT                UINT32_C(0x1)
3318         uint32_t flags;
3319
3320         uint32_t unused_0;
3321 } __attribute__((packed));
3322
3323 /* Output (16 bytes) */
3324 struct hwrm_vnic_alloc_output {
3325         /*
3326          * Pass/Fail or error type Note: receiver to verify the in parameters,
3327          * and fail the call with an error when appropriate
3328          */
3329         uint16_t error_code;
3330
3331         /* This field returns the type of original request. */
3332         uint16_t req_type;
3333
3334         /* This field provides original sequence number of the command. */
3335         uint16_t seq_id;
3336
3337         /*
3338          * This field is the length of the response in bytes. The last byte of
3339          * the response is a valid flag that will read as '1' when the command
3340          * has been completely written to memory.
3341          */
3342         uint16_t resp_len;
3343
3344         /* Logical vnic ID */
3345         uint32_t vnic_id;
3346
3347         uint8_t unused_0;
3348         uint8_t unused_1;
3349         uint8_t unused_2;
3350
3351         /*
3352          * This field is used in Output records to indicate that the output is
3353          * completely written to RAM. This field should be read as '1' to
3354          * indicate that the output has been completely written. When writing a
3355          * command completion or response to an internal processor, the order of
3356          * writes has to be such that this field is written last.
3357          */
3358         uint8_t valid;
3359 } __attribute__((packed));
3360
3361 /* hwrm_vnic_cfg */
3362 /* Description: Configure the RX VNIC structure. */
3363
3364 /* Input (40 bytes) */
3365 struct hwrm_vnic_cfg_input {
3366         /*
3367          * This value indicates what type of request this is. The format for the
3368          * rest of the command is determined by this field.
3369          */
3370         uint16_t req_type;
3371
3372         /*
3373          * This value indicates the what completion ring the request will be
3374          * optionally completed on. If the value is -1, then no CR completion
3375          * will be generated. Any other value must be a valid CR ring_id value
3376          * for this function.
3377          */
3378         uint16_t cmpl_ring;
3379
3380         /* This value indicates the command sequence number. */
3381         uint16_t seq_id;
3382
3383         /*
3384          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
3385          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
3386          */
3387         uint16_t target_id;
3388
3389         /*
3390          * This is the host address where the response will be written when the
3391          * request is complete. This area must be 16B aligned and must be
3392          * cleared to zero before the request is made.
3393          */
3394         uint64_t resp_addr;
3395
3396         /*
3397          * When this bit is '1', the VNIC is requested to be the default VNIC
3398          * for the function.
3399          */
3400         #define HWRM_VNIC_CFG_INPUT_FLAGS_DEFAULT               UINT32_C(0x1)
3401         /*
3402          * When this bit is '1', the VNIC is being configured to strip VLAN in
3403          * the RX path. If set to '0', then VLAN stripping is disabled on this
3404          * VNIC.
3405          */
3406         #define HWRM_VNIC_CFG_INPUT_FLAGS_VLAN_STRIP_MODE       UINT32_C(0x2)
3407         /*
3408          * When this bit is '1', the VNIC is being configured to buffer receive
3409          * packets in the hardware until the host posts new receive buffers. If
3410          * set to '0', then bd_stall is being configured to be disabled on this
3411          * VNIC.
3412          */
3413         #define HWRM_VNIC_CFG_INPUT_FLAGS_BD_STALL_MODE         UINT32_C(0x4)
3414         /*
3415          * When this bit is '1', the VNIC is being configured to receive both
3416          * RoCE and non-RoCE traffic. If set to '0', then this VNIC is not
3417          * configured to be operating in dual VNIC mode.
3418          */
3419         #define HWRM_VNIC_CFG_INPUT_FLAGS_ROCE_DUAL_VNIC_MODE   UINT32_C(0x8)
3420         /*
3421          * When this flag is set to '1', the VNIC is requested to be configured
3422          * to receive only RoCE traffic. If this flag is set to '0', then this
3423          * flag shall be ignored by the HWRM. If roce_dual_vnic_mode flag is set
3424          * to '1', then the HWRM client shall not set this flag to '1'.
3425          */
3426         #define HWRM_VNIC_CFG_INPUT_FLAGS_ROCE_ONLY_VNIC_MODE   UINT32_C(0x10)
3427         uint32_t flags;
3428
3429         /* This bit must be '1' for the dflt_ring_grp field to be configured. */
3430         #define HWRM_VNIC_CFG_INPUT_ENABLES_DFLT_RING_GRP       UINT32_C(0x1)
3431         /* This bit must be '1' for the rss_rule field to be configured. */
3432         #define HWRM_VNIC_CFG_INPUT_ENABLES_RSS_RULE            UINT32_C(0x2)
3433         /* This bit must be '1' for the cos_rule field to be configured. */
3434         #define HWRM_VNIC_CFG_INPUT_ENABLES_COS_RULE            UINT32_C(0x4)
3435         /* This bit must be '1' for the lb_rule field to be configured. */
3436         #define HWRM_VNIC_CFG_INPUT_ENABLES_LB_RULE             UINT32_C(0x8)
3437         /* This bit must be '1' for the mru field to be configured. */
3438         #define HWRM_VNIC_CFG_INPUT_ENABLES_MRU                 UINT32_C(0x10)
3439         uint32_t enables;
3440
3441         /* Logical vnic ID */
3442         uint16_t vnic_id;
3443
3444         /*
3445          * Default Completion ring for the VNIC. This ring will be chosen if
3446          * packet does not match any RSS rules and if there is no COS rule.
3447          */
3448         uint16_t dflt_ring_grp;
3449
3450         /*
3451          * RSS ID for RSS rule/table structure. 0xFF... (All Fs) if there is no
3452          * RSS rule.
3453          */
3454         uint16_t rss_rule;
3455
3456         /*
3457          * RSS ID for COS rule/table structure. 0xFF... (All Fs) if there is no
3458          * COS rule.
3459          */
3460         uint16_t cos_rule;
3461
3462         /*
3463          * RSS ID for load balancing rule/table structure. 0xFF... (All Fs) if
3464          * there is no LB rule.
3465          */
3466         uint16_t lb_rule;
3467
3468         /*
3469          * The maximum receive unit of the vnic. Each vnic is associated with a
3470          * function. The vnic mru value overwrites the mru setting of the
3471          * associated function. The HWRM shall make sure that vnic mru does not
3472          * exceed the mru of the port the function is associated with.
3473          */
3474         uint16_t mru;
3475
3476         uint32_t unused_0;
3477 } __attribute__((packed));
3478
3479 /* Output (16 bytes) */
3480 struct hwrm_vnic_cfg_output {
3481         /*
3482          * Pass/Fail or error type Note: receiver to verify the in parameters,
3483          * and fail the call with an error when appropriate
3484          */
3485         uint16_t error_code;
3486
3487         /* This field returns the type of original request. */
3488         uint16_t req_type;
3489
3490         /* This field provides original sequence number of the command. */
3491         uint16_t seq_id;
3492
3493         /*
3494          * This field is the length of the response in bytes. The last byte of
3495          * the response is a valid flag that will read as '1' when the command
3496          * has been completely written to memory.
3497          */
3498         uint16_t resp_len;
3499
3500         uint32_t unused_0;
3501         uint8_t unused_1;
3502         uint8_t unused_2;
3503         uint8_t unused_3;
3504
3505         /*
3506          * This field is used in Output records to indicate that the output is
3507          * completely written to RAM. This field should be read as '1' to
3508          * indicate that the output has been completely written. When writing a
3509          * command completion or response to an internal processor, the order of
3510          * writes has to be such that this field is written last.
3511          */
3512         uint8_t valid;
3513 } __attribute__((packed));
3514
3515 /* hwrm_vnic_free */
3516 /*
3517  * Description: Free a VNIC resource. Idle any resources associated with the
3518  * VNIC as well as the VNIC. Reset and release all resources associated with the
3519  * VNIC.
3520  */
3521
3522 /* Input (24 bytes) */
3523 struct hwrm_vnic_free_input {
3524         /*
3525          * This value indicates what type of request this is. The format for the
3526          * rest of the command is determined by this field.
3527          */
3528         uint16_t req_type;
3529
3530         /*
3531          * This value indicates the what completion ring the request will be
3532          * optionally completed on. If the value is -1, then no CR completion
3533          * will be generated. Any other value must be a valid CR ring_id value
3534          * for this function.
3535          */
3536         uint16_t cmpl_ring;
3537
3538         /* This value indicates the command sequence number. */
3539         uint16_t seq_id;
3540
3541         /*
3542          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
3543          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
3544          */
3545         uint16_t target_id;
3546
3547         /*
3548          * This is the host address where the response will be written when the
3549          * request is complete. This area must be 16B aligned and must be
3550          * cleared to zero before the request is made.
3551          */
3552         uint64_t resp_addr;
3553
3554         /* Logical vnic ID */
3555         uint32_t vnic_id;
3556
3557         uint32_t unused_0;
3558 } __attribute__((packed));
3559
3560 /* Output (16 bytes) */
3561 struct hwrm_vnic_free_output {
3562         /*
3563          * Pass/Fail or error type Note: receiver to verify the in parameters,
3564          * and fail the call with an error when appropriate
3565          */
3566         uint16_t error_code;
3567
3568         /* This field returns the type of original request. */
3569         uint16_t req_type;
3570
3571         /* This field provides original sequence number of the command. */
3572         uint16_t seq_id;
3573
3574         /*
3575          * This field is the length of the response in bytes. The last byte of
3576          * the response is a valid flag that will read as '1' when the command
3577          * has been completely written to memory.
3578          */
3579         uint16_t resp_len;
3580
3581         uint32_t unused_0;
3582         uint8_t unused_1;
3583         uint8_t unused_2;
3584         uint8_t unused_3;
3585
3586         /*
3587          * This field is used in Output records to indicate that the output is
3588          * completely written to RAM. This field should be read as '1' to
3589          * indicate that the output has been completely written. When writing a
3590          * command completion or response to an internal processor, the order of
3591          * writes has to be such that this field is written last.
3592          */
3593         uint8_t valid;
3594 } __attribute__((packed));
3595
3596 /* hwrm_vnic_rss_cfg */
3597 /* Description: This function is used to enable RSS configuration. */
3598
3599 /* Input (48 bytes) */
3600 struct hwrm_vnic_rss_cfg_input {
3601         /*
3602          * This value indicates what type of request this is. The format for the
3603          * rest of the command is determined by this field.
3604          */
3605         uint16_t req_type;
3606
3607         /*
3608          * This value indicates the what completion ring the request will be
3609          * optionally completed on. If the value is -1, then no CR completion
3610          * will be generated. Any other value must be a valid CR ring_id value
3611          * for this function.
3612          */
3613         uint16_t cmpl_ring;
3614
3615         /* This value indicates the command sequence number. */
3616         uint16_t seq_id;
3617
3618         /*
3619          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
3620          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
3621          */
3622         uint16_t target_id;
3623
3624         /*
3625          * This is the host address where the response will be written when the
3626          * request is complete. This area must be 16B aligned and must be
3627          * cleared to zero before the request is made.
3628          */
3629         uint64_t resp_addr;
3630
3631         /*
3632          * When this bit is '1', the RSS hash shall be computed over source and
3633          * destination IPv4 addresses of IPv4 packets.
3634          */
3635         #define HWRM_VNIC_RSS_CFG_INPUT_HASH_TYPE_IPV4          UINT32_C(0x1)
3636         /*
3637          * When this bit is '1', the RSS hash shall be computed over
3638          * source/destination IPv4 addresses and source/destination ports of
3639          * TCP/IPv4 packets.
3640          */
3641         #define HWRM_VNIC_RSS_CFG_INPUT_HASH_TYPE_TCP_IPV4      UINT32_C(0x2)
3642         /*
3643          * When this bit is '1', the RSS hash shall be computed over
3644          * source/destination IPv4 addresses and source/destination ports of
3645          * UDP/IPv4 packets.
3646          */
3647         #define HWRM_VNIC_RSS_CFG_INPUT_HASH_TYPE_UDP_IPV4      UINT32_C(0x4)
3648         /*
3649          * When this bit is '1', the RSS hash shall be computed over source and
3650          * destination IPv4 addresses of IPv6 packets.
3651          */
3652         #define HWRM_VNIC_RSS_CFG_INPUT_HASH_TYPE_IPV6          UINT32_C(0x8)
3653         /*
3654          * When this bit is '1', the RSS hash shall be computed over
3655          * source/destination IPv6 addresses and source/destination ports of
3656          * TCP/IPv6 packets.
3657          */
3658         #define HWRM_VNIC_RSS_CFG_INPUT_HASH_TYPE_TCP_IPV6      UINT32_C(0x10)
3659         /*
3660          * When this bit is '1', the RSS hash shall be computed over
3661          * source/destination IPv6 addresses and source/destination ports of
3662          * UDP/IPv6 packets.
3663          */
3664         #define HWRM_VNIC_RSS_CFG_INPUT_HASH_TYPE_UDP_IPV6      UINT32_C(0x20)
3665         uint32_t hash_type;
3666
3667         uint32_t unused_0;
3668
3669         /* This is the address for rss ring group table */
3670         uint64_t ring_grp_tbl_addr;
3671
3672         /* This is the address for rss hash key table */
3673         uint64_t hash_key_tbl_addr;
3674
3675         /* Index to the rss indirection table. */
3676         uint16_t rss_ctx_idx;
3677
3678         uint16_t unused_1[3];
3679 } __attribute__((packed));
3680
3681 /* Output (16 bytes) */
3682 struct hwrm_vnic_rss_cfg_output {
3683         /*
3684          * Pass/Fail or error type Note: receiver to verify the in parameters,
3685          * and fail the call with an error when appropriate
3686          */
3687         uint16_t error_code;
3688
3689         /* This field returns the type of original request. */
3690         uint16_t req_type;
3691
3692         /* This field provides original sequence number of the command. */
3693         uint16_t seq_id;
3694
3695         /*
3696          * This field is the length of the response in bytes. The last byte of
3697          * the response is a valid flag that will read as '1' when the command
3698          * has been completely written to memory.
3699          */
3700         uint16_t resp_len;
3701
3702         uint32_t unused_0;
3703         uint8_t unused_1;
3704         uint8_t unused_2;
3705         uint8_t unused_3;
3706
3707         /*
3708          * This field is used in Output records to indicate that the output is
3709          * completely written to RAM. This field should be read as '1' to
3710          * indicate that the output has been completely written. When writing a
3711          * command completion or response to an internal processor, the order of
3712          * writes has to be such that this field is written last.
3713          */
3714         uint8_t valid;
3715 } __attribute__((packed));
3716
3717 /* Input (16 bytes) */
3718 struct hwrm_vnic_rss_cos_lb_ctx_alloc_input {
3719         /*
3720          * This value indicates what type of request this is. The format for the
3721          * rest of the command is determined by this field.
3722          */
3723         uint16_t req_type;
3724
3725         /*
3726          * This value indicates the what completion ring the request will be
3727          * optionally completed on. If the value is -1, then no CR completion
3728          * will be generated. Any other value must be a valid CR ring_id value
3729          * for this function.
3730          */
3731         uint16_t cmpl_ring;
3732
3733         /* This value indicates the command sequence number. */
3734         uint16_t seq_id;
3735
3736         /*
3737          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
3738          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
3739          */
3740         uint16_t target_id;
3741
3742         /*
3743          * This is the host address where the response will be written when the
3744          * request is complete. This area must be 16B aligned and must be
3745          * cleared to zero before the request is made.
3746          */
3747         uint64_t resp_addr;
3748 } __attribute__((packed));
3749
3750 /* Output (16 bytes) */
3751
3752 struct hwrm_vnic_rss_cos_lb_ctx_alloc_output {
3753         /*
3754          * Pass/Fail or error type Note: receiver to verify the in parameters,
3755          * and fail the call with an error when appropriate
3756          */
3757         uint16_t error_code;
3758
3759         /* This field returns the type of original request. */
3760         uint16_t req_type;
3761
3762         /* This field provides original sequence number of the command. */
3763         uint16_t seq_id;
3764
3765         /*
3766          * This field is the length of the response in bytes. The last byte of
3767          * the response is a valid flag that will read as '1' when the command
3768          * has been completely written to memory.
3769          */
3770         uint16_t resp_len;
3771
3772         /* rss_cos_lb_ctx_id is 16 b */
3773         uint16_t rss_cos_lb_ctx_id;
3774
3775         uint8_t unused_0;
3776         uint8_t unused_1;
3777         uint8_t unused_2;
3778         uint8_t unused_3;
3779         uint8_t unused_4;
3780
3781         /*
3782          * This field is used in Output records to indicate that the output is
3783          * completely written to RAM. This field should be read as '1' to
3784          * indicate that the output has been completely written. When writing a
3785          * command completion or response to an internal processor, the order of
3786          * writes has to be such that this field is written last.
3787          */
3788         uint8_t valid;
3789 } __attribute__((packed));
3790
3791 /* hwrm_vnic_rss_cos_lb_ctx_free */
3792 /* Description: This function can be used to free COS/Load Balance context. */
3793 /* Input (24 bytes) */
3794
3795 struct hwrm_vnic_rss_cos_lb_ctx_free_input {
3796         /*
3797          * This value indicates what type of request this is. The format for the
3798          * rest of the command is determined by this field.
3799          */
3800         uint16_t req_type;
3801
3802         /*
3803          * This value indicates the what completion ring the request will be
3804          * optionally completed on. If the value is -1, then no CR completion
3805          * will be generated. Any other value must be a valid CR ring_id value
3806          * for this function.
3807          */
3808         uint16_t cmpl_ring;
3809
3810         /* This value indicates the command sequence number. */
3811         uint16_t seq_id;
3812
3813         /*
3814          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
3815          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
3816          */
3817         uint16_t target_id;
3818
3819         /*
3820          * This is the host address where the response will be written when the
3821          * request is complete. This area must be 16B aligned and must be
3822          * cleared to zero before the request is made.
3823          */
3824         uint64_t resp_addr;
3825
3826         /* rss_cos_lb_ctx_id is 16 b */
3827         uint16_t rss_cos_lb_ctx_id;
3828
3829         uint16_t unused_0[3];
3830 } __attribute__((packed));
3831
3832 /* Output (16 bytes) */
3833 struct hwrm_vnic_rss_cos_lb_ctx_free_output {
3834         /*
3835          * Pass/Fail or error type Note: receiver to verify the in parameters,
3836          * and fail the call with an error when appropriate
3837          */
3838         uint16_t error_code;
3839
3840         /* This field returns the type of original request. */
3841         uint16_t req_type;
3842
3843         /* This field provides original sequence number of the command. */
3844         uint16_t seq_id;
3845
3846         /*
3847          * This field is the length of the response in bytes. The last byte of
3848          * the response is a valid flag that will read as '1' when the command
3849          * has been completely written to memory.
3850          */
3851         uint16_t resp_len;
3852
3853         uint32_t unused_0;
3854         uint8_t unused_1;
3855         uint8_t unused_2;
3856         uint8_t unused_3;
3857
3858         /*
3859          * This field is used in Output records to indicate that the output is
3860          * completely written to RAM. This field should be read as '1' to
3861          * indicate that the output has been completely written. When writing a
3862          * command completion or response to an internal processor, the order of
3863          * writes has to be such that this field is written last.
3864          */
3865         uint8_t valid;
3866 } __attribute__((packed));
3867
3868 /* Output (32 bytes) */
3869 struct hwrm_queue_qportcfg_output {
3870         /*
3871          * Pass/Fail or error type Note: receiver to verify the in parameters,
3872          * and fail the call with an error when appropriate
3873          */
3874         uint16_t error_code;
3875
3876         /* This field returns the type of original request. */
3877         uint16_t req_type;
3878
3879         /* This field provides original sequence number of the command. */
3880         uint16_t seq_id;
3881
3882         /*
3883          * This field is the length of the response in bytes. The last byte of
3884          * the response is a valid flag that will read as '1' when the command
3885          * has been completely written to memory.
3886          */
3887         uint16_t resp_len;
3888
3889         /* The maximum number of queues that can be configured. */
3890         uint8_t max_configurable_queues;
3891
3892         /* The maximum number of lossless queues that can be configured. */
3893         uint8_t max_configurable_lossless_queues;
3894
3895         /*
3896          * 0 - Not allowed. Non-zero - Allowed. If this value is non-zero, then
3897          * the HWRM shall allow the host SW driver to configure queues using
3898          * hwrm_queue_cfg.
3899          */
3900         uint8_t queue_cfg_allowed;
3901
3902         /*
3903          * 0 - Not allowed. Non-zero - Allowed If this value is non-zero, then
3904          * the HWRM shall allow the host SW driver to configure queue buffers
3905          * using hwrm_queue_buffers_cfg.
3906          */
3907         uint8_t queue_buffers_cfg_allowed;
3908
3909         /*
3910          * 0 - Not allowed. Non-zero - Allowed If this value is non-zero, then
3911          * the HWRM shall allow the host SW driver to configure PFC using
3912          * hwrm_queue_pfcenable_cfg.
3913          */
3914         uint8_t queue_pfcenable_cfg_allowed;
3915
3916         /*
3917          * 0 - Not allowed. Non-zero - Allowed If this value is non-zero, then
3918          * the HWRM shall allow the host SW driver to configure Priority to CoS
3919          * mapping using hwrm_queue_pri2cos_cfg.
3920          */
3921         uint8_t queue_pri2cos_cfg_allowed;
3922
3923         /*
3924          * 0 - Not allowed. Non-zero - Allowed If this value is non-zero, then
3925          * the HWRM shall allow the host SW driver to configure CoS Bandwidth
3926          * configuration using hwrm_queue_cos2bw_cfg.
3927          */
3928         uint8_t queue_cos2bw_cfg_allowed;
3929
3930         /* ID of CoS Queue 0. FF - Invalid id */
3931         uint8_t queue_id0;
3932
3933         /* This value is applicable to CoS queues only. */
3934                 /* Lossy (best-effort) */
3935         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID0_SERVICE_PROFILE_LOSSY \
3936                                                         (UINT32_C(0x0) << 0)
3937                 /* Lossless */
3938         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID0_SERVICE_PROFILE_LOSSLESS \
3939                                                         (UINT32_C(0x1) << 0)
3940                 /*
3941                  * Set to 0xFF... (All Fs) if there is no service profile
3942                  * specified
3943                  */
3944         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID0_SERVICE_PROFILE_UNKNOWN \
3945                                                         (UINT32_C(0xff) << 0)
3946         uint8_t queue_id0_service_profile;
3947
3948         /* ID of CoS Queue 1. FF - Invalid id */
3949         uint8_t queue_id1;
3950         /* This value is applicable to CoS queues only. */
3951                 /* Lossy (best-effort) */
3952         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID1_SERVICE_PROFILE_LOSSY \
3953                                                         (UINT32_C(0x0) << 0)
3954                 /* Lossless */
3955         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID1_SERVICE_PROFILE_LOSSLESS \
3956                                                         (UINT32_C(0x1) << 0)
3957                 /*
3958                  * Set to 0xFF... (All Fs) if there is no service profile
3959                  * specified
3960                  */
3961         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID1_SERVICE_PROFILE_UNKNOWN \
3962                                                         (UINT32_C(0xff) << 0)
3963         uint8_t queue_id1_service_profile;
3964
3965         /* ID of CoS Queue 2. FF - Invalid id */
3966         uint8_t queue_id2;
3967         /* This value is applicable to CoS queues only. */
3968                 /* Lossy (best-effort) */
3969         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID2_SERVICE_PROFILE_LOSSY \
3970                                                         (UINT32_C(0x0) << 0)
3971                 /* Lossless */
3972         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID2_SERVICE_PROFILE_LOSSLESS \
3973                                                         (UINT32_C(0x1) << 0)
3974                 /*
3975                  * Set to 0xFF... (All Fs) if there is no service profile
3976                  * specified
3977                  */
3978         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID2_SERVICE_PROFILE_UNKNOWN \
3979                                                         (UINT32_C(0xff) << 0)
3980         uint8_t queue_id2_service_profile;
3981
3982         /* ID of CoS Queue 3. FF - Invalid id */
3983         uint8_t queue_id3;
3984
3985         /* This value is applicable to CoS queues only. */
3986                 /* Lossy (best-effort) */
3987         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID3_SERVICE_PROFILE_LOSSY \
3988                                                         (UINT32_C(0x0) << 0)
3989                 /* Lossless */
3990         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID3_SERVICE_PROFILE_LOSSLESS \
3991                                                         (UINT32_C(0x1) << 0)
3992                 /*
3993                  * Set to 0xFF... (All Fs) if there is no service profile
3994                  * specified
3995                  */
3996         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID3_SERVICE_PROFILE_UNKNOWN \
3997                                                         (UINT32_C(0xff) << 0)
3998         uint8_t queue_id3_service_profile;
3999
4000         /* ID of CoS Queue 4. FF - Invalid id */
4001         uint8_t queue_id4;
4002         /* This value is applicable to CoS queues only. */
4003                 /* Lossy (best-effort) */
4004         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID4_SERVICE_PROFILE_LOSSY \
4005                                                         (UINT32_C(0x0) << 0)
4006                 /* Lossless */
4007         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID4_SERVICE_PROFILE_LOSSLESS \
4008                                                         (UINT32_C(0x1) << 0)
4009                 /*
4010                  * Set to 0xFF... (All Fs) if there is no service profile
4011                  * specified
4012                  */
4013         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID4_SERVICE_PROFILE_UNKNOWN \
4014                                                         (UINT32_C(0xff) << 0)
4015         uint8_t queue_id4_service_profile;
4016
4017         /* ID of CoS Queue 5. FF - Invalid id */
4018         uint8_t queue_id5;
4019
4020         /* This value is applicable to CoS queues only. */
4021                 /* Lossy (best-effort) */
4022         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID5_SERVICE_PROFILE_LOSSY \
4023                                                         (UINT32_C(0x0) << 0)
4024                 /* Lossless */
4025         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID5_SERVICE_PROFILE_LOSSLESS \
4026                                                         (UINT32_C(0x1) << 0)
4027                 /*
4028                  * Set to 0xFF... (All Fs) if there is no service profile
4029                  * specified
4030                  */
4031         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID5_SERVICE_PROFILE_UNKNOWN \
4032                                                         (UINT32_C(0xff) << 0)
4033         uint8_t queue_id5_service_profile;
4034
4035         /* ID of CoS Queue 6. FF - Invalid id */
4036         uint8_t queue_id6_service_profile;
4037         /* This value is applicable to CoS queues only. */
4038                 /* Lossy (best-effort) */
4039         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID6_SERVICE_PROFILE_LOSSY \
4040                                                         (UINT32_C(0x0) << 0)
4041                 /* Lossless */
4042         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID6_SERVICE_PROFILE_LOSSLESS \
4043                                                         (UINT32_C(0x1) << 0)
4044                 /*
4045                  * Set to 0xFF... (All Fs) if there is no service profile
4046                  * specified
4047                  */
4048         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID6_SERVICE_PROFILE_UNKNOWN \
4049                                                         (UINT32_C(0xff) << 0)
4050         uint8_t queue_id6;
4051
4052         /* ID of CoS Queue 7. FF - Invalid id */
4053         uint8_t queue_id7;
4054
4055         /* This value is applicable to CoS queues only. */
4056                 /* Lossy (best-effort) */
4057         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID7_SERVICE_PROFILE_LOSSY \
4058                                                         (UINT32_C(0x0) << 0)
4059                 /* Lossless */
4060         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID7_SERVICE_PROFILE_LOSSLESS \
4061                                                         (UINT32_C(0x1) << 0)
4062                 /*
4063                  * Set to 0xFF... (All Fs) if there is no service profile
4064                  * specified
4065                  */
4066         #define HWRM_QUEUE_QPORTCFG_OUTPUT_QUEUE_ID7_SERVICE_PROFILE_UNKNOWN \
4067                                                         (UINT32_C(0xff) << 0)
4068         uint8_t queue_id7_service_profile;
4069
4070         /*
4071          * This field is used in Output records to indicate that the output is
4072          * completely written to RAM. This field should be read as '1' to
4073          * indicate that the output has been completely written. When writing a
4074          * command completion or response to an internal processor, the order of
4075          * writes has to be such that this field is written last.
4076          */
4077         uint8_t valid;
4078 } __attribute__((packed));
4079
4080 /* hwrm_func_drv_rgtr */
4081 /*
4082  * Description: This command is used by the function driver to register its
4083  * information with the HWRM. A function driver shall implement this command. A
4084  * function driver shall use this command during the driver initialization right
4085  * after the HWRM version discovery and default ring resources allocation.
4086  */
4087
4088 /* Input (80 bytes) */
4089 struct hwrm_func_drv_rgtr_input {
4090         /*
4091          * This value indicates what type of request this is. The format for the
4092          * rest of the command is determined by this field.
4093          */
4094         uint16_t req_type;
4095
4096         /*
4097          * This value indicates the what completion ring the request will be
4098          * optionally completed on. If the value is -1, then no CR completion
4099          * will be generated. Any other value must be a valid CR ring_id value
4100          * for this function.
4101          */
4102         uint16_t cmpl_ring;
4103
4104         /* This value indicates the command sequence number. */
4105         uint16_t seq_id;
4106
4107         /*
4108          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
4109          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
4110          */
4111         uint16_t target_id;
4112
4113         /*
4114          * This is the host address where the response will be written when the
4115          * request is complete. This area must be 16B aligned and must be
4116          * cleared to zero before the request is made.
4117          */
4118         uint64_t resp_addr;
4119
4120         /*
4121          * When this bit is '1', the function driver is requesting all requests
4122          * from its children VF drivers to be forwarded to itself. This flag can
4123          * only be set by the PF driver. If a VF driver sets this flag, it
4124          * should be ignored by the HWRM.
4125          */
4126         #define HWRM_FUNC_DRV_RGTR_INPUT_FLAGS_FWD_ALL_MODE        UINT32_C(0x1)
4127         /*
4128          * When this bit is '1', the function is requesting none of the requests
4129          * from its children VF drivers to be forwarded to itself. This flag can
4130          * only be set by the PF driver. If a VF driver sets this flag, it
4131          * should be ignored by the HWRM.
4132          */
4133         #define HWRM_FUNC_DRV_RGTR_INPUT_FLAGS_FWD_NONE_MODE       UINT32_C(0x2)
4134         uint32_t flags;
4135
4136         /* This bit must be '1' for the os_type field to be configured. */
4137         #define HWRM_FUNC_DRV_RGTR_INPUT_ENABLES_OS_TYPE           UINT32_C(0x1)
4138         /* This bit must be '1' for the ver field to be configured. */
4139         #define HWRM_FUNC_DRV_RGTR_INPUT_ENABLES_VER               UINT32_C(0x2)
4140         /* This bit must be '1' for the timestamp field to be configured. */
4141         #define HWRM_FUNC_DRV_RGTR_INPUT_ENABLES_TIMESTAMP         UINT32_C(0x4)
4142         /* This bit must be '1' for the vf_req_fwd field to be configured. */
4143         #define HWRM_FUNC_DRV_RGTR_INPUT_ENABLES_VF_REQ_FWD        UINT32_C(0x8)
4144         /*
4145          * This bit must be '1' for the async_event_fwd field to be configured.
4146          */
4147         #define HWRM_FUNC_DRV_RGTR_INPUT_ENABLES_ASYNC_EVENT_FWD \
4148                                                                 UINT32_C(0x10)
4149         uint32_t enables;
4150
4151         /* This value indicates the type of OS. */
4152                 /* Unknown */
4153         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_UNKNOWN \
4154                                                         (UINT32_C(0x0) << 0)
4155                 /* Other OS not listed below. */
4156         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_OTHER \
4157                                                         (UINT32_C(0x1) << 0)
4158                 /* MSDOS OS. */
4159         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_MSDOS \
4160                                                         (UINT32_C(0xe) << 0)
4161                 /* Windows OS. */
4162         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_WINDOWS \
4163                                                         (UINT32_C(0x12) << 0)
4164                 /* Solaris OS. */
4165         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_SOLARIS \
4166                                                         (UINT32_C(0x1d) << 0)
4167                 /* Linux OS. */
4168         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_LINUX \
4169                                                         (UINT32_C(0x24) << 0)
4170                 /* FreeBSD OS. */
4171         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_FREEBSD \
4172                                                         (UINT32_C(0x2a) << 0)
4173                 /* VMware ESXi OS. */
4174         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_ESXI \
4175                                                         (UINT32_C(0x68) << 0)
4176                 /* Microsoft Windows 8 64-bit OS. */
4177         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_WIN864 \
4178                                                         (UINT32_C(0x73) << 0)
4179                 /* Microsoft Windows Server 2012 R2 OS. */
4180         #define HWRM_FUNC_DRV_RGTR_INPUT_OS_TYPE_WIN2012R2 \
4181                                                         (UINT32_C(0x74) << 0)
4182         uint16_t os_type;
4183
4184         /* This is the major version of the driver. */
4185         uint8_t ver_maj;
4186
4187         /* This is the minor version of the driver. */
4188         uint8_t ver_min;
4189
4190         /* This is the update version of the driver. */
4191         uint8_t ver_upd;
4192
4193         uint8_t unused_0;
4194         uint16_t unused_1;
4195
4196         /*
4197          * This is a 32-bit timestamp provided by the driver for keep alive. The
4198          * timestamp is in multiples of 1ms.
4199          */
4200         uint32_t timestamp;
4201
4202         uint32_t unused_2;
4203
4204         /*
4205          * This is a 256-bit bit mask provided by the PF driver for letting the
4206          * HWRM know what commands issued by the VF driver to the HWRM should be
4207          * forwarded to the PF driver. Nth bit refers to the Nth req_type.
4208          * Setting Nth bit to 1 indicates that requests from the VF driver with
4209          * req_type equal to N shall be forwarded to the parent PF driver. This
4210          * field is not valid for the VF driver.
4211          */
4212         uint32_t vf_req_fwd[8];
4213
4214         /*
4215          * This is a 256-bit bit mask provided by the function driver (PF or VF
4216          * driver) to indicate the list of asynchronous event completions to be
4217          * forwarded. Nth bit refers to the Nth event_id. Setting Nth bit to 1
4218          * by the function driver shall result in the HWRM forwarding
4219          * asynchronous event completion with event_id equal to N. If all bits
4220          * are set to 0 (value of 0), then the HWRM shall not forward any
4221          * asynchronous event completion to this function driver.
4222          */
4223         uint32_t async_event_fwd[8];
4224 } __attribute__((packed));
4225
4226 /* Output (16 bytes) */
4227
4228 struct hwrm_func_drv_rgtr_output {
4229         /*
4230          * Pass/Fail or error type Note: receiver to verify the in parameters,
4231          * and fail the call with an error when appropriate
4232          */
4233         uint16_t error_code;
4234
4235         /* This field returns the type of original request. */
4236         uint16_t req_type;
4237
4238         /* This field provides original sequence number of the command. */
4239         uint16_t seq_id;
4240
4241         /*
4242          * This field is the length of the response in bytes. The last byte of
4243          * the response is a valid flag that will read as '1' when the command
4244          * has been completely written to memory.
4245          */
4246         uint16_t resp_len;
4247
4248         uint32_t unused_0;
4249         uint8_t unused_1;
4250         uint8_t unused_2;
4251         uint8_t unused_3;
4252
4253         /*
4254          * This field is used in Output records to indicate that the output is
4255          * completely written to RAM. This field should be read as '1' to
4256          * indicate that the output has been completely written. When writing a
4257          * command completion or response to an internal processor, the order of
4258          * writes has to be such that this field is written last.
4259          */
4260         uint8_t valid;
4261 } __attribute__((packed));
4262
4263 /* hwrm_func_drv_unrgtr */
4264 /*
4265  * Description: This command is used by the function driver to un register with
4266  * the HWRM. A function driver shall implement this command. A function driver
4267  * shall use this command during the driver unloading.
4268  */
4269 /* Input (24 bytes) */
4270
4271 struct hwrm_func_drv_unrgtr_input {
4272         /*
4273          * This value indicates what type of request this is. The format for the
4274          * rest of the command is determined by this field.
4275          */
4276         uint16_t req_type;
4277
4278         /*
4279          * This value indicates the what completion ring the request will be
4280          * optionally completed on. If the value is -1, then no CR completion
4281          * will be generated. Any other value must be a valid CR ring_id value
4282          * for this function.
4283          */
4284         uint16_t cmpl_ring;
4285
4286         /* This value indicates the command sequence number. */
4287         uint16_t seq_id;
4288
4289         /*
4290          * Target ID of this command. 0x0 - 0xFFF8 - Used for function ids
4291          * 0xFFF8 - 0xFFFE - Reserved for internal processors 0xFFFF - HWRM
4292          */
4293         uint16_t target_id;
4294
4295         /*
4296          * This is the host address where the response will be written when the
4297          * request is complete. This area must be 16B aligned and must be
4298          * cleared to zero before the request is made.
4299          */
4300         uint64_t resp_addr;
4301
4302         /*
4303          * When this bit is '1', the function driver is notifying the HWRM to
4304          * prepare for the shutdown.
4305          */
4306         #define HWRM_FUNC_DRV_UNRGTR_INPUT_FLAGS_PREPARE_FOR_SHUTDOWN \
4307                                                         UINT32_C(0x1)
4308         uint32_t flags;
4309
4310         uint32_t unused_0;
4311 } __attribute__((packed));
4312
4313 /* Output (16 bytes) */
4314 struct hwrm_func_drv_unrgtr_output {
4315         /*
4316          * Pass/Fail or error type Note: receiver to verify the in parameters,
4317          * and fail the call with an error when appropriate
4318          */
4319         uint16_t error_code;
4320
4321         /* This field returns the type of original request. */
4322         uint16_t req_type;
4323
4324         /* This field provides original sequence number of the command. */
4325         uint16_t seq_id;
4326
4327         /*
4328          * This field is the length of the response in bytes. The last byte of
4329          * the response is a valid flag that will read as '1' when the command
4330          * has been completely written to memory.
4331          */
4332         uint16_t resp_len;
4333
4334         uint32_t unused_0;
4335         uint8_t unused_1;
4336         uint8_t unused_2;
4337         uint8_t unused_3;
4338
4339         /*
4340          * This field is used in Output records to indicate that the output is
4341          * completely written to RAM. This field should be read as '1' to
4342          * indicate that the output has been completely written. When writing a
4343          * command completion or response to an internal processor, the order of
4344          * writes has to be such that this field is written last.
4345          */
4346         uint8_t valid;
4347 } __attribute__((packed));
4348
4349 #endif