blob: a331c051af3f16244dd70fbe0b7343c4d676bc2a [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Dan Handleyea596682015-04-01 17:34:24 +01002 * Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
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 */
Dan Handleyea596682015-04-01 17:34:24 +010030#ifndef __ASM_MACROS_S__
31#define __ASM_MACROS_S__
Achin Gupta4f6ad662013-10-25 09:08:21 +010032
Dan Handley2bd4ef22014-04-09 13:14:54 +010033#include <arch.h>
34
35
Achin Gupta4f6ad662013-10-25 09:08:21 +010036 .macro func_prologue
37 stp x29, x30, [sp, #-0x10]!
38 mov x29,sp
39 .endm
40
41 .macro func_epilogue
42 ldp x29, x30, [sp], #0x10
43 .endm
44
45
46 .macro dcache_line_size reg, tmp
Achin Gupta07f4e072014-02-02 12:02:23 +000047 mrs \tmp, ctr_el0
Achin Gupta4f6ad662013-10-25 09:08:21 +010048 ubfx \tmp, \tmp, #16, #4
Achin Gupta07f4e072014-02-02 12:02:23 +000049 mov \reg, #4
50 lsl \reg, \reg, \tmp
Achin Gupta4f6ad662013-10-25 09:08:21 +010051 .endm
52
53
54 .macro icache_line_size reg, tmp
Achin Gupta07f4e072014-02-02 12:02:23 +000055 mrs \tmp, ctr_el0
56 and \tmp, \tmp, #0xf
57 mov \reg, #4
58 lsl \reg, \reg, \tmp
Achin Gupta4f6ad662013-10-25 09:08:21 +010059 .endm
60
61
Achin Gupta4f6ad662013-10-25 09:08:21 +010062 .macro smc_check label
Andrew Thoelkef977ed82014-04-28 12:32:02 +010063 mrs x0, esr_el3
Achin Gupta4f6ad662013-10-25 09:08:21 +010064 ubfx x0, x0, #ESR_EC_SHIFT, #ESR_EC_LENGTH
65 cmp x0, #EC_AARCH64_SMC
66 b.ne $label
67 .endm
68
69
Jeenu Viswambharana7934d62014-02-07 15:53:18 +000070 /*
71 * This macro verifies that the a given vector doesn't exceed the
72 * architectural limit of 32 instructions. This is meant to be placed
73 * immedately after the last instruction in the vector. It takes the
74 * vector entry as the parameter
75 */
76 .macro check_vector_size since
77 .if (. - \since) > (32 * 4)
78 .error "Vector exceeds 32 instructions"
79 .endif
80 .endm
Andrew Thoelke38bde412014-03-18 13:46:55 +000081
82 /*
83 * This macro is used to create a function label and place the
84 * code into a separate text section based on the function name
85 * to enable elimination of unused code during linking
86 */
87 .macro func _name
88 .section .text.\_name, "ax"
89 .type \_name, %function
Kévin Petita877c252015-03-24 14:03:57 +000090 .func \_name
Andrew Thoelke38bde412014-03-18 13:46:55 +000091 \_name:
92 .endm
Andrew Thoelke65668f92014-03-20 10:48:23 +000093
Kévin Petita877c252015-03-24 14:03:57 +000094 /*
95 * This macro is used to mark the end of a function.
96 */
97 .macro endfunc _name
98 .endfunc
99 .size \_name, . - \_name
100 .endm
101
Andrew Thoelke65668f92014-03-20 10:48:23 +0000102 /*
Soby Mathew70716d62015-07-13 16:26:11 +0100103 * Theses macros are used to create function labels for deprecated
Soby Mathew18a62042015-10-26 14:29:21 +0000104 * APIs. If ERROR_DEPRECATED is non zero, the callers of these APIs
Soby Mathew70716d62015-07-13 16:26:11 +0100105 * will fail to link and cause build failure.
106 */
Soby Mathew18a62042015-10-26 14:29:21 +0000107#if ERROR_DEPRECATED
Soby Mathew70716d62015-07-13 16:26:11 +0100108 .macro func_deprecated _name
109 func deprecated\_name
110 .endm
111
112 .macro endfunc_deprecated _name
113 endfunc deprecated\_name
114 .endm
115#else
116 .macro func_deprecated _name
117 func \_name
118 .endm
119
120 .macro endfunc_deprecated _name
121 endfunc \_name
122 .endm
123#endif
124
125 /*
Andrew Thoelke65668f92014-03-20 10:48:23 +0000126 * This macro declares an array of 1 or more stacks, properly
127 * aligned and in the requested section
128 */
129#define STACK_ALIGN 6
130
131 .macro declare_stack _name, _section, _size, _count
132 .if ((\_size & ((1 << STACK_ALIGN) - 1)) <> 0)
133 .error "Stack size not correctly aligned"
134 .endif
135 .section \_section, "aw", %nobits
136 .align STACK_ALIGN
137 \_name:
138 .space ((\_count) * (\_size)), 0
139 .endm
140
Soby Mathew981487a2015-07-13 14:10:57 +0100141#if ENABLE_PLAT_COMPAT
Andrew Thoelke65668f92014-03-20 10:48:23 +0000142 /*
143 * This macro calculates the base address of an MP stack using the
144 * platform_get_core_pos() index, the name of the stack storage and
145 * the size of each stack
146 * In: X0 = MPIDR of CPU whose stack is wanted
147 * Out: X0 = physical address of stack base
148 * Clobber: X30, X1, X2
149 */
150 .macro get_mp_stack _name, _size
151 bl platform_get_core_pos
152 ldr x2, =(\_name + \_size)
153 mov x1, #\_size
154 madd x0, x0, x1, x2
155 .endm
Soby Mathew981487a2015-07-13 14:10:57 +0100156#endif
Andrew Thoelke65668f92014-03-20 10:48:23 +0000157
158 /*
Soby Mathewb0082d22015-04-09 13:40:55 +0100159 * This macro calculates the base address of the current CPU's MP stack
160 * using the plat_my_core_pos() index, the name of the stack storage
161 * and the size of each stack
162 * Out: X0 = physical address of stack base
163 * Clobber: X30, X1, X2
164 */
165 .macro get_my_mp_stack _name, _size
166 bl plat_my_core_pos
167 ldr x2, =(\_name + \_size)
168 mov x1, #\_size
169 madd x0, x0, x1, x2
170 .endm
171
172 /*
Andrew Thoelke65668f92014-03-20 10:48:23 +0000173 * This macro calculates the base address of a UP stack using the
174 * name of the stack storage and the size of the stack
175 * Out: X0 = physical address of stack base
176 */
177 .macro get_up_stack _name, _size
178 ldr x0, =(\_name + \_size)
179 .endm
Soby Mathew066f7132014-07-14 16:57:23 +0100180
181 /*
182 * Helper macro to generate the best mov/movk combinations according
183 * the value to be moved. The 16 bits from '_shift' are tested and
184 * if not zero, they are moved into '_reg' without affecting
185 * other bits.
186 */
187 .macro _mov_imm16 _reg, _val, _shift
188 .if (\_val >> \_shift) & 0xffff
189 .if (\_val & (1 << \_shift - 1))
190 movk \_reg, (\_val >> \_shift) & 0xffff, LSL \_shift
191 .else
192 mov \_reg, \_val & (0xffff << \_shift)
193 .endif
194 .endif
195 .endm
196
197 /*
198 * Helper macro to load arbitrary values into 32 or 64-bit registers
199 * which generates the best mov/movk combinations. Many base addresses
200 * are 64KB aligned the macro will eliminate updating bits 15:0 in
201 * that case
202 */
203 .macro mov_imm _reg, _val
204 .if (\_val) == 0
205 mov \_reg, #0
206 .else
207 _mov_imm16 \_reg, (\_val), 0
208 _mov_imm16 \_reg, (\_val), 16
209 _mov_imm16 \_reg, (\_val), 32
210 _mov_imm16 \_reg, (\_val), 48
211 .endif
212 .endm
Dan Handleyea596682015-04-01 17:34:24 +0100213
214#endif /* __ASM_MACROS_S__ */