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/sysreg.h>
  43
  44 #define _C_LABEL(x)     x
  45 #define _ASM_LABEL(x)   x
  46
  47 #ifndef _ALIGN_TEXT
  48 # define _ALIGN_TEXT .align 2
  49 #endif
  50
  51 #ifndef _STANDALONE
  52 #define STOP_UNWINDING  .cantunwind
  53 #define _FNSTART        .fnstart
  54 #define _FNEND          .fnend
  55 #define _SAVE(...)      .save __VA_ARGS__
  56 #else
  57 #define STOP_UNWINDING
  58 #define _FNSTART
  59 #define _FNEND
  60 #define _SAVE(...)
  61 #endif
  62
  63 /*
  64  * gas/arm uses @ as a single comment character and thus cannot be used here.
  65  * It recognises the # instead of an @ symbol in .type directives.
  66  */
  67 #define _ASM_TYPE_FUNCTION      #function
  68 #define _ASM_TYPE_OBJECT        #object
  69
  70 /* XXX Is this still the right prologue for profiling? */
  71 #ifdef GPROF
  72 #define _PROF_PROLOGUE  \
  73         mov ip, lr;     \
  74         bl __mcount
  75 #else
  76 #define _PROF_PROLOGUE
  77 #endif
  78
  79 /*
  80  * EENTRY()/EEND() mark "extra" entry/exit points from a function.
  81  * LEENTRY()/LEEND() are the same for local symbols.
  82  * The unwind info cannot handle the concept of a nested function, or a function
  83  * with multiple .fnstart directives, but some of our assembler code is written
  84  * with multiple labels to allow entry at several points.  The EENTRY() macro
  85  * defines such an extra entry point without a new .fnstart, so that it's
  86  * basically just a label that you can jump to.  The EEND() macro does nothing
  87  * at all, except document the exit point associated with the same-named entry.
  88  */
  89 #define GLOBAL(x)       .global x
  90
  91 #ifdef __thumb__
  92 #define _FUNC_MODE      .code 16; .thumb_func
  93 #else
  94 #define _FUNC_MODE      .code 32
  95 #endif
  96
  97 #define _LEENTRY(x)     .type x,_ASM_TYPE_FUNCTION; _FUNC_MODE; x:
  98 #define _LEEND(x)       /* nothing */
  99 #define _EENTRY(x)      GLOBAL(x); _LEENTRY(x)
 100 #define _EEND(x)        _LEEND(x)
 101
 102 #define _LENTRY(x)      .text; _ALIGN_TEXT; _LEENTRY(x); _FNSTART
 103 #define _LEND(x)        .size x, . - x; _FNEND
 104 #define _ENTRY(x)       .text; _ALIGN_TEXT; _EENTRY(x); _FNSTART
 105 #define _END(x)         _LEND(x)
 106
 107 #define ENTRY(y)        _ENTRY(_C_LABEL(y)); _PROF_PROLOGUE
 108 #define EENTRY(y)       _EENTRY(_C_LABEL(y));
 109 #define ENTRY_NP(y)     _ENTRY(_C_LABEL(y))
 110 #define EENTRY_NP(y)    _EENTRY(_C_LABEL(y))
 111 #define END(y)          _END(_C_LABEL(y))
 112 #define EEND(y)         _EEND(_C_LABEL(y))
 113 #define ASENTRY(y)      _ENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
 114 #define ASLENTRY(y)     _LENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
 115 #define ASEENTRY(y)     _EENTRY(_ASM_LABEL(y));
 116 #define ASLEENTRY(y)    _LEENTRY(_ASM_LABEL(y));
 117 #define ASENTRY_NP(y)   _ENTRY(_ASM_LABEL(y))
 118 #define ASLENTRY_NP(y)  _LENTRY(_ASM_LABEL(y))
 119 #define ASEENTRY_NP(y)  _EENTRY(_ASM_LABEL(y))
 120 #define ASLEENTRY_NP(y) _LEENTRY(_ASM_LABEL(y))
 121 #define ASEND(y)        _END(_ASM_LABEL(y))
 122 #define ASLEND(y)       _LEND(_ASM_LABEL(y))
 123 #define ASEEND(y)       _EEND(_ASM_LABEL(y))
 124 #define ASLEEND(y)      _LEEND(_ASM_LABEL(y))
 125
 126 #define ASMSTR          .asciz
 127
 128 #if defined(PIC)
 129 #define PLT_SYM(x)      PIC_SYM(x, PLT)
 130 #define GOT_SYM(x)      PIC_SYM(x, GOT)
 131 #define GOT_GET(x,got,sym)      \
 132         ldr     x, sym;         \
 133         ldr     x, [x, got]
 134 #define GOT_INIT(got,gotsym,pclabel) \
 135         ldr     got, gotsym;    \
 136         pclabel: add    got, pc
 137 #ifdef __thumb__
 138 #define GOT_INITSYM(gotsym,pclabel) \
 139         .align 2;               \
 140         gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+4)
 141 #else
 142 #define GOT_INITSYM(gotsym,pclabel) \
 143         .align 2;               \
 144         gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+8)
 145 #endif
 146
 147 #ifdef __STDC__
 148 #define PIC_SYM(x,y)    x ## ( ## y ## )
 149 #else
 150 #define PIC_SYM(x,y)    x/**/(/**/y/**/)
 151 #endif
 152
 153 #else
 154 #define PLT_SYM(x)      x
 155 #define GOT_SYM(x)      x
 156 #define GOT_GET(x,got,sym)      \
 157         ldr     x, sym;
 158 #define GOT_INIT(got,gotsym,pclabel)
 159 #define GOT_INITSYM(gotsym,pclabel)
 160 #define PIC_SYM(x,y)    x
 161 #endif  /* PIC */
 162
 163 #undef __FBSDID
 164 #if !defined(lint) && !defined(STRIP_FBSDID)
 165 #define __FBSDID(s)     .ident s
 166 #else
 167 #define __FBSDID(s)     /* nothing */
 168 #endif
 169
 170
 171 #define WEAK_ALIAS(alias,sym)                                           \
 172         .weak alias;                                                    \
 173         alias = sym
 174
 175 #ifdef __STDC__
 176 #define WARN_REFERENCES(sym,msg)                                        \
 177         .stabs msg ## ,30,0,0,0 ;                                       \
 178         .stabs __STRING(_C_LABEL(sym)) ## ,1,0,0,0
 179 #else
 180 #define WARN_REFERENCES(sym,msg)                                        \
 181         .stabs msg,30,0,0,0 ;                                           \
 182         .stabs __STRING(sym),1,0,0,0
 183 #endif /* __STDC__ */
 184
 185 /* Exactly one of the __ARM_ARCH_*__ macros will be defined by the compiler. */
 186 /* The _ARM_ARCH_* macros are deprecated and will be removed soon. */
 187 /* This should be moved into another header so it can be used in
 188  * both asm and C code. machine/asm.h cannot be included in C code. */
 189 #if defined (__ARM_ARCH_7__) || defined (__ARM_ARCH_7A__)
 190 #define _ARM_ARCH_7
 191 #define _HAVE_ARMv7_INSTRUCTIONS 1
 192 #endif
 193
 194 #if defined (_HAVE_ARMv7_INSTRUCTIONS) || defined (__ARM_ARCH_6__) || \
 195         defined (__ARM_ARCH_6J__) || defined (__ARM_ARCH_6K__) || \
 196         defined (__ARM_ARCH_6Z__) || defined (__ARM_ARCH_6ZK__)
 197 #define _ARM_ARCH_6
 198 #define _HAVE_ARMv6_INSTRUCTIONS 1
 199 #endif
 200
 201 #if defined (_HAVE_ARMv6_INSTRUCTIONS) || defined (__ARM_ARCH_5TE__) || \
 202     defined (__ARM_ARCH_5TEJ__) || defined (__ARM_ARCH_5E__)
 203 #define _ARM_ARCH_5E
 204 #define _HAVE_ARMv5E_INSTRUCTIONS 1
 205 #endif
 206
 207 #if defined (_HAVE_ARMv5E_INSTRUCTIONS) || defined (__ARM_ARCH_5__) || \
 208     defined (__ARM_ARCH_5T__)
 209 #define _ARM_ARCH_5
 210 #define _HAVE_ARMv5_INSTRUCTIONS 1
 211 #endif
 212
 213 #if defined (_HAVE_ARMv5_INSTRUCTIONS) || defined (__ARM_ARCH_4T__)
 214 #define _ARM_ARCH_4T
 215 #define _HAVE_ARMv4T_INSTRUCTIONS 1
 216 #endif
 217
 218 /* FreeBSD requires ARMv4, so this is always set. */
 219 #define _HAVE_ARMv4_INSTRUCTIONS 1
 220
 221 #if defined (_HAVE_ARMv4T_INSTRUCTIONS)
 222 # define RET    bx      lr
 223 # define RETeq  bxeq    lr
 224 # define RETne  bxne    lr
 225 # define RETc(c) bx##c  lr
 226 #else
 227 # define RET    mov     pc, lr
 228 # define RETeq  moveq   pc, lr
 229 # define RETne  movne   pc, lr
 230 # define RETc(c) mov##c pc, lr
 231 #endif
 232
 233 #if __ARM_ARCH >= 7
 234 #define ISB     isb
 235 #define DSB     dsb
 236 #define DMB     dmb
 237 #define WFI     wfi
 238 #elif __ARM_ARCH == 6
 239 #define ISB     mcr CP15_CP15ISB
 240 #define DSB     mcr CP15_CP15DSB
 241 #define DMB     mcr CP15_CP15DMB
 242 #define WFI     mcr CP15_CP15WFI
 243 #else
 244 #define ISB     mcr CP15_CP15ISB
 245 #define DSB     mcr CP15_CP15DSB        /* DSB and DMB are the */
 246 #define DMB     mcr CP15_CP15DSB        /* same prior to v6.*/
 247 /* No form of WFI available on v4, define nothing to get an error on use. */
 248 #endif
 249
 250 #endif /* !_MACHINE_ASM_H_ */