1 /**************************************************************************//**
3 * @brief CMSIS Cortex-M Core Function/Instruction Header File
5 * @date 27. September 2016
6 ******************************************************************************/
8 * Copyright (c) 2009-2016 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 * http://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 #define __ARM_ARCH_6M__ 1
38 #if (defined (__TARGET_ARCH_7_M ) && (__TARGET_ARCH_7_M == 1))
39 #define __ARM_ARCH_7M__ 1
42 #if (defined (__TARGET_ARCH_7E_M) && (__TARGET_ARCH_7E_M == 1))
43 #define __ARM_ARCH_7EM__ 1
46 /* __ARM_ARCH_8M_BASE__ not applicable */
47 /* __ARM_ARCH_8M_MAIN__ not applicable */
50 /* CMSIS compiler specific defines */
55 #define __INLINE __inline
57 #ifndef __STATIC_INLINE
58 #define __STATIC_INLINE static __inline
61 #define __NO_RETURN __declspec(noreturn)
64 #define __USED __attribute__((used))
67 #define __WEAK __attribute__((weak))
69 #ifndef __UNALIGNED_UINT32
70 #define __UNALIGNED_UINT32(x) (*((__packed uint32_t *)(x)))
73 #define __ALIGNED(x) __attribute__((aligned(x)))
76 #define __PACKED __attribute__((packed))
80 /* ########################### Core Function Access ########################### */
81 /** \ingroup CMSIS_Core_FunctionInterface
82 \defgroup CMSIS_Core_RegAccFunctions CMSIS Core Register Access Functions
87 \brief Enable IRQ Interrupts
88 \details Enables IRQ interrupts by clearing the I-bit in the CPSR.
89 Can only be executed in Privileged modes.
91 /* intrinsic void __enable_irq(); */
95 \brief Disable IRQ Interrupts
96 \details Disables IRQ interrupts by setting the I-bit in the CPSR.
97 Can only be executed in Privileged modes.
99 /* intrinsic void __disable_irq(); */
102 \brief Get Control Register
103 \details Returns the content of the Control Register.
104 \return Control Register value
106 __STATIC_INLINE uint32_t __get_CONTROL(void)
108 register uint32_t __regControl __ASM("control");
109 return(__regControl);
114 \brief Set Control Register
115 \details Writes the given value to the Control Register.
116 \param [in] control Control Register value to set
118 __STATIC_INLINE void __set_CONTROL(uint32_t control)
120 register uint32_t __regControl __ASM("control");
121 __regControl = control;
126 \brief Get IPSR Register
127 \details Returns the content of the IPSR Register.
128 \return IPSR Register value
130 __STATIC_INLINE uint32_t __get_IPSR(void)
132 register uint32_t __regIPSR __ASM("ipsr");
138 \brief Get APSR Register
139 \details Returns the content of the APSR Register.
140 \return APSR Register value
142 __STATIC_INLINE uint32_t __get_APSR(void)
144 register uint32_t __regAPSR __ASM("apsr");
150 \brief Get xPSR Register
151 \details Returns the content of the xPSR Register.
152 \return xPSR Register value
154 __STATIC_INLINE uint32_t __get_xPSR(void)
156 register uint32_t __regXPSR __ASM("xpsr");
162 \brief Get Process Stack Pointer
163 \details Returns the current value of the Process Stack Pointer (PSP).
164 \return PSP Register value
166 __STATIC_INLINE uint32_t __get_PSP(void)
168 register uint32_t __regProcessStackPointer __ASM("psp");
169 return(__regProcessStackPointer);
174 \brief Set Process Stack Pointer
175 \details Assigns the given value to the Process Stack Pointer (PSP).
176 \param [in] topOfProcStack Process Stack Pointer value to set
178 __STATIC_INLINE void __set_PSP(uint32_t topOfProcStack)
180 register uint32_t __regProcessStackPointer __ASM("psp");
181 __regProcessStackPointer = topOfProcStack;
186 \brief Get Main Stack Pointer
187 \details Returns the current value of the Main Stack Pointer (MSP).
188 \return MSP Register value
190 __STATIC_INLINE uint32_t __get_MSP(void)
192 register uint32_t __regMainStackPointer __ASM("msp");
193 return(__regMainStackPointer);
198 \brief Set Main Stack Pointer
199 \details Assigns the given value to the Main Stack Pointer (MSP).
200 \param [in] topOfMainStack Main Stack Pointer value to set
202 __STATIC_INLINE void __set_MSP(uint32_t topOfMainStack)
204 register uint32_t __regMainStackPointer __ASM("msp");
205 __regMainStackPointer = topOfMainStack;
210 \brief Get Priority Mask
211 \details Returns the current state of the priority mask bit from the Priority Mask Register.
212 \return Priority Mask value
214 __STATIC_INLINE uint32_t __get_PRIMASK(void)
216 register uint32_t __regPriMask __ASM("primask");
217 return(__regPriMask);
222 \brief Set Priority Mask
223 \details Assigns the given value to the Priority Mask Register.
224 \param [in] priMask Priority Mask
226 __STATIC_INLINE void __set_PRIMASK(uint32_t priMask)
228 register uint32_t __regPriMask __ASM("primask");
229 __regPriMask = (priMask);
233 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
234 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
238 \details Enables FIQ interrupts by clearing the F-bit in the CPSR.
239 Can only be executed in Privileged modes.
241 #define __enable_fault_irq __enable_fiq
246 \details Disables FIQ interrupts by setting the F-bit in the CPSR.
247 Can only be executed in Privileged modes.
249 #define __disable_fault_irq __disable_fiq
253 \brief Get Base Priority
254 \details Returns the current value of the Base Priority register.
255 \return Base Priority register value
257 __STATIC_INLINE uint32_t __get_BASEPRI(void)
259 register uint32_t __regBasePri __ASM("basepri");
260 return(__regBasePri);
265 \brief Set Base Priority
266 \details Assigns the given value to the Base Priority register.
267 \param [in] basePri Base Priority value to set
269 __STATIC_INLINE void __set_BASEPRI(uint32_t basePri)
271 register uint32_t __regBasePri __ASM("basepri");
272 __regBasePri = (basePri & 0xFFU);
277 \brief Set Base Priority with condition
278 \details Assigns the given value to the Base Priority register only if BASEPRI masking is disabled,
279 or the new value increases the BASEPRI priority level.
280 \param [in] basePri Base Priority value to set
282 __STATIC_INLINE void __set_BASEPRI_MAX(uint32_t basePri)
284 register uint32_t __regBasePriMax __ASM("basepri_max");
285 __regBasePriMax = (basePri & 0xFFU);
290 \brief Get Fault Mask
291 \details Returns the current value of the Fault Mask register.
292 \return Fault Mask register value
294 __STATIC_INLINE uint32_t __get_FAULTMASK(void)
296 register uint32_t __regFaultMask __ASM("faultmask");
297 return(__regFaultMask);
302 \brief Set Fault Mask
303 \details Assigns the given value to the Fault Mask register.
304 \param [in] faultMask Fault Mask value to set
306 __STATIC_INLINE void __set_FAULTMASK(uint32_t faultMask)
308 register uint32_t __regFaultMask __ASM("faultmask");
309 __regFaultMask = (faultMask & (uint32_t)1U);
312 #endif /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
313 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
316 #if ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
320 \details Returns the current value of the Floating Point Status/Control register.
321 \return Floating Point Status/Control register value
323 __STATIC_INLINE uint32_t __get_FPSCR(void)
325 #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
326 (defined (__FPU_USED ) && (__FPU_USED == 1U)) )
327 register uint32_t __regfpscr __ASM("fpscr");
337 \details Assigns the given value to the Floating Point Status/Control register.
338 \param [in] fpscr Floating Point Status/Control value to set
340 __STATIC_INLINE void __set_FPSCR(uint32_t fpscr)
342 #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
343 (defined (__FPU_USED ) && (__FPU_USED == 1U)) )
344 register uint32_t __regfpscr __ASM("fpscr");
345 __regfpscr = (fpscr);
349 #endif /* ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
353 /*@} end of CMSIS_Core_RegAccFunctions */
356 /* ########################## Core Instruction Access ######################### */
357 /** \defgroup CMSIS_Core_InstructionInterface CMSIS Core Instruction Interface
358 Access to dedicated instructions
364 \details No Operation does nothing. This instruction can be used for code alignment purposes.
370 \brief Wait For Interrupt
371 \details Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs.
377 \brief Wait For Event
378 \details Wait For Event is a hint instruction that permits the processor to enter
379 a low-power state until one of a number of events occurs.
386 \details Send Event is a hint instruction. It causes an event to be signaled to the CPU.
392 \brief Instruction Synchronization Barrier
393 \details Instruction Synchronization Barrier flushes the pipeline in the processor,
394 so that all instructions following the ISB are fetched from cache or memory,
395 after the instruction has been completed.
397 #define __ISB() do {\
398 __schedule_barrier();\
400 __schedule_barrier();\
404 \brief Data Synchronization Barrier
405 \details Acts as a special kind of Data Memory Barrier.
406 It completes when all explicit memory accesses before this instruction complete.
408 #define __DSB() do {\
409 __schedule_barrier();\
411 __schedule_barrier();\
415 \brief Data Memory Barrier
416 \details Ensures the apparent order of the explicit memory operations before
417 and after the instruction, without ensuring their completion.
419 #define __DMB() do {\
420 __schedule_barrier();\
422 __schedule_barrier();\
426 \brief Reverse byte order (32 bit)
427 \details Reverses the byte order in integer value.
428 \param [in] value Value to reverse
429 \return Reversed value
435 \brief Reverse byte order (16 bit)
436 \details Reverses the byte order in two unsigned short values.
437 \param [in] value Value to reverse
438 \return Reversed value
440 #ifndef __NO_EMBEDDED_ASM
441 __attribute__((section(".rev16_text"))) __STATIC_INLINE __ASM uint32_t __REV16(uint32_t value)
450 \brief Reverse byte order in signed short value
451 \details Reverses the byte order in a signed short value with sign extension to integer.
452 \param [in] value Value to reverse
453 \return Reversed value
455 #ifndef __NO_EMBEDDED_ASM
456 __attribute__((section(".revsh_text"))) __STATIC_INLINE __ASM int32_t __REVSH(int32_t value)
465 \brief Rotate Right in unsigned value (32 bit)
466 \details Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits.
467 \param [in] op1 Value to rotate
468 \param [in] op2 Number of Bits to rotate
469 \return Rotated value
476 \details Causes the processor to enter Debug state.
477 Debug tools can use this to investigate system state when the instruction at a particular address is reached.
478 \param [in] value is ignored by the processor.
479 If required, a debugger can use it to store additional information about the breakpoint.
481 #define __BKPT(value) __breakpoint(value)
485 \brief Reverse bit order of value
486 \details Reverses the bit order of the given value.
487 \param [in] value Value to reverse
488 \return Reversed value
490 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
491 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
492 #define __RBIT __rbit
494 __attribute__((always_inline)) __STATIC_INLINE uint32_t __RBIT(uint32_t value)
497 int32_t s = (4 /*sizeof(v)*/ * 8) - 1; /* extra shift needed at end */
499 result = value; /* r will be reversed bits of v; first get LSB of v */
500 for (value >>= 1U; value; value >>= 1U)
503 result |= value & 1U;
506 result <<= s; /* shift when v's highest bits are zero */
513 \brief Count leading zeros
514 \details Counts the number of leading zeros of a data value.
515 \param [in] value Value to count the leading zeros
516 \return number of leading zeros in value
521 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
522 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
525 \brief LDR Exclusive (8 bit)
526 \details Executes a exclusive LDR instruction for 8 bit value.
527 \param [in] ptr Pointer to data
528 \return value of type uint8_t at (*ptr)
530 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
531 #define __LDREXB(ptr) ((uint8_t ) __ldrex(ptr))
533 #define __LDREXB(ptr) _Pragma("push") _Pragma("diag_suppress 3731") ((uint8_t ) __ldrex(ptr)) _Pragma("pop")
538 \brief LDR Exclusive (16 bit)
539 \details Executes a exclusive LDR instruction for 16 bit values.
540 \param [in] ptr Pointer to data
541 \return value of type uint16_t at (*ptr)
543 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
544 #define __LDREXH(ptr) ((uint16_t) __ldrex(ptr))
546 #define __LDREXH(ptr) _Pragma("push") _Pragma("diag_suppress 3731") ((uint16_t) __ldrex(ptr)) _Pragma("pop")
551 \brief LDR Exclusive (32 bit)
552 \details Executes a exclusive LDR instruction for 32 bit values.
553 \param [in] ptr Pointer to data
554 \return value of type uint32_t at (*ptr)
556 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
557 #define __LDREXW(ptr) ((uint32_t ) __ldrex(ptr))
559 #define __LDREXW(ptr) _Pragma("push") _Pragma("diag_suppress 3731") ((uint32_t ) __ldrex(ptr)) _Pragma("pop")
564 \brief STR Exclusive (8 bit)
565 \details Executes a exclusive STR instruction for 8 bit values.
566 \param [in] value Value to store
567 \param [in] ptr Pointer to location
568 \return 0 Function succeeded
569 \return 1 Function failed
571 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
572 #define __STREXB(value, ptr) __strex(value, ptr)
574 #define __STREXB(value, ptr) _Pragma("push") _Pragma("diag_suppress 3731") __strex(value, ptr) _Pragma("pop")
579 \brief STR Exclusive (16 bit)
580 \details Executes a exclusive STR instruction for 16 bit values.
581 \param [in] value Value to store
582 \param [in] ptr Pointer to location
583 \return 0 Function succeeded
584 \return 1 Function failed
586 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
587 #define __STREXH(value, ptr) __strex(value, ptr)
589 #define __STREXH(value, ptr) _Pragma("push") _Pragma("diag_suppress 3731") __strex(value, ptr) _Pragma("pop")
594 \brief STR Exclusive (32 bit)
595 \details Executes a exclusive STR instruction for 32 bit values.
596 \param [in] value Value to store
597 \param [in] ptr Pointer to location
598 \return 0 Function succeeded
599 \return 1 Function failed
601 #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
602 #define __STREXW(value, ptr) __strex(value, ptr)
604 #define __STREXW(value, ptr) _Pragma("push") _Pragma("diag_suppress 3731") __strex(value, ptr) _Pragma("pop")
609 \brief Remove the exclusive lock
610 \details Removes the exclusive lock which is created by LDREX.
612 #define __CLREX __clrex
616 \brief Signed Saturate
617 \details Saturates a signed value.
618 \param [in] value Value to be saturated
619 \param [in] sat Bit position to saturate to (1..32)
620 \return Saturated value
622 #define __SSAT __ssat
626 \brief Unsigned Saturate
627 \details Saturates an unsigned value.
628 \param [in] value Value to be saturated
629 \param [in] sat Bit position to saturate to (0..31)
630 \return Saturated value
632 #define __USAT __usat
636 \brief Rotate Right with Extend (32 bit)
637 \details Moves each bit of a bitstring right by one bit.
638 The carry input is shifted in at the left end of the bitstring.
639 \param [in] value Value to rotate
640 \return Rotated value
642 #ifndef __NO_EMBEDDED_ASM
643 __attribute__((section(".rrx_text"))) __STATIC_INLINE __ASM uint32_t __RRX(uint32_t value)
652 \brief LDRT Unprivileged (8 bit)
653 \details Executes a Unprivileged LDRT instruction for 8 bit value.
654 \param [in] ptr Pointer to data
655 \return value of type uint8_t at (*ptr)
657 #define __LDRBT(ptr) ((uint8_t ) __ldrt(ptr))
661 \brief LDRT Unprivileged (16 bit)
662 \details Executes a Unprivileged LDRT instruction for 16 bit values.
663 \param [in] ptr Pointer to data
664 \return value of type uint16_t at (*ptr)
666 #define __LDRHT(ptr) ((uint16_t) __ldrt(ptr))
670 \brief LDRT Unprivileged (32 bit)
671 \details Executes a Unprivileged LDRT instruction for 32 bit values.
672 \param [in] ptr Pointer to data
673 \return value of type uint32_t at (*ptr)
675 #define __LDRT(ptr) ((uint32_t ) __ldrt(ptr))
679 \brief STRT Unprivileged (8 bit)
680 \details Executes a Unprivileged STRT instruction for 8 bit values.
681 \param [in] value Value to store
682 \param [in] ptr Pointer to location
684 #define __STRBT(value, ptr) __strt(value, ptr)
688 \brief STRT Unprivileged (16 bit)
689 \details Executes a Unprivileged STRT instruction for 16 bit values.
690 \param [in] value Value to store
691 \param [in] ptr Pointer to location
693 #define __STRHT(value, ptr) __strt(value, ptr)
697 \brief STRT Unprivileged (32 bit)
698 \details Executes a Unprivileged STRT instruction for 32 bit values.
699 \param [in] value Value to store
700 \param [in] ptr Pointer to location
702 #define __STRT(value, ptr) __strt(value, ptr)
704 #endif /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
705 (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
707 /*@}*/ /* end of group CMSIS_Core_InstructionInterface */
710 /* ################### Compiler specific Intrinsics ########################### */
711 /** \defgroup CMSIS_SIMD_intrinsics CMSIS SIMD Intrinsics
712 Access to dedicated SIMD instructions
716 #if ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
718 #define __SADD8 __sadd8
719 #define __QADD8 __qadd8
720 #define __SHADD8 __shadd8
721 #define __UADD8 __uadd8
722 #define __UQADD8 __uqadd8
723 #define __UHADD8 __uhadd8
724 #define __SSUB8 __ssub8
725 #define __QSUB8 __qsub8
726 #define __SHSUB8 __shsub8
727 #define __USUB8 __usub8
728 #define __UQSUB8 __uqsub8
729 #define __UHSUB8 __uhsub8
730 #define __SADD16 __sadd16
731 #define __QADD16 __qadd16
732 #define __SHADD16 __shadd16
733 #define __UADD16 __uadd16
734 #define __UQADD16 __uqadd16
735 #define __UHADD16 __uhadd16
736 #define __SSUB16 __ssub16
737 #define __QSUB16 __qsub16
738 #define __SHSUB16 __shsub16
739 #define __USUB16 __usub16
740 #define __UQSUB16 __uqsub16
741 #define __UHSUB16 __uhsub16
742 #define __SASX __sasx
743 #define __QASX __qasx
744 #define __SHASX __shasx
745 #define __UASX __uasx
746 #define __UQASX __uqasx
747 #define __UHASX __uhasx
748 #define __SSAX __ssax
749 #define __QSAX __qsax
750 #define __SHSAX __shsax
751 #define __USAX __usax
752 #define __UQSAX __uqsax
753 #define __UHSAX __uhsax
754 #define __USAD8 __usad8
755 #define __USADA8 __usada8
756 #define __SSAT16 __ssat16
757 #define __USAT16 __usat16
758 #define __UXTB16 __uxtb16
759 #define __UXTAB16 __uxtab16
760 #define __SXTB16 __sxtb16
761 #define __SXTAB16 __sxtab16
762 #define __SMUAD __smuad
763 #define __SMUADX __smuadx
764 #define __SMLAD __smlad
765 #define __SMLADX __smladx
766 #define __SMLALD __smlald
767 #define __SMLALDX __smlaldx
768 #define __SMUSD __smusd
769 #define __SMUSDX __smusdx
770 #define __SMLSD __smlsd
771 #define __SMLSDX __smlsdx
772 #define __SMLSLD __smlsld
773 #define __SMLSLDX __smlsldx
775 #define __QADD __qadd
776 #define __QSUB __qsub
778 #define __PKHBT(ARG1,ARG2,ARG3) ( ((((uint32_t)(ARG1)) ) & 0x0000FFFFUL) | \
779 ((((uint32_t)(ARG2)) << (ARG3)) & 0xFFFF0000UL) )
781 #define __PKHTB(ARG1,ARG2,ARG3) ( ((((uint32_t)(ARG1)) ) & 0xFFFF0000UL) | \
782 ((((uint32_t)(ARG2)) >> (ARG3)) & 0x0000FFFFUL) )
784 #define __SMMLA(ARG1,ARG2,ARG3) ( (int32_t)((((int64_t)(ARG1) * (ARG2)) + \
785 ((int64_t)(ARG3) << 32U) ) >> 32U))
787 #endif /* ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
788 /*@} end of group CMSIS_SIMD_intrinsics */
791 #endif /* __CMSIS_ARMCC_H */