/* SPDX-License-Identifier: GPL-2.0 */
/*  Marvell OcteonTx2 RVU Admin Function driver
 *
 * Copyright (C) 2018 Marvell International Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef MBOX_H
#define MBOX_H

#include <linux/etherdevice.h>
#include <linux/sizes.h>

#include "rvu_struct.h"
#include "common.h"

#define MBOX_SIZE               SZ_64K

/* AF/PF: PF initiated, PF/VF VF initiated */
#define MBOX_DOWN_RX_START      0
#define MBOX_DOWN_RX_SIZE       (46 * SZ_1K)
#define MBOX_DOWN_TX_START      (MBOX_DOWN_RX_START + MBOX_DOWN_RX_SIZE)
#define MBOX_DOWN_TX_SIZE       (16 * SZ_1K)
/* AF/PF: AF initiated, PF/VF PF initiated */
#define MBOX_UP_RX_START        (MBOX_DOWN_TX_START + MBOX_DOWN_TX_SIZE)
#define MBOX_UP_RX_SIZE         SZ_1K
#define MBOX_UP_TX_START        (MBOX_UP_RX_START + MBOX_UP_RX_SIZE)
#define MBOX_UP_TX_SIZE         SZ_1K

#if MBOX_UP_TX_SIZE + MBOX_UP_TX_START != MBOX_SIZE
# error "incorrect mailbox area sizes"
#endif

#define INTR_MASK(pfvfs) ((pfvfs < 64) ? (BIT_ULL(pfvfs) - 1) : (~0ull))

#define MBOX_RSP_TIMEOUT        2000 /* Time(ms) to wait for mbox response */

#define MBOX_MSG_ALIGN          16  /* Align mbox msg start to 16bytes */

/* Mailbox directions */
#define MBOX_DIR_AFPF           0  /* AF replies to PF */
#define MBOX_DIR_PFAF           1  /* PF sends messages to AF */
#define MBOX_DIR_PFVF           2  /* PF replies to VF */
#define MBOX_DIR_VFPF           3  /* VF sends messages to PF */
#define MBOX_DIR_AFPF_UP        4  /* AF sends messages to PF */
#define MBOX_DIR_PFAF_UP        5  /* PF replies to AF */
#define MBOX_DIR_PFVF_UP        6  /* PF sends messages to VF */
#define MBOX_DIR_VFPF_UP        7  /* VF replies to PF */

struct otx2_mbox_dev {
        void        *mbase;   /* This dev's mbox region */
        spinlock_t  mbox_lock;
        u16         msg_size; /* Total msg size to be sent */
        u16         rsp_size; /* Total rsp size to be sure the reply is ok */
        u16         num_msgs; /* No of msgs sent or waiting for response */
        u16         msgs_acked; /* No of msgs for which response is received */
};

struct otx2_mbox {
        struct pci_dev *pdev;
        void   *hwbase;  /* Mbox region advertised by HW */
        void   *reg_base;/* CSR base for this dev */
        u64    trigger;  /* Trigger mbox notification */
        u16    tr_shift; /* Mbox trigger shift */
        u64    rx_start; /* Offset of Rx region in mbox memory */
        u64    tx_start; /* Offset of Tx region in mbox memory */
        u16    rx_size;  /* Size of Rx region */
        u16    tx_size;  /* Size of Tx region */
        u16    ndevs;    /* The number of peers */
        struct otx2_mbox_dev *dev;
};

/* Header which preceeds all mbox messages */
struct mbox_hdr {
        u64 msg_size;   /* Total msgs size embedded */
        u16  num_msgs;   /* No of msgs embedded */
};

/* Header which preceeds every msg and is also part of it */
struct mbox_msghdr {
        u16 pcifunc;     /* Who's sending this msg */
        u16 id;          /* Mbox message ID */
#define OTX2_MBOX_REQ_SIG (0xdead)
#define OTX2_MBOX_RSP_SIG (0xbeef)
        u16 sig;         /* Signature, for validating corrupted msgs */
#define OTX2_MBOX_VERSION (0x0007)
        u16 ver;         /* Version of msg's structure for this ID */
        u16 next_msgoff; /* Offset of next msg within mailbox region */
        int rc;          /* Msg process'ed response code */
};

void otx2_mbox_reset(struct otx2_mbox *mbox, int devid);
void __otx2_mbox_reset(struct otx2_mbox *mbox, int devid);
void otx2_mbox_destroy(struct otx2_mbox *mbox);
int otx2_mbox_init(struct otx2_mbox *mbox, void __force *hwbase,
                   struct pci_dev *pdev, void __force *reg_base,
                   int direction, int ndevs);
void otx2_mbox_msg_send(struct otx2_mbox *mbox, int devid);
int otx2_mbox_wait_for_rsp(struct otx2_mbox *mbox, int devid);
int otx2_mbox_busy_poll_for_rsp(struct otx2_mbox *mbox, int devid);
struct mbox_msghdr *otx2_mbox_alloc_msg_rsp(struct otx2_mbox *mbox, int devid,
                                            int size, int size_rsp);
struct mbox_msghdr *otx2_mbox_get_rsp(struct otx2_mbox *mbox, int devid,
                                      struct mbox_msghdr *msg);
int otx2_mbox_check_rsp_msgs(struct otx2_mbox *mbox, int devid);
int otx2_reply_invalid_msg(struct otx2_mbox *mbox, int devid,
                           u16 pcifunc, u16 id);
bool otx2_mbox_nonempty(struct otx2_mbox *mbox, int devid);
const char *otx2_mbox_id2name(u16 id);
static inline struct mbox_msghdr *otx2_mbox_alloc_msg(struct otx2_mbox *mbox,
                                                      int devid, int size)
{
        return otx2_mbox_alloc_msg_rsp(mbox, devid, size, 0);
}

/* Mailbox message types */
#define MBOX_MSG_MASK                           0xFFFF
#define MBOX_MSG_INVALID                        0xFFFE
#define MBOX_MSG_MAX                            0xFFFF

