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 /* This size of buffer is big enough to store an attestation
40  * token produced by initial attestation service
41  */
42 #define PSA_INITIAL_ATTEST_TOKEN_MAX_SIZE   (0x250)
43 
44 /* MPC granularity is 128 KB on AN521 Castor MPS2 FPGA image. Alignment
45  * of partitions is defined in accordance with this constraint.
46  */
47 
48 #ifdef BL2
49 #ifndef LINK_TO_SECONDARY_PARTITION
50 #define S_IMAGE_PRIMARY_PARTITION_OFFSET   (FLASH_AREA_0_OFFSET)
51 #define S_IMAGE_SECONDARY_PARTITION_OFFSET (FLASH_AREA_2_OFFSET)
52 #else
53 #define S_IMAGE_PRIMARY_PARTITION_OFFSET   (FLASH_AREA_2_OFFSET)
54 #define S_IMAGE_SECONDARY_PARTITION_OFFSET (FLASH_AREA_0_OFFSET)
55 #endif /* !LINK_TO_SECONDARY_PARTITION */
56 #else
57 #define S_IMAGE_PRIMARY_PARTITION_OFFSET (0x0)
58 #endif /* BL2 */
59 
60 #ifndef LINK_TO_SECONDARY_PARTITION
61 #define NS_IMAGE_PRIMARY_PARTITION_OFFSET (FLASH_AREA_0_OFFSET \
62                                            + FLASH_S_PARTITION_SIZE)
63 #else
64 #define NS_IMAGE_PRIMARY_PARTITION_OFFSET (FLASH_AREA_2_OFFSET \
65                                            + FLASH_S_PARTITION_SIZE)
66 #endif /* !LINK_TO_SECONDARY_PARTITION */
67 
68 /* Boot partition structure if MCUBoot is used:
69  * 0x0_0000 Bootloader header
70  * 0x0_0400 Image area
71  * 0x7_0000 Trailer
72  */
73 /* IMAGE_CODE_SIZE is the space available for the software binary image.
74  * It is less than the FLASH_S_PARTITION_SIZE + FLASH_NS_PARTITION_SIZE
75  * because we reserve space for the image header and trailer introduced
76  * by the bootloader.
77  */
78 
79 #if (!defined(MCUBOOT_IMAGE_NUMBER) || (MCUBOOT_IMAGE_NUMBER == 1)) && \
80     (NS_IMAGE_PRIMARY_PARTITION_OFFSET > S_IMAGE_PRIMARY_PARTITION_OFFSET)
81 /* If secure image and nonsecure image are concatenated, and nonsecure image
82  * locates at the higher memory range, then the secure image does not need
83  * the trailer area.
84  */
85 #define IMAGE_S_CODE_SIZE \
86             (FLASH_S_PARTITION_SIZE - BL2_HEADER_SIZE)
87 #else
88 #define IMAGE_S_CODE_SIZE \
89             (FLASH_S_PARTITION_SIZE - BL2_HEADER_SIZE - BL2_TRAILER_SIZE)
90 #endif
91 
92 #define IMAGE_NS_CODE_SIZE \
93             (FLASH_NS_PARTITION_SIZE - BL2_HEADER_SIZE - BL2_TRAILER_SIZE)
94 
95 /* Alias definitions for secure and non-secure areas*/
96 #define S_ROM_ALIAS(x)  (S_ROM_ALIAS_BASE + (x))
97 #define NS_ROM_ALIAS(x) (NS_ROM_ALIAS_BASE + (x))
98 
99 #define S_RAM_ALIAS(x)  (S_RAM_ALIAS_BASE + (x))
100 #define NS_RAM_ALIAS(x) (NS_RAM_ALIAS_BASE + (x))
101 
102 /* Secure regions */
103 #define S_IMAGE_PRIMARY_AREA_OFFSET \
104              (S_IMAGE_PRIMARY_PARTITION_OFFSET + BL2_HEADER_SIZE)
105 #define S_CODE_START    (S_ROM_ALIAS(S_IMAGE_PRIMARY_AREA_OFFSET))
106 #define S_CODE_SIZE     (IMAGE_S_CODE_SIZE)
107 #define S_CODE_LIMIT    (S_CODE_START + S_CODE_SIZE - 1)
108 
109 /* Size of vector table: 139 interrupt handlers + 4 bytes MPS initial value */
110 #define S_CODE_VECTOR_TABLE_SIZE    (0x230)
111 
112 #define S_DATA_START    (S_RAM_ALIAS(0x0))
113 #define S_DATA_SIZE     (TOTAL_RAM_SIZE / 2)
114 #define S_DATA_LIMIT    (S_DATA_START + S_DATA_SIZE - 1)
115 
116 /* Non-secure regions */
117 #define NS_IMAGE_PRIMARY_AREA_OFFSET \
118                         (NS_IMAGE_PRIMARY_PARTITION_OFFSET + BL2_HEADER_SIZE)
119 #define NS_CODE_START   (NS_ROM_ALIAS(NS_IMAGE_PRIMARY_AREA_OFFSET))
120 #define NS_CODE_SIZE    (IMAGE_NS_CODE_SIZE)
121 #define NS_CODE_LIMIT   (NS_CODE_START + NS_CODE_SIZE - 1)
122 
123 #define NS_DATA_START   (NS_RAM_ALIAS(TOTAL_RAM_SIZE / 2))
124 #if defined(PSA_API_TEST_NS) && !defined(PSA_API_TEST_IPC)
125 #define DEV_APIS_TEST_NVMEM_REGION_SIZE  0x400
126 #define NS_DATA_SIZE    (TOTAL_RAM_SIZE / 2 - DEV_APIS_TEST_NVMEM_REGION_SIZE)
127 #else
128 #define NS_DATA_SIZE    (TOTAL_RAM_SIZE / 2)
129 #endif
130 #define NS_DATA_LIMIT   (NS_DATA_START + NS_DATA_SIZE - 1)
131 
132 /* NS partition information is used for MPC and SAU configuration */
133 #define NS_PARTITION_START \
134             (NS_ROM_ALIAS(NS_IMAGE_PRIMARY_PARTITION_OFFSET))
135 #define NS_PARTITION_SIZE (FLASH_NS_PARTITION_SIZE)
136 
137 /* Secondary partition for new images in case of firmware upgrade */
138 #define SECONDARY_PARTITION_START \
139             (NS_ROM_ALIAS(S_IMAGE_SECONDARY_PARTITION_OFFSET))
140 #define SECONDARY_PARTITION_SIZE (FLASH_S_PARTITION_SIZE + \
141                                   FLASH_NS_PARTITION_SIZE)
142 
143 #ifdef BL2
144 /* Bootloader regions */
145 #define BL2_CODE_START    (S_ROM_ALIAS(FLASH_AREA_BL2_OFFSET))
146 #define BL2_CODE_SIZE     (FLASH_AREA_BL2_SIZE)
147 #define BL2_CODE_LIMIT    (BL2_CODE_START + BL2_CODE_SIZE - 1)
148 
149 #define BL2_DATA_START    (S_RAM_ALIAS(0x0))
150 #define BL2_DATA_SIZE     (TOTAL_RAM_SIZE)
151 #define BL2_DATA_LIMIT    (BL2_DATA_START + BL2_DATA_SIZE - 1)
152 #endif /* BL2 */
153 
154 
155 
156 /* Shared symbol area between bootloader and runtime firmware. Global variables
157  * in the shared code can be placed here.
158  */
159 #ifdef CODE_SHARING
160 #define SHARED_SYMBOL_AREA_BASE S_RAM_ALIAS_BASE
161 #define SHARED_SYMBOL_AREA_SIZE 0x20
162 #else
163 #define SHARED_SYMBOL_AREA_BASE S_RAM_ALIAS_BASE
164 #define SHARED_SYMBOL_AREA_SIZE 0x0
165 #endif /* CODE_SHARING */
166 
167 /* Shared data area between bootloader and runtime firmware.
168  * These areas are allocated at the beginning of the RAM, it is overlapping
169  * with TF-M Secure code's MSP stack
170  */
171 #define BOOT_TFM_SHARED_DATA_BASE (SHARED_SYMBOL_AREA_BASE + \
172                                    SHARED_SYMBOL_AREA_SIZE)
173 #define BOOT_TFM_SHARED_DATA_SIZE (0x400)
174 #define BOOT_TFM_SHARED_DATA_LIMIT (BOOT_TFM_SHARED_DATA_BASE + \
175                                     BOOT_TFM_SHARED_DATA_SIZE - 1)
176 
177 #endif /* __REGION_DEFS_H__ */
178