xref: /rk3399_ARM-atf/include/bl2/bl2.h (revision 7a9a5f2d22c4f76ae95300fe52129603d29bccc1)
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  * Forward declarations
36  *****************************************/
37 struct meminfo;
38 struct bl31_params;
39 struct entry_point_info;
40 
41 /******************************************
42  * Function prototypes
43  *****************************************/
44 void bl2_platform_setup(void);
45 struct meminfo *bl2_plat_sec_mem_layout(void);
46 
47 /*******************************************************************************
48  * This function returns a pointer to the shared memory that the platform has
49  * kept aside to pass trusted firmware related information that BL3-1
50  * could need
51  ******************************************************************************/
52 struct bl31_params *bl2_plat_get_bl31_params(void);
53 
54 /*******************************************************************************
55  * This function returns a pointer to the shared memory that the platform
56  * has kept to point to entry point information of BL31 to BL2
57  ******************************************************************************/
58 struct entry_point_info *bl2_plat_get_bl31_ep_info(void);
59 
60 /************************************************************************
61  * This function flushes to main memory all the params that are
62  * passed to BL3-1
63  **************************************************************************/
64 void bl2_plat_flush_bl31_params(void);
65 
66 #endif /* __BL2_H__ */
67