#define MBOX_MESSAGES                                                   \
/* Generic mbox IDs (range 0x000 - 0x1FF) */                            \
M(READY,                0x001, ready, msg_req, ready_msg_rsp)           \
M(ATTACH_RESOURCES,     0x002, attach_resources, rsrc_attach, msg_rsp)  \
M(DETACH_RESOURCES,     0x003, detach_resources, rsrc_detach, msg_rsp)  \
M(MSIX_OFFSET,          0x005, msix_offset, msg_req, msix_offset_rsp)   \
M(VF_FLR,               0x006, vf_flr, msg_req, msg_rsp)                \
M(PTP_OP,               0x007, ptp_op, ptp_req, ptp_rsp)                \
M(GET_HW_CAP,           0x008, get_hw_cap, msg_req, get_hw_cap_rsp)     \
/* CGX mbox IDs (range 0x200 - 0x3FF) */                                \
M(CGX_START_RXTX,       0x200, cgx_start_rxtx, msg_req, msg_rsp)        \
M(CGX_STOP_RXTX,        0x201, cgx_stop_rxtx, msg_req, msg_rsp)         \
M(CGX_STATS,            0x202, cgx_stats, msg_req, cgx_stats_rsp)       \
M(CGX_MAC_ADDR_SET,     0x203, cgx_mac_addr_set, cgx_mac_addr_set_or_get,    \
                                cgx_mac_addr_set_or_get)                \
M(CGX_MAC_ADDR_GET,     0x204, cgx_mac_addr_get, cgx_mac_addr_set_or_get,    \
                                cgx_mac_addr_set_or_get)                \
M(CGX_PROMISC_ENABLE,   0x205, cgx_promisc_enable, msg_req, msg_rsp)    \
M(CGX_PROMISC_DISABLE,  0x206, cgx_promisc_disable, msg_req, msg_rsp)   \
M(CGX_START_LINKEVENTS, 0x207, cgx_start_linkevents, msg_req, msg_rsp)  \
M(CGX_STOP_LINKEVENTS,  0x208, cgx_stop_linkevents, msg_req, msg_rsp)   \
M(CGX_GET_LINKINFO,     0x209, cgx_get_linkinfo, msg_req, cgx_link_info_msg) \
M(CGX_INTLBK_ENABLE,    0x20A, cgx_intlbk_enable, msg_req, msg_rsp)     \
M(CGX_INTLBK_DISABLE,   0x20B, cgx_intlbk_disable, msg_req, msg_rsp)    \
M(CGX_PTP_RX_ENABLE,    0x20C, cgx_ptp_rx_enable, msg_req, msg_rsp)     \
M(CGX_PTP_RX_DISABLE,   0x20D, cgx_ptp_rx_disable, msg_req, msg_rsp)    \
M(CGX_CFG_PAUSE_FRM,    0x20E, cgx_cfg_pause_frm, cgx_pause_frm_cfg,    \
                               cgx_pause_frm_cfg)                       \
/* NPA mbox IDs (range 0x400 - 0x5FF) */                                \
M(NPA_LF_ALLOC,         0x400, npa_lf_alloc,                            \
                                npa_lf_alloc_req, npa_lf_alloc_rsp)     \
M(NPA_LF_FREE,          0x401, npa_lf_free, msg_req, msg_rsp)           \
M(NPA_AQ_ENQ,           0x402, npa_aq_enq, npa_aq_enq_req, npa_aq_enq_rsp)   \
M(NPA_HWCTX_DISABLE,    0x403, npa_hwctx_disable, hwctx_disable_req, msg_rsp)\
/* SSO/SSOW mbox IDs (range 0x600 - 0x7FF) */                           \
/* TIM mbox IDs (range 0x800 - 0x9FF) */                                \
/* CPT mbox IDs (range 0xA00 - 0xBFF) */                                \
M(CPT_LF_ALLOC,         0xA00, cpt_lf_alloc, cpt_lf_alloc_req_msg,      \
                               msg_rsp)                                 \
M(CPT_LF_FREE,          0xA01, cpt_lf_free, msg_req, msg_rsp)           \
M(CPT_RD_WR_REGISTER,   0xA02, cpt_rd_wr_register,  cpt_rd_wr_reg_msg,  \
                               cpt_rd_wr_reg_msg)                       \
/* NPC mbox IDs (range 0x6000 - 0x7FFF) */                              \
M(NPC_MCAM_ALLOC_ENTRY, 0x6000, npc_mcam_alloc_entry, npc_mcam_alloc_entry_req,\
                                npc_mcam_alloc_entry_rsp)               \
M(NPC_MCAM_FREE_ENTRY,  0x6001, npc_mcam_free_entry,                    \
                                 npc_mcam_free_entry_req, msg_rsp)      \
M(NPC_MCAM_WRITE_ENTRY, 0x6002, npc_mcam_write_entry,                   \
                                 npc_mcam_write_entry_req, msg_rsp)     \
M(NPC_MCAM_ENA_ENTRY,   0x6003, npc_mcam_ena_entry,                     \
                                 npc_mcam_ena_dis_entry_req, msg_rsp)   \
M(NPC_MCAM_DIS_ENTRY,   0x6004, npc_mcam_dis_entry,                     \
                                 npc_mcam_ena_dis_entry_req, msg_rsp)   \
M(NPC_MCAM_SHIFT_ENTRY, 0x6005, npc_mcam_shift_entry, npc_mcam_shift_entry_req,\
                                npc_mcam_shift_entry_rsp)               \
M(NPC_MCAM_ALLOC_COUNTER, 0x6006, npc_mcam_alloc_counter,               \
                                        npc_mcam_alloc_counter_req,     \
                                        npc_mcam_alloc_counter_rsp)     \
M(NPC_MCAM_FREE_COUNTER,  0x6007, npc_mcam_free_counter,                \
                                    npc_mcam_oper_counter_req, msg_rsp) \
M(NPC_MCAM_UNMAP_COUNTER, 0x6008, npc_mcam_unmap_counter,               \
                                   npc_mcam_unmap_counter_req, msg_rsp) \
M(NPC_MCAM_CLEAR_COUNTER, 0x6009, npc_mcam_clear_counter,               \
                                   npc_mcam_oper_counter_req, msg_rsp)  \
