353 lines
11 KiB
C
353 lines
11 KiB
C
/*
|
|
* Copyright (c) 2015-2021, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
#ifndef PLAT_ARM_H
|
|
#define PLAT_ARM_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#include <drivers/arm/tzc_common.h>
|
|
#include <lib/bakery_lock.h>
|
|
#include <lib/cassert.h>
|
|
#include <lib/el3_runtime/cpu_data.h>
|
|
#include <lib/spinlock.h>
|
|
#include <lib/utils_def.h>
|
|
#include <lib/xlat_tables/xlat_tables_compat.h>
|
|
|
|
/*******************************************************************************
|
|
* Forward declarations
|
|
******************************************************************************/
|
|
struct meminfo;
|
|
struct image_info;
|
|
struct bl_params;
|
|
|
|
typedef struct arm_tzc_regions_info {
|
|
unsigned long long base;
|
|
unsigned long long end;
|
|
unsigned int sec_attr;
|
|
unsigned int nsaid_permissions;
|
|
} arm_tzc_regions_info_t;
|
|
|
|
/*******************************************************************************
|
|
* Default mapping definition of the TrustZone Controller for ARM standard
|
|
* platforms.
|
|
* Configure:
|
|
* - Region 0 with no access;
|
|
* - Region 1 with secure access only;
|
|
* - the remaining DRAM regions access from the given Non-Secure masters.
|
|
******************************************************************************/
|
|
#if SPM_MM
|
|
#define ARM_TZC_REGIONS_DEF \
|
|
{ARM_AP_TZC_DRAM1_BASE, ARM_EL3_TZC_DRAM1_END, \
|
|
TZC_REGION_S_RDWR, 0}, \
|
|
{ARM_NS_DRAM1_BASE, ARM_NS_DRAM1_END, ARM_TZC_NS_DRAM_S_ACCESS, \
|
|
PLAT_ARM_TZC_NS_DEV_ACCESS}, \
|
|
{ARM_DRAM2_BASE, ARM_DRAM2_END, ARM_TZC_NS_DRAM_S_ACCESS, \
|
|
PLAT_ARM_TZC_NS_DEV_ACCESS}, \
|
|
{PLAT_SP_IMAGE_NS_BUF_BASE, (PLAT_SP_IMAGE_NS_BUF_BASE + \
|
|
PLAT_SP_IMAGE_NS_BUF_SIZE) - 1, TZC_REGION_S_NONE, \
|
|
PLAT_ARM_TZC_NS_DEV_ACCESS}
|
|
|
|
#else
|
|
#define ARM_TZC_REGIONS_DEF \
|
|
{ARM_AP_TZC_DRAM1_BASE, ARM_EL3_TZC_DRAM1_END, \
|
|
TZC_REGION_S_RDWR, 0}, \
|
|
{ARM_NS_DRAM1_BASE, ARM_NS_DRAM1_END, ARM_TZC_NS_DRAM_S_ACCESS, \
|
|
PLAT_ARM_TZC_NS_DEV_ACCESS}, \
|
|
{ARM_DRAM2_BASE, ARM_DRAM2_END, ARM_TZC_NS_DRAM_S_ACCESS, \
|
|
PLAT_ARM_TZC_NS_DEV_ACCESS}
|
|
#endif
|
|
|
|
#define ARM_CASSERT_MMAP \
|
|
CASSERT((ARRAY_SIZE(plat_arm_mmap) - 1) <= PLAT_ARM_MMAP_ENTRIES, \
|
|
assert_plat_arm_mmap_mismatch); \
|
|
CASSERT((PLAT_ARM_MMAP_ENTRIES + ARM_BL_REGIONS) \
|
|
<= MAX_MMAP_REGIONS, \
|
|
assert_max_mmap_regions);
|
|
|
|
void arm_setup_romlib(void);
|
|
|
|
#if defined(IMAGE_BL31) || (!defined(__aarch64__) && defined(IMAGE_BL32))
|
|
/*
|
|
* Use this macro to instantiate lock before it is used in below
|
|
* arm_lock_xxx() macros
|
|
*/
|
|
#define ARM_INSTANTIATE_LOCK static DEFINE_BAKERY_LOCK(arm_lock)
|
|
#define ARM_LOCK_GET_INSTANCE (&arm_lock)
|
|
|
|
#if !HW_ASSISTED_COHERENCY
|
|
#define ARM_SCMI_INSTANTIATE_LOCK DEFINE_BAKERY_LOCK(arm_scmi_lock)
|
|
#else
|
|
#define ARM_SCMI_INSTANTIATE_LOCK spinlock_t arm_scmi_lock
|
|
#endif
|
|
#define ARM_SCMI_LOCK_GET_INSTANCE (&arm_scmi_lock)
|
|
|
|
/*
|
|
* These are wrapper macros to the Coherent Memory Bakery Lock API.
|
|
*/
|
|
#define arm_lock_init() bakery_lock_init(&arm_lock)
|
|
#define arm_lock_get() bakery_lock_get(&arm_lock)
|
|
#define arm_lock_release() bakery_lock_release(&arm_lock)
|
|
|
|
#else
|
|
|
|
/*
|
|
* Empty macros for all other BL stages other than BL31 and BL32
|
|
*/
|
|
#define ARM_INSTANTIATE_LOCK static int arm_lock __unused
|
|
#define ARM_LOCK_GET_INSTANCE 0
|
|
#define arm_lock_init()
|
|
#define arm_lock_get()
|
|
#define arm_lock_release()
|
|
|
|
#endif /* defined(IMAGE_BL31) || (!defined(__aarch64__) && defined(IMAGE_BL32)) */
|
|
|
|
#if ARM_RECOM_STATE_ID_ENC
|
|
/*
|
|
* Macros used to parse state information from State-ID if it is using the
|
|
* recommended encoding for State-ID.
|
|
*/
|
|
#define ARM_LOCAL_PSTATE_WIDTH 4
|
|
#define ARM_LOCAL_PSTATE_MASK ((1 << ARM_LOCAL_PSTATE_WIDTH) - 1)
|
|
|
|
/* Macros to construct the composite power state */
|
|
|
|
/* Make composite power state parameter till power level 0 */
|
|
#if PSCI_EXTENDED_STATE_ID
|
|
|
|
#define arm_make_pwrstate_lvl0(lvl0_state, pwr_lvl, type) \
|
|
(((lvl0_state) << PSTATE_ID_SHIFT) | ((type) << PSTATE_TYPE_SHIFT))
|
|
#else
|
|
#define arm_make_pwrstate_lvl0(lvl0_state, pwr_lvl, type) \
|
|
(((lvl0_state) << PSTATE_ID_SHIFT) | \
|
|
((pwr_lvl) << PSTATE_PWR_LVL_SHIFT) | \
|
|
((type) << PSTATE_TYPE_SHIFT))
|
|
#endif /* __PSCI_EXTENDED_STATE_ID__ */
|
|
|
|
/* Make composite power state parameter till power level 1 */
|
|
#define arm_make_pwrstate_lvl1(lvl1_state, lvl0_state, pwr_lvl, type) \
|
|
(((lvl1_state) << ARM_LOCAL_PSTATE_WIDTH) | \
|
|
arm_make_pwrstate_lvl0(lvl0_state, pwr_lvl, type))
|
|
|
|
/* Make composite power state parameter till power level 2 */
|
|
#define arm_make_pwrstate_lvl2(lvl2_state, lvl1_state, lvl0_state, pwr_lvl, type) \
|
|
(((lvl2_state) << (ARM_LOCAL_PSTATE_WIDTH * 2)) | \
|
|
arm_make_pwrstate_lvl1(lvl1_state, lvl0_state, pwr_lvl, type))
|
|
|
|
#endif /* __ARM_RECOM_STATE_ID_ENC__ */
|
|
|
|
/* ARM State switch error codes */
|
|
#define STATE_SW_E_PARAM (-2)
|
|
#define STATE_SW_E_DENIED (-3)
|
|
|
|
/* plat_get_rotpk_info() flags */
|
|
#define ARM_ROTPK_REGS_ID 1
|
|
#define ARM_ROTPK_DEVEL_RSA_ID 2
|
|
#define ARM_ROTPK_DEVEL_ECDSA_ID 3
|
|
|
|
|
|
/* IO storage utility functions */
|
|
int arm_io_setup(void);
|
|
|
|
/* Set image specification in IO block policy */
|
|
int arm_set_image_source(unsigned int image_id, const char *part_name,
|
|
uintptr_t *dev_handle, uintptr_t *image_spec);
|
|
void arm_set_fip_addr(uint32_t active_fw_bank_idx);
|
|
|
|
/* Security utility functions */
|
|
void arm_tzc400_setup(uintptr_t tzc_base,
|
|
const arm_tzc_regions_info_t *tzc_regions);
|
|
struct tzc_dmc500_driver_data;
|
|
void arm_tzc_dmc500_setup(struct tzc_dmc500_driver_data *plat_driver_data,
|
|
const arm_tzc_regions_info_t *tzc_regions);
|
|
|
|
/* Console utility functions */
|
|
void arm_console_boot_init(void);
|
|
void arm_console_boot_end(void);
|
|
void arm_console_runtime_init(void);
|
|
void arm_console_runtime_end(void);
|
|
|
|
/* Systimer utility function */
|
|
void arm_configure_sys_timer(void);
|
|
|
|
/* PM utility functions */
|
|
int arm_validate_power_state(unsigned int power_state,
|
|
psci_power_state_t *req_state);
|
|
int arm_validate_psci_entrypoint(uintptr_t entrypoint);
|
|
int arm_validate_ns_entrypoint(uintptr_t entrypoint);
|
|
void arm_system_pwr_domain_save(void);
|
|
void arm_system_pwr_domain_resume(void);
|
|
int arm_psci_read_mem_protect(int *enabled);
|
|
int arm_nor_psci_write_mem_protect(int val);
|
|
void arm_nor_psci_do_static_mem_protect(void);
|
|
void arm_nor_psci_do_dyn_mem_protect(void);
|
|
int arm_psci_mem_protect_chk(uintptr_t base, u_register_t length);
|
|
|
|
/* Topology utility function */
|
|
int arm_check_mpidr(u_register_t mpidr);
|
|
|
|
/* BL1 utility functions */
|
|
void arm_bl1_early_platform_setup(void);
|
|
void arm_bl1_platform_setup(void);
|
|
void arm_bl1_plat_arch_setup(void);
|
|
|
|
/* BL2 utility functions */
|
|
void arm_bl2_early_platform_setup(uintptr_t fw_config, struct meminfo *mem_layout);
|
|
void arm_bl2_platform_setup(void);
|
|
void arm_bl2_plat_arch_setup(void);
|
|
uint32_t arm_get_spsr_for_bl32_entry(void);
|
|
uint32_t arm_get_spsr_for_bl33_entry(void);
|
|
int arm_bl2_plat_handle_post_image_load(unsigned int image_id);
|
|
int arm_bl2_handle_post_image_load(unsigned int image_id);
|
|
struct bl_params *arm_get_next_bl_params(void);
|
|
|
|
/* BL2 at EL3 functions */
|
|
void arm_bl2_el3_early_platform_setup(void);
|
|
void arm_bl2_el3_plat_arch_setup(void);
|
|
|
|
/* BL2U utility functions */
|
|
void arm_bl2u_early_platform_setup(struct meminfo *mem_layout,
|
|
void *plat_info);
|
|
void arm_bl2u_platform_setup(void);
|
|
void arm_bl2u_plat_arch_setup(void);
|
|
|
|
/* BL31 utility functions */
|
|
void arm_bl31_early_platform_setup(void *from_bl2, uintptr_t soc_fw_config,
|
|
uintptr_t hw_config, void *plat_params_from_bl2);
|
|
void arm_bl31_platform_setup(void);
|
|
void arm_bl31_plat_runtime_setup(void);
|
|
void arm_bl31_plat_arch_setup(void);
|
|
|
|
/* TSP utility functions */
|
|
void arm_tsp_early_platform_setup(void);
|
|
|
|
/* SP_MIN utility functions */
|
|
void arm_sp_min_early_platform_setup(void *from_bl2, uintptr_t tos_fw_config,
|
|
uintptr_t hw_config, void *plat_params_from_bl2);
|
|
void arm_sp_min_plat_runtime_setup(void);
|
|
void arm_sp_min_plat_arch_setup(void);
|
|
|
|
/* FIP TOC validity check */
|
|
bool arm_io_is_toc_valid(void);
|
|
|
|
/* Utility functions for Dynamic Config */
|
|
void arm_bl2_dyn_cfg_init(void);
|
|
void arm_bl1_set_mbedtls_heap(void);
|
|
int arm_get_mbedtls_heap(void **heap_addr, size_t *heap_size);
|
|
|
|
#if MEASURED_BOOT
|
|
/* Measured boot related functions */
|
|
void arm_bl1_set_bl2_hash(const image_desc_t *image_desc);
|
|
void arm_bl2_get_hash(void *data);
|
|
int arm_set_tos_fw_info(uintptr_t config_base, uintptr_t log_addr,
|
|
size_t log_size);
|
|
int arm_set_nt_fw_info(uintptr_t config_base,
|
|
/*
|
|
* Currently OP-TEE does not support reading DTBs from Secure memory
|
|
* and this option should be removed when feature is supported.
|
|
*/
|
|
#ifdef SPD_opteed
|
|
uintptr_t log_addr,
|
|
#endif
|
|
size_t log_size, uintptr_t *ns_log_addr);
|
|
#endif /* MEASURED_BOOT */
|
|
|
|
/*
|
|
* Free the memory storing initialization code only used during an images boot
|
|
* time so it can be reclaimed for runtime data
|
|
*/
|
|
void arm_free_init_memory(void);
|
|
|
|
/*
|
|
* Make the higher level translation tables read-only
|
|
*/
|
|
void arm_xlat_make_tables_readonly(void);
|
|
|
|
/*
|
|
* Mandatory functions required in ARM standard platforms
|
|
*/
|
|
unsigned int plat_arm_get_cluster_core_count(u_register_t mpidr);
|
|
void plat_arm_gic_driver_init(void);
|
|
void plat_arm_gic_init(void);
|
|
void plat_arm_gic_cpuif_enable(void);
|
|
void plat_arm_gic_cpuif_disable(void);
|
|
void plat_arm_gic_redistif_on(void);
|
|
void plat_arm_gic_redistif_off(void);
|
|
void plat_arm_gic_pcpu_init(void);
|
|
void plat_arm_gic_save(void);
|
|
void plat_arm_gic_resume(void);
|
|
void plat_arm_security_setup(void);
|
|
void plat_arm_pwrc_setup(void);
|
|
void plat_arm_interconnect_init(void);
|
|
void plat_arm_interconnect_enter_coherency(void);
|
|
void plat_arm_interconnect_exit_coherency(void);
|
|
void plat_arm_program_trusted_mailbox(uintptr_t address);
|
|
bool plat_arm_bl1_fwu_needed(void);
|
|
__dead2 void plat_arm_error_handler(int err);
|
|
|
|
/*
|
|
* Optional functions in ARM standard platforms
|
|
*/
|
|
void plat_arm_override_gicr_frames(const uintptr_t *plat_gicr_frames);
|
|
int arm_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
|
|
unsigned int *flags);
|
|
int arm_get_rotpk_info_regs(void **key_ptr, unsigned int *key_len,
|
|
unsigned int *flags);
|
|
int arm_get_rotpk_info_cc(void **key_ptr, unsigned int *key_len,
|
|
unsigned int *flags);
|
|
int arm_get_rotpk_info_dev(void **key_ptr, unsigned int *key_len,
|
|
unsigned int *flags);
|
|
|
|
#if ARM_PLAT_MT
|
|
unsigned int plat_arm_get_cpu_pe_count(u_register_t mpidr);
|
|
#endif
|
|
|
|
/*
|
|
* This function is called after loading SCP_BL2 image and it is used to perform
|
|
* any platform-specific actions required to handle the SCP firmware.
|
|
*/
|
|
int plat_arm_bl2_handle_scp_bl2(struct image_info *scp_bl2_image_info);
|
|
|
|
/*
|
|
* Optional functions required in ARM standard platforms
|
|
*/
|
|
void plat_arm_io_setup(void);
|
|
int plat_arm_get_alt_image_source(
|
|
unsigned int image_id,
|
|
uintptr_t *dev_handle,
|
|
uintptr_t *image_spec);
|
|
unsigned int plat_arm_calc_core_pos(u_register_t mpidr);
|
|
const mmap_region_t *plat_arm_get_mmap(void);
|
|
|
|
/* Allow platform to override psci_pm_ops during runtime */
|
|
const plat_psci_ops_t *plat_arm_psci_override_pm_ops(plat_psci_ops_t *ops);
|
|
|
|
/* Execution state switch in ARM platforms */
|
|
int arm_execution_state_switch(unsigned int smc_fid,
|
|
uint32_t pc_hi,
|
|
uint32_t pc_lo,
|
|
uint32_t cookie_hi,
|
|
uint32_t cookie_lo,
|
|
void *handle);
|
|
|
|
/* Optional functions for SP_MIN */
|
|
void plat_arm_sp_min_early_platform_setup(u_register_t arg0, u_register_t arg1,
|
|
u_register_t arg2, u_register_t arg3);
|
|
|
|
/* global variables */
|
|
extern plat_psci_ops_t plat_arm_psci_pm_ops;
|
|
extern const mmap_region_t plat_arm_mmap[];
|
|
extern const unsigned int arm_pm_idle_states[];
|
|
|
|
/* secure watchdog */
|
|
void plat_arm_secure_wdt_start(void);
|
|
void plat_arm_secure_wdt_stop(void);
|
|
|
|
/* Get SOC-ID of ARM platform */
|
|
uint32_t plat_arm_get_soc_id(void);
|
|
|
|
#endif /* PLAT_ARM_H */
|