xref: /rk3399_ARM-atf/include/bl2/bl2.h (revision 4112bfa0c223eda73af1cfe57ca7dc926f767dd8)
1 /*
2  * Copyright (c) 2013-2014, 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 
31 #ifndef __BL2_H__
32 #define __BL2_H__
33 
34 /******************************************
35  * Data declarations
36  *****************************************/
37 extern unsigned long long bl2_entrypoint;
38 
39 /******************************************
40  * Forward declarations
41  *****************************************/
42 struct meminfo;
43 struct bl31_args;
44 
45 /******************************************
46  * Function prototypes
47  *****************************************/
48 extern void bl2_platform_setup(void);
49 extern struct meminfo *bl2_plat_sec_mem_layout(void);
50 
51 /*******************************************************************************
52  * This function returns a pointer to the shared memory that the platform has
53  * kept aside to pass trusted firmware related information that BL3-1
54  * could need
55  ******************************************************************************/
56 extern struct bl31_params *bl2_plat_get_bl31_params(void);
57 
58 /*******************************************************************************
59  * This function returns a pointer to the shared memory that the platform has
60  * kept aside to pass platform related information that BL3-1 could need
61  ******************************************************************************/
62 extern struct bl31_plat_params *bl2_plat_get_bl31_plat_params(void);
63 
64 /*******************************************************************************
65  * This function returns a pointer to the shared memory that the platform
66  * has kept to point to entry point information of BL31 to BL2
67  ******************************************************************************/
68 extern struct entry_point_info *bl2_plat_get_bl31_ep_info(void);
69 
70 
71 /************************************************************************
72  * This function flushes to main memory all the params that are
73  * passed to BL3-1
74  **************************************************************************/
75 extern void bl2_plat_flush_bl31_params(void);
76 
77 
78 #endif /* __BL2_H__ */
79