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