M(NPC_MCAM_COUNTER_STATS, 0x600a, npc_mcam_counter_stats,               \
                                   npc_mcam_oper_counter_req,           \
                                   npc_mcam_oper_counter_rsp)           \
M(NPC_MCAM_ALLOC_AND_WRITE_ENTRY, 0x600b, npc_mcam_alloc_and_write_entry,      \
                                          npc_mcam_alloc_and_write_entry_req,  \
                                          npc_mcam_alloc_and_write_entry_rsp)  \
M(NPC_GET_KEX_CFG,        0x600c, npc_get_kex_cfg,                      \
                                   msg_req, npc_get_kex_cfg_rsp)        \
M(NPC_INSTALL_FLOW,       0x600d, npc_install_flow,                            \
                                  npc_install_flow_req, npc_install_flow_rsp)  \
M(NPC_DELETE_FLOW,        0x600e, npc_delete_flow,                      \
                                  npc_delete_flow_req, msg_rsp)         \
M(NPC_MCAM_READ_ENTRY,    0x600f, npc_mcam_read_entry,                  \
                                  npc_mcam_read_entry_req,              \
                                  npc_mcam_read_entry_rsp)              \
M(NPC_MCAM_READ_BASE_RULE, 0x6011, npc_read_base_steer_rule,            \
                                   msg_req, npc_mcam_read_base_rule_rsp)  \
/* NIX mbox IDs (range 0x8000 - 0xFFFF) */                              \
M(NIX_LF_ALLOC,         0x8000, nix_lf_alloc,                           \
                                 nix_lf_alloc_req, nix_lf_alloc_rsp)    \
M(NIX_LF_FREE,          0x8001, nix_lf_free, nix_lf_free_req, msg_rsp)  \
M(NIX_AQ_ENQ,           0x8002, nix_aq_enq, nix_aq_enq_req, nix_aq_enq_rsp)  \
M(NIX_HWCTX_DISABLE,    0x8003, nix_hwctx_disable,                      \
                                 hwctx_disable_req, msg_rsp)            \
M(NIX_TXSCH_ALLOC,      0x8004, nix_txsch_alloc,                        \
                                 nix_txsch_alloc_req, nix_txsch_alloc_rsp)   \
M(NIX_TXSCH_FREE,       0x8005, nix_txsch_free, nix_txsch_free_req, msg_rsp) \
M(NIX_TXSCHQ_CFG,       0x8006, nix_txschq_cfg, nix_txschq_config, msg_rsp)  \
M(NIX_STATS_RST,        0x8007, nix_stats_rst, msg_req, msg_rsp)        \
M(NIX_VTAG_CFG,         0x8008, nix_vtag_cfg, nix_vtag_config,          \
                                 nix_vtag_config_rsp)                   \
M(NIX_RSS_FLOWKEY_CFG,  0x8009, nix_rss_flowkey_cfg,                    \
                                 nix_rss_flowkey_cfg,                   \
                                 nix_rss_flowkey_cfg_rsp)               \
M(NIX_SET_MAC_ADDR,     0x800a, nix_set_mac_addr, nix_set_mac_addr, msg_rsp) \
M(NIX_SET_RX_MODE,      0x800b, nix_set_rx_mode, nix_rx_mode, msg_rsp)  \
M(NIX_SET_HW_FRS,       0x800c, nix_set_hw_frs, nix_frs_cfg, msg_rsp)   \
M(NIX_LF_START_RX,      0x800d, nix_lf_start_rx, msg_req, msg_rsp)      \
M(NIX_LF_STOP_RX,       0x800e, nix_lf_stop_rx, msg_req, msg_rsp)       \
M(NIX_MARK_FORMAT_CFG,  0x800f, nix_mark_format_cfg,                    \
                                 nix_mark_format_cfg,                   \
                                 nix_mark_format_cfg_rsp)               \
M(NIX_SET_RX_CFG,       0x8010, nix_set_rx_cfg, nix_rx_cfg, msg_rsp)    \
M(NIX_LSO_FORMAT_CFG,   0x8011, nix_lso_format_cfg,                     \
                                 nix_lso_format_cfg,                    \
                                 nix_lso_format_cfg_rsp)                \
M(NIX_LF_PTP_TX_ENABLE, 0x8013, nix_lf_ptp_tx_enable, msg_req, msg_rsp) \
M(NIX_LF_PTP_TX_DISABLE, 0x8014, nix_lf_ptp_tx_disable, msg_req, msg_rsp) \
M(NIX_BP_ENABLE,        0x8016, nix_bp_enable, nix_bp_cfg_req,  \
                                nix_bp_cfg_rsp) \
M(NIX_BP_DISABLE,       0x8017, nix_bp_disable, nix_bp_cfg_req, msg_rsp) \
M(NIX_GET_MAC_ADDR, 0x8018, nix_get_mac_addr, msg_req, nix_get_mac_addr_rsp) \

/* Messages initiated by AF (range 0xC00 - 0xDFF) */
#define MBOX_UP_CGX_MESSAGES                                            \
M(CGX_LINK_EVENT,       0xC00, cgx_link_event, cgx_link_info_msg, msg_rsp)

enum {
#define M(_name, _id, _1, _2, _3) MBOX_MSG_ ## _name = _id,
MBOX_MESSAGES
MBOX_UP_CGX_MESSAGES
#undef M
};

/* Mailbox message formats */

#define RVU_DEFAULT_PF_FUNC     0xFFFF

/* Generic request msg used for those mbox messages which
 * don't send any data in the request.
 */
struct msg_req {
        struct mbox_msghdr hdr;
};

/* Generic rsponse msg used a ack or response for those mbox
 * messages which doesn't have a specific rsp msg format.
 */
struct msg_rsp {
        struct mbox_msghdr hdr;
};

/* RVU mailbox error codes
 * Range 256 - 300.
 */
enum rvu_af_status {
        RVU_INVALID_VF_ID           = -256,
};

