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