1 /*
2  * Copyright (c) 2017-2022 Arm Limited. All rights reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef __REGION_DEFS_H__
18 #define __REGION_DEFS_H__
19 
20 #include "flash_layout.h"
21 
22 #define BL2_HEAP_SIZE           (0x00001000)
23 #define BL2_MSP_STACK_SIZE      (0x00001800)
24 
25 #ifdef ENABLE_HEAP
26 #define S_HEAP_SIZE             (0x00000200)
27 #endif
28 
29 #ifdef TFM_FIH_PROFILE_ON
30 #define S_MSP_STACK_SIZE        (0x00000A40)
31 #else
32 #define S_MSP_STACK_SIZE        (0x00000800)
33 #endif
34 #define S_PSP_STACK_SIZE        (0x00000800)
35 
36 #define NS_HEAP_SIZE            (0x00001000)
37 #define NS_STACK_SIZE           (0x000001E0)
38 
39 /* MPC granularity is 128 KB on AN521 Castor MPS2 FPGA image. Alignment
40  * of partitions is defined in accordance with this constraint.
41  */
42 
43 #ifdef BL2
44 #ifndef LINK_TO_SECONDARY_PARTITION
45 #define S_IMAGE_PRIMARY_PARTITION_OFFSET   (FLASH_AREA_0_OFFSET)
46 #define S_IMAGE_SECONDARY_PARTITION_OFFSET (FLASH_AREA_2_OFFSET)
47 #else
48 #define S_IMAGE_PRIMARY_PARTITION_OFFSET   (FLASH_AREA_2_OFFSET)
49 #define S_IMAGE_SECONDARY_PARTITION_OFFSET (FLASH_AREA_0_OFFSET)
50 #endif /* !LINK_TO_SECONDARY_PARTITION */
51 #else
52 #define S_IMAGE_PRIMARY_PARTITION_OFFSET (0x0)
53 #endif /* BL2 */
54 
55 #ifndef LINK_TO_SECONDARY_PARTITION
56 #define NS_IMAGE_PRIMARY_PARTITION_OFFSET (FLASH_AREA_0_OFFSET \
57                                            + FLASH_S_PARTITION_SIZE)
58 #else
59 #define NS_IMAGE_PRIMARY_PARTITION_OFFSET (FLASH_AREA_2_OFFSET \
60                                            + FLASH_S_PARTITION_SIZE)
61 #endif /* !LINK_TO_SECONDARY_PARTITION */
62 
63 /* Boot partition structure if MCUBoot is used:
64  * 0x0_0000 Bootloader header
65  * 0x0_0400 Image area
66  * 0x7_0000 Trailer
67  */
68 /* IMAGE_CODE_SIZE is the space available for the software binary image.
69  * It is less than the FLASH_S_PARTITION_SIZE + FLASH_NS_PARTITION_SIZE
70  * because we reserve space for the image header and trailer introduced
71  * by the bootloader.
72  */
73 
74 #if (!defined(MCUBOOT_IMAGE_NUMBER) || (MCUBOOT_IMAGE_NUMBER == 1)) && \
75     (NS_IMAGE_PRIMARY_PARTITION_OFFSET > S_IMAGE_PRIMARY_PARTITION_OFFSET)
76 /* If secure image and nonsecure image are concatenated, and nonsecure image
77  * locates at the higher memory range, then the secure image does not need
78  * the trailer area.
79  */
80 #define IMAGE_S_CODE_SIZE \
81             (FLASH_S_PARTITION_SIZE - BL2_HEADER_SIZE)
82 #else
83 #define IMAGE_S_CODE_SIZE \
84             (FLASH_S_PARTITION_SIZE - BL2_HEADER_SIZE - BL2_TRAILER_SIZE)
85 #endif
86 
87 #define IMAGE_NS_CODE_SIZE \
88             (FLASH_NS_PARTITION_SIZE - BL2_HEADER_SIZE - BL2_TRAILER_SIZE)
89 
90 /* Alias definitions for secure and non-secure areas*/
91 #define S_ROM_ALIAS(x)  (S_ROM_ALIAS_BASE + (x))
92 #define NS_ROM_ALIAS(x) (NS_ROM_ALIAS_BASE + (x))
93 
94 #define S_RAM_ALIAS(x)  (S_RAM_ALIAS_BASE + (x))
95 #define NS_RAM_ALIAS(x) (NS_RAM_ALIAS_BASE + (x))
96 
97 /* Secure regions */
98 #define S_IMAGE_PRIMARY_AREA_OFFSET \
99              (S_IMAGE_PRIMARY_PARTITION_OFFSET + BL2_HEADER_SIZE)
100 #define S_CODE_START    (S_ROM_ALIAS(S_IMAGE_PRIMARY_AREA_OFFSET))
101 #define S_CODE_SIZE     (IMAGE_S_CODE_SIZE)
102 #define S_CODE_LIMIT    (S_CODE_START + S_CODE_SIZE - 1)
103 
104 /* Size of vector table: 139 interrupt handlers + 4 bytes MPS initial value */
105 #define S_CODE_VECTOR_TABLE_SIZE    (0x230)
106 
107 #define S_DATA_START    (S_RAM_ALIAS(0x0))
108 #define S_DATA_SIZE     (TOTAL_RAM_SIZE / 2)
109 #define S_DATA_LIMIT    (S_DATA_START + S_DATA_SIZE - 1)
110 
111 /* Non-secure regions */
112 #define NS_IMAGE_PRIMARY_AREA_OFFSET \
113                         (NS_IMAGE_PRIMARY_PARTITION_OFFSET + BL2_HEADER_SIZE)
114 #define NS_CODE_START   (NS_ROM_ALIAS(NS_IMAGE_PRIMARY_AREA_OFFSET))
115 #define NS_CODE_SIZE    (IMAGE_NS_CODE_SIZE)
116 #define NS_CODE_LIMIT   (NS_CODE_START + NS_CODE_SIZE - 1)
117 
118 #define NS_DATA_START   (NS_RAM_ALIAS(TOTAL_RAM_SIZE / 2))
119 #if defined(PSA_API_TEST_NS) && !defined(PSA_API_TEST_IPC)
120 #define DEV_APIS_TEST_NVMEM_REGION_SIZE  0x400
121 #define NS_DATA_SIZE    (TOTAL_RAM_SIZE / 2 - DEV_APIS_TEST_NVMEM_REGION_SIZE)
122 #else
123 #define NS_DATA_SIZE    (TOTAL_RAM_SIZE / 2)
124 #endif
125 #define NS_DATA_LIMIT   (NS_DATA_START + NS_DATA_SIZE - 1)
126 
127 /* NS partition information is used for MPC and SAU configuration */
128 #define NS_PARTITION_START \
129             (NS_ROM_ALIAS(NS_IMAGE_PRIMARY_PARTITION_OFFSET))
130 #define NS_PARTITION_SIZE (FLASH_NS_PARTITION_SIZE)
131 
132 /* Secondary partition for new images in case of firmware upgrade */
133 #define SECONDARY_PARTITION_START \
134             (NS_ROM_ALIAS(S_IMAGE_SECONDARY_PARTITION_OFFSET))
135 #define SECONDARY_PARTITION_SIZE (FLASH_S_PARTITION_SIZE + \
136                                   FLASH_NS_PARTITION_SIZE)
137 
138 #ifdef BL2
139 /* Bootloader regions */
140 #define BL2_CODE_START    (S_ROM_ALIAS(FLASH_AREA_BL2_OFFSET))
141 #define BL2_CODE_SIZE     (FLASH_AREA_BL2_SIZE)
142 #define BL2_CODE_LIMIT    (BL2_CODE_START + BL2_CODE_SIZE - 1)
143 
144 #define BL2_DATA_START    (S_RAM_ALIAS(0x0))
145 #define BL2_DATA_SIZE     (TOTAL_RAM_SIZE)
146 #define BL2_DATA_LIMIT    (BL2_DATA_START + BL2_DATA_SIZE - 1)
147 #endif /* BL2 */
148 
149 
150 
151 /* Shared symbol area between bootloader and runtime firmware. Global variables
152  * in the shared code can be placed here.
153  */
154 #ifdef CODE_SHARING
155 #define SHARED_SYMBOL_AREA_BASE S_RAM_ALIAS_BASE
156 #define SHARED_SYMBOL_AREA_SIZE 0x20
157 #else
158 #define SHARED_SYMBOL_AREA_BASE S_RAM_ALIAS_BASE
159 #define SHARED_SYMBOL_AREA_SIZE 0x0
160 #endif /* CODE_SHARING */
161 
162 /* Shared data area between bootloader and runtime firmware.
163  * These areas are allocated at the beginning of the RAM, it is overlapping
164  * with TF-M Secure code's MSP stack
165  */
166 #define BOOT_TFM_SHARED_DATA_BASE (SHARED_SYMBOL_AREA_BASE + \
167                                    SHARED_SYMBOL_AREA_SIZE)
168 #define BOOT_TFM_SHARED_DATA_SIZE (0x400)
169 #define BOOT_TFM_SHARED_DATA_LIMIT (BOOT_TFM_SHARED_DATA_BASE + \
170                                     BOOT_TFM_SHARED_DATA_SIZE - 1)
171 
172 #endif /* __REGION_DEFS_H__ */
173