1 /*
2  * Copyright (c) 2019-2023 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           (0x0001000)
23 #define BL2_MSP_STACK_SIZE      (0x0001800)
24 
25 #ifdef ENABLE_HEAP
26     #define S_HEAP_SIZE             (0x0000200)
27 #endif
28 
29 #define S_MSP_STACK_SIZE        (0x0000800)
30 #define S_PSP_STACK_SIZE        (0x0000800)
31 
32 #define NS_HEAP_SIZE            (0x0001000)
33 #define NS_STACK_SIZE           (0x00001E0)
34 
35 /* This configuration uses QSPI for code memory and ISRAM0-3 as data
36  * memory.
37  */
38 
39 #ifdef BL2
40 #ifndef LINK_TO_SECONDARY_PARTITION
41 #define S_IMAGE_PRIMARY_PARTITION_OFFSET   (FLASH_AREA_0_OFFSET)
42 #define S_IMAGE_SECONDARY_PARTITION_OFFSET (FLASH_AREA_2_OFFSET)
43 #else
44 #define S_IMAGE_PRIMARY_PARTITION_OFFSET   (FLASH_AREA_2_OFFSET)
45 #define S_IMAGE_SECONDARY_PARTITION_OFFSET (FLASH_AREA_0_OFFSET)
46 #endif /* !LINK_TO_SECONDARY_PARTITION */
47 #else
48 #define S_IMAGE_PRIMARY_PARTITION_OFFSET   (0x0)
49 #endif /* BL2 */
50 
51 #ifndef LINK_TO_SECONDARY_PARTITION
52 #define NS_IMAGE_PRIMARY_PARTITION_OFFSET (FLASH_AREA_0_OFFSET \
53                                            + FLASH_S_PARTITION_SIZE)
54 #else
55 #define NS_IMAGE_PRIMARY_PARTITION_OFFSET (FLASH_AREA_2_OFFSET \
56                                            + FLASH_S_PARTITION_SIZE)
57 #endif /* !LINK_TO_SECONDARY_PARTITION */
58 
59 #if (!defined(MCUBOOT_IMAGE_NUMBER) || (MCUBOOT_IMAGE_NUMBER == 1)) && \
60     (NS_IMAGE_PRIMARY_PARTITION_OFFSET > S_IMAGE_PRIMARY_PARTITION_OFFSET)
61 /* If secure image and nonsecure image are concatenated, and nonsecure image
62  * locates at the higher memory range, then the secure image does not need
63  * the trailer area.
64  */
65 #define IMAGE_S_CODE_SIZE \
66             (FLASH_S_PARTITION_SIZE - BL2_HEADER_SIZE)
67 #else
68 #define IMAGE_S_CODE_SIZE \
69             (FLASH_S_PARTITION_SIZE - BL2_HEADER_SIZE - BL2_TRAILER_SIZE)
70 #endif
71 
72 #define IMAGE_NS_CODE_SIZE \
73             (FLASH_NS_PARTITION_SIZE - BL2_HEADER_SIZE - BL2_TRAILER_SIZE)
74 
75 /* Alias definitions for secure and non-secure areas*/
76 #define S_ROM_ALIAS(x)  (S_ROM_ALIAS_BASE + (x))
77 #define NS_ROM_ALIAS(x) (NS_ROM_ALIAS_BASE + (x))
78 
79 #define S_RAM_ALIAS(x)  (S_RAM_ALIAS_BASE + (x))
80 #define NS_RAM_ALIAS(x) (NS_RAM_ALIAS_BASE + (x))
81 
82 /* Secure regions */
83 #define S_IMAGE_PRIMARY_AREA_OFFSET \
84              (S_IMAGE_PRIMARY_PARTITION_OFFSET + BL2_HEADER_SIZE)
85 #define S_CODE_START    (S_ROM_ALIAS(S_IMAGE_PRIMARY_AREA_OFFSET))
86 #define S_CODE_SIZE     (IMAGE_S_CODE_SIZE)
87 #define S_CODE_LIMIT    (S_CODE_START + S_CODE_SIZE - 1)
88 
89 /* ISRAM0 and ISRAM1 are assigned to Secure data */
90 #define S_DATA_START    (S_RAM_ALIAS(0x0))
91 #define S_DATA_SIZE     (TOTAL_RAM_SIZE / 2 + (TOTAL_RAM_SIZE / 4))
92 #define S_DATA_LIMIT    (S_DATA_START + S_DATA_SIZE - 1)
93 
94 /* Size of vector table: 143 interrupt handlers + 4 bytes MPS initial value */
95 #define S_CODE_VECTOR_TABLE_SIZE    (0x240)
96 
97 /* Non-secure regions */
98 #define NS_IMAGE_PRIMARY_AREA_OFFSET \
99                         (NS_IMAGE_PRIMARY_PARTITION_OFFSET + BL2_HEADER_SIZE)
100 #define NS_CODE_START   (NS_ROM_ALIAS(NS_IMAGE_PRIMARY_AREA_OFFSET))
101 #define NS_CODE_SIZE    (IMAGE_NS_CODE_SIZE)
102 #define NS_CODE_LIMIT   (NS_CODE_START + NS_CODE_SIZE - 1)
103 
104 /* ISRAM2 and ISRAM3 are assigned to Secure data */
105 #define NS_DATA_START   (NS_RAM_ALIAS(S_DATA_SIZE))
106 #define NS_DATA_SIZE    (TOTAL_RAM_SIZE - S_DATA_SIZE)
107 #define NS_DATA_LIMIT   (NS_DATA_START + NS_DATA_SIZE - 1)
108 
109 /* NS partition information is used for MPC and SAU configuration */
110 #define NS_PARTITION_START \
111             (NS_ROM_ALIAS(NS_IMAGE_PRIMARY_PARTITION_OFFSET))
112 #define NS_PARTITION_SIZE  (FLASH_NS_PARTITION_SIZE)
113 
114 #ifdef BL2
115 #define SECONDARY_PARTITION_START  \
116                    (NS_ROM_ALIAS(S_IMAGE_SECONDARY_PARTITION_OFFSET))
117 #define SECONDARY_PARTITION_SIZE   (FLASH_S_PARTITION_SIZE + \
118                                     FLASH_NS_PARTITION_SIZE)
119 #define SECONDARY_PARTITION_LIMIT  (SECONDARY_PARTITION_START + \
120                                     SECONDARY_PARTITION_SIZE - 1)
121 
122 #define BL2_ROM_ALIAS_BASE         (0x0)
123 #define BL2_ROM_ALIAS(x)           (BL2_ROM_ALIAS_BASE + (x))
124 
125 /* Bootloader regions */
126 #define BL2_CODE_START    (BL2_ROM_ALIAS(FLASH_AREA_BL2_OFFSET))
127 #define BL2_CODE_SIZE     (FLASH_AREA_BL2_SIZE)
128 #define BL2_CODE_LIMIT    (BL2_CODE_START + BL2_CODE_SIZE - 1)
129 
130 #define BL2_DATA_START    (S_RAM_ALIAS(0x0))
131 #define BL2_DATA_SIZE     (TOTAL_RAM_SIZE / 4)
132 #define BL2_DATA_LIMIT    (BL2_DATA_START + BL2_DATA_SIZE - 1)
133 #endif /* BL2 */
134 
135 /* Shared data area between bootloader and runtime firmware.
136  * Shared data area is allocated at the beginning of the RAM, it is overlapping
137  * with TF-M Secure code's MSP stack
138  */
139 #define BOOT_TFM_SHARED_DATA_BASE S_RAM_ALIAS_BASE
140 #define BOOT_TFM_SHARED_DATA_SIZE (0x400)
141 #define BOOT_TFM_SHARED_DATA_LIMIT (BOOT_TFM_SHARED_DATA_BASE + \
142                                     BOOT_TFM_SHARED_DATA_SIZE - 1)
143 
144 #define PROVISIONING_BUNDLE_CODE_START (BL2_DATA_START + BL2_DATA_SIZE)
145 #define PROVISIONING_BUNDLE_CODE_SIZE  (PROVISIONING_CODE_PADDED_SIZE)
146 /* The max size of the values(keys, seeds) that are going to be provisioned
147  * into the OTP. */
148 #define PROVISIONING_BUNDLE_VALUES_START (PROVISIONING_BUNDLE_CODE_START + PROVISIONING_BUNDLE_CODE_SIZE)
149 #define PROVISIONING_BUNDLE_VALUES_SIZE (PROVISIONING_VALUES_PADDED_SIZE)
150 #define PROVISIONING_BUNDLE_DATA_START (PROVISIONING_BUNDLE_VALUES_START + \
151                                         PROVISIONING_BUNDLE_VALUES_SIZE)
152 #define PROVISIONING_BUNDLE_DATA_SIZE (PROVISIONING_DATA_PADDED_SIZE)
153 
154 #define PROVISIONING_BUNDLE_START (FLASH_OTP_NV_COUNTERS_AREA_OFFSET + FLASH_OTP_NV_COUNTERS_AREA_SIZE)
155 
156 #endif /* __REGION_DEFS_H__ */
157