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