drivers/net/ice/base/ice_type.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2019
   3  */
   4
   5 #ifndef _ICE_TYPE_H_
   6 #define _ICE_TYPE_H_
   7
   8 #define ETH_ALEN        6
   9
  10 #define ETH_HEADER_LEN  14
  11
  12 #define BIT(a) (1UL << (a))
  13 #define BIT_ULL(a) (1ULL << (a))
  14
  15 #define BITS_PER_BYTE   8
  16
  17 #define _FORCE_
  18
  19 #define ICE_BYTES_PER_WORD      2
  20 #define ICE_BYTES_PER_DWORD     4
  21 #define ICE_MAX_TRAFFIC_CLASS   8
  22
  23 /**
  24  * ROUND_UP - round up to next arbitrary multiple (not a power of 2)
  25  * @a: value to round up
  26  * @b: arbitrary multiple
  27  *
  28  * Round up to the next multiple of the arbitrary b.
  29  * Note, when b is a power of 2 use ICE_ALIGN() instead.
  30  */
  31 #define ROUND_UP(a, b)  ((b) * DIVIDE_AND_ROUND_UP((a), (b)))
  32
  33 #define MIN_T(_t, _a, _b)       min((_t)(_a), (_t)(_b))
  34
  35 #define IS_ASCII(_ch)   ((_ch) < 0x80)
  36
  37 #define ice_struct_size(ptr, field, num) \
  38         (sizeof(*(ptr)) + sizeof(*(ptr)->field) * (num))
  39
  40 #include "ice_status.h"
  41 #include "ice_hw_autogen.h"
  42 #include "ice_devids.h"
  43 #include "ice_osdep.h"
  44 #include "ice_bitops.h" /* Must come before ice_controlq.h */
  45 #include "ice_controlq.h"
  46 #include "ice_lan_tx_rx.h"
  47 #include "ice_flex_type.h"
  48 #include "ice_protocol_type.h"
  49
  50 /**
  51  * ice_is_pow2 - check if integer value is a power of 2
  52  * @val: unsigned integer to be validated
  53  */
  54 static inline bool ice_is_pow2(u64 val)
  55 {
  56         return (val && !(val & (val - 1)));
  57 }
  58
  59 /**
  60  * ice_ilog2 - Calculates integer log base 2 of a number
  61  * @n: number on which to perform operation
  62  */
  63 static inline int ice_ilog2(u64 n)
  64 {
  65         int i;
  66
  67         for (i = 63; i >= 0; i--)
  68                 if (((u64)1 << i) & n)
  69                         return i;
  70
  71         return -1;
  72 }
  73
  74 static inline bool ice_is_tc_ena(ice_bitmap_t bitmap, u8 tc)
  75 {
  76         return ice_is_bit_set(&bitmap, tc);
  77 }
  78
  79 #define DIV_64BIT(n, d) ((n) / (d))
  80
  81 static inline u64 round_up_64bit(u64 a, u32 b)
  82 {
  83         return DIV_64BIT(((a) + (b) / 2), (b));
  84 }
  85
  86 static inline u32 ice_round_to_num(u32 N, u32 R)
  87 {
  88         return ((((N) % (R)) < ((R) / 2)) ? (((N) / (R)) * (R)) :
  89                 ((((N) + (R) - 1) / (R)) * (R)));
  90 }
  91
  92 /* Driver always calls main vsi_handle first */
  93 #define ICE_MAIN_VSI_HANDLE             0
  94
  95 /* Switch from ms to the 1usec global time (this is the GTIME resolution) */
  96 #define ICE_MS_TO_GTIME(time)           ((time) * 1000)
  97
  98 /* Data type manipulation macros. */
  99 #define ICE_HI_DWORD(x)         ((u32)((((x) >> 16) >> 16) & 0xFFFFFFFF))
 100 #define ICE_LO_DWORD(x)         ((u32)((x) & 0xFFFFFFFF))
 101 #define ICE_HI_WORD(x)          ((u16)(((x) >> 16) & 0xFFFF))
 102
 103 /* debug masks - set these bits in hw->debug_mask to control output */
 104 #define ICE_DBG_TRACE           BIT_ULL(0) /* for function-trace only */
 105 #define ICE_DBG_INIT            BIT_ULL(1)
 106 #define ICE_DBG_RELEASE         BIT_ULL(2)
 107 #define ICE_DBG_FW_LOG          BIT_ULL(3)
 108 #define ICE_DBG_LINK            BIT_ULL(4)
 109 #define ICE_DBG_PHY             BIT_ULL(5)
 110 #define ICE_DBG_QCTX            BIT_ULL(6)
 111 #define ICE_DBG_NVM             BIT_ULL(7)
 112 #define ICE_DBG_LAN             BIT_ULL(8)
 113 #define ICE_DBG_FLOW            BIT_ULL(9)
 114 #define ICE_DBG_DCB             BIT_ULL(10)
 115 #define ICE_DBG_DIAG            BIT_ULL(11)
 116 #define ICE_DBG_FD              BIT_ULL(12)
 117 #define ICE_DBG_SW              BIT_ULL(13)
 118 #define ICE_DBG_SCHED           BIT_ULL(14)
 119
 120 #define ICE_DBG_PKG             BIT_ULL(16)
 121 #define ICE_DBG_RES             BIT_ULL(17)
 122 #define ICE_DBG_AQ_MSG          BIT_ULL(24)
 123 #define ICE_DBG_AQ_DESC         BIT_ULL(25)
 124 #define ICE_DBG_AQ_DESC_BUF     BIT_ULL(26)
 125 #define ICE_DBG_AQ_CMD          BIT_ULL(27)
 126 #define ICE_DBG_AQ              (ICE_DBG_AQ_MSG         | \
 127                                  ICE_DBG_AQ_DESC        | \
 128                                  ICE_DBG_AQ_DESC_BUF    | \
 129                                  ICE_DBG_AQ_CMD)
 130
 131 #define ICE_DBG_USER            BIT_ULL(31)
 132 #define ICE_DBG_ALL             0xFFFFFFFFFFFFFFFFULL
 133
 134 #define __ALWAYS_UNUSED
 135
 136 #define IS_ETHER_ADDR_EQUAL(addr1, addr2) \
 137         (((bool)((((u16 *)(addr1))[0] == ((u16 *)(addr2))[0]))) && \
 138          ((bool)((((u16 *)(addr1))[1] == ((u16 *)(addr2))[1]))) && \
 139          ((bool)((((u16 *)(addr1))[2] == ((u16 *)(addr2))[2]))))
 140
 141 enum ice_aq_res_ids {
 142         ICE_NVM_RES_ID = 1,
 143         ICE_SPD_RES_ID,
 144         ICE_CHANGE_LOCK_RES_ID,
 145         ICE_GLOBAL_CFG_LOCK_RES_ID
 146 };
 147
 148 /* FW update timeout definitions are in milliseconds */
 149 #define ICE_NVM_TIMEOUT                 180000
 150 #define ICE_CHANGE_LOCK_TIMEOUT         1000
 151 #define ICE_GLOBAL_CFG_LOCK_TIMEOUT     3000
 152
 153 enum ice_aq_res_access_type {
 154         ICE_RES_READ = 1,
 155         ICE_RES_WRITE
 156 };
 157
 158 struct ice_driver_ver {
 159         u8 major_ver;
 160         u8 minor_ver;
 161         u8 build_ver;
 162         u8 subbuild_ver;
 163         u8 driver_string[32];
 164 };
 165
 166 enum ice_fc_mode {
 167         ICE_FC_NONE = 0,
 168         ICE_FC_RX_PAUSE,
 169         ICE_FC_TX_PAUSE,
 170         ICE_FC_FULL,
 171         ICE_FC_AUTO,
 172         ICE_FC_PFC,
 173         ICE_FC_DFLT
 174 };
 175
 176 enum ice_phy_cache_mode {
 177         ICE_FC_MODE = 0,
 178         ICE_SPEED_MODE,
 179         ICE_FEC_MODE
 180 };
 181
 182 enum ice_fec_mode {
 183         ICE_FEC_NONE = 0,
 184         ICE_FEC_RS,
 185         ICE_FEC_BASER,
 186         ICE_FEC_AUTO
 187 };
 188
 189 struct ice_phy_cache_mode_data {
 190         union {
 191                 enum ice_fec_mode curr_user_fec_req;
 192                 enum ice_fc_mode curr_user_fc_req;
 193                 u16 curr_user_speed_req;
 194         } data;
 195 };
 196
 197 enum ice_set_fc_aq_failures {
 198         ICE_SET_FC_AQ_FAIL_NONE = 0,
 199         ICE_SET_FC_AQ_FAIL_GET,
 200         ICE_SET_FC_AQ_FAIL_SET,
 201         ICE_SET_FC_AQ_FAIL_UPDATE
 202 };
 203
 204 /* These are structs for managing the hardware information and the operations */
 205 /* MAC types */
 206 enum ice_mac_type {
 207         ICE_MAC_UNKNOWN = 0,
 208         ICE_MAC_E810,
 209         ICE_MAC_GENERIC,
 210 };
 211
 212 /* Media Types */
 213 enum ice_media_type {
 214         ICE_MEDIA_UNKNOWN = 0,
 215         ICE_MEDIA_FIBER,
 216         ICE_MEDIA_BASET,
 217         ICE_MEDIA_BACKPLANE,
 218         ICE_MEDIA_DA,
 219 };
 220
 221 /* Software VSI types. */
 222 enum ice_vsi_type {
 223         ICE_VSI_PF = 0,
 224         ICE_VSI_CTRL = 3,       /* equates to ICE_VSI_PF with 1 queue pair */
 225         ICE_VSI_LB = 6,
 226 };
 227
 228 struct ice_link_status {
 229         /* Refer to ice_aq_phy_type for bits definition */
 230         u64 phy_type_low;
 231         u64 phy_type_high;
 232         u8 topo_media_conflict;
 233         u16 max_frame_size;
 234         u16 link_speed;
 235         u16 req_speeds;
 236         u8 lse_ena;     /* Link Status Event notification */
 237         u8 link_info;
 238         u8 an_info;
 239         u8 ext_info;
 240         u8 fec_info;
 241         u8 pacing;
 242         /* Refer to #define from module_type[ICE_MODULE_TYPE_TOTAL_BYTE] of
 243          * ice_aqc_get_phy_caps structure
 244          */
 245         u8 module_type[ICE_MODULE_TYPE_TOTAL_BYTE];
 246 };
 247
 248 /* Different data queue types: These are mainly for SW consumption. */
 249 enum ice_q {
 250         ICE_DATA_Q_DOORBELL,
 251         ICE_DATA_Q_CMPL,
 252         ICE_DATA_Q_QUANTA,
 253         ICE_DATA_Q_RX,
 254         ICE_DATA_Q_TX,
 255 };
 256
 257 /* Different reset sources for which a disable queue AQ call has to be made in
 258  * order to clean the Tx scheduler as a part of the reset
 259  */
 260 enum ice_disq_rst_src {
 261         ICE_NO_RESET = 0,
 262         ICE_VM_RESET,
 263 };
 264
 265 /* PHY info such as phy_type, etc... */
 266 struct ice_phy_info {
 267         struct ice_link_status link_info;
 268         struct ice_link_status link_info_old;
 269         u64 phy_type_low;
 270         u64 phy_type_high;
 271         enum ice_media_type media_type;
 272         u8 get_link_info;
 273         /* Please refer to struct ice_aqc_get_link_status_data to get
 274          * detail of enable bit in curr_user_speed_req
 275          */
 276         u16 curr_user_speed_req;
 277         enum ice_fec_mode curr_user_fec_req;
 278         enum ice_fc_mode curr_user_fc_req;
 279         struct ice_aqc_set_phy_cfg_data curr_user_phy_cfg;
 280 };
 281
 282 #define ICE_MAX_NUM_MIRROR_RULES        64
 283
 284 /* protocol enumeration for filters */
 285 enum ice_fltr_ptype {
 286         /* NONE - used for undef/error */
 287         ICE_FLTR_PTYPE_NONF_NONE = 0,
 288         ICE_FLTR_PTYPE_NONF_IPV4_UDP,
 289         ICE_FLTR_PTYPE_NONF_IPV4_TCP,
 290         ICE_FLTR_PTYPE_NONF_IPV4_SCTP,
 291         ICE_FLTR_PTYPE_NONF_IPV4_OTHER,
 292         ICE_FLTR_PTYPE_NONF_IPV4_GTPU_IPV4_UDP,
 293         ICE_FLTR_PTYPE_NONF_IPV4_GTPU_IPV4_TCP,
 294         ICE_FLTR_PTYPE_NONF_IPV4_GTPU_IPV4_ICMP,
 295         ICE_FLTR_PTYPE_NONF_IPV4_GTPU_IPV4_OTHER,
 296         ICE_FLTR_PTYPE_FRAG_IPV4,
 297         ICE_FLTR_PTYPE_NONF_IPV6_UDP,
 298         ICE_FLTR_PTYPE_NONF_IPV6_TCP,
 299         ICE_FLTR_PTYPE_NONF_IPV6_SCTP,
 300         ICE_FLTR_PTYPE_NONF_IPV6_OTHER,
 301         ICE_FLTR_PTYPE_MAX,
 302 };
 303
 304 enum ice_fd_hw_seg {
 305         ICE_FD_HW_SEG_NON_TUN = 0,
 306         ICE_FD_HW_SEG_TUN,
 307         ICE_FD_HW_SEG_MAX,
 308 };
 309
 310 /* 2 VSI = 1 ICE_VSI_PF + 1 ICE_VSI_CTRL */
 311 #define ICE_MAX_FDIR_VSI_PER_FILTER     2
 312
 313 struct ice_fd_hw_prof {
 314         struct ice_flow_seg_info *fdir_seg[ICE_FD_HW_SEG_MAX];
 315         int cnt;
 316         u64 entry_h[ICE_MAX_FDIR_VSI_PER_FILTER][ICE_FD_HW_SEG_MAX];
 317         u16 vsi_h[ICE_MAX_FDIR_VSI_PER_FILTER];
 318 };
 319
 320 /* Common HW capabilities for SW use */
 321 struct ice_hw_common_caps {
 322         /* Write CSR protection */
 323         u64 wr_csr_prot;
 324         u32 switching_mode;
 325         /* switching mode supported - EVB switching (including cloud) */
 326 #define ICE_NVM_IMAGE_TYPE_EVB          0x0
 327
 328         /* Manageablity mode & supported protocols over MCTP */
 329         u32 mgmt_mode;
 330 #define ICE_MGMT_MODE_PASS_THRU_MODE_M          0xF
 331 #define ICE_MGMT_MODE_CTL_INTERFACE_M           0xF0
 332 #define ICE_MGMT_MODE_REDIR_SB_INTERFACE_M      0xF00
 333
 334         u32 mgmt_protocols_mctp;
 335 #define ICE_MGMT_MODE_PROTO_RSVD        BIT(0)
 336 #define ICE_MGMT_MODE_PROTO_PLDM        BIT(1)
 337 #define ICE_MGMT_MODE_PROTO_OEM         BIT(2)
 338 #define ICE_MGMT_MODE_PROTO_NC_SI       BIT(3)
 339
 340         u32 os2bmc;
 341         u32 valid_functions;
 342         /* DCB capabilities */
 343         u32 active_tc_bitmap;
 344         u32 maxtc;
 345
 346         /* RSS related capabilities */
 347         u32 rss_table_size;             /* 512 for PFs and 64 for VFs */
 348         u32 rss_table_entry_width;      /* RSS Entry width in bits */
 349
 350         /* Tx/Rx queues */
 351         u32 num_rxq;                    /* Number/Total Rx queues */
 352         u32 rxq_first_id;               /* First queue ID for Rx queues */
 353         u32 num_txq;                    /* Number/Total Tx queues */
 354         u32 txq_first_id;               /* First queue ID for Tx queues */
 355
 356         /* MSI-X vectors */
 357         u32 num_msix_vectors;
 358         u32 msix_vector_first_id;
 359
 360         /* Max MTU for function or device */
 361         u32 max_mtu;
 362
 363         /* WOL related */
 364         u32 num_wol_proxy_fltr;
 365         u32 wol_proxy_vsi_seid;
 366
 367         /* LED/SDP pin count */
 368         u32 led_pin_num;
 369         u32 sdp_pin_num;
 370
 371         /* LED/SDP - Supports up to 12 LED pins and 8 SDP signals */
 372 #define ICE_MAX_SUPPORTED_GPIO_LED      12
 373 #define ICE_MAX_SUPPORTED_GPIO_SDP      8
 374         u8 led[ICE_MAX_SUPPORTED_GPIO_LED];
 375         u8 sdp[ICE_MAX_SUPPORTED_GPIO_SDP];
 376
 377         /* EVB capabilities */
 378         u8 evb_802_1_qbg;               /* Edge Virtual Bridging */
 379         u8 evb_802_1_qbh;               /* Bridge Port Extension */
 380
 381         u8 dcb;
 382         u8 iscsi;
 383         u8 mgmt_cem;
 384
 385         /* WoL and APM support */
 386 #define ICE_WOL_SUPPORT_M               BIT(0)
 387 #define ICE_ACPI_PROG_MTHD_M            BIT(1)
 388 #define ICE_PROXY_SUPPORT_M             BIT(2)
 389         u8 apm_wol_support;
 390         u8 acpi_prog_mthd;
 391         u8 proxy_support;
 392 };
 393
 394 /* Function specific capabilities */
 395 struct ice_hw_func_caps {
 396         struct ice_hw_common_caps common_cap;
 397         u32 guar_num_vsi;
 398         u32 fd_fltr_guar;               /* Number of filters guaranteed */
 399         u32 fd_fltr_best_effort;        /* Number of best effort filters */
 400 };
 401
 402 /* Device wide capabilities */
 403 struct ice_hw_dev_caps {
 404         struct ice_hw_common_caps common_cap;
 405         u32 num_vsi_allocd_to_host;     /* Excluding EMP VSI */
 406         u32 num_flow_director_fltr;     /* Number of FD filters available */
 407         u32 num_funcs;
 408 };
 409
 410 /* Information about MAC such as address, etc... */
 411 struct ice_mac_info {
 412         u8 lan_addr[ETH_ALEN];
 413         u8 perm_addr[ETH_ALEN];
 414         u8 port_addr[ETH_ALEN];
 415         u8 wol_addr[ETH_ALEN];
 416 };
 417
 418 /* PCI bus types */
 419 enum ice_bus_type {
 420         ice_bus_unknown = 0,
 421         ice_bus_pci_express,
 422         ice_bus_embedded, /* Is device Embedded versus card */
 423         ice_bus_reserved
 424 };
 425
 426 /* PCI bus speeds */
 427 enum ice_pcie_bus_speed {
 428         ice_pcie_speed_unknown  = 0xff,
 429         ice_pcie_speed_2_5GT    = 0x14,
 430         ice_pcie_speed_5_0GT    = 0x15,
 431         ice_pcie_speed_8_0GT    = 0x16,
 432         ice_pcie_speed_16_0GT   = 0x17
 433 };
 434
 435 /* PCI bus widths */
 436 enum ice_pcie_link_width {
 437         ice_pcie_lnk_width_resrv        = 0x00,
 438         ice_pcie_lnk_x1                 = 0x01,
 439         ice_pcie_lnk_x2                 = 0x02,
 440         ice_pcie_lnk_x4                 = 0x04,
 441         ice_pcie_lnk_x8                 = 0x08,
 442         ice_pcie_lnk_x12                = 0x0C,
 443         ice_pcie_lnk_x16                = 0x10,
 444         ice_pcie_lnk_x32                = 0x20,
 445         ice_pcie_lnk_width_unknown      = 0xff,
 446 };
 447
 448 /* Reset types used to determine which kind of reset was requested. These
 449  * defines match what the RESET_TYPE field of the GLGEN_RSTAT register.
 450  * ICE_RESET_PFR does not match any RESET_TYPE field in the GLGEN_RSTAT register
 451  * because its reset source is different than the other types listed.
 452  */
 453 enum ice_reset_req {
 454         ICE_RESET_POR   = 0,
 455         ICE_RESET_INVAL = 0,
 456         ICE_RESET_CORER = 1,
 457         ICE_RESET_GLOBR = 2,
 458         ICE_RESET_EMPR  = 3,
 459         ICE_RESET_PFR   = 4,
 460 };
 461
 462 /* Bus parameters */
 463 struct ice_bus_info {
 464         enum ice_pcie_bus_speed speed;
 465         enum ice_pcie_link_width width;
 466         enum ice_bus_type type;
 467         u16 domain_num;
 468         u16 device;
 469         u8 func;
 470         u8 bus_num;
 471 };
 472
 473 /* Flow control (FC) parameters */
 474 struct ice_fc_info {
 475         enum ice_fc_mode current_mode;  /* FC mode in effect */
 476         enum ice_fc_mode req_mode;      /* FC mode requested by caller */
 477 };
 478
 479 /* NVM Information */
 480 struct ice_nvm_info {
 481         u32 eetrack;                    /* NVM data version */
 482         u32 oem_ver;                    /* OEM version info */
 483         u16 sr_words;                   /* Shadow RAM size in words */
 484         u16 ver;                        /* dev starter version */
 485         u8 blank_nvm_mode;              /* is NVM empty (no FW present)*/
 486 };
 487
 488 struct ice_link_default_override_tlv {
 489         u8 options;
 490 #define ICE_LINK_OVERRIDE_OPT_M         0x3F
 491 #define ICE_LINK_OVERRIDE_STRICT_MODE   BIT(0)
 492 #define ICE_LINK_OVERRIDE_EPCT_DIS      BIT(1)
 493 #define ICE_LINK_OVERRIDE_PORT_DIS      BIT(2)
 494 #define ICE_LINK_OVERRIDE_EN            BIT(3)
 495 #define ICE_LINK_OVERRIDE_AUTO_LINK_DIS BIT(4)
 496 #define ICE_LINK_OVERRIDE_EEE_EN        BIT(5)
 497         u8 phy_config;
 498 #define ICE_LINK_OVERRIDE_PHY_CFG_S     8
 499 #define ICE_LINK_OVERRIDE_PHY_CFG_M     (0xC3 << ICE_LINK_OVERRIDE_PHY_CFG_S)
 500 #define ICE_LINK_OVERRIDE_PAUSE_M       0x3
 501 #define ICE_LINK_OVERRIDE_LESM_EN       BIT(6)
 502 #define ICE_LINK_OVERRIDE_AUTO_FEC_EN   BIT(7)
 503         u8 fec_options;
 504 #define ICE_LINK_OVERRIDE_FEC_OPT_M     0xFF
 505         u8 rsvd1;
 506         u64 phy_type_low;
 507         u64 phy_type_high;
 508 };
 509
 510 #define ICE_NVM_VER_LEN 32
 511
 512 /* Max number of port to queue branches w.r.t topology */
 513 #define ICE_TXSCHED_MAX_BRANCHES ICE_MAX_TRAFFIC_CLASS
 514
 515 #define ice_for_each_traffic_class(_i)  \
 516         for ((_i) = 0; (_i) < ICE_MAX_TRAFFIC_CLASS; (_i)++)
 517
 518 /* ICE_DFLT_AGG_ID means that all new VM(s)/VSI node connects
 519  * to driver defined policy for default aggregator
 520  */
 521 #define ICE_INVAL_TEID 0xFFFFFFFF
 522 #define ICE_DFLT_AGG_ID 0
 523
 524 struct ice_sched_node {
 525         struct ice_sched_node *parent;
 526         struct ice_sched_node *sibling; /* next sibling in the same layer */
 527         struct ice_sched_node **children;
 528         struct ice_aqc_txsched_elem_data info;
 529         u32 agg_id;                     /* aggregator group ID */
 530         u16 vsi_handle;
 531         u8 in_use;                      /* suspended or in use */
 532         u8 tx_sched_layer;              /* Logical Layer (1-9) */
 533         u8 num_children;
 534         u8 tc_num;
 535         u8 owner;
 536 #define ICE_SCHED_NODE_OWNER_LAN        0
 537 #define ICE_SCHED_NODE_OWNER_AE         1
 538 #define ICE_SCHED_NODE_OWNER_RDMA       2
 539 };
 540
 541 /* Access Macros for Tx Sched Elements data */
 542 #define ICE_TXSCHED_GET_NODE_TEID(x) LE32_TO_CPU((x)->info.node_teid)
 543 #define ICE_TXSCHED_GET_PARENT_TEID(x) LE32_TO_CPU((x)->info.parent_teid)
 544 #define ICE_TXSCHED_GET_CIR_RL_ID(x)    \
 545         LE16_TO_CPU((x)->info.cir_bw.bw_profile_idx)
 546 #define ICE_TXSCHED_GET_EIR_RL_ID(x)    \
 547         LE16_TO_CPU((x)->info.eir_bw.bw_profile_idx)
 548 #define ICE_TXSCHED_GET_SRL_ID(x) LE16_TO_CPU((x)->info.srl_id)
 549 #define ICE_TXSCHED_GET_CIR_BWALLOC(x)  \
 550         LE16_TO_CPU((x)->info.cir_bw.bw_alloc)
 551 #define ICE_TXSCHED_GET_EIR_BWALLOC(x)  \
 552         LE16_TO_CPU((x)->info.eir_bw.bw_alloc)
 553
 554 struct ice_sched_rl_profile {
 555         u32 rate; /* In Kbps */
 556         struct ice_aqc_rl_profile_elem info;
 557 };
 558
 559 /* The aggregator type determines if identifier is for a VSI group,
 560  * aggregator group, aggregator of queues, or queue group.
 561  */
 562 enum ice_agg_type {
 563         ICE_AGG_TYPE_UNKNOWN = 0,
 564         ICE_AGG_TYPE_TC,
 565         ICE_AGG_TYPE_AGG, /* aggregator */
 566         ICE_AGG_TYPE_VSI,
 567         ICE_AGG_TYPE_QG,
 568         ICE_AGG_TYPE_Q
 569 };
 570
 571 /* Rate limit types */
 572 enum ice_rl_type {
 573         ICE_UNKNOWN_BW = 0,
 574         ICE_MIN_BW,             /* for CIR profile */
 575         ICE_MAX_BW,             /* for EIR profile */
 576         ICE_SHARED_BW           /* for shared profile */
 577 };
 578
 579 #define ICE_SCHED_MIN_BW                500             /* in Kbps */
 580 #define ICE_SCHED_MAX_BW                100000000       /* in Kbps */
 581 #define ICE_SCHED_DFLT_BW               0xFFFFFFFF      /* unlimited */
 582 #define ICE_SCHED_NO_PRIORITY           0
 583 #define ICE_SCHED_NO_BW_WT              0
 584 #define ICE_SCHED_DFLT_RL_PROF_ID       0
 585 #define ICE_SCHED_NO_SHARED_RL_PROF_ID  0xFFFF
 586 #define ICE_SCHED_DFLT_BW_WT            1
 587 #define ICE_SCHED_INVAL_PROF_ID         0xFFFF
 588 #define ICE_SCHED_DFLT_BURST_SIZE       (15 * 1024)     /* in bytes (15k) */
 589
 590 /* Access Macros for Tx Sched RL Profile data */
 591 #define ICE_TXSCHED_GET_RL_PROF_ID(p) LE16_TO_CPU((p)->info.profile_id)
 592 #define ICE_TXSCHED_GET_RL_MBS(p) LE16_TO_CPU((p)->info.max_burst_size)
 593 #define ICE_TXSCHED_GET_RL_MULTIPLIER(p) LE16_TO_CPU((p)->info.rl_multiply)
 594 #define ICE_TXSCHED_GET_RL_WAKEUP_MV(p) LE16_TO_CPU((p)->info.wake_up_calc)
 595 #define ICE_TXSCHED_GET_RL_ENCODE(p) LE16_TO_CPU((p)->info.rl_encode)
 596
 597 /* The following tree example shows the naming conventions followed under
 598  * ice_port_info struct for default scheduler tree topology.
 599  *
 600  *                 A tree on a port
 601  *                       *                ---> root node
 602  *        (TC0)/  /  /  / \  \  \  \(TC7) ---> num_branches (range:1- 8)
 603  *            *  *  *  *   *  *  *  *     |
 604  *           /                            |
 605  *          *                             |
 606  *         /                              |-> num_elements (range:1 - 9)
 607  *        *                               |   implies num_of_layers
 608  *       /                                |
 609  *   (a)*                                 |
 610  *
 611  *  (a) is the last_node_teid(not of type Leaf). A leaf node is created under
 612  *  (a) as child node where queues get added, add Tx/Rx queue admin commands;
 613  *  need TEID of (a) to add queues.
 614  *
 615  *  This tree
 616  *       -> has 8 branches (one for each TC)
 617  *       -> First branch (TC0) has 4 elements
 618  *       -> has 4 layers
 619  *       -> (a) is the topmost layer node created by firmware on branch 0
 620  *
 621  *  Note: Above asterisk tree covers only basic terminology and scenario.
 622  *  Refer to the documentation for more info.
 623  */
 624
 625  /* Data structure for saving BW information */
 626 enum ice_bw_type {
 627         ICE_BW_TYPE_PRIO,
 628         ICE_BW_TYPE_CIR,
 629         ICE_BW_TYPE_CIR_WT,
 630         ICE_BW_TYPE_EIR,
 631         ICE_BW_TYPE_EIR_WT,
 632         ICE_BW_TYPE_SHARED,
 633         ICE_BW_TYPE_CNT         /* This must be last */
 634 };
 635
 636 struct ice_bw {
 637         u32 bw;
 638         u16 bw_alloc;
 639 };
 640
 641 struct ice_bw_type_info {
 642         ice_declare_bitmap(bw_t_bitmap, ICE_BW_TYPE_CNT);
 643         u8 generic;
 644         struct ice_bw cir_bw;
 645         struct ice_bw eir_bw;
 646         u32 shared_bw;
 647 };
 648
 649 /* VSI queue context structure for given TC */
 650 struct ice_q_ctx {
 651         u16  q_handle;
 652         u32  q_teid;
 653         /* bw_t_info saves queue BW information */
 654         struct ice_bw_type_info bw_t_info;
 655 };
 656
 657 /* VSI type list entry to locate corresponding VSI/aggregator nodes */
 658 struct ice_sched_vsi_info {
 659         struct ice_sched_node *vsi_node[ICE_MAX_TRAFFIC_CLASS];
 660         struct ice_sched_node *ag_node[ICE_MAX_TRAFFIC_CLASS];
 661         u16 max_lanq[ICE_MAX_TRAFFIC_CLASS];
 662         /* bw_t_info saves VSI BW information */
 663         struct ice_bw_type_info bw_t_info[ICE_MAX_TRAFFIC_CLASS];
 664 };
 665
 666 /* CEE or IEEE 802.1Qaz ETS Configuration data */
 667 struct ice_dcb_ets_cfg {
 668         u8 willing;
 669         u8 cbs;
 670         u8 maxtcs;
 671         u8 prio_table[ICE_MAX_TRAFFIC_CLASS];
 672         u8 tcbwtable[ICE_MAX_TRAFFIC_CLASS];
 673         u8 tsatable[ICE_MAX_TRAFFIC_CLASS];
 674 };
 675
 676 /* CEE or IEEE 802.1Qaz PFC Configuration data */
 677 struct ice_dcb_pfc_cfg {
 678         u8 willing;
 679         u8 mbc;
 680         u8 pfccap;
 681         u8 pfcena;
 682 };
 683
 684 /* CEE or IEEE 802.1Qaz Application Priority data */
 685 struct ice_dcb_app_priority_table {
 686         u16 prot_id;
 687         u8 priority;
 688         u8 selector;
 689 };
 690
 691 #define ICE_MAX_USER_PRIORITY   8
 692 #define ICE_DCBX_MAX_APPS       32
 693 #define ICE_LLDPDU_SIZE         1500
 694 #define ICE_TLV_STATUS_OPER     0x1
 695 #define ICE_TLV_STATUS_SYNC     0x2
 696 #define ICE_TLV_STATUS_ERR      0x4
 697 #define ICE_APP_PROT_ID_FCOE    0x8906
 698 #define ICE_APP_PROT_ID_ISCSI   0x0cbc
 699 #define ICE_APP_PROT_ID_FIP     0x8914
 700 #define ICE_APP_SEL_ETHTYPE     0x1
 701 #define ICE_APP_SEL_TCPIP       0x2
 702 #define ICE_CEE_APP_SEL_ETHTYPE 0x0
 703 #define ICE_CEE_APP_SEL_TCPIP   0x1
 704
 705 struct ice_dcbx_cfg {
 706         u32 numapps;
 707         u32 tlv_status; /* CEE mode TLV status */
 708         struct ice_dcb_ets_cfg etscfg;
 709         struct ice_dcb_ets_cfg etsrec;
 710         struct ice_dcb_pfc_cfg pfc;
 711         struct ice_dcb_app_priority_table app[ICE_DCBX_MAX_APPS];
 712         u8 dcbx_mode;
 713 #define ICE_DCBX_MODE_CEE       0x1
 714 #define ICE_DCBX_MODE_IEEE      0x2
 715         u8 app_mode;
 716 #define ICE_DCBX_APPS_NON_WILLING       0x1
 717 };
 718
 719 struct ice_port_info {
 720         struct ice_sched_node *root;    /* Root Node per Port */
 721         struct ice_hw *hw;              /* back pointer to HW instance */
 722         u32 last_node_teid;             /* scheduler last node info */
 723         u16 sw_id;                      /* Initial switch ID belongs to port */
 724         u16 pf_vf_num;
 725         u8 port_state;
 726 #define ICE_SCHED_PORT_STATE_INIT       0x0
 727 #define ICE_SCHED_PORT_STATE_READY      0x1
 728         u8 lport;
 729 #define ICE_LPORT_MASK                  0xff
 730         u16 dflt_tx_vsi_rule_id;
 731         u16 dflt_tx_vsi_num;
 732         u16 dflt_rx_vsi_rule_id;
 733         u16 dflt_rx_vsi_num;
 734         struct ice_fc_info fc;
 735         struct ice_mac_info mac;
 736         struct ice_phy_info phy;
 737         struct ice_lock sched_lock;     /* protect access to TXSched tree */
 738         struct ice_sched_node *
 739                 sib_head[ICE_MAX_TRAFFIC_CLASS][ICE_AQC_TOPO_MAX_LEVEL_NUM];
 740         /* List contain profile ID(s) and other params per layer */
 741         struct LIST_HEAD_TYPE rl_prof_list[ICE_AQC_TOPO_MAX_LEVEL_NUM];
 742         struct ice_bw_type_info tc_node_bw_t_info[ICE_MAX_TRAFFIC_CLASS];
 743         struct ice_dcbx_cfg local_dcbx_cfg;     /* Oper/Local Cfg */
 744         /* DCBX info */
 745         struct ice_dcbx_cfg remote_dcbx_cfg;    /* Peer Cfg */
 746         struct ice_dcbx_cfg desired_dcbx_cfg;   /* CEE Desired Cfg */
 747         /* LLDP/DCBX Status */
 748         u8 dcbx_status:3;               /* see ICE_DCBX_STATUS_DIS */
 749         u8 is_sw_lldp:1;
 750         u8 is_vf:1;
 751 };
 752
 753 struct ice_switch_info {
 754         struct LIST_HEAD_TYPE vsi_list_map_head;
 755         struct ice_sw_recipe *recp_list;
 756         u16 prof_res_bm_init;
 757
 758         ice_declare_bitmap(prof_res_bm[ICE_MAX_NUM_PROFILES], ICE_MAX_FV_WORDS);
 759 };
 760
 761 /* Port hardware description */
 762 struct ice_hw {
 763         u8 *hw_addr;
 764         void *back;
 765         struct ice_aqc_layer_props *layer_info;
 766         struct ice_port_info *port_info;
 767         /* 2D Array for each Tx Sched RL Profile type */
 768         struct ice_sched_rl_profile **cir_profiles;
 769         struct ice_sched_rl_profile **eir_profiles;
 770         struct ice_sched_rl_profile **srl_profiles;
 771         /* PSM clock frequency for calculating RL profile params */
 772         u32 psm_clk_freq;
 773         u64 debug_mask;         /* BITMAP for debug mask */
 774         enum ice_mac_type mac_type;
 775
 776         u16 fd_ctr_base;        /* FD counter base index */
 777         /* pci info */
 778         u16 device_id;
 779         u16 vendor_id;
 780         u16 subsystem_device_id;
 781         u16 subsystem_vendor_id;
 782         u8 revision_id;
 783
 784         u8 pf_id;               /* device profile info */
 785
 786         u16 max_burst_size;     /* driver sets this value */
 787
 788         /* Tx Scheduler values */
 789         u8 num_tx_sched_layers;
 790         u8 num_tx_sched_phys_layers;
 791         u8 flattened_layers;
 792         u8 max_cgds;
 793         u8 sw_entry_point_layer;
 794         u16 max_children[ICE_AQC_TOPO_MAX_LEVEL_NUM];
 795         struct LIST_HEAD_TYPE agg_list; /* lists all aggregator */
 796         struct ice_vsi_ctx *vsi_ctx[ICE_MAX_VSI];
 797         u8 evb_veb;             /* true for VEB, false for VEPA */
 798         u8 reset_ongoing;       /* true if HW is in reset, false otherwise */
 799         struct ice_bus_info bus;
 800         struct ice_nvm_info nvm;
 801         struct ice_hw_dev_caps dev_caps;        /* device capabilities */
 802         struct ice_hw_func_caps func_caps;      /* function capabilities */
 803
 804         struct ice_switch_info *switch_info;    /* switch filter lists */
 805
 806         /* Control Queue info */
 807         struct ice_ctl_q_info adminq;
 808         struct ice_ctl_q_info mailboxq;
 809
 810         u8 api_branch;          /* API branch version */
 811         u8 api_maj_ver;         /* API major version */
 812         u8 api_min_ver;         /* API minor version */
 813         u8 api_patch;           /* API patch version */
 814         u8 fw_branch;           /* firmware branch version */
 815         u8 fw_maj_ver;          /* firmware major version */
 816         u8 fw_min_ver;          /* firmware minor version */
 817         u8 fw_patch;            /* firmware patch version */
 818         u32 fw_build;           /* firmware build number */
 819
 820 /* Device max aggregate bandwidths corresponding to the GL_PWR_MODE_CTL
 821  * register. Used for determining the ITR/INTRL granularity during
 822  * initialization.
 823  */
 824 #define ICE_MAX_AGG_BW_200G     0x0
 825 #define ICE_MAX_AGG_BW_100G     0X1
 826 #define ICE_MAX_AGG_BW_50G      0x2
 827 #define ICE_MAX_AGG_BW_25G      0x3
 828         /* ITR granularity for different speeds */
 829 #define ICE_ITR_GRAN_ABOVE_25   2
 830 #define ICE_ITR_GRAN_MAX_25     4
 831         /* ITR granularity in 1 us */
 832         u8 itr_gran;
 833         /* INTRL granularity for different speeds */
 834 #define ICE_INTRL_GRAN_ABOVE_25 4
 835 #define ICE_INTRL_GRAN_MAX_25   8
 836         /* INTRL granularity in 1 us */
 837         u8 intrl_gran;
 838
 839         u8 ucast_shared;        /* true if VSIs can share unicast addr */
 840
 841 #define ICE_PHY_PER_NAC         1
 842 #define ICE_MAX_QUAD            2
 843 #define ICE_NUM_QUAD_TYPE       2
 844 #define ICE_PORTS_PER_QUAD      4
 845 #define ICE_PHY_0_LAST_QUAD     1
 846 #define ICE_PORTS_PER_PHY       8
 847 #define ICE_NUM_EXTERNAL_PORTS          ICE_PORTS_PER_PHY
 848
 849         /* Active package version (currently active) */
 850         struct ice_pkg_ver active_pkg_ver;
 851         u8 active_pkg_name[ICE_PKG_NAME_SIZE];
 852         u8 active_pkg_in_nvm;
 853
 854         enum ice_aq_err pkg_dwnld_status;
 855
 856         /* Driver's package ver - (from the Metadata seg) */
 857         struct ice_pkg_ver pkg_ver;
 858         u8 pkg_name[ICE_PKG_NAME_SIZE];
 859
 860         /* Driver's Ice package version (from the Ice seg) */
 861         struct ice_pkg_ver ice_pkg_ver;
 862         u8 ice_pkg_name[ICE_PKG_NAME_SIZE];
 863
 864         /* Pointer to the ice segment */
 865         struct ice_seg *seg;
 866
 867         /* Pointer to allocated copy of pkg memory */
 868         u8 *pkg_copy;
 869         u32 pkg_size;
 870
 871         /* tunneling info */
 872         struct ice_tunnel_table tnl;
 873
 874         /* HW block tables */
 875         struct ice_blk_info blk[ICE_BLK_COUNT];
 876         struct ice_lock fl_profs_locks[ICE_BLK_COUNT];  /* lock fltr profiles */
 877         struct LIST_HEAD_TYPE fl_profs[ICE_BLK_COUNT];
 878         /* Flow Director filter info */
 879         int fdir_active_fltr;
 880
 881         struct ice_lock fdir_fltr_lock; /* protect Flow Director */
 882         struct LIST_HEAD_TYPE fdir_list_head;
 883
 884         /* Book-keeping of side-band filter count per flow-type.
 885          * This is used to detect and handle input set changes for
 886          * respective flow-type.
 887          */
 888         u16 fdir_fltr_cnt[ICE_FLTR_PTYPE_MAX];
 889
 890         struct ice_fd_hw_prof **fdir_prof;
 891         ice_declare_bitmap(fdir_perfect_fltr, ICE_FLTR_PTYPE_MAX);
 892         struct ice_lock rss_locks;      /* protect RSS configuration */
 893         struct LIST_HEAD_TYPE rss_list_head;
 894 };
 895
 896 /* Statistics collected by each port, VSI, VEB, and S-channel */
 897 struct ice_eth_stats {
 898         u64 rx_bytes;                   /* gorc */
 899         u64 rx_unicast;                 /* uprc */
 900         u64 rx_multicast;               /* mprc */
 901         u64 rx_broadcast;               /* bprc */
 902         u64 rx_discards;                /* rdpc */
 903         u64 rx_unknown_protocol;        /* rupp */
 904         u64 tx_bytes;                   /* gotc */
 905         u64 tx_unicast;                 /* uptc */
 906         u64 tx_multicast;               /* mptc */
 907         u64 tx_broadcast;               /* bptc */
 908         u64 tx_discards;                /* tdpc */
 909         u64 tx_errors;                  /* tepc */
 910         u64 rx_no_desc;                 /* repc */
 911         u64 rx_errors;                  /* repc */
 912 };
 913
 914 #define ICE_MAX_UP      8
 915
 916 /* Statistics collected per VEB per User Priority (UP) for up to 8 UPs */
 917 struct ice_veb_up_stats {
 918         u64 up_rx_pkts[ICE_MAX_UP];
 919         u64 up_rx_bytes[ICE_MAX_UP];
 920         u64 up_tx_pkts[ICE_MAX_UP];
 921         u64 up_tx_bytes[ICE_MAX_UP];
 922 };
 923
 924 /* Statistics collected by the MAC */
 925 struct ice_hw_port_stats {
 926         /* eth stats collected by the port */
 927         struct ice_eth_stats eth;
 928         /* additional port specific stats */
 929         u64 tx_dropped_link_down;       /* tdold */
 930         u64 crc_errors;                 /* crcerrs */
 931         u64 illegal_bytes;              /* illerrc */
 932         u64 error_bytes;                /* errbc */
 933         u64 mac_local_faults;           /* mlfc */
 934         u64 mac_remote_faults;          /* mrfc */
 935         u64 rx_len_errors;              /* rlec */
 936         u64 link_xon_rx;                /* lxonrxc */
 937         u64 link_xoff_rx;               /* lxoffrxc */
 938         u64 link_xon_tx;                /* lxontxc */
 939         u64 link_xoff_tx;               /* lxofftxc */
 940         u64 priority_xon_rx[8];         /* pxonrxc[8] */
 941         u64 priority_xoff_rx[8];        /* pxoffrxc[8] */
 942         u64 priority_xon_tx[8];         /* pxontxc[8] */
 943         u64 priority_xoff_tx[8];        /* pxofftxc[8] */
 944         u64 priority_xon_2_xoff[8];     /* pxon2offc[8] */
 945         u64 rx_size_64;                 /* prc64 */
 946         u64 rx_size_127;                /* prc127 */
 947         u64 rx_size_255;                /* prc255 */
 948         u64 rx_size_511;                /* prc511 */
 949         u64 rx_size_1023;               /* prc1023 */
 950         u64 rx_size_1522;               /* prc1522 */
 951         u64 rx_size_big;                /* prc9522 */
 952         u64 rx_undersize;               /* ruc */
 953         u64 rx_fragments;               /* rfc */
 954         u64 rx_oversize;                /* roc */
 955         u64 rx_jabber;                  /* rjc */
 956         u64 tx_size_64;                 /* ptc64 */
 957         u64 tx_size_127;                /* ptc127 */
 958         u64 tx_size_255;                /* ptc255 */
 959         u64 tx_size_511;                /* ptc511 */
 960         u64 tx_size_1023;               /* ptc1023 */
 961         u64 tx_size_1522;               /* ptc1522 */
 962         u64 tx_size_big;                /* ptc9522 */
 963         u64 mac_short_pkt_dropped;      /* mspdc */
 964         /* flow director stats */
 965         u32 fd_sb_status;
 966         u64 fd_sb_match;
 967 };
 968
 969 enum ice_sw_fwd_act_type {
 970         ICE_FWD_TO_VSI = 0,
 971         ICE_FWD_TO_VSI_LIST, /* Do not use this when adding filter */
 972         ICE_FWD_TO_Q,
 973         ICE_FWD_TO_QGRP,
 974         ICE_DROP_PACKET,
 975         ICE_INVAL_ACT
 976 };
 977
 978 /* Checksum and Shadow RAM pointers */
 979 #define ICE_SR_NVM_CTRL_WORD                    0x00
 980 #define ICE_SR_PHY_ANALOG_PTR                   0x04
 981 #define ICE_SR_OPTION_ROM_PTR                   0x05
 982 #define ICE_SR_RO_PCIR_REGS_AUTO_LOAD_PTR       0x06
 983 #define ICE_SR_AUTO_GENERATED_POINTERS_PTR      0x07
 984 #define ICE_SR_PCIR_REGS_AUTO_LOAD_PTR          0x08
 985 #define ICE_SR_EMP_GLOBAL_MODULE_PTR            0x09
 986 #define ICE_SR_EMP_IMAGE_PTR                    0x0B
 987 #define ICE_SR_PE_IMAGE_PTR                     0x0C
 988 #define ICE_SR_CSR_PROTECTED_LIST_PTR           0x0D
 989 #define ICE_SR_MNG_CFG_PTR                      0x0E
 990 #define ICE_SR_EMP_MODULE_PTR                   0x0F
 991 #define ICE_SR_PBA_BLOCK_PTR                    0x16
 992 #define ICE_SR_BOOT_CFG_PTR                     0x132
 993 #define ICE_SR_NVM_WOL_CFG                      0x19
 994 #define ICE_NVM_OEM_VER_OFF                     0x02
 995 #define ICE_SR_NVM_DEV_STARTER_VER              0x18
 996 #define ICE_SR_ALTERNATE_SAN_MAC_ADDR_PTR       0x27
 997 #define ICE_SR_PERMANENT_SAN_MAC_ADDR_PTR       0x28
 998 #define ICE_SR_NVM_MAP_VER                      0x29
 999 #define ICE_SR_NVM_IMAGE_VER                    0x2A
