xref: /rk3399_ARM-atf/plat/common/aarch64/platform_helpers.S (revision 3105f7ba9a3a9f6f0e78761e8bdd4da621254730)
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#include <arch.h>
32#include <asm_macros.S>
33#include <platform_def.h>
34
35	.weak	plat_report_exception
36	.weak	plat_crash_console_init
37	.weak	plat_crash_console_putc
38	.weak	plat_reset_handler
39	.weak	plat_disable_acp
40	.weak	bl1_plat_prepare_exit
41	.weak	plat_error_handler
42
43#if !ENABLE_PLAT_COMPAT
44	.globl	platform_get_core_pos
45
46#define MPIDR_RES_BIT_MASK	0xff000000
47
48	/* ------------------------------------------------------------------
49	 *  int platform_get_core_pos(int mpidr)
50	 *  Returns the CPU index of the CPU specified by mpidr. This is
51	 *  defined when platform compatibility is disabled to enable Trusted
52	 *  Firmware components like SPD using the old  platform API to work.
53	 *  This API is deprecated and it assumes that the mpidr specified is
54	 *  that of a valid and present CPU. Instead, plat_my_core_pos()
55	 *  should be used for CPU index of the current CPU and
56	 *  plat_core_pos_by_mpidr() should be used for CPU index of a
57	 *  CPU specified by its mpidr.
58	 * ------------------------------------------------------------------
59	 */
60func_deprecated platform_get_core_pos
61	bic	x0, x0, #MPIDR_RES_BIT_MASK
62	mrs	x1, mpidr_el1
63	bic	x1, x1, #MPIDR_RES_BIT_MASK
64	cmp	x0, x1
65	beq	plat_my_core_pos
66	b	platform_core_pos_helper
67endfunc_deprecated platform_get_core_pos
68#endif
69
70	/* -----------------------------------------------------
71	 * Placeholder function which should be redefined by
72	 * each platform.
73	 * -----------------------------------------------------
74	 */
75func plat_report_exception
76	ret
77endfunc plat_report_exception
78
79	/* -----------------------------------------------------
80	 * Placeholder function which should be redefined by
81	 * each platform.
82	 * -----------------------------------------------------
83	 */
84func plat_crash_console_init
85	mov	x0, #0
86	ret
87endfunc plat_crash_console_init
88
89	/* -----------------------------------------------------
90	 * Placeholder function which should be redefined by
91	 * each platform.
92	 * -----------------------------------------------------
93	 */
94func plat_crash_console_putc
95	ret
96endfunc plat_crash_console_putc
97
98	/* -----------------------------------------------------
99	 * Placeholder function which should be redefined by
100	 * each platform. This function should preserve x10.
101	 * -----------------------------------------------------
102	 */
103func plat_reset_handler
104	ret
105endfunc plat_reset_handler
106
107	/* -----------------------------------------------------
108	 * Placeholder function which should be redefined by
109	 * each platform. This function is allowed to use
110	 * registers x0 - x17.
111	 * -----------------------------------------------------
112	 */
113func plat_disable_acp
114	ret
115endfunc plat_disable_acp
116
117	/* -----------------------------------------------------
118	 * void bl1_plat_prepare_exit(entry_point_info_t *ep_info);
119	 * Called before exiting BL1. Default: do nothing
120	 * -----------------------------------------------------
121	 */
122func bl1_plat_prepare_exit
123	ret
124endfunc bl1_plat_prepare_exit
125
126	/* -----------------------------------------------------
127	 * void plat_error_handler(int err) __dead2;
128	 * Endless loop by default.
129	 * -----------------------------------------------------
130	 */
131func plat_error_handler
132	b	plat_error_handler
133endfunc plat_error_handler
134