]> begriffs open source - cmsis/blob - CMSIS/Core_A/Include/cmsis_armclang.h
CMSIS-DSP: New testing framework
[cmsis] / CMSIS / Core_A / Include / cmsis_armclang.h
1 /**************************************************************************//**
2  * @file     cmsis_armclang.h
3  * @brief    CMSIS compiler specific macros, functions, instructions
4  * @version  V1.1.1
5  * @date     15. May 2019
6  ******************************************************************************/
7 /*
8  * Copyright (c) 2009-2019 Arm Limited. All rights reserved.
9  *
10  * SPDX-License-Identifier: Apache-2.0
11  *
12  * Licensed under the Apache License, Version 2.0 (the License); you may
13  * not use this file except in compliance with the License.
14  * You may obtain a copy of the License at
15  *
16  * www.apache.org/licenses/LICENSE-2.0
17  *
18  * Unless required by applicable law or agreed to in writing, software
19  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
20  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21  * See the License for the specific language governing permissions and
22  * limitations under the License.
23  */
24
25 #ifndef __CMSIS_ARMCLANG_H
26 #define __CMSIS_ARMCLANG_H
27
28 #pragma clang system_header   /* treat file as system include file */
29
30 #ifndef __ARM_COMPAT_H
31 #include <arm_compat.h>    /* Compatibility header for Arm Compiler 5 intrinsics */
32 #endif
33
34 /* CMSIS compiler specific defines */
35 #ifndef   __ASM
36   #define __ASM                                  __asm
37 #endif
38 #ifndef   __INLINE
39   #define __INLINE                               __inline
40 #endif
41 #ifndef   __FORCEINLINE
42   #define __FORCEINLINE                          __attribute__((always_inline))
43 #endif
44 #ifndef   __STATIC_INLINE
45   #define __STATIC_INLINE                        static __inline
46 #endif
47 #ifndef   __STATIC_FORCEINLINE
48   #define __STATIC_FORCEINLINE                   __attribute__((always_inline)) static __inline
49 #endif
50 #ifndef   __NO_RETURN
51   #define __NO_RETURN                            __attribute__((__noreturn__))
52 #endif
53 #ifndef   CMSIS_DEPRECATED
54   #define CMSIS_DEPRECATED                       __attribute__((deprecated))
55 #endif
56 #ifndef   __USED
57   #define __USED                                 __attribute__((used))
58 #endif
59 #ifndef   __WEAK
60   #define __WEAK                                 __attribute__((weak))
61 #endif
62 #ifndef   __PACKED
63   #define __PACKED                               __attribute__((packed, aligned(1)))
64 #endif
65 #ifndef   __PACKED_STRUCT
66   #define __PACKED_STRUCT                        struct __attribute__((packed, aligned(1)))
67 #endif
68 #ifndef   __UNALIGNED_UINT16_WRITE
69   #pragma clang diagnostic push
70   #pragma clang diagnostic ignored "-Wpacked"
71 /*lint -esym(9058, T_UINT16_WRITE)*/ /* disable MISRA 2012 Rule 2.4 for T_UINT16_WRITE */
72   __PACKED_STRUCT T_UINT16_WRITE { uint16_t v; };
73   #pragma clang diagnostic pop
74   #define __UNALIGNED_UINT16_WRITE(addr, val)    (void)((((struct T_UINT16_WRITE *)(void *)(addr))->v) = (val))
75 #endif
76 #ifndef   __UNALIGNED_UINT16_READ
77   #pragma clang diagnostic push
78   #pragma clang diagnostic ignored "-Wpacked"
79 /*lint -esym(9058, T_UINT16_READ)*/ /* disable MISRA 2012 Rule 2.4 for T_UINT16_READ */
80   __PACKED_STRUCT T_UINT16_READ { uint16_t v; };
81   #pragma clang diagnostic pop
82   #define __UNALIGNED_UINT16_READ(addr)          (((const struct T_UINT16_READ *)(const void *)(addr))->v)
83 #endif
84 #ifndef   __UNALIGNED_UINT32_WRITE
85   #pragma clang diagnostic push
86   #pragma clang diagnostic ignored "-Wpacked"
87 /*lint -esym(9058, T_UINT32_WRITE)*/ /* disable MISRA 2012 Rule 2.4 for T_UINT32_WRITE */
88   __PACKED_STRUCT T_UINT32_WRITE { uint32_t v; };
89   #pragma clang diagnostic pop
90   #define __UNALIGNED_UINT32_WRITE(addr, val)    (void)((((struct T_UINT32_WRITE *)(void *)(addr))->v) = (val))
91 #endif
92 #ifndef   __UNALIGNED_UINT32_READ
93   #pragma clang diagnostic push
94   #pragma clang diagnostic ignored "-Wpacked"
95   __PACKED_STRUCT T_UINT32_READ { uint32_t v; };
96   #pragma clang diagnostic pop
97   #define __UNALIGNED_UINT32_READ(addr)          (((const struct T_UINT32_READ *)(const void *)(addr))->v)
98 #endif
99 #ifndef   __ALIGNED
100   #define __ALIGNED(x)                           __attribute__((aligned(x)))
101 #endif
102 #ifndef   __PACKED
103   #define __PACKED                               __attribute__((packed))
104 #endif
105 #ifndef   __COMPILER_BARRIER
106   #define __COMPILER_BARRIER()                   __ASM volatile("":::"memory")
107 #endif
108
109 /* ##########################  Core Instruction Access  ######################### */
110 /**
111   \brief   No Operation
112  */
113 #define __NOP                             __builtin_arm_nop
114
115 /**
116   \brief   Wait For Interrupt
117  */
118 #define __WFI                             __builtin_arm_wfi
119
120 /**
121   \brief   Wait For Event
122  */
123 #define __WFE                             __builtin_arm_wfe
124
125 /**
126   \brief   Send Event
127  */
128 #define __SEV                             __builtin_arm_sev
129
130 /**
131   \brief   Instruction Synchronization Barrier
132  */
133 #define __ISB() do {\
134                    __schedule_barrier();\
135                    __builtin_arm_isb(0xF);\
136                    __schedule_barrier();\
137                 } while (0U)
138
139 /**
140   \brief   Data Synchronization Barrier
141  */
142 #define __DSB() do {\
143                    __schedule_barrier();\
144                    __builtin_arm_dsb(0xF);\
145                    __schedule_barrier();\
146                 } while (0U)
147
148 /**
149   \brief   Data Memory Barrier
150  */
151 #define __DMB() do {\
152                    __schedule_barrier();\
153                    __builtin_arm_dmb(0xF);\
154                    __schedule_barrier();\
155                 } while (0U)
156
157 /**
158   \brief   Reverse byte order (32 bit)
159   \details Reverses the byte order in unsigned integer value. For example, 0x12345678 becomes 0x78563412.
160   \param [in]    value  Value to reverse
161   \return               Reversed value
162  */
163 #define __REV(value)   __builtin_bswap32(value)
164
165 /**
166   \brief   Reverse byte order (16 bit)
167   \details Reverses the byte order within each halfword of a word. For example, 0x12345678 becomes 0x34127856.
168   \param [in]    value  Value to reverse
169   \return               Reversed value
170  */
171 #define __REV16(value) __ROR(__REV(value), 16)
172
173
174 /**
175   \brief   Reverse byte order (16 bit)
176   \details Reverses the byte order in a 16-bit value and returns the signed 16-bit result. For example, 0x0080 becomes 0x8000.
177   \param [in]    value  Value to reverse
178   \return               Reversed value
179  */
180 #define __REVSH(value) (int16_t)__builtin_bswap16(value)
181
182
183 /**
184   \brief   Rotate Right in unsigned value (32 bit)
185   \details Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits.
186   \param [in]    op1  Value to rotate
187   \param [in]    op2  Number of Bits to rotate
188   \return               Rotated value
189  */
190 __STATIC_FORCEINLINE uint32_t __ROR(uint32_t op1, uint32_t op2)
191 {
192   op2 %= 32U;
193   if (op2 == 0U)
194   {
195     return op1;
196   }
197   return (op1 >> op2) | (op1 << (32U - op2));
198 }
199
200
201 /**
202   \brief   Breakpoint
203   \param [in]    value  is ignored by the processor.
204                  If required, a debugger can use it to store additional information about the breakpoint.
205  */
206 #define __BKPT(value)   __ASM volatile ("bkpt "#value)
207
208 /**
209   \brief   Reverse bit order of value
210   \param [in]    value  Value to reverse
211   \return               Reversed value
212  */
213 #define __RBIT          __builtin_arm_rbit
214
215 /**
216   \brief   Count leading zeros
217   \param [in]  value  Value to count the leading zeros
218   \return             number of leading zeros in value
219  */
220 __STATIC_FORCEINLINE uint8_t __CLZ(uint32_t value)
221 {
222   /* Even though __builtin_clz produces a CLZ instruction on ARM, formally
223      __builtin_clz(0) is undefined behaviour, so handle this case specially.
224      This guarantees ARM-compatible results if happening to compile on a non-ARM
225      target, and ensures the compiler doesn't decide to activate any
226      optimisations using the logic "value was passed to __builtin_clz, so it
227      is non-zero".
228      ARM Compiler 6.10 and possibly earlier will optimise this test away, leaving a
229      single CLZ instruction.
230    */
231   if (value == 0U)
232   {
233     return 32U;
234   }
235   return __builtin_clz(value);
236 }
237
238 /**
239   \brief   LDR Exclusive (8 bit)
240   \details Executes a exclusive LDR instruction for 8 bit value.
241   \param [in]    ptr  Pointer to data
242   \return             value of type uint8_t at (*ptr)
243  */
244 #define __LDREXB        (uint8_t)__builtin_arm_ldrex
245
246
247 /**
248   \brief   LDR Exclusive (16 bit)
249   \details Executes a exclusive LDR instruction for 16 bit values.
250   \param [in]    ptr  Pointer to data
251   \return        value of type uint16_t at (*ptr)
252  */
253 #define __LDREXH        (uint16_t)__builtin_arm_ldrex
254
255 /**
256   \brief   LDR Exclusive (32 bit)
257   \details Executes a exclusive LDR instruction for 32 bit values.
258   \param [in]    ptr  Pointer to data
259   \return        value of type uint32_t at (*ptr)
260  */
261 #define __LDREXW        (uint32_t)__builtin_arm_ldrex
262
263 /**
264   \brief   STR Exclusive (8 bit)
265   \details Executes a exclusive STR instruction for 8 bit values.
266   \param [in]  value  Value to store
267   \param [in]    ptr  Pointer to location
268   \return          0  Function succeeded
269   \return          1  Function failed
270  */
271 #define __STREXB        (uint32_t)__builtin_arm_strex
272
273 /**
274   \brief   STR Exclusive (16 bit)
275   \details Executes a exclusive STR instruction for 16 bit values.
276   \param [in]  value  Value to store
277   \param [in]    ptr  Pointer to location
278   \return          0  Function succeeded
279   \return          1  Function failed
280  */
281 #define __STREXH        (uint32_t)__builtin_arm_strex
282
283 /**
284   \brief   STR Exclusive (32 bit)
285   \details Executes a exclusive STR instruction for 32 bit values.
286   \param [in]  value  Value to store
287   \param [in]    ptr  Pointer to location
288   \return          0  Function succeeded
289   \return          1  Function failed
290  */
291 #define __STREXW        (uint32_t)__builtin_arm_strex
292
293 /**
294   \brief   Remove the exclusive lock
295   \details Removes the exclusive lock which is created by LDREX.
296  */
297 #define __CLREX             __builtin_arm_clrex
298
299 /**
300   \brief   Signed Saturate
301   \details Saturates a signed value.
302   \param [in]  value  Value to be saturated
303   \param [in]    sat  Bit position to saturate to (1..32)
304   \return             Saturated value
305  */
306 #define __SSAT             __builtin_arm_ssat
307
308 /**
309   \brief   Unsigned Saturate
310   \details Saturates an unsigned value.
311   \param [in]  value  Value to be saturated
312   \param [in]    sat  Bit position to saturate to (0..31)
313   \return             Saturated value
314  */
315 #define __USAT             __builtin_arm_usat
316
317 /* ###################  Compiler specific Intrinsics  ########################### */
318 /** \defgroup CMSIS_SIMD_intrinsics CMSIS SIMD Intrinsics
319   Access to dedicated SIMD instructions
320   @{
321 */
322
323 #if (defined (__ARM_FEATURE_DSP) && (__ARM_FEATURE_DSP == 1))
324
325 #define     __SADD8                 __builtin_arm_sadd8
326 #define     __SADD16                __builtin_arm_sadd16
327 #define     __QADD8                 __builtin_arm_qadd8
328 #define     __QSUB8                 __builtin_arm_qsub8
329 #define     __QADD16                __builtin_arm_qadd16
330 #define     __SHADD16               __builtin_arm_shadd16
331 #define     __QSUB16                __builtin_arm_qsub16
332 #define     __SHSUB16               __builtin_arm_shsub16
333 #define     __QASX                  __builtin_arm_qasx
334 #define     __SHASX                 __builtin_arm_shasx
335 #define     __QSAX                  __builtin_arm_qsax
336 #define     __SHSAX                 __builtin_arm_shsax
337 #define     __SXTB16                __builtin_arm_sxtb16
338 #define     __SMUAD                 __builtin_arm_smuad
339 #define     __SMUADX                __builtin_arm_smuadx
340 #define     __SMLAD                 __builtin_arm_smlad
341 #define     __SMLADX                __builtin_arm_smladx
342 #define     __SMLALD                __builtin_arm_smlald
343 #define     __SMLALDX               __builtin_arm_smlaldx
344 #define     __SMUSD                 __builtin_arm_smusd
345 #define     __SMUSDX                __builtin_arm_smusdx
346 #define     __SMLSDX                __builtin_arm_smlsdx
347
348
349
350 __STATIC_FORCEINLINE  int32_t __QADD( int32_t op1,  int32_t op2)
351 {
352   int32_t result;
353
354   __ASM volatile ("qadd %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
355   return(result);
356 }
357
358 __STATIC_FORCEINLINE  int32_t __QSUB( int32_t op1,  int32_t op2)
359 {
360   int32_t result;
361
362   __ASM volatile ("qsub %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
363   return(result);
364 }
365
366 #define __PKHBT(ARG1,ARG2,ARG3)          ( ((((uint32_t)(ARG1))          ) & 0x0000FFFFUL) |  \
367                                            ((((uint32_t)(ARG2)) << (ARG3)) & 0xFFFF0000UL)  )
368
369 #define __PKHTB(ARG1,ARG2,ARG3)          ( ((((uint32_t)(ARG1))          ) & 0xFFFF0000UL) |  \
370                                            ((((uint32_t)(ARG2)) >> (ARG3)) & 0x0000FFFFUL)  )
371
372 __STATIC_FORCEINLINE int32_t __SMMLA (int32_t op1, int32_t op2, int32_t op3)
373 {
374   int32_t result;
375
376   __ASM volatile ("smmla %0, %1, %2, %3" : "=r" (result): "r"  (op1), "r" (op2), "r" (op3) );
377   return(result);
378 }
379
380 #endif /* (__ARM_FEATURE_DSP == 1) */
381
382 /* ###########################  Core Function Access  ########################### */
383
384 /**
385   \brief   Get FPSCR
386   \details Returns the current value of the Floating Point Status/Control register.
387   \return               Floating Point Status/Control register value
388  */
389 #define __get_FPSCR      __builtin_arm_get_fpscr
390
391 /**
392   \brief   Set FPSCR
393   \details Assigns the given value to the Floating Point Status/Control register.
394   \param [in]    fpscr  Floating Point Status/Control value to set
395  */
396 #define __set_FPSCR      __builtin_arm_set_fpscr
397
398 /** \brief  Get CPSR Register
399     \return               CPSR Register value
400  */
401 __STATIC_FORCEINLINE uint32_t __get_CPSR(void)
402 {
403   uint32_t result;
404   __ASM volatile("MRS %0, cpsr" : "=r" (result) );
405   return(result);
406 }
407
408 /** \brief  Set CPSR Register
409     \param [in]    cpsr  CPSR value to set
410  */
411 __STATIC_FORCEINLINE void __set_CPSR(uint32_t cpsr)
412 {
413 __ASM volatile ("MSR cpsr, %0" : : "r" (cpsr) : "memory");
414 }
415
416 /** \brief  Get Mode
417     \return                Processor Mode
418  */
419 __STATIC_FORCEINLINE uint32_t __get_mode(void)
420 {
421         return (__get_CPSR() & 0x1FU);
422 }
423
424 /** \brief  Set Mode
425     \param [in]    mode  Mode value to set
426  */
427 __STATIC_FORCEINLINE void __set_mode(uint32_t mode)
428 {
429   __ASM volatile("MSR  cpsr_c, %0" : : "r" (mode) : "memory");
430 }
431
432 /** \brief  Get Stack Pointer
433     \return Stack Pointer value
434  */
435 __STATIC_FORCEINLINE uint32_t __get_SP()
436 {
437   uint32_t result;
438   __ASM volatile("MOV  %0, sp" : "=r" (result) : : "memory");
439   return result;
440 }
441
442 /** \brief  Set Stack Pointer
443     \param [in]    stack  Stack Pointer value to set
444  */
445 __STATIC_FORCEINLINE void __set_SP(uint32_t stack)
446 {
447   __ASM volatile("MOV  sp, %0" : : "r" (stack) : "memory");
448 }
449
450 /** \brief  Get USR/SYS Stack Pointer
451     \return USR/SYS Stack Pointer value
452  */
453 __STATIC_FORCEINLINE uint32_t __get_SP_usr()
454 {
455   uint32_t cpsr;
456   uint32_t result;
457   __ASM volatile(
458     "MRS     %0, cpsr   \n"
459     "CPS     #0x1F      \n" // no effect in USR mode
460     "MOV     %1, sp     \n"
461     "MSR     cpsr_c, %0 \n" // no effect in USR mode
462     "ISB" :  "=r"(cpsr), "=r"(result) : : "memory"
463    );
464   return result;
465 }
466
467 /** \brief  Set USR/SYS Stack Pointer
468     \param [in]    topOfProcStack  USR/SYS Stack Pointer value to set
469  */
470 __STATIC_FORCEINLINE void __set_SP_usr(uint32_t topOfProcStack)
471 {
472   uint32_t cpsr;
473   __ASM volatile(
474     "MRS     %0, cpsr   \n"
475     "CPS     #0x1F      \n" // no effect in USR mode
476     "MOV     sp, %1     \n"
477     "MSR     cpsr_c, %0 \n" // no effect in USR mode
478     "ISB" : "=r"(cpsr) : "r" (topOfProcStack) : "memory"
479    );
480 }
481
482 /** \brief  Get FPEXC
483     \return               Floating Point Exception Control register value
484  */
485 __STATIC_FORCEINLINE uint32_t __get_FPEXC(void)
486 {
487 #if (__FPU_PRESENT == 1)
488   uint32_t result;
489   __ASM volatile("VMRS %0, fpexc" : "=r" (result) : : "memory");
490   return(result);
491 #else
492   return(0);
493 #endif
494 }
495
496 /** \brief  Set FPEXC
497     \param [in]    fpexc  Floating Point Exception Control value to set
498  */
499 __STATIC_FORCEINLINE void __set_FPEXC(uint32_t fpexc)
500 {
501 #if (__FPU_PRESENT == 1)
502   __ASM volatile ("VMSR fpexc, %0" : : "r" (fpexc) : "memory");
503 #endif
504 }
505
506 /*
507  * Include common core functions to access Coprocessor 15 registers
508  */
509
510 #define __get_CP(cp, op1, Rt, CRn, CRm, op2) __ASM volatile("MRC p" # cp ", " # op1 ", %0, c" # CRn ", c" # CRm ", " # op2 : "=r" (Rt) : : "memory" )
511 #define __set_CP(cp, op1, Rt, CRn, CRm, op2) __ASM volatile("MCR p" # cp ", " # op1 ", %0, c" # CRn ", c" # CRm ", " # op2 : : "r" (Rt) : "memory" )
512 #define __get_CP64(cp, op1, Rt, CRm)         __ASM volatile("MRRC p" # cp ", " # op1 ", %Q0, %R0, c" # CRm  : "=r" (Rt) : : "memory" )
513 #define __set_CP64(cp, op1, Rt, CRm)         __ASM volatile("MCRR p" # cp ", " # op1 ", %Q0, %R0, c" # CRm  : : "r" (Rt) : "memory" )
514
515 #include "cmsis_cp15.h"
516
517 /** \brief  Enable Floating Point Unit
518
519   Critical section, called from undef handler, so systick is disabled
520  */
521 __STATIC_INLINE void __FPU_Enable(void)
522 {
523   __ASM volatile(
524     //Permit access to VFP/NEON, registers by modifying CPACR
525     "        MRC     p15,0,R1,c1,c0,2  \n"
526     "        ORR     R1,R1,#0x00F00000 \n"
527     "        MCR     p15,0,R1,c1,c0,2  \n"
528
529     //Ensure that subsequent instructions occur in the context of VFP/NEON access permitted
530     "        ISB                       \n"
531
532     //Enable VFP/NEON
533     "        VMRS    R1,FPEXC          \n"
534     "        ORR     R1,R1,#0x40000000 \n"
535     "        VMSR    FPEXC,R1          \n"
536
537     //Initialise VFP/NEON registers to 0
538     "        MOV     R2,#0             \n"
539
540     //Initialise D16 registers to 0
541     "        VMOV    D0, R2,R2         \n"
542     "        VMOV    D1, R2,R2         \n"
543     "        VMOV    D2, R2,R2         \n"
544     "        VMOV    D3, R2,R2         \n"
545     "        VMOV    D4, R2,R2         \n"
546     "        VMOV    D5, R2,R2         \n"
547     "        VMOV    D6, R2,R2         \n"
548     "        VMOV    D7, R2,R2         \n"
549     "        VMOV    D8, R2,R2         \n"
550     "        VMOV    D9, R2,R2         \n"
551     "        VMOV    D10,R2,R2         \n"
552     "        VMOV    D11,R2,R2         \n"
553     "        VMOV    D12,R2,R2         \n"
554     "        VMOV    D13,R2,R2         \n"
555     "        VMOV    D14,R2,R2         \n"
556     "        VMOV    D15,R2,R2         \n"
557
558 #if __ARM_NEON == 1
559     //Initialise D32 registers to 0
560     "        VMOV    D16,R2,R2         \n"
561     "        VMOV    D17,R2,R2         \n"
562     "        VMOV    D18,R2,R2         \n"
563     "        VMOV    D19,R2,R2         \n"
564     "        VMOV    D20,R2,R2         \n"
565     "        VMOV    D21,R2,R2         \n"
566     "        VMOV    D22,R2,R2         \n"
567     "        VMOV    D23,R2,R2         \n"
568     "        VMOV    D24,R2,R2         \n"
569     "        VMOV    D25,R2,R2         \n"
570     "        VMOV    D26,R2,R2         \n"
571     "        VMOV    D27,R2,R2         \n"
572     "        VMOV    D28,R2,R2         \n"
573     "        VMOV    D29,R2,R2         \n"
574     "        VMOV    D30,R2,R2         \n"
575     "        VMOV    D31,R2,R2         \n"
576 #endif
577
578     //Initialise FPSCR to a known state
579     "        VMRS    R1,FPSCR          \n"
580     "        LDR     R2,=0x00086060    \n" //Mask off all bits that do not have to be preserved. Non-preserved bits can/should be zero.
581     "        AND     R1,R1,R2          \n"
582     "        VMSR    FPSCR,R1            "
583     : : : "cc", "r1", "r2"
584   );
585 }
586
587 #endif /* __CMSIS_ARMCLANG_H */