1*91f16700Schasinglulu /* 2*91f16700Schasinglulu * Copyright (c) 2017, ARM Limited and Contributors. All rights reserved. 3*91f16700Schasinglulu * 4*91f16700Schasinglulu * SPDX-License-Identifier: BSD-3-Clause 5*91f16700Schasinglulu */ 6*91f16700Schasinglulu 7*91f16700Schasinglulu #ifndef SDS_H 8*91f16700Schasinglulu #define SDS_H 9*91f16700Schasinglulu 10*91f16700Schasinglulu /* SDS Structure Identifier defines */ 11*91f16700Schasinglulu /* AP CPU INFO defines */ 12*91f16700Schasinglulu #define SDS_AP_CPU_INFO_STRUCT_ID 1 13*91f16700Schasinglulu #define SDS_AP_CPU_INFO_PRIMARY_CPUID_OFFSET 0x0 14*91f16700Schasinglulu #define SDS_AP_CPU_INFO_PRIMARY_CPUID_SIZE 0x4 15*91f16700Schasinglulu 16*91f16700Schasinglulu /* ROM Firmware Version defines */ 17*91f16700Schasinglulu #define SDS_ROM_VERSION_STRUCT_ID 2 18*91f16700Schasinglulu #define SDS_ROM_VERSION_OFFSET 0x0 19*91f16700Schasinglulu #define SDS_ROM_VERSION_SIZE 0x4 20*91f16700Schasinglulu 21*91f16700Schasinglulu /* RAM Firmware version defines */ 22*91f16700Schasinglulu #define SDS_RAM_VERSION_STRUCT_ID 3 23*91f16700Schasinglulu #define SDS_RAM_VERSION_OFFSET 0x0 24*91f16700Schasinglulu #define SDS_RAM_VERSION_SIZE 0x4 25*91f16700Schasinglulu 26*91f16700Schasinglulu /* Platform Identity defines */ 27*91f16700Schasinglulu #define SDS_PLATFORM_IDENTITY_STRUCT_ID 4 28*91f16700Schasinglulu #define SDS_PLATFORM_IDENTITY_ID_OFFSET 0x0 29*91f16700Schasinglulu #define SDS_PLATFORM_IDENTITY_ID_SIZE 0x4 30*91f16700Schasinglulu #define SDS_PLATFORM_IDENTITY_ID_CONFIG_SHIFT 28 31*91f16700Schasinglulu #define SDS_PLATFORM_IDENTITY_ID_CONFIG_WIDTH 4 32*91f16700Schasinglulu #define SDS_PLATFORM_IDENTITY_ID_CONFIG_MASK \ 33*91f16700Schasinglulu ((1 << SDS_PLATFORM_IDENTITY_ID_CONFIG_WIDTH) - 1) 34*91f16700Schasinglulu 35*91f16700Schasinglulu #define SDS_PLATFORM_IDENTITY_PLAT_TYPE_OFFSET 0x4 36*91f16700Schasinglulu #define SDS_PLATFORM_IDENTITY_PLAT_TYPE_SIZE 0x4 37*91f16700Schasinglulu 38*91f16700Schasinglulu /* Reset Syndrome defines */ 39*91f16700Schasinglulu #define SDS_RESET_SYNDROME_STRUCT_ID 5 40*91f16700Schasinglulu #define SDS_RESET_SYNDROME_OFFSET 0 41*91f16700Schasinglulu #define SDS_RESET_SYNDROME_SIZE 4 42*91f16700Schasinglulu #define SDS_RESET_SYNDROME_POW_ON_RESET_BIT (1 << 0) 43*91f16700Schasinglulu #define SDS_RESET_SYNDROME_SCP_WD_RESET_BIT (1 << 1) 44*91f16700Schasinglulu #define SDS_RESET_SYNDROME_AP_WD_RESET_BIT (1 << 2) 45*91f16700Schasinglulu #define SDS_RESET_SYNDROME_SYS_RESET_REQ_BIT (1 << 3) 46*91f16700Schasinglulu #define SDS_RESET_SYNDROME_M3_LOCKUP_BIT (1 << 4) 47*91f16700Schasinglulu 48*91f16700Schasinglulu /* SCP Firmware Feature Availability defines */ 49*91f16700Schasinglulu #define SDS_FEATURE_AVAIL_STRUCT_ID 6 50*91f16700Schasinglulu #define SDS_FEATURE_AVAIL_OFFSET 0 51*91f16700Schasinglulu #define SDS_FEATURE_AVAIL_SIZE 4 52*91f16700Schasinglulu #define SDS_FEATURE_AVAIL_SCP_RAM_READY_BIT (1 << 0) 53*91f16700Schasinglulu #define SDS_FEATURE_AVAIL_DMC_READY_BIT (1 << 1) 54*91f16700Schasinglulu #define SDS_FEATURE_AVAIL_MSG_IF_READY_BIT (1 << 2) 55*91f16700Schasinglulu 56*91f16700Schasinglulu /* SCP BL2 Image Metadata defines */ 57*91f16700Schasinglulu #define SDS_SCP_IMG_STRUCT_ID 9 58*91f16700Schasinglulu #define SDS_SCP_IMG_FLAG_OFFSET 0 59*91f16700Schasinglulu #define SDS_SCP_IMG_FLAG_SIZE 4 60*91f16700Schasinglulu #define SDS_SCP_IMG_VALID_FLAG_BIT (1 << 0) 61*91f16700Schasinglulu #define SDS_SCP_IMG_ADDR_OFFSET 4 62*91f16700Schasinglulu #define SDS_SCP_IMG_ADDR_SIZE 4 63*91f16700Schasinglulu #define SDS_SCP_IMG_SIZE_OFFSET 8 64*91f16700Schasinglulu #define SDS_SCP_IMG_SIZE_SIZE 4 65*91f16700Schasinglulu 66*91f16700Schasinglulu /* SDS Driver Error Codes */ 67*91f16700Schasinglulu #define SDS_OK 0 68*91f16700Schasinglulu #define SDS_ERR_FAIL -1 69*91f16700Schasinglulu #define SDS_ERR_INVALID_PARAMS -2 70*91f16700Schasinglulu #define SDS_ERR_STRUCT_NOT_FOUND -3 71*91f16700Schasinglulu #define SDS_ERR_STRUCT_NOT_FINALIZED -4 72*91f16700Schasinglulu 73*91f16700Schasinglulu #ifndef __ASSEMBLER__ 74*91f16700Schasinglulu #include <stddef.h> 75*91f16700Schasinglulu #include <stdint.h> 76*91f16700Schasinglulu 77*91f16700Schasinglulu typedef enum { 78*91f16700Schasinglulu SDS_ACCESS_MODE_NON_CACHED, 79*91f16700Schasinglulu SDS_ACCESS_MODE_CACHED, 80*91f16700Schasinglulu } sds_access_mode_t; 81*91f16700Schasinglulu 82*91f16700Schasinglulu int sds_init(void); 83*91f16700Schasinglulu int sds_struct_exists(unsigned int structure_id); 84*91f16700Schasinglulu int sds_struct_read(uint32_t structure_id, unsigned int fld_off, void *data, 85*91f16700Schasinglulu size_t size, sds_access_mode_t mode); 86*91f16700Schasinglulu int sds_struct_write(uint32_t structure_id, unsigned int fld_off, void *data, 87*91f16700Schasinglulu size_t size, sds_access_mode_t mode); 88*91f16700Schasinglulu #endif /*__ASSEMBLER__ */ 89*91f16700Schasinglulu 90*91f16700Schasinglulu #endif /* SDS_H */ 91