diff options
Diffstat (limited to 'sbe/sbefw/sbe_sp_intf.H')
| -rw-r--r-- | sbe/sbefw/sbe_sp_intf.H | 409 |
1 files changed, 0 insertions, 409 deletions
diff --git a/sbe/sbefw/sbe_sp_intf.H b/sbe/sbefw/sbe_sp_intf.H deleted file mode 100644 index 5e241455..00000000 --- a/sbe/sbefw/sbe_sp_intf.H +++ /dev/null @@ -1,409 +0,0 @@ -/* IBM_PROLOG_BEGIN_TAG */ -/* This is an automatically generated prolog. */ -/* */ -/* $Source: sbe/sbefw/sbe_sp_intf.H $ */ -/* */ -/* OpenPOWER sbe Project */ -/* */ -/* Contributors Listed Below - COPYRIGHT 2015,2016 */ -/* [+] International Business Machines Corp. */ -/* */ -/* */ -/* Licensed under the Apache License, Version 2.0 (the "License"); */ -/* you may not use this file except in compliance with the License. */ -/* You may obtain a copy of the License at */ -/* */ -/* http://www.apache.org/licenses/LICENSE-2.0 */ -/* */ -/* Unless required by applicable law or agreed to in writing, software */ -/* distributed under the License is distributed on an "AS IS" BASIS, */ -/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */ -/* implied. See the License for the specific language governing */ -/* permissions and limitations under the License. */ -/* */ -/* IBM_PROLOG_END_TAG */ -/* - * @file sbe_sp_intf.H - * - * @brief This file contains the SP - SBE interface protocol common details - */ - -#ifndef __SBEFW_SBE_SP_INTF_H -#define __SBEFW_SBE_SP_INTF_H - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * $Version: Conforms to SP-SBE Interface Spec v0.8e - */ - -/* - * Constants for SBE FW major and minor number - */ -static const uint16_t SBE_FW_MAJOR_VERSION = 1; -static const uint16_t SBE_FW_MINOR_VERSION = 1; - -/** - * @brief enums for SBE command classes - * -*/ -enum sbeCommandClass -{ - SBE_CMD_CLASS_UNKNOWN = 0, - SBE_CMD_CLASS_IPL_CONTROL = 0xA1, - SBE_CMD_CLASS_SCOM_ACCESS = 0xA2, - SBE_CMD_CLASS_RING_ACCESS = 0xA3, - SBE_CMD_CLASS_MEMORY_ACCESS = 0xA4, - SBE_CMD_CLASS_REGISTER_ACCESS = 0xA5, - SBE_CMD_CLASS_ARRAY_ACCESS = 0xA6, - SBE_CMD_CLASS_INSTRUCTION_CONTROL = 0xA7, - SBE_CMD_CLASS_GENERIC_MESSAGE = 0xA8, - SBE_CMD_CLASS_MPIPL_COMMANDS = 0xA9, -}; - -/** - * @brief enums for SBE Istep Control command class - * -*/ -enum sbeIplControlCommands -{ - SBE_CMD_EXECUTE_ISTEP = 0x01, /* Execute istep */ - SBE_CMD_CONTINUE_BOOT = 0x02, /* Continue SBE Boot */ -}; - -/** - * @brief enums for SCOM Access Messages - * -*/ -enum sbeScomAccessCommands -{ - SBE_CMD_GETSCOM = 0x01, /* Get SCOM */ - SBE_CMD_PUTSCOM = 0x02, /* Put SCOM */ - SBE_CMD_MODIFYSCOM = 0x03, /* Modify SCOM */ - SBE_CMD_PUTSCOM_MASK = 0x04, /* Put SCOM under mask */ - SBE_CMD_MULTISCOM = 0x05, /* Execute Multi SCOM */ -}; - -/** - * @brief enum for modify mode - * -*/ -enum sbeChipOpModifyMode -{ - SBE_MODIFY_MODE_OR = 0x01, - SBE_MODIFY_MODE_AND = 0x02, - SBE_MODIFY_MODE_XOR = 0x03, -}; - -/** - * @brief enums for Ring Access Messages - * -*/ -enum sbeRingAccessCommands -{ - SBE_CMD_GETRING = 0x01, /* Get Ring */ - SBE_CMD_PUTRING = 0x02, /* Put Ring */ -}; - -/** - * @brief enums for Memory Access Messages - * -*/ -enum sbeMemoryAccesCommands -{ - SBE_CMD_GETMEM = 0x01, /* Get Memory (Proc/PBA) */ - SBE_CMD_PUTMEM = 0x02, /* Put Memory (Proc/PBA) */ - SBE_CMD_GETSRAM_OCC = 0x03, /* Get Memory (OCC SRAM) */ - SBE_CMD_PUTSRAM_OCC = 0x04, /* Put Memory (OCC SRAM) */ -}; - -/** - * @brief enums for GPR/SPR/FPR Access Messages - * -*/ -enum sbeRegisterAccessCommands -{ - SBE_CMD_GETREG = 0x01, /* Get Register (GPR,SPR,FPR) */ - SBE_CMD_PUTREG = 0x02, /* Put Register (GPR,SPR,FPR) */ -}; - -/** - * @brief enums for Trace Array Access Messages - * -*/ -enum sbeArrayAccessCommands -{ - SBE_CMD_GET_FAST_ARRAY = 0x01, /* Get Fast Array */ - SBE_CMD_GET_TRACE_ARRAY = 0x02, /* Get Trace Array */ - SBE_CMD_CONTROL_TRACE_ARRAY = 0x03, /* Control Trace Array */ -}; - -/** - * @brief enums for Instruction Control Messages - * -*/ -enum sbeInstructionControlCommands -{ - SBE_CMD_CONTROL_INSTRUCTIONS = 0x01, /* Control Instructions */ -}; - -/** - * @brief enums for Generic Messages - * -*/ -enum sbeGenericMessageCommands -{ - SBE_CMD_GET_SBE_FFDC = 0x01, /* Get FFDC */ - SBE_CMD_GET_SBE_CAPABILITIES = 0x02, /* GET SBE capabilities */ - SBE_CMD_GET_FREQ_SUPPORTED = 0x03, /* Get Supported frequencies */ - SBE_CMD_ABORT = 0x05, /* Sbe Abort */ -}; - -enum sbeMpIplCommands -{ - SBE_CMD_MPIPL_ENTER = 0x01, /* Enter MPIPL */ - SBE_CMD_MPIPL_CONTINUE = 0x02, /* Continue MPIPL */ -}; - -/** - * @brief enums for primary SBE response - * -*/ -enum sbePrimResponse -{ - SBE_PRI_OPERATION_SUCCESSFUL = 0x00, - SBE_PRI_INVALID_COMMAND = 0x01, - SBE_PRI_INVALID_DATA = 0x02, - SBE_PRI_SEQUENCE_ERROR = 0x03, - SBE_PRI_INTERNAL_ERROR = 0x04, - SBE_PRI_GENERIC_EXECUTION_FAILURE = 0xFE, -}; - -/** - * @brief enums for secondary SBE response - * @TODO via RTC: 129763 - * Discuss on SBE_SEC_INVALID_TARGET_ID_PASSED - * -*/ -enum sbeSecondaryResponse -{ - SBE_SEC_OPERATION_SUCCESSFUL = 0x00, - SBE_SEC_COMMAND_CLASS_NOT_SUPPORTED = 0x01, - SBE_SEC_COMMAND_NOT_SUPPORTED = 0x02, - SBE_SEC_INVALID_ADDRESS_PASSED = 0x03, - SBE_SEC_INVALID_TARGET_TYPE_PASSED = 0x04, - SBE_SEC_INVALID_TARGET_ID_PASSED = 0x05, - SBE_SEC_SPECIFIED_TARGET_NOT_PRESENT = 0x06, - SBE_SEC_SPECIFIED_TARGET_NOT_FUNCTIONAL = 0x07, - SBE_SEC_COMMAND_NOT_ALLOWED_IN_THIS_STATE = 0x08, - SBE_SEC_FUNCTIONALITY_NOT_SUPPORTED = 0x09, - SBE_SEC_GENERIC_FAILURE_IN_EXECUTION = 0x0A, - SBE_SEC_SECURITY_VALIDATION_FAILED = 0x0B, - SBE_SEC_OS_FAILURE = 0x0C, - SBE_SEC_FIFO_ACCESS_FAILURE = 0x0D, - SBE_SEC_UNEXPECTED_EOT_INSUFFICIENT_DATA = 0x0E, - SBE_SEC_UNEXPECTED_EOT_EXCESS_DATA = 0x0F, - SBE_SEC_HW_OP_TIMEOUT = 0x10, - SBE_SEC_PCB_PIB_ERR = 0x11, -}; - -/** - * @brief enums for SBE command timeout values - * -*/ -enum sbeCmdRespTimeout -{ - SBE_CMD_TIMEOUT_SHORT_IN_MSEC = 100, - SBE_CMD_TIMEOUT_LONG_IN_MSEC = 30000, -}; - -/** - * @brief enums for PCB-PIB Generic Error codes - * -*/ -enum sbePCBPIBErrorRC -{ - SBE_PCB_PIB_ERROR_NONE = 0x00, - SBE_PCB_PIB_ERROR_RESOURCE_OCCUPIED = 0x01, - SBE_PCB_PIB_ERROR_CHIPLET_OFFLINE = 0x02, - SBE_PCB_PIB_ERROR_PARTIAL_GOOD = 0x03, - SBE_PCB_PIB_ERROR_ADDRESS_ERROR = 0x04, - SBE_PCB_PIB_ERROR_CLOCK_ERROR = 0x05, - SBE_PCB_PIB_ERROR_PACKET_ERROR = 0x06, - SBE_PCB_PIB_ERROR_TIMEOUT = 0x07, -}; - -/** - * @brief capabilities index values. - * Get Capability response will return 18 capabilities. This - * enum tells the index for each capability. Currently each generic - * functionality( scom, IPL ) etc span across two capabilities. - */ -enum -{ - GENERIC_CAPABILTITY_START_IDX = 0, - IPL_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 2, - SCOM_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 4, - RING_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 6, - MEMORY_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 8, - REGISTER_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 10, - ARRAY_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 12, - INSTRUCTION_CTRL_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 14, - GENERIC_CHIPOP_CAPABILITY_START_IDX = GENERIC_CAPABILTITY_START_IDX + 16, -}; -/** - * @brief capabilities enum values. - * - */ -enum -{ - HWP_FFDC_COLLECTION_SUPPPORTED = 0x00000001, - SBE_FFDC_COLLECTION_SUPPPORTED = 0x00000002, - ADDRESS_BLACKLISTING_SUPPPORTED = 0x00000004, - FIFO_RESET_SUPPPORTED = 0x00000008, - EXECUTE_ISTEP_SUPPPORTED = 0xA1000001, - IS_SBE_DONE_SUPPPORTED = 0xA1000002, - GET_SCOM_SUPPPORTED = 0xA2000001, - PUT_SCOM_SUPPPORTED = 0xA2000002, - MODIFY_SCOM_SUPPPORTED = 0xA2000004, - PUT_SCOM_UNDER_MASK_SUPPPORTED = 0xA2000008, - MULTI_SCOM_SUPPPORTED = 0xA2000010, - GET_RING_SUPPPORTED = 0xA3000001, - PUT_RING_SUPPPORTED = 0xA3000002, - GET_MEMORY_SUPPPORTED = 0xA4000001, - PUT_MEMORY_SUPPPORTED = 0xA4000002, - GET_SRAM_OCC_SUPPPORTED = 0xA4000004, - PUT_SRAM_OCC_SUPPPORTED = 0xA4000008, - GET_SRAM_CME_SUPPPORTED = 0xA4000010, - PUT_SRAM_CME_SUPPPORTED = 0xA4000011, - GET_REGISTER_SUPPPORTED = 0xA5000001, - PUT_REGISTER_SUPPPORTED = 0xA5000002, - READ_FAST_ARRAY_SUPPPORTED = 0xA6000001, - READ_TRACE_ARRAY_SUPPPORTED = 0xA6000002, - COLLECT_TRACE_ARRAY_SUPPPORTED = 0xA6000004, - CONTROL_INSTRUCTIONS_SUPPPORTED = 0xA7000001, - GET_SBE_FFDC_SUPPPORTED = 0xA8000001, - GET_SBE_CAPABILITIES_SUPPPORTED = 0xA8000002, - GET_SBE_FREQUENCIES_SUPPPORTED = 0xA8000004, - GET_SBE_STATE_SUPPPORTED = 0xA8000008, -}; - -/** - * * @brief enums for SBE Memory Access command flags - * - */ -enum sbeMemoryAccessFlags -{ - SBE_MEM_ACCESS_FLAGS_TARGET_PROC = 0x0001, //required in ADU - SBE_MEM_ACCESS_FLAGS_TARGET_PBA = 0x0002, //required in PBA - SBE_MEM_ACCESS_FLAGS_AUTO_INCR_ON = 0x0004, - SBE_MEM_ACCESS_FLAGS_ECC_REQUIRED = 0x0008, //required only in ADU-GET - SBE_MEM_ACCESS_FLAGS_ECC_OVERRIDE = 0x0008, //required only in ADU-PUT - SBE_MEM_ACCESS_FLAGS_ITAG = 0x0010, //ITAG Mode in ADU - SBE_MEM_ACCESS_FLAGS_FAST_MODE_ON = 0x0020, - SBE_MEM_ACCESS_FLAGS_LCO_ENABLED = 0x0040, //required only in PBA-PUT - SBE_MEM_ACCESS_FLAGS_CACHE_INHIBIT = 0x0080, //required in I/O oper ADU -}; - -/** - * @brief enum for various modes for Sram Access - */ -enum sbeSramAccessMode -{ - NORMAL_MODE = 0x1, - DEBUG_MODE = 0x2, - CIRCULAR_MODE = 0x3, -}; -/* - * Constants for maximum number of register supported in reg access chipop. - */ -static const uint32_t SBE_MAX_REG_ACCESS_REGS = 64; - -/** - * @brief Error Mode enum - */ -enum sbeErrorMode -{ - EXIT_ON_FIRST_ERROR = 0x0, // Bail out on first error - IGNORE_HW_ERRORS = 0x01, // Attempt best case -}; - -/** - * @brief Core Chiplet Id Enum - */ -enum sbeCoreChipletId -{ - SMT4_CORE0_ID = 0x20, - SMT4_CORE_ID_MAX = 0x38, - SMT4_ALL_CORES = 0xFF, -}; - -/** - * @brief Thread Num Enum - */ -enum sbeThreadNum -{ - SMT4_THREAD0 = 0x0, - SMT4_THREAD1 = 0x1, - SMT4_THREAD2 = 0x2, - SMT4_THREAD3 = 0x3, - SMT4_THREAD_MAX = 0x4, - SMT4_THREAD_ALL = 0xF, -}; - -/** - * @brief Thread Operation Enum - */ -enum sbeThreadOps -{ - THREAD_START_INS = 0x0, - THREAD_STOP_INS = 0x1, - THREAD_STEP_INS = 0x2, - THREAD_SRESET_INS = 0x3, -}; - -/** - * @brief enums for Reg access register type - * - */ -enum sbeRegAccesRegType -{ - SBE_REG_ACCESS_GPR = 0x00, - SBE_REG_ACCESS_SPR = 0x01, - SBE_REG_ACCESS_FPR = 0x02, -}; - -/* - * @brief enums for target types used in ring access chip op -*/ -typedef enum -{ - TARGET_PROC_CHIP = 0x0000, - TARGET_EX = 0x0001, - TARGET_PERV = 0x0002, - TARGET_MCS = 0x0003, -} sbeRingTargetTypes_t; - -/* - * @brief enums for access modes used in ring access chip op - */ -typedef enum -{ - SBE_RING_MODE_NO_HEADER_CHECK = 0x0001, ///< Don't check header - SBE_RING_MODE_SET_PULSE_NO_OPCG_COND = 0x0002, ///< Set pulse with - /// no OPCG conditioning - SBE_RING_MODE_SET_PULSE_NSL = 0x0004, ///< Set pulse with NSL - /// pulse - SBE_RING_MODE_SET_PULSE_SL = 0x0008, ///< Set pulse with SL - /// pulse - SBE_RING_MODE_SET_PULSE_ALL = 0x0010, ///< Set pulse with pulse - /// to all hold types -} sbeRingAccessModes_t; - -#ifdef __cplusplus -} -#endif - -#endif /* __SBEFW_SBE_SP_INTF_H */ |
