drivers/net/ice/base/ice_type.h

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