sys/arm/include/asm.h

   1 /*      $NetBSD: asm.h,v 1.5 2003/08/07 16:26:53 agc Exp $      */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-3-Clause
   5  *
   6  * Copyright (c) 1990 The Regents of the University of California.
   7  * All rights reserved.
   8  *
   9  * This code is derived from software contributed to Berkeley by
  10  * William Jolitz.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      from: @(#)asm.h 5.5 (Berkeley) 5/7/91
  37  *
  38  * $FreeBSD$
  39  */
  40
  41 #ifndef _MACHINE_ASM_H_
  42 #define _MACHINE_ASM_H_
  43 #include <sys/cdefs.h>
  44 #include <machine/sysreg.h>
  45
  46 #define _C_LABEL(x)     x
  47 #define _ASM_LABEL(x)   x
  48
  49 #ifndef _ALIGN_TEXT
  50 # define _ALIGN_TEXT .align 2
  51 #endif
  52
  53 #ifndef _STANDALONE
  54 #define STOP_UNWINDING  .cantunwind
  55 #define _FNSTART        .fnstart
  56 #define _FNEND          .fnend
  57 #define _SAVE(...)      .save __VA_ARGS__
  58 #else
  59 #define STOP_UNWINDING
  60 #define _FNSTART
  61 #define _FNEND
  62 #define _SAVE(...)
  63 #endif
  64
  65 /*
  66  * gas/arm uses @ as a single comment character and thus cannot be used here.
  67  * It recognises the # instead of an @ symbol in .type directives.
  68  */
  69 #define _ASM_TYPE_FUNCTION      #function
  70 #define _ASM_TYPE_OBJECT        #object
  71
  72 /* XXX Is this still the right prologue for profiling? */
  73 #ifdef GPROF
  74 #define _PROF_PROLOGUE  \
  75         mov ip, lr;     \
  76         bl __mcount
  77 #else
  78 #define _PROF_PROLOGUE
  79 #endif
  80
  81 /*
  82  * EENTRY()/EEND() mark "extra" entry/exit points from a function.
  83  * LEENTRY()/LEEND() are the same for local symbols.
  84  * The unwind info cannot handle the concept of a nested function, or a function
  85  * with multiple .fnstart directives, but some of our assembler code is written
  86  * with multiple labels to allow entry at several points.  The EENTRY() macro
  87  * defines such an extra entry point without a new .fnstart, so that it's
  88  * basically just a label that you can jump to.  The EEND() macro does nothing
  89  * at all, except document the exit point associated with the same-named entry.
  90  */
  91 #define GLOBAL(x)       .global x
  92
  93 #ifdef __thumb__
  94 #define _FUNC_MODE      .code 16; .thumb_func
  95 #else
  96 #define _FUNC_MODE      .code 32
  97 #endif
  98
  99 #define _LEENTRY(x)     .type x,_ASM_TYPE_FUNCTION; _FUNC_MODE; x:
 100 #define _LEEND(x)       /* nothing */
 101 #define _EENTRY(x)      GLOBAL(x); _LEENTRY(x)
 102 #define _EEND(x)        _LEEND(x)
 103
 104 #define _LENTRY(x)      .text; _ALIGN_TEXT; _LEENTRY(x); _FNSTART
 105 #define _LEND(x)        .size x, . - x; _FNEND
 106 #define _ENTRY(x)       .text; _ALIGN_TEXT; _EENTRY(x); _FNSTART
 107 #define _END(x)         _LEND(x)
 108
 109 #define ENTRY(y)        _ENTRY(_C_LABEL(y)); _PROF_PROLOGUE
 110 #define EENTRY(y)       _EENTRY(_C_LABEL(y));
 111 #define ENTRY_NP(y)     _ENTRY(_C_LABEL(y))
 112 #define EENTRY_NP(y)    _EENTRY(_C_LABEL(y))
 113 #define END(y)          _END(_C_LABEL(y))
 114 #define EEND(y)         _EEND(_C_LABEL(y))
 115 #define ASENTRY(y)      _ENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
 116 #define ASLENTRY(y)     _LENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
 117 #define ASEENTRY(y)     _EENTRY(_ASM_LABEL(y));
 118 #define ASLEENTRY(y)    _LEENTRY(_ASM_LABEL(y));
 119 #define ASENTRY_NP(y)   _ENTRY(_ASM_LABEL(y))
 120 #define ASLENTRY_NP(y)  _LENTRY(_ASM_LABEL(y))
 121 #define ASEENTRY_NP(y)  _EENTRY(_ASM_LABEL(y))
 122 #define ASLEENTRY_NP(y) _LEENTRY(_ASM_LABEL(y))
 123 #define ASEND(y)        _END(_ASM_LABEL(y))
 124 #define ASLEND(y)       _LEND(_ASM_LABEL(y))
 125 #define ASEEND(y)       _EEND(_ASM_LABEL(y))
 126 #define ASLEEND(y)      _LEEND(_ASM_LABEL(y))
 127
 128 #define ASMSTR          .asciz
 129
 130 #if defined(PIC)
 131 #define PLT_SYM(x)      PIC_SYM(x, PLT)
 132 #define GOT_SYM(x)      PIC_SYM(x, GOT)
 133 #define GOT_GET(x,got,sym)      \
 134         ldr     x, sym;         \
 135         ldr     x, [x, got]
 136 #define GOT_INIT(got,gotsym,pclabel) \
 137         ldr     got, gotsym;    \
 138         pclabel: add    got, pc
 139 #ifdef __thumb__
 140 #define GOT_INITSYM(gotsym,pclabel) \
 141         .align 2;               \
 142         gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+4)
 143 #else
 144 #define GOT_INITSYM(gotsym,pclabel) \
 145         .align 2;               \
 146         gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+8)
 147 #endif
 148
 149 #ifdef __STDC__
 150 #define PIC_SYM(x,y)    x ## ( ## y ## )
 151 #else
 152 #define PIC_SYM(x,y)    x/**/(/**/y/**/)
 153 #endif
 154
 155 #else
 156 #define PLT_SYM(x)      x
 157 #define GOT_SYM(x)      x
 158 #define GOT_GET(x,got,sym)      \
 159         ldr     x, sym;
 160 #define GOT_INIT(got,gotsym,pclabel)
 161 #define GOT_INITSYM(gotsym,pclabel)
 162 #define PIC_SYM(x,y)    x
 163 #endif  /* PIC */
 164
 165 #undef __FBSDID
 166 #if !defined(lint) && !defined(STRIP_FBSDID)
 167 #define __FBSDID(s)     .ident s
 168 #else
 169 #define __FBSDID(s)     /* nothing */
 170 #endif
 171
 172
 173 #define WEAK_ALIAS(alias,sym)                                           \
 174         .weak alias;                                                    \
 175         alias = sym
 176
 177 #ifdef __STDC__
 178 #define WARN_REFERENCES(sym,msg)                                        \
 179         .stabs msg ## ,30,0,0,0 ;                                       \
 180         .stabs __STRING(_C_LABEL(sym)) ## ,1,0,0,0
 181 #else
 182 #define WARN_REFERENCES(sym,msg)                                        \
 183         .stabs msg,30,0,0,0 ;                                           \
 184         .stabs __STRING(sym),1,0,0,0
 185 #endif /* __STDC__ */
 186
 187 /* Exactly one of the __ARM_ARCH_*__ macros will be defined by the compiler. */
 188 /* The _ARM_ARCH_* macros are deprecated and will be removed soon. */
 189 /* This should be moved into another header so it can be used in
 190  * both asm and C code. machine/asm.h cannot be included in C code. */
 191 #if defined (__ARM_ARCH_7__) || defined (__ARM_ARCH_7A__)
 192 #define _ARM_ARCH_7
 193 #define _HAVE_ARMv7_INSTRUCTIONS 1
 194 #endif
 195
 196 #if defined (_HAVE_ARMv7_INSTRUCTIONS) || defined (__ARM_ARCH_6__) || \
 197         defined (__ARM_ARCH_6J__) || defined (__ARM_ARCH_6K__) || \
 198         defined (__ARM_ARCH_6KZ__) || \
 199         defined (__ARM_ARCH_6Z__) || defined (__ARM_ARCH_6ZK__)
 200 #define _ARM_ARCH_6
 201 #define _HAVE_ARMv6_INSTRUCTIONS 1
 202 #endif
 203
 204 #if defined (_HAVE_ARMv6_INSTRUCTIONS) || defined (__ARM_ARCH_5TE__) || \
 205     defined (__ARM_ARCH_5TEJ__) || defined (__ARM_ARCH_5E__)
 206 #define _ARM_ARCH_5E
 207 #define _HAVE_ARMv5E_INSTRUCTIONS 1
 208 #endif
 209
 210 #if defined (_HAVE_ARMv5E_INSTRUCTIONS) || defined (__ARM_ARCH_5__) || \
 211     defined (__ARM_ARCH_5T__)
 212 #define _ARM_ARCH_5
 213 #define _HAVE_ARMv5_INSTRUCTIONS 1
 214 #endif
 215
 216 #if defined (_HAVE_ARMv5_INSTRUCTIONS) || defined (__ARM_ARCH_4T__)
 217 #define _ARM_ARCH_4T
 218 #define _HAVE_ARMv4T_INSTRUCTIONS 1
 219 #endif
 220
 221 /* FreeBSD requires ARMv4, so this is always set. */
 222 #define _HAVE_ARMv4_INSTRUCTIONS 1
 223
 224 #if defined (_HAVE_ARMv4T_INSTRUCTIONS)
 225 # define RET    bx      lr
 226 # define RETeq  bxeq    lr
 227 # define RETne  bxne    lr
 228 # define RETc(c) bx##c  lr
 229 #else
 230 # define RET    mov     pc, lr
 231 # define RETeq  moveq   pc, lr
 232 # define RETne  movne   pc, lr
 233 # define RETc(c) mov##c pc, lr
 234 #endif
 235
 236 #if __ARM_ARCH >= 7
 237 #define ISB     isb
 238 #define DSB     dsb
 239 #define DMB     dmb
 240 #define WFI     wfi
 241
 242 #if defined(__ARM_ARCH_7VE__) || defined(__clang__)
 243 #define MSR_ELR_HYP(regnum)     msr     elr_hyp, lr
 244 #define ERET    eret
 245 #else
 246 #define MSR_ELR_HYP(regnum) .word (0xe12ef300 | regnum)
 247 #define ERET .word 0xe160006e
 248 #endif
 249
 250 #elif __ARM_ARCH == 6
 251 #define ISB     mcr CP15_CP15ISB
 252 #define DSB     mcr CP15_CP15DSB
 253 #define DMB     mcr CP15_CP15DMB
 254 #define WFI     mcr CP15_CP15WFI
 255 #else
 256 #define ISB     mcr CP15_CP15ISB
 257 #define DSB     mcr CP15_CP15DSB        /* DSB and DMB are the */
 258 #define DMB     mcr CP15_CP15DSB        /* same prior to v6.*/
 259 /* No form of WFI available on v4, define nothing to get an error on use. */
 260 #endif
 261
 262 #endif /* !_MACHINE_ASM_H_ */