struct ready_msg_rsp {
        struct mbox_msghdr hdr;
        u16    sclk_freq;       /* SCLK frequency (in MHz) */
        u16    rclk_freq;       /* RCLK frequency (in MHz) */
};

/* Structure for requesting resource provisioning.
 * 'modify' flag to be used when either requesting more
 * or to detach partial of a cetain resource type.
 * Rest of the fields specify how many of what type to
 * be attached.
 * To request LFs from two blocks of same type this mailbox
 * can be sent twice as below:
 *      struct rsrc_attach *attach;
 *       .. Allocate memory for message ..
 *       attach->cptlfs = 3; <3 LFs from CPT0>
 *       .. Send message ..
 *       .. Allocate memory for message ..
 *       attach->modify = 1;
 *       attach->cpt_blkaddr = BLKADDR_CPT1;
 *       attach->cptlfs = 2; <2 LFs from CPT1>
 *       .. Send message ..
 */
struct rsrc_attach {
        struct mbox_msghdr hdr;
        u8   modify:1;
        u8   npalf:1;
        u8   nixlf:1;
        u16  sso;
        u16  ssow;
        u16  timlfs;
        u16  cptlfs;
        int  cpt_blkaddr; /* BLKADDR_CPT0/BLKADDR_CPT1 or 0 for BLKADDR_CPT0 */
};

/* Structure for relinquishing resources.
 * 'partial' flag to be used when relinquishing all resources
 * but only of a certain type. If not set, all resources of all
 * types provisioned to the RVU function will be detached.
 */
struct rsrc_detach {
        struct mbox_msghdr hdr;
        u8 partial:1;
        u8 npalf:1;
        u8 nixlf:1;
        u8 sso:1;
        u8 ssow:1;
        u8 timlfs:1;
        u8 cptlfs:1;
};

#define MSIX_VECTOR_INVALID     0xFFFF
#define MAX_RVU_BLKLF_CNT       256

struct msix_offset_rsp {
        struct mbox_msghdr hdr;
        u16  npa_msixoff;
        u16  nix_msixoff;
        u8   sso;
        u8   ssow;
        u8   timlfs;
        u8   cptlfs;
        u16  sso_msixoff[MAX_RVU_BLKLF_CNT];
        u16  ssow_msixoff[MAX_RVU_BLKLF_CNT];
        u16  timlf_msixoff[MAX_RVU_BLKLF_CNT];
        u16  cptlf_msixoff[MAX_RVU_BLKLF_CNT];
        u8   cpt1_lfs;
        u16  cpt1_lf_msixoff[MAX_RVU_BLKLF_CNT];
};

struct get_hw_cap_rsp {
        struct mbox_msghdr hdr;
        u8 nix_fixed_txschq_mapping; /* Schq mapping fixed or flexible */
        u8 nix_shaping;              /* Is shaping and coloring supported */
};

/* CGX mbox message formats */

struct cgx_stats_rsp {
        struct mbox_msghdr hdr;
#define CGX_RX_STATS_COUNT      13
#define CGX_TX_STATS_COUNT      18
        u64 rx_stats[CGX_RX_STATS_COUNT];
        u64 tx_stats[CGX_TX_STATS_COUNT];
};

/* Structure for requesting the operation for
 * setting/getting mac address in the CGX interface
 */
struct cgx_mac_addr_set_or_get {
        struct mbox_msghdr hdr;
        u8 mac_addr[ETH_ALEN];
};

struct cgx_link_user_info {
        uint64_t link_up:1;
        uint64_t full_duplex:1;
        uint64_t lmac_type_id:4;
        uint64_t speed:20; /* speed in Mbps */
#define LMACTYPE_STR_LEN 16
        char lmac_type[LMACTYPE_STR_LEN];
};

struct cgx_link_info_msg {
        struct mbox_msghdr hdr;
        struct cgx_link_user_info link_info;
};

struct cgx_pause_frm_cfg {
        struct mbox_msghdr hdr;
        u8 set;
        /* set = 1 if the request is to config pause frames */
        /* set = 0 if the request is to fetch pause frames config */
        u8 rx_pause;
        u8 tx_pause;
};

/* NPA mbox message formats */

/* NPA mailbox error codes
 * Range 301 - 400.
 */
enum npa_af_status {
        NPA_AF_ERR_PARAM            = -301,
        NPA_AF_ERR_AQ_FULL          = -302,
        NPA_AF_ERR_AQ_ENQUEUE       = -303,
        NPA_AF_ERR_AF_LF_INVALID    = -304,
        NPA_AF_ERR_AF_LF_ALLOC      = -305,
        NPA_AF_ERR_LF_RESET         = -306,
};

/* For NPA LF context alloc and init */
struct npa_lf_alloc_req {
        struct mbox_msghdr hdr;
        int node;
        int aura_sz;  /* No of auras */
        u32 nr_pools; /* No of pools */
        u64 way_mask;
};

struct npa_lf_alloc_rsp {
        struct mbox_msghdr hdr;
        u32 stack_pg_ptrs;  /* No of ptrs per stack page */
        u32 stack_pg_bytes; /* Size of stack page */
        u16 qints; /* NPA_AF_CONST::QINTS */
};

/* NPA AQ enqueue msg */
struct npa_aq_enq_req {
        struct mbox_msghdr hdr;
        u32 aura_id;
        u8 ctype;
        u8 op;
        union {
                /* Valid when op == WRITE/INIT and ctype == AURA.
                 * LF fills the pool_id in aura.pool_addr. AF will translate
                 * the pool_id to pool context pointer.
                 */
                struct npa_aura_s aura;
                /* Valid when op == WRITE/INIT and ctype == POOL */
                struct npa_pool_s pool;
        };
        /* Mask data when op == WRITE (1=write, 0=don't write) */
        union {
                /* Valid when op == WRITE and ctype == AURA */
                struct npa_aura_s aura_mask;
                /* Valid when op == WRITE and ctype == POOL */
                struct npa_pool_s pool_mask;
        };
};

struct npa_aq_enq_rsp {
        struct mbox_msghdr hdr;
        union {
                /* Valid when op == READ and ctype == AURA */
                struct npa_aura_s aura;
                /* Valid when op == READ and ctype == POOL */
                struct npa_pool_s pool;
        };
};

