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