1 /**************************************************************************//**
3 * @brief CMSIS compiler ARMCC (ARM compiler V5) header file
5 * @date 13. February 2017
6 ******************************************************************************/
8 * Copyright (c) 2009-2017 ARM Limited. All rights reserved.
10 * SPDX-License-Identifier: Apache-2.0
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
16 * www.apache.org/licenses/LICENSE-2.0
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.
25 #ifndef __CMSIS_ARMCC_H
26 #define __CMSIS_ARMCC_H
29 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 400677)
30 #error "Please use ARM Compiler Toolchain V4.0.677 or later!"
33 /* CMSIS compiler control architecture macros */
34 #if ((defined (__TARGET_ARCH_6_M ) && (__TARGET_ARCH_6_M == 1)) || \
35 (defined (__TARGET_ARCH_6S_M ) && (__TARGET_ARCH_6S_M == 1)) )
36 #define __ARM_ARCH_6M__ 1
39 #if (defined (__TARGET_ARCH_7_M ) && (__TARGET_ARCH_7_M == 1))
40 #define __ARM_ARCH_7M__ 1
43 #if (defined (__TARGET_ARCH_7E_M) && (__TARGET_ARCH_7E_M == 1))
44 #define __ARM_ARCH_7EM__ 1
47 /* __ARM_ARCH_8M_BASE__ not applicable */
48 /* __ARM_ARCH_8M_MAIN__ not applicable */
51 /* CMSIS compiler specific defines */
56 #define __INLINE __inline
58 #ifndef __STATIC_INLINE
59 #define __STATIC_INLINE static __inline
62 #define __NO_RETURN __declspec(noreturn)
65 #define __USED __attribute__((used))
68 #define __WEAK __attribute__((weak))
71 #define __PACKED __attribute__((packed))
73 #ifndef __PACKED_STRUCT
74 #define __PACKED_STRUCT __packed struct
76 #ifndef __UNALIGNED_UINT32 /* deprecated */
77 #define __UNALIGNED_UINT32(x) (*((__packed uint32_t *)(x)))
79 #ifndef __UNALIGNED_UINT16_WRITE
80 #define __UNALIGNED_UINT16_WRITE(addr, val) ((*((__packed uint16_t *)(addr))) = (val))
82 #ifndef __UNALIGNED_UINT16_READ
83 #define __UNALIGNED_UINT16_READ(addr) (*((const __packed uint16_t *)(addr)))
85 #ifndef __UNALIGNED_UINT32_WRITE
86 #define __UNALIGNED_UINT32_WRITE(addr, val) ((*((__packed uint32_t *)(addr))) = (val))
88 #ifndef __UNALIGNED_UINT32_READ
89 #define __UNALIGNED_UINT32_READ(addr) (*((const __packed uint32_t *)(addr)))
92 #define __ALIGNED(x) __attribute__((aligned(x)))
96 /* ########################### Core Function Access ########################### */
97 /** \ingroup CMSIS_Core_FunctionInterface
98 \defgroup CMSIS_Core_RegAccFunctions CMSIS Core Register Access Functions
103 \brief Enable IRQ Interrupts
104 \details Enables IRQ interrupts by clearing the I-bit in the CPSR.
105 Can only be executed in Privileged modes.
107 /* intrinsic void __enable_irq(); */
111 \brief Disable IRQ Interrupts
112 \details Disables IRQ interrupts by setting the I-bit in the CPSR.
113 Can only be executed in Privileged modes.
115 /* intrinsic void __disable_irq(); */
118 \brief Get Control Register
119 \details Returns the content of the Control Register.
120 \return Control Register value
122 __STATIC_INLINE uint32_t __get_CONTROL(void)
124 register uint32_t __regControl __ASM("control");
125 return(__regControl);
130 \brief Set Control Register
131 \details Writes the given value to the Control Register.
132 \param [in] control Control Register value to set
134 __STATIC_INLINE void __set_CONTROL(uint32_t control)
136 register uint32_t __regControl __ASM("control");
137 __regControl = control;
142 \brief Get IPSR Register
143 \details Returns the content of the IPSR Register.
144 \return IPSR Register value
146 __STATIC_INLINE uint32_t __get_IPSR(void)
148 register uint32_t __regIPSR __ASM("ipsr");
154 \brief Get APSR Register
155 \details Returns the content of the APSR Register.
156 \return APSR Register value
158 __STATIC_INLINE uint32_t __get_APSR(void)
160 register uint32_t __regAPSR __ASM("apsr");
166 \brief Get xPSR Register
167 \details Returns the content of the xPSR Register.
168 \return xPSR Register value
170 __STATIC_INLINE uint32_t __get_xPSR(void)
172 register uint32_t __regXPSR __ASM("xpsr");
178 \brief Get Process Stack Pointer
179 \details Returns the current value of the Process Stack Pointer (PSP).
180 \return PSP Register value
182 __STATIC_INLINE uint32_t __get_PSP(void)
184 register uint32_t __regProcessStackPointer __ASM("psp");
185 return(__regProcessStackPointer);
190 \brief Set Process Stack Pointer
191 \details Assigns the given value to the Process Stack Pointer (PSP).
192 \param [in] topOfProcStack Process Stack Pointer value to set
194 __STATIC_INLINE void __set_PSP(uint32_t topOfProcStack)
196 register uint32_t __regProcessStackPointer __ASM("psp");
197 __regProcessStackPointer = topOfProcStack;
202 \brief Get Main Stack Pointer
203 \details Returns the current value of the Main Stack Pointer (MSP).
204 \return MSP Register value
206 __STATIC_INLINE uint32_t __get_MSP(void)
208 register uint32_t __regMainStackPointer __ASM("msp");
209 return(__regMainStackPointer);
214 \brief Set Main Stack Pointer
215 \details Assigns the given value to the Main Stack Pointer (MSP).
216 \param [in] topOfMainStack Main Stack Pointer value to set
218 __STATIC_INLINE void __set_MSP(uint32_t topOfMainStack)
220 register uint32_t __regMainStackPointer __ASM("msp");
221 __regMainStackPointer = topOfMainStack;
226 \brief Get Priority Mask
227 \details Returns the current state of the priority mask bit from the Priority Mask Register.
228 \return Priority Mask value
230 __STATIC_INLINE uint32_t __get_PRIMASK(void)
232 register uint32_t __regPriMask __ASM("primask");
233 return(__regPriMask);
238 \brief Set Priority Mask
239 \details Assigns the given value to the Priority Mask Register.
240 \param [in] priMask Priority Mask
242 __STATIC_INLINE void __set_PRIMASK(uint32_t priMask)
244 register uint32_t __regPriMask __ASM("primask");
245 __regPriMask = (priMask);
249 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
250 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
254 \details Enables FIQ interrupts by clearing the F-bit in the CPSR.
255 Can only be executed in Privileged modes.
257 #define __enable_fault_irq __enable_fiq
262 \details Disables FIQ interrupts by setting the F-bit in the CPSR.
263 Can only be executed in Privileged modes.
265 #define __disable_fault_irq __disable_fiq
269 \brief Get Base Priority
270 \details Returns the current value of the Base Priority register.
271 \return Base Priority register value
273 __STATIC_INLINE uint32_t __get_BASEPRI(void)
275 register uint32_t __regBasePri __ASM("basepri");
276 return(__regBasePri);
281 \brief Set Base Priority
282 \details Assigns the given value to the Base Priority register.
283 \param [in] basePri Base Priority value to set
285 __STATIC_INLINE void __set_BASEPRI(uint32_t basePri)
287 register uint32_t __regBasePri __ASM("basepri");
288 __regBasePri = (basePri & 0xFFU);
293 \brief Set Base Priority with condition
294 \details Assigns the given value to the Base Priority register only if BASEPRI masking is disabled,
295 or the new value increases the BASEPRI priority level.
296 \param [in] basePri Base Priority value to set
298 __STATIC_INLINE void __set_BASEPRI_MAX(uint32_t basePri)
300 register uint32_t __regBasePriMax __ASM("basepri_max");
301 __regBasePriMax = (basePri & 0xFFU);
306 \brief Get Fault Mask
307 \details Returns the current value of the Fault Mask register.
308 \return Fault Mask register value
310 __STATIC_INLINE uint32_t __get_FAULTMASK(void)
312 register uint32_t __regFaultMask __ASM("faultmask");
313 return(__regFaultMask);
318 \brief Set Fault Mask
319 \details Assigns the given value to the Fault Mask register.
320 \param [in] faultMask Fault Mask value to set
322 __STATIC_INLINE void __set_FAULTMASK(uint32_t faultMask)
324 register uint32_t __regFaultMask __ASM("faultmask");
325 __regFaultMask = (faultMask & (uint32_t)1U);
328 #endif /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
329 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
332 #if ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
336 \details Returns the current value of the Floating Point Status/Control register.
337 \return Floating Point Status/Control register value
339 __STATIC_INLINE uint32_t __get_FPSCR(void)
341 #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
342 (defined (__FPU_USED ) && (__FPU_USED == 1U)) )
343 register uint32_t __regfpscr __ASM("fpscr");
353 \details Assigns the given value to the Floating Point Status/Control register.
354 \param [in] fpscr Floating Point Status/Control value to set
356 __STATIC_INLINE void __set_FPSCR(uint32_t fpscr)
358 #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
359 (defined (__FPU_USED ) && (__FPU_USED == 1U)) )
360 register uint32_t __regfpscr __ASM("fpscr");
361 __regfpscr = (fpscr);
367 #endif /* ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
371 /*@} end of CMSIS_Core_RegAccFunctions */
374 /* ########################## Core Instruction Access ######################### */
375 /** \defgroup CMSIS_Core_InstructionInterface CMSIS Core Instruction Interface
376 Access to dedicated instructions
382 \details No Operation does nothing. This instruction can be used for code alignment purposes.
388 \brief Wait For Interrupt
389 \details Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs.
395 \brief Wait For Event
396 \details Wait For Event is a hint instruction that permits the processor to enter
397 a low-power state until one of a number of events occurs.
404 \details Send Event is a hint instruction. It causes an event to be signaled to the CPU.
410 \brief Instruction Synchronization Barrier
411 \details Instruction Synchronization Barrier flushes the pipeline in the processor,
412 so that all instructions following the ISB are fetched from cache or memory,
413 after the instruction has been completed.
415 #define __ISB() do {\
416 __schedule_barrier();\
418 __schedule_barrier();\
422 \brief Data Synchronization Barrier
423 \details Acts as a special kind of Data Memory Barrier.
424 It completes when all explicit memory accesses before this instruction complete.
426 #define __DSB() do {\
427 __schedule_barrier();\
429 __schedule_barrier();\
433 \brief Data Memory Barrier
434 \details Ensures the apparent order of the explicit memory operations before
435 and after the instruction, without ensuring their completion.
437 #define __DMB() do {\
438 __schedule_barrier();\
440 __schedule_barrier();\
444 \brief Reverse byte order (32 bit)
445 \details Reverses the byte order in integer value.
446 \param [in] value Value to reverse
447 \return Reversed value
453 \brief Reverse byte order (16 bit)
454 \details Reverses the byte order in two unsigned short values.
455 \param [in] value Value to reverse
456 \return Reversed value
458 #ifndef __NO_EMBEDDED_ASM
459 __attribute__((section(".rev16_text"))) __STATIC_INLINE __ASM uint32_t __REV16(uint32_t value)
468 \brief Reverse byte order in signed short value
469 \details Reverses the byte order in a signed short value with sign extension to integer.
470 \param [in] value Value to reverse
471 \return Reversed value
473 #ifndef __NO_EMBEDDED_ASM
474 __attribute__((section(".revsh_text"))) __STATIC_INLINE __ASM int32_t __REVSH(int32_t value)
483 \brief Rotate Right in unsigned value (32 bit)
484 \details Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits.
485 \param [in] op1 Value to rotate
486 \param [in] op2 Number of Bits to rotate
487 \return Rotated value
494 \details Causes the processor to enter Debug state.
495 Debug tools can use this to investigate system state when the instruction at a particular address is reached.
496 \param [in] value is ignored by the processor.
497 If required, a debugger can use it to store additional information about the breakpoint.
499 #define __BKPT(value) __breakpoint(value)
503 \brief Reverse bit order of value
504 \details Reverses the bit order of the given value.
505 \param [in] value Value to reverse
506 \return Reversed value
508 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
509 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
510 #define __RBIT __rbit
512 __attribute__((always_inline)) __STATIC_INLINE uint32_t __RBIT(uint32_t value)
515 int32_t s = (4 /*sizeof(v)*/ * 8) - 1; /* extra shift needed at end */
517 result = value; /* r will be reversed bits of v; first get LSB of v */
518 for (value >>= 1U; value; value >>= 1U)
521 result |= value & 1U;
524 result <<= s; /* shift when v's highest bits are zero */
531 \brief Count leading zeros
532 \details Counts the number of leading zeros of a data value.
533 \param [in] value Value to count the leading zeros
534 \return number of leading zeros in value
539 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
540 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
543 \brief LDR Exclusive (8 bit)
544 \details Executes a exclusive LDR instruction for 8 bit value.
545 \param [in] ptr Pointer to data
546 \return value of type uint8_t at (*ptr)
548 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
549 #define __LDREXB(ptr) ((uint8_t ) __ldrex(ptr))
551 #define __LDREXB(ptr) _Pragma("push") _Pragma("diag_suppress 3731") ((uint8_t ) __ldrex(ptr)) _Pragma("pop")
556 \brief LDR Exclusive (16 bit)
557 \details Executes a exclusive LDR instruction for 16 bit values.
558 \param [in] ptr Pointer to data
559 \return value of type uint16_t at (*ptr)
561 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
562 #define __LDREXH(ptr) ((uint16_t) __ldrex(ptr))
564 #define __LDREXH(ptr) _Pragma("push") _Pragma("diag_suppress 3731") ((uint16_t) __ldrex(ptr)) _Pragma("pop")
569 \brief LDR Exclusive (32 bit)
570 \details Executes a exclusive LDR instruction for 32 bit values.
571 \param [in] ptr Pointer to data
572 \return value of type uint32_t at (*ptr)
574 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
575 #define __LDREXW(ptr) ((uint32_t ) __ldrex(ptr))
577 #define __LDREXW(ptr) _Pragma("push") _Pragma("diag_suppress 3731") ((uint32_t ) __ldrex(ptr)) _Pragma("pop")
582 \brief STR Exclusive (8 bit)
583 \details Executes a exclusive STR instruction for 8 bit values.
584 \param [in] value Value to store
585 \param [in] ptr Pointer to location
586 \return 0 Function succeeded
587 \return 1 Function failed
589 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
590 #define __STREXB(value, ptr) __strex(value, ptr)
592 #define __STREXB(value, ptr) _Pragma("push") _Pragma("diag_suppress 3731") __strex(value, ptr) _Pragma("pop")
597 \brief STR Exclusive (16 bit)
598 \details Executes a exclusive STR instruction for 16 bit values.
599 \param [in] value Value to store
600 \param [in] ptr Pointer to location
601 \return 0 Function succeeded
602 \return 1 Function failed
604 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
605 #define __STREXH(value, ptr) __strex(value, ptr)
607 #define __STREXH(value, ptr) _Pragma("push") _Pragma("diag_suppress 3731") __strex(value, ptr) _Pragma("pop")
612 \brief STR Exclusive (32 bit)
613 \details Executes a exclusive STR instruction for 32 bit values.
614 \param [in] value Value to store
615 \param [in] ptr Pointer to location
616 \return 0 Function succeeded
617 \return 1 Function failed
619 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
620 #define __STREXW(value, ptr) __strex(value, ptr)
622 #define __STREXW(value, ptr) _Pragma("push") _Pragma("diag_suppress 3731") __strex(value, ptr) _Pragma("pop")
627 \brief Remove the exclusive lock
628 \details Removes the exclusive lock which is created by LDREX.
630 #define __CLREX __clrex
634 \brief Signed Saturate
635 \details Saturates a signed value.
636 \param [in] value Value to be saturated
637 \param [in] sat Bit position to saturate to (1..32)
638 \return Saturated value
640 #define __SSAT __ssat
644 \brief Unsigned Saturate
645 \details Saturates an unsigned value.
646 \param [in] value Value to be saturated
647 \param [in] sat Bit position to saturate to (0..31)
648 \return Saturated value
650 #define __USAT __usat
654 \brief Rotate Right with Extend (32 bit)
655 \details Moves each bit of a bitstring right by one bit.
656 The carry input is shifted in at the left end of the bitstring.
657 \param [in] value Value to rotate
658 \return Rotated value
660 #ifndef __NO_EMBEDDED_ASM
661 __attribute__((section(".rrx_text"))) __STATIC_INLINE __ASM uint32_t __RRX(uint32_t value)
670 \brief LDRT Unprivileged (8 bit)
671 \details Executes a Unprivileged LDRT instruction for 8 bit value.
672 \param [in] ptr Pointer to data
673 \return value of type uint8_t at (*ptr)
675 #define __LDRBT(ptr) ((uint8_t ) __ldrt(ptr))
679 \brief LDRT Unprivileged (16 bit)
680 \details Executes a Unprivileged LDRT instruction for 16 bit values.
681 \param [in] ptr Pointer to data
682 \return value of type uint16_t at (*ptr)
684 #define __LDRHT(ptr) ((uint16_t) __ldrt(ptr))
688 \brief LDRT Unprivileged (32 bit)
689 \details Executes a Unprivileged LDRT instruction for 32 bit values.
690 \param [in] ptr Pointer to data
691 \return value of type uint32_t at (*ptr)
693 #define __LDRT(ptr) ((uint32_t ) __ldrt(ptr))
697 \brief STRT Unprivileged (8 bit)
698 \details Executes a Unprivileged STRT instruction for 8 bit values.
699 \param [in] value Value to store
700 \param [in] ptr Pointer to location
702 #define __STRBT(value, ptr) __strt(value, ptr)
706 \brief STRT Unprivileged (16 bit)
707 \details Executes a Unprivileged STRT instruction for 16 bit values.
708 \param [in] value Value to store
709 \param [in] ptr Pointer to location
711 #define __STRHT(value, ptr) __strt(value, ptr)
715 \brief STRT Unprivileged (32 bit)
716 \details Executes a Unprivileged STRT instruction for 32 bit values.
717 \param [in] value Value to store
718 \param [in] ptr Pointer to location
720 #define __STRT(value, ptr) __strt(value, ptr)
722 #endif /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
723 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
725 /*@}*/ /* end of group CMSIS_Core_InstructionInterface */
728 /* ################### Compiler specific Intrinsics ########################### */
729 /** \defgroup CMSIS_SIMD_intrinsics CMSIS SIMD Intrinsics
730 Access to dedicated SIMD instructions
734 #if ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
736 #define __SADD8 __sadd8
737 #define __QADD8 __qadd8
738 #define __SHADD8 __shadd8
739 #define __UADD8 __uadd8
740 #define __UQADD8 __uqadd8
741 #define __UHADD8 __uhadd8
742 #define __SSUB8 __ssub8
743 #define __QSUB8 __qsub8
744 #define __SHSUB8 __shsub8
745 #define __USUB8 __usub8
746 #define __UQSUB8 __uqsub8
747 #define __UHSUB8 __uhsub8
748 #define __SADD16 __sadd16
749 #define __QADD16 __qadd16
750 #define __SHADD16 __shadd16
751 #define __UADD16 __uadd16
752 #define __UQADD16 __uqadd16
753 #define __UHADD16 __uhadd16
754 #define __SSUB16 __ssub16
755 #define __QSUB16 __qsub16
756 #define __SHSUB16 __shsub16
757 #define __USUB16 __usub16
758 #define __UQSUB16 __uqsub16
759 #define __UHSUB16 __uhsub16
760 #define __SASX __sasx
761 #define __QASX __qasx
762 #define __SHASX __shasx
763 #define __UASX __uasx
764 #define __UQASX __uqasx
765 #define __UHASX __uhasx
766 #define __SSAX __ssax
767 #define __QSAX __qsax
768 #define __SHSAX __shsax
769 #define __USAX __usax
770 #define __UQSAX __uqsax
771 #define __UHSAX __uhsax
772 #define __USAD8 __usad8
773 #define __USADA8 __usada8
774 #define __SSAT16 __ssat16
775 #define __USAT16 __usat16
776 #define __UXTB16 __uxtb16
777 #define __UXTAB16 __uxtab16
778 #define __SXTB16 __sxtb16
779 #define __SXTAB16 __sxtab16
780 #define __SMUAD __smuad
781 #define __SMUADX __smuadx
782 #define __SMLAD __smlad
783 #define __SMLADX __smladx
784 #define __SMLALD __smlald
785 #define __SMLALDX __smlaldx
786 #define __SMUSD __smusd
787 #define __SMUSDX __smusdx
788 #define __SMLSD __smlsd
789 #define __SMLSDX __smlsdx
790 #define __SMLSLD __smlsld
791 #define __SMLSLDX __smlsldx
793 #define __QADD __qadd
794 #define __QSUB __qsub
796 #define __PKHBT(ARG1,ARG2,ARG3) ( ((((uint32_t)(ARG1)) ) & 0x0000FFFFUL) | \
797 ((((uint32_t)(ARG2)) << (ARG3)) & 0xFFFF0000UL) )
799 #define __PKHTB(ARG1,ARG2,ARG3) ( ((((uint32_t)(ARG1)) ) & 0xFFFF0000UL) | \
800 ((((uint32_t)(ARG2)) >> (ARG3)) & 0x0000FFFFUL) )
802 #define __SMMLA(ARG1,ARG2,ARG3) ( (int32_t)((((int64_t)(ARG1) * (ARG2)) + \
803 ((int64_t)(ARG3) << 32U) ) >> 32U))
805 #endif /* ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
806 /*@} end of group CMSIS_SIMD_intrinsics */
809 #endif /* __CMSIS_ARMCC_H */