/* Disable all contexts of type 'ctype' */
struct hwctx_disable_req {
        struct mbox_msghdr hdr;
        u8 ctype;
};

/* NIX mbox message formats */

/* NIX mailbox error codes
 * Range 401 - 500.
 */
enum nix_af_status {
        NIX_AF_ERR_PARAM            = -401,
        NIX_AF_ERR_AQ_FULL          = -402,
        NIX_AF_ERR_AQ_ENQUEUE       = -403,
        NIX_AF_ERR_AF_LF_INVALID    = -404,
        NIX_AF_ERR_AF_LF_ALLOC      = -405,
        NIX_AF_ERR_TLX_ALLOC_FAIL   = -406,
        NIX_AF_ERR_TLX_INVALID      = -407,
        NIX_AF_ERR_RSS_SIZE_INVALID = -408,
        NIX_AF_ERR_RSS_GRPS_INVALID = -409,
        NIX_AF_ERR_FRS_INVALID      = -410,
        NIX_AF_ERR_RX_LINK_INVALID  = -411,
        NIX_AF_INVAL_TXSCHQ_CFG     = -412,
        NIX_AF_SMQ_FLUSH_FAILED     = -413,
        NIX_AF_ERR_LF_RESET         = -414,
        NIX_AF_ERR_RSS_NOSPC_FIELD  = -415,
        NIX_AF_ERR_RSS_NOSPC_ALGO   = -416,
        NIX_AF_ERR_MARK_CFG_FAIL    = -417,
        NIX_AF_ERR_LSO_CFG_FAIL     = -418,
        NIX_AF_INVAL_NPA_PF_FUNC    = -419,
        NIX_AF_INVAL_SSO_PF_FUNC    = -420,
        NIX_AF_ERR_TX_VTAG_NOSPC    = -421,
        NIX_AF_ERR_RX_VTAG_INUSE    = -422,
};

/* For NIX RX vtag action  */
enum nix_rx_vtag0_type {
        NIX_AF_LFX_RX_VTAG_TYPE0, /* reserved for rx vlan offload */
        NIX_AF_LFX_RX_VTAG_TYPE1,
        NIX_AF_LFX_RX_VTAG_TYPE2,
        NIX_AF_LFX_RX_VTAG_TYPE3,
        NIX_AF_LFX_RX_VTAG_TYPE4,
        NIX_AF_LFX_RX_VTAG_TYPE5,
        NIX_AF_LFX_RX_VTAG_TYPE6,
        NIX_AF_LFX_RX_VTAG_TYPE7,
};

/* For NIX LF context alloc and init */
struct nix_lf_alloc_req {
        struct mbox_msghdr hdr;
        int node;
        u32 rq_cnt;   /* No of receive queues */
        u32 sq_cnt;   /* No of send queues */
        u32 cq_cnt;   /* No of completion queues */
        u8  xqe_sz;
        u16 rss_sz;
        u8  rss_grps;
        u16 npa_func;
        u16 sso_func;
        u64 rx_cfg;   /* See NIX_AF_LF(0..127)_RX_CFG */
        u64 way_mask;
};

struct nix_lf_alloc_rsp {
        struct mbox_msghdr hdr;
        u16     sqb_size;
        u16     rx_chan_base;
        u16     tx_chan_base;
        u8      rx_chan_cnt; /* total number of RX channels */
        u8      tx_chan_cnt; /* total number of TX channels */
        u8      lso_tsov4_idx;
        u8      lso_tsov6_idx;
        u8      mac_addr[ETH_ALEN];
        u8      lf_rx_stats; /* NIX_AF_CONST1::LF_RX_STATS */
        u8      lf_tx_stats; /* NIX_AF_CONST1::LF_TX_STATS */
        u16     cints; /* NIX_AF_CONST2::CINTS */
        u16     qints; /* NIX_AF_CONST2::QINTS */
        u8      cgx_links;  /* No. of CGX links present in HW */
        u8      lbk_links;  /* No. of LBK links present in HW */
        u8      sdp_links;  /* No. of SDP links present in HW */
};

struct nix_lf_free_req {
        struct mbox_msghdr hdr;
#define NIX_LF_DISABLE_FLOWS            BIT_ULL(0)
#define NIX_LF_DONT_FREE_TX_VTAG        BIT_ULL(1)
        u64 flags;
};

/* NIX AQ enqueue msg */
struct nix_aq_enq_req {
        struct mbox_msghdr hdr;
        u32  qidx;
        u8 ctype;
        u8 op;
        union {
                struct nix_rq_ctx_s rq;
                struct nix_sq_ctx_s sq;
                struct nix_cq_ctx_s cq;
                struct nix_rsse_s   rss;
                struct nix_rx_mce_s mce;
        };
        union {
                struct nix_rq_ctx_s rq_mask;
                struct nix_sq_ctx_s sq_mask;
                struct nix_cq_ctx_s cq_mask;
                struct nix_rsse_s   rss_mask;
                struct nix_rx_mce_s mce_mask;
        };
};

struct nix_aq_enq_rsp {
        struct mbox_msghdr hdr;
        union {
                struct nix_rq_ctx_s rq;
                struct nix_sq_ctx_s sq;
                struct nix_cq_ctx_s cq;
                struct nix_rsse_s   rss;
                struct nix_rx_mce_s mce;
        };
};

/* Tx scheduler/shaper mailbox messages */

#define MAX_TXSCHQ_PER_FUNC             128

struct nix_txsch_alloc_req {
        struct mbox_msghdr hdr;
        /* Scheduler queue count request at each level */
        u16 schq_contig[NIX_TXSCH_LVL_CNT]; /* No of contiguous queues */
        u16 schq[NIX_TXSCH_LVL_CNT]; /* No of non-contiguous queues */
};

