xref: /rk3399_ARM-atf/include/common/desc_image_load.h (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
1 /*
2  * Copyright (c) 2016, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 #ifndef __DESC_IMAGE_LOAD_H__
31 #define __DESC_IMAGE_LOAD_H__
32 
33 #include <bl_common.h>
34 
35 #if LOAD_IMAGE_V2
36 /* Following structure is used to store BL ep/image info. */
37 typedef struct bl_mem_params_node {
38 	unsigned int image_id;
39 	image_info_t image_info;
40 	entry_point_info_t ep_info;
41 	unsigned int next_handoff_image_id;
42 	bl_load_info_node_t load_node_mem;
43 	bl_params_node_t params_node_mem;
44 } bl_mem_params_node_t;
45 
46 /*
47  * Macro to register list of BL image descriptors,
48  * defined as an array of bl_mem_params_node_t.
49  */
50 #define REGISTER_BL_IMAGE_DESCS(_img_desc)				\
51 	bl_mem_params_node_t *bl_mem_params_desc_ptr = &_img_desc[0];	\
52 	unsigned int bl_mem_params_desc_num = ARRAY_SIZE(_img_desc);
53 
54 /* BL image loading utility functions */
55 void flush_bl_params_desc(void);
56 int get_bl_params_node_index(unsigned int image_id);
57 bl_mem_params_node_t *get_bl_mem_params_node(unsigned int image_id);
58 bl_load_info_t *get_bl_load_info_from_mem_params_desc(void);
59 bl_params_t *get_next_bl_params_from_mem_params_desc(void);
60 
61 
62 #endif /* LOAD_IMAGE_V2 */
63 #endif /* __DESC_IMAGE_LOAD_H__ */
64