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