struct nix_txsch_alloc_rsp {
        struct mbox_msghdr hdr;
        /* Scheduler queue count allocated at each level */
        u16 schq_contig[NIX_TXSCH_LVL_CNT];
        u16 schq[NIX_TXSCH_LVL_CNT];
        /* Scheduler queue list allocated at each level */
        u16 schq_contig_list[NIX_TXSCH_LVL_CNT][MAX_TXSCHQ_PER_FUNC];
        u16 schq_list[NIX_TXSCH_LVL_CNT][MAX_TXSCHQ_PER_FUNC];
        u8  aggr_level; /* Traffic aggregation scheduler level */
        u8  aggr_lvl_rr_prio; /* Aggregation lvl's RR_PRIO config */
        u8  link_cfg_lvl; /* LINKX_CFG CSRs mapped to TL3 or TL2's index ? */
};

struct nix_txsch_free_req {
        struct mbox_msghdr hdr;
#define TXSCHQ_FREE_ALL BIT_ULL(0)
        u16 flags;
        /* Scheduler queue level to be freed */
        u16 schq_lvl;
        /* List of scheduler queues to be freed */
        u16 schq;
};

struct nix_txschq_config {
        struct mbox_msghdr hdr;
        u8 lvl; /* SMQ/MDQ/TL4/TL3/TL2/TL1 */
#define TXSCHQ_IDX_SHIFT        16
#define TXSCHQ_IDX_MASK         (BIT_ULL(10) - 1)
#define TXSCHQ_IDX(reg, shift)  (((reg) >> (shift)) & TXSCHQ_IDX_MASK)
        u8 num_regs;
#define MAX_REGS_PER_MBOX_MSG   20
        u64 reg[MAX_REGS_PER_MBOX_MSG];
        u64 regval[MAX_REGS_PER_MBOX_MSG];
};

struct nix_vtag_config {
        struct mbox_msghdr hdr;
        /* '0' for 4 octet VTAG, '1' for 8 octet VTAG */
        u8 vtag_size;
        /* cfg_type is '0' for tx vlan cfg
         * cfg_type is '1' for rx vlan cfg
         */
        u8 cfg_type;
        union {
                /* valid when cfg_type is '0' */
                struct {
                        u64 vtag0;
                        u64 vtag1;

                        /* cfg_vtag0 & cfg_vtag1 fields are valid
                         * when free_vtag0 & free_vtag1 are '0's.
                         */
                        /* cfg_vtag0 = 1 to configure vtag0 */
                        u8 cfg_vtag0 :1;
                        /* cfg_vtag1 = 1 to configure vtag1 */
                        u8 cfg_vtag1 :1;

                        /* vtag0_idx & vtag1_idx are only valid when
                         * both cfg_vtag0 & cfg_vtag1 are '0's,
                         * these fields are used along with free_vtag0
                         * & free_vtag1 to free the nix lf's tx_vlan
                         * configuration.
                         *
                         * Denotes the indices of tx_vtag def registers
                         * that needs to be cleared and freed.
                         */
                        int vtag0_idx;
                        int vtag1_idx;

                        /* free_vtag0 & free_vtag1 fields are valid
                         * when cfg_vtag0 & cfg_vtag1 are '0's.
                         */
                        /* free_vtag0 = 1 clears vtag0 configuration
                         * vtag0_idx denotes the index to be cleared.
                         */
                        u8 free_vtag0 :1;
                        /* free_vtag1 = 1 clears vtag1 configuration
                         * vtag1_idx denotes the index to be cleared.
                         */
                        u8 free_vtag1 :1;
                } tx;

                /* valid when cfg_type is '1' */
                struct {
                        /* rx vtag type index, valid values are in 0..7 range */
                        u8 vtag_type;
                        /* rx vtag strip */
                        u8 strip_vtag :1;
                        /* rx vtag capture */
                        u8 capture_vtag :1;
                } rx;
        };
};

struct nix_vtag_config_rsp {
        struct mbox_msghdr hdr;
        int vtag0_idx;
        int vtag1_idx;
        /* Indices of tx_vtag def registers used to configure
         * tx vtag0 & vtag1 headers, these indices are valid
         * when nix_vtag_config mbox requested for vtag0 and/
         * or vtag1 configuration.
         */
};

struct nix_rss_flowkey_cfg {
        struct mbox_msghdr hdr;
        int     mcam_index;  /* MCAM entry index to modify */
#define NIX_FLOW_KEY_TYPE_PORT  BIT(0)
#define NIX_FLOW_KEY_TYPE_IPV4  BIT(1)
#define NIX_FLOW_KEY_TYPE_IPV6  BIT(2)
#define NIX_FLOW_KEY_TYPE_TCP   BIT(3)
#define NIX_FLOW_KEY_TYPE_UDP   BIT(4)
#define NIX_FLOW_KEY_TYPE_SCTP  BIT(5)
#define NIX_FLOW_KEY_TYPE_NVGRE    BIT(6)
#define NIX_FLOW_KEY_TYPE_VXLAN    BIT(7)
#define NIX_FLOW_KEY_TYPE_GENEVE   BIT(8)
#define NIX_FLOW_KEY_TYPE_ETH_DMAC BIT(9)
#define NIX_FLOW_KEY_TYPE_IPV6_EXT BIT(10)
#define NIX_FLOW_KEY_TYPE_GTPU       BIT(11)
#define NIX_FLOW_KEY_TYPE_INNR_IPV4     BIT(12)
#define NIX_FLOW_KEY_TYPE_INNR_IPV6     BIT(13)
#define NIX_FLOW_KEY_TYPE_INNR_TCP      BIT(14)
#define NIX_FLOW_KEY_TYPE_INNR_UDP      BIT(15)
#define NIX_FLOW_KEY_TYPE_INNR_SCTP     BIT(16)
#define NIX_FLOW_KEY_TYPE_INNR_ETH_DMAC BIT(17)
#define NIX_FLOW_KEY_TYPE_VLAN          BIT(20)
#define NIX_FLOW_KEY_TYPE_IPV4_PROTO    BIT(21)
        u32     flowkey_cfg; /* Flowkey types selected */
        u8      group;       /* RSS context or group */
};

struct nix_rss_flowkey_cfg_rsp {
        struct mbox_msghdr hdr;
        u8      alg_idx; /* Selected algo index */
};

