drivers/net/qede/base/eth_common.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright (c) 2016 - 2018 Cavium Inc.
   3  * All rights reserved.
   4  * www.cavium.com
   5  */
   6
   7 #ifndef __ETH_COMMON__
   8 #define __ETH_COMMON__
   9 /********************/
  10 /* ETH FW CONSTANTS */
  11 /********************/
  12
  13 /* FP HSI version. FP HSI is compatible if (fwVer.major == drvVer.major &&
  14  * fwVer.minor >= drvVer.minor)
  15  */
  16 /* ETH FP HSI Major version */
  17 #define ETH_HSI_VER_MAJOR                   3
  18 /* ETH FP HSI Minor version */
  19 #define ETH_HSI_VER_MINOR                   10
  20
  21 /* Alias for 8.7.x.x/8.8.x.x ETH FP HSI MINOR version. In this version driver
  22  * is not required to set pkt_len field in eth_tx_1st_bd struct, and tunneling
  23  * offload is not supported.
  24  */
  25 #define ETH_HSI_VER_NO_PKT_LEN_TUNN         5
  26
  27 #define ETH_CACHE_LINE_SIZE                 64
  28 #define ETH_RX_CQE_GAP                      32
  29 #define ETH_MAX_RAMROD_PER_CON              8
  30 #define ETH_TX_BD_PAGE_SIZE_BYTES           4096
  31 #define ETH_RX_BD_PAGE_SIZE_BYTES           4096
  32 #define ETH_RX_CQE_PAGE_SIZE_BYTES          4096
  33 #define ETH_RX_NUM_NEXT_PAGE_BDS            2
  34
  35 /* Limitation for Tunneled LSO Packets on the offset (in bytes) of the inner IP
  36  * header (relevant to LSO for tunneled packet):
  37  */
  38 /* Offset is limited to 253 bytes (inclusive). */
  39 #define ETH_MAX_TUNN_LSO_INNER_IPV4_OFFSET          253
  40 /* Offset is limited to 251 bytes (inclusive). */
  41 #define ETH_MAX_TUNN_LSO_INNER_IPV6_OFFSET          251
  42
  43 #define ETH_TX_MIN_BDS_PER_NON_LSO_PKT              1
  44 #define ETH_TX_MAX_BDS_PER_NON_LSO_PACKET           18
  45 #define ETH_TX_MAX_BDS_PER_LSO_PACKET               255
  46 #define ETH_TX_MAX_LSO_HDR_NBD                      4
  47 #define ETH_TX_MIN_BDS_PER_LSO_PKT                  3
  48 #define ETH_TX_MIN_BDS_PER_TUNN_IPV6_WITH_EXT_PKT   3
  49 #define ETH_TX_MIN_BDS_PER_IPV6_WITH_EXT_PKT        2
  50 #define ETH_TX_MIN_BDS_PER_PKT_W_LOOPBACK_MODE      2
  51 /* (QM_REG_TASKBYTECRDCOST_0, QM_VOQ_BYTE_CRD_TASK_COST) -
  52  * (VLAN-TAG + CRC + IPG + PREAMBLE)
  53  */
  54 #define ETH_TX_MAX_NON_LSO_PKT_LEN                  (9700 - (4 + 4 + 12 + 8))
  55 #define ETH_TX_MAX_LSO_HDR_BYTES                    510
  56 /* Number of BDs to consider for LSO sliding window restriction is
  57  * (ETH_TX_LSO_WINDOW_BDS_NUM - hdr_nbd)
  58  */
  59 #define ETH_TX_LSO_WINDOW_BDS_NUM                   (18 - 1)
  60 /* Minimum data length (in bytes) in LSO sliding window */
  61 #define ETH_TX_LSO_WINDOW_MIN_LEN                   9700
  62 /* Maximum LSO packet TCP payload length (in bytes) */
  63 #define ETH_TX_MAX_LSO_PAYLOAD_LEN                  0xFE000
  64 /* Number of same-as-last resources in tx switching */
  65 #define ETH_TX_NUM_SAME_AS_LAST_ENTRIES             320
  66 /* Value for a connection for which same as last feature is disabled */
  67 #define ETH_TX_INACTIVE_SAME_AS_LAST                0xFFFF
  68
  69 /* Maximum number of statistics counters */
  70 #define ETH_NUM_STATISTIC_COUNTERS                  MAX_NUM_VPORTS
  71 /* Maximum number of statistics counters when doubled VF zone used */
  72 #define ETH_NUM_STATISTIC_COUNTERS_DOUBLE_VF_ZONE \
  73         (ETH_NUM_STATISTIC_COUNTERS - MAX_NUM_VFS / 2)
  74 /* Maximum number of statistics counters when quad VF zone used */
  75 #define ETH_NUM_STATISTIC_COUNTERS_QUAD_VF_ZONE \
  76         (ETH_NUM_STATISTIC_COUNTERS - 3 * MAX_NUM_VFS / 4)
  77
  78 /* Maximum number of buffers, used for RX packet placement */
  79 #define ETH_RX_MAX_BUFF_PER_PKT             5
  80 /* Minimum number of free BDs in RX ring, that guarantee receiving of at least
  81  * one RX packet.
  82  */
  83 #define ETH_RX_BD_THRESHOLD                12
  84
  85 /* num of MAC/VLAN filters */
  86 #define ETH_NUM_MAC_FILTERS                 512
  87 #define ETH_NUM_VLAN_FILTERS                512
  88
  89 /* approx. multicast constants */
  90 /* CRC seed for multicast bin calculation */
  91 #define ETH_MULTICAST_BIN_FROM_MAC_SEED     0
  92 #define ETH_MULTICAST_MAC_BINS              256
  93 #define ETH_MULTICAST_MAC_BINS_IN_REGS      (ETH_MULTICAST_MAC_BINS / 32)
  94
  95 /*  ethernet vport update constants */
  96 #define ETH_FILTER_RULES_COUNT              10
  97 /* number of RSS indirection table entries, per Vport) */
  98 #define ETH_RSS_IND_TABLE_ENTRIES_NUM       128
  99 /* Length of RSS key (in regs) */
 100 #define ETH_RSS_KEY_SIZE_REGS               10
 101 /* number of available RSS engines in K2 */
 102 #define ETH_RSS_ENGINE_NUM_K2               207
 103 /* number of available RSS engines in BB */
 104 #define ETH_RSS_ENGINE_NUM_BB               127
 105
 106 /* TPA constants */
 107 /* Maximum number of open TPA aggregations */
 108 #define ETH_TPA_MAX_AGGS_NUM              64
 109 /* Maximum number of additional buffers, reported by TPA-start CQE */
 110 #define ETH_TPA_CQE_START_LEN_LIST_SIZE   ETH_RX_MAX_BUFF_PER_PKT
 111 /* Maximum number of buffers, reported by TPA-continue CQE */
 112 #define ETH_TPA_CQE_CONT_LEN_LIST_SIZE    6
 113 /* Maximum number of buffers, reported by TPA-end CQE */
 114 #define ETH_TPA_CQE_END_LEN_LIST_SIZE     4
 115
 116 /* Control frame check constants */
 117 /* Number of etherType values configured by driver for control frame check */
 118 #define ETH_CTL_FRAME_ETH_TYPE_NUM              4
 119
 120 /* GFS constants */
 121 #define ETH_GFT_TRASHCAN_VPORT         0x1FF /* GFT drop flow vport number */
 122
 123
 124
 125 /*
 126  * Destination port mode
 127  */
 128 enum dest_port_mode {
 129         DEST_PORT_PHY /* Send to physical port. */,
 130         DEST_PORT_LOOPBACK /* Send to loopback port. */,
 131         DEST_PORT_PHY_LOOPBACK /* Send to physical and loopback port. */,
 132         DEST_PORT_DROP /* Drop the packet in PBF. */,
 133         MAX_DEST_PORT_MODE
 134 };
 135
 136
 137 /*
 138  * Ethernet address type
 139  */
 140 enum eth_addr_type {
 141         BROADCAST_ADDRESS,
 142         MULTICAST_ADDRESS,
 143         UNICAST_ADDRESS,
 144         UNKNOWN_ADDRESS,
 145         MAX_ETH_ADDR_TYPE
 146 };
 147
 148
 149 struct eth_tx_1st_bd_flags {
 150         u8 bitfields;
 151 /* Set to 1 in the first BD. (for debug) */
 152 #define ETH_TX_1ST_BD_FLAGS_START_BD_MASK         0x1
 153 #define ETH_TX_1ST_BD_FLAGS_START_BD_SHIFT        0
 154 /* Do not allow additional VLAN manipulations on this packet. */
 155 #define ETH_TX_1ST_BD_FLAGS_FORCE_VLAN_MODE_MASK  0x1
 156 #define ETH_TX_1ST_BD_FLAGS_FORCE_VLAN_MODE_SHIFT 1
 157 /* Recalculate IP checksum. For tunneled packet - relevant to inner header. */
 158 #define ETH_TX_1ST_BD_FLAGS_IP_CSUM_MASK          0x1
 159 #define ETH_TX_1ST_BD_FLAGS_IP_CSUM_SHIFT         2
 160 /* Recalculate TCP/UDP checksum.
 161  * For tunneled packet - relevant to inner header.
 162  */
 163 #define ETH_TX_1ST_BD_FLAGS_L4_CSUM_MASK          0x1
 164 #define ETH_TX_1ST_BD_FLAGS_L4_CSUM_SHIFT         3
 165 /* If set, insert VLAN tag from vlan field to the packet.
 166  * For tunneled packet - relevant to outer header.
 167  */
 168 #define ETH_TX_1ST_BD_FLAGS_VLAN_INSERTION_MASK   0x1
 169 #define ETH_TX_1ST_BD_FLAGS_VLAN_INSERTION_SHIFT  4
 170 /* If set, this is an LSO packet. Note: For Tunneled LSO packets, the offset of
 171  * the inner IPV4 (and IPV6) header is limited to 253 (and 251 respectively)
 172  * bytes, inclusive.
 173  */
 174 #define ETH_TX_1ST_BD_FLAGS_LSO_MASK              0x1
 175 #define ETH_TX_1ST_BD_FLAGS_LSO_SHIFT             5
 176 /* Recalculate Tunnel IP Checksum (if Tunnel IP Header is IPv4) */
 177 #define ETH_TX_1ST_BD_FLAGS_TUNN_IP_CSUM_MASK     0x1
 178 #define ETH_TX_1ST_BD_FLAGS_TUNN_IP_CSUM_SHIFT    6
 179 /* Recalculate Tunnel UDP/GRE Checksum (Depending on Tunnel Type) */
 180 #define ETH_TX_1ST_BD_FLAGS_TUNN_L4_CSUM_MASK     0x1
 181 #define ETH_TX_1ST_BD_FLAGS_TUNN_L4_CSUM_SHIFT    7
 182 };
 183
 184 /*
 185  * The parsing information data for the first tx bd of a given packet.
 186  */
 187 struct eth_tx_data_1st_bd {
 188 /* VLAN tag to insert to packet (if enabled by vlan_insertion flag). */
 189         __le16 vlan;
 190 /* Number of BDs in packet. Should be at least 1 in non-LSO packet and at least
 191  * 3 in LSO (or Tunnel with IPv6+ext) packet.
 192  */
 193         u8 nbds;
 194         struct eth_tx_1st_bd_flags bd_flags;
 195         __le16 bitfields;
 196 /* Indicates a tunneled packet. Must be set for encapsulated packet. */
 197 #define ETH_TX_DATA_1ST_BD_TUNN_FLAG_MASK  0x1
 198 #define ETH_TX_DATA_1ST_BD_TUNN_FLAG_SHIFT 0
 199 #define ETH_TX_DATA_1ST_BD_RESERVED0_MASK  0x1
 200 #define ETH_TX_DATA_1ST_BD_RESERVED0_SHIFT 1
 201 /* Total packet length - must be filled for non-LSO packets. */
 202 #define ETH_TX_DATA_1ST_BD_PKT_LEN_MASK    0x3FFF
 203 #define ETH_TX_DATA_1ST_BD_PKT_LEN_SHIFT   2
 204 };
 205
 206 /*
 207  * The parsing information data for the second tx bd of a given packet.
 208  */
 209 struct eth_tx_data_2nd_bd {
 210 /* For tunnel with IPv6+ext - Tunnel header IP datagram length (in BYTEs) */
 211         __le16 tunn_ip_size;
 212         __le16 bitfields1;
 213 /* For Tunnel header with IPv6 ext. - Inner L2 Header Size (in 2-byte WORDs) */
 214 #define ETH_TX_DATA_2ND_BD_TUNN_INNER_L2_HDR_SIZE_W_MASK  0xF
 215 #define ETH_TX_DATA_2ND_BD_TUNN_INNER_L2_HDR_SIZE_W_SHIFT 0
 216 /* For Tunnel header with IPv6 ext. - Inner L2 Header MAC DA Type
 217  * (use enum eth_addr_type)
 218  */
 219 #define ETH_TX_DATA_2ND_BD_TUNN_INNER_ETH_TYPE_MASK       0x3
 220 #define ETH_TX_DATA_2ND_BD_TUNN_INNER_ETH_TYPE_SHIFT      4
 221 /* Destination port mode. (use enum dest_port_mode) */
 222 #define ETH_TX_DATA_2ND_BD_DEST_PORT_MODE_MASK            0x3
 223 #define ETH_TX_DATA_2ND_BD_DEST_PORT_MODE_SHIFT           6
 224 /* Should be 0 in all the BDs, except the first one. (for debug) */
 225 #define ETH_TX_DATA_2ND_BD_START_BD_MASK                  0x1
 226 #define ETH_TX_DATA_2ND_BD_START_BD_SHIFT                 8
 227 /* For Tunnel header with IPv6 ext. - Tunnel Type (use enum eth_tx_tunn_type) */
 228 #define ETH_TX_DATA_2ND_BD_TUNN_TYPE_MASK                 0x3
 229 #define ETH_TX_DATA_2ND_BD_TUNN_TYPE_SHIFT                9
 230 /* For LSO / Tunnel header with IPv6+ext - Set if inner header is IPv6 */
 231 #define ETH_TX_DATA_2ND_BD_TUNN_INNER_IPV6_MASK           0x1
 232 #define ETH_TX_DATA_2ND_BD_TUNN_INNER_IPV6_SHIFT          11
 233 /* In tunneling mode - Set to 1 when the Inner header is IPv6 with extension.
 234  * Otherwise set to 1 if the header is IPv6 with extension.
 235  */
 236 #define ETH_TX_DATA_2ND_BD_IPV6_EXT_MASK                  0x1
 237 #define ETH_TX_DATA_2ND_BD_IPV6_EXT_SHIFT                 12
 238 /* Set to 1 if Tunnel (outer = encapsulating) header has IPv6 ext. (Note: 3rd BD
 239  * is required, hence EDPM does not support Tunnel [outer] header with Ipv6Ext)
 240  */
 241 #define ETH_TX_DATA_2ND_BD_TUNN_IPV6_EXT_MASK             0x1
 242 #define ETH_TX_DATA_2ND_BD_TUNN_IPV6_EXT_SHIFT            13
 243 /* Set if (inner) L4 protocol is UDP. (Required when IPv6+ext (or tunnel with
 244  * inner or outer Ipv6+ext) and l4_csum is set)
 245  */
 246 #define ETH_TX_DATA_2ND_BD_L4_UDP_MASK                    0x1
 247 #define ETH_TX_DATA_2ND_BD_L4_UDP_SHIFT                   14
 248 /* The pseudo header checksum type in the L4 checksum field. Required when
 249  * IPv6+ext and l4_csum is set. (use enum eth_l4_pseudo_checksum_mode)
 250  */
 251 #define ETH_TX_DATA_2ND_BD_L4_PSEUDO_CSUM_MODE_MASK       0x1
 252 #define ETH_TX_DATA_2ND_BD_L4_PSEUDO_CSUM_MODE_SHIFT      15
 253         __le16 bitfields2;
 254 /* For inner/outer header IPv6+ext - (inner) L4 header offset (in 2-byte WORDs).
 255  * For regular packet - offset from the beginning of the packet. For tunneled
 256  * packet - offset from the beginning of the inner header
 257  */
 258 #define ETH_TX_DATA_2ND_BD_L4_HDR_START_OFFSET_W_MASK     0x1FFF
 259 #define ETH_TX_DATA_2ND_BD_L4_HDR_START_OFFSET_W_SHIFT    0
 260 #define ETH_TX_DATA_2ND_BD_RESERVED0_MASK                 0x7
 261 #define ETH_TX_DATA_2ND_BD_RESERVED0_SHIFT                13
 262 };
 263
 264 /*
 265  * Firmware data for L2-EDPM packet.
 266  */
 267 struct eth_edpm_fw_data {
 268 /* Parsing information data from the 1st BD. */
 269         struct eth_tx_data_1st_bd data_1st_bd;
 270 /* Parsing information data from the 2nd BD. */
 271         struct eth_tx_data_2nd_bd data_2nd_bd;
 272         __le32 reserved;
 273 };
 274
 275
 276 /*
 277  * FW debug.
 278  */
 279 struct eth_fast_path_cqe_fw_debug {
 280         __le16 reserved2 /* FW reserved. */;
 281 };
 282
 283
 284 /*
 285  * tunneling parsing flags
 286  */
 287 struct eth_tunnel_parsing_flags {
 288         u8 flags;
 289 /* 0 - no tunneling, 1 - GENEVE, 2 - GRE, 3 - VXLAN
 290  * (use enum eth_rx_tunn_type)
 291  */
 292 #define ETH_TUNNEL_PARSING_FLAGS_TYPE_MASK              0x3
 293 #define ETH_TUNNEL_PARSING_FLAGS_TYPE_SHIFT             0
 294 /*  If it s not an encapsulated packet then put 0x0. If it s an encapsulated
 295  *  packet but the tenant-id doesn t exist then put 0x0. Else put 0x1
 296  *
 297  */
 298 #define ETH_TUNNEL_PARSING_FLAGS_TENNANT_ID_EXIST_MASK  0x1
 299 #define ETH_TUNNEL_PARSING_FLAGS_TENNANT_ID_EXIST_SHIFT 2
 300 /* Type of the next header above the tunneling: 0 - unknown, 1 - L2, 2 - Ipv4,
 301  * 3 - IPv6 (use enum tunnel_next_protocol)
 302  */
 303 #define ETH_TUNNEL_PARSING_FLAGS_NEXT_PROTOCOL_MASK     0x3
 304 #define ETH_TUNNEL_PARSING_FLAGS_NEXT_PROTOCOL_SHIFT    3
 305 /* The result of comparing the DA-ip of the tunnel header. */
 306 #define ETH_TUNNEL_PARSING_FLAGS_FIRSTHDRIPMATCH_MASK   0x1
 307 #define ETH_TUNNEL_PARSING_FLAGS_FIRSTHDRIPMATCH_SHIFT  5
 308 #define ETH_TUNNEL_PARSING_FLAGS_IPV4_FRAGMENT_MASK     0x1
 309 #define ETH_TUNNEL_PARSING_FLAGS_IPV4_FRAGMENT_SHIFT    6
 310 #define ETH_TUNNEL_PARSING_FLAGS_IPV4_OPTIONS_MASK      0x1
 311 #define ETH_TUNNEL_PARSING_FLAGS_IPV4_OPTIONS_SHIFT     7
 312 };
 313
 314 /*
 315  * PMD flow control bits
 316  */
 317 struct eth_pmd_flow_flags {
 318         u8 flags;
 319 #define ETH_PMD_FLOW_FLAGS_VALID_MASK     0x1 /* CQE valid bit */
 320 #define ETH_PMD_FLOW_FLAGS_VALID_SHIFT    0
 321 #define ETH_PMD_FLOW_FLAGS_TOGGLE_MASK    0x1 /* CQE ring toggle bit */
 322 #define ETH_PMD_FLOW_FLAGS_TOGGLE_SHIFT   1
 323 #define ETH_PMD_FLOW_FLAGS_RESERVED_MASK  0x3F
 324 #define ETH_PMD_FLOW_FLAGS_RESERVED_SHIFT 2
 325 };
 326
 327 /*
 328  * Regular ETH Rx FP CQE.
 329  */
 330 struct eth_fast_path_rx_reg_cqe {
 331         u8 type /* CQE type */;
 332         u8 bitfields;
 333 /* Type of calculated RSS hash (use enum rss_hash_type) */
 334 #define ETH_FAST_PATH_RX_REG_CQE_RSS_HASH_TYPE_MASK  0x7
 335 #define ETH_FAST_PATH_RX_REG_CQE_RSS_HASH_TYPE_SHIFT 0
 336 /* Traffic Class */
 337 #define ETH_FAST_PATH_RX_REG_CQE_TC_MASK             0xF
 338 #define ETH_FAST_PATH_RX_REG_CQE_TC_SHIFT            3
 339 #define ETH_FAST_PATH_RX_REG_CQE_RESERVED0_MASK      0x1
 340 #define ETH_FAST_PATH_RX_REG_CQE_RESERVED0_SHIFT     7
 341         __le16 pkt_len /* Total packet length (from the parser) */;
 342 /* Parsing and error flags from the parser */
 343         struct parsing_and_err_flags pars_flags;
 344         __le16 vlan_tag /* 802.1q VLAN tag */;
 345         __le32 rss_hash /* RSS hash result */;
 346         __le16 len_on_first_bd /* Number of bytes placed on first BD */;
 347         u8 placement_offset /* Offset of placement from BD start */;
 348 /* Tunnel Parsing Flags */
 349         struct eth_tunnel_parsing_flags tunnel_pars_flags;
 350         u8 bd_num /* Number of BDs, used for packet */;
 351         u8 reserved[9];
 352         struct eth_fast_path_cqe_fw_debug fw_debug /* FW reserved. */;
 353         u8 reserved1[3];
 354         struct eth_pmd_flow_flags pmd_flags /* CQE valid and toggle bits */;
 355 };
 356
 357
 358 /*
 359  * TPA-continue ETH Rx FP CQE.
 360  */
 361 struct eth_fast_path_rx_tpa_cont_cqe {
 362         u8 type /* CQE type */;
 363         u8 tpa_agg_index /* TPA aggregation index */;
 364 /* List of the segment sizes */
 365         __le16 len_list[ETH_TPA_CQE_CONT_LEN_LIST_SIZE];
 366         u8 reserved;
 367         u8 reserved1 /* FW reserved. */;
 368         __le16 reserved2[ETH_TPA_CQE_CONT_LEN_LIST_SIZE] /* FW reserved. */;
 369         u8 reserved3[3];
 370         struct eth_pmd_flow_flags pmd_flags /* CQE valid and toggle bits */;
 371 };
 372
 373
 374 /*
 375  * TPA-end ETH Rx FP CQE .
 376  */
 377 struct eth_fast_path_rx_tpa_end_cqe {
 378         u8 type /* CQE type */;
 379         u8 tpa_agg_index /* TPA aggregation index */;
 380         __le16 total_packet_len /* Total aggregated packet length */;
 381         u8 num_of_bds /* Total number of BDs comprising the packet */;
 382 /* Aggregation end reason. Use enum eth_tpa_end_reason */
 383         u8 end_reason;
 384         __le16 num_of_coalesced_segs /* Number of coalesced TCP segments */;
 385         __le32 ts_delta /* TCP timestamp delta */;
 386 /* List of the segment sizes */
 387         __le16 len_list[ETH_TPA_CQE_END_LEN_LIST_SIZE];
 388         __le16 reserved3[ETH_TPA_CQE_END_LEN_LIST_SIZE] /* FW reserved. */;
 389         __le16 reserved1;
 390         u8 reserved2 /* FW reserved. */;
 391         struct eth_pmd_flow_flags pmd_flags /* CQE valid and toggle bits */;
 392 };
 393
 394
 395 /*
 396  * TPA-start ETH Rx FP CQE.
 397  */
 398 struct eth_fast_path_rx_tpa_start_cqe {
 399         u8 type /* CQE type */;
 400         u8 bitfields;
 401 /* Type of calculated RSS hash (use enum rss_hash_type) */
 402 #define ETH_FAST_PATH_RX_TPA_START_CQE_RSS_HASH_TYPE_MASK  0x7
 403 #define ETH_FAST_PATH_RX_TPA_START_CQE_RSS_HASH_TYPE_SHIFT 0
 404 /* Traffic Class */
 405 #define ETH_FAST_PATH_RX_TPA_START_CQE_TC_MASK             0xF
 406 #define ETH_FAST_PATH_RX_TPA_START_CQE_TC_SHIFT            3
 407 #define ETH_FAST_PATH_RX_TPA_START_CQE_RESERVED0_MASK      0x1
 408 #define ETH_FAST_PATH_RX_TPA_START_CQE_RESERVED0_SHIFT     7
 409         __le16 seg_len /* Segment length (packetLen from the parser) */;
 410 /* Parsing and error flags from the parser */
 411         struct parsing_and_err_flags pars_flags;
 412         __le16 vlan_tag /* 802.1q VLAN tag */;
 413         __le32 rss_hash /* RSS hash result */;
 414         __le16 len_on_first_bd /* Number of bytes placed on first BD */;
 415         u8 placement_offset /* Offset of placement from BD start */;
 416 /* Tunnel Parsing Flags */
 417         struct eth_tunnel_parsing_flags tunnel_pars_flags;
 418         u8 tpa_agg_index /* TPA aggregation index */;
 419         u8 header_len /* Packet L2+L3+L4 header length */;
 420 /* Additional BDs length list. */
 421         __le16 ext_bd_len_list[ETH_TPA_CQE_START_LEN_LIST_SIZE];
 422         struct eth_fast_path_cqe_fw_debug fw_debug /* FW reserved. */;
 423         u8 reserved;
 424         struct eth_pmd_flow_flags pmd_flags /* CQE valid and toggle bits */;
 425 };
 426
 427
 428 /*
 429  * The L4 pseudo checksum mode for Ethernet
 430  */
 431 enum eth_l4_pseudo_checksum_mode {
 432 /* Pseudo Header checksum on packet is calculated with the correct packet length
 433  * field.
 434  */
 435         ETH_L4_PSEUDO_CSUM_CORRECT_LENGTH,
 436 /* Pseudo Header checksum on packet is calculated with zero length field. */
 437         ETH_L4_PSEUDO_CSUM_ZERO_LENGTH,
 438         MAX_ETH_L4_PSEUDO_CHECKSUM_MODE
 439 };
 440
 441
 442
 443 struct eth_rx_bd {
 444         struct regpair addr /* single continues buffer */;
 445 };
 446
 447
 448 /*
 449  * regular ETH Rx SP CQE
 450  */
 451 struct eth_slow_path_rx_cqe {
 452         u8 type /* CQE type */;
 453         u8 ramrod_cmd_id;
 454         u8 error_flag;
 455         u8 reserved[25];
 456         __le16 echo;
 457         u8 reserved1;
 458         struct eth_pmd_flow_flags pmd_flags /* CQE valid and toggle bits */;
 459 };
 460
 461 /*
 462  * union for all ETH Rx CQE types
 463  */
 464 union eth_rx_cqe {
 465 /* Regular FP CQE */
 466         struct eth_fast_path_rx_reg_cqe fast_path_regular;
 467 /* TPA-start CQE */
 468         struct eth_fast_path_rx_tpa_start_cqe fast_path_tpa_start;
 469 /* TPA-continue CQE */
 470         struct eth_fast_path_rx_tpa_cont_cqe fast_path_tpa_cont;
 471 /* TPA-end CQE */
 472         struct eth_fast_path_rx_tpa_end_cqe fast_path_tpa_end;
 473         struct eth_slow_path_rx_cqe slow_path /* SP CQE */;
 474 };
 475
 476
 477 /*
 478  * ETH Rx CQE type
 479  */
 480 enum eth_rx_cqe_type {
 481         ETH_RX_CQE_TYPE_UNUSED,
 482         ETH_RX_CQE_TYPE_REGULAR /* Regular FP ETH Rx CQE */,
 483         ETH_RX_CQE_TYPE_SLOW_PATH /* Slow path ETH Rx CQE */,
 484         ETH_RX_CQE_TYPE_TPA_START /* TPA start ETH Rx CQE */,
 485         ETH_RX_CQE_TYPE_TPA_CONT /* TPA Continue ETH Rx CQE */,
 486         ETH_RX_CQE_TYPE_TPA_END /* TPA end ETH Rx CQE */,
 487         MAX_ETH_RX_CQE_TYPE
 488 };
 489
 490
 491 /*
 492  * Wrapper for PD RX CQE - used in order to cover full cache line when writing
 493  * CQE
 494  */
 495 struct eth_rx_pmd_cqe {
 496         union eth_rx_cqe cqe /* CQE data itself */;
 497         u8 reserved[ETH_RX_CQE_GAP];
 498 };
 499
 500
 501 /*
 502  * Eth RX Tunnel Type
 503  */
 504 enum eth_rx_tunn_type {
 505         ETH_RX_NO_TUNN /* No Tunnel. */,
 506         ETH_RX_TUNN_GENEVE /* GENEVE Tunnel. */,
 507         ETH_RX_TUNN_GRE /* GRE Tunnel. */,
 508         ETH_RX_TUNN_VXLAN /* VXLAN Tunnel. */,
 509         MAX_ETH_RX_TUNN_TYPE
 510 };
 511
 512
 513
 514 /*
 515  * Aggregation end reason.
 516  */
 517 enum eth_tpa_end_reason {
 518         ETH_AGG_END_UNUSED,
 519         ETH_AGG_END_SP_UPDATE /* SP configuration update */,
 520 /* Maximum aggregation length or maximum buffer number used. */
 521         ETH_AGG_END_MAX_LEN,
 522 /* TCP PSH flag or TCP payload length below continue threshold. */
 523         ETH_AGG_END_LAST_SEG,
 524         ETH_AGG_END_TIMEOUT /* Timeout expiration. */,
 525 /* Packet header not consistency: different IPv4 TOS, TTL or flags, IPv6 TC,
 526  * Hop limit or Flow label, TCP header length or TS options. In GRO different
 527  * TS value, SMAC, DMAC, ackNum, windowSize or VLAN
 528  */
 529         ETH_AGG_END_NOT_CONSISTENT,
 530 /* Out of order or retransmission packet: sequence, ack or timestamp not
 531  * consistent with previous segment.
 532  */
 533         ETH_AGG_END_OUT_OF_ORDER,
 534 /* Next segment cant be aggregated due to LLC/SNAP, IP error, IP fragment, IPv4
 535  * options, IPv6 extension, IP ECN = CE, TCP errors, TCP options, zero TCP
 536  * payload length , TCP flags or not supported tunnel header options.
 537  */
 538         ETH_AGG_END_NON_TPA_SEG,
 539         MAX_ETH_TPA_END_REASON
 540 };
 541
 542
 543
 544 /*
 545  * The first tx bd of a given packet
 546  */
 547 struct eth_tx_1st_bd {
 548         struct regpair addr /* Single continuous buffer */;
 549         __le16 nbytes /* Number of bytes in this BD. */;
 550         struct eth_tx_data_1st_bd data /* Parsing information data. */;
 551 };
 552
 553
 554
 555 /*
 556  * The second tx bd of a given packet
 557  */
 558 struct eth_tx_2nd_bd {
 559         struct regpair addr /* Single continuous buffer */;
 560         __le16 nbytes /* Number of bytes in this BD. */;
 561         struct eth_tx_data_2nd_bd data /* Parsing information data. */;
 562 };
 563
 564
 565 /*
 566  * The parsing information data for the third tx bd of a given packet.
 567  */
 568 struct eth_tx_data_3rd_bd {
 569         __le16 lso_mss /* For LSO packet - the MSS in bytes. */;
 570         __le16 bitfields;
 571 /* For LSO with inner/outer IPv6+ext - TCP header length (in 4-byte WORDs) */
 572 #define ETH_TX_DATA_3RD_BD_TCP_HDR_LEN_DW_MASK  0xF
 573 #define ETH_TX_DATA_3RD_BD_TCP_HDR_LEN_DW_SHIFT 0
 574 /* LSO - number of BDs which contain headers. value should be in range
 575  * (1..ETH_TX_MAX_LSO_HDR_NBD).
 576  */
 577 #define ETH_TX_DATA_3RD_BD_HDR_NBD_MASK         0xF
 578 #define ETH_TX_DATA_3RD_BD_HDR_NBD_SHIFT        4
 579 /* Should be 0 in all the BDs, except the first one. (for debug) */
 580 #define ETH_TX_DATA_3RD_BD_START_BD_MASK        0x1
 581 #define ETH_TX_DATA_3RD_BD_START_BD_SHIFT       8
 582 #define ETH_TX_DATA_3RD_BD_RESERVED0_MASK       0x7F
 583 #define ETH_TX_DATA_3RD_BD_RESERVED0_SHIFT      9
 584 /* For tunnel with IPv6+ext - Pointer to tunnel L4 Header (in 2-byte WORDs) */
 585         u8 tunn_l4_hdr_start_offset_w;
 586 /* For tunnel with IPv6+ext - Total size of Tunnel Header (in 2-byte WORDs) */
 587         u8 tunn_hdr_size_w;
 588 };
 589
 590 /*
 591  * The third tx bd of a given packet
 592  */
 593 struct eth_tx_3rd_bd {
 594         struct regpair addr /* Single continuous buffer */;
 595         __le16 nbytes /* Number of bytes in this BD. */;
 596         struct eth_tx_data_3rd_bd data /* Parsing information data. */;
 597 };
 598
 599
 600 /*
 601  * Complementary information for the regular tx bd of a given packet.
 602  */
 603 struct eth_tx_data_bd {
 604         __le16 reserved0;
 605         __le16 bitfields;
 606 #define ETH_TX_DATA_BD_RESERVED1_MASK  0xFF
 607 #define ETH_TX_DATA_BD_RESERVED1_SHIFT 0
 608 /* Should be 0 in all the BDs, except the first one. (for debug) */
 609 #define ETH_TX_DATA_BD_START_BD_MASK   0x1
 610 #define ETH_TX_DATA_BD_START_BD_SHIFT  8
 611 #define ETH_TX_DATA_BD_RESERVED2_MASK  0x7F
 612 #define ETH_TX_DATA_BD_RESERVED2_SHIFT 9
 613         __le16 reserved3;
 614 };
 615
 616 /*
 617  * The common regular TX BD ring element
 618  */
 619 struct eth_tx_bd {
 620         struct regpair addr /* Single continuous buffer */;
 621         __le16 nbytes /* Number of bytes in this BD. */;
 622         struct eth_tx_data_bd data /* Complementary information. */;
 623 };
 624
 625
 626 union eth_tx_bd_types {
 627         struct eth_tx_1st_bd first_bd /* The first tx bd of a given packet */;
 628 /* The second tx bd of a given packet */
 629         struct eth_tx_2nd_bd second_bd;
 630         struct eth_tx_3rd_bd third_bd /* The third tx bd of a given packet */;
 631         struct eth_tx_bd reg_bd /* The common non-special bd */;
 632 };
 633
 634
 635
 636
 637
 638
 639 /*
 640  * Eth Tx Tunnel Type
 641  */
 642 enum eth_tx_tunn_type {
 643         ETH_TX_TUNN_GENEVE /* GENEVE Tunnel. */,
 644         ETH_TX_TUNN_TTAG /* T-Tag Tunnel. */,
 645         ETH_TX_TUNN_GRE /* GRE Tunnel. */,
 646         ETH_TX_TUNN_VXLAN /* VXLAN Tunnel. */,
 647         MAX_ETH_TX_TUNN_TYPE
 648 };
 649
 650
 651 /*
 652  * Ystorm Queue Zone
 653  */
 654 struct xstorm_eth_queue_zone {
 655 /* Tx interrupt coalescing TimeSet */
 656         struct coalescing_timeset int_coalescing_timeset;
 657         u8 reserved[7];
 658 };
 659
 660
 661 /*
 662  * ETH doorbell data
 663  */
 664 struct eth_db_data {
 665         u8 params;
 666 /* destination of doorbell (use enum db_dest) */
 667 #define ETH_DB_DATA_DEST_MASK         0x3
 668 #define ETH_DB_DATA_DEST_SHIFT        0
 669 /* aggregative command to CM (use enum db_agg_cmd_sel) */
 670 #define ETH_DB_DATA_AGG_CMD_MASK      0x3
 671 #define ETH_DB_DATA_AGG_CMD_SHIFT     2
 672 #define ETH_DB_DATA_BYPASS_EN_MASK    0x1 /* enable QM bypass */
 673 #define ETH_DB_DATA_BYPASS_EN_SHIFT   4
 674 #define ETH_DB_DATA_RESERVED_MASK     0x1
 675 #define ETH_DB_DATA_RESERVED_SHIFT    5
 676 /* aggregative value selection */
 677 #define ETH_DB_DATA_AGG_VAL_SEL_MASK  0x3
 678 #define ETH_DB_DATA_AGG_VAL_SEL_SHIFT 6
 679 /* bit for every DQ counter flags in CM context that DQ can increment */
 680         u8 agg_flags;
 681         __le16 bd_prod;
 682 };
 683
 684 #endif /* __ETH_COMMON__ */