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 #ifndef _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 #ifdef __thumb__
  91 #define _FUNC_MODE      .code 16; .thumb_func
  92 #else
  93 #define _FUNC_MODE      .code 32
  94 #endif
  95
  96 #define _LEENTRY(x)     .type x,_ASM_TYPE_FUNCTION; _FUNC_MODE; x:
  97 #define _LEEND(x)       /* nothing */
  98 #define _EENTRY(x)      GLOBAL(x); _LEENTRY(x)
  99 #define _EEND(x)        _LEEND(x)
 100
 101 #define _LENTRY(x)      .text; _ALIGN_TEXT; _LEENTRY(x); _FNSTART
 102 #define _LEND(x)        .size x, . - x; _FNEND
 103 #define _ENTRY(x)       .text; _ALIGN_TEXT; _EENTRY(x); _FNSTART
 104 #define _END(x)         _LEND(x)
 105
 106 #define ENTRY(y)        _ENTRY(_C_LABEL(y)); _PROF_PROLOGUE
 107 #define EENTRY(y)       _EENTRY(_C_LABEL(y));
 108 #define ENTRY_NP(y)     _ENTRY(_C_LABEL(y))
 109 #define EENTRY_NP(y)    _EENTRY(_C_LABEL(y))
 110 #define END(y)          _END(_C_LABEL(y))
 111 #define EEND(y)         _EEND(_C_LABEL(y))
 112 #define ASENTRY(y)      _ENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
 113 #define ASLENTRY(y)     _LENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
 114 #define ASEENTRY(y)     _EENTRY(_ASM_LABEL(y));
 115 #define ASLEENTRY(y)    _LEENTRY(_ASM_LABEL(y));
 116 #define ASENTRY_NP(y)   _ENTRY(_ASM_LABEL(y))
 117 #define ASLENTRY_NP(y)  _LENTRY(_ASM_LABEL(y))
 118 #define ASEENTRY_NP(y)  _EENTRY(_ASM_LABEL(y))
 119 #define ASLEENTRY_NP(y) _LEENTRY(_ASM_LABEL(y))
 120 #define ASEND(y)        _END(_ASM_LABEL(y))
 121 #define ASLEND(y)       _LEND(_ASM_LABEL(y))
 122 #define ASEEND(y)       _EEND(_ASM_LABEL(y))
 123 #define ASLEEND(y)      _LEEND(_ASM_LABEL(y))
 124
 125 #define ASMSTR          .asciz
 126
 127 #if defined(PIC)
 128 #define PLT_SYM(x)      PIC_SYM(x, PLT)
 129 #define GOT_SYM(x)      PIC_SYM(x, GOT)
 130 #define GOT_GET(x,got,sym)      \
 131         ldr     x, sym;         \
 132         ldr     x, [x, got]
 133 #define GOT_INIT(got,gotsym,pclabel) \
 134         ldr     got, gotsym;    \
 135         pclabel: add    got, pc
 136 #ifdef __thumb__
 137 #define GOT_INITSYM(gotsym,pclabel) \
 138         .align 2;               \
 139         gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+4)
 140 #else
 141 #define GOT_INITSYM(gotsym,pclabel) \
 142         .align 2;               \
 143         gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+8)
 144 #endif
 145
 146 #ifdef __STDC__
 147 #define PIC_SYM(x,y)    x ## ( ## y ## )
 148 #else
 149 #define PIC_SYM(x,y)    x/**/(/**/y/**/)
 150 #endif
 151
 152 #else
 153 #define PLT_SYM(x)      x
 154 #define GOT_SYM(x)      x
 155 #define GOT_GET(x,got,sym)      \
 156         ldr     x, sym;
 157 #define GOT_INIT(got,gotsym,pclabel)
 158 #define GOT_INITSYM(gotsym,pclabel)
 159 #define PIC_SYM(x,y)    x
 160 #endif  /* PIC */
 161
 162 #undef __FBSDID
 163 #if !defined(lint) && !defined(STRIP_FBSDID)
 164 #define __FBSDID(s)     .ident s
 165 #else
 166 #define __FBSDID(s)     /* nothing */
 167 #endif
 168
 169
 170 #define WEAK_ALIAS(alias,sym)                                           \
 171         .weak alias;                                                    \
 172         alias = sym
 173
 174 #ifdef __STDC__
 175 #define WARN_REFERENCES(sym,msg)                                        \
 176         .stabs msg ## ,30,0,0,0 ;                                       \
 177         .stabs __STRING(_C_LABEL(sym)) ## ,1,0,0,0
 178 #else
 179 #define WARN_REFERENCES(sym,msg)                                        \
 180         .stabs msg,30,0,0,0 ;                                           \
 181         .stabs __STRING(sym),1,0,0,0
 182 #endif /* __STDC__ */
 183
 184 /* Exactly one of the __ARM_ARCH_*__ macros will be defined by the compiler. */
 185 /* The _ARM_ARCH_* macros are deprecated and will be removed soon. */
 186 /* This should be moved into another header so it can be used in
 187  * both asm and C code. machine/asm.h cannot be included in C code. */
 188 #if defined (__ARM_ARCH_7__) || defined (__ARM_ARCH_7A__)
 189 #define _ARM_ARCH_7
 190 #define _HAVE_ARMv7_INSTRUCTIONS 1
 191 #endif
 192
 193 #if defined (_HAVE_ARMv7_INSTRUCTIONS) || defined (__ARM_ARCH_6__) || \
 194         defined (__ARM_ARCH_6J__) || defined (__ARM_ARCH_6K__) || \
 195         defined (__ARM_ARCH_6Z__) || defined (__ARM_ARCH_6ZK__)
 196 #define _ARM_ARCH_6
 197 #define _HAVE_ARMv6_INSTRUCTIONS 1
 198 #endif
 199
 200 #if defined (_HAVE_ARMv6_INSTRUCTIONS) || defined (__ARM_ARCH_5TE__) || \
 201     defined (__ARM_ARCH_5TEJ__) || defined (__ARM_ARCH_5E__)
 202 #define _ARM_ARCH_5E
 203 #define _HAVE_ARMv5E_INSTRUCTIONS 1
 204 #endif
 205
 206 #if defined (_HAVE_ARMv5E_INSTRUCTIONS) || defined (__ARM_ARCH_5__) || \
 207     defined (__ARM_ARCH_5T__)
 208 #define _ARM_ARCH_5
 209 #define _HAVE_ARMv5_INSTRUCTIONS 1
 210 #endif
 211
 212 #if defined (_HAVE_ARMv5_INSTRUCTIONS) || defined (__ARM_ARCH_4T__)
 213 #define _ARM_ARCH_4T
 214 #define _HAVE_ARMv4T_INSTRUCTIONS 1
 215 #endif
 216
 217 /* FreeBSD requires ARMv4, so this is always set. */
 218 #define _HAVE_ARMv4_INSTRUCTIONS 1
 219
 220 #if defined (_HAVE_ARMv4T_INSTRUCTIONS)
 221 # define RET    bx      lr
 222 # define RETeq  bxeq    lr
 223 # define RETne  bxne    lr
 224 # define RETc(c) bx##c  lr
 225 #else
 226 # define RET    mov     pc, lr
 227 # define RETeq  moveq   pc, lr
 228 # define RETne  movne   pc, lr
 229 # define RETc(c) mov##c pc, lr
 230 #endif
 231
 232 #if __ARM_ARCH >= 7
 233 #define ISB     isb
 234 #define DSB     dsb
 235 #define DMB     dmb
 236 #define WFI     wfi
 237 #elif __ARM_ARCH == 6
 238 #define ISB     mcr CP15_CP15ISB
 239 #define DSB     mcr CP15_CP15DSB
 240 #define DMB     mcr CP15_CP15DMB
 241 #define WFI     mcr CP15_CP15WFI
 242 #else
 243 #define ISB     mcr CP15_CP15ISB
 244 #define DSB     mcr CP15_CP15DSB        /* DSB and DMB are the */
 245 #define DMB     mcr CP15_CP15DSB        /* same prior to v6.*/
 246 /* No form of WFI available on v4, define nothing to get an error on use. */
 247 #endif
 248
 249 #endif /* !_MACHINE_ASM_H_ */