struct nix_set_mac_addr {
        struct mbox_msghdr hdr;
        u8 mac_addr[ETH_ALEN]; /* MAC address to be set for this pcifunc */
};

struct nix_get_mac_addr_rsp {
        struct mbox_msghdr hdr;
        u8 mac_addr[ETH_ALEN];
};

struct nix_mark_format_cfg {
        struct mbox_msghdr hdr;
        u8 offset;
        u8 y_mask;
        u8 y_val;
        u8 r_mask;
        u8 r_val;
};

struct nix_mark_format_cfg_rsp {
        struct mbox_msghdr hdr;
        u8 mark_format_idx;
};

struct nix_rx_mode {
        struct mbox_msghdr hdr;
#define NIX_RX_MODE_UCAST       BIT(0)
#define NIX_RX_MODE_PROMISC     BIT(1)
#define NIX_RX_MODE_ALLMULTI    BIT(2)
        u16     mode;
};

struct nix_rx_cfg {
        struct mbox_msghdr hdr;
#define NIX_RX_OL3_VERIFY   BIT(0)
#define NIX_RX_OL4_VERIFY   BIT(1)
        u8 len_verify; /* Outer L3/L4 len check */
#define NIX_RX_CSUM_OL4_VERIFY  BIT(0)
        u8 csum_verify; /* Outer L4 checksum verification */
};

struct nix_frs_cfg {
        struct mbox_msghdr hdr;
        u8      update_smq;    /* Update SMQ's min/max lens */
        u8      update_minlen; /* Set minlen also */
        u8      sdp_link;      /* Set SDP RX link */
        u16     maxlen;
        u16     minlen;
};

struct nix_lso_format_cfg {
        struct mbox_msghdr hdr;
        u64 field_mask;
#define NIX_LSO_FIELD_MAX       8
        u64 fields[NIX_LSO_FIELD_MAX];
};

struct nix_lso_format_cfg_rsp {
        struct mbox_msghdr hdr;
        u8 lso_format_idx;
};

struct nix_bp_cfg_req {
        struct mbox_msghdr hdr;
        u16     chan_base; /* Starting channel number */
        u8      chan_cnt; /* Number of channels */
        u8      bpid_per_chan;
        /* bpid_per_chan = 0 assigns single bp id for range of channels */
        /* bpid_per_chan = 1 assigns separate bp id for each channel */
};

/* PF can be mapped to either CGX or LBK interface,
 * so maximum 64 channels are possible.
 */
#define NIX_MAX_BPID_CHAN       64
struct nix_bp_cfg_rsp {
        struct mbox_msghdr hdr;
        u16     chan_bpid[NIX_MAX_BPID_CHAN]; /* Channel and bpid mapping */
        u8      chan_cnt; /* Number of channel for which bpids are assigned */
};

/* NPC mbox message structs */

#define NPC_MCAM_ENTRY_INVALID  0xFFFF
#define NPC_MCAM_INVALID_MAP    0xFFFF

/* NPC mailbox error codes
 * Range 701 - 800.
 */
enum npc_af_status {
        NPC_MCAM_INVALID_REQ    = -701,
        NPC_MCAM_ALLOC_DENIED   = -702,
        NPC_MCAM_ALLOC_FAILED   = -703,
        NPC_MCAM_PERM_DENIED    = -704,
};

struct npc_mcam_alloc_entry_req {
        struct mbox_msghdr hdr;
#define NPC_MAX_NONCONTIG_ENTRIES       256
        u8  contig;   /* Contiguous entries ? */
#define NPC_MCAM_ANY_PRIO               0
#define NPC_MCAM_LOWER_PRIO             1
#define NPC_MCAM_HIGHER_PRIO            2
        u8  priority; /* Lower or higher w.r.t ref_entry */
        u16 ref_entry;
        u16 count;    /* Number of entries requested */
};

struct npc_mcam_alloc_entry_rsp {
        struct mbox_msghdr hdr;
        u16 entry; /* Entry allocated or start index if contiguous.
                    * Invalid incase of non-contiguous.
                    */
        u16 count; /* Number of entries allocated */
        u16 free_count; /* Number of entries available */
        u16 entry_list[NPC_MAX_NONCONTIG_ENTRIES];
};

struct npc_mcam_free_entry_req {
        struct mbox_msghdr hdr;
        u16 entry; /* Entry index to be freed */
        u8  all;   /* If all entries allocated to this PFVF to be freed */
};

struct mcam_entry {
#define NPC_MAX_KWS_IN_KEY      7 /* Number of keywords in max keywidth */
        u64     kw[NPC_MAX_KWS_IN_KEY];
        u64     kw_mask[NPC_MAX_KWS_IN_KEY];
        u64     action;
        u64     vtag_action;
};

struct npc_mcam_write_entry_req {
        struct mbox_msghdr hdr;
        struct mcam_entry entry_data;
        u16 entry;       /* MCAM entry to write this match key */
        u16 cntr;        /* Counter for this MCAM entry */
        u8  intf;        /* Rx or Tx interface */
        u8  enable_entry;/* Enable this MCAM entry ? */
        u8  set_cntr;    /* Set counter for this entry ? */
};

/* Enable/Disable a given entry */
struct npc_mcam_ena_dis_entry_req {
        struct mbox_msghdr hdr;
        u16 entry;
};

struct npc_mcam_shift_entry_req {
        struct mbox_msghdr hdr;
#define NPC_MCAM_MAX_SHIFTS     64
        u16 curr_entry[NPC_MCAM_MAX_SHIFTS];
        u16 new_entry[NPC_MCAM_MAX_SHIFTS];
        u16 shift_count; /* Number of entries to shift */
};

struct npc_mcam_shift_entry_rsp {
        struct mbox_msghdr hdr;
        u16 failed_entry_idx; /* Index in 'curr_entry', not entry itself */
};

struct npc_mcam_alloc_counter_req {
        struct mbox_msghdr hdr;
        u8  contig;     /* Contiguous counters ? */
#define NPC_MAX_NONCONTIG_COUNTERS       64
        u16 count;      /* Number of counters requested */
};

