1 /*
2  * Copyright (c) 2021-2022, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef SGI_SOC_CSS_DEF_V2_H
8 #define SGI_SOC_CSS_DEF_V2_H
9 
10 #include <lib/utils_def.h>
11 #include <plat/common/common_def.h>
12 
13 /*
14  * Definitions common to all ARM CSS SoCs
15  */
16 
17 /* Following covers ARM CSS SoC Peripherals */
18 
19 #define SOC_SYSTEM_PERIPH_BASE		UL(0x0C000000)
20 #define SOC_SYSTEM_PERIPH_SIZE		UL(0x02000000)
21 
22 #define SOC_PLATFORM_PERIPH_BASE	UL(0x0E000000)
23 #define SOC_PLATFORM_PERIPH_SIZE	UL(0x02000000)
24 
25 #define SOC_CSS_PCIE_CONTROL_BASE	UL(0x0ef20000)
26 
27 /* Memory controller */
28 #define SOC_MEMCNTRL_BASE		UL(0x10000000)
29 #define SOC_MEMCNTRL_SIZE		UL(0x10000000)
30 
31 /* SoC NIC-400 Global Programmers View (GPV) */
32 #define SOC_CSS_NIC400_BASE		UL(0x0ED00000)
33 
34 #define SOC_CSS_NIC400_USB_EHCI		U(0)
35 #define SOC_CSS_NIC400_TLX_MASTER	U(1)
36 #define SOC_CSS_NIC400_USB_OHCI		U(2)
37 #define SOC_CSS_NIC400_PL354_SMC	U(3)
38 /*
39  * The apb4_bridge controls access to:
40  *   - the PCIe configuration registers
41  *   - the MMU units for USB, HDLCD and DMA
42  */
43 #define SOC_CSS_NIC400_APB4_BRIDGE	U(4)
44 
45 /* Non-volatile counters */
46 #define SOC_TRUSTED_NVCTR_BASE		UL(0x0EE70000)
47 #define TFW_NVCTR_BASE			(SOC_TRUSTED_NVCTR_BASE + 0x0000)
48 #define TFW_NVCTR_SIZE			U(4)
49 #define NTFW_CTR_BASE			(SOC_TRUSTED_NVCTR_BASE + 0x0004)
50 #define NTFW_CTR_SIZE			U(4)
51 
52 /* Keys */
53 #define SOC_KEYS_BASE			UL(0x0EE80000)
54 #define TZ_PUB_KEY_HASH_BASE		(SOC_KEYS_BASE + 0x0000)
55 #define TZ_PUB_KEY_HASH_SIZE		U(32)
56 #define HU_KEY_BASE			(SOC_KEYS_BASE + 0x0020)
57 #define HU_KEY_SIZE			U(16)
58 #define END_KEY_BASE			(SOC_KEYS_BASE + 0x0044)
59 #define END_KEY_SIZE			U(32)
60 
61 /* Base Element RAM error definitions */
62 #define SOC_NS_RAM_ERR_REC_BASE		UL(0x2A4C0000)
63 #define NS_RAM_ECC_CE_INT		U(87)
64 #define NS_RAM_ECC_UE_INT		U(88)
65 
66 #define SOC_PLATFORM_PERIPH_MAP_DEVICE	MAP_REGION_FLAT(			\
67 						SOC_PLATFORM_PERIPH_BASE, 	\
68 						SOC_PLATFORM_PERIPH_SIZE, 	\
69 						MT_DEVICE | MT_RW | MT_SECURE)
70 
71 #if SPM_MM
72 /*
73  * Memory map definition for the platform peripheral memory region that is
74  * accessible from S-EL0 (with secure user mode access).
75  */
76 #define SOC_PLATFORM_PERIPH_MAP_DEVICE_USER				       \
77 		MAP_REGION_FLAT(					       \
78 			SOC_PLATFORM_PERIPH_BASE,			       \
79 			SOC_PLATFORM_PERIPH_SIZE,			       \
80 			MT_DEVICE | MT_RW | MT_SECURE | MT_USER)
81 #endif
82 
83 #define SOC_SYSTEM_PERIPH_MAP_DEVICE	MAP_REGION_FLAT(			\
84 						SOC_SYSTEM_PERIPH_BASE,		\
85 						SOC_SYSTEM_PERIPH_SIZE,		\
86 						MT_DEVICE | MT_RW | MT_SECURE)
87 
88 #define SOC_MEMCNTRL_MAP_DEVICE		MAP_REGION_FLAT(			\
89 						SOC_MEMCNTRL_BASE,		\
90 						SOC_MEMCNTRL_SIZE,		\
91 						MT_DEVICE | MT_RW | MT_SECURE)
92 
93 #define SOC_MEMCNTRL_MAP_DEVICE_REMOTE_CHIP(n)					\
94 		MAP_REGION_FLAT(						\
95 			CSS_SGI_REMOTE_CHIP_MEM_OFFSET(n) + SOC_MEMCNTRL_BASE,	\
96 			SOC_MEMCNTRL_SIZE,					\
97 			MT_DEVICE | MT_RW | MT_SECURE)
98 
99 /*
100  * The bootsec_bridge controls access to a bunch of peripherals, e.g. the UARTs.
101  */
102 #define SOC_CSS_NIC400_BOOTSEC_BRIDGE		U(5)
103 #define SOC_CSS_NIC400_BOOTSEC_BRIDGE_UART1	UL(1 << 12)
104 
105 /*
106  * Required platform porting definitions common to all ARM CSS SoCs
107  */
108 /* 2MB used for SCP DDR retraining */
109 #define PLAT_ARM_SCP_TZC_DRAM1_SIZE	UL(0x00200000)
110 
111 /* V2M motherboard system registers & offsets */
112 #define V2M_SYSREGS_BASE		UL(0x0C010000)
113 #define V2M_SYS_LED			U(0x8)
114 
115 /*
116  * V2M sysled bit definitions. The values written to this
117  * register are defined in arch.h & runtime_svc.h. Only
118  * used by the primary cpu to diagnose any cold boot issues.
119  *
120  * SYS_LED[0]   - Security state (S=0/NS=1)
121  * SYS_LED[2:1] - Exception Level (EL3-EL0)
122  * SYS_LED[7:3] - Exception Class (Sync/Async & origin)
123  *
124  */
125 #define V2M_SYS_LED_SS_SHIFT		U(0)
126 #define V2M_SYS_LED_EL_SHIFT		U(1)
127 #define V2M_SYS_LED_EC_SHIFT		U(3)
128 
129 #define V2M_SYS_LED_SS_MASK		U(0x01)
130 #define V2M_SYS_LED_EL_MASK		U(0x03)
131 #define V2M_SYS_LED_EC_MASK		U(0x1f)
132 
133 /* NOR Flash */
134 #define V2M_FLASH0_BASE			UL(0x08000000)
135 #define V2M_FLASH0_SIZE			UL(0x04000000)
136 #define V2M_FLASH_BLOCK_SIZE		UL(0x00040000)	/* 256 KB */
137 
138 /*
139  * The flash can be mapped either as read-only or read-write.
140  *
141  * If it is read-write then it should also be mapped as device memory because
142  * NOR flash programming involves sending a fixed, ordered sequence of commands.
143  *
144  * If it is read-only then it should also be mapped as:
145  * - Normal memory, because reading from NOR flash is transparent, it is like
146  *   reading from RAM.
147  * - Non-executable by default. If some parts of the flash need to be executable
148  *   then platform code is responsible for re-mapping the appropriate portion
149  *   of it as executable.
150  */
151 #define V2M_MAP_FLASH0_RW		MAP_REGION_FLAT(V2M_FLASH0_BASE,\
152 						V2M_FLASH0_SIZE,	\
153 						MT_DEVICE | MT_RW | MT_SECURE)
154 
155 #define V2M_MAP_FLASH0_RO		MAP_REGION_FLAT(V2M_FLASH0_BASE,\
156 						V2M_FLASH0_SIZE,	\
157 						MT_RO_DATA | MT_SECURE)
158 
159 #define SGI_MAP_FLASH0_RO		MAP_REGION_FLAT(V2M_FLASH0_BASE,\
160 						V2M_FLASH0_SIZE,	\
161 						MT_DEVICE | MT_RO | MT_SECURE)
162 
163 /* Platform ID address */
164 #define BOARD_CSS_PLAT_ID_REG_ADDR		UL(0x0EFE00E0)
165 
166 /* Platform ID related accessors */
167 #define BOARD_CSS_PLAT_ID_REG_ID_MASK		U(0x0F)
168 #define BOARD_CSS_PLAT_ID_REG_ID_SHIFT		U(0x00)
169 #define BOARD_CSS_PLAT_ID_REG_VERSION_MASK	U(0xF00)
170 #define BOARD_CSS_PLAT_ID_REG_VERSION_SHIFT	U(0x08)
171 #define BOARD_CSS_PLAT_TYPE_RTL			U(0x00)
172 #define BOARD_CSS_PLAT_TYPE_FPGA		U(0x01)
173 #define BOARD_CSS_PLAT_TYPE_EMULATOR		U(0x02)
174 #define BOARD_CSS_PLAT_TYPE_FVP			U(0x03)
175 
176 #ifndef __ASSEMBLER__
177 
178 #include <lib/mmio.h>
179 
180 #define BOARD_CSS_GET_PLAT_TYPE(addr)					\
181 	((mmio_read_32(addr) & BOARD_CSS_PLAT_ID_REG_ID_MASK)		\
182 	>> BOARD_CSS_PLAT_ID_REG_ID_SHIFT)
183 
184 #endif /* __ASSEMBLER__ */
185 
186 
187 #define MAX_IO_DEVICES			U(3)
188 #define MAX_IO_HANDLES			U(4)
189 
190 /* Reserve the last block of flash for PSCI MEM PROTECT flag */
191 #define PLAT_ARM_FLASH_IMAGE_BASE	V2M_FLASH0_BASE
192 #define PLAT_ARM_FLASH_IMAGE_MAX_SIZE	(V2M_FLASH0_SIZE - V2M_FLASH_BLOCK_SIZE)
193 
194 #if ARM_GPT_SUPPORT
195 /*
196  * Offset of the FIP in the GPT image. BL1 component uses this option
197  * as it does not load the partition table to get the FIP base
198  * address. At sector 34 by default (i.e. after reserved sectors 0-33)
199  * Offset = 34 * 512(sector size) = 17408 i.e. 0x4400
200  */
201 #define PLAT_ARM_FIP_OFFSET_IN_GPT		0x4400
202 #endif /* ARM_GPT_SUPPORT */
203 
204 #define PLAT_ARM_NVM_BASE		V2M_FLASH0_BASE
205 #define PLAT_ARM_NVM_SIZE		(V2M_FLASH0_SIZE - V2M_FLASH_BLOCK_SIZE)
206 
207 #endif /* SGI_SOC_CSS_DEF_V2_H */
208