net/ice/base: add basic structures
authorPaul M Stillwell Jr <paul.m.stillwell.jr@intel.com>
Tue, 18 Dec 2018 08:46:11 +0000 (16:46 +0800)
committerFerruh Yigit <ferruh.yigit@intel.com>
Fri, 21 Dec 2018 15:22:40 +0000 (16:22 +0100)
Add the structures required by the NIC.

Signed-off-by: Paul M Stillwell Jr <paul.m.stillwell.jr@intel.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
drivers/net/ice/base/ice_type.h [new file with mode: 0644]

diff --git a/drivers/net/ice/base/ice_type.h b/drivers/net/ice/base/ice_type.h
new file mode 100644 (file)
index 0000000..256bf3f
--- /dev/null
@@ -0,0 +1,869 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2001-2018
+ */
+
+#ifndef _ICE_TYPE_H_
+#define _ICE_TYPE_H_
+
+#define ETH_ALEN       6
+
+#define ETH_HEADER_LEN 14
+
+#define BIT(a) (1UL << (a))
+#define BIT_ULL(a) (1ULL << (a))
+
+#define BITS_PER_BYTE  8
+
+#define ICE_BYTES_PER_WORD     2
+#define ICE_BYTES_PER_DWORD    4
+#define ICE_MAX_TRAFFIC_CLASS  8
+
+
+#include "ice_status.h"
+#include "ice_hw_autogen.h"
+#include "ice_devids.h"
+#include "ice_osdep.h"
+#include "ice_controlq.h"
+#include "ice_lan_tx_rx.h"
+#include "ice_flex_type.h"
+#include "ice_protocol_type.h"
+
+static inline bool ice_is_tc_ena(ice_bitmap_t bitmap, u8 tc)
+{
+       return ice_is_bit_set(&bitmap, tc);
+}
+
+#ifndef DIV_64BIT
+#define DIV_64BIT(n, d) ((n) / (d))
+#endif /* DIV_64BIT */
+
+static inline u64 round_up_64bit(u64 a, u32 b)
+{
+       return DIV_64BIT(((a) + (b) / 2), (b));
+}
+
+static inline u32 ice_round_to_num(u32 N, u32 R)
+{
+       return ((((N) % (R)) < ((R) / 2)) ? (((N) / (R)) * (R)) :
+               ((((N) + (R) - 1) / (R)) * (R)));
+}
+
+/* Driver always calls main vsi_handle first */
+#define ICE_MAIN_VSI_HANDLE            0
+
+/* Switch from ms to the 1usec global time (this is the GTIME resolution) */
+#define ICE_MS_TO_GTIME(time)          ((time) * 1000)
+
+/* Data type manipulation macros. */
+#define ICE_HI_DWORD(x)                ((u32)((((x) >> 16) >> 16) & 0xFFFFFFFF))
+#define ICE_LO_DWORD(x)                ((u32)((x) & 0xFFFFFFFF))
+#define ICE_HI_WORD(x)         ((u16)(((x) >> 16) & 0xFFFF))
+
+/* debug masks - set these bits in hw->debug_mask to control output */
+#define ICE_DBG_INIT           BIT_ULL(1)
+#define ICE_DBG_RELEASE                BIT_ULL(2)
+
+#define ICE_DBG_LINK           BIT_ULL(4)
+#define ICE_DBG_PHY            BIT_ULL(5)
+#define ICE_DBG_QCTX           BIT_ULL(6)
+#define ICE_DBG_NVM            BIT_ULL(7)
+#define ICE_DBG_LAN            BIT_ULL(8)
+#define ICE_DBG_FLOW           BIT_ULL(9)
+#define ICE_DBG_DCB            BIT_ULL(10)
+#define ICE_DBG_DIAG           BIT_ULL(11)
+#define ICE_DBG_FD             BIT_ULL(12)
+#define ICE_DBG_SW             BIT_ULL(13)
+#define ICE_DBG_SCHED          BIT_ULL(14)
+
+#define ICE_DBG_PKG            BIT_ULL(16)
+#define ICE_DBG_RES            BIT_ULL(17)
+#define ICE_DBG_AQ_MSG         BIT_ULL(24)
+#define ICE_DBG_AQ_DESC                BIT_ULL(25)
+#define ICE_DBG_AQ_DESC_BUF    BIT_ULL(26)
+#define ICE_DBG_AQ_CMD         BIT_ULL(27)
+#define ICE_DBG_AQ             (ICE_DBG_AQ_MSG         | \
+                                ICE_DBG_AQ_DESC        | \
+                                ICE_DBG_AQ_DESC_BUF    | \
+                                ICE_DBG_AQ_CMD)
+
+#define ICE_DBG_USER           BIT_ULL(31)
+#define ICE_DBG_ALL            0xFFFFFFFFFFFFFFFFULL
+
+
+
+
+
+
+enum ice_aq_res_ids {
+       ICE_NVM_RES_ID = 1,
+       ICE_SPD_RES_ID,
+       ICE_CHANGE_LOCK_RES_ID,
+       ICE_GLOBAL_CFG_LOCK_RES_ID
+};
+
+/* FW update timeout definitions are in milliseconds */
+#define ICE_NVM_TIMEOUT                        180000
+#define ICE_CHANGE_LOCK_TIMEOUT                1000
+#define ICE_GLOBAL_CFG_LOCK_TIMEOUT    3000
+
+enum ice_aq_res_access_type {
+       ICE_RES_READ = 1,
+       ICE_RES_WRITE
+};
+
+struct ice_driver_ver {
+       u8 major_ver;
+       u8 minor_ver;
+       u8 build_ver;
+       u8 subbuild_ver;
+       u8 driver_string[32];
+};
+
+enum ice_fc_mode {
+       ICE_FC_NONE = 0,
+       ICE_FC_RX_PAUSE,
+       ICE_FC_TX_PAUSE,
+       ICE_FC_FULL,
+       ICE_FC_PFC,
+       ICE_FC_DFLT
+};
+
+enum ice_fec_mode {
+       ICE_FEC_NONE = 0,
+       ICE_FEC_RS,
+       ICE_FEC_BASER,
+       ICE_FEC_AUTO
+};
+
+enum ice_set_fc_aq_failures {
+       ICE_SET_FC_AQ_FAIL_NONE = 0,
+       ICE_SET_FC_AQ_FAIL_GET,
+       ICE_SET_FC_AQ_FAIL_SET,
+       ICE_SET_FC_AQ_FAIL_UPDATE
+};
+
+/* These are structs for managing the hardware information and the operations */
+/* MAC types */
+enum ice_mac_type {
+       ICE_MAC_UNKNOWN = 0,
+       ICE_MAC_GENERIC,
+};
+
+/* Media Types */
+enum ice_media_type {
+       ICE_MEDIA_UNKNOWN = 0,
+       ICE_MEDIA_FIBER,
+       ICE_MEDIA_BASET,
+       ICE_MEDIA_BACKPLANE,
+       ICE_MEDIA_DA,
+};
+
+/* Software VSI types. */
+enum ice_vsi_type {
+       ICE_VSI_PF = 0,
+#ifdef ADQ_SUPPORT
+       ICE_VSI_CHNL = 4,
+#endif /* ADQ_SUPPORT */
+};
+
+struct ice_link_status {
+       /* Refer to ice_aq_phy_type for bits definition */
+       u64 phy_type_low;
+       u64 phy_type_high;
+       u8 topo_media_conflict;
+       u16 max_frame_size;
+       u16 link_speed;
+       u16 req_speeds;
+       u8 lse_ena;     /* Link Status Event notification */
+       u8 link_info;
+       u8 an_info;
+       u8 ext_info;
+       u8 fec_info;
+       u8 pacing;
+       /* Refer to #define from module_type[ICE_MODULE_TYPE_TOTAL_BYTE] of
+        * ice_aqc_get_phy_caps structure
+        */
+       u8 module_type[ICE_MODULE_TYPE_TOTAL_BYTE];
+};
+
+/* Different data queue types: These are mainly for SW consumption. */
+enum ice_q {
+       ICE_DATA_Q_DOORBELL,
+       ICE_DATA_Q_CMPL,
+       ICE_DATA_Q_QUANTA,
+       ICE_DATA_Q_RX,
+       ICE_DATA_Q_TX,
+};
+
+/* Different reset sources for which a disable queue AQ call has to be made in
+ * order to clean the TX scheduler as a part of the reset
+ */
+enum ice_disq_rst_src {
+       ICE_NO_RESET = 0,
+       ICE_VM_RESET,
+};
+
+/* PHY info such as phy_type, etc... */
+struct ice_phy_info {
+       struct ice_link_status link_info;
+       struct ice_link_status link_info_old;
+       u64 phy_type_low;
+       u64 phy_type_high;
+       enum ice_media_type media_type;
+       u8 get_link_info;
+};
+
+#define ICE_MAX_NUM_MIRROR_RULES       64
+
+/* Common HW capabilities for SW use */
+struct ice_hw_common_caps {
+       /* Write CSR protection */
+       u64 wr_csr_prot;
+       u32 switching_mode;
+       /* switching mode supported - EVB switching (including cloud) */
+#define ICE_NVM_IMAGE_TYPE_EVB         0x0
+
+       /* Manageablity mode & supported protocols over MCTP */
+       u32 mgmt_mode;
+#define ICE_MGMT_MODE_PASS_THRU_MODE_M         0xF
+#define ICE_MGMT_MODE_CTL_INTERFACE_M          0xF0
+#define ICE_MGMT_MODE_REDIR_SB_INTERFACE_M     0xF00
+
+       u32 mgmt_protocols_mctp;
+#define ICE_MGMT_MODE_PROTO_RSVD       BIT(0)
+#define ICE_MGMT_MODE_PROTO_PLDM       BIT(1)
+#define ICE_MGMT_MODE_PROTO_OEM                BIT(2)
+#define ICE_MGMT_MODE_PROTO_NC_SI      BIT(3)
+
+       u32 os2bmc;
+       u32 valid_functions;
+
+       /* RSS related capabilities */
+       u32 rss_table_size;             /* 512 for PFs and 64 for VFs */
+       u32 rss_table_entry_width;      /* RSS Entry width in bits */
+
+       /* TX/RX queues */
+       u32 num_rxq;                    /* Number/Total RX queues */
+       u32 rxq_first_id;               /* First queue ID for RX queues */
+       u32 num_txq;                    /* Number/Total TX queues */
+       u32 txq_first_id;               /* First queue ID for TX queues */
+
+       /* MSI-X vectors */
+       u32 num_msix_vectors;
+       u32 msix_vector_first_id;
+
+       /* Max MTU for function or device */
+       u32 max_mtu;
+
+       /* WOL related */
+       u32 num_wol_proxy_fltr;
+       u32 wol_proxy_vsi_seid;
+
+       /* LED/SDP pin count */
+       u32 led_pin_num;
+       u32 sdp_pin_num;
+
+       /* LED/SDP - Supports up to 12 LED pins and 8 SDP signals */
+#define ICE_MAX_SUPPORTED_GPIO_LED     12
+#define ICE_MAX_SUPPORTED_GPIO_SDP     8
+       u8 led[ICE_MAX_SUPPORTED_GPIO_LED];
+       u8 sdp[ICE_MAX_SUPPORTED_GPIO_SDP];
+
+       /* EVB capabilities */
+       u8 evb_802_1_qbg;               /* Edge Virtual Bridging */
+       u8 evb_802_1_qbh;               /* Bridge Port Extension */
+
+       u8 iscsi;
+       u8 mgmt_cem;
+
+       /* WoL and APM support */
+#define ICE_WOL_SUPPORT_M              BIT(0)
+#define ICE_ACPI_PROG_MTHD_M           BIT(1)
+#define ICE_PROXY_SUPPORT_M            BIT(2)
+       u8 apm_wol_support;
+       u8 acpi_prog_mthd;
+       u8 proxy_support;
+};
+
+
+/* Function specific capabilities */
+struct ice_hw_func_caps {
+       struct ice_hw_common_caps common_cap;
+       u32 guar_num_vsi;
+};
+
+/* Device wide capabilities */
+struct ice_hw_dev_caps {
+       struct ice_hw_common_caps common_cap;
+       u32 num_vsi_allocd_to_host;     /* Excluding EMP VSI */
+};
+
+
+/* Information about MAC such as address, etc... */
+struct ice_mac_info {
+       u8 lan_addr[ETH_ALEN];
+       u8 perm_addr[ETH_ALEN];
+       u8 port_addr[ETH_ALEN];
+       u8 wol_addr[ETH_ALEN];
+};
+
+/* PCI bus types */
+enum ice_bus_type {
+       ice_bus_unknown = 0,
+       ice_bus_pci_express,
+       ice_bus_embedded, /* Is device Embedded versus card */
+       ice_bus_reserved
+};
+
+/* PCI bus speeds */
+enum ice_pcie_bus_speed {
+       ice_pcie_speed_unknown  = 0xff,
+       ice_pcie_speed_2_5GT    = 0x14,
+       ice_pcie_speed_5_0GT    = 0x15,
+       ice_pcie_speed_8_0GT    = 0x16,
+       ice_pcie_speed_16_0GT   = 0x17
+};
+
+/* PCI bus widths */
+enum ice_pcie_link_width {
+       ice_pcie_lnk_width_resrv        = 0x00,
+       ice_pcie_lnk_x1                 = 0x01,
+       ice_pcie_lnk_x2                 = 0x02,
+       ice_pcie_lnk_x4                 = 0x04,
+       ice_pcie_lnk_x8                 = 0x08,
+       ice_pcie_lnk_x12                = 0x0C,
+       ice_pcie_lnk_x16                = 0x10,
+       ice_pcie_lnk_x32                = 0x20,
+       ice_pcie_lnk_width_unknown      = 0xff,
+};
+
+/* Reset types used to determine which kind of reset was requested. These
+ * defines match what the RESET_TYPE field of the GLGEN_RSTAT register.
+ * ICE_RESET_PFR does not match any RESET_TYPE field in the GLGEN_RSTAT register
+ * because its reset source is different than the other types listed.
+ */
+enum ice_reset_req {
+       ICE_RESET_POR   = 0,
+       ICE_RESET_INVAL = 0,
+       ICE_RESET_CORER = 1,
+       ICE_RESET_GLOBR = 2,
+       ICE_RESET_EMPR  = 3,
+       ICE_RESET_PFR   = 4,
+};
+
+/* Bus parameters */
+struct ice_bus_info {
+       enum ice_pcie_bus_speed speed;
+       enum ice_pcie_link_width width;
+       enum ice_bus_type type;
+       u16 domain_num;
+       u16 device;
+       u8 func;
+       u8 bus_num;
+};
+
+/* Flow control (FC) parameters */
+struct ice_fc_info {
+       enum ice_fc_mode current_mode;  /* FC mode in effect */
+       enum ice_fc_mode req_mode;      /* FC mode requested by caller */
+};
+
+/* NVM Information */
+struct ice_nvm_info {
+       u32 eetrack;                    /* NVM data version */
+       u32 oem_ver;                    /* OEM version info */
+       u16 sr_words;                   /* Shadow RAM size in words */
+       u16 ver;                        /* NVM package version */
+       u8 blank_nvm_mode;              /* is NVM empty (no FW present)*/
+};
+
+/* Max number of port to queue branches w.r.t topology */
+#define ICE_TXSCHED_MAX_BRANCHES ICE_MAX_TRAFFIC_CLASS
+/* ICE_DFLT_AGG_ID means that all new VM(s)/VSI node connects
+ * to driver defined policy for default aggregator
+ */
+#define ICE_INVAL_TEID 0xFFFFFFFF
+#define ICE_DFLT_AGG_ID 0
+
+struct ice_sched_node {
+       struct ice_sched_node *parent;
+       struct ice_sched_node *sibling; /* next sibling in the same layer */
+       struct ice_sched_node **children;
+       struct ice_aqc_txsched_elem_data info;
+       u32 agg_id;                     /* aggregator group id */
+       u16 vsi_handle;
+       u8 in_use;                      /* suspended or in use */
+       u8 tx_sched_layer;              /* Logical Layer (1-9) */
+       u8 num_children;
+       u8 tc_num;
+       u8 owner;
+#define ICE_SCHED_NODE_OWNER_LAN       0
+#define ICE_SCHED_NODE_OWNER_AE                1
+#define ICE_SCHED_NODE_OWNER_RDMA      2
+};
+
+/* Access Macros for Tx Sched Elements data */
+#define ICE_TXSCHED_GET_NODE_TEID(x) LE32_TO_CPU((x)->info.node_teid)
+#define ICE_TXSCHED_GET_PARENT_TEID(x) LE32_TO_CPU((x)->info.parent_teid)
+#define ICE_TXSCHED_GET_CIR_RL_ID(x)   \
+       LE16_TO_CPU((x)->info.cir_bw.bw_profile_idx)
+#define ICE_TXSCHED_GET_EIR_RL_ID(x)   \
+       LE16_TO_CPU((x)->info.eir_bw.bw_profile_idx)
+#define ICE_TXSCHED_GET_SRL_ID(x) LE16_TO_CPU((x)->info.srl_id)
+#define ICE_TXSCHED_GET_CIR_BWALLOC(x) \
+       LE16_TO_CPU((x)->info.cir_bw.bw_alloc)
+#define ICE_TXSCHED_GET_EIR_BWALLOC(x) \
+       LE16_TO_CPU((x)->info.eir_bw.bw_alloc)
+
+struct ice_sched_rl_profle {
+       u32 rate; /* In Kbps */
+       struct ice_aqc_rl_profile_elem info;
+};
+
+/* The aggregator type determines if identifier is for a VSI group,
+ * aggregator group, aggregator of queues, or queue group.
+ */
+enum ice_agg_type {
+       ICE_AGG_TYPE_UNKNOWN = 0,
+       ICE_AGG_TYPE_TC,
+       ICE_AGG_TYPE_AGG, /* aggregator */
+       ICE_AGG_TYPE_VSI,
+       ICE_AGG_TYPE_QG,
+       ICE_AGG_TYPE_Q
+};
+
+/* Rate limit types */
+enum ice_rl_type {
+       ICE_UNKNOWN_BW = 0,
+       ICE_MIN_BW,             /* for cir profile */
+       ICE_MAX_BW,             /* for eir profile */
+       ICE_SHARED_BW           /* for shared profile */
+};
+
+#define ICE_SCHED_MIN_BW               500             /* in Kbps */
+#define ICE_SCHED_MAX_BW               100000000       /* in Kbps */
+#define ICE_SCHED_DFLT_BW              0xFFFFFFFF      /* unlimited */
+#define ICE_SCHED_NO_PRIORITY          0
+#define ICE_SCHED_NO_BW_WT             0
+#define ICE_SCHED_DFLT_RL_PROF_ID      0
+#define ICE_SCHED_NO_SHARED_RL_PROF_ID 0xFFFF
+#define ICE_SCHED_DFLT_BW_WT           1
+#define ICE_SCHED_INVAL_PROF_ID                0xFFFF
+#define ICE_SCHED_DFLT_BURST_SIZE      (15 * 1024)     /* in bytes (15k) */
+
+/* Access Macros for Tx Sched RL Profile data */
+#define ICE_TXSCHED_GET_RL_PROF_ID(p) LE16_TO_CPU((p)->info.profile_id)
+#define ICE_TXSCHED_GET_RL_MBS(p) LE16_TO_CPU((p)->info.max_burst_size)
+#define ICE_TXSCHED_GET_RL_MULTIPLIER(p) LE16_TO_CPU((p)->info.rl_multiply)
+#define ICE_TXSCHED_GET_RL_WAKEUP_MV(p) LE16_TO_CPU((p)->info.wake_up_calc)
+#define ICE_TXSCHED_GET_RL_ENCODE(p) LE16_TO_CPU((p)->info.rl_encode)
+
+
+/* The following tree example shows the naming conventions followed under
+ * ice_port_info struct for default scheduler tree topology.
+ *
+ *                 A tree on a port
+ *                       *                ---> root node
+ *        (TC0)/  /  /  / \  \  \  \(TC7) ---> num_branches (range:1- 8)
+ *            *  *  *  *   *  *  *  *     |
+ *           /                            |
+ *          *                             |
+ *         /                              |-> num_elements (range:1 - 9)
+ *        *                               |   implies num_of_layers
+ *       /                                |
+ *   (a)*                                 |
+ *
+ *  (a) is the last_node_teid(not of type Leaf). A leaf node is created under
+ *  (a) as child node where queues get added, add Tx/Rx queue admin commands;
+ *  need teid of (a) to add queues.
+ *
+ *  This tree
+ *       -> has 8 branches (one for each TC)
+ *       -> First branch (TC0) has 4 elements
+ *       -> has 4 layers
+ *       -> (a) is the topmost layer node created by firmware on branch 0
+ *
+ *  Note: Above asterisk tree covers only basic terminology and scenario.
+ *  Refer to the documentation for more info.
+ */
+
+ /* Data structure for saving bw information */
+enum ice_bw_type {
+       ICE_BW_TYPE_PRIO,
+       ICE_BW_TYPE_CIR,
+       ICE_BW_TYPE_CIR_WT,
+       ICE_BW_TYPE_EIR,
+       ICE_BW_TYPE_EIR_WT,
+       ICE_BW_TYPE_SHARED,
+       ICE_BW_TYPE_CNT         /* This must be last */
+};
+
+struct ice_bw {
+       u32 bw;
+       u16 bw_alloc;
+};
+
+struct ice_bw_type_info {
+       ice_declare_bitmap(bw_t_bitmap, ICE_BW_TYPE_CNT);
+       u8 generic;
+       struct ice_bw cir_bw;
+       struct ice_bw eir_bw;
+       u32 shared_bw;
+};
+
+/* vsi type list entry to locate corresponding vsi/ag nodes */
+struct ice_sched_vsi_info {
+       struct ice_sched_node *vsi_node[ICE_MAX_TRAFFIC_CLASS];
+       struct ice_sched_node *ag_node[ICE_MAX_TRAFFIC_CLASS];
+       u16 max_lanq[ICE_MAX_TRAFFIC_CLASS];
+       /* bw_t_info saves VSI bw information */
+       struct ice_bw_type_info bw_t_info[ICE_MAX_TRAFFIC_CLASS];
+};
+
+#if !defined(NO_DCB_SUPPORT) || defined(ADQ_SUPPORT)
+/* CEE or IEEE 802.1Qaz ETS Configuration data */
+struct ice_dcb_ets_cfg {
+       u8 willing;
+       u8 cbs;
+       u8 maxtcs;
+       u8 prio_table[ICE_MAX_TRAFFIC_CLASS];
+       u8 tcbwtable[ICE_MAX_TRAFFIC_CLASS];
+       u8 tsatable[ICE_MAX_TRAFFIC_CLASS];
+};
+
+/* CEE or IEEE 802.1Qaz PFC Configuration data */
+struct ice_dcb_pfc_cfg {
+       u8 willing;
+       u8 mbc;
+       u8 pfccap;
+       u8 pfcena;
+};
+
+/* CEE or IEEE 802.1Qaz Application Priority data */
+struct ice_dcb_app_priority_table {
+       u16 prot_id;
+       u8 priority;
+       u8 selector;
+};
+
+#define ICE_MAX_USER_PRIORITY  8
+#define ICE_DCBX_MAX_APPS      32
+#define ICE_LLDPDU_SIZE                1500
+#define ICE_TLV_STATUS_OPER    0x1
+#define ICE_TLV_STATUS_SYNC    0x2
+#define ICE_TLV_STATUS_ERR     0x4
+#define ICE_APP_PROT_ID_FCOE   0x8906
+#define ICE_APP_PROT_ID_ISCSI  0x0cbc
+#define ICE_APP_PROT_ID_FIP    0x8914
+#define ICE_APP_SEL_ETHTYPE    0x1
+#define ICE_APP_SEL_TCPIP      0x2
+#define ICE_CEE_APP_SEL_ETHTYPE        0x0
+#define ICE_CEE_APP_SEL_TCPIP  0x1
+
+struct ice_dcbx_cfg {
+       u32 numapps;
+       u32 tlv_status; /* CEE mode TLV status */
+       struct ice_dcb_ets_cfg etscfg;
+       struct ice_dcb_ets_cfg etsrec;
+       struct ice_dcb_pfc_cfg pfc;
+       struct ice_dcb_app_priority_table app[ICE_DCBX_MAX_APPS];
+       u8 dcbx_mode;
+#define ICE_DCBX_MODE_CEE      0x1
+#define ICE_DCBX_MODE_IEEE     0x2
+       u8 app_mode;
+#define ICE_DCBX_APPS_NON_WILLING      0x1
+};
+#endif /* !NO_DCB_SUPPORT || ADQ_SUPPORT */
+
+struct ice_port_info {
+       struct ice_sched_node *root;    /* Root Node per Port */
+       struct ice_hw *hw;              /* back pointer to hw instance */
+       u32 last_node_teid;             /* scheduler last node info */
+       u16 sw_id;                      /* Initial switch ID belongs to port */
+       u16 pf_vf_num;
+       u8 port_state;
+#define ICE_SCHED_PORT_STATE_INIT      0x0
+#define ICE_SCHED_PORT_STATE_READY     0x1
+       u16 dflt_tx_vsi_rule_id;
+       u16 dflt_tx_vsi_num;
+       u16 dflt_rx_vsi_rule_id;
+       u16 dflt_rx_vsi_num;
+       struct ice_fc_info fc;
+       struct ice_mac_info mac;
+       struct ice_phy_info phy;
+       struct ice_lock sched_lock;     /* protect access to TXSched tree */
+       /* List contain profile id(s) and other params per layer */
+       struct LIST_HEAD_TYPE rl_prof_list[ICE_AQC_TOPO_MAX_LEVEL_NUM];
+#if !defined(NO_DCB_SUPPORT) || defined(ADQ_SUPPORT)
+       struct ice_dcbx_cfg local_dcbx_cfg;     /* Oper/Local Cfg */
+#endif /* !NO_DCB_SUPPORT || ADQ_SUPPORT */
+       u8 lport;
+#define ICE_LPORT_MASK         0xff
+       u8 is_vf;
+};
+
+struct ice_switch_info {
+       struct LIST_HEAD_TYPE vsi_list_map_head;
+       struct ice_sw_recipe *recp_list;
+};
+
+/* FW logging configuration */
+struct ice_fw_log_evnt {
+       u8 cfg : 4;     /* New event enables to configure */
+       u8 cur : 4;     /* Current/active event enables */
+};
+
+struct ice_fw_log_cfg {
+       u8 cq_en : 1;    /* FW logging is enabled via the control queue */
+       u8 uart_en : 1;  /* FW logging is enabled via UART for all PFs */
+       u8 actv_evnts;   /* Cumulation of currently enabled log events */
+
+#define ICE_FW_LOG_EVNT_INFO   (ICE_AQC_FW_LOG_INFO_EN >> ICE_AQC_FW_LOG_EN_S)
+#define ICE_FW_LOG_EVNT_INIT   (ICE_AQC_FW_LOG_INIT_EN >> ICE_AQC_FW_LOG_EN_S)
+#define ICE_FW_LOG_EVNT_FLOW   (ICE_AQC_FW_LOG_FLOW_EN >> ICE_AQC_FW_LOG_EN_S)
+#define ICE_FW_LOG_EVNT_ERR    (ICE_AQC_FW_LOG_ERR_EN >> ICE_AQC_FW_LOG_EN_S)
+       struct ice_fw_log_evnt evnts[ICE_AQC_FW_LOG_ID_MAX];
+};
+
+/* Port hardware description */
+struct ice_hw {
+       u8 *hw_addr;
+       void *back;
+       struct ice_aqc_layer_props *layer_info;
+       struct ice_port_info *port_info;
+       /* 2D Array for each Tx Sched RL Profile type */
+       struct ice_sched_rl_profile **cir_profiles;
+       struct ice_sched_rl_profile **eir_profiles;
+       struct ice_sched_rl_profile **srl_profiles;
+       u64 debug_mask;         /* BITMAP for debug mask */
+       enum ice_mac_type mac_type;
+
+       /* pci info */
+       u16 device_id;
+       u16 vendor_id;
+       u16 subsystem_device_id;
+       u16 subsystem_vendor_id;
+       u8 revision_id;
+
+       u8 pf_id;               /* device profile info */
+
+       u16 max_burst_size;     /* driver sets this value */
+       /* TX Scheduler values */
+       u16 num_tx_sched_layers;
+       u16 num_tx_sched_phys_layers;
+       u8 flattened_layers;
+       u8 max_cgds;
+       u8 sw_entry_point_layer;
+       u16 max_children[ICE_AQC_TOPO_MAX_LEVEL_NUM];
+       struct LIST_HEAD_TYPE agg_list; /* lists all aggregator */
+       struct ice_bw_type_info tc_node_bw_t_info[ICE_MAX_TRAFFIC_CLASS];
+       struct ice_vsi_ctx *vsi_ctx[ICE_MAX_VSI];
+       u8 evb_veb;             /* true for VEB, false for VEPA */
+       u8 reset_ongoing;       /* true if hw is in reset, false otherwise */
+       struct ice_bus_info bus;
+       struct ice_nvm_info nvm;
+       struct ice_hw_dev_caps dev_caps;        /* device capabilities */
+       struct ice_hw_func_caps func_caps;      /* function capabilities */
+
+       struct ice_switch_info *switch_info;    /* switch filter lists */
+
+       /* Control Queue info */
+       struct ice_ctl_q_info adminq;
+       struct ice_ctl_q_info mailboxq;
+
+       u8 api_branch;          /* API branch version */
+       u8 api_maj_ver;         /* API major version */
+       u8 api_min_ver;         /* API minor version */
+       u8 api_patch;           /* API patch version */
+       u8 fw_branch;           /* firmware branch version */
+       u8 fw_maj_ver;          /* firmware major version */
+       u8 fw_min_ver;          /* firmware minor version */
+       u8 fw_patch;            /* firmware patch version */
+       u32 fw_build;           /* firmware build number */
+
+       struct ice_fw_log_cfg fw_log;
+
+/* Device max aggregate bandwidths corresponding to the GL_PWR_MODE_CTL
+ * register. Used for determining the itr/intrl granularity during
+ * initialization.
+ */
+#define ICE_MAX_AGG_BW_200G    0x0
+#define ICE_MAX_AGG_BW_100G    0X1
+#define ICE_MAX_AGG_BW_50G     0x2
+#define ICE_MAX_AGG_BW_25G     0x3
+       /* ITR granularity for different speeds */
+#define ICE_ITR_GRAN_ABOVE_25  2
+#define ICE_ITR_GRAN_MAX_25    4
+       /* ITR granularity in 1 us */
+       u8 itr_gran;
+       /* INTRL granularity for different speeds */
+#define ICE_INTRL_GRAN_ABOVE_25        4
+#define ICE_INTRL_GRAN_MAX_25  8
+       /* INTRL granularity in 1 us */
+       u8 intrl_gran;
+
+       u8 ucast_shared;        /* true if VSIs can share unicast addr */
+
+
+};
+
+/* Statistics collected by each port, VSI, VEB, and S-channel */
+struct ice_eth_stats {
+       u64 rx_bytes;                   /* gorc */
+       u64 rx_unicast;                 /* uprc */
+       u64 rx_multicast;               /* mprc */
+       u64 rx_broadcast;               /* bprc */
+       u64 rx_discards;                /* rdpc */
+       u64 rx_unknown_protocol;        /* rupp */
+       u64 tx_bytes;                   /* gotc */
+       u64 tx_unicast;                 /* uptc */
+       u64 tx_multicast;               /* mptc */
+       u64 tx_broadcast;               /* bptc */
+       u64 tx_discards;                /* tdpc */
+       u64 tx_errors;                  /* tepc */
+};
+
+#define ICE_MAX_UP     8
+
+/* Statistics collected per VEB per User Priority (UP) for up to 8 UPs */
+struct ice_veb_up_stats {
+       u64 up_rx_pkts[ICE_MAX_UP];
+       u64 up_rx_bytes[ICE_MAX_UP];
+       u64 up_tx_pkts[ICE_MAX_UP];
+       u64 up_tx_bytes[ICE_MAX_UP];
+};
+
+/* Statistics collected by the MAC */
+struct ice_hw_port_stats {
+       /* eth stats collected by the port */
+       struct ice_eth_stats eth;
+       /* additional port specific stats */
+       u64 tx_dropped_link_down;       /* tdold */
+       u64 crc_errors;                 /* crcerrs */
+       u64 illegal_bytes;              /* illerrc */
+       u64 error_bytes;                /* errbc */
+       u64 mac_local_faults;           /* mlfc */
+       u64 mac_remote_faults;          /* mrfc */
+       u64 rx_len_errors;              /* rlec */
+       u64 link_xon_rx;                /* lxonrxc */
+       u64 link_xoff_rx;               /* lxoffrxc */
+       u64 link_xon_tx;                /* lxontxc */
+       u64 link_xoff_tx;               /* lxofftxc */
+       u64 rx_size_64;                 /* prc64 */
+       u64 rx_size_127;                /* prc127 */
+       u64 rx_size_255;                /* prc255 */
+       u64 rx_size_511;                /* prc511 */
+       u64 rx_size_1023;               /* prc1023 */
+       u64 rx_size_1522;               /* prc1522 */
+       u64 rx_size_big;                /* prc9522 */
+       u64 rx_undersize;               /* ruc */
+       u64 rx_fragments;               /* rfc */
+       u64 rx_oversize;                /* roc */
+       u64 rx_jabber;                  /* rjc */
+       u64 tx_size_64;                 /* ptc64 */
+       u64 tx_size_127;                /* ptc127 */
+       u64 tx_size_255;                /* ptc255 */
+       u64 tx_size_511;                /* ptc511 */
+       u64 tx_size_1023;               /* ptc1023 */
+       u64 tx_size_1522;               /* ptc1522 */
+       u64 tx_size_big;                /* ptc9522 */
+       u64 mac_short_pkt_dropped;      /* mspdc */
+};
+
+enum ice_sw_fwd_act_type {
+       ICE_FWD_TO_VSI = 0,
+       ICE_FWD_TO_VSI_LIST, /* Do not use this when adding filter */
+       ICE_FWD_TO_Q,
+       ICE_FWD_TO_QGRP,
+       ICE_DROP_PACKET,
+       ICE_INVAL_ACT
+};
+
+/* Checksum and Shadow RAM pointers */
+#define ICE_SR_NVM_CTRL_WORD                   0x00
+#define ICE_SR_PHY_ANALOG_PTR                  0x04
+#define ICE_SR_OPTION_ROM_PTR                  0x05
+#define ICE_SR_RO_PCIR_REGS_AUTO_LOAD_PTR      0x06
+#define ICE_SR_AUTO_GENERATED_POINTERS_PTR     0x07
+#define ICE_SR_PCIR_REGS_AUTO_LOAD_PTR         0x08
+#define ICE_SR_EMP_GLOBAL_MODULE_PTR           0x09
+#define ICE_SR_EMP_IMAGE_PTR                   0x0B
+#define ICE_SR_PE_IMAGE_PTR                    0x0C
+#define ICE_SR_CSR_PROTECTED_LIST_PTR          0x0D
+#define ICE_SR_MNG_CFG_PTR                     0x0E
+#define ICE_SR_EMP_MODULE_PTR                  0x0F
+#define ICE_SR_PBA_FLAGS                       0x15
+#define ICE_SR_PBA_BLOCK_PTR                   0x16
+#define ICE_SR_BOOT_CFG_PTR                    0x17
+#define ICE_SR_NVM_WOL_CFG                     0x19
+#define ICE_NVM_OEM_VER_OFF                    0x83
+#define ICE_SR_NVM_DEV_STARTER_VER             0x18
+#define ICE_SR_ALTERNATE_SAN_MAC_ADDR_PTR      0x27
+#define ICE_SR_PERMANENT_SAN_MAC_ADDR_PTR      0x28
+#define ICE_SR_NVM_MAP_VER                     0x29
+#define ICE_SR_NVM_IMAGE_VER                   0x2A
+#define ICE_SR_NVM_STRUCTURE_VER               0x2B
+#define ICE_SR_NVM_EETRACK_LO                  0x2D
+#define ICE_SR_NVM_EETRACK_HI                  0x2E
+#define ICE_NVM_VER_LO_SHIFT                   0
+#define ICE_NVM_VER_LO_MASK                    (0xff << ICE_NVM_VER_LO_SHIFT)
+#define ICE_NVM_VER_HI_SHIFT                   12
+#define ICE_NVM_VER_HI_MASK                    (0xf << ICE_NVM_VER_HI_SHIFT)
+#define ICE_OEM_EETRACK_ID                     0xffffffff
+#define ICE_OEM_VER_PATCH_SHIFT                        0
+#define ICE_OEM_VER_PATCH_MASK         (0xff << ICE_OEM_VER_PATCH_SHIFT)
+#define ICE_OEM_VER_BUILD_SHIFT                        8
+#define ICE_OEM_VER_BUILD_MASK         (0xffff << ICE_OEM_VER_BUILD_SHIFT)
+#define ICE_OEM_VER_SHIFT                      24
+#define ICE_OEM_VER_MASK                       (0xff << ICE_OEM_VER_SHIFT)
+#define ICE_SR_VPD_PTR                         0x2F
+#define ICE_SR_PXE_SETUP_PTR                   0x30
+#define ICE_SR_PXE_CFG_CUST_OPTIONS_PTR                0x31
+#define ICE_SR_NVM_ORIGINAL_EETRACK_LO         0x34
+#define ICE_SR_NVM_ORIGINAL_EETRACK_HI         0x35
+#define ICE_SR_VLAN_CFG_PTR                    0x37
+#define ICE_SR_POR_REGS_AUTO_LOAD_PTR          0x38
+#define ICE_SR_EMPR_REGS_AUTO_LOAD_PTR         0x3A
+#define ICE_SR_GLOBR_REGS_AUTO_LOAD_PTR                0x3B
+#define ICE_SR_CORER_REGS_AUTO_LOAD_PTR                0x3C
+#define ICE_SR_PHY_CFG_SCRIPT_PTR              0x3D
+#define ICE_SR_PCIE_ALT_AUTO_LOAD_PTR          0x3E
+#define ICE_SR_SW_CHECKSUM_WORD                        0x3F
+#define ICE_SR_PFA_PTR                         0x40
+#define ICE_SR_1ST_SCRATCH_PAD_PTR             0x41
+#define ICE_SR_1ST_NVM_BANK_PTR                        0x42
+#define ICE_SR_NVM_BANK_SIZE                   0x43
+#define ICE_SR_1ND_OROM_BANK_PTR               0x44
+#define ICE_SR_OROM_BANK_SIZE                  0x45
+#define ICE_SR_EMP_SR_SETTINGS_PTR             0x48
+#define ICE_SR_CONFIGURATION_METADATA_PTR      0x4D
+#define ICE_SR_IMMEDIATE_VALUES_PTR            0x4E
+
+/* Auxiliary field, mask and shift definition for Shadow RAM and NVM Flash */
+#define ICE_SR_VPD_SIZE_WORDS          512
+#define ICE_SR_PCIE_ALT_SIZE_WORDS     512
+#define ICE_SR_CTRL_WORD_1_S           0x06
+#define ICE_SR_CTRL_WORD_1_M           (0x03 << ICE_SR_CTRL_WORD_1_S)
+
+/* Shadow RAM related */
+#define ICE_SR_SECTOR_SIZE_IN_WORDS    0x800
+#define ICE_SR_BUF_ALIGNMENT           4096
+#define ICE_SR_WORDS_IN_1KB            512
+/* Checksum should be calculated such that after adding all the words,
+ * including the checksum word itself, the sum should be 0xBABA.
+ */
+#define ICE_SR_SW_CHECKSUM_BASE                0xBABA
+
+#define ICE_PBA_FLAG_DFLT              0xFAFA
+/* Hash redirection LUT for VSI - maximum array size */
+#define ICE_VSIQF_HLUT_ARRAY_SIZE      ((VSIQF_HLUT_MAX_INDEX + 1) * 4)
+
+/*
+ * Defines for values in the VF_PE_DB_SIZE bits in the GLPCI_LBARCTRL register.
+ * This is needed to determine the BAR0 space for the VFs
+ */
+#define GLPCI_LBARCTRL_VF_PE_DB_SIZE_0KB 0x0
+#define GLPCI_LBARCTRL_VF_PE_DB_SIZE_8KB 0x1
+#define GLPCI_LBARCTRL_VF_PE_DB_SIZE_64KB 0x2
+
+#endif /* _ICE_TYPE_H_ */