drivers/common/octeontx2/otx2_mbox.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(C) 2019 Marvell International Ltd.
   3  */
   4
   5 #ifndef __OTX2_MBOX_H__
   6 #define __OTX2_MBOX_H__
   7
   8 #include <errno.h>
   9 #include <stdbool.h>
  10
  11 #include <rte_ether.h>
  12 #include <rte_spinlock.h>
  13
  14 #include <otx2_common.h>
  15
  16 #define SZ_64K                  (64ULL * 1024ULL)
  17 #define SZ_1K                   (1ULL * 1024ULL)
  18 #define MBOX_SIZE               SZ_64K
  19
  20 /* AF/PF: PF initiated, PF/VF VF initiated */
  21 #define MBOX_DOWN_RX_START      0
  22 #define MBOX_DOWN_RX_SIZE       (46 * SZ_1K)
  23 #define MBOX_DOWN_TX_START      (MBOX_DOWN_RX_START + MBOX_DOWN_RX_SIZE)
  24 #define MBOX_DOWN_TX_SIZE       (16 * SZ_1K)
  25 /* AF/PF: AF initiated, PF/VF PF initiated */
  26 #define MBOX_UP_RX_START        (MBOX_DOWN_TX_START + MBOX_DOWN_TX_SIZE)
  27 #define MBOX_UP_RX_SIZE         SZ_1K
  28 #define MBOX_UP_TX_START        (MBOX_UP_RX_START + MBOX_UP_RX_SIZE)
  29 #define MBOX_UP_TX_SIZE         SZ_1K
  30
  31 #if MBOX_UP_TX_SIZE + MBOX_UP_TX_START != MBOX_SIZE
  32 # error "Incorrect mailbox area sizes"
  33 #endif
  34
  35 #define INTR_MASK(pfvfs) ((pfvfs < 64) ? (BIT_ULL(pfvfs) - 1) : (~0ull))
  36
  37 #define MBOX_RSP_TIMEOUT        3000 /* Time to wait for mbox response in ms */
  38
  39 #define MBOX_MSG_ALIGN          16  /* Align mbox msg start to 16bytes */
  40
  41 /* Mailbox directions */
  42 #define MBOX_DIR_AFPF           0  /* AF replies to PF */
  43 #define MBOX_DIR_PFAF           1  /* PF sends messages to AF */
  44 #define MBOX_DIR_PFVF           2  /* PF replies to VF */
  45 #define MBOX_DIR_VFPF           3  /* VF sends messages to PF */
  46 #define MBOX_DIR_AFPF_UP        4  /* AF sends messages to PF */
  47 #define MBOX_DIR_PFAF_UP        5  /* PF replies to AF */
  48 #define MBOX_DIR_PFVF_UP        6  /* PF sends messages to VF */
  49 #define MBOX_DIR_VFPF_UP        7  /* VF replies to PF */
  50
  51 /* Device memory does not support unaligned access, instruct compiler to
  52  * not optimize the memory access when working with mailbox memory.
  53  */
  54 #define __otx2_io volatile
  55
  56 struct otx2_mbox_dev {
  57         void        *mbase;   /* This dev's mbox region */
  58         rte_spinlock_t  mbox_lock;
  59         uint16_t     msg_size; /* Total msg size to be sent */
  60         uint16_t     rsp_size; /* Total rsp size to be sure the reply is ok */
  61         uint16_t     num_msgs; /* No of msgs sent or waiting for response */
  62         uint16_t     msgs_acked; /* No of msgs for which response is received */
  63 };
  64
  65 struct otx2_mbox {
  66         uintptr_t hwbase;  /* Mbox region advertised by HW */
  67         uintptr_t reg_base;/* CSR base for this dev */
  68         uint64_t trigger;  /* Trigger mbox notification */
  69         uint16_t tr_shift; /* Mbox trigger shift */
  70         uint64_t rx_start; /* Offset of Rx region in mbox memory */
  71         uint64_t tx_start; /* Offset of Tx region in mbox memory */
  72         uint16_t rx_size;  /* Size of Rx region */
  73         uint16_t tx_size;  /* Size of Tx region */
  74         uint16_t ndevs;    /* The number of peers */
  75         struct otx2_mbox_dev *dev;
  76         uint64_t intr_offset; /* Offset to interrupt register */
  77 };
  78
  79 /* Header which precedes all mbox messages */
  80 struct mbox_hdr {
  81         uint64_t __otx2_io msg_size;   /* Total msgs size embedded */
  82         uint16_t __otx2_io num_msgs;   /* No of msgs embedded */
  83 };
  84
  85 /* Header which precedes every msg and is also part of it */
  86 struct mbox_msghdr {
  87         uint16_t __otx2_io pcifunc; /* Who's sending this msg */
  88         uint16_t __otx2_io id;      /* Mbox message ID */
  89 #define OTX2_MBOX_REQ_SIG (0xdead)
  90 #define OTX2_MBOX_RSP_SIG (0xbeef)
  91         /* Signature, for validating corrupted msgs */
  92         uint16_t __otx2_io sig;
  93 #define OTX2_MBOX_VERSION (0x0005)
  94         /* Version of msg's structure for this ID */
  95         uint16_t __otx2_io ver;
  96         /* Offset of next msg within mailbox region */
  97         uint16_t __otx2_io next_msgoff;
  98         int __otx2_io rc; /* Msg processed response code */
  99 };
 100
 101 /* Mailbox message types */
 102 #define MBOX_MSG_MASK                           0xFFFF
 103 #define MBOX_MSG_INVALID                        0xFFFE
 104 #define MBOX_MSG_MAX                            0xFFFF
 105
 106 #define MBOX_MESSAGES                                                   \
 107 /* Generic mbox IDs (range 0x000 - 0x1FF) */                            \
 108 M(READY,                0x001, ready, msg_req, ready_msg_rsp)           \
 109 M(ATTACH_RESOURCES,     0x002, attach_resources, rsrc_attach_req, msg_rsp)\
 110 M(DETACH_RESOURCES,     0x003, detach_resources, rsrc_detach_req, msg_rsp)\
 111 M(FREE_RSRC_CNT,        0x004, free_rsrc_cnt, msg_req, free_rsrcs_rsp)  \
 112 M(MSIX_OFFSET,          0x005, msix_offset, msg_req, msix_offset_rsp)   \
 113 M(VF_FLR,               0x006, vf_flr, msg_req, msg_rsp)                \
 114 M(PTP_OP,               0x007, ptp_op, ptp_req, ptp_rsp)                \
 115 M(GET_HW_CAP,           0x008, get_hw_cap, msg_req, get_hw_cap_rsp)     \
 116 M(NDC_SYNC_OP,          0x009, ndc_sync_op, ndc_sync_op, msg_rsp)       \
 117 /* CGX mbox IDs (range 0x200 - 0x3FF) */                                \
 118 M(CGX_START_RXTX,       0x200, cgx_start_rxtx, msg_req, msg_rsp)        \
 119 M(CGX_STOP_RXTX,        0x201, cgx_stop_rxtx, msg_req, msg_rsp)         \
 120 M(CGX_STATS,            0x202, cgx_stats, msg_req, cgx_stats_rsp)       \
 121 M(CGX_MAC_ADDR_SET,     0x203, cgx_mac_addr_set, cgx_mac_addr_set_or_get,\
 122                                 cgx_mac_addr_set_or_get)                \
 123 M(CGX_MAC_ADDR_GET,     0x204, cgx_mac_addr_get, cgx_mac_addr_set_or_get,\
 124                                 cgx_mac_addr_set_or_get)                \
 125 M(CGX_PROMISC_ENABLE,   0x205, cgx_promisc_enable, msg_req, msg_rsp)    \
 126 M(CGX_PROMISC_DISABLE,  0x206, cgx_promisc_disable, msg_req, msg_rsp)   \
 127 M(CGX_START_LINKEVENTS, 0x207, cgx_start_linkevents, msg_req, msg_rsp)  \
 128 M(CGX_STOP_LINKEVENTS,  0x208, cgx_stop_linkevents, msg_req, msg_rsp)   \
 129 M(CGX_GET_LINKINFO,     0x209, cgx_get_linkinfo, msg_req, cgx_link_info_msg)\
 130 M(CGX_INTLBK_ENABLE,    0x20A, cgx_intlbk_enable, msg_req, msg_rsp)     \
 131 M(CGX_INTLBK_DISABLE,   0x20B, cgx_intlbk_disable, msg_req, msg_rsp)    \
 132 M(CGX_PTP_RX_ENABLE,    0x20C, cgx_ptp_rx_enable, msg_req, msg_rsp)     \
 133 M(CGX_PTP_RX_DISABLE,   0x20D, cgx_ptp_rx_disable, msg_req, msg_rsp)    \
 134 M(CGX_CFG_PAUSE_FRM,    0x20E, cgx_cfg_pause_frm, cgx_pause_frm_cfg,    \
 135                                 cgx_pause_frm_cfg)                      \
 136 M(CGX_FW_DATA_GET,      0x20F, cgx_get_aux_link_info, msg_req, cgx_fw_data) \
 137 M(CGX_FEC_SET,          0x210, cgx_set_fec_param, fec_mode, fec_mode) \
 138 M(CGX_MAC_ADDR_ADD,     0x211, cgx_mac_addr_add, cgx_mac_addr_add_req,  \
 139                                 cgx_mac_addr_add_rsp)                   \
 140 M(CGX_MAC_ADDR_DEL,     0x212, cgx_mac_addr_del, cgx_mac_addr_del_req,  \
 141                                 msg_rsp)                                \
 142 M(CGX_MAC_MAX_ENTRIES_GET, 0x213, cgx_mac_max_entries_get, msg_req,     \
 143                                  cgx_max_dmac_entries_get_rsp)          \
 144 M(CGX_SET_LINK_STATE,   0x214, cgx_set_link_state,              \
 145                         cgx_set_link_state_msg, msg_rsp)                \
 146 M(CGX_GET_PHY_MOD_TYPE, 0x215, cgx_get_phy_mod_type, msg_req,           \
 147                                 cgx_phy_mod_type)                       \
 148 M(CGX_SET_PHY_MOD_TYPE, 0x216, cgx_set_phy_mod_type, cgx_phy_mod_type,  \
 149                                 msg_rsp)                                \
 150 M(CGX_FEC_STATS,        0x217, cgx_fec_stats, msg_req, cgx_fec_stats_rsp) \
 151 M(CGX_SET_LINK_MODE,    0x218, cgx_set_link_mode, cgx_set_link_mode_req,\
 152                                cgx_set_link_mode_rsp)                   \
 153 /* NPA mbox IDs (range 0x400 - 0x5FF) */                                \
 154 M(NPA_LF_ALLOC,         0x400, npa_lf_alloc, npa_lf_alloc_req,          \
 155                                 npa_lf_alloc_rsp)                       \
 156 M(NPA_LF_FREE,          0x401, npa_lf_free, msg_req, msg_rsp)           \
 157 M(NPA_AQ_ENQ,           0x402, npa_aq_enq, npa_aq_enq_req, npa_aq_enq_rsp)\
 158 M(NPA_HWCTX_DISABLE,    0x403, npa_hwctx_disable, hwctx_disable_req, msg_rsp)\
 159 /* SSO/SSOW mbox IDs (range 0x600 - 0x7FF) */                           \
 160 M(SSO_LF_ALLOC,         0x600, sso_lf_alloc, sso_lf_alloc_req,          \
 161                                 sso_lf_alloc_rsp)                       \
 162 M(SSO_LF_FREE,          0x601, sso_lf_free, sso_lf_free_req, msg_rsp)   \
 163 M(SSOW_LF_ALLOC,        0x602, ssow_lf_alloc, ssow_lf_alloc_req, msg_rsp)\
 164 M(SSOW_LF_FREE,         0x603, ssow_lf_free, ssow_lf_free_req, msg_rsp) \
 165 M(SSO_HW_SETCONFIG,     0x604, sso_hw_setconfig, sso_hw_setconfig,      \
 166                                 msg_rsp)                                \
 167 M(SSO_GRP_SET_PRIORITY, 0x605, sso_grp_set_priority, sso_grp_priority,  \
 168                                 msg_rsp)                                \
 169 M(SSO_GRP_GET_PRIORITY, 0x606, sso_grp_get_priority, sso_info_req,      \
 170                                 sso_grp_priority)                       \
 171 M(SSO_WS_CACHE_INV,     0x607, sso_ws_cache_inv, msg_req, msg_rsp)      \
 172 M(SSO_GRP_QOS_CONFIG,   0x608, sso_grp_qos_config, sso_grp_qos_cfg,     \
 173                                 msg_rsp)                                \
 174 M(SSO_GRP_GET_STATS,    0x609, sso_grp_get_stats, sso_info_req,         \
 175                                 sso_grp_stats)                          \
 176 M(SSO_HWS_GET_STATS,    0x610, sso_hws_get_stats, sso_info_req,         \
 177                                 sso_hws_stats)                          \
 178 /* TIM mbox IDs (range 0x800 - 0x9FF) */                                \
 179 M(TIM_LF_ALLOC,         0x800, tim_lf_alloc, tim_lf_alloc_req,          \
 180                                 tim_lf_alloc_rsp)                       \
 181 M(TIM_LF_FREE,          0x801, tim_lf_free, tim_ring_req, msg_rsp)      \
 182 M(TIM_CONFIG_RING,      0x802, tim_config_ring, tim_config_req, msg_rsp)\
 183 M(TIM_ENABLE_RING,      0x803, tim_enable_ring, tim_ring_req,           \
 184                                 tim_enable_rsp)                         \
 185 M(TIM_DISABLE_RING,     0x804, tim_disable_ring, tim_ring_req, msg_rsp) \
 186 /* CPT mbox IDs (range 0xA00 - 0xBFF) */                                \
 187 M(CPT_LF_ALLOC,         0xA00, cpt_lf_alloc, cpt_lf_alloc_req_msg,      \
 188                                cpt_lf_alloc_rsp_msg)                    \
 189 M(CPT_LF_FREE,          0xA01, cpt_lf_free, msg_req, msg_rsp)           \
 190 M(CPT_RD_WR_REGISTER,   0xA02, cpt_rd_wr_register, cpt_rd_wr_reg_msg,   \
 191                                cpt_rd_wr_reg_msg)                       \
 192 M(CPT_SET_CRYPTO_GRP,   0xA03, cpt_set_crypto_grp,                      \
 193                                cpt_set_crypto_grp_req_msg,              \
 194                                msg_rsp)                                 \
 195 M(CPT_INLINE_IPSEC_CFG, 0xA04, cpt_inline_ipsec_cfg,                    \
 196                                cpt_inline_ipsec_cfg_msg, msg_rsp)       \
 197 M(CPT_RX_INLINE_LF_CFG, 0xBFE, cpt_rx_inline_lf_cfg,                    \
 198                                cpt_rx_inline_lf_cfg_msg, msg_rsp)       \
 199 /* NPC mbox IDs (range 0x6000 - 0x7FFF) */                              \
 200 M(NPC_MCAM_ALLOC_ENTRY, 0x6000, npc_mcam_alloc_entry,                   \
 201                                 npc_mcam_alloc_entry_req,               \
 202                                 npc_mcam_alloc_entry_rsp)               \
 203 M(NPC_MCAM_FREE_ENTRY,  0x6001, npc_mcam_free_entry,                    \
 204                                 npc_mcam_free_entry_req, msg_rsp)       \
 205 M(NPC_MCAM_WRITE_ENTRY, 0x6002, npc_mcam_write_entry,                   \
 206                                 npc_mcam_write_entry_req, msg_rsp)      \
 207 M(NPC_MCAM_ENA_ENTRY,   0x6003, npc_mcam_ena_entry,                     \
 208                                 npc_mcam_ena_dis_entry_req, msg_rsp)    \
 209 M(NPC_MCAM_DIS_ENTRY,   0x6004, npc_mcam_dis_entry,                     \
 210                                 npc_mcam_ena_dis_entry_req, msg_rsp)    \
 211 M(NPC_MCAM_SHIFT_ENTRY, 0x6005, npc_mcam_shift_entry,                   \
 212                                 npc_mcam_shift_entry_req,               \
 213                                 npc_mcam_shift_entry_rsp)               \
 214 M(NPC_MCAM_ALLOC_COUNTER,       0x6006, npc_mcam_alloc_counter,         \
 215                                 npc_mcam_alloc_counter_req,             \
 216                                 npc_mcam_alloc_counter_rsp)             \
 217 M(NPC_MCAM_FREE_COUNTER,        0x6007, npc_mcam_free_counter,          \
 218                                 npc_mcam_oper_counter_req,              \
 219                                 msg_rsp)                                \
 220 M(NPC_MCAM_UNMAP_COUNTER,       0x6008, npc_mcam_unmap_counter,         \
 221                                 npc_mcam_unmap_counter_req,             \
 222                                 msg_rsp)                                \
 223 M(NPC_MCAM_CLEAR_COUNTER,       0x6009, npc_mcam_clear_counter,         \
 224                                 npc_mcam_oper_counter_req,              \
 225                                 msg_rsp)                                \
 226 M(NPC_MCAM_COUNTER_STATS,       0x600a, npc_mcam_counter_stats,         \
 227                                 npc_mcam_oper_counter_req,              \
 228                                 npc_mcam_oper_counter_rsp)              \
 229 M(NPC_MCAM_ALLOC_AND_WRITE_ENTRY, 0x600b, npc_mcam_alloc_and_write_entry,\
 230                                 npc_mcam_alloc_and_write_entry_req,     \
 231                                 npc_mcam_alloc_and_write_entry_rsp)     \
 232 M(NPC_GET_KEX_CFG,        0x600c, npc_get_kex_cfg, msg_req,             \
 233                                 npc_get_kex_cfg_rsp)                    \
 234 M(NPC_INSTALL_FLOW,       0x600d, npc_install_flow,                     \
 235                                   npc_install_flow_req,                 \
 236                                   npc_install_flow_rsp)                 \
 237 M(NPC_DELETE_FLOW,        0x600e, npc_delete_flow,                      \
 238                                   npc_delete_flow_req, msg_rsp)         \
 239 M(NPC_MCAM_READ_ENTRY,    0x600f, npc_mcam_read_entry,                  \
 240                                   npc_mcam_read_entry_req,              \
 241                                   npc_mcam_read_entry_rsp)              \
 242 M(NPC_SET_PKIND,          0x6010, npc_set_pkind,                        \
 243                                   npc_set_pkind,                        \
 244                                   msg_rsp)                              \
 245 /* NIX mbox IDs (range 0x8000 - 0xFFFF) */                              \
 246 M(NIX_LF_ALLOC,         0x8000, nix_lf_alloc, nix_lf_alloc_req,         \
 247                                 nix_lf_alloc_rsp)                       \
 248 M(NIX_LF_FREE,          0x8001, nix_lf_free, nix_lf_free_req, msg_rsp)  \
 249 M(NIX_AQ_ENQ,           0x8002, nix_aq_enq, nix_aq_enq_req,             \
 250                                 nix_aq_enq_rsp)                         \
 251 M(NIX_HWCTX_DISABLE,    0x8003, nix_hwctx_disable, hwctx_disable_req,   \
 252                                 msg_rsp)                                \
 253 M(NIX_TXSCH_ALLOC,      0x8004, nix_txsch_alloc, nix_txsch_alloc_req,   \
 254                                 nix_txsch_alloc_rsp)                    \
 255 M(NIX_TXSCH_FREE,       0x8005, nix_txsch_free, nix_txsch_free_req,     \
 256                                 msg_rsp)                                \
 257 M(NIX_TXSCHQ_CFG,       0x8006, nix_txschq_cfg, nix_txschq_config,      \
 258                                 nix_txschq_config)                      \
 259 M(NIX_STATS_RST,        0x8007, nix_stats_rst, msg_req, msg_rsp)        \
 260 M(NIX_VTAG_CFG,         0x8008, nix_vtag_cfg, nix_vtag_config, msg_rsp) \
 261 M(NIX_RSS_FLOWKEY_CFG,  0x8009, nix_rss_flowkey_cfg,                    \
 262                                 nix_rss_flowkey_cfg,                    \
 263                                 nix_rss_flowkey_cfg_rsp)                \
 264 M(NIX_SET_MAC_ADDR,     0x800a, nix_set_mac_addr, nix_set_mac_addr,     \
 265                                 msg_rsp)                                \
 266 M(NIX_SET_RX_MODE,      0x800b, nix_set_rx_mode, nix_rx_mode, msg_rsp)  \
 267 M(NIX_SET_HW_FRS,       0x800c, nix_set_hw_frs, nix_frs_cfg, msg_rsp)   \
 268 M(NIX_LF_START_RX,      0x800d, nix_lf_start_rx, msg_req, msg_rsp)      \
 269 M(NIX_LF_STOP_RX,       0x800e, nix_lf_stop_rx, msg_req, msg_rsp)       \
 270 M(NIX_MARK_FORMAT_CFG,  0x800f, nix_mark_format_cfg,                    \
 271                                 nix_mark_format_cfg,                    \
 272                                 nix_mark_format_cfg_rsp)                \
 273 M(NIX_SET_RX_CFG,       0x8010, nix_set_rx_cfg, nix_rx_cfg, msg_rsp)    \
 274 M(NIX_LSO_FORMAT_CFG,   0x8011, nix_lso_format_cfg, nix_lso_format_cfg, \
 275                                 nix_lso_format_cfg_rsp)                 \
 276 M(NIX_LF_PTP_TX_ENABLE, 0x8013, nix_lf_ptp_tx_enable, msg_req,          \
 277                                 msg_rsp)                                \
 278 M(NIX_LF_PTP_TX_DISABLE,        0x8014, nix_lf_ptp_tx_disable, msg_req, \
 279                                 msg_rsp)                                \
 280 M(NIX_SET_VLAN_TPID,    0x8015, nix_set_vlan_tpid, nix_set_vlan_tpid,   \
 281                                 msg_rsp)                                \
 282 M(NIX_BP_ENABLE,        0x8016, nix_bp_enable, nix_bp_cfg_req,          \
 283                                 nix_bp_cfg_rsp)                         \
 284 M(NIX_BP_DISABLE,       0x8017, nix_bp_disable, nix_bp_cfg_req, msg_rsp)\
 285 M(NIX_GET_MAC_ADDR,     0x8018, nix_get_mac_addr, msg_req,              \
 286                                 nix_get_mac_addr_rsp)                   \
 287 M(NIX_INLINE_IPSEC_CFG, 0x8019, nix_inline_ipsec_cfg,                   \
 288                                 nix_inline_ipsec_cfg, msg_rsp)          \
 289 M(NIX_INLINE_IPSEC_LF_CFG,                                              \
 290                         0x801a, nix_inline_ipsec_lf_cfg,                \
 291                                 nix_inline_ipsec_lf_cfg, msg_rsp)
 292
 293 /* Messages initiated by AF (range 0xC00 - 0xDFF) */
 294 #define MBOX_UP_CGX_MESSAGES                                            \
 295 M(CGX_LINK_EVENT,       0xC00, cgx_link_event, cgx_link_info_msg,       \
 296                                 msg_rsp)                                \
 297 M(CGX_PTP_RX_INFO,      0xC01, cgx_ptp_rx_info, cgx_ptp_rx_info_msg,    \
 298                                 msg_rsp)
 299
 300 enum {
 301 #define M(_name, _id, _1, _2, _3) MBOX_MSG_ ## _name = _id,
 302 MBOX_MESSAGES
 303 MBOX_UP_CGX_MESSAGES
 304 #undef M
 305 };
 306
 307 /* Mailbox message formats */
 308
 309 #define RVU_DEFAULT_PF_FUNC     0xFFFF
 310
 311 /* Generic request msg used for those mbox messages which
 312  * don't send any data in the request.
 313  */
 314 struct msg_req {
 315         struct mbox_msghdr hdr;
 316 };
 317
 318 /* Generic response msg used a ack or response for those mbox
 319  * messages which doesn't have a specific rsp msg format.
 320  */
 321 struct msg_rsp {
 322         struct mbox_msghdr hdr;
 323 };
 324
 325 /* RVU mailbox error codes
 326  * Range 256 - 300.
 327  */
 328 enum rvu_af_status {
 329         RVU_INVALID_VF_ID           = -256,
 330 };
 331
 332 struct ready_msg_rsp {
 333         struct mbox_msghdr hdr;
 334         uint16_t __otx2_io sclk_feq; /* SCLK frequency */
 335         uint16_t __otx2_io rclk_freq; /* RCLK frequency */
 336 };
 337
 338 /* Struct to set pkind */
 339 struct npc_set_pkind {
 340         struct mbox_msghdr hdr;
 341 #define OTX2_PRIV_FLAGS_DEFAULT  BIT_ULL(0)
 342 #define OTX2_PRIV_FLAGS_EDSA     BIT_ULL(1)
 343 #define OTX2_PRIV_FLAGS_HIGIG    BIT_ULL(2)
 344 #define OTX2_PRIV_FLAGS_CUSTOM   BIT_ULL(63)
 345         uint64_t __otx2_io mode;
 346 #define PKIND_TX                BIT_ULL(0)
 347 #define PKIND_RX                BIT_ULL(1)
 348         uint8_t __otx2_io dir;
 349         uint8_t __otx2_io pkind; /* valid only in case custom flag */
 350 };
 351
 352 /* Structure for requesting resource provisioning.
 353  * 'modify' flag to be used when either requesting more
 354  * or detach partial of a certain resource type.
 355  * Rest of the fields specify how many of what type to
 356  * be attached.
 357  */
 358 struct rsrc_attach_req {
 359         struct mbox_msghdr hdr;
 360         uint8_t __otx2_io modify:1;
 361         uint8_t __otx2_io npalf:1;
 362         uint8_t __otx2_io nixlf:1;
 363         uint16_t __otx2_io sso;
 364         uint16_t __otx2_io ssow;
 365         uint16_t __otx2_io timlfs;
 366         uint16_t __otx2_io cptlfs;
 367 };
 368
 369 /* Structure for relinquishing resources.
 370  * 'partial' flag to be used when relinquishing all resources
 371  * but only of a certain type. If not set, all resources of all
 372  * types provisioned to the RVU function will be detached.
 373  */
 374 struct rsrc_detach_req {
 375         struct mbox_msghdr hdr;
 376         uint8_t __otx2_io partial:1;
 377         uint8_t __otx2_io npalf:1;
 378         uint8_t __otx2_io nixlf:1;
 379         uint8_t __otx2_io sso:1;
 380         uint8_t __otx2_io ssow:1;
 381         uint8_t __otx2_io timlfs:1;
 382         uint8_t __otx2_io cptlfs:1;
 383 };
 384
 385 /* NIX Transmit schedulers */
 386 #define NIX_TXSCH_LVL_SMQ 0x0
 387 #define NIX_TXSCH_LVL_MDQ 0x0
 388 #define NIX_TXSCH_LVL_TL4 0x1
 389 #define NIX_TXSCH_LVL_TL3 0x2
 390 #define NIX_TXSCH_LVL_TL2 0x3
 391 #define NIX_TXSCH_LVL_TL1 0x4
 392 #define NIX_TXSCH_LVL_CNT 0x5
 393
 394 /*
 395  * Number of resources available to the caller.
 396  * In reply to MBOX_MSG_FREE_RSRC_CNT.
 397  */
 398 struct free_rsrcs_rsp {
 399         struct mbox_msghdr hdr;
 400         uint16_t __otx2_io schq[NIX_TXSCH_LVL_CNT];
 401         uint16_t __otx2_io sso;
 402         uint16_t __otx2_io tim;
 403         uint16_t __otx2_io ssow;
 404         uint16_t __otx2_io cpt;
 405         uint8_t __otx2_io npa;
 406         uint8_t __otx2_io nix;
 407 };
 408
 409 #define MSIX_VECTOR_INVALID     0xFFFF
 410 #define MAX_RVU_BLKLF_CNT       256
 411
 412 struct msix_offset_rsp {
 413         struct mbox_msghdr hdr;
 414         uint16_t __otx2_io npa_msixoff;
 415         uint16_t __otx2_io nix_msixoff;
 416         uint8_t __otx2_io sso;
 417         uint8_t __otx2_io ssow;
 418         uint8_t __otx2_io timlfs;
 419         uint8_t __otx2_io cptlfs;
 420         uint16_t __otx2_io sso_msixoff[MAX_RVU_BLKLF_CNT];
 421         uint16_t __otx2_io ssow_msixoff[MAX_RVU_BLKLF_CNT];
 422         uint16_t __otx2_io timlf_msixoff[MAX_RVU_BLKLF_CNT];
 423         uint16_t __otx2_io cptlf_msixoff[MAX_RVU_BLKLF_CNT];
 424 };
 425
 426 /* CGX mbox message formats */
 427
 428 struct cgx_stats_rsp {
 429         struct mbox_msghdr hdr;
 430 #define CGX_RX_STATS_COUNT      13
 431 #define CGX_TX_STATS_COUNT      18
 432         uint64_t __otx2_io rx_stats[CGX_RX_STATS_COUNT];
 433         uint64_t __otx2_io tx_stats[CGX_TX_STATS_COUNT];
 434 };
 435
 436 struct cgx_fec_stats_rsp {
 437         struct mbox_msghdr hdr;
 438         uint64_t __otx2_io fec_corr_blks;
 439         uint64_t __otx2_io fec_uncorr_blks;
 440 };
 441 /* Structure for requesting the operation for
 442  * setting/getting mac address in the CGX interface
 443  */
 444 struct cgx_mac_addr_set_or_get {
 445         struct mbox_msghdr hdr;
 446         uint8_t __otx2_io mac_addr[RTE_ETHER_ADDR_LEN];
 447 };
 448
 449 /* Structure for requesting the operation to
 450  * add DMAC filter entry into CGX interface
 451  */
 452 struct cgx_mac_addr_add_req {
 453         struct mbox_msghdr hdr;
 454         uint8_t __otx2_io mac_addr[RTE_ETHER_ADDR_LEN];
 455 };
 456
 457 /* Structure for response against the operation to
 458  * add DMAC filter entry into CGX interface
 459  */
 460 struct cgx_mac_addr_add_rsp {
 461         struct mbox_msghdr hdr;
 462         uint8_t __otx2_io index;
 463 };
 464
 465 /* Structure for requesting the operation to
 466  * delete DMAC filter entry from CGX interface
 467  */
 468 struct cgx_mac_addr_del_req {
 469         struct mbox_msghdr hdr;
 470         uint8_t __otx2_io index;
 471 };
 472
 473 /* Structure for response against the operation to
 474  * get maximum supported DMAC filter entries
 475  */
 476 struct cgx_max_dmac_entries_get_rsp {
 477         struct mbox_msghdr hdr;
 478         uint8_t __otx2_io max_dmac_filters;
 479 };
 480
 481 struct cgx_link_user_info {
 482         uint64_t __otx2_io link_up:1;
 483         uint64_t __otx2_io full_duplex:1;
 484         uint64_t __otx2_io lmac_type_id:4;
 485         uint64_t __otx2_io speed:20; /* speed in Mbps */
 486         uint64_t __otx2_io an:1; /* AN supported or not */
 487         uint64_t __otx2_io fec:2; /* FEC type if enabled else 0 */
 488         uint64_t __otx2_io port:8;
 489 #define LMACTYPE_STR_LEN 16
 490         char lmac_type[LMACTYPE_STR_LEN];
 491 };
 492
 493 struct cgx_link_info_msg {
 494         struct mbox_msghdr hdr;
 495         struct cgx_link_user_info link_info;
 496 };
 497
 498 struct cgx_ptp_rx_info_msg {
 499         struct mbox_msghdr hdr;
 500         uint8_t __otx2_io ptp_en;
 501 };
 502
 503 struct cgx_pause_frm_cfg {
 504         struct mbox_msghdr hdr;
 505         uint8_t __otx2_io set;
 506         /* set = 1 if the request is to config pause frames */
 507         /* set = 0 if the request is to fetch pause frames config */
 508         uint8_t __otx2_io rx_pause;
 509         uint8_t __otx2_io tx_pause;
 510 };
 511
 512 struct sfp_eeprom_s {
 513 #define SFP_EEPROM_SIZE 256
 514         uint16_t __otx2_io sff_id;
 515         uint8_t __otx2_io buf[SFP_EEPROM_SIZE];
 516         uint64_t __otx2_io reserved;
 517 };
 518
 519 enum fec_type {
 520         OTX2_FEC_NONE,
 521         OTX2_FEC_BASER,
 522         OTX2_FEC_RS,
 523 };
 524
 525 struct phy_s {
 526         uint64_t __otx2_io can_change_mod_type : 1;
 527         uint64_t __otx2_io mod_type            : 1;
 528 };
 529
 530 struct cgx_lmac_fwdata_s {
 531         uint16_t __otx2_io rw_valid;
 532         uint64_t __otx2_io supported_fec;
 533         uint64_t __otx2_io supported_an;
 534         uint64_t __otx2_io supported_link_modes;
 535         /* Only applicable if AN is supported */
 536         uint64_t __otx2_io advertised_fec;
 537         uint64_t __otx2_io advertised_link_modes;
 538         /* Only applicable if SFP/QSFP slot is present */
 539         struct sfp_eeprom_s sfp_eeprom;
 540         struct phy_s phy;
 541 #define LMAC_FWDATA_RESERVED_MEM 1023
 542         uint64_t __otx2_io reserved[LMAC_FWDATA_RESERVED_MEM];
 543 };
 544
 545 struct cgx_fw_data {
 546         struct mbox_msghdr hdr;
 547         struct cgx_lmac_fwdata_s fwdata;
 548 };
 549
 550 struct fec_mode {
 551         struct mbox_msghdr hdr;
 552         int __otx2_io fec;
 553 };
 554
 555 struct cgx_set_link_state_msg {
 556         struct mbox_msghdr hdr;
 557         uint8_t __otx2_io enable;
 558 };
 559
 560 struct cgx_phy_mod_type {
 561         struct mbox_msghdr hdr;
 562         int __otx2_io mod;
 563 };
 564
 565 struct cgx_set_link_mode_args {
 566         uint32_t __otx2_io speed;
 567         uint8_t __otx2_io duplex;
 568         uint8_t __otx2_io an;
 569         uint8_t __otx2_io ports;
 570         uint64_t __otx2_io mode;
 571 };
 572
 573 struct cgx_set_link_mode_req {
 574         struct mbox_msghdr hdr;
 575         struct cgx_set_link_mode_args args;
 576 };
 577
 578 struct cgx_set_link_mode_rsp {
 579         struct mbox_msghdr hdr;
 580         int __otx2_io status;
 581 };
 582 /* NPA mbox message formats */
 583
 584 /* NPA mailbox error codes
 585  * Range 301 - 400.
 586  */
 587 enum npa_af_status {
 588         NPA_AF_ERR_PARAM            = -301,
 589         NPA_AF_ERR_AQ_FULL          = -302,
 590         NPA_AF_ERR_AQ_ENQUEUE       = -303,
 591         NPA_AF_ERR_AF_LF_INVALID    = -304,
 592         NPA_AF_ERR_AF_LF_ALLOC      = -305,
 593         NPA_AF_ERR_LF_RESET         = -306,
 594 };
 595
 596 #define NPA_AURA_SZ_0           0
 597 #define NPA_AURA_SZ_128         1
 598 #define NPA_AURA_SZ_256         2
 599 #define NPA_AURA_SZ_512         3
 600 #define NPA_AURA_SZ_1K          4
 601 #define NPA_AURA_SZ_2K          5
 602 #define NPA_AURA_SZ_4K          6
 603 #define NPA_AURA_SZ_8K          7
 604 #define NPA_AURA_SZ_16K         8
 605 #define NPA_AURA_SZ_32K         9
 606 #define NPA_AURA_SZ_64K         10
 607 #define NPA_AURA_SZ_128K        11
 608 #define NPA_AURA_SZ_256K        12
 609 #define NPA_AURA_SZ_512K        13
 610 #define NPA_AURA_SZ_1M          14
 611 #define NPA_AURA_SZ_MAX         15
 612
 613 /* For NPA LF context alloc and init */
 614 struct npa_lf_alloc_req {
 615         struct mbox_msghdr hdr;
 616         int __otx2_io node;
 617         int __otx2_io aura_sz; /* No of auras. See NPA_AURA_SZ_* */
 618         uint32_t __otx2_io nr_pools; /* No of pools */
 619         uint64_t __otx2_io way_mask;
 620 };
 621
 622 struct npa_lf_alloc_rsp {
 623         struct mbox_msghdr hdr;
 624         uint32_t __otx2_io stack_pg_ptrs;  /* No of ptrs per stack page */
 625         uint32_t __otx2_io stack_pg_bytes; /* Size of stack page */
 626         uint16_t __otx2_io qints; /* NPA_AF_CONST::QINTS */
 627 };
 628
 629 /* NPA AQ enqueue msg */
 630 struct npa_aq_enq_req {
 631         struct mbox_msghdr hdr;
 632         uint32_t __otx2_io aura_id;
 633         uint8_t __otx2_io ctype;
 634         uint8_t __otx2_io op;
 635         union {
 636                 /* Valid when op == WRITE/INIT and ctype == AURA.
 637                  * LF fills the pool_id in aura.pool_addr. AF will translate
 638                  * the pool_id to pool context pointer.
 639                  */
 640                 __otx2_io struct npa_aura_s aura;
 641                 /* Valid when op == WRITE/INIT and ctype == POOL */
 642                 __otx2_io struct npa_pool_s pool;
 643         };
 644         /* Mask data when op == WRITE (1=write, 0=don't write) */
 645         union {
 646                 /* Valid when op == WRITE and ctype == AURA */
 647                 __otx2_io struct npa_aura_s aura_mask;
 648                 /* Valid when op == WRITE and ctype == POOL */
 649                 __otx2_io struct npa_pool_s pool_mask;
 650         };
 651 };
 652
 653 struct npa_aq_enq_rsp {
 654         struct mbox_msghdr hdr;
 655         union {
 656                 /* Valid when op == READ and ctype == AURA */
 657                 __otx2_io struct npa_aura_s aura;
 658                 /* Valid when op == READ and ctype == POOL */
 659                 __otx2_io struct npa_pool_s pool;
 660         };
 661 };
 662
 663 /* Disable all contexts of type 'ctype' */
 664 struct hwctx_disable_req {
 665         struct mbox_msghdr hdr;
 666         uint8_t __otx2_io ctype;
 667 };
 668
 669 /* NIX mbox message formats */
 670
 671 /* NIX mailbox error codes
 672  * Range 401 - 500.
 673  */
 674 enum nix_af_status {
 675         NIX_AF_ERR_PARAM            = -401,
 676         NIX_AF_ERR_AQ_FULL          = -402,
 677         NIX_AF_ERR_AQ_ENQUEUE       = -403,
 678         NIX_AF_ERR_AF_LF_INVALID    = -404,
 679         NIX_AF_ERR_AF_LF_ALLOC      = -405,
 680         NIX_AF_ERR_TLX_ALLOC_FAIL   = -406,
 681         NIX_AF_ERR_TLX_INVALID      = -407,
 682         NIX_AF_ERR_RSS_SIZE_INVALID = -408,
 683         NIX_AF_ERR_RSS_GRPS_INVALID = -409,
 684         NIX_AF_ERR_FRS_INVALID      = -410,
 685         NIX_AF_ERR_RX_LINK_INVALID  = -411,
 686         NIX_AF_INVAL_TXSCHQ_CFG     = -412,
 687         NIX_AF_SMQ_FLUSH_FAILED     = -413,
 688         NIX_AF_ERR_LF_RESET         = -414,
 689         NIX_AF_ERR_RSS_NOSPC_FIELD  = -415,
 690         NIX_AF_ERR_RSS_NOSPC_ALGO   = -416,
 691         NIX_AF_ERR_MARK_CFG_FAIL    = -417,
 692         NIX_AF_ERR_LSO_CFG_FAIL     = -418,
 693         NIX_AF_INVAL_NPA_PF_FUNC    = -419,
 694         NIX_AF_INVAL_SSO_PF_FUNC    = -420,
 695         NIX_AF_ERR_TX_VTAG_NOSPC    = -421,
 696         NIX_AF_ERR_RX_VTAG_INUSE    = -422,
 697         NIX_AF_ERR_PTP_CONFIG_FAIL  = -423,
 698 };
 699
 700 /* For NIX LF context alloc and init */
 701 struct nix_lf_alloc_req {
 702         struct mbox_msghdr hdr;
 703         int __otx2_io node;
 704         uint32_t __otx2_io rq_cnt;   /* No of receive queues */
 705         uint32_t __otx2_io sq_cnt;   /* No of send queues */
 706         uint32_t __otx2_io cq_cnt;   /* No of completion queues */
 707         uint8_t __otx2_io xqe_sz;
 708         uint16_t __otx2_io rss_sz;
 709         uint8_t __otx2_io rss_grps;
 710         uint16_t __otx2_io npa_func;
 711         /* RVU_DEFAULT_PF_FUNC == default pf_func associated with lf */
 712         uint16_t __otx2_io sso_func;
 713         uint64_t __otx2_io rx_cfg;   /* See NIX_AF_LF(0..127)_RX_CFG */
 714         uint64_t __otx2_io way_mask;
 715 #define NIX_LF_RSS_TAG_LSB_AS_ADDER BIT_ULL(0)
 716         uint64_t flags;
 717 };
 718
 719 struct nix_lf_alloc_rsp {
 720         struct mbox_msghdr hdr;
 721         uint16_t __otx2_io sqb_size;
 722         uint16_t __otx2_io rx_chan_base;
 723         uint16_t __otx2_io tx_chan_base;
 724         uint8_t __otx2_io rx_chan_cnt; /* Total number of RX channels */
 725         uint8_t __otx2_io tx_chan_cnt; /* Total number of TX channels */
 726         uint8_t __otx2_io lso_tsov4_idx;
 727         uint8_t __otx2_io lso_tsov6_idx;
 728         uint8_t __otx2_io mac_addr[RTE_ETHER_ADDR_LEN];
 729         uint8_t __otx2_io lf_rx_stats; /* NIX_AF_CONST1::LF_RX_STATS */
 730         uint8_t __otx2_io lf_tx_stats; /* NIX_AF_CONST1::LF_TX_STATS */
 731         uint16_t __otx2_io cints; /* NIX_AF_CONST2::CINTS */
 732         uint16_t __otx2_io qints; /* NIX_AF_CONST2::QINTS */
 733         uint8_t __otx2_io hw_rx_tstamp_en; /*set if rx timestamping enabled */
 734 };
 735
 736 struct nix_lf_free_req {
 737         struct mbox_msghdr hdr;
 738 #define NIX_LF_DISABLE_FLOWS            BIT_ULL(0)
 739 #define NIX_LF_DONT_FREE_TX_VTAG        BIT_ULL(1)
 740         uint64_t __otx2_io flags;
 741 };
 742
 743 /* NIX AQ enqueue msg */
 744 struct nix_aq_enq_req {
 745         struct mbox_msghdr hdr;
 746         uint32_t __otx2_io qidx;
 747         uint8_t __otx2_io ctype;
 748         uint8_t __otx2_io op;
 749         union {
 750                 /* Valid when op == WRITE/INIT and ctype == NIX_AQ_CTYPE_RQ */
 751                 __otx2_io struct nix_rq_ctx_s rq;
 752                 /* Valid when op == WRITE/INIT and ctype == NIX_AQ_CTYPE_SQ */
 753                 __otx2_io struct nix_sq_ctx_s sq;
 754                 /* Valid when op == WRITE/INIT and ctype == NIX_AQ_CTYPE_CQ */
 755                 __otx2_io struct nix_cq_ctx_s cq;
 756                 /* Valid when op == WRITE/INIT and ctype == NIX_AQ_CTYPE_RSS */
 757                 __otx2_io struct nix_rsse_s rss;
 758                 /* Valid when op == WRITE/INIT and ctype == NIX_AQ_CTYPE_MCE */
 759                 __otx2_io struct nix_rx_mce_s mce;
 760         };
 761         /* Mask data when op == WRITE (1=write, 0=don't write) */
 762         union {
 763                 /* Valid when op == WRITE and ctype == NIX_AQ_CTYPE_RQ */
 764                 __otx2_io struct nix_rq_ctx_s rq_mask;
 765                 /* Valid when op == WRITE and ctype == NIX_AQ_CTYPE_SQ */
 766                 __otx2_io struct nix_sq_ctx_s sq_mask;
 767                 /* Valid when op == WRITE and ctype == NIX_AQ_CTYPE_CQ */
 768                 __otx2_io struct nix_cq_ctx_s cq_mask;
 769                 /* Valid when op == WRITE and ctype == NIX_AQ_CTYPE_RSS */
 770                 __otx2_io struct nix_rsse_s rss_mask;
 771                 /* Valid when op == WRITE and ctype == NIX_AQ_CTYPE_MCE */
 772                 __otx2_io struct nix_rx_mce_s mce_mask;
 773         };
 774 };
 775
 776 struct nix_aq_enq_rsp {
 777         struct mbox_msghdr hdr;
 778         union {
 779                 __otx2_io struct nix_rq_ctx_s rq;
 780                 __otx2_io struct nix_sq_ctx_s sq;
 781                 __otx2_io struct nix_cq_ctx_s cq;
 782                 __otx2_io struct nix_rsse_s   rss;
 783                 __otx2_io struct nix_rx_mce_s mce;
 784         };
 785 };
 786
 787 /* Tx scheduler/shaper mailbox messages */
 788
 789 #define MAX_TXSCHQ_PER_FUNC     128
 790
 791 struct nix_txsch_alloc_req {
 792         struct mbox_msghdr hdr;
 793         /* Scheduler queue count request at each level */
 794         uint16_t __otx2_io schq_contig[NIX_TXSCH_LVL_CNT]; /* Contig. queues */
 795         uint16_t __otx2_io schq[NIX_TXSCH_LVL_CNT]; /* Non-Contig. queues */
 796 };
 797
 798 struct nix_txsch_alloc_rsp {
 799         struct mbox_msghdr hdr;
 800         /* Scheduler queue count allocated at each level */
 801         uint16_t __otx2_io schq_contig[NIX_TXSCH_LVL_CNT]; /* Contig. queues */
 802         uint16_t __otx2_io schq[NIX_TXSCH_LVL_CNT]; /* Non-Contig. queues */
 803         /* Scheduler queue list allocated at each level */
 804         uint16_t __otx2_io
 805                 schq_contig_list[NIX_TXSCH_LVL_CNT][MAX_TXSCHQ_PER_FUNC];
 806         uint16_t __otx2_io schq_list[NIX_TXSCH_LVL_CNT][MAX_TXSCHQ_PER_FUNC];
 807         /* Traffic aggregation scheduler level */
 808         uint8_t  __otx2_io aggr_level;
 809         /* Aggregation lvl's RR_PRIO config */
 810         uint8_t  __otx2_io aggr_lvl_rr_prio;
 811         /* LINKX_CFG CSRs mapped to TL3 or TL2's index ? */
 812         uint8_t  __otx2_io link_cfg_lvl;
 813 };
 814
 815 struct nix_txsch_free_req {
 816         struct mbox_msghdr hdr;
 817 #define TXSCHQ_FREE_ALL BIT_ULL(0)
 818         uint16_t __otx2_io flags;
 819         /* Scheduler queue level to be freed */
 820         uint16_t __otx2_io schq_lvl;
 821         /* List of scheduler queues to be freed */
 822         uint16_t __otx2_io schq;
 823 };
 824
 825 struct nix_txschq_config {
 826         struct mbox_msghdr hdr;
 827         uint8_t __otx2_io lvl; /* SMQ/MDQ/TL4/TL3/TL2/TL1 */
 828         uint8_t __otx2_io read;
 829 #define TXSCHQ_IDX_SHIFT 16
 830 #define TXSCHQ_IDX_MASK (BIT_ULL(10) - 1)
 831 #define TXSCHQ_IDX(reg, shift) (((reg) >> (shift)) & TXSCHQ_IDX_MASK)
 832         uint8_t __otx2_io num_regs;
 833 #define MAX_REGS_PER_MBOX_MSG 20
 834         uint64_t __otx2_io reg[MAX_REGS_PER_MBOX_MSG];
 835         uint64_t __otx2_io regval[MAX_REGS_PER_MBOX_MSG];
 836         /* All 0's => overwrite with new value */
 837         uint64_t __otx2_io regval_mask[MAX_REGS_PER_MBOX_MSG];
 838 };
 839
 840 struct nix_vtag_config {
 841         struct mbox_msghdr hdr;
 842         /* '0' for 4 octet VTAG, '1' for 8 octet VTAG */
 843         uint8_t __otx2_io vtag_size;
 844         /* cfg_type is '0' for tx vlan cfg
 845          * cfg_type is '1' for rx vlan cfg
 846          */
 847         uint8_t __otx2_io cfg_type;
 848         union {
 849                 /* Valid when cfg_type is '0' */
 850                 struct {
 851                         uint64_t __otx2_io vtag0;
 852                         uint64_t __otx2_io vtag1;
 853
 854                         /* cfg_vtag0 & cfg_vtag1 fields are valid
 855                          * when free_vtag0 & free_vtag1 are '0's.
 856                          */
 857                         /* cfg_vtag0 = 1 to configure vtag0 */
 858                         uint8_t __otx2_io cfg_vtag0 :1;
 859                         /* cfg_vtag1 = 1 to configure vtag1 */
 860                         uint8_t __otx2_io cfg_vtag1 :1;
 861
 862                         /* vtag0_idx & vtag1_idx are only valid when
 863                          * both cfg_vtag0 & cfg_vtag1 are '0's,
 864                          * these fields are used along with free_vtag0
 865                          * & free_vtag1 to free the nix lf's tx_vlan
 866                          * configuration.
 867                          *
 868                          * Denotes the indices of tx_vtag def registers
 869                          * that needs to be cleared and freed.
 870                          */
 871                         int __otx2_io vtag0_idx;
 872                         int __otx2_io vtag1_idx;
 873
 874                         /* Free_vtag0 & free_vtag1 fields are valid
 875                          * when cfg_vtag0 & cfg_vtag1 are '0's.
 876                          */
 877                         /* Free_vtag0 = 1 clears vtag0 configuration
 878                          * vtag0_idx denotes the index to be cleared.
 879                          */
 880                         uint8_t __otx2_io free_vtag0 :1;
 881                         /* Free_vtag1 = 1 clears vtag1 configuration
 882                          * vtag1_idx denotes the index to be cleared.
 883                          */
 884                         uint8_t __otx2_io free_vtag1 :1;
 885                 } tx;
 886
 887                 /* Valid when cfg_type is '1' */
 888                 struct {
 889                         /* Rx vtag type index, valid values are in 0..7 range */
 890                         uint8_t __otx2_io vtag_type;
 891                         /* Rx vtag strip */
 892                         uint8_t __otx2_io strip_vtag :1;
 893                         /* Rx vtag capture */
 894                         uint8_t __otx2_io capture_vtag :1;
 895                 } rx;
 896         };
 897 };
 898
 899 struct nix_vtag_config_rsp {
 900         struct mbox_msghdr hdr;
 901         /* Indices of tx_vtag def registers used to configure
 902          * tx vtag0 & vtag1 headers, these indices are valid
 903          * when nix_vtag_config mbox requested for vtag0 and/
 904          * or vtag1 configuration.
 905          */
 906         int __otx2_io vtag0_idx;
 907         int __otx2_io vtag1_idx;
 908 };
 909
 910 struct nix_rss_flowkey_cfg {
 911         struct mbox_msghdr hdr;
 912         int __otx2_io mcam_index;  /* MCAM entry index to modify */
 913         uint32_t __otx2_io flowkey_cfg; /* Flowkey types selected */
 914 #define FLOW_KEY_TYPE_PORT     BIT(0)
 915 #define FLOW_KEY_TYPE_IPV4     BIT(1)
 916 #define FLOW_KEY_TYPE_IPV6     BIT(2)
 917 #define FLOW_KEY_TYPE_TCP      BIT(3)
 918 #define FLOW_KEY_TYPE_UDP      BIT(4)
 919 #define FLOW_KEY_TYPE_SCTP     BIT(5)
 920 #define FLOW_KEY_TYPE_NVGRE    BIT(6)
 921 #define FLOW_KEY_TYPE_VXLAN    BIT(7)
 922 #define FLOW_KEY_TYPE_GENEVE   BIT(8)
 923 #define FLOW_KEY_TYPE_ETH_DMAC BIT(9)
 924 #define FLOW_KEY_TYPE_IPV6_EXT BIT(10)
 925 #define FLOW_KEY_TYPE_GTPU       BIT(11)
 926 #define FLOW_KEY_TYPE_INNR_IPV4     BIT(12)
 927 #define FLOW_KEY_TYPE_INNR_IPV6     BIT(13)
 928 #define FLOW_KEY_TYPE_INNR_TCP      BIT(14)
 929 #define FLOW_KEY_TYPE_INNR_UDP      BIT(15)
 930 #define FLOW_KEY_TYPE_INNR_SCTP     BIT(16)
 931 #define FLOW_KEY_TYPE_INNR_ETH_DMAC BIT(17)
 932 #define FLOW_KEY_TYPE_L4_DST BIT(28)
 933 #define FLOW_KEY_TYPE_L4_SRC BIT(29)
 934 #define FLOW_KEY_TYPE_L3_DST BIT(30)
 935 #define FLOW_KEY_TYPE_L3_SRC BIT(31)
 936         uint8_t __otx2_io group;       /* RSS context or group */
 937 };
 938
 939 struct nix_rss_flowkey_cfg_rsp {
 940         struct mbox_msghdr hdr;
 941         uint8_t __otx2_io alg_idx; /* Selected algo index */
 942 };
 943
 944 struct nix_set_mac_addr {
 945         struct mbox_msghdr hdr;
 946         uint8_t __otx2_io mac_addr[RTE_ETHER_ADDR_LEN];
 947 };
 948
 949 struct nix_get_mac_addr_rsp {
 950         struct mbox_msghdr hdr;
 951         uint8_t __otx2_io mac_addr[RTE_ETHER_ADDR_LEN];
 952 };
 953
 954 struct nix_mark_format_cfg {
 955         struct mbox_msghdr hdr;
 956         uint8_t __otx2_io offset;
 957         uint8_t __otx2_io y_mask;
 958         uint8_t __otx2_io y_val;
 959         uint8_t __otx2_io r_mask;
 960         uint8_t __otx2_io r_val;
 961 };
 962
 963 struct nix_mark_format_cfg_rsp {
 964         struct mbox_msghdr hdr;
 965         uint8_t __otx2_io mark_format_idx;
 966 };
 967
 968 struct nix_lso_format_cfg {
 969         struct mbox_msghdr hdr;
 970         uint64_t __otx2_io field_mask;
 971         uint64_t __otx2_io fields[NIX_LSO_FIELD_MAX];
 972 };
 973
 974 struct nix_lso_format_cfg_rsp {
 975         struct mbox_msghdr hdr;
 976         uint8_t __otx2_io lso_format_idx;
 977 };
 978
 979 struct nix_rx_mode {
 980         struct mbox_msghdr hdr;
 981 #define NIX_RX_MODE_UCAST    BIT(0)
 982 #define NIX_RX_MODE_PROMISC  BIT(1)
 983 #define NIX_RX_MODE_ALLMULTI BIT(2)
 984         uint16_t __otx2_io mode;
 985 };
 986
 987 struct nix_rx_cfg {
 988         struct mbox_msghdr hdr;
 989 #define NIX_RX_OL3_VERIFY   BIT(0)
 990 #define NIX_RX_OL4_VERIFY   BIT(1)
 991         uint8_t __otx2_io len_verify; /* Outer L3/L4 len check */
 992 #define NIX_RX_CSUM_OL4_VERIFY  BIT(0)
 993         uint8_t __otx2_io csum_verify; /* Outer L4 checksum verification */
 994 };
 995
 996 struct nix_frs_cfg {
 997         struct mbox_msghdr hdr;
 998         uint8_t __otx2_io update_smq;    /* Update SMQ's min/max lens */
 999         uint8_t __otx2_io update_minlen; /* Set minlen also */
1000         uint8_t __otx2_io sdp_link;      /* Set SDP RX link */
1001         uint16_t __otx2_io maxlen;
1002         uint16_t __otx2_io minlen;
1003 };
1004
1005 struct nix_set_vlan_tpid {
1006         struct mbox_msghdr hdr;
1007 #define NIX_VLAN_TYPE_INNER 0
1008 #define NIX_VLAN_TYPE_OUTER 1
1009         uint8_t __otx2_io vlan_type;
1010         uint16_t __otx2_io tpid;
1011 };
1012
1013 struct nix_bp_cfg_req {
1014         struct mbox_msghdr hdr;
1015         uint16_t __otx2_io chan_base; /* Starting channel number */
1016         uint8_t __otx2_io chan_cnt; /* Number of channels */
1017         uint8_t __otx2_io bpid_per_chan;
1018         /* bpid_per_chan = 0  assigns single bp id for range of channels */
1019         /* bpid_per_chan = 1 assigns separate bp id for each channel */
1020 };
1021
1022 /* PF can be mapped to either CGX or LBK interface,
1023  * so maximum 64 channels are possible.
1024  */
1025 #define NIX_MAX_CHAN    64
1026 struct nix_bp_cfg_rsp {
1027         struct mbox_msghdr hdr;
1028         /* Channel and bpid mapping */
1029         uint16_t __otx2_io chan_bpid[NIX_MAX_CHAN];
1030         /* Number of channel for which bpids are assigned */
1031         uint8_t __otx2_io chan_cnt;
1032 };
1033
1034 /* Global NIX inline IPSec configuration */
1035 struct nix_inline_ipsec_cfg {
1036         struct mbox_msghdr hdr;
1037         uint32_t __otx2_io cpt_credit;
1038         struct {
1039                 uint8_t __otx2_io egrp;
1040                 uint8_t __otx2_io opcode;
1041         } gen_cfg;
1042         struct {
1043                 uint16_t __otx2_io cpt_pf_func;
1044                 uint8_t __otx2_io cpt_slot;
1045         } inst_qsel;
1046         uint8_t __otx2_io enable;
1047 };
1048
1049 /* Per NIX LF inline IPSec configuration */
1050 struct nix_inline_ipsec_lf_cfg {
1051         struct mbox_msghdr hdr;
1052         uint64_t __otx2_io sa_base_addr;
1053         struct {
1054                 uint32_t __otx2_io tag_const;
1055                 uint16_t __otx2_io lenm1_max;
1056                 uint8_t __otx2_io sa_pow2_size;
1057                 uint8_t __otx2_io tt;
1058         } ipsec_cfg0;
1059         struct {
1060                 uint32_t __otx2_io sa_idx_max;
1061                 uint8_t __otx2_io sa_idx_w;
1062         } ipsec_cfg1;
1063         uint8_t __otx2_io enable;
1064 };
1065
1066 /* SSO mailbox error codes
1067  * Range 501 - 600.
1068  */
1069 enum sso_af_status {
1070         SSO_AF_ERR_PARAM        = -501,
1071         SSO_AF_ERR_LF_INVALID   = -502,
1072         SSO_AF_ERR_AF_LF_ALLOC  = -503,
1073         SSO_AF_ERR_GRP_EBUSY    = -504,
1074         SSO_AF_INVAL_NPA_PF_FUNC = -505,
1075 };
1076
1077 struct sso_lf_alloc_req {
1078         struct mbox_msghdr hdr;
1079         int __otx2_io node;
1080         uint16_t __otx2_io hwgrps;
1081 };
1082
1083 struct sso_lf_alloc_rsp {
1084         struct mbox_msghdr hdr;
1085         uint32_t __otx2_io xaq_buf_size;
1086         uint32_t __otx2_io xaq_wq_entries;
1087         uint32_t __otx2_io in_unit_entries;
1088         uint16_t __otx2_io hwgrps;
1089 };
1090
1091 struct sso_lf_free_req {
1092         struct mbox_msghdr hdr;
1093         int __otx2_io node;
1094         uint16_t __otx2_io hwgrps;
1095 };
1096
1097 /* SSOW mailbox error codes
1098  * Range 601 - 700.
1099  */
1100 enum ssow_af_status {
1101         SSOW_AF_ERR_PARAM       = -601,
1102         SSOW_AF_ERR_LF_INVALID  = -602,
1103         SSOW_AF_ERR_AF_LF_ALLOC = -603,
1104 };
1105
1106 struct ssow_lf_alloc_req {
1107         struct mbox_msghdr hdr;
1108         int __otx2_io node;
1109         uint16_t __otx2_io hws;
1110 };
1111
1112 struct ssow_lf_free_req {
1113         struct mbox_msghdr hdr;
1114         int __otx2_io node;
1115         uint16_t __otx2_io hws;
1116 };
1117
1118 struct sso_hw_setconfig {
1119         struct mbox_msghdr hdr;
1120         uint32_t __otx2_io npa_aura_id;
1121         uint16_t __otx2_io npa_pf_func;
1122         uint16_t __otx2_io hwgrps;
1123 };
1124
1125 struct sso_info_req {
1126         struct mbox_msghdr hdr;
1127         union {
1128                 uint16_t __otx2_io grp;
1129                 uint16_t __otx2_io hws;
1130         };
1131 };
1132
1133 struct sso_grp_priority {
1134         struct mbox_msghdr hdr;
1135         uint16_t __otx2_io grp;
1136         uint8_t __otx2_io priority;
1137         uint8_t __otx2_io affinity;
1138         uint8_t __otx2_io weight;
1139 };
1140
1141 struct sso_grp_qos_cfg {
1142         struct mbox_msghdr hdr;
1143         uint16_t __otx2_io grp;
1144         uint32_t __otx2_io xaq_limit;
1145         uint16_t __otx2_io taq_thr;
1146         uint16_t __otx2_io iaq_thr;
1147 };
1148
1149 struct sso_grp_stats {
1150         struct mbox_msghdr hdr;
1151         uint16_t __otx2_io grp;
1152         uint64_t __otx2_io ws_pc;
1153         uint64_t __otx2_io ext_pc;
1154         uint64_t __otx2_io wa_pc;
1155         uint64_t __otx2_io ts_pc;
1156         uint64_t __otx2_io ds_pc;
1157         uint64_t __otx2_io dq_pc;
1158         uint64_t __otx2_io aw_status;
1159         uint64_t __otx2_io page_cnt;
1160 };
1161
1162 struct sso_hws_stats {
1163         struct mbox_msghdr hdr;
1164         uint16_t __otx2_io hws;
1165         uint64_t __otx2_io arbitration;
1166 };
1167
1168 /* CPT mailbox error codes
1169  * Range 901 - 1000.
1170  */
1171 enum cpt_af_status {
1172         CPT_AF_ERR_PARAM                = -901,
1173         CPT_AF_ERR_GRP_INVALID          = -902,
1174         CPT_AF_ERR_LF_INVALID           = -903,
1175         CPT_AF_ERR_ACCESS_DENIED        = -904,
1176         CPT_AF_ERR_SSO_PF_FUNC_INVALID  = -905,
1177         CPT_AF_ERR_NIX_PF_FUNC_INVALID  = -906,
1178         CPT_AF_ERR_INLINE_IPSEC_INB_ENA = -907,
1179         CPT_AF_ERR_INLINE_IPSEC_OUT_ENA = -908
1180 };
1181
1182 /* CPT mbox message formats */
1183
1184 struct cpt_rd_wr_reg_msg {
1185         struct mbox_msghdr hdr;
1186         uint64_t __otx2_io reg_offset;
1187         uint64_t __otx2_io *ret_val;
1188         uint64_t __otx2_io val;
1189         uint8_t __otx2_io is_write;
1190 };
1191
1192 struct cpt_set_crypto_grp_req_msg {
1193         struct mbox_msghdr hdr;
1194         uint8_t __otx2_io crypto_eng_grp;
1195 };
1196
1197 struct cpt_lf_alloc_req_msg {
1198         struct mbox_msghdr hdr;
1199         uint16_t __otx2_io nix_pf_func;
1200         uint16_t __otx2_io sso_pf_func;
1201 };
1202
1203 struct cpt_lf_alloc_rsp_msg {
1204         struct mbox_msghdr hdr;
1205         uint8_t __otx2_io crypto_eng_grp;
1206 };
1207
1208 #define CPT_INLINE_INBOUND      0
1209 #define CPT_INLINE_OUTBOUND     1
1210
1211 struct cpt_inline_ipsec_cfg_msg {
1212         struct mbox_msghdr hdr;
1213         uint8_t __otx2_io enable;
1214         uint8_t __otx2_io slot;
1215         uint8_t __otx2_io dir;
1216         uint16_t __otx2_io sso_pf_func; /* Inbound path SSO_PF_FUNC */
1217         uint16_t __otx2_io nix_pf_func; /* Outbound path NIX_PF_FUNC */
1218 };
1219
1220 struct cpt_rx_inline_lf_cfg_msg {
1221         struct mbox_msghdr hdr;
1222         uint16_t __otx2_io sso_pf_func;
1223 };
1224
1225 /* NPC mbox message structs */
1226
1227 #define NPC_MCAM_ENTRY_INVALID  0xFFFF
1228 #define NPC_MCAM_INVALID_MAP    0xFFFF
1229
1230 /* NPC mailbox error codes
1231  * Range 701 - 800.
1232  */
1233 enum npc_af_status {
1234         NPC_MCAM_INVALID_REQ    = -701,
1235         NPC_MCAM_ALLOC_DENIED   = -702,
1236         NPC_MCAM_ALLOC_FAILED   = -703,
1237         NPC_MCAM_PERM_DENIED    = -704,
1238         NPC_AF_ERR_HIGIG_CONFIG_FAIL    = -705,
1239 };
1240
1241 struct npc_mcam_alloc_entry_req {
1242         struct mbox_msghdr hdr;
1243 #define NPC_MAX_NONCONTIG_ENTRIES       256
1244         uint8_t __otx2_io contig;   /* Contiguous entries ? */
1245 #define NPC_MCAM_ANY_PRIO               0
1246 #define NPC_MCAM_LOWER_PRIO             1
1247 #define NPC_MCAM_HIGHER_PRIO            2
1248         uint8_t __otx2_io priority; /* Lower or higher w.r.t ref_entry */
1249         uint16_t __otx2_io ref_entry;
1250         uint16_t __otx2_io count;    /* Number of entries requested */
1251 };
1252
1253 struct npc_mcam_alloc_entry_rsp {
1254         struct mbox_msghdr hdr;
1255         /* Entry alloc'ed or start index if contiguous.
1256          * Invalid in case of non-contiguous.
1257          */
1258         uint16_t __otx2_io entry;
1259         uint16_t __otx2_io count; /* Number of entries allocated */
1260         uint16_t __otx2_io free_count; /* Number of entries available */
1261         uint16_t __otx2_io entry_list[NPC_MAX_NONCONTIG_ENTRIES];
1262 };
1263
1264 struct npc_mcam_free_entry_req {
1265         struct mbox_msghdr hdr;
1266         uint16_t __otx2_io entry; /* Entry index to be freed */
1267         uint8_t __otx2_io all;   /* Free all entries alloc'ed to this PFVF */
1268 };
1269
1270 struct mcam_entry {
1271 #define NPC_MAX_KWS_IN_KEY      7 /* Number of keywords in max key width */
1272         uint64_t __otx2_io kw[NPC_MAX_KWS_IN_KEY];
1273         uint64_t __otx2_io kw_mask[NPC_MAX_KWS_IN_KEY];
1274         uint64_t __otx2_io action;
1275         uint64_t __otx2_io vtag_action;
1276 };
1277
1278 struct npc_mcam_write_entry_req {
1279         struct mbox_msghdr hdr;
1280         struct mcam_entry entry_data;
1281         uint16_t __otx2_io entry; /* MCAM entry to write this match key */
1282         uint16_t __otx2_io cntr;         /* Counter for this MCAM entry */
1283         uint8_t __otx2_io intf;  /* Rx or Tx interface */
1284         uint8_t __otx2_io enable_entry;/* Enable this MCAM entry ? */
1285         uint8_t __otx2_io set_cntr;    /* Set counter for this entry ? */
1286 };
1287
1288 /* Enable/Disable a given entry */
1289 struct npc_mcam_ena_dis_entry_req {
1290         struct mbox_msghdr hdr;
1291         uint16_t __otx2_io entry;
1292 };
1293
1294 struct npc_mcam_shift_entry_req {
1295         struct mbox_msghdr hdr;
1296 #define NPC_MCAM_MAX_SHIFTS     64
1297         uint16_t __otx2_io curr_entry[NPC_MCAM_MAX_SHIFTS];
1298         uint16_t __otx2_io new_entry[NPC_MCAM_MAX_SHIFTS];
1299         uint16_t __otx2_io shift_count; /* Number of entries to shift */
1300 };
1301
1302 struct npc_mcam_shift_entry_rsp {
1303         struct mbox_msghdr hdr;
1304         /* Index in 'curr_entry', not entry itself */
1305         uint16_t __otx2_io failed_entry_idx;
1306 };
1307
1308 struct npc_mcam_alloc_counter_req {
1309         struct mbox_msghdr hdr;
1310         uint8_t __otx2_io contig;       /* Contiguous counters ? */
1311 #define NPC_MAX_NONCONTIG_COUNTERS 64
1312         uint16_t __otx2_io count;       /* Number of counters requested */
1313 };
1314
1315 struct npc_mcam_alloc_counter_rsp {
1316         struct mbox_msghdr hdr;
1317         /* Counter alloc'ed or start idx if contiguous.
1318          * Invalid incase of non-contiguous.
1319          */
1320         uint16_t __otx2_io cntr;
1321         uint16_t __otx2_io count; /* Number of counters allocated */
1322         uint16_t __otx2_io cntr_list[NPC_MAX_NONCONTIG_COUNTERS];
1323 };
1324
1325 struct npc_mcam_oper_counter_req {
1326         struct mbox_msghdr hdr;
1327         uint16_t __otx2_io cntr; /* Free a counter or clear/fetch it's stats */
1328 };
1329
1330 struct npc_mcam_oper_counter_rsp {
1331         struct mbox_msghdr hdr;
1332         /* valid only while fetching counter's stats */
1333         uint64_t __otx2_io stat;
1334 };
1335
1336 struct npc_mcam_unmap_counter_req {
1337         struct mbox_msghdr hdr;
1338         uint16_t __otx2_io cntr;
1339         uint16_t __otx2_io entry; /* Entry and counter to be unmapped */
1340         uint8_t __otx2_io all;   /* Unmap all entries using this counter ? */
1341 };
1342
1343 struct npc_mcam_alloc_and_write_entry_req {
1344         struct mbox_msghdr hdr;
1345         struct mcam_entry entry_data;
1346         uint16_t __otx2_io ref_entry;
1347         uint8_t __otx2_io priority;    /* Lower or higher w.r.t ref_entry */
1348         uint8_t __otx2_io intf;  /* Rx or Tx interface */
1349         uint8_t __otx2_io enable_entry;/* Enable this MCAM entry ? */
1350         uint8_t __otx2_io alloc_cntr;  /* Allocate counter and map ? */
1351 };
1352
1353 struct npc_mcam_alloc_and_write_entry_rsp {
1354         struct mbox_msghdr hdr;
1355         uint16_t __otx2_io entry;
1356         uint16_t __otx2_io cntr;
1357 };
1358
1359 struct npc_get_kex_cfg_rsp {
1360         struct mbox_msghdr hdr;
1361         uint64_t __otx2_io rx_keyx_cfg;   /* NPC_AF_INTF(0)_KEX_CFG */
1362         uint64_t __otx2_io tx_keyx_cfg;   /* NPC_AF_INTF(1)_KEX_CFG */
1363 #define NPC_MAX_INTF    2
1364 #define NPC_MAX_LID     8
1365 #define NPC_MAX_LT      16
1366 #define NPC_MAX_LD      2
1367 #define NPC_MAX_LFL     16
1368         /* NPC_AF_KEX_LDATA(0..1)_FLAGS_CFG */
1369         uint64_t __otx2_io kex_ld_flags[NPC_MAX_LD];
1370         /* NPC_AF_INTF(0..1)_LID(0..7)_LT(0..15)_LD(0..1)_CFG */
1371         uint64_t __otx2_io
1372         intf_lid_lt_ld[NPC_MAX_INTF][NPC_MAX_LID][NPC_MAX_LT][NPC_MAX_LD];
1373         /* NPC_AF_INTF(0..1)_LDATA(0..1)_FLAGS(0..15)_CFG */
1374         uint64_t __otx2_io
1375         intf_ld_flags[NPC_MAX_INTF][NPC_MAX_LD][NPC_MAX_LFL];
1376 #define MKEX_NAME_LEN 128
1377         uint8_t __otx2_io mkex_pfl_name[MKEX_NAME_LEN];
1378 };
1379
1380 enum header_fields {
1381         NPC_DMAC,
1382         NPC_SMAC,
1383         NPC_ETYPE,
1384         NPC_OUTER_VID,
1385         NPC_TOS,
1386         NPC_SIP_IPV4,
1387         NPC_DIP_IPV4,
1388         NPC_SIP_IPV6,
1389         NPC_DIP_IPV6,
1390         NPC_SPORT_TCP,
1391         NPC_DPORT_TCP,
1392         NPC_SPORT_UDP,
1393         NPC_DPORT_UDP,
1394         NPC_HEADER_FIELDS_MAX,
1395 };
1396
1397 struct flow_msg {
1398         unsigned char __otx2_io dmac[6];
1399         unsigned char __otx2_io smac[6];
1400         uint16_t __otx2_io etype;
1401         uint16_t __otx2_io vlan_etype;
1402         uint16_t __otx2_io vlan_tci;
1403         union {
1404                 uint32_t __otx2_io ip4src;
1405                 uint32_t __otx2_io ip6src[4];
1406         };
1407         union {
1408                 uint32_t __otx2_io ip4dst;
1409                 uint32_t __otx2_io ip6dst[4];
1410         };
1411         uint8_t __otx2_io tos;
1412         uint8_t __otx2_io ip_ver;
1413         uint8_t __otx2_io ip_proto;
1414         uint8_t __otx2_io tc;
1415         uint16_t __otx2_io sport;
1416         uint16_t __otx2_io dport;
1417 };
1418
1419 struct npc_install_flow_req {
1420         struct mbox_msghdr hdr;
1421         struct flow_msg packet;
1422         struct flow_msg mask;
1423         uint64_t __otx2_io features;
1424         uint16_t __otx2_io entry;
1425         uint16_t __otx2_io channel;
1426         uint8_t __otx2_io intf;
1427         uint8_t __otx2_io set_cntr;
1428         uint8_t __otx2_io default_rule;
1429         /* Overwrite(0) or append(1) flow to default rule? */
1430         uint8_t __otx2_io append;
1431         uint16_t __otx2_io vf;
1432         /* action */
1433         uint32_t __otx2_io index;
1434         uint16_t __otx2_io match_id;
1435         uint8_t __otx2_io flow_key_alg;
1436         uint8_t __otx2_io op;
1437         /* vtag action */
1438         uint8_t __otx2_io vtag0_type;
1439         uint8_t __otx2_io vtag0_valid;
1440         uint8_t __otx2_io vtag1_type;
1441         uint8_t __otx2_io vtag1_valid;
1442
1443         /* vtag tx action */
1444         uint16_t __otx2_io vtag0_def;
1445         uint8_t  __otx2_io vtag0_op;
1446         uint16_t __otx2_io vtag1_def;
1447         uint8_t  __otx2_io vtag1_op;
1448 };
1449
1450 struct npc_install_flow_rsp {
1451         struct mbox_msghdr hdr;
1452         /* Negative if no counter else counter number */
1453         int __otx2_io counter;
1454 };
1455
1456 struct npc_delete_flow_req {
1457         struct mbox_msghdr hdr;
1458         uint16_t __otx2_io entry;
1459         uint16_t __otx2_io start;/*Disable range of entries */
1460         uint16_t __otx2_io end;
1461         uint8_t __otx2_io all; /* PF + VFs */
1462 };
1463
1464 struct npc_mcam_read_entry_req {
1465         struct mbox_msghdr hdr;
1466         /* MCAM entry to read */
1467         uint16_t __otx2_io entry;
1468 };
1469
1470 struct npc_mcam_read_entry_rsp {
1471         struct mbox_msghdr hdr;
1472         struct mcam_entry entry_data;
1473         uint8_t __otx2_io intf;
1474         uint8_t __otx2_io enable;
1475 };
1476
1477 /* TIM mailbox error codes
1478  * Range 801 - 900.
1479  */
1480 enum tim_af_status {
1481         TIM_AF_NO_RINGS_LEFT                    = -801,
1482         TIM_AF_INVALID_NPA_PF_FUNC              = -802,
1483         TIM_AF_INVALID_SSO_PF_FUNC              = -803,
1484         TIM_AF_RING_STILL_RUNNING               = -804,
1485         TIM_AF_LF_INVALID                       = -805,
1486         TIM_AF_CSIZE_NOT_ALIGNED                = -806,
1487         TIM_AF_CSIZE_TOO_SMALL                  = -807,
1488         TIM_AF_CSIZE_TOO_BIG                    = -808,
1489         TIM_AF_INTERVAL_TOO_SMALL               = -809,
1490         TIM_AF_INVALID_BIG_ENDIAN_VALUE         = -810,
1491         TIM_AF_INVALID_CLOCK_SOURCE             = -811,
1492         TIM_AF_GPIO_CLK_SRC_NOT_ENABLED         = -812,
1493         TIM_AF_INVALID_BSIZE                    = -813,
1494         TIM_AF_INVALID_ENABLE_PERIODIC          = -814,
1495         TIM_AF_INVALID_ENABLE_DONTFREE          = -815,
1496         TIM_AF_ENA_DONTFRE_NSET_PERIODIC        = -816,
1497         TIM_AF_RING_ALREADY_DISABLED            = -817,
1498 };
1499
1500 enum tim_clk_srcs {
1501         TIM_CLK_SRCS_TENNS      = 0,
1502         TIM_CLK_SRCS_GPIO       = 1,
1503         TIM_CLK_SRCS_GTI        = 2,
1504         TIM_CLK_SRCS_PTP        = 3,
1505         TIM_CLK_SRSC_INVALID,
1506 };
1507
1508 enum tim_gpio_edge {
1509         TIM_GPIO_NO_EDGE                = 0,
1510         TIM_GPIO_LTOH_TRANS             = 1,
1511         TIM_GPIO_HTOL_TRANS             = 2,
1512         TIM_GPIO_BOTH_TRANS             = 3,
1513         TIM_GPIO_INVALID,
1514 };
1515
1516 enum ptp_op {
1517         PTP_OP_ADJFINE = 0, /* adjfine(req.scaled_ppm); */
1518         PTP_OP_GET_CLOCK = 1, /* rsp.clk = get_clock() */
1519 };
1520
1521 struct ptp_req {
1522         struct mbox_msghdr hdr;
1523         uint8_t __otx2_io op;
1524         int64_t __otx2_io scaled_ppm;
1525         uint8_t __otx2_io is_pmu;
1526 };
1527
1528 struct ptp_rsp {
1529         struct mbox_msghdr hdr;
1530         uint64_t __otx2_io clk;
1531         uint64_t __otx2_io tsc;
1532 };
1533
1534 struct get_hw_cap_rsp {
1535         struct mbox_msghdr hdr;
1536         /* Schq mapping fixed or flexible */
1537         uint8_t __otx2_io nix_fixed_txschq_mapping;
1538         uint8_t __otx2_io nix_shaping; /* Is shaping and coloring supported */
1539 };
1540
1541 struct ndc_sync_op {
1542         struct mbox_msghdr hdr;
1543         uint8_t __otx2_io nix_lf_tx_sync;
1544         uint8_t __otx2_io nix_lf_rx_sync;
1545         uint8_t __otx2_io npa_lf_sync;
1546 };
1547
1548 struct tim_lf_alloc_req {
1549         struct mbox_msghdr hdr;
1550         uint16_t __otx2_io ring;
1551         uint16_t __otx2_io npa_pf_func;
1552         uint16_t __otx2_io sso_pf_func;
1553 };
1554
1555 struct tim_ring_req {
1556         struct mbox_msghdr hdr;
1557         uint16_t __otx2_io ring;
1558 };
1559
1560 struct tim_config_req {
1561         struct mbox_msghdr hdr;
1562         uint16_t __otx2_io ring;
1563         uint8_t __otx2_io bigendian;
1564         uint8_t __otx2_io clocksource;
1565         uint8_t __otx2_io enableperiodic;
1566         uint8_t __otx2_io enabledontfreebuffer;
1567         uint32_t __otx2_io bucketsize;
1568         uint32_t __otx2_io chunksize;
1569         uint32_t __otx2_io interval;
1570 };
1571
1572 struct tim_lf_alloc_rsp {
1573         struct mbox_msghdr hdr;
1574         uint64_t __otx2_io tenns_clk;
1575 };
1576
1577 struct tim_enable_rsp {
1578         struct mbox_msghdr hdr;
1579         uint64_t __otx2_io timestarted;
1580         uint32_t __otx2_io currentbucket;
1581 };
1582
1583 const char *otx2_mbox_id2name(uint16_t id);
1584 int otx2_mbox_id2size(uint16_t id);
1585 void otx2_mbox_reset(struct otx2_mbox *mbox, int devid);
1586 int otx2_mbox_init(struct otx2_mbox *mbox, uintptr_t hwbase, uintptr_t reg_base,
1587                    int direction, int ndevsi, uint64_t intr_offset);
1588 void otx2_mbox_fini(struct otx2_mbox *mbox);
1589 void otx2_mbox_msg_send(struct otx2_mbox *mbox, int devid);
1590 int otx2_mbox_wait_for_rsp(struct otx2_mbox *mbox, int devid);
1591 int otx2_mbox_wait_for_rsp_tmo(struct otx2_mbox *mbox, int devid, uint32_t tmo);
1592 int otx2_mbox_get_rsp(struct otx2_mbox *mbox, int devid, void **msg);
1593 int otx2_mbox_get_rsp_tmo(struct otx2_mbox *mbox, int devid, void **msg,
1594                           uint32_t tmo);
1595 int otx2_mbox_get_availmem(struct otx2_mbox *mbox, int devid);
1596 struct mbox_msghdr *otx2_mbox_alloc_msg_rsp(struct otx2_mbox *mbox, int devid,
1597                                             int size, int size_rsp);
1598
1599 static inline struct mbox_msghdr *
1600 otx2_mbox_alloc_msg(struct otx2_mbox *mbox, int devid, int size)
1601 {
1602         return otx2_mbox_alloc_msg_rsp(mbox, devid, size, 0);
1603 }
1604
1605 static inline void
1606 otx2_mbox_req_init(uint16_t mbox_id, void *msghdr)
1607 {
1608         struct mbox_msghdr *hdr = msghdr;
1609
1610         hdr->sig = OTX2_MBOX_REQ_SIG;
1611         hdr->ver = OTX2_MBOX_VERSION;
1612         hdr->id = mbox_id;
1613         hdr->pcifunc = 0;
1614 }
1615
1616 static inline void
1617 otx2_mbox_rsp_init(uint16_t mbox_id, void *msghdr)
1618 {
1619         struct mbox_msghdr *hdr = msghdr;
1620
1621         hdr->sig = OTX2_MBOX_RSP_SIG;
1622         hdr->rc = -ETIMEDOUT;
1623         hdr->id = mbox_id;
1624 }
1625
1626 static inline bool
1627 otx2_mbox_nonempty(struct otx2_mbox *mbox, int devid)
1628 {
1629         struct otx2_mbox_dev *mdev = &mbox->dev[devid];
1630         bool ret;
1631
1632         rte_spinlock_lock(&mdev->mbox_lock);
1633         ret = mdev->num_msgs != 0;
1634         rte_spinlock_unlock(&mdev->mbox_lock);
1635
1636         return ret;
1637 }
1638
1639 static inline int
1640 otx2_mbox_process(struct otx2_mbox *mbox)
1641 {
1642         otx2_mbox_msg_send(mbox, 0);
1643         return otx2_mbox_get_rsp(mbox, 0, NULL);
1644 }
1645
1646 static inline int
1647 otx2_mbox_process_msg(struct otx2_mbox *mbox, void **msg)
1648 {
1649         otx2_mbox_msg_send(mbox, 0);
1650         return otx2_mbox_get_rsp(mbox, 0, msg);
1651 }
1652
1653 static inline int
1654 otx2_mbox_process_tmo(struct otx2_mbox *mbox, uint32_t tmo)
1655 {
1656         otx2_mbox_msg_send(mbox, 0);
1657         return otx2_mbox_get_rsp_tmo(mbox, 0, NULL, tmo);
1658 }
1659
1660 static inline int
1661 otx2_mbox_process_msg_tmo(struct otx2_mbox *mbox, void **msg, uint32_t tmo)
1662 {
1663         otx2_mbox_msg_send(mbox, 0);
1664         return otx2_mbox_get_rsp_tmo(mbox, 0, msg, tmo);
1665 }
1666
1667 int otx2_send_ready_msg(struct otx2_mbox *mbox, uint16_t *pf_func /* out */);
1668 int otx2_reply_invalid_msg(struct otx2_mbox *mbox, int devid, uint16_t pf_func,
1669                         uint16_t id);
1670
1671 #define M(_name, _id, _fn_name, _req_type, _rsp_type)                   \
1672 static inline struct _req_type                                          \
1673 *otx2_mbox_alloc_msg_ ## _fn_name(struct otx2_mbox *mbox)               \
1674 {                                                                       \
1675         struct _req_type *req;                                          \
1676                                                                         \
1677         req = (struct _req_type *)otx2_mbox_alloc_msg_rsp(              \
1678                 mbox, 0, sizeof(struct _req_type),                      \
1679                 sizeof(struct _rsp_type));                              \
1680         if (!req)                                                       \
1681                 return NULL;                                            \
1682                                                                         \
1683         req->hdr.sig = OTX2_MBOX_REQ_SIG;                               \
1684         req->hdr.id = _id;                                              \
1685         otx2_mbox_dbg("id=0x%x (%s)",                                   \
1686                         req->hdr.id, otx2_mbox_id2name(req->hdr.id));   \
1687         return req;                                                     \
1688 }
1689
1690 MBOX_MESSAGES
1691 #undef M
1692
1693 /* This is required for copy operations from device memory which do not work on
1694  * addresses which are unaligned to 16B. This is because of specific
1695  * optimizations to libc memcpy.
1696  */
1697 static inline volatile void *
1698 otx2_mbox_memcpy(volatile void *d, const volatile void *s, size_t l)
1699 {
1700         const volatile uint8_t *sb;
1701         volatile uint8_t *db;
1702         size_t i;
1703
1704         if (!d || !s)
1705                 return NULL;
1706         db = (volatile uint8_t *)d;
1707         sb = (const volatile uint8_t *)s;
1708         for (i = 0; i < l; i++)
1709                 db[i] = sb[i];
1710         return d;
1711 }
1712
1713 /* This is required for memory operations from device memory which do not
1714  * work on addresses which are unaligned to 16B. This is because of specific
1715  * optimizations to libc memset.
1716  */
1717 static inline void
1718 otx2_mbox_memset(volatile void *d, uint8_t val, size_t l)
1719 {
1720         volatile uint8_t *db;
1721         size_t i = 0;
1722
1723         if (!d || !l)
1724                 return;
1725         db = (volatile uint8_t *)d;
1726         for (i = 0; i < l; i++)
1727                 db[i] = val;
1728 }
1729
1730 #endif /* __OTX2_MBOX_H__ */