1000 #define ICE_SR_NVM_STRUCTURE_VER                0x2B
1001 #define ICE_SR_NVM_EETRACK_LO                   0x2D
1002 #define ICE_SR_NVM_EETRACK_HI                   0x2E
1003 #define ICE_NVM_VER_LO_SHIFT                    0
1004 #define ICE_NVM_VER_LO_MASK                     (0xff << ICE_NVM_VER_LO_SHIFT)
1005 #define ICE_NVM_VER_HI_SHIFT                    12
1006 #define ICE_NVM_VER_HI_MASK                     (0xf << ICE_NVM_VER_HI_SHIFT)
1007 #define ICE_OEM_EETRACK_ID                      0xffffffff
1008 #define ICE_OEM_VER_PATCH_SHIFT                 0
1009 #define ICE_OEM_VER_PATCH_MASK          (0xff << ICE_OEM_VER_PATCH_SHIFT)
1010 #define ICE_OEM_VER_BUILD_SHIFT                 8
1011 #define ICE_OEM_VER_BUILD_MASK          (0xffff << ICE_OEM_VER_BUILD_SHIFT)
1012 #define ICE_OEM_VER_SHIFT                       24
1013 #define ICE_OEM_VER_MASK                        (0xff << ICE_OEM_VER_SHIFT)
1014 #define ICE_SR_VPD_PTR                          0x2F
1015 #define ICE_SR_PXE_SETUP_PTR                    0x30
1016 #define ICE_SR_PXE_CFG_CUST_OPTIONS_PTR         0x31
1017 #define ICE_SR_NVM_ORIGINAL_EETRACK_LO          0x34
1018 #define ICE_SR_NVM_ORIGINAL_EETRACK_HI          0x35
1019 #define ICE_SR_VLAN_CFG_PTR                     0x37
1020 #define ICE_SR_POR_REGS_AUTO_LOAD_PTR           0x38
1021 #define ICE_SR_EMPR_REGS_AUTO_LOAD_PTR          0x3A
1022 #define ICE_SR_GLOBR_REGS_AUTO_LOAD_PTR         0x3B
1023 #define ICE_SR_CORER_REGS_AUTO_LOAD_PTR         0x3C
1024 #define ICE_SR_PHY_CFG_SCRIPT_PTR               0x3D
1025 #define ICE_SR_PCIE_ALT_AUTO_LOAD_PTR           0x3E
1026 #define ICE_SR_SW_CHECKSUM_WORD                 0x3F
1027 #define ICE_SR_PFA_PTR                          0x40
1028 #define ICE_SR_1ST_SCRATCH_PAD_PTR              0x41
1029 #define ICE_SR_1ST_NVM_BANK_PTR                 0x42
1030 #define ICE_SR_NVM_BANK_SIZE                    0x43
1031 #define ICE_SR_1ND_OROM_BANK_PTR                0x44
1032 #define ICE_SR_OROM_BANK_SIZE                   0x45
1033 #define ICE_SR_NETLIST_BANK_PTR                 0x46
1034 #define ICE_SR_NETLIST_BANK_SIZE                0x47
1035 #define ICE_SR_EMP_SR_SETTINGS_PTR              0x48
1036 #define ICE_SR_CONFIGURATION_METADATA_PTR       0x4D
1037 #define ICE_SR_IMMEDIATE_VALUES_PTR             0x4E
1038 #define ICE_SR_LINK_DEFAULT_OVERRIDE_PTR        0x134
1039 #define ICE_SR_POR_REGISTERS_AUTOLOAD_PTR       0x118
1040
1041 /* Auxiliary field, mask and shift definition for Shadow RAM and NVM Flash */
1042 #define ICE_SR_VPD_SIZE_WORDS           512
1043 #define ICE_SR_PCIE_ALT_SIZE_WORDS      512
1044 #define ICE_SR_CTRL_WORD_1_S            0x06
1045 #define ICE_SR_CTRL_WORD_1_M            (0x03 << ICE_SR_CTRL_WORD_1_S)
1046
1047 /* Shadow RAM related */
1048 #define ICE_SR_SECTOR_SIZE_IN_WORDS     0x800
1049 #define ICE_SR_BUF_ALIGNMENT            4096
1050 #define ICE_SR_WORDS_IN_1KB             512
1051 /* Checksum should be calculated such that after adding all the words,
1052  * including the checksum word itself, the sum should be 0xBABA.
1053  */
1054 #define ICE_SR_SW_CHECKSUM_BASE         0xBABA
1055
1056 /* Link override related */
1057 #define ICE_SR_PFA_LINK_OVERRIDE_WORDS          10
1058 #define ICE_SR_PFA_LINK_OVERRIDE_PHY_WORDS      4
1059 #define ICE_SR_PFA_LINK_OVERRIDE_OFFSET         2
1060 #define ICE_SR_PFA_LINK_OVERRIDE_FEC_OFFSET     1
1061 #define ICE_SR_PFA_LINK_OVERRIDE_PHY_OFFSET     2
1062 #define ICE_FW_API_LINK_OVERRIDE_MAJ            1
1063 #define ICE_FW_API_LINK_OVERRIDE_MIN            5
1064 #define ICE_FW_API_LINK_OVERRIDE_PATCH          2
1065
1066 #define ICE_PBA_FLAG_DFLT               0xFAFA
1067 /* Hash redirection LUT for VSI - maximum array size */
1068 #define ICE_VSIQF_HLUT_ARRAY_SIZE       ((VSIQF_HLUT_MAX_INDEX + 1) * 4)
1069
1070 /*
1071  * Defines for values in the VF_PE_DB_SIZE bits in the GLPCI_LBARCTRL register.
1072  * This is needed to determine the BAR0 space for the VFs
1073  */
1074 #define GLPCI_LBARCTRL_VF_PE_DB_SIZE_0KB 0x0
1075 #define GLPCI_LBARCTRL_VF_PE_DB_SIZE_8KB 0x1
1076 #define GLPCI_LBARCTRL_VF_PE_DB_SIZE_64KB 0x2
1077
1078 #endif /* _ICE_TYPE_H_ */