mrpc.h

/*
 * Microsemi Switchtec(tm) PCIe Management Library
 * Copyright (c) 2017, Microsemi Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
#ifndef LIBSWITCHTEC_MRPC_H
#define LIBSWITCHTEC_MRPC_H
 
#define MRPC_MAX_DATA_LEN   1024
 
enum mrpc_cmd {
    MRPC_DIAG_PMC_START = 0x0,
    MRPC_TWI = 0x1,
    MRPC_VGPIO = 0x2,
    MRPC_PWM = 0x3,
    MRPC_DIETEMP = 0x4,
    MRPC_FWDNLD = 0x5,
    MRPC_FWLOGRD = 0x6,
    MRPC_PMON = 0x7,
    MRPC_PORTLN = 0x8,
    MRPC_PORTARB = 0x9,
    MRPC_MCOVRLY = 0xA,
    MRPC_STACKBIF = 0xB,
    MRPC_PORTPARTP2P = 0xC,
    MRPC_DIAG_TLP_INJECT = 0xD,
    MRPC_RESERVED1 = 0xE,
    MRPC_DIAG_PORT_EYE = 0xF,
    MRPC_DIAG_POT_VHIST = 0x10,
    MRPC_DIAG_PORT_LTSSM_LOG = 0x11,
    MRPC_DIAG_PORT_TLP_ANL = 0x12,
    MRPC_DIAG_PORT_LN_ADPT = 0x13,
    MRPC_SRDS_PCIE_PEAK = 0x14,
    MRPC_SRDS_EQ_CTRL = 0x15,
    MRPC_SRDS_LN_TUNING_MODE = 0x16,
    MRPC_NT_MCG_CAPABLE_CONFIG = 0x17,
    MRPC_TCH = 0x18,
    MRPC_ARB = 0x19,
    MRPC_SMBUS = 0x1A,
    MRPC_RESET = 0x1B,
    MRPC_LNKSTAT = 0x1C,
    MRPC_MULTI_CFG = 0x1D,
    MRPC_SES = 0x1E,
    MRPC_RD_FLASH = 0x1F,
    MRPC_SPI_ECC = 0x20,
    MRPC_PAT_GEN = 0x21,
    MRPC_INT_LOOPBACK = 0x22,
    MRPC_RESERVED2 = 0x24,
    MRPC_ROUTE_TO_SELF = 0x25,
    MRPC_REFCLK_S = 0x26,
    MRPC_SYNTH_EP = 0x27,
    MRPC_EVENTS_QUERY = 0x28,
    MRPC_GAS_READ = 0x29,
    MRPC_AER_GEN = 0x2A,
    MRPC_PART_INFO = 0x2B,
    MRPC_PCIE_GEN_1_2_DUMP = 0x2C,
    MRPC_PCIE_GEN_1_2_TUNE = 0x2D,
    MRPC_EYE_OBSERVE = 0x2F,
    MRPC_RCVR_OBJ_DUMP = 0x30,
    MRPC_RESERVED3 = 0x31,
    MRPC_PORT_EQ_STATUS = 0x32,
    MRPC_PORT_EQ_CTRL = 0x33,
    MRPC_GAS_WRITE = 0x34,
    MRPC_MRPC_ERR_INJ = 0x35,
    MRPC_DEV_INFO_GET = 0x36,
    MRPC_MRPC_PERM_TABLE_GET = 0x37,
    MRPC_CROSS_HAIR = 0x38,
    MRPC_RECV_DETECT_STATUS = 0x39,
    MRPC_EXT_RCVR_OBJ_DUMP = 0x3A,
    MRPC_LOG_DEF_GET = 0x3B,
    MRPC_SECURITY_CONFIG_GET_EXT = 0x3C,
    MRPC_ORDERED_SET_ANALYZER = 0x3D,
    MRPC_ECHO = 0x41,
 
    MRPC_GET_PAX_ID = 0x81,
    MRPC_TOPO_INFO_DUMP = 0x82,
    MRPC_GFMS_DB_DUMP = 0x83,
    MRPC_GFMS_BIND_UNBIND = 0x84,
    MRPC_DEVICE_MANAGE_CMD = 0x85,
    MRPC_PORT_CONFIG = 0x88,
    MRPC_GFMS_EVENT = 0x89,
    MRPC_PORT_CONTROL = 0x8D,
    MRPC_EP_RESOURCE_ACCESS = 0x8E,
    MRPC_EP_TUNNEL_CFG = 0x8F,
    MRPC_NVME_ADMIN_PASSTHRU = 0x91,
 
    MRPC_I2C_TWI_PING = 0x100,
    MRPC_SECURITY_CONFIG_GET = 0x101,
    MRPC_SECURITY_CONFIG_SET = 0x102,
    MRPC_KMSK_ENTRY_SET = 0x103,
    MRPC_SECURE_STATE_SET = 0x104,
    MRPC_ACT_IMG_IDX_GET = 0x105,
    MRPC_ACT_IMG_IDX_SET = 0x106,
    MRPC_FW_TX = 0x107,
    MRPC_MAILBOX_GET = 0x108,
    MRPC_SN_VER_GET = 0x109,
    MRPC_DBG_UNLOCK = 0x10A,
    MRPC_BOOTUP_RESUME = 0x10B,
    MRPC_SECURITY_CONFIG_GET_GEN5 = 0x111,
    MRPC_SECURITY_CONFIG_SET_GEN5 = 0x112,
    MRPC_KMSK_ENTRY_SET_GEN5 = 0x113,
    MRPC_SECURE_STATE_SET_GEN5 = 0x114,
    MRPC_ACT_IMG_IDX_GET_GEN5 = 0x115,
    MRPC_ACT_IMG_IDX_SET_GEN5 = 0x116,
    MRPC_FW_TX_GEN5 = 0x117,
    MRPC_MAILBOX_GET_GEN5 = 0x118,
    MRPC_SN_VER_GET_GEN5 = 0x119,
    MRPC_DBG_UNLOCK_GEN5 = 0x11A,
    MRPC_BOOTUP_RESUME_GEN5 = 0x11B,
    MRPC_SECURITY_CONFIG_GET_GEN6 = 0x121,
    MRPC_FW_TX_GEN6 = 0x122,
    MRPC_MAILBOX_GET_GEN6 = 0x123,
    MRPC_SN_VER_GET_GEN6 = 0x124,
    MRPC_DBG_UNLOCK_GEN6 = 0x125,
    MRPC_SECURE_CONFIG_GET_GEN6 = 0x126,
    MRPC_DEVICE_CONFIG = 0x127,
    MRPC_DOK_CONFIG = 0x128,
    MRPC_SECURE_STATE_SET_GEN6 = 0x129,
    MRPC_GEN5_EYE_CAPTURE = 0x142,
    MRPC_FTDC_LOG_DUMP = 0x147,
    MRPC_RTC = 0x14C,
    MRPC_FW_IMG_GET = 0x14F,
 
    MRPC_MAX_ID = 0x14D,
};
 
enum mrpc_bg_status {
    MRPC_BG_STAT_IDLE = 0,
    MRPC_BG_STAT_INPROGRESS = 1,
    MRPC_BG_STAT_DONE = 2,
    MRPC_BG_STAT_OFFSET = 3,
    MRPC_BG_STAT_ERROR = 0xFF,
};
 
enum mrpc_sub_cmd {
    MRPC_FWDNLD_GET_STATUS = 0,
    MRPC_FWDNLD_DOWNLOAD = 1,
    MRPC_FWDNLD_TOGGLE = 2,
    MRPC_FWDNLD_BOOT_RO = 4,
    MRPC_FWDNLD_SET_RDNDNT = 5,
 
    MRPC_VGPIO_GET_DIR = 0,
    MRPC_VGPIO_GET_POL = 1,
    MRPC_VGPIO_GET_VAL = 2,
    MRPC_VGPIO_SET_VAL = 3,
    MRPC_VGPIO_EN_INT = 4,
    MRPC_VGPIO_DIS_INT = 5,
    MRPC_VPGIO_GET_PIN_STS = 7,
 
        MRPC_PMON_SETUP_EV_COUNTER = 0,
        MRPC_PMON_GET_BW_COUNTER = 1,
    MRPC_PMON_GET_EV_COUNTER = 2,
    MRPC_PMON_GET_EV_COUNTER_SETUP = 3,
        MRPC_PMON_SETUP_LAT_COUNTER = 4,
    MRPC_PMON_GET_LAT_COUNTER_SETUP = 5,
    MRPC_PMON_GET_LAT_COUNTER = 6,
    MRPC_PMON_RULE_ERROR_TLP = 8,
    MRPC_PMON_RULE_TLP_MATCH = 9,
    MRPC_PMON_RULE_TLP_TO_USP = 10,
    MRPC_PMON_RULE_TLP_TO_DSP = 11,
    MRPC_PMON_SET_BW_COUNTER = 12,
 
    MRPC_STACKBIF_GET = 0,
    MRPC_STACKBIF_SET = 1,
 
    MRPC_FWLOGRD_RAM = 0,
    MRPC_FWLOGRD_FLASH = 1,
    MRPC_FWLOGRD_MEMLOG = 2,
    MRPC_FWLOGRD_REGS = 3,
    MRPC_FWLOGRD_SYS_STACK = 4,
    MRPC_FWLOGRD_THRD_STACK = 5,
    MRPC_FWLOGRD_THRD = 6,
    MRPC_FWLOGRD_INVAL = 7,
    MRPC_FWLOGRD_NVHDR = 10,
    MRPC_FWLOGRD_RAM_GEN5 = 11,
    MRPC_FWLOGRD_FLASH_GEN5 = 12,
    MRPC_FWLOGRD_RAM_WITH_FLAG = 13,
    MRPC_FWLOGRD_FLASH_WITH_FLAG = 14,
 
    MRPC_LOG_DEF_APP = 0,
    MRPC_LOG_DEF_MAILBOX = 1,
 
    MRPC_DIETEMP_SET_CLOCK = 0,
    MRPC_DIETEMP_SET_MEAS = 1,
    MRPC_DIETEMP_GET = 2,
    MRPC_DIETEMP_STOP = 3,
    MRPC_DIETEMP_GET_GEN4 = 2,
    MRPC_DIETEMP_GET_GEN5 = 4,
 
    MRPC_MULTI_CFG_SUPPORTED = 0,
    MRPC_MULTI_CFG_COUNT = 1,
    MRPC_MULTI_CFG_ACTIVE = 2,
    MRPC_MULTI_CFG_START_ADDR = 3,
    MRPC_MULTI_CFG_LENGTH = 4,
 
    MRPC_PORT_BIND = 0,
    MRPC_PORT_UNBIND = 1,
    MRPC_PORT_INFO = 2,
 
    MRPC_PART_INFO_GET_ALL_INFO = 0,
    MRPC_PART_INFO_GET_METADATA = 1,
    MRPC_PART_INFO_GET_SEEPROM = 2,
    MRPC_PART_INFO_GET_ALL_INFO_GEN5 = 4,
    MRPC_PART_INFO_GET_METADATA_GEN5 = 5,
    MRPC_PART_INFO_GET_ALL_INFO_GEN6 = 8,
    MRPC_PART_INFO_GET_METADATA_GEN6 = 9,
    MRPC_PART_INFO_GET_SEEPROM_GEN6 = 10,
    MRPC_PART_INFO_GET_SMS_FMC_VERSION_GEN6 = 12,
 
    MRPC_GFMS_BIND = 1,
    MRPC_GFMS_UNBIND = 2,
 
    MRPC_PORT_CONFIG_SET = 0,
    MRPC_PORT_CONFIG_GET = 1,
 
    MRPC_TOPO_INFO_DUMP_START = 1,
    MRPC_TOPO_INFO_DUMP_STATUS_GET = 2,
    MRPC_TOPO_INFO_DUMP_DATA_GET = 3,
    MRPC_TOPO_INFO_DUMP_FINISH = 4,
    MRPC_TOPO_INFO_DUMP_DATA_GET_GEN5 = 5,
 
    MRPC_GFMS_DB_DUMP_FABRIC = 0,
    MRPC_GFMS_DB_DUMP_PAX_ALL,
    MRPC_GFMS_DB_DUMP_PAX,
    MRPC_GFMS_DB_DUMP_HVD,
    MRPC_GFMS_DB_DUMP_FAB_PORT,
    MRPC_GFMS_DB_DUMP_EP_PORT,
    MRPC_GFMS_DB_DUMP_HVD_DETAIL,
 
    MRPC_FW_TX_EXEC = 2,
    MRPC_FW_TX_FLASH = 3,
    MRPC_FW_TX_TOGGLE = 4,
 
    MRPC_DBG_UNLOCK_PKEY = 0,
    MRPC_DBG_UNLOCK_DATA = 1,
    MRPC_DBG_UNLOCK_UPDATE = 2,
 
    MRPC_GEN6_DBG_UNLOCK_PKEY = 0,
    MRPC_GEN6_DBG_UNLOCK_SIG = 1,
    MRPC_GEN6_DBG_UNLOCK_STATIC = 2,
    MRPC_GEN6_DBG_SEC_VER_UPDATE = 3,
    MRPC_GEN6_DBG_UNLOCK_STATIC_DISABLE = 4,
    MRPC_GEN6_DBG_UNLOCK_TOKEN_GET = 5,
    MRPC_GEN6_DBG_UNLOCK_STATUS_GET = 6,
 
    MRPC_KMSK_ENTRY_SET_PKEY = 0,
    MRPC_KMSK_ENTRY_SET_SIG = 1,
    MRPC_KMSK_ENTRY_SET_KMSK = 2,
 
    MRPC_EP_TUNNEL_ENABLE = 0,
    MRPC_EP_TUNNEL_DISABLE = 1,
    MRPC_EP_TUNNEL_STATUS = 2,
 
    MRPC_NVME_ADMIN_PASSTHRU_START = 1,
    MRPC_NVME_ADMIN_PASSTHRU_DATA = 2,
    MRPC_NVME_ADMIN_PASSTHRU_END = 3,
 
    MRPC_PORT_EQ_LOCAL_TX_COEFF_DUMP = 0,
    MRPC_PORT_EQ_FAR_END_TX_COEFF_DUMP = 1,
    MRPC_PORT_EQ_FAR_END_TX_EQ_TABLE_DUMP = 2,
    MRPC_PORT_EQ_LOCAL_TX_FSLF_DUMP = 3,
    MRPC_PORT_EQ_FAR_END_TX_FSLF_DUMP = 4,
 
    MRPC_GEN5_PORT_EQ_LOCAL_TX_COEFF_DUMP = 9,
    MRPC_GEN5_PORT_EQ_FAR_END_TX_COEFF_DUMP = 10,
    MRPC_GEN5_PORT_EQ_LOCAL_TX_FSLF_DUMP = 11,
    MRPC_GEN5_PORT_EQ_FAR_END_TX_FSLF_DUMP = 12,
    MRPC_GEN5_PORT_EQ_FAR_END_TX_EQ_TABLE_DUMP = 15,
 
    MRPC_GEN6_PORT_EQ_LOCAL_TX_COEFF_DUMP = 17,
    MRPC_GEN6_PORT_EQ_FAR_END_TX_COEFF_DUMP = 18,
    MRPC_GEN6_PORT_EQ_LOCAL_TX_FSLF_DUMP = 19,
    MRPC_GEN6_PORT_EQ_FAR_END_TX_FSLF_DUMP = 20,
 
    MRPC_EXT_RCVR_OBJ_DUMP_RCVR_EXT = 0,
    MRPC_EXT_RCVR_OBJ_DUMP_RCVR_EXT_PREV = 1,
    MRPC_EXT_RCVR_OBJ_DUMP_PREV = 2,
    MRPC_EXT_RCVR_OBJ_DUMP_LOCAL_TX_COEFF_PREV = 3,
    MRPC_EXT_RCVR_OBJ_DUMP_FAR_END_TX_COEFF_PREV = 4,
    MRPC_EXT_RCVR_OBJ_DUMP_EQ_TX_TABLE_PREV = 5,
    MRPC_EXT_RCVR_OBJ_DUMP_LOCAL_TX_FSLF_PREV = 6,
    MRPC_EXT_RCVR_OBJ_DUMP_FAR_END_TX_FSLF_PREV = 7,
 
    MRPC_REFCLK_S_DISABLE = 0,
    MRPC_REFCLK_S_ENABLE = 1,
    MRPC_REFCLK_S_STATUS = 2,
 
    MRPC_REFCLK_S_DISABLE_GEN6 = 3,
    MRPC_REFCLK_S_ENABLE_GEN6 = 4,
    MRPC_REFCLK_S_STATUS_GEN6 = 5,
 
    MRPC_LOOPBACK_GET_INT_LOOPBACK = 2,
    MRPC_LOOPBACK_SET_INT_LOOPBACK = 3,
    MRPC_LOOPBACK_SET_LTSSM_LOOPBACK = 4,
    MRPC_LOOPBACK_GET_LTSSM_LOOPBACK = 5,
 
    MRPC_PAT_GEN_GET_GEN = 5,
    MRPC_PAT_GEN_SET_GEN = 6,
    MRPC_PAT_GEN_GET_MON = 7,
    MRPC_PAT_GEN_SET_MON = 8,
    MRPC_PAT_GEN_INJ_ERR = 9,
    MRPC_PAT_GEN_SET_GEN_GEN5 = 10,
    MRPC_PAT_GEN_GET_GEN_GEN6 = 11,
    MRPC_PAT_GEN_SET_GEN_GEN6 = 12,
    MRPC_PAT_GEN_SET_MON_GEN6 = 13,
    MRPC_PAT_GEN_GET_MON_GEN6 = 14,
 
    MRPC_EYE_OBSERVE_START = 0,
    MRPC_EYE_OBSERVE_FETCH = 1,
    MRPC_EYE_OBSERVE_CANCEL = 2,
    MRPC_EYE_OBSERVE_SET_DATA_MODE = 3,
    MRPC_EYE_OBSERVE_GET_DATA_MODE = 4,
 
    MRPC_EYE_CAP_RUN_GEN5 = 0,
    MRPC_EYE_CAP_STATUS_GEN5 = 1,
    MRPC_EYE_CAP_READ_GEN5 = 2,
 
    MRPC_EYE_CAP_RUN_GEN6 = 3,
    MRPC_EYE_CAP_READ_GEN6 = 4,
 
    MRPC_CROSS_HAIR_ENABLE = 0,
    MRPC_CROSS_HAIR_DISABLE = 1,
    MRPC_CROSS_HAIR_GET = 2,
 
    MRPC_LTMON_CLEAR_LOG = 10,
    MRPC_LTMON_GET_STATUS_GEN4 = 13,
    MRPC_LTMON_FREEZE = 14,
    MRPC_LTMON_LOG_DUMP_GEN4 = 15,
    MRPC_LTMON_GET_STATUS_GEN5 = 20,
    MRPC_LTMON_LOG_DUMP_GEN5 = 21,
    
    MRPC_ERR_INJ_DLLP = 0,
    MRPC_ERR_INJ_DLLP_CRC = 1,
    MRPC_ERR_INJ_TLP_LCRC = 2,
    MRPC_ERR_INJ_TLP_SEQ = 3,
    MRPC_ERR_INJ_ACK_NACK = 4,
    MRPC_ERR_INJ_CTO = 5,
 
    MRPC_OSA_TYPE_TRIG_CONFIG = 0,
    MRPC_OSA_PAT_TRIG_CONFIG = 1,
    MRPC_OSA_MISC_TRIG_CONFIG = 2,
    MRPC_OSA_CAPTURE_CTRL = 3,
    MRPC_OSA_CONFIG_DMP = 4,
    MRPC_OSA_ANALYZER_OP = 5,
    MRPC_OSA_STATUS_QUERY = 6,
    MRPC_OSA_DATA_READ = 7,
    MRPC_OSA_REL_ACCESS_PERM = 8,
    MRPC_OSA_TYPE_TRIG_CONFIG_GEN6 = 9,
    MRPC_OSA_CAPTURE_CTRL_GEN6 = 10,
    MRPC_OSA_CONFIG_DMP_GEN6 = 11,
    MRPC_OSA_STATUS_QUERY_GEN6 = 12,
 
    MRPC_GET_SECURE_OTP = 0,
    MRPC_GET_SECURE_STATUS = 1,
    MRPC_GET_SECURE_BOOT_STATUS_PINSTRAP = 2,
};
 
#endif