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 /*
  73  * EENTRY()/EEND() mark "extra" entry/exit points from a function.
  74  * LEENTRY()/LEEND() are the same for local symbols.
  75  * The unwind info cannot handle the concept of a nested function, or a function
  76  * with multiple .fnstart directives, but some of our assembler code is written
  77  * with multiple labels to allow entry at several points.  The EENTRY() macro
  78  * defines such an extra entry point without a new .fnstart, so that it's
  79  * basically just a label that you can jump to.  The EEND() macro does nothing
  80  * at all, except document the exit point associated with the same-named entry.
  81  */
  82 #define GLOBAL(x)       .global x
  83
  84 #ifdef __thumb__
  85 #define _FUNC_MODE      .code 16; .thumb_func
  86 #else
  87 #define _FUNC_MODE      .code 32
  88 #endif
  89
  90 #define _LEENTRY(x)     .type x,_ASM_TYPE_FUNCTION; _FUNC_MODE; x:
  91 #define _LEEND(x)       /* nothing */
  92 #define _EENTRY(x)      GLOBAL(x); _LEENTRY(x)
  93 #define _EEND(x)        _LEEND(x)
  94
  95 #define _LENTRY(x)      .text; _ALIGN_TEXT; _LEENTRY(x); _FNSTART
  96 #define _LEND(x)        .size x, . - x; _FNEND
  97 #define _ENTRY(x)       .text; _ALIGN_TEXT; _EENTRY(x); _FNSTART
  98 #define _END(x)         _LEND(x)
  99
 100 #define ENTRY(y)        _ENTRY(_C_LABEL(y));
 101 #define EENTRY(y)       _EENTRY(_C_LABEL(y));
 102 #define ENTRY_NP(y)     _ENTRY(_C_LABEL(y))
 103 #define EENTRY_NP(y)    _EENTRY(_C_LABEL(y))
 104 #define END(y)          _END(_C_LABEL(y))
 105 #define EEND(y)         _EEND(_C_LABEL(y))
 106 #define ASENTRY(y)      _ENTRY(_ASM_LABEL(y));
 107 #define ASLENTRY(y)     _LENTRY(_ASM_LABEL(y));
 108 #define ASEENTRY(y)     _EENTRY(_ASM_LABEL(y));
 109 #define ASLEENTRY(y)    _LEENTRY(_ASM_LABEL(y));
 110 #define ASENTRY_NP(y)   _ENTRY(_ASM_LABEL(y))
 111 #define ASLENTRY_NP(y)  _LENTRY(_ASM_LABEL(y))
 112 #define ASEENTRY_NP(y)  _EENTRY(_ASM_LABEL(y))
 113 #define ASLEENTRY_NP(y) _LEENTRY(_ASM_LABEL(y))
 114 #define ASEND(y)        _END(_ASM_LABEL(y))
 115 #define ASLEND(y)       _LEND(_ASM_LABEL(y))
 116 #define ASEEND(y)       _EEND(_ASM_LABEL(y))
 117 #define ASLEEND(y)      _LEEND(_ASM_LABEL(y))
 118
 119 #define ASMSTR          .asciz
 120
 121 #if defined(PIC)
 122 #define PLT_SYM(x)      PIC_SYM(x, PLT)
 123 #define GOT_SYM(x)      PIC_SYM(x, GOT)
 124 #define GOT_GET(x,got,sym)      \
 125         ldr     x, sym;         \
 126         ldr     x, [x, got]
 127 #define GOT_INIT(got,gotsym,pclabel) \
 128         ldr     got, gotsym;    \
 129         pclabel: add    got, pc
 130 #ifdef __thumb__
 131 #define GOT_INITSYM(gotsym,pclabel) \
 132         .align 2;               \
 133         gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+4)
 134 #else
 135 #define GOT_INITSYM(gotsym,pclabel) \
 136         .align 2;               \
 137         gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+8)
 138 #endif
 139
 140 #ifdef __STDC__
 141 #define PIC_SYM(x,y)    x ## ( ## y ## )
 142 #else
 143 #define PIC_SYM(x,y)    x/**/(/**/y/**/)
 144 #endif
 145
 146 #else
 147 #define PLT_SYM(x)      x
 148 #define GOT_SYM(x)      x
 149 #define GOT_GET(x,got,sym)      \
 150         ldr     x, sym;
 151 #define GOT_INIT(got,gotsym,pclabel)
 152 #define GOT_INITSYM(gotsym,pclabel)
 153 #define PIC_SYM(x,y)    x
 154 #endif  /* PIC */
 155
 156 #undef __FBSDID
 157 #if !defined(lint) && !defined(STRIP_FBSDID)
 158 #define __FBSDID(s)     .ident s
 159 #else
 160 #define __FBSDID(s)     /* nothing */
 161 #endif
 162
 163 #define WEAK_ALIAS(alias,sym)                                           \
 164         .weak alias;                                                    \
 165         alias = sym
 166
 167 #ifdef __STDC__
 168 #define WARN_REFERENCES(sym,msg)                                        \
 169         .stabs msg ## ,30,0,0,0 ;                                       \
 170         .stabs __STRING(_C_LABEL(sym)) ## ,1,0,0,0
 171 #else
 172 #define WARN_REFERENCES(sym,msg)                                        \
 173         .stabs msg,30,0,0,0 ;                                           \
 174         .stabs __STRING(sym),1,0,0,0
 175 #endif /* __STDC__ */
 176
 177 # define RET    bx      lr
 178 # define RETeq  bxeq    lr
 179 # define RETne  bxne    lr
 180 # define RETc(c) bx##c  lr
 181
 182 #if __ARM_ARCH >= 7
 183 #define ISB     isb
 184 #define DSB     dsb
 185 #define DMB     dmb
 186 #define WFI     wfi
 187
 188 #if defined(__ARM_ARCH_7VE__) || defined(__clang__)
 189 #define MSR_ELR_HYP(regnum)     msr     elr_hyp, lr
 190 #define ERET    eret
 191 #else
 192 #define MSR_ELR_HYP(regnum) .word (0xe12ef300 | regnum)
 193 #define ERET .word 0xe160006e
 194 #endif
 195
 196 #elif __ARM_ARCH == 6
 197 #define ISB     mcr CP15_CP15ISB
 198 #define DSB     mcr CP15_CP15DSB
 199 #define DMB     mcr CP15_CP15DMB
 200 #define WFI     mcr CP15_CP15WFI
 201 #endif
 202
 203 #endif /* !_MACHINE_ASM_H_ */