xref: /aosp_15_r20/external/arm-trusted-firmware/include/common/desc_image_load.h (revision 54fd6939e177f8ff529b10183254802c76df6d08)
1*54fd6939SJiyong Park /*
2*54fd6939SJiyong Park  * Copyright (c) 2016-2019, ARM Limited and Contributors. All rights reserved.
3*54fd6939SJiyong Park  *
4*54fd6939SJiyong Park  * SPDX-License-Identifier: BSD-3-Clause
5*54fd6939SJiyong Park  */
6*54fd6939SJiyong Park #ifndef DESC_IMAGE_LOAD_H
7*54fd6939SJiyong Park #define DESC_IMAGE_LOAD_H
8*54fd6939SJiyong Park 
9*54fd6939SJiyong Park #include <common/bl_common.h>
10*54fd6939SJiyong Park 
11*54fd6939SJiyong Park /* Following structure is used to store BL ep/image info. */
12*54fd6939SJiyong Park typedef struct bl_mem_params_node {
13*54fd6939SJiyong Park 	unsigned int image_id;
14*54fd6939SJiyong Park 	image_info_t image_info;
15*54fd6939SJiyong Park 	entry_point_info_t ep_info;
16*54fd6939SJiyong Park 	unsigned int next_handoff_image_id;
17*54fd6939SJiyong Park 	bl_load_info_node_t load_node_mem;
18*54fd6939SJiyong Park 	bl_params_node_t params_node_mem;
19*54fd6939SJiyong Park } bl_mem_params_node_t;
20*54fd6939SJiyong Park 
21*54fd6939SJiyong Park extern bl_mem_params_node_t *bl_mem_params_desc_ptr;
22*54fd6939SJiyong Park extern unsigned int bl_mem_params_desc_num;
23*54fd6939SJiyong Park 
24*54fd6939SJiyong Park /*
25*54fd6939SJiyong Park  * Macro to register list of BL image descriptors,
26*54fd6939SJiyong Park  * defined as an array of bl_mem_params_node_t.
27*54fd6939SJiyong Park  */
28*54fd6939SJiyong Park #define REGISTER_BL_IMAGE_DESCS(_img_desc)				\
29*54fd6939SJiyong Park 	bl_mem_params_node_t *bl_mem_params_desc_ptr = &_img_desc[0];	\
30*54fd6939SJiyong Park 	unsigned int bl_mem_params_desc_num = ARRAY_SIZE(_img_desc);
31*54fd6939SJiyong Park 
32*54fd6939SJiyong Park /* BL image loading utility functions */
33*54fd6939SJiyong Park void flush_bl_params_desc(void);
34*54fd6939SJiyong Park void flush_bl_params_desc_args(bl_mem_params_node_t *mem_params_desc_ptr,
35*54fd6939SJiyong Park 	unsigned int mem_params_desc_num,
36*54fd6939SJiyong Park 	bl_params_t *next_bl_params_ptr);
37*54fd6939SJiyong Park int get_bl_params_node_index(unsigned int image_id);
38*54fd6939SJiyong Park bl_mem_params_node_t *get_bl_mem_params_node(unsigned int image_id);
39*54fd6939SJiyong Park bl_load_info_t *get_bl_load_info_from_mem_params_desc(void);
40*54fd6939SJiyong Park bl_params_t *get_next_bl_params_from_mem_params_desc(void);
41*54fd6939SJiyong Park void populate_next_bl_params_config(bl_params_t *bl2_to_next_bl_params);
42*54fd6939SJiyong Park 
43*54fd6939SJiyong Park /* Helper to extract BL32/BL33 entry point info from arg0 passed to BL31. */
44*54fd6939SJiyong Park void bl31_params_parse_helper(u_register_t param,
45*54fd6939SJiyong Park 			      entry_point_info_t *bl32_ep_info_out,
46*54fd6939SJiyong Park 			      entry_point_info_t *bl33_ep_info_out);
47*54fd6939SJiyong Park 
48*54fd6939SJiyong Park #endif /* DESC_IMAGE_LOAD_H */
49