struct npc_mcam_alloc_counter_rsp {
        struct mbox_msghdr hdr;
        u16 cntr;   /* Counter allocated or start index if contiguous.
                     * Invalid incase of non-contiguous.
                     */
        u16 count;  /* Number of counters allocated */
        u16 cntr_list[NPC_MAX_NONCONTIG_COUNTERS];
};

struct npc_mcam_oper_counter_req {
        struct mbox_msghdr hdr;
        u16 cntr;   /* Free a counter or clear/fetch it's stats */
};

struct npc_mcam_oper_counter_rsp {
        struct mbox_msghdr hdr;
        u64 stat;  /* valid only while fetching counter's stats */
};

struct npc_mcam_unmap_counter_req {
        struct mbox_msghdr hdr;
        u16 cntr;
        u16 entry; /* Entry and counter to be unmapped */
        u8  all;   /* Unmap all entries using this counter ? */
};

struct npc_mcam_alloc_and_write_entry_req {
        struct mbox_msghdr hdr;
        struct mcam_entry entry_data;
        u16 ref_entry;
        u8  priority;    /* Lower or higher w.r.t ref_entry */
        u8  intf;        /* Rx or Tx interface */
        u8  enable_entry;/* Enable this MCAM entry ? */
        u8  alloc_cntr;  /* Allocate counter and map ? */
};

struct npc_mcam_alloc_and_write_entry_rsp {
        struct mbox_msghdr hdr;
        u16 entry;
        u16 cntr;
};

struct npc_get_kex_cfg_rsp {
        struct mbox_msghdr hdr;
        u64 rx_keyx_cfg;   /* NPC_AF_INTF(0)_KEX_CFG */
        u64 tx_keyx_cfg;   /* NPC_AF_INTF(1)_KEX_CFG */
#define NPC_MAX_INTF    2
#define NPC_MAX_LID     8
#define NPC_MAX_LT      16
#define NPC_MAX_LD      2
#define NPC_MAX_LFL     16
        /* NPC_AF_KEX_LDATA(0..1)_FLAGS_CFG */
        u64 kex_ld_flags[NPC_MAX_LD];
        /* NPC_AF_INTF(0..1)_LID(0..7)_LT(0..15)_LD(0..1)_CFG */
        u64 intf_lid_lt_ld[NPC_MAX_INTF][NPC_MAX_LID][NPC_MAX_LT][NPC_MAX_LD];
        /* NPC_AF_INTF(0..1)_LDATA(0..1)_FLAGS(0..15)_CFG */
        u64 intf_ld_flags[NPC_MAX_INTF][NPC_MAX_LD][NPC_MAX_LFL];
#define MKEX_NAME_LEN 128
        u8 mkex_pfl_name[MKEX_NAME_LEN];
};

struct flow_msg {
        unsigned char dmac[6];
        unsigned char smac[6];
        __be16 etype;
        __be16 vlan_etype;
        __be16 vlan_tci;
        union {
                __be32 ip4src;
                __be32 ip6src[4];
        };
        union {
                __be32 ip4dst;
                __be32 ip6dst[4];
        };
        u8 tos;
        u8 ip_ver;
        u8 ip_proto;
        u8 tc;
        __be16 sport;
        __be16 dport;
};

struct npc_install_flow_req {
        struct mbox_msghdr hdr;
        struct flow_msg packet;
        struct flow_msg mask;
        u64 features;
        u16 entry;
        u16 channel;
        u8 intf;
        u8 set_cntr; /* If counter is available set counter for this entry ? */
        u8 default_rule;
        u8 append; /* overwrite(0) or append(1) flow to default rule? */
        u16 vf;
        /* action */
        u32 index;
        u16 match_id;
        u8 flow_key_alg;
        u8 op;
        /* vtag rx action */
        u8 vtag0_type;
        u8 vtag0_valid;
        u8 vtag1_type;

        u8 vtag1_valid;
        /* vtag tx action */
        u16 vtag0_def;
        u8  vtag0_op;
        u16 vtag1_def;
        u8  vtag1_op;
};

struct npc_install_flow_rsp {
        struct mbox_msghdr hdr;
        int counter; /* negative if no counter else counter number */
};

struct npc_delete_flow_req {
        struct mbox_msghdr hdr;
        u16 entry;
        u16 start;/*Disable range of entries */
        u16 end;
        u8 all; /* PF + VFs */
};

struct npc_mcam_read_entry_req {
        struct mbox_msghdr hdr;
        u16 entry;       /* MCAM entry to read */
};

struct npc_mcam_read_entry_rsp {
        struct mbox_msghdr hdr;
        struct mcam_entry entry_data;
        u8 intf;
        u8 enable;
};

struct npc_mcam_read_base_rule_rsp {
        struct mbox_msghdr hdr;
        struct mcam_entry entry;
};

enum ptp_op {
        PTP_OP_ADJFINE = 0,
        PTP_OP_GET_CLOCK = 1,
};

struct ptp_req {
        struct mbox_msghdr hdr;
        u8 op;
        s64 scaled_ppm;
};

struct ptp_rsp {
        struct mbox_msghdr hdr;
        u64 clk;
};

/* CPT mailbox error codes
 * Range 901 - 1000.
 */
enum cpt_af_status {
        CPT_AF_ERR_PARAM                = -901,
        CPT_AF_ERR_GRP_INVALID          = -902,
        CPT_AF_ERR_LF_INVALID           = -903,
        CPT_AF_ERR_ACCESS_DENIED        = -904,
        CPT_AF_ERR_SSO_PF_FUNC_INVALID  = -905,
        CPT_AF_ERR_NIX_PF_FUNC_INVALID  = -906
};

/* CPT mbox message formats */
struct cpt_rd_wr_reg_msg {
        struct mbox_msghdr hdr;
        u64 reg_offset;
        u64 *ret_val;
        u64 val;
        u8 is_write;
};

struct cpt_lf_alloc_req_msg {
        struct mbox_msghdr hdr;
        u16 nix_pf_func;
        u16 sso_pf_func;
        u16 eng_grpmsk;
};

#endif /* MBOX_H */