sys/arm/include/asm.h

   1 /*      $NetBSD: asm.h,v 1.5 2003/08/07 16:26:53 agc Exp $      */
   2
   3 /*-
   4  * Copyright (c) 1990 The Regents of the University of California.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * William Jolitz.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      from: @(#)asm.h 5.5 (Berkeley) 5/7/91
  35  *
  36  * $FreeBSD$
  37  */
  38
  39 #ifndef _MACHINE_ASM_H_
  40 #define _MACHINE_ASM_H_
  41 #include <sys/cdefs.h>
  42 #include <machine/acle-compat.h>
  43 #include <machine/sysreg.h>
  44
  45 #define _C_LABEL(x)     x
  46 #define _ASM_LABEL(x)   x
  47
  48 #ifndef _ALIGN_TEXT
  49 # define _ALIGN_TEXT .align 2
  50 #endif
  51
  52 #if defined(__ARM_EABI__) && !defined(_STANDALONE)
  53 #define STOP_UNWINDING  .cantunwind
  54 #define _FNSTART        .fnstart
  55 #define _FNEND          .fnend
  56 #else
  57 #define STOP_UNWINDING
  58 #define _FNSTART
  59 #define _FNEND
  60 #endif
  61
  62 /*
  63  * gas/arm uses @ as a single comment character and thus cannot be used here.
  64  * It recognises the # instead of an @ symbol in .type directives.
  65  */
  66 #define _ASM_TYPE_FUNCTION      #function
  67 #define _ASM_TYPE_OBJECT        #object
  68
  69 /* XXX Is this still the right prologue for profiling? */
  70 #ifdef GPROF
  71 #define _PROF_PROLOGUE  \
  72         mov ip, lr;     \
  73         bl __mcount
  74 #else
  75 #define _PROF_PROLOGUE
  76 #endif
  77
  78 /*
  79  * EENTRY()/EEND() mark "extra" entry/exit points from a function.
  80  * LEENTRY()/LEEND() are the the same for local symbols.
  81  * The unwind info cannot handle the concept of a nested function, or a function
  82  * with multiple .fnstart directives, but some of our assembler code is written
  83  * with multiple labels to allow entry at several points.  The EENTRY() macro
  84  * defines such an extra entry point without a new .fnstart, so that it's
  85  * basically just a label that you can jump to.  The EEND() macro does nothing
  86  * at all, except document the exit point associated with the same-named entry.
  87  */
  88 #define GLOBAL(x)       .global x
  89
  90 #define _LEENTRY(x)     .type x,_ASM_TYPE_FUNCTION; 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)); _PROF_PROLOGUE
 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)); _PROF_PROLOGUE
 107 #define ASLENTRY(y)     _LENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
 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, 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
 164 #define WEAK_ALIAS(alias,sym)                                           \
 165         .weak alias;                                                    \
 166         alias = sym
 167
 168 #ifdef __STDC__
 169 #define WARN_REFERENCES(sym,msg)                                        \
 170         .stabs msg ## ,30,0,0,0 ;                                       \
 171         .stabs __STRING(_C_LABEL(sym)) ## ,1,0,0,0
 172 #else
 173 #define WARN_REFERENCES(sym,msg)                                        \
 174         .stabs msg,30,0,0,0 ;                                           \
 175         .stabs __STRING(sym),1,0,0,0
 176 #endif /* __STDC__ */
 177
 178 /* Exactly one of the __ARM_ARCH_*__ macros will be defined by the compiler. */
 179 /* The _ARM_ARCH_* macros are deprecated and will be removed soon. */
 180 /* This should be moved into another header so it can be used in
 181  * both asm and C code. machine/asm.h cannot be included in C code. */
 182 #if defined (__ARM_ARCH_7__) || defined (__ARM_ARCH_7A__)
 183 #define _ARM_ARCH_7
 184 #define _HAVE_ARMv7_INSTRUCTIONS 1
 185 #endif
 186
 187 #if defined (_HAVE_ARMv7_INSTRUCTIONS) || defined (__ARM_ARCH_6__) || \
 188         defined (__ARM_ARCH_6J__) || defined (__ARM_ARCH_6K__) || \
 189         defined (__ARM_ARCH_6Z__) || defined (__ARM_ARCH_6ZK__)
 190 #define _ARM_ARCH_6
 191 #define _HAVE_ARMv6_INSTRUCTIONS 1
 192 #endif
 193
 194 #if defined (_HAVE_ARMv6_INSTRUCTIONS) || defined (__ARM_ARCH_5TE__) || \
 195     defined (__ARM_ARCH_5TEJ__) || defined (__ARM_ARCH_5E__)
 196 #define _ARM_ARCH_5E
 197 #define _HAVE_ARMv5E_INSTRUCTIONS 1
 198 #endif
 199
 200 #if defined (_HAVE_ARMv5E_INSTRUCTIONS) || defined (__ARM_ARCH_5__) || \
 201     defined (__ARM_ARCH_5T__)
 202 #define _ARM_ARCH_5
 203 #define _HAVE_ARMv5_INSTRUCTIONS 1
 204 #endif
 205
 206 #if defined (_HAVE_ARMv5_INSTRUCTIONS) || defined (__ARM_ARCH_4T__)
 207 #define _ARM_ARCH_4T
 208 #define _HAVE_ARMv4T_INSTRUCTIONS 1
 209 #endif
 210
 211 /* FreeBSD requires ARMv4, so this is always set. */
 212 #define _HAVE_ARMv4_INSTRUCTIONS 1
 213
 214 #if defined (_HAVE_ARMv4T_INSTRUCTIONS)
 215 # define RET    bx      lr
 216 # define RETeq  bxeq    lr
 217 # define RETne  bxne    lr
 218 # define RETc(c) bx##c  lr
 219 #else
 220 # define RET    mov     pc, lr
 221 # define RETeq  moveq   pc, lr
 222 # define RETne  movne   pc, lr
 223 # define RETc(c) mov##c pc, lr
 224 #endif
 225
 226 #if __ARM_ARCH >= 7
 227 #define ISB     isb
 228 #define DSB     dsb
 229 #define DMB     dmb
 230 #define WFI     wfi
 231 #elif __ARM_ARCH == 6
 232 #define ISB     mcr CP15_CP15ISB
 233 #define DSB     mcr CP15_CP15DSB
 234 #define DMB     mcr CP15_CP15DMB
 235 #define WFI     mcr CP15_CP15WFI
 236 #else
 237 #define ISB     mcr CP15_CP15ISB
 238 #define DSB     mcr CP15_CP15DSB        /* DSB and DMB are the */
 239 #define DMB     mcr CP15_CP15DSB        /* same prior to v6.*/
 240 /* No form of WFI available on v4, define nothing to get an error on use. */
 241 #endif
 242
 243 #endif /* !_MACHINE_ASM_H_ */