| /* | |
| * Copyright (c) 2013-2019, ARM Limited and Contributors. All rights reserved. | |
| * | |
| * SPDX-License-Identifier: BSD-3-Clause | |
| */ | |
| #ifndef BL_COMMON_H | |
| #define BL_COMMON_H | |
| #include <common/ep_info.h> | |
| #include <common/param_header.h> | |
| #include <lib/utils_def.h> | |
| #ifndef __ASSEMBLER__ | |
| #include <stddef.h> | |
| #include <stdint.h> | |
| #include <lib/cassert.h> | |
| #endif /* __ASSEMBLER__ */ | |
| #include <export/common/bl_common_exp.h> | |
| #define UP U(1) | |
| #define DOWN U(0) | |
| /******************************************************************************* | |
| * Constants to identify the location of a memory region in a given memory | |
| * layout. | |
| ******************************************************************************/ | |
| #define TOP U(0x1) | |
| #define BOTTOM U(0x0) | |
| /******************************************************************************* | |
| * Constants to indicate type of exception to the common exception handler. | |
| ******************************************************************************/ | |
| #define SYNC_EXCEPTION_SP_EL0 U(0x0) | |
| #define IRQ_SP_EL0 U(0x1) | |
| #define FIQ_SP_EL0 U(0x2) | |
| #define SERROR_SP_EL0 U(0x3) | |
| #define SYNC_EXCEPTION_SP_ELX U(0x4) | |
| #define IRQ_SP_ELX U(0x5) | |
| #define FIQ_SP_ELX U(0x6) | |
| #define SERROR_SP_ELX U(0x7) | |
| #define SYNC_EXCEPTION_AARCH64 U(0x8) | |
| #define IRQ_AARCH64 U(0x9) | |
| #define FIQ_AARCH64 U(0xa) | |
| #define SERROR_AARCH64 U(0xb) | |
| #define SYNC_EXCEPTION_AARCH32 U(0xc) | |
| #define IRQ_AARCH32 U(0xd) | |
| #define FIQ_AARCH32 U(0xe) | |
| #define SERROR_AARCH32 U(0xf) | |
| /* | |
| * Mapping to connect linker symbols from .ld.S with their counterparts | |
| * from .scat for the BL31 image | |
| */ | |
| #if defined(USE_ARM_LINK) | |
| #define __BL31_END__ Load$$LR$$LR_END$$Base | |
| #define __BSS_START__ Load$$LR$$LR_BSS$$Base | |
| #define __BSS_END__ Load$$LR$$LR_BSS$$Limit | |
| #define __BSS_SIZE__ Load$$LR$$LR_BSS$$Length | |
| #define __COHERENT_RAM_START__ Load$$LR$$LR_COHERENT_RAM$$Base | |
| #define __COHERENT_RAM_END_UNALIGNED__ Load$$__COHERENT_RAM_EPILOGUE_UNALIGNED__$$Base | |
| #define __COHERENT_RAM_END__ Load$$LR$$LR_COHERENT_RAM$$Limit | |
| #define __COHERENT_RAM_UNALIGNED_SIZE__ Load$$__COHERENT_RAM__$$Length | |
| #define __CPU_OPS_START__ Load$$__CPU_OPS__$$Base | |
| #define __CPU_OPS_END__ Load$$__CPU_OPS__$$Limit | |
| #define __DATA_START__ Load$$__DATA__$$Base | |
| #define __DATA_END__ Load$$__DATA__$$Limit | |
| #define __GOT_START__ Load$$__GOT__$$Base | |
| #define __GOT_END__ Load$$__GOT__$$Limit | |
| #define __PERCPU_BAKERY_LOCK_START__ Load$$__BAKERY_LOCKS__$$Base | |
| #define __PERCPU_BAKERY_LOCK_END__ Load$$__BAKERY_LOCKS_EPILOGUE__$$Base | |
| #define __PMF_SVC_DESCS_START__ Load$$__PMF_SVC_DESCS__$$Base | |
| #define __PMF_SVC_DESCS_END__ Load$$__PMF_SVC_DESCS__$$Limit | |
| #define __PMF_TIMESTAMP_START__ Load$$__PMF_TIMESTAMP__$$Base | |
| #define __PMF_TIMESTAMP_END__ Load$$__PER_CPU_TIMESTAMPS__$$Limit | |
| #define __PMF_PERCPU_TIMESTAMP_END__ Load$$__PMF_TIMESTAMP_EPILOGUE__$$Base | |
| #define __RELA_END__ Load$$__RELA__$$Limit | |
| #define __RELA_START__ Load$$__RELA__$$Base | |
| #define __RODATA_START__ Load$$__RODATA__$$Base | |
| #define __RODATA_END__ Load$$__RODATA_EPILOGUE__$$Base | |
| #define __RT_SVC_DESCS_START__ Load$$__RT_SVC_DESCS__$$Base | |
| #define __RT_SVC_DESCS_END__ Load$$__RT_SVC_DESCS__$$Limit | |
| #define __RW_START__ Load$$LR$$LR_RW_DATA$$Base | |
| #define __RW_END__ Load$$LR$$LR_END$$Base | |
| #define __SPM_SHIM_EXCEPTIONS_START__ Load$$__SPM_SHIM_EXCEPTIONS__$$Base | |
| #define __SPM_SHIM_EXCEPTIONS_END__ Load$$__SPM_SHIM_EXCEPTIONS_EPILOGUE__$$Base | |
| #define __STACKS_START__ Load$$__STACKS__$$Base | |
| #define __STACKS_END__ Load$$__STACKS__$$Limit | |
| #define __TEXT_START__ Load$$__TEXT__$$Base | |
| #define __TEXT_END__ Load$$__TEXT_EPILOGUE__$$Base | |
| #endif /* USE_ARM_LINK */ | |
| #ifndef __ASSEMBLER__ | |
| /* | |
| * Declarations of linker defined symbols to help determine memory layout of | |
| * BL images | |
| */ | |
| #if SEPARATE_CODE_AND_RODATA | |
| IMPORT_SYM(uintptr_t, __TEXT_START__, BL_CODE_BASE); | |
| IMPORT_SYM(uintptr_t, __TEXT_END__, BL_CODE_END); | |
| IMPORT_SYM(uintptr_t, __RODATA_START__, BL_RO_DATA_BASE); | |
| IMPORT_SYM(uintptr_t, __RODATA_END__, BL_RO_DATA_END); | |
| #else | |
| IMPORT_SYM(uintptr_t, __RO_START__, BL_CODE_BASE); | |
| IMPORT_SYM(uintptr_t, __RO_END__, BL_CODE_END); | |
| #endif | |
| #if defined(IMAGE_BL1) | |
| IMPORT_SYM(uintptr_t, __BL1_ROM_END__, BL1_ROM_END); | |
| IMPORT_SYM(uintptr_t, __BL1_RAM_START__, BL1_RAM_BASE); | |
| IMPORT_SYM(uintptr_t, __BL1_RAM_END__, BL1_RAM_LIMIT); | |
| #elif defined(IMAGE_BL2) | |
| IMPORT_SYM(uintptr_t, __BL2_END__, BL2_END); | |
| #elif defined(IMAGE_BL2U) | |
| IMPORT_SYM(uintptr_t, __BL2U_END__, BL2U_END); | |
| #elif defined(IMAGE_BL31) | |
| IMPORT_SYM(uintptr_t, __BL31_START__, BL31_START); | |
| IMPORT_SYM(uintptr_t, __BL31_END__, BL31_END); | |
| #elif defined(IMAGE_BL32) | |
| IMPORT_SYM(uintptr_t, __BL32_END__, BL32_END); | |
| #endif /* IMAGE_BLX */ | |
| /* The following symbols are only exported from the BL2 at EL3 linker script. */ | |
| #if BL2_IN_XIP_MEM && defined(IMAGE_BL2) | |
| IMPORT_SYM(uintptr_t, __BL2_ROM_END__, BL2_ROM_END); | |
| IMPORT_SYM(uintptr_t, __BL2_RAM_START__, BL2_RAM_BASE); | |
| IMPORT_SYM(uintptr_t, __BL2_RAM_END__, BL2_RAM_END); | |
| #endif /* BL2_IN_XIP_MEM */ | |
| /* | |
| * The next 2 constants identify the extents of the coherent memory region. | |
| * These addresses are used by the MMU setup code and therefore they must be | |
| * page-aligned. It is the responsibility of the linker script to ensure that | |
| * __COHERENT_RAM_START__ and __COHERENT_RAM_END__ linker symbols refer to | |
| * page-aligned addresses. | |
| */ | |
| #if USE_COHERENT_MEM | |
| IMPORT_SYM(uintptr_t, __COHERENT_RAM_START__, BL_COHERENT_RAM_BASE); | |
| IMPORT_SYM(uintptr_t, __COHERENT_RAM_END__, BL_COHERENT_RAM_END); | |
| #endif | |
| /******************************************************************************* | |
| * Structure used for telling the next BL how much of a particular type of | |
| * memory is available for its use and how much is already used. | |
| ******************************************************************************/ | |
| typedef struct meminfo { | |
| uintptr_t total_base; | |
| size_t total_size; | |
| } meminfo_t; | |
| /******************************************************************************* | |
| * Function & variable prototypes | |
| ******************************************************************************/ | |
| int load_auth_image(unsigned int image_id, image_info_t *image_data); | |
| #if TRUSTED_BOARD_BOOT && defined(DYN_DISABLE_AUTH) | |
| /* | |
| * API to dynamically disable authentication. Only meant for development | |
| * systems. | |
| */ | |
| void dyn_disable_auth(void); | |
| #endif | |
| extern const char build_message[]; | |
| extern const char version_string[]; | |
| void print_entry_point_info(const entry_point_info_t *ep_info); | |
| uintptr_t page_align(uintptr_t value, unsigned dir); | |
| struct mmap_region; | |
| void setup_page_tables(const struct mmap_region *bl_regions, | |
| const struct mmap_region *plat_regions); | |
| void bl_handle_pauth(void); | |
| #endif /*__ASSEMBLER__*/ | |
| #endif /* BL_COMMON_H */ |