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