mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-24 13:55:56 +00:00
57bf605772
This patch adds a new include/export/ directory meant for inclusion in third-party code. This is useful for cases where third-party code needs to interact with TF-A interfaces and data structures (such as a custom BL2-implementation like coreboot handing off to BL31). Directly including headers from the TF-A repository avoids having to duplicate all these definitions (and risk them going stale), but with the current header structure this is not possible because handoff API definitions are too deeply intertwined with other TF code/headers and chain-include other headers that will not be available in the other environment. The new approach aims to solve this by separating only the parts that are really needed into these special headers that are self-contained and will not chain-include other (non-export) headers. TF-A code should never include them directly but should instead always include the respective wrapper header, which will include the required prerequisites (like <stdint.h>) before including the export header. Third-party code can include the export headers via its own wrappers that make sure the necessary definitions are available in whatever way that environment can provide them. Change-Id: Ifd769320ba51371439a8e5dd5b79c2516c3b43ab Signed-off-by: Julius Werner <jwerner@chromium.org>
95 lines
2.9 KiB
C
95 lines
2.9 KiB
C
/*
|
|
* Copyright (c) 2019, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef ARM_TRUSTED_FIRMWARE_EXPORT_COMMON_BL_COMMON_EXP_H
|
|
#define ARM_TRUSTED_FIRMWARE_EXPORT_COMMON_BL_COMMON_EXP_H
|
|
|
|
/* EXPORT HEADER -- See include/export/README for details! -- EXPORT HEADER */
|
|
|
|
#include "ep_info_exp.h"
|
|
#include "tbbr/tbbr_img_def_exp.h"
|
|
|
|
/*
|
|
* The following are used for image state attributes.
|
|
* Image can only be in one of the following state.
|
|
*/
|
|
#define IMAGE_STATE_RESET U(0)
|
|
#define IMAGE_STATE_COPIED U(1)
|
|
#define IMAGE_STATE_COPYING U(2)
|
|
#define IMAGE_STATE_AUTHENTICATED U(3)
|
|
#define IMAGE_STATE_EXECUTED U(4)
|
|
#define IMAGE_STATE_INTERRUPTED U(5)
|
|
|
|
#define IMAGE_ATTRIB_SKIP_LOADING U(0x02)
|
|
#define IMAGE_ATTRIB_PLAT_SETUP U(0x04)
|
|
|
|
#define INVALID_IMAGE_ID U(0xFFFFFFFF)
|
|
|
|
#ifndef __ASSEMBLER__
|
|
|
|
/*****************************************************************************
|
|
* Image info binary provides information from the image loader that
|
|
* can be used by the firmware to manage available trusted RAM.
|
|
* More advanced firmware image formats can provide additional
|
|
* information that enables optimization or greater flexibility in the
|
|
* common firmware code
|
|
*****************************************************************************/
|
|
typedef struct image_info {
|
|
param_header_t h;
|
|
uintptr_t image_base; /* physical address of base of image */
|
|
uint32_t image_size; /* bytes read from image file */
|
|
uint32_t image_max_size;
|
|
} image_info_t;
|
|
|
|
/* BL image node in the BL image execution sequence */
|
|
typedef struct bl_params_node {
|
|
unsigned int image_id;
|
|
image_info_t *image_info;
|
|
entry_point_info_t *ep_info;
|
|
struct bl_params_node *next_params_info;
|
|
} bl_params_node_t;
|
|
|
|
/*
|
|
* BL image head node in the BL image execution sequence
|
|
* It is also used to pass information to next BL image.
|
|
*/
|
|
typedef struct bl_params {
|
|
param_header_t h;
|
|
bl_params_node_t *head;
|
|
} bl_params_t;
|
|
|
|
/*****************************************************************************
|
|
* The image descriptor struct definition.
|
|
*****************************************************************************/
|
|
typedef struct image_desc {
|
|
/* Contains unique image id for the image. */
|
|
unsigned int image_id;
|
|
/*
|
|
* This member contains Image state information.
|
|
* Refer IMAGE_STATE_XXX defined above.
|
|
*/
|
|
unsigned int state;
|
|
uint32_t copied_size; /* image size copied in blocks */
|
|
image_info_t image_info;
|
|
entry_point_info_t ep_info;
|
|
} image_desc_t;
|
|
|
|
/* BL image node in the BL image loading sequence */
|
|
typedef struct bl_load_info_node {
|
|
unsigned int image_id;
|
|
image_info_t *image_info;
|
|
struct bl_load_info_node *next_load_info;
|
|
} bl_load_info_node_t;
|
|
|
|
/* BL image head node in the BL image loading sequence */
|
|
typedef struct bl_load_info {
|
|
param_header_t h;
|
|
bl_load_info_node_t *head;
|
|
} bl_load_info_t;
|
|
|
|
#endif /* __ASSEMBLER__ */
|
|
|
|
#endif /* ARM_TRUSTED_FIRMWARE_EXPORT_COMMON_BL_COMMON_EXP_H */
|