mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-27 15:24:54 +00:00
40fc6cd141
This patch adds an optional API to the platform port:
void plat_error_handler(int err) __dead2;
The platform error handler is called when there is a specific error
condition after which Trusted Firmware cannot continue. While panic()
simply prints the crash report (if enabled) and spins, the platform
error handler can be used to hand control over to the platform port
so it can perform specific bookeeping or post-error actions (for
example, reset the system). This function must not return.
The parameter indicates the type of error using standard codes from
errno.h. Possible errors reported by the generic code are:
-EAUTH : a certificate or image could not be authenticated
(when Trusted Board Boot is enabled)
-ENOENT : the requested image or certificate could not be found
or an IO error was detected
-ENOMEM : resources exhausted. Trusted Firmware does not use
dynamic memory, so this error is usually an indication
of an incorrect array size
A default weak implementation of this function has been provided.
It simply implements an infinite loop.
Change-Id: Iffaf9eee82d037da6caa43b3aed51df555e597a3
241 lines
10 KiB
C
241 lines
10 KiB
C
/*
|
|
* Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* Neither the name of ARM nor the names of its contributors may be used
|
|
* to endorse or promote products derived from this software without specific
|
|
* prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef __PLATFORM_H__
|
|
#define __PLATFORM_H__
|
|
|
|
#include <psci.h>
|
|
#include <stdint.h>
|
|
#include <types.h>
|
|
|
|
|
|
/*******************************************************************************
|
|
* Forward declarations
|
|
******************************************************************************/
|
|
struct meminfo;
|
|
struct image_info;
|
|
struct entry_point_info;
|
|
struct bl31_params;
|
|
|
|
/*******************************************************************************
|
|
* plat_get_rotpk_info() flags
|
|
******************************************************************************/
|
|
#define ROTPK_IS_HASH (1 << 0)
|
|
|
|
/*******************************************************************************
|
|
* Function declarations
|
|
******************************************************************************/
|
|
/*******************************************************************************
|
|
* Mandatory common functions
|
|
******************************************************************************/
|
|
uint64_t plat_get_syscnt_freq(void);
|
|
int plat_get_image_source(unsigned int image_id,
|
|
uintptr_t *dev_handle,
|
|
uintptr_t *image_spec);
|
|
unsigned long plat_get_ns_image_entrypoint(void);
|
|
unsigned int plat_my_core_pos(void);
|
|
int plat_core_pos_by_mpidr(u_register_t mpidr);
|
|
|
|
/*******************************************************************************
|
|
* Mandatory interrupt management functions
|
|
******************************************************************************/
|
|
uint32_t plat_ic_get_pending_interrupt_id(void);
|
|
uint32_t plat_ic_get_pending_interrupt_type(void);
|
|
uint32_t plat_ic_acknowledge_interrupt(void);
|
|
uint32_t plat_ic_get_interrupt_type(uint32_t id);
|
|
void plat_ic_end_of_interrupt(uint32_t id);
|
|
uint32_t plat_interrupt_type_to_line(uint32_t type,
|
|
uint32_t security_state);
|
|
|
|
/*******************************************************************************
|
|
* Optional common functions (may be overridden)
|
|
******************************************************************************/
|
|
unsigned long plat_get_my_stack(void);
|
|
void plat_report_exception(unsigned long);
|
|
int plat_crash_console_init(void);
|
|
int plat_crash_console_putc(int c);
|
|
void plat_error_handler(int err) __dead2;
|
|
|
|
/*******************************************************************************
|
|
* Mandatory BL1 functions
|
|
******************************************************************************/
|
|
void bl1_early_platform_setup(void);
|
|
void bl1_plat_arch_setup(void);
|
|
void bl1_platform_setup(void);
|
|
struct meminfo *bl1_plat_sec_mem_layout(void);
|
|
|
|
/*
|
|
* This function allows the platform to change the entrypoint information for
|
|
* BL2, after BL1 has loaded BL2 into memory but before BL2 is executed.
|
|
*/
|
|
void bl1_plat_set_bl2_ep_info(struct image_info *image,
|
|
struct entry_point_info *ep);
|
|
|
|
/*******************************************************************************
|
|
* Optional BL1 functions (may be overridden)
|
|
******************************************************************************/
|
|
void bl1_init_bl2_mem_layout(const struct meminfo *bl1_mem_layout,
|
|
struct meminfo *bl2_mem_layout);
|
|
|
|
/*******************************************************************************
|
|
* Mandatory BL2 functions
|
|
******************************************************************************/
|
|
void bl2_early_platform_setup(struct meminfo *mem_layout);
|
|
void bl2_plat_arch_setup(void);
|
|
void bl2_platform_setup(void);
|
|
struct meminfo *bl2_plat_sec_mem_layout(void);
|
|
|
|
/*
|
|
* This function returns a pointer to the shared memory that the platform has
|
|
* kept aside to pass trusted firmware related information that BL3-1
|
|
* could need
|
|
*/
|
|
struct bl31_params *bl2_plat_get_bl31_params(void);
|
|
|
|
/*
|
|
* This function returns a pointer to the shared memory that the platform
|
|
* has kept to point to entry point information of BL31 to BL2
|
|
*/
|
|
struct entry_point_info *bl2_plat_get_bl31_ep_info(void);
|
|
|
|
/*
|
|
* This function flushes to main memory all the params that are
|
|
* passed to BL3-1
|
|
*/
|
|
void bl2_plat_flush_bl31_params(void);
|
|
|
|
/*
|
|
* The next 2 functions allow the platform to change the entrypoint information
|
|
* for the mandatory 3rd level BL images, BL3-1 and BL3-3. This is done after
|
|
* BL2 has loaded those images into memory but before BL3-1 is executed.
|
|
*/
|
|
void bl2_plat_set_bl31_ep_info(struct image_info *image,
|
|
struct entry_point_info *ep);
|
|
|
|
void bl2_plat_set_bl33_ep_info(struct image_info *image,
|
|
struct entry_point_info *ep);
|
|
|
|
/* Gets the memory layout for BL3-3 */
|
|
void bl2_plat_get_bl33_meminfo(struct meminfo *mem_info);
|
|
|
|
/*******************************************************************************
|
|
* Conditionally mandatory BL2 functions: must be implemented if BL3-0 image
|
|
* is supported
|
|
******************************************************************************/
|
|
/* Gets the memory layout for BL3-0 */
|
|
void bl2_plat_get_bl30_meminfo(struct meminfo *mem_info);
|
|
|
|
/*
|
|
* This function is called after loading BL3-0 image and it is used to perform
|
|
* any platform-specific actions required to handle the SCP firmware.
|
|
*/
|
|
int bl2_plat_handle_bl30(struct image_info *bl30_image_info);
|
|
|
|
/*******************************************************************************
|
|
* Conditionally mandatory BL2 functions: must be implemented if BL3-2 image
|
|
* is supported
|
|
******************************************************************************/
|
|
void bl2_plat_set_bl32_ep_info(struct image_info *image,
|
|
struct entry_point_info *ep);
|
|
|
|
/* Gets the memory layout for BL3-2 */
|
|
void bl2_plat_get_bl32_meminfo(struct meminfo *mem_info);
|
|
|
|
/*******************************************************************************
|
|
* Optional BL2 functions (may be overridden)
|
|
******************************************************************************/
|
|
|
|
/*******************************************************************************
|
|
* Mandatory BL3-1 functions
|
|
******************************************************************************/
|
|
void bl31_early_platform_setup(struct bl31_params *from_bl2,
|
|
void *plat_params_from_bl2);
|
|
void bl31_plat_arch_setup(void);
|
|
void bl31_platform_setup(void);
|
|
struct entry_point_info *bl31_plat_get_next_image_ep_info(uint32_t type);
|
|
|
|
/*******************************************************************************
|
|
* Mandatory PSCI functions (BL3-1)
|
|
******************************************************************************/
|
|
int plat_setup_psci_ops(uintptr_t sec_entrypoint,
|
|
const struct plat_psci_ops **);
|
|
const unsigned char *plat_get_power_domain_tree_desc(void);
|
|
|
|
/*******************************************************************************
|
|
* Optional PSCI functions (BL3-1).
|
|
******************************************************************************/
|
|
plat_local_state_t plat_get_target_pwr_state(unsigned int lvl,
|
|
const plat_local_state_t *states,
|
|
unsigned int ncpu);
|
|
|
|
/*******************************************************************************
|
|
* Optional BL3-1 functions (may be overridden)
|
|
******************************************************************************/
|
|
void bl31_plat_enable_mmu(uint32_t flags);
|
|
|
|
/*******************************************************************************
|
|
* Optional BL3-2 functions (may be overridden)
|
|
******************************************************************************/
|
|
void bl32_plat_enable_mmu(uint32_t flags);
|
|
|
|
/*******************************************************************************
|
|
* Trusted Board Boot functions
|
|
******************************************************************************/
|
|
int plat_get_rotpk_info(void *cookie, void **key_ptr, unsigned int *key_len,
|
|
unsigned int *flags);
|
|
|
|
#if ENABLE_PLAT_COMPAT
|
|
/*
|
|
* The below declarations are to enable compatibility for the platform ports
|
|
* using the old platform interface.
|
|
*/
|
|
|
|
/*******************************************************************************
|
|
* Optional common functions (may be overridden)
|
|
******************************************************************************/
|
|
unsigned int platform_get_core_pos(unsigned long mpidr);
|
|
|
|
/*******************************************************************************
|
|
* Mandatory PSCI Compatibility functions (BL3-1)
|
|
******************************************************************************/
|
|
int platform_setup_pm(const plat_pm_ops_t **);
|
|
|
|
unsigned int plat_get_aff_count(unsigned int, unsigned long);
|
|
unsigned int plat_get_aff_state(unsigned int, unsigned long);
|
|
#else
|
|
/*
|
|
* The below function enable Trusted Firmware components like SPDs which
|
|
* haven't migrated to the new platform API to compile on platforms which
|
|
* have the compatibility layer disabled.
|
|
*/
|
|
unsigned int platform_get_core_pos(unsigned long mpidr) __warn_deprecated;
|
|
|
|
#endif /* __ENABLE_PLAT_COMPAT__ */
|
|
#endif /* __PLATFORM_H__ */
|