xref: /rk3399_ARM-atf/plat/st/stm32mp2/stm32mp2_def.h (revision 03020b6688b459da84bdb2a3fb58c99916bfd7f7)
1 /*
2  * Copyright (c) 2023-2024, STMicroelectronics - All Rights Reserved
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef STM32MP2_DEF_H
8 #define STM32MP2_DEF_H
9 
10 #include <common/tbbr/tbbr_img_def.h>
11 #ifndef __ASSEMBLER__
12 #include <drivers/st/bsec.h>
13 #endif
14 #include <drivers/st/stm32mp25_rcc.h>
15 #ifndef __ASSEMBLER__
16 #include <drivers/st/stm32mp2_clk.h>
17 #endif
18 #include <drivers/st/stm32mp2_pwr.h>
19 #include <dt-bindings/clock/stm32mp25-clks.h>
20 #include <dt-bindings/clock/stm32mp25-clksrc.h>
21 #include <dt-bindings/gpio/stm32-gpio.h>
22 #include <dt-bindings/reset/stm32mp25-resets.h>
23 
24 #ifndef __ASSEMBLER__
25 #include <boot_api.h>
26 #include <stm32mp2_private.h>
27 #include <stm32mp_common.h>
28 #include <stm32mp_dt.h>
29 #include <stm32mp_shared_resources.h>
30 #endif
31 
32 /*******************************************************************************
33  * CHIP ID
34  ******************************************************************************/
35 #define STM32MP2_CHIP_ID			U(0x505)
36 
37 #define STM32MP251A_PART_NB			U(0x400B3E6D)
38 #define STM32MP251C_PART_NB			U(0x000B306D)
39 #define STM32MP251D_PART_NB			U(0xC00B3E6D)
40 #define STM32MP251F_PART_NB			U(0x800B306D)
41 #define STM32MP253A_PART_NB			U(0x400B3E0C)
42 #define STM32MP253C_PART_NB			U(0x000B300C)
43 #define STM32MP253D_PART_NB			U(0xC00B3E0C)
44 #define STM32MP253F_PART_NB			U(0x800B300C)
45 #define STM32MP255A_PART_NB			U(0x40082E00)
46 #define STM32MP255C_PART_NB			U(0x00082000)
47 #define STM32MP255D_PART_NB			U(0xC0082E00)
48 #define STM32MP255F_PART_NB			U(0x80082000)
49 #define STM32MP257A_PART_NB			U(0x40002E00)
50 #define STM32MP257C_PART_NB			U(0x00002000)
51 #define STM32MP257D_PART_NB			U(0xC0002E00)
52 #define STM32MP257F_PART_NB			U(0x80002000)
53 
54 #define STM32MP2_REV_A				U(0x08)
55 #define STM32MP2_REV_B				U(0x10)
56 #define STM32MP2_REV_X				U(0x12)
57 #define STM32MP2_REV_Y				U(0x11)
58 #define STM32MP2_REV_Z				U(0x09)
59 
60 /*******************************************************************************
61  * PACKAGE ID
62  ******************************************************************************/
63 #define STM32MP25_PKG_CUSTOM			U(0)
64 #define STM32MP25_PKG_AL_VFBGA361		U(1)
65 #define STM32MP25_PKG_AK_VFBGA424		U(3)
66 #define STM32MP25_PKG_AI_TFBGA436		U(5)
67 #define STM32MP25_PKG_UNKNOWN			U(7)
68 
69 /*******************************************************************************
70  * STM32MP2 memory map related constants
71  ******************************************************************************/
72 #define STM32MP_SYSRAM_BASE			U(0x0E000000)
73 #define STM32MP_SYSRAM_SIZE			U(0x00040000)
74 #define STM32MP_SEC_SYSRAM_SIZE			STM32MP_SYSRAM_SIZE
75 
76 /* DDR configuration */
77 #define STM32MP_DDR_BASE			U(0x80000000)
78 #define STM32MP_DDR_MAX_SIZE			UL(0x100000000)	/* Max 4GB */
79 
80 /* DDR power initializations */
81 #ifndef __ASSEMBLER__
82 enum ddr_type {
83 	STM32MP_DDR3,
84 	STM32MP_DDR4,
85 	STM32MP_LPDDR4
86 };
87 #endif
88 
89 /* Section used inside TF binaries */
90 #define STM32MP_PARAM_LOAD_SIZE			U(0x00002400) /* 9 KB for param */
91 /* 512 Bytes reserved for header */
92 #define STM32MP_HEADER_SIZE			U(0x00000200)
93 #define STM32MP_HEADER_BASE			(STM32MP_SYSRAM_BASE +	\
94 						 STM32MP_PARAM_LOAD_SIZE)
95 
96 /* round_up(STM32MP_PARAM_LOAD_SIZE + STM32MP_HEADER_SIZE, PAGE_SIZE) */
97 #define STM32MP_HEADER_RESERVED_SIZE		U(0x3000)
98 
99 #define STM32MP_BINARY_BASE			(STM32MP_SYSRAM_BASE +	\
100 						 STM32MP_PARAM_LOAD_SIZE +	\
101 						 STM32MP_HEADER_SIZE)
102 
103 #define STM32MP_BINARY_SIZE			(STM32MP_SYSRAM_SIZE -	\
104 						 (STM32MP_PARAM_LOAD_SIZE +	\
105 						  STM32MP_HEADER_SIZE))
106 
107 #define STM32MP_BL2_RO_SIZE			U(0x00020000) /* 128 KB */
108 #define STM32MP_BL2_SIZE			U(0x00029000) /* 164 KB for BL2 */
109 
110 /* Allocate remaining sysram to BL31 */
111 #define STM32MP_BL31_SIZE			(STM32MP_SEC_SYSRAM_SIZE - \
112 						 STM32MP_BL2_SIZE)
113 
114 #define STM32MP_BL2_BASE			(STM32MP_SYSRAM_BASE + \
115 						 STM32MP_SYSRAM_SIZE - \
116 						 STM32MP_BL2_SIZE)
117 
118 #define STM32MP_BL2_RO_BASE			STM32MP_BL2_BASE
119 
120 #define STM32MP_BL2_RW_BASE			(STM32MP_BL2_RO_BASE + \
121 						 STM32MP_BL2_RO_SIZE)
122 
123 #define STM32MP_BL2_RW_SIZE			(STM32MP_SYSRAM_BASE + \
124 						 STM32MP_SYSRAM_SIZE - \
125 						 STM32MP_BL2_RW_BASE)
126 
127 /* BL2 and BL32/sp_min require 4 tables */
128 #define MAX_XLAT_TABLES				U(4)	/* 16 KB for mapping */
129 
130 /*
131  * MAX_MMAP_REGIONS is usually:
132  * BL stm32mp2_mmap size + mmap regions in *_plat_arch_setup
133  */
134 #define MAX_MMAP_REGIONS			6
135 
136 /* DTB initialization value */
137 #define STM32MP_BL2_DTB_SIZE			U(0x00006000)	/* 24 KB for DTB */
138 
139 #define STM32MP_BL2_DTB_BASE			(STM32MP_BL2_BASE - \
140 						 STM32MP_BL2_DTB_SIZE)
141 
142 #if defined(IMAGE_BL2)
143 #define STM32MP_DTB_SIZE			STM32MP_BL2_DTB_SIZE
144 #define STM32MP_DTB_BASE			STM32MP_BL2_DTB_BASE
145 #endif
146 
147 #define STM32MP_FW_CONFIG_MAX_SIZE		PAGE_SIZE
148 #define STM32MP_FW_CONFIG_BASE			STM32MP_SYSRAM_BASE
149 
150 #define STM32MP_BL33_BASE			(STM32MP_DDR_BASE + U(0x04000000))
151 #define STM32MP_BL33_MAX_SIZE			U(0x400000)
152 #define STM32MP_HW_CONFIG_BASE			(STM32MP_BL33_BASE + \
153 						STM32MP_BL33_MAX_SIZE)
154 #define STM32MP_HW_CONFIG_MAX_SIZE		U(0x40000)
155 
156 /*******************************************************************************
157  * STM32MP2 device/io map related constants (used for MMU)
158  ******************************************************************************/
159 #define STM32MP_DEVICE_BASE			U(0x40000000)
160 #define STM32MP_DEVICE_SIZE			U(0x40000000)
161 
162 /*******************************************************************************
163  * STM32MP2 RCC
164  ******************************************************************************/
165 #define RCC_BASE				U(0x44200000)
166 
167 /*******************************************************************************
168  * STM32MP2 PWR
169  ******************************************************************************/
170 #define PWR_BASE				U(0x44210000)
171 
172 /*******************************************************************************
173  * STM32MP2 GPIO
174  ******************************************************************************/
175 #define GPIOA_BASE				U(0x44240000)
176 #define GPIOB_BASE				U(0x44250000)
177 #define GPIOC_BASE				U(0x44260000)
178 #define GPIOD_BASE				U(0x44270000)
179 #define GPIOE_BASE				U(0x44280000)
180 #define GPIOF_BASE				U(0x44290000)
181 #define GPIOG_BASE				U(0x442A0000)
182 #define GPIOH_BASE				U(0x442B0000)
183 #define GPIOI_BASE				U(0x442C0000)
184 #define GPIOJ_BASE				U(0x442D0000)
185 #define GPIOK_BASE				U(0x442E0000)
186 #define GPIOZ_BASE				U(0x46200000)
187 #define GPIO_BANK_OFFSET			U(0x10000)
188 
189 #define STM32MP_GPIOS_PIN_MAX_COUNT		16
190 #define STM32MP_GPIOZ_PIN_MAX_COUNT		8
191 
192 /*******************************************************************************
193  * STM32MP2 UART
194  ******************************************************************************/
195 #define USART1_BASE				U(0x40330000)
196 #define USART2_BASE				U(0x400E0000)
197 #define USART3_BASE				U(0x400F0000)
198 #define UART4_BASE				U(0x40100000)
199 #define UART5_BASE				U(0x40110000)
200 #define USART6_BASE				U(0x40220000)
201 #define UART7_BASE				U(0x40370000)
202 #define UART8_BASE				U(0x40380000)
203 #define UART9_BASE				U(0x402C0000)
204 #define STM32MP_NB_OF_UART			U(9)
205 
206 /* For UART crash console */
207 #define STM32MP_DEBUG_USART_CLK_FRQ		64000000
208 /* USART2 on HSI@64MHz, TX on GPIOA4 Alternate 6 */
209 #define STM32MP_DEBUG_USART_BASE		USART2_BASE
210 #define DEBUG_UART_TX_GPIO_BANK_ADDRESS		GPIOA_BASE
211 #define DEBUG_UART_TX_GPIO_BANK_CLK_REG		RCC_GPIOACFGR
212 #define DEBUG_UART_TX_GPIO_BANK_CLK_EN		RCC_GPIOxCFGR_GPIOxEN
213 #define DEBUG_UART_TX_GPIO_PORT			4
214 #define DEBUG_UART_TX_GPIO_ALTERNATE		6
215 #define DEBUG_UART_TX_CLKSRC_REG		RCC_XBAR8CFGR
216 #define DEBUG_UART_TX_CLKSRC			XBAR_SRC_HSI
217 #define DEBUG_UART_TX_EN_REG			RCC_USART2CFGR
218 #define DEBUG_UART_TX_EN			RCC_UARTxCFGR_UARTxEN
219 #define DEBUG_UART_RST_REG			RCC_USART2CFGR
220 #define DEBUG_UART_RST_BIT			RCC_UARTxCFGR_UARTxRST
221 #define DEBUG_UART_PREDIV_CFGR			RCC_PREDIV8CFGR
222 #define DEBUG_UART_FINDIV_CFGR			RCC_FINDIV8CFGR
223 
224 /*******************************************************************************
225  * STM32MP2 SDMMC
226  ******************************************************************************/
227 #define STM32MP_SDMMC1_BASE			U(0x48220000)
228 #define STM32MP_SDMMC2_BASE			U(0x48230000)
229 #define STM32MP_SDMMC3_BASE			U(0x48240000)
230 
231 /*******************************************************************************
232  * STM32MP2 BSEC / OTP
233  ******************************************************************************/
234 /*
235  * 367 available OTPs, the other are masked
236  * - ECIES key: 368 to 375 (only readable by bootrom)
237  * - HWKEY: 376 to 383 (never reloadable or readable)
238  */
239 #define STM32MP2_OTP_MAX_ID			U(0x16F)
240 #define STM32MP2_MID_OTP_START			U(0x80)
241 #define STM32MP2_UPPER_OTP_START		U(0x100)
242 
243 /* OTP labels */
244 #define PART_NUMBER_OTP				"part-number-otp"
245 #define REVISION_OTP				"rev_otp"
246 #define PACKAGE_OTP				"package-otp"
247 #define HCONF1_OTP				"otp124"
248 #define NAND_OTP				"otp16"
249 #define NAND2_OTP				"otp20"
250 #define BOARD_ID_OTP				"board-id"
251 #define UID_OTP					"uid-otp"
252 #define LIFECYCLE2_OTP				"otp18"
253 #define PKH_OTP					"otp144"
254 #define ENCKEY_OTP				"otp260"
255 
256 /* OTP mask */
257 /* PACKAGE */
258 #define PACKAGE_OTP_PKG_MASK			GENMASK_32(2, 0)
259 #define PACKAGE_OTP_PKG_SHIFT			U(0)
260 
261 /* IWDG OTP */
262 #define HCONF1_OTP_IWDG_HW_POS			U(0)
263 #define HCONF1_OTP_IWDG_FZ_STOP_POS		U(1)
264 #define HCONF1_OTP_IWDG_FZ_STANDBY_POS		U(2)
265 
266 /* NAND OTP */
267 /* NAND parameter storage flag */
268 #define NAND_PARAM_STORED_IN_OTP		BIT_32(31)
269 
270 /* NAND page size in bytes */
271 #define NAND_PAGE_SIZE_MASK			GENMASK_32(30, 29)
272 #define NAND_PAGE_SIZE_SHIFT			U(29)
273 #define NAND_PAGE_SIZE_2K			U(0)
274 #define NAND_PAGE_SIZE_4K			U(1)
275 #define NAND_PAGE_SIZE_8K			U(2)
276 
277 /* NAND block size in pages */
278 #define NAND_BLOCK_SIZE_MASK			GENMASK_32(28, 27)
279 #define NAND_BLOCK_SIZE_SHIFT			U(27)
280 #define NAND_BLOCK_SIZE_64_PAGES		U(0)
281 #define NAND_BLOCK_SIZE_128_PAGES		U(1)
282 #define NAND_BLOCK_SIZE_256_PAGES		U(2)
283 
284 /* NAND number of block (in unit of 256 blocks) */
285 #define NAND_BLOCK_NB_MASK			GENMASK_32(26, 19)
286 #define NAND_BLOCK_NB_SHIFT			U(19)
287 #define NAND_BLOCK_NB_UNIT			U(256)
288 
289 /* NAND bus width in bits */
290 #define NAND_WIDTH_MASK				BIT_32(18)
291 #define NAND_WIDTH_SHIFT			U(18)
292 
293 /* NAND number of ECC bits per 512 bytes */
294 #define NAND_ECC_BIT_NB_MASK			GENMASK_32(17, 15)
295 #define NAND_ECC_BIT_NB_SHIFT			U(15)
296 #define NAND_ECC_BIT_NB_UNSET			U(0)
297 #define NAND_ECC_BIT_NB_1_BITS			U(1)
298 #define NAND_ECC_BIT_NB_4_BITS			U(2)
299 #define NAND_ECC_BIT_NB_8_BITS			U(3)
300 #define NAND_ECC_ON_DIE				U(4)
301 
302 /* NAND number of planes */
303 #define NAND_PLANE_BIT_NB_MASK			BIT_32(14)
304 
305 /* NAND2 OTP */
306 #define NAND2_PAGE_SIZE_SHIFT			U(16)
307 
308 /* NAND2 config distribution */
309 #define NAND2_CONFIG_DISTRIB			BIT_32(0)
310 #define NAND2_PNAND_NAND2_SNAND_NAND1		U(0)
311 #define NAND2_PNAND_NAND1_SNAND_NAND2		U(1)
312 
313 /* MONOTONIC OTP */
314 #define MAX_MONOTONIC_VALUE			U(32)
315 
316 /* UID OTP */
317 #define UID_WORD_NB				U(3)
318 
319 /* Lifecycle OTP */
320 #define SECURE_BOOT_CLOSED_SECURE		GENMASK_32(3, 0)
321 
322 /*******************************************************************************
323  * STM32MP2 TAMP
324  ******************************************************************************/
325 #define PLAT_MAX_TAMP_INT			U(5)
326 #define PLAT_MAX_TAMP_EXT			U(3)
327 #define TAMP_BASE				U(0x46010000)
328 #define TAMP_SMCR				(TAMP_BASE + U(0x20))
329 #define TAMP_BKP_REGISTER_BASE			(TAMP_BASE + U(0x100))
330 #define TAMP_BKP_REG_CLK			CK_BUS_RTC
331 #define TAMP_BKP_SEC_NUMBER			U(10)
332 #define TAMP_COUNTR				U(0x40)
333 
334 #if !(defined(__LINKER__) || defined(__ASSEMBLER__))
335 static inline uintptr_t tamp_bkpr(uint32_t idx)
336 {
337 	return TAMP_BKP_REGISTER_BASE + (idx << 2);
338 }
339 #endif
340 
341 /*******************************************************************************
342  * STM32MP2 DDRCTRL
343  ******************************************************************************/
344 #define DDRCTRL_BASE				U(0x48040000)
345 
346 /*******************************************************************************
347  * STM32MP2 DDRDBG
348  ******************************************************************************/
349 #define DDRDBG_BASE				U(0x48050000)
350 
351 /*******************************************************************************
352  * STM32MP2 DDRPHYC
353  ******************************************************************************/
354 #define DDRPHYC_BASE				U(0x48C00000)
355 
356 /*******************************************************************************
357  * Miscellaneous STM32MP1 peripherals base address
358  ******************************************************************************/
359 #define BSEC_BASE				U(0x44000000)
360 #define DBGMCU_BASE				U(0x4A010000)
361 #define HASH_BASE				U(0x42010000)
362 #define RTC_BASE				U(0x46000000)
363 #define STGEN_BASE				U(0x48080000)
364 #define SYSCFG_BASE				U(0x44230000)
365 
366 /*******************************************************************************
367  * STM32MP CA35SSC
368  ******************************************************************************/
369 #define A35SSC_BASE				U(0x48800000)
370 
371 /*******************************************************************************
372  * REGULATORS
373  ******************************************************************************/
374 /* 3 PWR + 1 VREFBUF + 14 PMIC regulators + 1 FIXED */
375 #define PLAT_NB_RDEVS				U(19)
376 /* 2 FIXED */
377 #define PLAT_NB_FIXED_REGUS			U(2)
378 /* No GPIO regu */
379 #define PLAT_NB_GPIO_REGUS			U(0)
380 
381 /*******************************************************************************
382  * Device Tree defines
383  ******************************************************************************/
384 #define DT_BSEC_COMPAT				"st,stm32mp25-bsec"
385 #define DT_DDR_COMPAT				"st,stm32mp2-ddr"
386 #define DT_PWR_COMPAT				"st,stm32mp25-pwr"
387 #define DT_RCC_CLK_COMPAT			"st,stm32mp25-rcc"
388 #define DT_SDMMC2_COMPAT			"st,stm32mp25-sdmmc2"
389 #define DT_UART_COMPAT				"st,stm32h7-uart"
390 
391 #endif /* STM32MP2_DEF_H */
392