1 /**************************************************************************//**
3 * @brief CMSIS compiler GCC header file
6 ******************************************************************************/
8 * Copyright (c) 2009-2018 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.
28 /* ignore some GCC warnings */
29 #pragma GCC diagnostic push
30 #pragma GCC diagnostic ignored "-Wsign-conversion"
31 #pragma GCC diagnostic ignored "-Wconversion"
32 #pragma GCC diagnostic ignored "-Wunused-parameter"
34 /* Fallback for __has_builtin */
36 #define __has_builtin(x) (0)
39 /* CMSIS compiler specific defines */
44 #define __INLINE inline
46 #ifndef __STATIC_INLINE
47 #define __STATIC_INLINE static inline
49 #ifndef __STATIC_FORCEINLINE
50 #define __STATIC_FORCEINLINE __attribute__((always_inline)) static inline
53 #define __NO_RETURN __attribute__((__noreturn__))
56 #define __USED __attribute__((used))
59 #define __WEAK __attribute__((weak))
62 #define __PACKED __attribute__((packed, aligned(1)))
64 #ifndef __PACKED_STRUCT
65 #define __PACKED_STRUCT struct __attribute__((packed, aligned(1)))
67 #ifndef __PACKED_UNION
68 #define __PACKED_UNION union __attribute__((packed, aligned(1)))
70 #ifndef __UNALIGNED_UINT32 /* deprecated */
71 #pragma GCC diagnostic push
72 #pragma GCC diagnostic ignored "-Wpacked"
73 #pragma GCC diagnostic ignored "-Wattributes"
74 struct __attribute__((packed)) T_UINT32 { uint32_t v; };
75 #pragma GCC diagnostic pop
76 #define __UNALIGNED_UINT32(x) (((struct T_UINT32 *)(x))->v)
78 #ifndef __UNALIGNED_UINT16_WRITE
79 #pragma GCC diagnostic push
80 #pragma GCC diagnostic ignored "-Wpacked"
81 #pragma GCC diagnostic ignored "-Wattributes"
82 __PACKED_STRUCT T_UINT16_WRITE { uint16_t v; };
83 #pragma GCC diagnostic pop
84 #define __UNALIGNED_UINT16_WRITE(addr, val) (void)((((struct T_UINT16_WRITE *)(void *)(addr))->v) = (val))
86 #ifndef __UNALIGNED_UINT16_READ
87 #pragma GCC diagnostic push
88 #pragma GCC diagnostic ignored "-Wpacked"
89 #pragma GCC diagnostic ignored "-Wattributes"
90 __PACKED_STRUCT T_UINT16_READ { uint16_t v; };
91 #pragma GCC diagnostic pop
92 #define __UNALIGNED_UINT16_READ(addr) (((const struct T_UINT16_READ *)(const void *)(addr))->v)
94 #ifndef __UNALIGNED_UINT32_WRITE
95 #pragma GCC diagnostic push
96 #pragma GCC diagnostic ignored "-Wpacked"
97 #pragma GCC diagnostic ignored "-Wattributes"
98 __PACKED_STRUCT T_UINT32_WRITE { uint32_t v; };
99 #pragma GCC diagnostic pop
100 #define __UNALIGNED_UINT32_WRITE(addr, val) (void)((((struct T_UINT32_WRITE *)(void *)(addr))->v) = (val))
102 #ifndef __UNALIGNED_UINT32_READ
103 #pragma GCC diagnostic push
104 #pragma GCC diagnostic ignored "-Wpacked"
105 #pragma GCC diagnostic ignored "-Wattributes"
106 __PACKED_STRUCT T_UINT32_READ { uint32_t v; };
107 #pragma GCC diagnostic pop
108 #define __UNALIGNED_UINT32_READ(addr) (((const struct T_UINT32_READ *)(const void *)(addr))->v)
111 #define __ALIGNED(x) __attribute__((aligned(x)))
114 #define __RESTRICT __restrict
118 /* ########################### Core Function Access ########################### */
119 /** \ingroup CMSIS_Core_FunctionInterface
120 \defgroup CMSIS_Core_RegAccFunctions CMSIS Core Register Access Functions
125 \brief Enable IRQ Interrupts
126 \details Enables IRQ interrupts by clearing the I-bit in the CPSR.
127 Can only be executed in Privileged modes.
129 __STATIC_FORCEINLINE void __enable_irq(void)
131 __ASM volatile ("cpsie i" : : : "memory");
136 \brief Disable IRQ Interrupts
137 \details Disables IRQ interrupts by setting the I-bit in the CPSR.
138 Can only be executed in Privileged modes.
140 __STATIC_FORCEINLINE void __disable_irq(void)
142 __ASM volatile ("cpsid i" : : : "memory");
147 \brief Get Control Register
148 \details Returns the content of the Control Register.
149 \return Control Register value
151 __STATIC_FORCEINLINE uint32_t __get_CONTROL(void)
155 __ASM volatile ("MRS %0, control" : "=r" (result) );
160 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
162 \brief Get Control Register (non-secure)
163 \details Returns the content of the non-secure Control Register when in secure mode.
164 \return non-secure Control Register value
166 __STATIC_FORCEINLINE uint32_t __TZ_get_CONTROL_NS(void)
170 __ASM volatile ("MRS %0, control_ns" : "=r" (result) );
177 \brief Set Control Register
178 \details Writes the given value to the Control Register.
179 \param [in] control Control Register value to set
181 __STATIC_FORCEINLINE void __set_CONTROL(uint32_t control)
183 __ASM volatile ("MSR control, %0" : : "r" (control) : "memory");
187 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
189 \brief Set Control Register (non-secure)
190 \details Writes the given value to the non-secure Control Register when in secure state.
191 \param [in] control Control Register value to set
193 __STATIC_FORCEINLINE void __TZ_set_CONTROL_NS(uint32_t control)
195 __ASM volatile ("MSR control_ns, %0" : : "r" (control) : "memory");
201 \brief Get IPSR Register
202 \details Returns the content of the IPSR Register.
203 \return IPSR Register value
205 __STATIC_FORCEINLINE uint32_t __get_IPSR(void)
209 __ASM volatile ("MRS %0, ipsr" : "=r" (result) );
215 \brief Get APSR Register
216 \details Returns the content of the APSR Register.
217 \return APSR Register value
219 __STATIC_FORCEINLINE uint32_t __get_APSR(void)
223 __ASM volatile ("MRS %0, apsr" : "=r" (result) );
229 \brief Get xPSR Register
230 \details Returns the content of the xPSR Register.
231 \return xPSR Register value
233 __STATIC_FORCEINLINE uint32_t __get_xPSR(void)
237 __ASM volatile ("MRS %0, xpsr" : "=r" (result) );
243 \brief Get Process Stack Pointer
244 \details Returns the current value of the Process Stack Pointer (PSP).
245 \return PSP Register value
247 __STATIC_FORCEINLINE uint32_t __get_PSP(void)
249 register uint32_t result;
251 __ASM volatile ("MRS %0, psp" : "=r" (result) );
256 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
258 \brief Get Process Stack Pointer (non-secure)
259 \details Returns the current value of the non-secure Process Stack Pointer (PSP) when in secure state.
260 \return PSP Register value
262 __STATIC_FORCEINLINE uint32_t __TZ_get_PSP_NS(void)
264 register uint32_t result;
266 __ASM volatile ("MRS %0, psp_ns" : "=r" (result) );
273 \brief Set Process Stack Pointer
274 \details Assigns the given value to the Process Stack Pointer (PSP).
275 \param [in] topOfProcStack Process Stack Pointer value to set
277 __STATIC_FORCEINLINE void __set_PSP(uint32_t topOfProcStack)
279 __ASM volatile ("MSR psp, %0" : : "r" (topOfProcStack) : );
283 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
285 \brief Set Process Stack Pointer (non-secure)
286 \details Assigns the given value to the non-secure Process Stack Pointer (PSP) when in secure state.
287 \param [in] topOfProcStack Process Stack Pointer value to set
289 __STATIC_FORCEINLINE void __TZ_set_PSP_NS(uint32_t topOfProcStack)
291 __ASM volatile ("MSR psp_ns, %0" : : "r" (topOfProcStack) : );
297 \brief Get Main Stack Pointer
298 \details Returns the current value of the Main Stack Pointer (MSP).
299 \return MSP Register value
301 __STATIC_FORCEINLINE uint32_t __get_MSP(void)
303 register uint32_t result;
305 __ASM volatile ("MRS %0, msp" : "=r" (result) );
310 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
312 \brief Get Main Stack Pointer (non-secure)
313 \details Returns the current value of the non-secure Main Stack Pointer (MSP) when in secure state.
314 \return MSP Register value
316 __STATIC_FORCEINLINE uint32_t __TZ_get_MSP_NS(void)
318 register uint32_t result;
320 __ASM volatile ("MRS %0, msp_ns" : "=r" (result) );
327 \brief Set Main Stack Pointer
328 \details Assigns the given value to the Main Stack Pointer (MSP).
329 \param [in] topOfMainStack Main Stack Pointer value to set
331 __STATIC_FORCEINLINE void __set_MSP(uint32_t topOfMainStack)
333 __ASM volatile ("MSR msp, %0" : : "r" (topOfMainStack) : );
337 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
339 \brief Set Main Stack Pointer (non-secure)
340 \details Assigns the given value to the non-secure Main Stack Pointer (MSP) when in secure state.
341 \param [in] topOfMainStack Main Stack Pointer value to set
343 __STATIC_FORCEINLINE void __TZ_set_MSP_NS(uint32_t topOfMainStack)
345 __ASM volatile ("MSR msp_ns, %0" : : "r" (topOfMainStack) : );
350 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
352 \brief Get Stack Pointer (non-secure)
353 \details Returns the current value of the non-secure Stack Pointer (SP) when in secure state.
354 \return SP Register value
356 __STATIC_FORCEINLINE uint32_t __TZ_get_SP_NS(void)
358 register uint32_t result;
360 __ASM volatile ("MRS %0, sp_ns" : "=r" (result) );
366 \brief Set Stack Pointer (non-secure)
367 \details Assigns the given value to the non-secure Stack Pointer (SP) when in secure state.
368 \param [in] topOfStack Stack Pointer value to set
370 __STATIC_FORCEINLINE void __TZ_set_SP_NS(uint32_t topOfStack)
372 __ASM volatile ("MSR sp_ns, %0" : : "r" (topOfStack) : );
378 \brief Get Priority Mask
379 \details Returns the current state of the priority mask bit from the Priority Mask Register.
380 \return Priority Mask value
382 __STATIC_FORCEINLINE uint32_t __get_PRIMASK(void)
386 __ASM volatile ("MRS %0, primask" : "=r" (result) :: "memory");
391 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
393 \brief Get Priority Mask (non-secure)
394 \details Returns the current state of the non-secure priority mask bit from the Priority Mask Register when in secure state.
395 \return Priority Mask value
397 __STATIC_FORCEINLINE uint32_t __TZ_get_PRIMASK_NS(void)
401 __ASM volatile ("MRS %0, primask_ns" : "=r" (result) :: "memory");
408 \brief Set Priority Mask
409 \details Assigns the given value to the Priority Mask Register.
410 \param [in] priMask Priority Mask
412 __STATIC_FORCEINLINE void __set_PRIMASK(uint32_t priMask)
414 __ASM volatile ("MSR primask, %0" : : "r" (priMask) : "memory");
418 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
420 \brief Set Priority Mask (non-secure)
421 \details Assigns the given value to the non-secure Priority Mask Register when in secure state.
422 \param [in] priMask Priority Mask
424 __STATIC_FORCEINLINE void __TZ_set_PRIMASK_NS(uint32_t priMask)
426 __ASM volatile ("MSR primask_ns, %0" : : "r" (priMask) : "memory");
431 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
432 (defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
433 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) )
436 \details Enables FIQ interrupts by clearing the F-bit in the CPSR.
437 Can only be executed in Privileged modes.
439 __STATIC_FORCEINLINE void __enable_fault_irq(void)
441 __ASM volatile ("cpsie f" : : : "memory");
447 \details Disables FIQ interrupts by setting the F-bit in the CPSR.
448 Can only be executed in Privileged modes.
450 __STATIC_FORCEINLINE void __disable_fault_irq(void)
452 __ASM volatile ("cpsid f" : : : "memory");
457 \brief Get Base Priority
458 \details Returns the current value of the Base Priority register.
459 \return Base Priority register value
461 __STATIC_FORCEINLINE uint32_t __get_BASEPRI(void)
465 __ASM volatile ("MRS %0, basepri" : "=r" (result) );
470 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
472 \brief Get Base Priority (non-secure)
473 \details Returns the current value of the non-secure Base Priority register when in secure state.
474 \return Base Priority register value
476 __STATIC_FORCEINLINE uint32_t __TZ_get_BASEPRI_NS(void)
480 __ASM volatile ("MRS %0, basepri_ns" : "=r" (result) );
487 \brief Set Base Priority
488 \details Assigns the given value to the Base Priority register.
489 \param [in] basePri Base Priority value to set
491 __STATIC_FORCEINLINE void __set_BASEPRI(uint32_t basePri)
493 __ASM volatile ("MSR basepri, %0" : : "r" (basePri) : "memory");
497 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
499 \brief Set Base Priority (non-secure)
500 \details Assigns the given value to the non-secure Base Priority register when in secure state.
501 \param [in] basePri Base Priority value to set
503 __STATIC_FORCEINLINE void __TZ_set_BASEPRI_NS(uint32_t basePri)
505 __ASM volatile ("MSR basepri_ns, %0" : : "r" (basePri) : "memory");
511 \brief Set Base Priority with condition
512 \details Assigns the given value to the Base Priority register only if BASEPRI masking is disabled,
513 or the new value increases the BASEPRI priority level.
514 \param [in] basePri Base Priority value to set
516 __STATIC_FORCEINLINE void __set_BASEPRI_MAX(uint32_t basePri)
518 __ASM volatile ("MSR basepri_max, %0" : : "r" (basePri) : "memory");
523 \brief Get Fault Mask
524 \details Returns the current value of the Fault Mask register.
525 \return Fault Mask register value
527 __STATIC_FORCEINLINE uint32_t __get_FAULTMASK(void)
531 __ASM volatile ("MRS %0, faultmask" : "=r" (result) );
536 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
538 \brief Get Fault Mask (non-secure)
539 \details Returns the current value of the non-secure Fault Mask register when in secure state.
540 \return Fault Mask register value
542 __STATIC_FORCEINLINE uint32_t __TZ_get_FAULTMASK_NS(void)
546 __ASM volatile ("MRS %0, faultmask_ns" : "=r" (result) );
553 \brief Set Fault Mask
554 \details Assigns the given value to the Fault Mask register.
555 \param [in] faultMask Fault Mask value to set
557 __STATIC_FORCEINLINE void __set_FAULTMASK(uint32_t faultMask)
559 __ASM volatile ("MSR faultmask, %0" : : "r" (faultMask) : "memory");
563 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
565 \brief Set Fault Mask (non-secure)
566 \details Assigns the given value to the non-secure Fault Mask register when in secure state.
567 \param [in] faultMask Fault Mask value to set
569 __STATIC_FORCEINLINE void __TZ_set_FAULTMASK_NS(uint32_t faultMask)
571 __ASM volatile ("MSR faultmask_ns, %0" : : "r" (faultMask) : "memory");
575 #endif /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
576 (defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
577 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) ) */
580 #if ((defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) || \
581 (defined (__ARM_ARCH_8M_BASE__ ) && (__ARM_ARCH_8M_BASE__ == 1)) )
584 \brief Get Process Stack Pointer Limit
585 Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
586 Stack Pointer Limit register hence zero is returned always in non-secure
589 \details Returns the current value of the Process Stack Pointer Limit (PSPLIM).
590 \return PSPLIM Register value
592 __STATIC_FORCEINLINE uint32_t __get_PSPLIM(void)
594 #if (!(defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) && \
595 (!defined (__ARM_FEATURE_CMSE) || (__ARM_FEATURE_CMSE < 3)))
596 // without main extensions, the non-secure PSPLIM is RAZ/WI
599 register uint32_t result;
600 __ASM volatile ("MRS %0, psplim" : "=r" (result) );
605 #if (defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3))
607 \brief Get Process Stack Pointer Limit (non-secure)
608 Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
609 Stack Pointer Limit register hence zero is returned always.
611 \details Returns the current value of the non-secure Process Stack Pointer Limit (PSPLIM) when in secure state.
612 \return PSPLIM Register value
614 __STATIC_FORCEINLINE uint32_t __TZ_get_PSPLIM_NS(void)
616 #if (!(defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)))
617 // without main extensions, the non-secure PSPLIM is RAZ/WI
620 register uint32_t result;
621 __ASM volatile ("MRS %0, psplim_ns" : "=r" (result) );
629 \brief Set Process Stack Pointer Limit
630 Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
631 Stack Pointer Limit register hence the write is silently ignored in non-secure
634 \details Assigns the given value to the Process Stack Pointer Limit (PSPLIM).
635 \param [in] ProcStackPtrLimit Process Stack Pointer Limit value to set
637 __STATIC_FORCEINLINE void __set_PSPLIM(uint32_t ProcStackPtrLimit)
639 #if (!(defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) && \
640 (!defined (__ARM_FEATURE_CMSE) || (__ARM_FEATURE_CMSE < 3)))
641 // without main extensions, the non-secure PSPLIM is RAZ/WI
642 (void)ProcStackPtrLimit;
644 __ASM volatile ("MSR psplim, %0" : : "r" (ProcStackPtrLimit));
649 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
651 \brief Set Process Stack Pointer (non-secure)
652 Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
653 Stack Pointer Limit register hence the write is silently ignored.
655 \details Assigns the given value to the non-secure Process Stack Pointer Limit (PSPLIM) when in secure state.
656 \param [in] ProcStackPtrLimit Process Stack Pointer Limit value to set
658 __STATIC_FORCEINLINE void __TZ_set_PSPLIM_NS(uint32_t ProcStackPtrLimit)
660 #if (!(defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)))
661 // without main extensions, the non-secure PSPLIM is RAZ/WI
662 (void)ProcStackPtrLimit;
664 __ASM volatile ("MSR psplim_ns, %0\n" : : "r" (ProcStackPtrLimit));
671 \brief Get Main Stack Pointer Limit
672 Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
673 Stack Pointer Limit register hence zero is returned always in non-secure
676 \details Returns the current value of the Main Stack Pointer Limit (MSPLIM).
677 \return MSPLIM Register value
679 __STATIC_FORCEINLINE uint32_t __get_MSPLIM(void)
681 #if (!(defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) && \
682 (!defined (__ARM_FEATURE_CMSE) || (__ARM_FEATURE_CMSE < 3)))
683 // without main extensions, the non-secure MSPLIM is RAZ/WI
686 register uint32_t result;
687 __ASM volatile ("MRS %0, msplim" : "=r" (result) );
693 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
695 \brief Get Main Stack Pointer Limit (non-secure)
696 Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
697 Stack Pointer Limit register hence zero is returned always.
699 \details Returns the current value of the non-secure Main Stack Pointer Limit(MSPLIM) when in secure state.
700 \return MSPLIM Register value
702 __STATIC_FORCEINLINE uint32_t __TZ_get_MSPLIM_NS(void)
704 #if (!(defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)))
705 // without main extensions, the non-secure MSPLIM is RAZ/WI
708 register uint32_t result;
709 __ASM volatile ("MRS %0, msplim_ns" : "=r" (result) );
717 \brief Set Main Stack Pointer Limit
718 Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
719 Stack Pointer Limit register hence the write is silently ignored in non-secure
722 \details Assigns the given value to the Main Stack Pointer Limit (MSPLIM).
723 \param [in] MainStackPtrLimit Main Stack Pointer Limit value to set
725 __STATIC_FORCEINLINE void __set_MSPLIM(uint32_t MainStackPtrLimit)
727 #if (!(defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) && \
728 (!defined (__ARM_FEATURE_CMSE) || (__ARM_FEATURE_CMSE < 3)))
729 // without main extensions, the non-secure MSPLIM is RAZ/WI
730 (void)MainStackPtrLimit;
732 __ASM volatile ("MSR msplim, %0" : : "r" (MainStackPtrLimit));
737 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
739 \brief Set Main Stack Pointer Limit (non-secure)
740 Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
741 Stack Pointer Limit register hence the write is silently ignored.
743 \details Assigns the given value to the non-secure Main Stack Pointer Limit (MSPLIM) when in secure state.
744 \param [in] MainStackPtrLimit Main Stack Pointer value to set
746 __STATIC_FORCEINLINE void __TZ_set_MSPLIM_NS(uint32_t MainStackPtrLimit)
748 #if (!(defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)))
749 // without main extensions, the non-secure MSPLIM is RAZ/WI
750 (void)MainStackPtrLimit;
752 __ASM volatile ("MSR msplim_ns, %0" : : "r" (MainStackPtrLimit));
757 #endif /* ((defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) || \
758 (defined (__ARM_ARCH_8M_BASE__ ) && (__ARM_ARCH_8M_BASE__ == 1)) ) */
761 #if ((defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
762 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) )
766 \details Returns the current value of the Floating Point Status/Control register.
767 \return Floating Point Status/Control register value
769 __STATIC_FORCEINLINE uint32_t __get_FPSCR(void)
771 #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
772 (defined (__FPU_USED ) && (__FPU_USED == 1U)) )
773 #if __has_builtin(__builtin_arm_get_fpscr)
774 // Re-enable using built-in when GCC has been fixed
775 // || (__GNUC__ > 7) || (__GNUC__ == 7 && __GNUC_MINOR__ >= 2)
776 /* see https://gcc.gnu.org/ml/gcc-patches/2017-04/msg00443.html */
777 return __builtin_arm_get_fpscr();
781 __ASM volatile ("VMRS %0, fpscr" : "=r" (result) );
792 \details Assigns the given value to the Floating Point Status/Control register.
793 \param [in] fpscr Floating Point Status/Control value to set
795 __STATIC_FORCEINLINE void __set_FPSCR(uint32_t fpscr)
797 #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
798 (defined (__FPU_USED ) && (__FPU_USED == 1U)) )
799 #if __has_builtin(__builtin_arm_set_fpscr)
800 // Re-enable using built-in when GCC has been fixed
801 // || (__GNUC__ > 7) || (__GNUC__ == 7 && __GNUC_MINOR__ >= 2)
802 /* see https://gcc.gnu.org/ml/gcc-patches/2017-04/msg00443.html */
803 __builtin_arm_set_fpscr(fpscr);
805 __ASM volatile ("VMSR fpscr, %0" : : "r" (fpscr) : "vfpcc", "memory");
812 #endif /* ((defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
813 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) ) */
817 /*@} end of CMSIS_Core_RegAccFunctions */
820 /* ########################## Core Instruction Access ######################### */
821 /** \defgroup CMSIS_Core_InstructionInterface CMSIS Core Instruction Interface
822 Access to dedicated instructions
826 /* Define macros for porting to both thumb1 and thumb2.
827 * For thumb1, use low register (r0-r7), specified by constraint "l"
828 * Otherwise, use general registers, specified by constraint "r" */
829 #if defined (__thumb__) && !defined (__thumb2__)
830 #define __CMSIS_GCC_OUT_REG(r) "=l" (r)
831 #define __CMSIS_GCC_RW_REG(r) "+l" (r)
832 #define __CMSIS_GCC_USE_REG(r) "l" (r)
834 #define __CMSIS_GCC_OUT_REG(r) "=r" (r)
835 #define __CMSIS_GCC_RW_REG(r) "+r" (r)
836 #define __CMSIS_GCC_USE_REG(r) "r" (r)
841 \details No Operation does nothing. This instruction can be used for code alignment purposes.
843 #define __NOP() __ASM volatile ("nop")
846 \brief Wait For Interrupt
847 \details Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs.
849 #define __WFI() __ASM volatile ("wfi")
853 \brief Wait For Event
854 \details Wait For Event is a hint instruction that permits the processor to enter
855 a low-power state until one of a number of events occurs.
857 #define __WFE() __ASM volatile ("wfe")
862 \details Send Event is a hint instruction. It causes an event to be signaled to the CPU.
864 #define __SEV() __ASM volatile ("sev")
868 \brief Instruction Synchronization Barrier
869 \details Instruction Synchronization Barrier flushes the pipeline in the processor,
870 so that all instructions following the ISB are fetched from cache or memory,
871 after the instruction has been completed.
873 __STATIC_FORCEINLINE void __ISB(void)
875 __ASM volatile ("isb 0xF":::"memory");
880 \brief Data Synchronization Barrier
881 \details Acts as a special kind of Data Memory Barrier.
882 It completes when all explicit memory accesses before this instruction complete.
884 __STATIC_FORCEINLINE void __DSB(void)
886 __ASM volatile ("dsb 0xF":::"memory");
891 \brief Data Memory Barrier
892 \details Ensures the apparent order of the explicit memory operations before
893 and after the instruction, without ensuring their completion.
895 __STATIC_FORCEINLINE void __DMB(void)
897 __ASM volatile ("dmb 0xF":::"memory");
902 \brief Reverse byte order (32 bit)
903 \details Reverses the byte order in unsigned integer value. For example, 0x12345678 becomes 0x78563412.
904 \param [in] value Value to reverse
905 \return Reversed value
907 __STATIC_FORCEINLINE uint32_t __REV(uint32_t value)
909 #if (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
910 return __builtin_bswap32(value);
914 __ASM volatile ("rev %0, %1" : __CMSIS_GCC_OUT_REG (result) : __CMSIS_GCC_USE_REG (value) );
921 \brief Reverse byte order (16 bit)
922 \details Reverses the byte order within each halfword of a word. For example, 0x12345678 becomes 0x34127856.
923 \param [in] value Value to reverse
924 \return Reversed value
926 __STATIC_FORCEINLINE uint32_t __REV16(uint32_t value)
930 __ASM volatile ("rev16 %0, %1" : __CMSIS_GCC_OUT_REG (result) : __CMSIS_GCC_USE_REG (value) );
936 \brief Reverse byte order (16 bit)
937 \details Reverses the byte order in a 16-bit value and returns the signed 16-bit result. For example, 0x0080 becomes 0x8000.
938 \param [in] value Value to reverse
939 \return Reversed value
941 __STATIC_FORCEINLINE int16_t __REVSH(int16_t value)
943 #if (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
944 return (int16_t)__builtin_bswap16(value);
948 __ASM volatile ("revsh %0, %1" : __CMSIS_GCC_OUT_REG (result) : __CMSIS_GCC_USE_REG (value) );
955 \brief Rotate Right in unsigned value (32 bit)
956 \details Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits.
957 \param [in] op1 Value to rotate
958 \param [in] op2 Number of Bits to rotate
959 \return Rotated value
961 __STATIC_FORCEINLINE uint32_t __ROR(uint32_t op1, uint32_t op2)
968 return (op1 >> op2) | (op1 << (32U - op2));
974 \details Causes the processor to enter Debug state.
975 Debug tools can use this to investigate system state when the instruction at a particular address is reached.
976 \param [in] value is ignored by the processor.
977 If required, a debugger can use it to store additional information about the breakpoint.
979 #define __BKPT(value) __ASM volatile ("bkpt "#value)
983 \brief Reverse bit order of value
984 \details Reverses the bit order of the given value.
985 \param [in] value Value to reverse
986 \return Reversed value
988 __STATIC_FORCEINLINE uint32_t __RBIT(uint32_t value)
992 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
993 (defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
994 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) )
995 __ASM volatile ("rbit %0, %1" : "=r" (result) : "r" (value) );
997 uint32_t s = (4U /*sizeof(v)*/ * 8U) - 1U; /* extra shift needed at end */
999 result = value; /* r will be reversed bits of v; first get LSB of v */
1000 for (value >>= 1U; value != 0U; value >>= 1U)
1003 result |= value & 1U;
1006 result <<= s; /* shift when v's highest bits are zero */
1013 \brief Count leading zeros
1014 \details Counts the number of leading zeros of a data value.
1015 \param [in] value Value to count the leading zeros
1016 \return number of leading zeros in value
1018 #define __CLZ (uint8_t)__builtin_clz
1021 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
1022 (defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
1023 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) || \
1024 (defined (__ARM_ARCH_8M_BASE__ ) && (__ARM_ARCH_8M_BASE__ == 1)) )
1026 \brief LDR Exclusive (8 bit)
1027 \details Executes a exclusive LDR instruction for 8 bit value.
1028 \param [in] ptr Pointer to data
1029 \return value of type uint8_t at (*ptr)
1031 __STATIC_FORCEINLINE uint8_t __LDREXB(volatile uint8_t *addr)
1035 #if (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
1036 __ASM volatile ("ldrexb %0, %1" : "=r" (result) : "Q" (*addr) );
1038 /* Prior to GCC 4.8, "Q" will be expanded to [rx, #0] which is not
1039 accepted by assembler. So has to use following less efficient pattern.
1041 __ASM volatile ("ldrexb %0, [%1]" : "=r" (result) : "r" (addr) : "memory" );
1043 return ((uint8_t) result); /* Add explicit type cast here */
1048 \brief LDR Exclusive (16 bit)
1049 \details Executes a exclusive LDR instruction for 16 bit values.
1050 \param [in] ptr Pointer to data
1051 \return value of type uint16_t at (*ptr)
1053 __STATIC_FORCEINLINE uint16_t __LDREXH(volatile uint16_t *addr)
1057 #if (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
1058 __ASM volatile ("ldrexh %0, %1" : "=r" (result) : "Q" (*addr) );
1060 /* Prior to GCC 4.8, "Q" will be expanded to [rx, #0] which is not
1061 accepted by assembler. So has to use following less efficient pattern.
1063 __ASM volatile ("ldrexh %0, [%1]" : "=r" (result) : "r" (addr) : "memory" );
1065 return ((uint16_t) result); /* Add explicit type cast here */
1070 \brief LDR Exclusive (32 bit)
1071 \details Executes a exclusive LDR instruction for 32 bit values.
1072 \param [in] ptr Pointer to data
1073 \return value of type uint32_t at (*ptr)
1075 __STATIC_FORCEINLINE uint32_t __LDREXW(volatile uint32_t *addr)
1079 __ASM volatile ("ldrex %0, %1" : "=r" (result) : "Q" (*addr) );
1085 \brief STR Exclusive (8 bit)
1086 \details Executes a exclusive STR instruction for 8 bit values.
1087 \param [in] value Value to store
1088 \param [in] ptr Pointer to location
1089 \return 0 Function succeeded
1090 \return 1 Function failed
1092 __STATIC_FORCEINLINE uint32_t __STREXB(uint8_t value, volatile uint8_t *addr)
1096 __ASM volatile ("strexb %0, %2, %1" : "=&r" (result), "=Q" (*addr) : "r" ((uint32_t)value) );
1102 \brief STR Exclusive (16 bit)
1103 \details Executes a exclusive STR instruction for 16 bit values.
1104 \param [in] value Value to store
1105 \param [in] ptr Pointer to location
1106 \return 0 Function succeeded
1107 \return 1 Function failed
1109 __STATIC_FORCEINLINE uint32_t __STREXH(uint16_t value, volatile uint16_t *addr)
1113 __ASM volatile ("strexh %0, %2, %1" : "=&r" (result), "=Q" (*addr) : "r" ((uint32_t)value) );
1119 \brief STR Exclusive (32 bit)
1120 \details Executes a exclusive STR instruction for 32 bit values.
1121 \param [in] value Value to store
1122 \param [in] ptr Pointer to location
1123 \return 0 Function succeeded
1124 \return 1 Function failed
1126 __STATIC_FORCEINLINE uint32_t __STREXW(uint32_t value, volatile uint32_t *addr)
1130 __ASM volatile ("strex %0, %2, %1" : "=&r" (result), "=Q" (*addr) : "r" (value) );
1136 \brief Remove the exclusive lock
1137 \details Removes the exclusive lock which is created by LDREX.
1139 __STATIC_FORCEINLINE void __CLREX(void)
1141 __ASM volatile ("clrex" ::: "memory");
1144 #endif /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
1145 (defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
1146 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) || \
1147 (defined (__ARM_ARCH_8M_BASE__ ) && (__ARM_ARCH_8M_BASE__ == 1)) ) */
1150 #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
1151 (defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
1152 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) )
1154 \brief Signed Saturate
1155 \details Saturates a signed value.
1156 \param [in] ARG1 Value to be saturated
1157 \param [in] ARG2 Bit position to saturate to (1..32)
1158 \return Saturated value
1160 #define __SSAT(ARG1,ARG2) \
1163 int32_t __RES, __ARG1 = (ARG1); \
1164 __ASM ("ssat %0, %1, %2" : "=r" (__RES) : "I" (ARG2), "r" (__ARG1) ); \
1170 \brief Unsigned Saturate
1171 \details Saturates an unsigned value.
1172 \param [in] ARG1 Value to be saturated
1173 \param [in] ARG2 Bit position to saturate to (0..31)
1174 \return Saturated value
1176 #define __USAT(ARG1,ARG2) \
1179 uint32_t __RES, __ARG1 = (ARG1); \
1180 __ASM ("usat %0, %1, %2" : "=r" (__RES) : "I" (ARG2), "r" (__ARG1) ); \
1186 \brief Rotate Right with Extend (32 bit)
1187 \details Moves each bit of a bitstring right by one bit.
1188 The carry input is shifted in at the left end of the bitstring.
1189 \param [in] value Value to rotate
1190 \return Rotated value
1192 __STATIC_FORCEINLINE uint32_t __RRX(uint32_t value)
1196 __ASM volatile ("rrx %0, %1" : __CMSIS_GCC_OUT_REG (result) : __CMSIS_GCC_USE_REG (value) );
1202 \brief LDRT Unprivileged (8 bit)
1203 \details Executes a Unprivileged LDRT instruction for 8 bit value.
1204 \param [in] ptr Pointer to data
1205 \return value of type uint8_t at (*ptr)
1207 __STATIC_FORCEINLINE uint8_t __LDRBT(volatile uint8_t *ptr)
1211 #if (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
1212 __ASM volatile ("ldrbt %0, %1" : "=r" (result) : "Q" (*ptr) );
1214 /* Prior to GCC 4.8, "Q" will be expanded to [rx, #0] which is not
1215 accepted by assembler. So has to use following less efficient pattern.
1217 __ASM volatile ("ldrbt %0, [%1]" : "=r" (result) : "r" (ptr) : "memory" );
1219 return ((uint8_t) result); /* Add explicit type cast here */
1224 \brief LDRT Unprivileged (16 bit)
1225 \details Executes a Unprivileged LDRT instruction for 16 bit values.
1226 \param [in] ptr Pointer to data
1227 \return value of type uint16_t at (*ptr)
1229 __STATIC_FORCEINLINE uint16_t __LDRHT(volatile uint16_t *ptr)
1233 #if (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
1234 __ASM volatile ("ldrht %0, %1" : "=r" (result) : "Q" (*ptr) );
1236 /* Prior to GCC 4.8, "Q" will be expanded to [rx, #0] which is not
1237 accepted by assembler. So has to use following less efficient pattern.
1239 __ASM volatile ("ldrht %0, [%1]" : "=r" (result) : "r" (ptr) : "memory" );
1241 return ((uint16_t) result); /* Add explicit type cast here */
1246 \brief LDRT Unprivileged (32 bit)
1247 \details Executes a Unprivileged LDRT instruction for 32 bit values.
1248 \param [in] ptr Pointer to data
1249 \return value of type uint32_t at (*ptr)
1251 __STATIC_FORCEINLINE uint32_t __LDRT(volatile uint32_t *ptr)
1255 __ASM volatile ("ldrt %0, %1" : "=r" (result) : "Q" (*ptr) );
1261 \brief STRT Unprivileged (8 bit)
1262 \details Executes a Unprivileged STRT instruction for 8 bit values.
1263 \param [in] value Value to store
1264 \param [in] ptr Pointer to location
1266 __STATIC_FORCEINLINE void __STRBT(uint8_t value, volatile uint8_t *ptr)
1268 __ASM volatile ("strbt %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) );
1273 \brief STRT Unprivileged (16 bit)
1274 \details Executes a Unprivileged STRT instruction for 16 bit values.
1275 \param [in] value Value to store
1276 \param [in] ptr Pointer to location
1278 __STATIC_FORCEINLINE void __STRHT(uint16_t value, volatile uint16_t *ptr)
1280 __ASM volatile ("strht %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) );
1285 \brief STRT Unprivileged (32 bit)
1286 \details Executes a Unprivileged STRT instruction for 32 bit values.
1287 \param [in] value Value to store
1288 \param [in] ptr Pointer to location
1290 __STATIC_FORCEINLINE void __STRT(uint32_t value, volatile uint32_t *ptr)
1292 __ASM volatile ("strt %1, %0" : "=Q" (*ptr) : "r" (value) );
1295 #else /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
1296 (defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
1297 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) ) */
1300 \brief Signed Saturate
1301 \details Saturates a signed value.
1302 \param [in] value Value to be saturated
1303 \param [in] sat Bit position to saturate to (1..32)
1304 \return Saturated value
1306 __STATIC_FORCEINLINE int32_t __SSAT(int32_t val, uint32_t sat)
1308 if ((sat >= 1U) && (sat <= 32U))
1310 const int32_t max = (int32_t)((1U << (sat - 1U)) - 1U);
1311 const int32_t min = -1 - max ;
1325 \brief Unsigned Saturate
1326 \details Saturates an unsigned value.
1327 \param [in] value Value to be saturated
1328 \param [in] sat Bit position to saturate to (0..31)
1329 \return Saturated value
1331 __STATIC_FORCEINLINE uint32_t __USAT(int32_t val, uint32_t sat)
1335 const uint32_t max = ((1U << sat) - 1U);
1336 if (val > (int32_t)max)
1345 return (uint32_t)val;
1348 #endif /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
1349 (defined (__ARM_ARCH_7EM__ ) && (__ARM_ARCH_7EM__ == 1)) || \
1350 (defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) ) */
1353 #if ((defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) || \
1354 (defined (__ARM_ARCH_8M_BASE__ ) && (__ARM_ARCH_8M_BASE__ == 1)) )
1356 \brief Load-Acquire (8 bit)
1357 \details Executes a LDAB instruction for 8 bit value.
1358 \param [in] ptr Pointer to data
1359 \return value of type uint8_t at (*ptr)
1361 __STATIC_FORCEINLINE uint8_t __LDAB(volatile uint8_t *ptr)
1365 __ASM volatile ("ldab %0, %1" : "=r" (result) : "Q" (*ptr) );
1366 return ((uint8_t) result);
1371 \brief Load-Acquire (16 bit)
1372 \details Executes a LDAH instruction for 16 bit values.
1373 \param [in] ptr Pointer to data
1374 \return value of type uint16_t at (*ptr)
1376 __STATIC_FORCEINLINE uint16_t __LDAH(volatile uint16_t *ptr)
1380 __ASM volatile ("ldah %0, %1" : "=r" (result) : "Q" (*ptr) );
1381 return ((uint16_t) result);
1386 \brief Load-Acquire (32 bit)
1387 \details Executes a LDA instruction for 32 bit values.
1388 \param [in] ptr Pointer to data
1389 \return value of type uint32_t at (*ptr)
1391 __STATIC_FORCEINLINE uint32_t __LDA(volatile uint32_t *ptr)
1395 __ASM volatile ("lda %0, %1" : "=r" (result) : "Q" (*ptr) );
1401 \brief Store-Release (8 bit)
1402 \details Executes a STLB instruction for 8 bit values.
1403 \param [in] value Value to store
1404 \param [in] ptr Pointer to location
1406 __STATIC_FORCEINLINE void __STLB(uint8_t value, volatile uint8_t *ptr)
1408 __ASM volatile ("stlb %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) );
1413 \brief Store-Release (16 bit)
1414 \details Executes a STLH instruction for 16 bit values.
1415 \param [in] value Value to store
1416 \param [in] ptr Pointer to location
1418 __STATIC_FORCEINLINE void __STLH(uint16_t value, volatile uint16_t *ptr)
1420 __ASM volatile ("stlh %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) );
1425 \brief Store-Release (32 bit)
1426 \details Executes a STL instruction for 32 bit values.
1427 \param [in] value Value to store
1428 \param [in] ptr Pointer to location
1430 __STATIC_FORCEINLINE void __STL(uint32_t value, volatile uint32_t *ptr)
1432 __ASM volatile ("stl %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) );
1437 \brief Load-Acquire Exclusive (8 bit)
1438 \details Executes a LDAB exclusive instruction for 8 bit value.
1439 \param [in] ptr Pointer to data
1440 \return value of type uint8_t at (*ptr)
1442 __STATIC_FORCEINLINE uint8_t __LDAEXB(volatile uint8_t *ptr)
1446 __ASM volatile ("ldaexb %0, %1" : "=r" (result) : "Q" (*ptr) );
1447 return ((uint8_t) result);
1452 \brief Load-Acquire Exclusive (16 bit)
1453 \details Executes a LDAH exclusive instruction for 16 bit values.
1454 \param [in] ptr Pointer to data
1455 \return value of type uint16_t at (*ptr)
1457 __STATIC_FORCEINLINE uint16_t __LDAEXH(volatile uint16_t *ptr)
1461 __ASM volatile ("ldaexh %0, %1" : "=r" (result) : "Q" (*ptr) );
1462 return ((uint16_t) result);
1467 \brief Load-Acquire Exclusive (32 bit)
1468 \details Executes a LDA exclusive instruction for 32 bit values.
1469 \param [in] ptr Pointer to data
1470 \return value of type uint32_t at (*ptr)
1472 __STATIC_FORCEINLINE uint32_t __LDAEX(volatile uint32_t *ptr)
1476 __ASM volatile ("ldaex %0, %1" : "=r" (result) : "Q" (*ptr) );
1482 \brief Store-Release Exclusive (8 bit)
1483 \details Executes a STLB exclusive instruction for 8 bit values.
1484 \param [in] value Value to store
1485 \param [in] ptr Pointer to location
1486 \return 0 Function succeeded
1487 \return 1 Function failed
1489 __STATIC_FORCEINLINE uint32_t __STLEXB(uint8_t value, volatile uint8_t *ptr)
1493 __ASM volatile ("stlexb %0, %2, %1" : "=&r" (result), "=Q" (*ptr) : "r" ((uint32_t)value) );
1499 \brief Store-Release Exclusive (16 bit)
1500 \details Executes a STLH exclusive instruction for 16 bit values.
1501 \param [in] value Value to store
1502 \param [in] ptr Pointer to location
1503 \return 0 Function succeeded
1504 \return 1 Function failed
1506 __STATIC_FORCEINLINE uint32_t __STLEXH(uint16_t value, volatile uint16_t *ptr)
1510 __ASM volatile ("stlexh %0, %2, %1" : "=&r" (result), "=Q" (*ptr) : "r" ((uint32_t)value) );
1516 \brief Store-Release Exclusive (32 bit)
1517 \details Executes a STL exclusive instruction for 32 bit values.
1518 \param [in] value Value to store
1519 \param [in] ptr Pointer to location
1520 \return 0 Function succeeded
1521 \return 1 Function failed
1523 __STATIC_FORCEINLINE uint32_t __STLEX(uint32_t value, volatile uint32_t *ptr)
1527 __ASM volatile ("stlex %0, %2, %1" : "=&r" (result), "=Q" (*ptr) : "r" ((uint32_t)value) );
1531 #endif /* ((defined (__ARM_ARCH_8M_MAIN__ ) && (__ARM_ARCH_8M_MAIN__ == 1)) || \
1532 (defined (__ARM_ARCH_8M_BASE__ ) && (__ARM_ARCH_8M_BASE__ == 1)) ) */
1534 /*@}*/ /* end of group CMSIS_Core_InstructionInterface */
1537 /* ################### Compiler specific Intrinsics ########################### */
1538 /** \defgroup CMSIS_SIMD_intrinsics CMSIS SIMD Intrinsics
1539 Access to dedicated SIMD instructions
1543 #if (defined (__ARM_FEATURE_DSP) && (__ARM_FEATURE_DSP == 1))
1545 __STATIC_FORCEINLINE uint32_t __SADD8(uint32_t op1, uint32_t op2)
1549 __ASM volatile ("sadd8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1553 __STATIC_FORCEINLINE uint32_t __QADD8(uint32_t op1, uint32_t op2)
1557 __ASM volatile ("qadd8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1561 __STATIC_FORCEINLINE uint32_t __SHADD8(uint32_t op1, uint32_t op2)
1565 __ASM volatile ("shadd8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1569 __STATIC_FORCEINLINE uint32_t __UADD8(uint32_t op1, uint32_t op2)
1573 __ASM volatile ("uadd8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1577 __STATIC_FORCEINLINE uint32_t __UQADD8(uint32_t op1, uint32_t op2)
1581 __ASM volatile ("uqadd8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1585 __STATIC_FORCEINLINE uint32_t __UHADD8(uint32_t op1, uint32_t op2)
1589 __ASM volatile ("uhadd8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1594 __STATIC_FORCEINLINE uint32_t __SSUB8(uint32_t op1, uint32_t op2)
1598 __ASM volatile ("ssub8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1602 __STATIC_FORCEINLINE uint32_t __QSUB8(uint32_t op1, uint32_t op2)
1606 __ASM volatile ("qsub8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1610 __STATIC_FORCEINLINE uint32_t __SHSUB8(uint32_t op1, uint32_t op2)
1614 __ASM volatile ("shsub8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1618 __STATIC_FORCEINLINE uint32_t __USUB8(uint32_t op1, uint32_t op2)
1622 __ASM volatile ("usub8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1626 __STATIC_FORCEINLINE uint32_t __UQSUB8(uint32_t op1, uint32_t op2)
1630 __ASM volatile ("uqsub8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1634 __STATIC_FORCEINLINE uint32_t __UHSUB8(uint32_t op1, uint32_t op2)
1638 __ASM volatile ("uhsub8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1643 __STATIC_FORCEINLINE uint32_t __SADD16(uint32_t op1, uint32_t op2)
1647 __ASM volatile ("sadd16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1651 __STATIC_FORCEINLINE uint32_t __QADD16(uint32_t op1, uint32_t op2)
1655 __ASM volatile ("qadd16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1659 __STATIC_FORCEINLINE uint32_t __SHADD16(uint32_t op1, uint32_t op2)
1663 __ASM volatile ("shadd16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1667 __STATIC_FORCEINLINE uint32_t __UADD16(uint32_t op1, uint32_t op2)
1671 __ASM volatile ("uadd16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1675 __STATIC_FORCEINLINE uint32_t __UQADD16(uint32_t op1, uint32_t op2)
1679 __ASM volatile ("uqadd16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1683 __STATIC_FORCEINLINE uint32_t __UHADD16(uint32_t op1, uint32_t op2)
1687 __ASM volatile ("uhadd16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1691 __STATIC_FORCEINLINE uint32_t __SSUB16(uint32_t op1, uint32_t op2)
1695 __ASM volatile ("ssub16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1699 __STATIC_FORCEINLINE uint32_t __QSUB16(uint32_t op1, uint32_t op2)
1703 __ASM volatile ("qsub16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1707 __STATIC_FORCEINLINE uint32_t __SHSUB16(uint32_t op1, uint32_t op2)
1711 __ASM volatile ("shsub16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1715 __STATIC_FORCEINLINE uint32_t __USUB16(uint32_t op1, uint32_t op2)
1719 __ASM volatile ("usub16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1723 __STATIC_FORCEINLINE uint32_t __UQSUB16(uint32_t op1, uint32_t op2)
1727 __ASM volatile ("uqsub16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1731 __STATIC_FORCEINLINE uint32_t __UHSUB16(uint32_t op1, uint32_t op2)
1735 __ASM volatile ("uhsub16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1739 __STATIC_FORCEINLINE uint32_t __SASX(uint32_t op1, uint32_t op2)
1743 __ASM volatile ("sasx %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1747 __STATIC_FORCEINLINE uint32_t __QASX(uint32_t op1, uint32_t op2)
1751 __ASM volatile ("qasx %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1755 __STATIC_FORCEINLINE uint32_t __SHASX(uint32_t op1, uint32_t op2)
1759 __ASM volatile ("shasx %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1763 __STATIC_FORCEINLINE uint32_t __UASX(uint32_t op1, uint32_t op2)
1767 __ASM volatile ("uasx %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1771 __STATIC_FORCEINLINE uint32_t __UQASX(uint32_t op1, uint32_t op2)
1775 __ASM volatile ("uqasx %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1779 __STATIC_FORCEINLINE uint32_t __UHASX(uint32_t op1, uint32_t op2)
1783 __ASM volatile ("uhasx %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1787 __STATIC_FORCEINLINE uint32_t __SSAX(uint32_t op1, uint32_t op2)
1791 __ASM volatile ("ssax %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1795 __STATIC_FORCEINLINE uint32_t __QSAX(uint32_t op1, uint32_t op2)
1799 __ASM volatile ("qsax %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1803 __STATIC_FORCEINLINE uint32_t __SHSAX(uint32_t op1, uint32_t op2)
1807 __ASM volatile ("shsax %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1811 __STATIC_FORCEINLINE uint32_t __USAX(uint32_t op1, uint32_t op2)
1815 __ASM volatile ("usax %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1819 __STATIC_FORCEINLINE uint32_t __UQSAX(uint32_t op1, uint32_t op2)
1823 __ASM volatile ("uqsax %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1827 __STATIC_FORCEINLINE uint32_t __UHSAX(uint32_t op1, uint32_t op2)
1831 __ASM volatile ("uhsax %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1835 __STATIC_FORCEINLINE uint32_t __USAD8(uint32_t op1, uint32_t op2)
1839 __ASM volatile ("usad8 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1843 __STATIC_FORCEINLINE uint32_t __USADA8(uint32_t op1, uint32_t op2, uint32_t op3)
1847 __ASM volatile ("usada8 %0, %1, %2, %3" : "=r" (result) : "r" (op1), "r" (op2), "r" (op3) );
1851 #define __SSAT16(ARG1,ARG2) \
1853 int32_t __RES, __ARG1 = (ARG1); \
1854 __ASM ("ssat16 %0, %1, %2" : "=r" (__RES) : "I" (ARG2), "r" (__ARG1) ); \
1858 #define __USAT16(ARG1,ARG2) \
1860 uint32_t __RES, __ARG1 = (ARG1); \
1861 __ASM ("usat16 %0, %1, %2" : "=r" (__RES) : "I" (ARG2), "r" (__ARG1) ); \
1865 __STATIC_FORCEINLINE uint32_t __UXTB16(uint32_t op1)
1869 __ASM volatile ("uxtb16 %0, %1" : "=r" (result) : "r" (op1));
1873 __STATIC_FORCEINLINE uint32_t __UXTAB16(uint32_t op1, uint32_t op2)
1877 __ASM volatile ("uxtab16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1881 __STATIC_FORCEINLINE uint32_t __SXTB16(uint32_t op1)
1885 __ASM volatile ("sxtb16 %0, %1" : "=r" (result) : "r" (op1));
1889 __STATIC_FORCEINLINE uint32_t __SXTAB16(uint32_t op1, uint32_t op2)
1893 __ASM volatile ("sxtab16 %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1897 __STATIC_FORCEINLINE uint32_t __SMUAD (uint32_t op1, uint32_t op2)
1901 __ASM volatile ("smuad %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1905 __STATIC_FORCEINLINE uint32_t __SMUADX (uint32_t op1, uint32_t op2)
1909 __ASM volatile ("smuadx %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1913 __STATIC_FORCEINLINE uint32_t __SMLAD (uint32_t op1, uint32_t op2, uint32_t op3)
1917 __ASM volatile ("smlad %0, %1, %2, %3" : "=r" (result) : "r" (op1), "r" (op2), "r" (op3) );
1921 __STATIC_FORCEINLINE uint32_t __SMLADX (uint32_t op1, uint32_t op2, uint32_t op3)
1925 __ASM volatile ("smladx %0, %1, %2, %3" : "=r" (result) : "r" (op1), "r" (op2), "r" (op3) );
1929 __STATIC_FORCEINLINE uint64_t __SMLALD (uint32_t op1, uint32_t op2, uint64_t acc)
1937 #ifndef __ARMEB__ /* Little endian */
1938 __ASM volatile ("smlald %0, %1, %2, %3" : "=r" (llr.w32[0]), "=r" (llr.w32[1]): "r" (op1), "r" (op2) , "0" (llr.w32[0]), "1" (llr.w32[1]) );
1939 #else /* Big endian */
1940 __ASM volatile ("smlald %0, %1, %2, %3" : "=r" (llr.w32[1]), "=r" (llr.w32[0]): "r" (op1), "r" (op2) , "0" (llr.w32[1]), "1" (llr.w32[0]) );
1946 __STATIC_FORCEINLINE uint64_t __SMLALDX (uint32_t op1, uint32_t op2, uint64_t acc)
1954 #ifndef __ARMEB__ /* Little endian */
1955 __ASM volatile ("smlaldx %0, %1, %2, %3" : "=r" (llr.w32[0]), "=r" (llr.w32[1]): "r" (op1), "r" (op2) , "0" (llr.w32[0]), "1" (llr.w32[1]) );
1956 #else /* Big endian */
1957 __ASM volatile ("smlaldx %0, %1, %2, %3" : "=r" (llr.w32[1]), "=r" (llr.w32[0]): "r" (op1), "r" (op2) , "0" (llr.w32[1]), "1" (llr.w32[0]) );
1963 __STATIC_FORCEINLINE uint32_t __SMUSD (uint32_t op1, uint32_t op2)
1967 __ASM volatile ("smusd %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1971 __STATIC_FORCEINLINE uint32_t __SMUSDX (uint32_t op1, uint32_t op2)
1975 __ASM volatile ("smusdx %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
1979 __STATIC_FORCEINLINE uint32_t __SMLSD (uint32_t op1, uint32_t op2, uint32_t op3)
1983 __ASM volatile ("smlsd %0, %1, %2, %3" : "=r" (result) : "r" (op1), "r" (op2), "r" (op3) );
1987 __STATIC_FORCEINLINE uint32_t __SMLSDX (uint32_t op1, uint32_t op2, uint32_t op3)
1991 __ASM volatile ("smlsdx %0, %1, %2, %3" : "=r" (result) : "r" (op1), "r" (op2), "r" (op3) );
1995 __STATIC_FORCEINLINE uint64_t __SMLSLD (uint32_t op1, uint32_t op2, uint64_t acc)
2003 #ifndef __ARMEB__ /* Little endian */
2004 __ASM volatile ("smlsld %0, %1, %2, %3" : "=r" (llr.w32[0]), "=r" (llr.w32[1]): "r" (op1), "r" (op2) , "0" (llr.w32[0]), "1" (llr.w32[1]) );
2005 #else /* Big endian */
2006 __ASM volatile ("smlsld %0, %1, %2, %3" : "=r" (llr.w32[1]), "=r" (llr.w32[0]): "r" (op1), "r" (op2) , "0" (llr.w32[1]), "1" (llr.w32[0]) );
2012 __STATIC_FORCEINLINE uint64_t __SMLSLDX (uint32_t op1, uint32_t op2, uint64_t acc)
2020 #ifndef __ARMEB__ /* Little endian */
2021 __ASM volatile ("smlsldx %0, %1, %2, %3" : "=r" (llr.w32[0]), "=r" (llr.w32[1]): "r" (op1), "r" (op2) , "0" (llr.w32[0]), "1" (llr.w32[1]) );
2022 #else /* Big endian */
2023 __ASM volatile ("smlsldx %0, %1, %2, %3" : "=r" (llr.w32[1]), "=r" (llr.w32[0]): "r" (op1), "r" (op2) , "0" (llr.w32[1]), "1" (llr.w32[0]) );
2029 __STATIC_FORCEINLINE uint32_t __SEL (uint32_t op1, uint32_t op2)
2033 __ASM volatile ("sel %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
2037 __STATIC_FORCEINLINE int32_t __QADD( int32_t op1, int32_t op2)
2041 __ASM volatile ("qadd %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
2045 __STATIC_FORCEINLINE int32_t __QSUB( int32_t op1, int32_t op2)
2049 __ASM volatile ("qsub %0, %1, %2" : "=r" (result) : "r" (op1), "r" (op2) );
2054 #define __PKHBT(ARG1,ARG2,ARG3) \
2056 uint32_t __RES, __ARG1 = (ARG1), __ARG2 = (ARG2); \
2057 __ASM ("pkhbt %0, %1, %2, lsl %3" : "=r" (__RES) : "r" (__ARG1), "r" (__ARG2), "I" (ARG3) ); \
2061 #define __PKHTB(ARG1,ARG2,ARG3) \
2063 uint32_t __RES, __ARG1 = (ARG1), __ARG2 = (ARG2); \
2065 __ASM ("pkhtb %0, %1, %2" : "=r" (__RES) : "r" (__ARG1), "r" (__ARG2) ); \
2067 __ASM ("pkhtb %0, %1, %2, asr %3" : "=r" (__RES) : "r" (__ARG1), "r" (__ARG2), "I" (ARG3) ); \
2072 #define __PKHBT(ARG1,ARG2,ARG3) ( ((((uint32_t)(ARG1)) ) & 0x0000FFFFUL) | \
2073 ((((uint32_t)(ARG2)) << (ARG3)) & 0xFFFF0000UL) )
2075 #define __PKHTB(ARG1,ARG2,ARG3) ( ((((uint32_t)(ARG1)) ) & 0xFFFF0000UL) | \
2076 ((((uint32_t)(ARG2)) >> (ARG3)) & 0x0000FFFFUL) )
2078 __STATIC_FORCEINLINE int32_t __SMMLA (int32_t op1, int32_t op2, int32_t op3)
2082 __ASM volatile ("smmla %0, %1, %2, %3" : "=r" (result): "r" (op1), "r" (op2), "r" (op3) );
2086 #endif /* (__ARM_FEATURE_DSP == 1) */
2087 /*@} end of group CMSIS_SIMD_intrinsics */
2090 #pragma GCC diagnostic pop
2092 #endif /* __CMSIS_GCC_H */