aboutsummaryrefslogtreecommitdiff log msg author committer range
path: root/platform/include/tfm_spm_hal.h
blob: 7aaafeba6b6428eee7d344c1d5f2d3cb5d172b50 (plain)
 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344  /* * Copyright (c) 2018-2021, Arm Limited. All rights reserved. * * SPDX-License-Identifier: BSD-3-Clause * */ #ifndef __TFM_SPM_HAL_H__ #define __TFM_SPM_HAL_H__ #include #include "fih.h" #include "tfm_secure_api.h" #ifdef TFM_MULTI_CORE_TOPOLOGY #include "tfm_multi_core.h" #endif #include "tfm_plat_defs.h" /** * \brief Holds peripheral specific data fields required to manage the * peripherals isolation * * This structure has to be defined in the platform directory, and may have * different definition for each platform. The structure should contain fields * that describe the peripheral for the functions that are prototyped in this * file and are responsible for configuring the isolation of the peripherals. * * Pointers to structures of this type are managed by the SPM, and passed to the * necessary function on isolation request. The pointers are also defined by the * platform in the header file tfm_peripherals_def.h. For details on this, see * the documentation of that file. */ struct platform_data_t; enum irq_target_state_t { TFM_IRQ_TARGET_STATE_SECURE, TFM_IRQ_TARGET_STATE_NON_SECURE, }; #ifdef TFM_PSA_API /** * \brief Holds SPM db fields that define the memory regions used by a * partition. */ struct tfm_spm_partition_memory_data_t { #if TFM_LVL == 3 uint32_t data_start; /* Start of the private data region of current * partition. Specifically, the private data * includes RW, ZI and the partition stack below. */ uint32_t data_limit; /* Address of the byte beyond the end of the data * region of this partition. */ #endif uint32_t stack_bottom; /* The bottom of the stack for the partition. */ uint32_t stack_top; /* The top of the stack for the partition. */ }; #endif #ifdef TFM_FIH_PROFILE_ON #ifdef CONFIG_TFM_ENABLE_MEMORY_PROTECT /** * \brief This function initialises the HW used for isolation, and sets the * default configuration for them. * This function is called during TF-M core early startup, after DB init * * \return Returns values as specified by FIH specific platform error code. */ fih_int tfm_spm_hal_setup_isolation_hw(void); #endif /* CONFIG_TFM_ENABLE_MEMORY_PROTECT */ /** * \brief Configure peripherals for a partition based on the platform data and * partition index from the DB * * This function is called during partition initialisation (before calling the * init function for the partition) * * \param[in] partition_idx The index of the partition that this peripheral * is assigned to. * \param[in] platform_data The platform fields of the partition DB record to * be used for configuration. * * \return Returns values as specified by FIH specific platform error code */ fih_int tfm_spm_hal_configure_default_isolation( uint32_t partition_idx, const struct platform_data_t *platform_data); /** * \brief Configures the system debug properties. * The default configuration of this function should disable secure debug * when either DAUTH_NONE or DAUTH_NS_ONLY define is set. It is up to the * platform owner to decide if secure debug can be turned on in their * system, if DAUTH_FULL define is present. * The DAUTH_CHIP_DEFAULT define should not be considered a safe default * option unless explicitly noted by the chip vendor. * The implementation has to expect that one of those defines is going to * be set. Otherwise, a compile error needs to be triggered. * * \return Returns values as specified by FIH specific platform error code */ fih_int tfm_spm_hal_init_debug(void); /** * \brief This function verifies the settings of HW used for memory isolation, * to make sure that important settings was not skipped due to fault * injection attacks. * * This function is called during TF-M core late startup, before passing * execution to non-secure code. * * \return Returns values as specified by FIH specific platform error code */ fih_int tfm_spm_hal_verify_isolation_hw(void); #else /* TFM_FIH_PROFILE_ON */ #ifdef CONFIG_TFM_ENABLE_MEMORY_PROTECT /** * \brief This function initialises the HW used for isolation, and sets the * default configuration for them. * This function is called during TF-M core early startup, after DB init * * \return Returns values as specified by the \ref tfm_plat_err_t */ enum tfm_plat_err_t tfm_spm_hal_setup_isolation_hw(void); #endif /* CONFIG_TFM_ENABLE_MEMORY_PROTECT */ /** * \brief Configure peripherals for a partition based on the platform data and * partition index from the DB * * This function is called during partition initialisation (before calling the * init function for the partition) * * \param[in] partition_idx The index of the partition that this peripheral * is assigned to. * \param[in] platform_data The platform fields of the partition DB record to * be used for configuration. * * \return Returns values as specified by the \ref tfm_plat_err_t */ enum tfm_plat_err_t tfm_spm_hal_configure_default_isolation( uint32_t partition_idx, const struct platform_data_t *platform_data); /** * \brief Configures the system debug properties. * The default configuration of this function should disable secure debug * when either DAUTH_NONE or DAUTH_NS_ONLY define is set. It is up to the * platform owner to decide if secure debug can be turned on in their * system, if DAUTH_FULL define is present. * The DAUTH_CHIP_DEFAULT define should not be considered a safe default * option unless explicitly noted by the chip vendor. * The implementation has to expect that one of those defines is going to * be set. Otherwise, a compile error needs to be triggered. * * \return Returns values as specified by the \ref tfm_plat_err_t */ enum tfm_plat_err_t tfm_spm_hal_init_debug(void); #endif /* TFM_FIH_PROFILE_ON */ /** * \brief Enables the fault handlers and sets priorities. * * Secure fault (if present) must have the highest possible priority * * \return Returns values as specified by the \ref tfm_plat_err_t */ enum tfm_plat_err_t tfm_spm_hal_enable_fault_handlers(void); /** * \brief Configures the system reset request properties * * \return Returns values as specified by the \ref tfm_plat_err_t */ enum tfm_plat_err_t tfm_spm_hal_system_reset_cfg(void); /** * \brief Configures all external interrupts to target the * NS state, apart for the ones associated to secure * peripherals (plus MPC and PPC) * * \return Returns values as specified by the \ref tfm_plat_err_t */ enum tfm_plat_err_t tfm_spm_hal_nvic_interrupt_target_state_cfg(void); /** * \brief This function enable the interrupts associated * to the secure peripherals (plus the isolation boundary violation * interrupts) * * \return Returns values as specified by the \ref tfm_plat_err_t */ enum tfm_plat_err_t tfm_spm_hal_nvic_interrupt_enable(void); /** * \brief Get the VTOR value of non-secure image * * \return Returns the address where the vector table of the non-secure image * is located */ uint32_t tfm_spm_hal_get_ns_VTOR(void); /** * \brief Get the initial address of non-secure image main stack * * \return Returns the initial non-secure MSP */ uint32_t tfm_spm_hal_get_ns_MSP(void); /** * \brief Get the entry point of the non-secure image * * \return Returns the address of the non-secure image entry point */ uint32_t tfm_spm_hal_get_ns_entry_point(void); /** * \brief Set the priority of a secure IRQ * * \param[in] irq_line The IRQ to set the priority for. Might be less than 0 * \param[in] priority The priority to set. [0..255] * * \details This function sets the priority for the IRQ passed in the parameter. * The precision of the priority value might be adjusted to match the * available priority bits in the underlying target platform. * * \return Returns values as specified by the \ref tfm_plat_err_t */ enum tfm_plat_err_t tfm_spm_hal_set_secure_irq_priority(IRQn_Type irq_line, uint32_t priority); /** * \brief Clears a pending IRQ * * \param[in] irq_line The IRQ to clear pending for. */ void tfm_spm_hal_clear_pending_irq(IRQn_Type irq_line); /** * \brief Enables an IRQ * * \param[in] irq_line The IRQ to be enabled. */ void tfm_spm_hal_enable_irq(IRQn_Type irq_line); /** * \brief Disables an IRQ * * \param[in] irq_line The IRQ to be disabled */ void tfm_spm_hal_disable_irq(IRQn_Type irq_line); /** * \brief Set the target state of an IRQ * * \param[in] irq_line The IRQ to set the priority for. * \param[in] target_state Target state to ret for the IRQ. * * \return TFM_IRQ_TARGET_STATE_SECURE if interrupt is assigned * to Secure * TFM_IRQ_TARGET_STATE_NON_SECURE if interrupt is * assigned to Non-Secure */ enum irq_target_state_t tfm_spm_hal_set_irq_target_state( IRQn_Type irq_line, enum irq_target_state_t target_state); #ifdef TFM_MULTI_CORE_TOPOLOGY /** * \brief Performs the necessary actions to start the non-secure CPU running * the code at the specified address. * * \param[in] start_addr The entry point address of non-secure code. */ void tfm_spm_hal_boot_ns_cpu(uintptr_t start_addr); /** * \brief Called on the secure CPU. * Flags that the secure CPU has completed its initialization * Waits, if necessary, for the non-secure CPU to flag that * it has completed its initialisation */ void tfm_spm_hal_wait_for_ns_cpu_ready(void); /** * \brief Retrieve the current active security configuration information and * fills the \ref security_attr_info_t. * * \param[in] p Base address of target memory region * \param[in] s Size of target memory region * \param[out] p_attr Address of \ref security_attr_info_t to be filled * * \return void */ void tfm_spm_hal_get_mem_security_attr(const void *p, size_t s, struct security_attr_info_t *p_attr); /** * \brief Retrieve the secure memory protection configuration information and * fills the \ref mem_attr_info_t. * * \param[in] p Base address of target memory region * \param[in] s Size of target memory region * \param[out] p_attr Address of \ref mem_attr_info_t to be filled * * \return void */ void tfm_spm_hal_get_secure_access_attr(const void *p, size_t s, struct mem_attr_info_t *p_attr); /** * \brief Retrieve the non-secure memory protection configuration information * and fills the \ref mem_attr_info_t. * * \param[in] p Base address of target memory region * \param[in] s Size of target memory region * \param[out] p_attr Address of \ref mem_attr_info_t to be filled * * \return void */ void tfm_spm_hal_get_ns_access_attr(const void *p, size_t s, struct mem_attr_info_t *p_attr); #endif /*TFM_MULTI_CORE_TOPOLOGY*/ #if !defined(__SAUREGION_PRESENT) || (__SAUREGION_PRESENT == 0) /** * \brief Platform-specific check whether the current partition has access to a memory range * * The function checks whether the current partition has access to a memory range, * taking into consideration the implementation-defined attribution unit that is * present on a particular platform. * * \param[in] p The start address of the range to check * \param[in] s The size of the range to check * \param[in] flags The flags to pass to the cmse_check_address_range func * * \return True if the access is granted, false otherwise. */ bool tfm_spm_hal_has_access_to_region(const void *p, size_t s, int flags); #endif /* !defined(__SAUREGION_PRESENT) || (__SAUREGION_PRESENT == 0) */ #endif /* __TFM_SPM_HAL_H__ */