begriffs open source - cmsis/blob - CMSIS/Core/Include/cmsis_armclang.h

   1 /**************************************************************************//**
   2  * @file     cmsis_armclang.h
   3  * @brief    CMSIS compiler armclang (Arm Compiler 6) header file
   4  * @version  V5.3.1
   5  * @date     14. February 2020
   6  ******************************************************************************/
   7 /*
   8  * Copyright (c) 2009-2020 Arm Limited. All rights reserved.
   9  *
  10  * SPDX-License-Identifier: Apache-2.0
  11  *
  12  * Licensed under the Apache License, Version 2.0 (the License); you may
  13  * not use this file except in compliance with the License.
  14  * You may obtain a copy of the License at
  15  *
  16  * www.apache.org/licenses/LICENSE-2.0
  17  *
  18  * Unless required by applicable law or agreed to in writing, software
  19  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  20  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  * See the License for the specific language governing permissions and
  22  * limitations under the License.
  23  */
  24
  25 /*lint -esym(9058, IRQn)*/ /* disable MISRA 2012 Rule 2.4 for IRQn */
  26
  27 #ifndef __CMSIS_ARMCLANG_H
  28 #define __CMSIS_ARMCLANG_H
  29
  30 #pragma clang system_header   /* treat file as system include file */
  31
  32 #ifndef __ARM_COMPAT_H
  33 #include <arm_compat.h>    /* Compatibility header for Arm Compiler 5 intrinsics */
  34 #endif
  35
  36 /* CMSIS compiler specific defines */
  37 #ifndef   __ASM
  38   #define __ASM                                  __asm
  39 #endif
  40 #ifndef   __INLINE
  41   #define __INLINE                               __inline
  42 #endif
  43 #ifndef   __STATIC_INLINE
  44   #define __STATIC_INLINE                        static __inline
  45 #endif
  46 #ifndef   __STATIC_FORCEINLINE
  47   #define __STATIC_FORCEINLINE                   __attribute__((always_inline)) static __inline
  48 #endif
  49 #ifndef   __NO_RETURN
  50   #define __NO_RETURN                            __attribute__((__noreturn__))
  51 #endif
  52 #ifndef   __USED
  53   #define __USED                                 __attribute__((used))
  54 #endif
  55 #ifndef   __WEAK
  56   #define __WEAK                                 __attribute__((weak))
  57 #endif
  58 #ifndef   __PACKED
  59   #define __PACKED                               __attribute__((packed, aligned(1)))
  60 #endif
  61 #ifndef   __PACKED_STRUCT
  62   #define __PACKED_STRUCT                        struct __attribute__((packed, aligned(1)))
  63 #endif
  64 #ifndef   __PACKED_UNION
  65   #define __PACKED_UNION                         union __attribute__((packed, aligned(1)))
  66 #endif
  67 #ifndef   __UNALIGNED_UINT32        /* deprecated */
  68   #pragma clang diagnostic push
  69   #pragma clang diagnostic ignored "-Wpacked"
  70 /*lint -esym(9058, T_UINT32)*/ /* disable MISRA 2012 Rule 2.4 for T_UINT32 */
  71   struct __attribute__((packed)) T_UINT32 { uint32_t v; };
  72   #pragma clang diagnostic pop
  73   #define __UNALIGNED_UINT32(x)                  (((struct T_UINT32 *)(x))->v)
  74 #endif
  75 #ifndef   __UNALIGNED_UINT16_WRITE
  76   #pragma clang diagnostic push
  77   #pragma clang diagnostic ignored "-Wpacked"
  78 /*lint -esym(9058, T_UINT16_WRITE)*/ /* disable MISRA 2012 Rule 2.4 for T_UINT16_WRITE */
  79   __PACKED_STRUCT T_UINT16_WRITE { uint16_t v; };
  80   #pragma clang diagnostic pop
  81   #define __UNALIGNED_UINT16_WRITE(addr, val)    (void)((((struct T_UINT16_WRITE *)(void *)(addr))->v) = (val))
  82 #endif
  83 #ifndef   __UNALIGNED_UINT16_READ
  84   #pragma clang diagnostic push
  85   #pragma clang diagnostic ignored "-Wpacked"
  86 /*lint -esym(9058, T_UINT16_READ)*/ /* disable MISRA 2012 Rule 2.4 for T_UINT16_READ */
  87   __PACKED_STRUCT T_UINT16_READ { uint16_t v; };
  88   #pragma clang diagnostic pop
  89   #define __UNALIGNED_UINT16_READ(addr)          (((const struct T_UINT16_READ *)(const void *)(addr))->v)
  90 #endif
  91 #ifndef   __UNALIGNED_UINT32_WRITE
  92   #pragma clang diagnostic push
  93   #pragma clang diagnostic ignored "-Wpacked"
  94 /*lint -esym(9058, T_UINT32_WRITE)*/ /* disable MISRA 2012 Rule 2.4 for T_UINT32_WRITE */
  95   __PACKED_STRUCT T_UINT32_WRITE { uint32_t v; };
  96   #pragma clang diagnostic pop
  97   #define __UNALIGNED_UINT32_WRITE(addr, val)    (void)((((struct T_UINT32_WRITE *)(void *)(addr))->v) = (val))
  98 #endif
  99 #ifndef   __UNALIGNED_UINT32_READ
 100   #pragma clang diagnostic push
 101   #pragma clang diagnostic ignored "-Wpacked"
 102 /*lint -esym(9058, T_UINT32_READ)*/ /* disable MISRA 2012 Rule 2.4 for T_UINT32_READ */
 103   __PACKED_STRUCT T_UINT32_READ { uint32_t v; };
 104   #pragma clang diagnostic pop
 105   #define __UNALIGNED_UINT32_READ(addr)          (((const struct T_UINT32_READ *)(const void *)(addr))->v)
 106 #endif
 107 #ifndef   __ALIGNED
 108   #define __ALIGNED(x)                           __attribute__((aligned(x)))
 109 #endif
 110 #ifndef   __RESTRICT
 111   #define __RESTRICT                             __restrict
 112 #endif
 113 #ifndef   __COMPILER_BARRIER
 114   #define __COMPILER_BARRIER()                   __ASM volatile("":::"memory")
 115 #endif
 116
 117 /* #########################  Startup and Lowlevel Init  ######################## */
 118
 119 #ifndef __PROGRAM_START
 120 #define __PROGRAM_START           __main
 121 #endif
 122
 123 #ifndef __INITIAL_SP
 124 #define __INITIAL_SP              Image$$ARM_LIB_STACK$$ZI$$Limit
 125 #endif
 126
 127 #ifndef __STACK_LIMIT
 128 #define __STACK_LIMIT             Image$$ARM_LIB_STACK$$ZI$$Base
 129 #endif
 130
 131 #ifndef __VECTOR_TABLE
 132 #define __VECTOR_TABLE            __Vectors
 133 #endif
 134
 135 #ifndef __VECTOR_TABLE_ATTRIBUTE
 136 #define __VECTOR_TABLE_ATTRIBUTE  __attribute((used, section("RESET")))
 137 #endif
 138
 139 /* ###########################  Core Function Access  ########################### */
 140 /** \ingroup  CMSIS_Core_FunctionInterface
 141     \defgroup CMSIS_Core_RegAccFunctions CMSIS Core Register Access Functions
 142   @{
 143  */
 144
 145 /**
 146   \brief   Enable IRQ Interrupts
 147   \details Enables IRQ interrupts by clearing the I-bit in the CPSR.
 148            Can only be executed in Privileged modes.
 149  */
 150 /* intrinsic void __enable_irq();  see arm_compat.h */
 151
 152
 153 /**
 154   \brief   Disable IRQ Interrupts
 155   \details Disables IRQ interrupts by setting the I-bit in the CPSR.
 156            Can only be executed in Privileged modes.
 157  */
 158 /* intrinsic void __disable_irq();  see arm_compat.h */
 159
 160
 161 /**
 162   \brief   Get Control Register
 163   \details Returns the content of the Control Register.
 164   \return               Control Register value
 165  */
 166 __STATIC_FORCEINLINE uint32_t __get_CONTROL(void)
 167 {
 168   uint32_t result;
 169
 170   __ASM volatile ("MRS %0, control" : "=r" (result) );
 171   return(result);
 172 }
 173
 174
 175 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 176 /**
 177   \brief   Get Control Register (non-secure)
 178   \details Returns the content of the non-secure Control Register when in secure mode.
 179   \return               non-secure Control Register value
 180  */
 181 __STATIC_FORCEINLINE uint32_t __TZ_get_CONTROL_NS(void)
 182 {
 183   uint32_t result;
 184
 185   __ASM volatile ("MRS %0, control_ns" : "=r" (result) );
 186   return(result);
 187 }
 188 #endif
 189
 190
 191 /**
 192   \brief   Set Control Register
 193   \details Writes the given value to the Control Register.
 194   \param [in]    control  Control Register value to set
 195  */
 196 __STATIC_FORCEINLINE void __set_CONTROL(uint32_t control)
 197 {
 198   __ASM volatile ("MSR control, %0" : : "r" (control) : "memory");
 199 }
 200
 201
 202 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 203 /**
 204   \brief   Set Control Register (non-secure)
 205   \details Writes the given value to the non-secure Control Register when in secure state.
 206   \param [in]    control  Control Register value to set
 207  */
 208 __STATIC_FORCEINLINE void __TZ_set_CONTROL_NS(uint32_t control)
 209 {
 210   __ASM volatile ("MSR control_ns, %0" : : "r" (control) : "memory");
 211 }
 212 #endif
 213
 214
 215 /**
 216   \brief   Get IPSR Register
 217   \details Returns the content of the IPSR Register.
 218   \return               IPSR Register value
 219  */
 220 __STATIC_FORCEINLINE uint32_t __get_IPSR(void)
 221 {
 222   uint32_t result;
 223
 224   __ASM volatile ("MRS %0, ipsr" : "=r" (result) );
 225   return(result);
 226 }
 227
 228
 229 /**
 230   \brief   Get APSR Register
 231   \details Returns the content of the APSR Register.
 232   \return               APSR Register value
 233  */
 234 __STATIC_FORCEINLINE uint32_t __get_APSR(void)
 235 {
 236   uint32_t result;
 237
 238   __ASM volatile ("MRS %0, apsr" : "=r" (result) );
 239   return(result);
 240 }
 241
 242
 243 /**
 244   \brief   Get xPSR Register
 245   \details Returns the content of the xPSR Register.
 246   \return               xPSR Register value
 247  */
 248 __STATIC_FORCEINLINE uint32_t __get_xPSR(void)
 249 {
 250   uint32_t result;
 251
 252   __ASM volatile ("MRS %0, xpsr" : "=r" (result) );
 253   return(result);
 254 }
 255
 256
 257 /**
 258   \brief   Get Process Stack Pointer
 259   \details Returns the current value of the Process Stack Pointer (PSP).
 260   \return               PSP Register value
 261  */
 262 __STATIC_FORCEINLINE uint32_t __get_PSP(void)
 263 {
 264   uint32_t result;
 265
 266   __ASM volatile ("MRS %0, psp"  : "=r" (result) );
 267   return(result);
 268 }
 269
 270
 271 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 272 /**
 273   \brief   Get Process Stack Pointer (non-secure)
 274   \details Returns the current value of the non-secure Process Stack Pointer (PSP) when in secure state.
 275   \return               PSP Register value
 276  */
 277 __STATIC_FORCEINLINE uint32_t __TZ_get_PSP_NS(void)
 278 {
 279   uint32_t result;
 280
 281   __ASM volatile ("MRS %0, psp_ns"  : "=r" (result) );
 282   return(result);
 283 }
 284 #endif
 285
 286
 287 /**
 288   \brief   Set Process Stack Pointer
 289   \details Assigns the given value to the Process Stack Pointer (PSP).
 290   \param [in]    topOfProcStack  Process Stack Pointer value to set
 291  */
 292 __STATIC_FORCEINLINE void __set_PSP(uint32_t topOfProcStack)
 293 {
 294   __ASM volatile ("MSR psp, %0" : : "r" (topOfProcStack) : );
 295 }
 296
 297
 298 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 299 /**
 300   \brief   Set Process Stack Pointer (non-secure)
 301   \details Assigns the given value to the non-secure Process Stack Pointer (PSP) when in secure state.
 302   \param [in]    topOfProcStack  Process Stack Pointer value to set
 303  */
 304 __STATIC_FORCEINLINE void __TZ_set_PSP_NS(uint32_t topOfProcStack)
 305 {
 306   __ASM volatile ("MSR psp_ns, %0" : : "r" (topOfProcStack) : );
 307 }
 308 #endif
 309
 310
 311 /**
 312   \brief   Get Main Stack Pointer
 313   \details Returns the current value of the Main Stack Pointer (MSP).
 314   \return               MSP Register value
 315  */
 316 __STATIC_FORCEINLINE uint32_t __get_MSP(void)
 317 {
 318   uint32_t result;
 319
 320   __ASM volatile ("MRS %0, msp" : "=r" (result) );
 321   return(result);
 322 }
 323
 324
 325 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 326 /**
 327   \brief   Get Main Stack Pointer (non-secure)
 328   \details Returns the current value of the non-secure Main Stack Pointer (MSP) when in secure state.
 329   \return               MSP Register value
 330  */
 331 __STATIC_FORCEINLINE uint32_t __TZ_get_MSP_NS(void)
 332 {
 333   uint32_t result;
 334
 335   __ASM volatile ("MRS %0, msp_ns" : "=r" (result) );
 336   return(result);
 337 }
 338 #endif
 339
 340
 341 /**
 342   \brief   Set Main Stack Pointer
 343   \details Assigns the given value to the Main Stack Pointer (MSP).
 344   \param [in]    topOfMainStack  Main Stack Pointer value to set
 345  */
 346 __STATIC_FORCEINLINE void __set_MSP(uint32_t topOfMainStack)
 347 {
 348   __ASM volatile ("MSR msp, %0" : : "r" (topOfMainStack) : );
 349 }
 350
 351
 352 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 353 /**
 354   \brief   Set Main Stack Pointer (non-secure)
 355   \details Assigns the given value to the non-secure Main Stack Pointer (MSP) when in secure state.
 356   \param [in]    topOfMainStack  Main Stack Pointer value to set
 357  */
 358 __STATIC_FORCEINLINE void __TZ_set_MSP_NS(uint32_t topOfMainStack)
 359 {
 360   __ASM volatile ("MSR msp_ns, %0" : : "r" (topOfMainStack) : );
 361 }
 362 #endif
 363
 364
 365 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 366 /**
 367   \brief   Get Stack Pointer (non-secure)
 368   \details Returns the current value of the non-secure Stack Pointer (SP) when in secure state.
 369   \return               SP Register value
 370  */
 371 __STATIC_FORCEINLINE uint32_t __TZ_get_SP_NS(void)
 372 {
 373   uint32_t result;
 374
 375   __ASM volatile ("MRS %0, sp_ns" : "=r" (result) );
 376   return(result);
 377 }
 378
 379
 380 /**
 381   \brief   Set Stack Pointer (non-secure)
 382   \details Assigns the given value to the non-secure Stack Pointer (SP) when in secure state.
 383   \param [in]    topOfStack  Stack Pointer value to set
 384  */
 385 __STATIC_FORCEINLINE void __TZ_set_SP_NS(uint32_t topOfStack)
 386 {
 387   __ASM volatile ("MSR sp_ns, %0" : : "r" (topOfStack) : );
 388 }
 389 #endif
 390
 391
 392 /**
 393   \brief   Get Priority Mask
 394   \details Returns the current state of the priority mask bit from the Priority Mask Register.
 395   \return               Priority Mask value
 396  */
 397 __STATIC_FORCEINLINE uint32_t __get_PRIMASK(void)
 398 {
 399   uint32_t result;
 400
 401   __ASM volatile ("MRS %0, primask" : "=r" (result) );
 402   return(result);
 403 }
 404
 405
 406 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 407 /**
 408   \brief   Get Priority Mask (non-secure)
 409   \details Returns the current state of the non-secure priority mask bit from the Priority Mask Register when in secure state.
 410   \return               Priority Mask value
 411  */
 412 __STATIC_FORCEINLINE uint32_t __TZ_get_PRIMASK_NS(void)
 413 {
 414   uint32_t result;
 415
 416   __ASM volatile ("MRS %0, primask_ns" : "=r" (result) );
 417   return(result);
 418 }
 419 #endif
 420
 421
 422 /**
 423   \brief   Set Priority Mask
 424   \details Assigns the given value to the Priority Mask Register.
 425   \param [in]    priMask  Priority Mask
 426  */
 427 __STATIC_FORCEINLINE void __set_PRIMASK(uint32_t priMask)
 428 {
 429   __ASM volatile ("MSR primask, %0" : : "r" (priMask) : "memory");
 430 }
 431
 432
 433 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 434 /**
 435   \brief   Set Priority Mask (non-secure)
 436   \details Assigns the given value to the non-secure Priority Mask Register when in secure state.
 437   \param [in]    priMask  Priority Mask
 438  */
 439 __STATIC_FORCEINLINE void __TZ_set_PRIMASK_NS(uint32_t priMask)
 440 {
 441   __ASM volatile ("MSR primask_ns, %0" : : "r" (priMask) : "memory");
 442 }
 443 #endif
 444
 445
 446 #if ((defined (__ARM_ARCH_7M__       ) && (__ARM_ARCH_7M__        == 1)) || \
 447      (defined (__ARM_ARCH_7EM__      ) && (__ARM_ARCH_7EM__       == 1)) || \
 448      (defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 449      (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     )
 450 /**
 451   \brief   Enable FIQ
 452   \details Enables FIQ interrupts by clearing the F-bit in the CPSR.
 453            Can only be executed in Privileged modes.
 454  */
 455 #define __enable_fault_irq                __enable_fiq   /* see arm_compat.h */
 456
 457
 458 /**
 459   \brief   Disable FIQ
 460   \details Disables FIQ interrupts by setting the F-bit in the CPSR.
 461            Can only be executed in Privileged modes.
 462  */
 463 #define __disable_fault_irq               __disable_fiq   /* see arm_compat.h */
 464
 465
 466 /**
 467   \brief   Get Base Priority
 468   \details Returns the current value of the Base Priority register.
 469   \return               Base Priority register value
 470  */
 471 __STATIC_FORCEINLINE uint32_t __get_BASEPRI(void)
 472 {
 473   uint32_t result;
 474
 475   __ASM volatile ("MRS %0, basepri" : "=r" (result) );
 476   return(result);
 477 }
 478
 479
 480 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 481 /**
 482   \brief   Get Base Priority (non-secure)
 483   \details Returns the current value of the non-secure Base Priority register when in secure state.
 484   \return               Base Priority register value
 485  */
 486 __STATIC_FORCEINLINE uint32_t __TZ_get_BASEPRI_NS(void)
 487 {
 488   uint32_t result;
 489
 490   __ASM volatile ("MRS %0, basepri_ns" : "=r" (result) );
 491   return(result);
 492 }
 493 #endif
 494
 495
 496 /**
 497   \brief   Set Base Priority
 498   \details Assigns the given value to the Base Priority register.
 499   \param [in]    basePri  Base Priority value to set
 500  */
 501 __STATIC_FORCEINLINE void __set_BASEPRI(uint32_t basePri)
 502 {
 503   __ASM volatile ("MSR basepri, %0" : : "r" (basePri) : "memory");
 504 }
 505
 506
 507 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 508 /**
 509   \brief   Set Base Priority (non-secure)
 510   \details Assigns the given value to the non-secure Base Priority register when in secure state.
 511   \param [in]    basePri  Base Priority value to set
 512  */
 513 __STATIC_FORCEINLINE void __TZ_set_BASEPRI_NS(uint32_t basePri)
 514 {
 515   __ASM volatile ("MSR basepri_ns, %0" : : "r" (basePri) : "memory");
 516 }
 517 #endif
 518
 519
 520 /**
 521   \brief   Set Base Priority with condition
 522   \details Assigns the given value to the Base Priority register only if BASEPRI masking is disabled,
 523            or the new value increases the BASEPRI priority level.
 524   \param [in]    basePri  Base Priority value to set
 525  */
 526 __STATIC_FORCEINLINE void __set_BASEPRI_MAX(uint32_t basePri)
 527 {
 528   __ASM volatile ("MSR basepri_max, %0" : : "r" (basePri) : "memory");
 529 }
 530
 531
 532 /**
 533   \brief   Get Fault Mask
 534   \details Returns the current value of the Fault Mask register.
 535   \return               Fault Mask register value
 536  */
 537 __STATIC_FORCEINLINE uint32_t __get_FAULTMASK(void)
 538 {
 539   uint32_t result;
 540
 541   __ASM volatile ("MRS %0, faultmask" : "=r" (result) );
 542   return(result);
 543 }
 544
 545
 546 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 547 /**
 548   \brief   Get Fault Mask (non-secure)
 549   \details Returns the current value of the non-secure Fault Mask register when in secure state.
 550   \return               Fault Mask register value
 551  */
 552 __STATIC_FORCEINLINE uint32_t __TZ_get_FAULTMASK_NS(void)
 553 {
 554   uint32_t result;
 555
 556   __ASM volatile ("MRS %0, faultmask_ns" : "=r" (result) );
 557   return(result);
 558 }
 559 #endif
 560
 561
 562 /**
 563   \brief   Set Fault Mask
 564   \details Assigns the given value to the Fault Mask register.
 565   \param [in]    faultMask  Fault Mask value to set
 566  */
 567 __STATIC_FORCEINLINE void __set_FAULTMASK(uint32_t faultMask)
 568 {
 569   __ASM volatile ("MSR faultmask, %0" : : "r" (faultMask) : "memory");
 570 }
 571
 572
 573 #if (defined (__ARM_FEATURE_CMSE ) && (__ARM_FEATURE_CMSE == 3))
 574 /**
 575   \brief   Set Fault Mask (non-secure)
 576   \details Assigns the given value to the non-secure Fault Mask register when in secure state.
 577   \param [in]    faultMask  Fault Mask value to set
 578  */
 579 __STATIC_FORCEINLINE void __TZ_set_FAULTMASK_NS(uint32_t faultMask)
 580 {
 581   __ASM volatile ("MSR faultmask_ns, %0" : : "r" (faultMask) : "memory");
 582 }
 583 #endif
 584
 585 #endif /* ((defined (__ARM_ARCH_7M__       ) && (__ARM_ARCH_7M__        == 1)) || \
 586            (defined (__ARM_ARCH_7EM__      ) && (__ARM_ARCH_7EM__       == 1)) || \
 587            (defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 588            (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     ) */
 589
 590
 591 #if ((defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 592      (defined (__ARM_ARCH_8M_BASE__  ) && (__ARM_ARCH_8M_BASE__   == 1)) || \
 593      (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     )
 594
 595 /**
 596   \brief   Get Process Stack Pointer Limit
 597   Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
 598   Stack Pointer Limit register hence zero is returned always in non-secure
 599   mode.
 600
 601   \details Returns the current value of the Process Stack Pointer Limit (PSPLIM).
 602   \return               PSPLIM Register value
 603  */
 604 __STATIC_FORCEINLINE uint32_t __get_PSPLIM(void)
 605 {
 606 #if (!((defined (__ARM_ARCH_8M_MAIN__   ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 607        (defined (__ARM_ARCH_8_1M_MAIN__ ) && (__ARM_ARCH_8_1M_MAIN__ == 1))   ) && \
 608     (!defined (__ARM_FEATURE_CMSE) || (__ARM_FEATURE_CMSE < 3)))
 609     // without main extensions, the non-secure PSPLIM is RAZ/WI
 610   return 0U;
 611 #else
 612   uint32_t result;
 613   __ASM volatile ("MRS %0, psplim"  : "=r" (result) );
 614   return result;
 615 #endif
 616 }
 617
 618 #if (defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3))
 619 /**
 620   \brief   Get Process Stack Pointer Limit (non-secure)
 621   Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
 622   Stack Pointer Limit register hence zero is returned always in non-secure
 623   mode.
 624
 625   \details Returns the current value of the non-secure Process Stack Pointer Limit (PSPLIM) when in secure state.
 626   \return               PSPLIM Register value
 627  */
 628 __STATIC_FORCEINLINE uint32_t __TZ_get_PSPLIM_NS(void)
 629 {
 630 #if (!((defined (__ARM_ARCH_8M_MAIN__   ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 631        (defined (__ARM_ARCH_8_1M_MAIN__ ) && (__ARM_ARCH_8_1M_MAIN__ == 1))   ) )
 632   // without main extensions, the non-secure PSPLIM is RAZ/WI
 633   return 0U;
 634 #else
 635   uint32_t result;
 636   __ASM volatile ("MRS %0, psplim_ns"  : "=r" (result) );
 637   return result;
 638 #endif
 639 }
 640 #endif
 641
 642
 643 /**
 644   \brief   Set Process Stack Pointer Limit
 645   Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
 646   Stack Pointer Limit register hence the write is silently ignored in non-secure
 647   mode.
 648
 649   \details Assigns the given value to the Process Stack Pointer Limit (PSPLIM).
 650   \param [in]    ProcStackPtrLimit  Process Stack Pointer Limit value to set
 651  */
 652 __STATIC_FORCEINLINE void __set_PSPLIM(uint32_t ProcStackPtrLimit)
 653 {
 654 #if (!((defined (__ARM_ARCH_8M_MAIN__   ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 655        (defined (__ARM_ARCH_8_1M_MAIN__ ) && (__ARM_ARCH_8_1M_MAIN__ == 1))   ) && \
 656     (!defined (__ARM_FEATURE_CMSE) || (__ARM_FEATURE_CMSE < 3)))
 657   // without main extensions, the non-secure PSPLIM is RAZ/WI
 658   (void)ProcStackPtrLimit;
 659 #else
 660   __ASM volatile ("MSR psplim, %0" : : "r" (ProcStackPtrLimit));
 661 #endif
 662 }
 663
 664
 665 #if (defined (__ARM_FEATURE_CMSE  ) && (__ARM_FEATURE_CMSE   == 3))
 666 /**
 667   \brief   Set Process Stack Pointer (non-secure)
 668   Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
 669   Stack Pointer Limit register hence the write is silently ignored in non-secure
 670   mode.
 671
 672   \details Assigns the given value to the non-secure Process Stack Pointer Limit (PSPLIM) when in secure state.
 673   \param [in]    ProcStackPtrLimit  Process Stack Pointer Limit value to set
 674  */
 675 __STATIC_FORCEINLINE void __TZ_set_PSPLIM_NS(uint32_t ProcStackPtrLimit)
 676 {
 677 #if (!((defined (__ARM_ARCH_8M_MAIN__   ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 678        (defined (__ARM_ARCH_8_1M_MAIN__ ) && (__ARM_ARCH_8_1M_MAIN__ == 1))   ) )
 679   // without main extensions, the non-secure PSPLIM is RAZ/WI
 680   (void)ProcStackPtrLimit;
 681 #else
 682   __ASM volatile ("MSR psplim_ns, %0\n" : : "r" (ProcStackPtrLimit));
 683 #endif
 684 }
 685 #endif
 686
 687
 688 /**
 689   \brief   Get Main Stack Pointer Limit
 690   Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
 691   Stack Pointer Limit register hence zero is returned always.
 692
 693   \details Returns the current value of the Main Stack Pointer Limit (MSPLIM).
 694   \return               MSPLIM Register value
 695  */
 696 __STATIC_FORCEINLINE uint32_t __get_MSPLIM(void)
 697 {
 698 #if (!((defined (__ARM_ARCH_8M_MAIN__   ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 699        (defined (__ARM_ARCH_8_1M_MAIN__ ) && (__ARM_ARCH_8_1M_MAIN__ == 1))   ) && \
 700     (!defined (__ARM_FEATURE_CMSE) || (__ARM_FEATURE_CMSE < 3)))
 701   // without main extensions, the non-secure MSPLIM is RAZ/WI
 702   return 0U;
 703 #else
 704   uint32_t result;
 705   __ASM volatile ("MRS %0, msplim" : "=r" (result) );
 706   return result;
 707 #endif
 708 }
 709
 710
 711 #if (defined (__ARM_FEATURE_CMSE  ) && (__ARM_FEATURE_CMSE   == 3))
 712 /**
 713   \brief   Get Main Stack Pointer Limit (non-secure)
 714   Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
 715   Stack Pointer Limit register hence zero is returned always.
 716
 717   \details Returns the current value of the non-secure Main Stack Pointer Limit(MSPLIM) when in secure state.
 718   \return               MSPLIM Register value
 719  */
 720 __STATIC_FORCEINLINE uint32_t __TZ_get_MSPLIM_NS(void)
 721 {
 722 #if (!((defined (__ARM_ARCH_8M_MAIN__   ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 723        (defined (__ARM_ARCH_8_1M_MAIN__ ) && (__ARM_ARCH_8_1M_MAIN__ == 1))   ) )
 724   // without main extensions, the non-secure MSPLIM is RAZ/WI
 725   return 0U;
 726 #else
 727   uint32_t result;
 728   __ASM volatile ("MRS %0, msplim_ns" : "=r" (result) );
 729   return result;
 730 #endif
 731 }
 732 #endif
 733
 734
 735 /**
 736   \brief   Set Main Stack Pointer Limit
 737   Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
 738   Stack Pointer Limit register hence the write is silently ignored.
 739
 740   \details Assigns the given value to the Main Stack Pointer Limit (MSPLIM).
 741   \param [in]    MainStackPtrLimit  Main Stack Pointer Limit value to set
 742  */
 743 __STATIC_FORCEINLINE void __set_MSPLIM(uint32_t MainStackPtrLimit)
 744 {
 745 #if (!((defined (__ARM_ARCH_8M_MAIN__   ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 746        (defined (__ARM_ARCH_8_1M_MAIN__ ) && (__ARM_ARCH_8_1M_MAIN__ == 1))   ) && \
 747     (!defined (__ARM_FEATURE_CMSE) || (__ARM_FEATURE_CMSE < 3)))
 748   // without main extensions, the non-secure MSPLIM is RAZ/WI
 749   (void)MainStackPtrLimit;
 750 #else
 751   __ASM volatile ("MSR msplim, %0" : : "r" (MainStackPtrLimit));
 752 #endif
 753 }
 754
 755
 756 #if (defined (__ARM_FEATURE_CMSE  ) && (__ARM_FEATURE_CMSE   == 3))
 757 /**
 758   \brief   Set Main Stack Pointer Limit (non-secure)
 759   Devices without ARMv8-M Main Extensions (i.e. Cortex-M23) lack the non-secure
 760   Stack Pointer Limit register hence the write is silently ignored.
 761
 762   \details Assigns the given value to the non-secure Main Stack Pointer Limit (MSPLIM) when in secure state.
 763   \param [in]    MainStackPtrLimit  Main Stack Pointer value to set
 764  */
 765 __STATIC_FORCEINLINE void __TZ_set_MSPLIM_NS(uint32_t MainStackPtrLimit)
 766 {
 767 #if (!((defined (__ARM_ARCH_8M_MAIN__   ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 768        (defined (__ARM_ARCH_8_1M_MAIN__ ) && (__ARM_ARCH_8_1M_MAIN__ == 1))   ) )
 769   // without main extensions, the non-secure MSPLIM is RAZ/WI
 770   (void)MainStackPtrLimit;
 771 #else
 772   __ASM volatile ("MSR msplim_ns, %0" : : "r" (MainStackPtrLimit));
 773 #endif
 774 }
 775 #endif
 776
 777 #endif /* ((defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 778            (defined (__ARM_ARCH_8M_BASE__  ) && (__ARM_ARCH_8M_BASE__   == 1)) || \
 779            (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     ) */
 780
 781 /**
 782   \brief   Get FPSCR
 783   \details Returns the current value of the Floating Point Status/Control register.
 784   \return               Floating Point Status/Control register value
 785  */
 786 #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
 787      (defined (__FPU_USED   ) && (__FPU_USED    == 1U))     )
 788 #define __get_FPSCR      (uint32_t)__builtin_arm_get_fpscr
 789 #else
 790 #define __get_FPSCR()      ((uint32_t)0U)
 791 #endif
 792
 793 /**
 794   \brief   Set FPSCR
 795   \details Assigns the given value to the Floating Point Status/Control register.
 796   \param [in]    fpscr  Floating Point Status/Control value to set
 797  */
 798 #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
 799      (defined (__FPU_USED   ) && (__FPU_USED    == 1U))     )
 800 #define __set_FPSCR      __builtin_arm_set_fpscr
 801 #else
 802 #define __set_FPSCR(x)      ((void)(x))
 803 #endif
 804
 805
 806 /*@} end of CMSIS_Core_RegAccFunctions */
 807
 808
 809 /* ##########################  Core Instruction Access  ######################### */
 810 /** \defgroup CMSIS_Core_InstructionInterface CMSIS Core Instruction Interface
 811   Access to dedicated instructions
 812   @{
 813 */
 814
 815 /* Define macros for porting to both thumb1 and thumb2.
 816  * For thumb1, use low register (r0-r7), specified by constraint "l"
 817  * Otherwise, use general registers, specified by constraint "r" */
 818 #if defined (__thumb__) && !defined (__thumb2__)
 819 #define __CMSIS_GCC_OUT_REG(r) "=l" (r)
 820 #define __CMSIS_GCC_RW_REG(r) "+l" (r)
 821 #define __CMSIS_GCC_USE_REG(r) "l" (r)
 822 #else
 823 #define __CMSIS_GCC_OUT_REG(r) "=r" (r)
 824 #define __CMSIS_GCC_RW_REG(r) "+r" (r)
 825 #define __CMSIS_GCC_USE_REG(r) "r" (r)
 826 #endif
 827
 828 /**
 829   \brief   No Operation
 830   \details No Operation does nothing. This instruction can be used for code alignment purposes.
 831  */
 832 #define __NOP          __builtin_arm_nop
 833
 834 /**
 835   \brief   Wait For Interrupt
 836   \details Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs.
 837  */
 838 #define __WFI          __builtin_arm_wfi
 839
 840
 841 /**
 842   \brief   Wait For Event
 843   \details Wait For Event is a hint instruction that permits the processor to enter
 844            a low-power state until one of a number of events occurs.
 845  */
 846 #define __WFE          __builtin_arm_wfe
 847
 848
 849 /**
 850   \brief   Send Event
 851   \details Send Event is a hint instruction. It causes an event to be signaled to the CPU.
 852  */
 853 #define __SEV          __builtin_arm_sev
 854
 855
 856 /**
 857   \brief   Instruction Synchronization Barrier
 858   \details Instruction Synchronization Barrier flushes the pipeline in the processor,
 859            so that all instructions following the ISB are fetched from cache or memory,
 860            after the instruction has been completed.
 861  */
 862 #define __ISB()        __builtin_arm_isb(0xF)
 863
 864 /**
 865   \brief   Data Synchronization Barrier
 866   \details Acts as a special kind of Data Memory Barrier.
 867            It completes when all explicit memory accesses before this instruction complete.
 868  */
 869 #define __DSB()        __builtin_arm_dsb(0xF)
 870
 871
 872 /**
 873   \brief   Data Memory Barrier
 874   \details Ensures the apparent order of the explicit memory operations before
 875            and after the instruction, without ensuring their completion.
 876  */
 877 #define __DMB()        __builtin_arm_dmb(0xF)
 878
 879
 880 /**
 881   \brief   Reverse byte order (32 bit)
 882   \details Reverses the byte order in unsigned integer value. For example, 0x12345678 becomes 0x78563412.
 883   \param [in]    value  Value to reverse
 884   \return               Reversed value
 885  */
 886 #define __REV(value)   __builtin_bswap32(value)
 887
 888
 889 /**
 890   \brief   Reverse byte order (16 bit)
 891   \details Reverses the byte order within each halfword of a word. For example, 0x12345678 becomes 0x34127856.
 892   \param [in]    value  Value to reverse
 893   \return               Reversed value
 894  */
 895 #define __REV16(value) __ROR(__REV(value), 16)
 896
 897
 898 /**
 899   \brief   Reverse byte order (16 bit)
 900   \details Reverses the byte order in a 16-bit value and returns the signed 16-bit result. For example, 0x0080 becomes 0x8000.
 901   \param [in]    value  Value to reverse
 902   \return               Reversed value
 903  */
 904 #define __REVSH(value) (int16_t)__builtin_bswap16(value)
 905
 906
 907 /**
 908   \brief   Rotate Right in unsigned value (32 bit)
 909   \details Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits.
 910   \param [in]    op1  Value to rotate
 911   \param [in]    op2  Number of Bits to rotate
 912   \return               Rotated value
 913  */
 914 __STATIC_FORCEINLINE uint32_t __ROR(uint32_t op1, uint32_t op2)
 915 {
 916   op2 %= 32U;
 917   if (op2 == 0U)
 918   {
 919     return op1;
 920   }
 921   return (op1 >> op2) | (op1 << (32U - op2));
 922 }
 923
 924
 925 /**
 926   \brief   Breakpoint
 927   \details Causes the processor to enter Debug state.
 928            Debug tools can use this to investigate system state when the instruction at a particular address is reached.
 929   \param [in]    value  is ignored by the processor.
 930                  If required, a debugger can use it to store additional information about the breakpoint.
 931  */
 932 #define __BKPT(value)     __ASM volatile ("bkpt "#value)
 933
 934
 935 /**
 936   \brief   Reverse bit order of value
 937   \details Reverses the bit order of the given value.
 938   \param [in]    value  Value to reverse
 939   \return               Reversed value
 940  */
 941 #define __RBIT            __builtin_arm_rbit
 942
 943 /**
 944   \brief   Count leading zeros
 945   \details Counts the number of leading zeros of a data value.
 946   \param [in]  value  Value to count the leading zeros
 947   \return             number of leading zeros in value
 948  */
 949 __STATIC_FORCEINLINE uint8_t __CLZ(uint32_t value)
 950 {
 951   /* Even though __builtin_clz produces a CLZ instruction on ARM, formally
 952      __builtin_clz(0) is undefined behaviour, so handle this case specially.
 953      This guarantees ARM-compatible results if happening to compile on a non-ARM
 954      target, and ensures the compiler doesn't decide to activate any
 955      optimisations using the logic "value was passed to __builtin_clz, so it
 956      is non-zero".
 957      ARM Compiler 6.10 and possibly earlier will optimise this test away, leaving a
 958      single CLZ instruction.
 959    */
 960   if (value == 0U)
 961   {
 962     return 32U;
 963   }
 964   return __builtin_clz(value);
 965 }
 966
 967
 968 #if ((defined (__ARM_ARCH_7M__       ) && (__ARM_ARCH_7M__        == 1)) || \
 969      (defined (__ARM_ARCH_7EM__      ) && (__ARM_ARCH_7EM__       == 1)) || \
 970      (defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
 971      (defined (__ARM_ARCH_8M_BASE__  ) && (__ARM_ARCH_8M_BASE__   == 1)) || \
 972      (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     )
 973
 974 /**
 975   \brief   LDR Exclusive (8 bit)
 976   \details Executes a exclusive LDR instruction for 8 bit value.
 977   \param [in]    ptr  Pointer to data
 978   \return             value of type uint8_t at (*ptr)
 979  */
 980 #define __LDREXB        (uint8_t)__builtin_arm_ldrex
 981
 982
 983 /**
 984   \brief   LDR Exclusive (16 bit)
 985   \details Executes a exclusive LDR instruction for 16 bit values.
 986   \param [in]    ptr  Pointer to data
 987   \return        value of type uint16_t at (*ptr)
 988  */
 989 #define __LDREXH        (uint16_t)__builtin_arm_ldrex
 990
 991
 992 /**
 993   \brief   LDR Exclusive (32 bit)
 994   \details Executes a exclusive LDR instruction for 32 bit values.
 995   \param [in]    ptr  Pointer to data
 996   \return        value of type uint32_t at (*ptr)
 997  */
 998 #define __LDREXW        (uint32_t)__builtin_arm_ldrex
 999
1000
1001 /**
1002   \brief   STR Exclusive (8 bit)
1003   \details Executes a exclusive STR instruction for 8 bit values.
1004   \param [in]  value  Value to store
1005   \param [in]    ptr  Pointer to location
1006   \return          0  Function succeeded
1007   \return          1  Function failed
1008  */
1009 #define __STREXB        (uint32_t)__builtin_arm_strex
1010
1011
1012 /**
1013   \brief   STR Exclusive (16 bit)
1014   \details Executes a exclusive STR instruction for 16 bit values.
1015   \param [in]  value  Value to store
1016   \param [in]    ptr  Pointer to location
1017   \return          0  Function succeeded
1018   \return          1  Function failed
1019  */
1020 #define __STREXH        (uint32_t)__builtin_arm_strex
1021
1022
1023 /**
1024   \brief   STR Exclusive (32 bit)
1025   \details Executes a exclusive STR instruction for 32 bit values.
1026   \param [in]  value  Value to store
1027   \param [in]    ptr  Pointer to location
1028   \return          0  Function succeeded
1029   \return          1  Function failed
1030  */
1031 #define __STREXW        (uint32_t)__builtin_arm_strex
1032
1033
1034 /**
1035   \brief   Remove the exclusive lock
1036   \details Removes the exclusive lock which is created by LDREX.
1037  */
1038 #define __CLREX             __builtin_arm_clrex
1039
1040 #endif /* ((defined (__ARM_ARCH_7M__       ) && (__ARM_ARCH_7M__        == 1)) || \
1041            (defined (__ARM_ARCH_7EM__      ) && (__ARM_ARCH_7EM__       == 1)) || \
1042            (defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
1043            (defined (__ARM_ARCH_8M_BASE__  ) && (__ARM_ARCH_8M_BASE__   == 1)) || \
1044            (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     ) */
1045
1046
1047 #if ((defined (__ARM_ARCH_7M__       ) && (__ARM_ARCH_7M__        == 1)) || \
1048      (defined (__ARM_ARCH_7EM__      ) && (__ARM_ARCH_7EM__       == 1)) || \
1049      (defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
1050      (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     )
1051
1052 /**
1053   \brief   Signed Saturate
1054   \details Saturates a signed value.
1055   \param [in]  value  Value to be saturated
1056   \param [in]    sat  Bit position to saturate to (1..32)
1057   \return             Saturated value
1058  */
1059 #define __SSAT             __builtin_arm_ssat
1060
1061
1062 /**
1063   \brief   Unsigned Saturate
1064   \details Saturates an unsigned value.
1065   \param [in]  value  Value to be saturated
1066   \param [in]    sat  Bit position to saturate to (0..31)
1067   \return             Saturated value
1068  */
1069 #define __USAT             __builtin_arm_usat
1070
1071
1072 /**
1073   \brief   Rotate Right with Extend (32 bit)
1074   \details Moves each bit of a bitstring right by one bit.
1075            The carry input is shifted in at the left end of the bitstring.
1076   \param [in]    value  Value to rotate
1077   \return               Rotated value
1078  */
1079 __STATIC_FORCEINLINE uint32_t __RRX(uint32_t value)
1080 {
1081   uint32_t result;
1082
1083   __ASM volatile ("rrx %0, %1" : __CMSIS_GCC_OUT_REG (result) : __CMSIS_GCC_USE_REG (value) );
1084   return(result);
1085 }
1086
1087
1088 /**
1089   \brief   LDRT Unprivileged (8 bit)
1090   \details Executes a Unprivileged LDRT instruction for 8 bit value.
1091   \param [in]    ptr  Pointer to data
1092   \return             value of type uint8_t at (*ptr)
1093  */
1094 __STATIC_FORCEINLINE uint8_t __LDRBT(volatile uint8_t *ptr)
1095 {
1096   uint32_t result;
1097
1098   __ASM volatile ("ldrbt %0, %1" : "=r" (result) : "Q" (*ptr) );
1099   return ((uint8_t) result);    /* Add explicit type cast here */
1100 }
1101
1102
1103 /**
1104   \brief   LDRT Unprivileged (16 bit)
1105   \details Executes a Unprivileged LDRT instruction for 16 bit values.
1106   \param [in]    ptr  Pointer to data
1107   \return        value of type uint16_t at (*ptr)
1108  */
1109 __STATIC_FORCEINLINE uint16_t __LDRHT(volatile uint16_t *ptr)
1110 {
1111   uint32_t result;
1112
1113   __ASM volatile ("ldrht %0, %1" : "=r" (result) : "Q" (*ptr) );
1114   return ((uint16_t) result);    /* Add explicit type cast here */
1115 }
1116
1117
1118 /**
1119   \brief   LDRT Unprivileged (32 bit)
1120   \details Executes a Unprivileged LDRT instruction for 32 bit values.
1121   \param [in]    ptr  Pointer to data
1122   \return        value of type uint32_t at (*ptr)
1123  */
1124 __STATIC_FORCEINLINE uint32_t __LDRT(volatile uint32_t *ptr)
1125 {
1126   uint32_t result;
1127
1128   __ASM volatile ("ldrt %0, %1" : "=r" (result) : "Q" (*ptr) );
1129   return(result);
1130 }
1131
1132
1133 /**
1134   \brief   STRT Unprivileged (8 bit)
1135   \details Executes a Unprivileged STRT instruction for 8 bit values.
1136   \param [in]  value  Value to store
1137   \param [in]    ptr  Pointer to location
1138  */
1139 __STATIC_FORCEINLINE void __STRBT(uint8_t value, volatile uint8_t *ptr)
1140 {
1141   __ASM volatile ("strbt %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) );
1142 }
1143
1144
1145 /**
1146   \brief   STRT Unprivileged (16 bit)
1147   \details Executes a Unprivileged STRT instruction for 16 bit values.
1148   \param [in]  value  Value to store
1149   \param [in]    ptr  Pointer to location
1150  */
1151 __STATIC_FORCEINLINE void __STRHT(uint16_t value, volatile uint16_t *ptr)
1152 {
1153   __ASM volatile ("strht %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) );
1154 }
1155
1156
1157 /**
1158   \brief   STRT Unprivileged (32 bit)
1159   \details Executes a Unprivileged STRT instruction for 32 bit values.
1160   \param [in]  value  Value to store
1161   \param [in]    ptr  Pointer to location
1162  */
1163 __STATIC_FORCEINLINE void __STRT(uint32_t value, volatile uint32_t *ptr)
1164 {
1165   __ASM volatile ("strt %1, %0" : "=Q" (*ptr) : "r" (value) );
1166 }
1167
1168 #else /* ((defined (__ARM_ARCH_7M__       ) && (__ARM_ARCH_7M__        == 1)) || \
1169           (defined (__ARM_ARCH_7EM__      ) && (__ARM_ARCH_7EM__       == 1)) || \
1170           (defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
1171           (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     ) */
1172
1173 /**
1174   \brief   Signed Saturate
1175   \details Saturates a signed value.
1176   \param [in]  value  Value to be saturated
1177   \param [in]    sat  Bit position to saturate to (1..32)
1178   \return             Saturated value
1179  */
1180 __STATIC_FORCEINLINE int32_t __SSAT(int32_t val, uint32_t sat)
1181 {
1182   if ((sat >= 1U) && (sat <= 32U))
1183   {
1184     const int32_t max = (int32_t)((1U << (sat - 1U)) - 1U);
1185     const int32_t min = -1 - max ;
1186     if (val > max)
1187     {
1188       return max;
1189     }
1190     else if (val < min)
1191     {
1192       return min;
1193     }
1194   }
1195   return val;
1196 }
1197
1198 /**
1199   \brief   Unsigned Saturate
1200   \details Saturates an unsigned value.
1201   \param [in]  value  Value to be saturated
1202   \param [in]    sat  Bit position to saturate to (0..31)
1203   \return             Saturated value
1204  */
1205 __STATIC_FORCEINLINE uint32_t __USAT(int32_t val, uint32_t sat)
1206 {
1207   if (sat <= 31U)
1208   {
1209     const uint32_t max = ((1U << sat) - 1U);
1210     if (val > (int32_t)max)
1211     {
1212       return max;
1213     }
1214     else if (val < 0)
1215     {
1216       return 0U;
1217     }
1218   }
1219   return (uint32_t)val;
1220 }
1221
1222 #endif /* ((defined (__ARM_ARCH_7M__       ) && (__ARM_ARCH_7M__        == 1)) || \
1223            (defined (__ARM_ARCH_7EM__      ) && (__ARM_ARCH_7EM__       == 1)) || \
1224            (defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
1225            (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     ) */
1226
1227
1228 #if ((defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
1229      (defined (__ARM_ARCH_8M_BASE__  ) && (__ARM_ARCH_8M_BASE__   == 1)) || \
1230      (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     )
1231
1232 /**
1233   \brief   Load-Acquire (8 bit)
1234   \details Executes a LDAB instruction for 8 bit value.
1235   \param [in]    ptr  Pointer to data
1236   \return             value of type uint8_t at (*ptr)
1237  */
1238 __STATIC_FORCEINLINE uint8_t __LDAB(volatile uint8_t *ptr)
1239 {
1240   uint32_t result;
1241
1242   __ASM volatile ("ldab %0, %1" : "=r" (result) : "Q" (*ptr) : "memory" );
1243   return ((uint8_t) result);
1244 }
1245
1246
1247 /**
1248   \brief   Load-Acquire (16 bit)
1249   \details Executes a LDAH instruction for 16 bit values.
1250   \param [in]    ptr  Pointer to data
1251   \return        value of type uint16_t at (*ptr)
1252  */
1253 __STATIC_FORCEINLINE uint16_t __LDAH(volatile uint16_t *ptr)
1254 {
1255   uint32_t result;
1256
1257   __ASM volatile ("ldah %0, %1" : "=r" (result) : "Q" (*ptr) : "memory" );
1258   return ((uint16_t) result);
1259 }
1260
1261
1262 /**
1263   \brief   Load-Acquire (32 bit)
1264   \details Executes a LDA instruction for 32 bit values.
1265   \param [in]    ptr  Pointer to data
1266   \return        value of type uint32_t at (*ptr)
1267  */
1268 __STATIC_FORCEINLINE uint32_t __LDA(volatile uint32_t *ptr)
1269 {
1270   uint32_t result;
1271
1272   __ASM volatile ("lda %0, %1" : "=r" (result) : "Q" (*ptr) : "memory" );
1273   return(result);
1274 }
1275
1276
1277 /**
1278   \brief   Store-Release (8 bit)
1279   \details Executes a STLB instruction for 8 bit values.
1280   \param [in]  value  Value to store
1281   \param [in]    ptr  Pointer to location
1282  */
1283 __STATIC_FORCEINLINE void __STLB(uint8_t value, volatile uint8_t *ptr)
1284 {
1285   __ASM volatile ("stlb %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) : "memory" );
1286 }
1287
1288
1289 /**
1290   \brief   Store-Release (16 bit)
1291   \details Executes a STLH instruction for 16 bit values.
1292   \param [in]  value  Value to store
1293   \param [in]    ptr  Pointer to location
1294  */
1295 __STATIC_FORCEINLINE void __STLH(uint16_t value, volatile uint16_t *ptr)
1296 {
1297   __ASM volatile ("stlh %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) : "memory" );
1298 }
1299
1300
1301 /**
1302   \brief   Store-Release (32 bit)
1303   \details Executes a STL instruction for 32 bit values.
1304   \param [in]  value  Value to store
1305   \param [in]    ptr  Pointer to location
1306  */
1307 __STATIC_FORCEINLINE void __STL(uint32_t value, volatile uint32_t *ptr)
1308 {
1309   __ASM volatile ("stl %1, %0" : "=Q" (*ptr) : "r" ((uint32_t)value) : "memory" );
1310 }
1311
1312
1313 /**
1314   \brief   Load-Acquire Exclusive (8 bit)
1315   \details Executes a LDAB exclusive instruction for 8 bit value.
1316   \param [in]    ptr  Pointer to data
1317   \return             value of type uint8_t at (*ptr)
1318  */
1319 #define     __LDAEXB                 (uint8_t)__builtin_arm_ldaex
1320
1321
1322 /**
1323   \brief   Load-Acquire Exclusive (16 bit)
1324   \details Executes a LDAH exclusive instruction for 16 bit values.
1325   \param [in]    ptr  Pointer to data
1326   \return        value of type uint16_t at (*ptr)
1327  */
1328 #define     __LDAEXH                 (uint16_t)__builtin_arm_ldaex
1329
1330
1331 /**
1332   \brief   Load-Acquire Exclusive (32 bit)
1333   \details Executes a LDA exclusive instruction for 32 bit values.
1334   \param [in]    ptr  Pointer to data
1335   \return        value of type uint32_t at (*ptr)
1336  */
1337 #define     __LDAEX                  (uint32_t)__builtin_arm_ldaex
1338
1339
1340 /**
1341   \brief   Store-Release Exclusive (8 bit)
1342   \details Executes a STLB exclusive instruction for 8 bit values.
1343   \param [in]  value  Value to store
1344   \param [in]    ptr  Pointer to location
1345   \return          0  Function succeeded
1346   \return          1  Function failed
1347  */
1348 #define     __STLEXB                 (uint32_t)__builtin_arm_stlex
1349
1350
1351 /**
1352   \brief   Store-Release Exclusive (16 bit)
1353   \details Executes a STLH exclusive instruction for 16 bit values.
1354   \param [in]  value  Value to store
1355   \param [in]    ptr  Pointer to location
1356   \return          0  Function succeeded
1357   \return          1  Function failed
1358  */
1359 #define     __STLEXH                 (uint32_t)__builtin_arm_stlex
1360
1361
1362 /**
1363   \brief   Store-Release Exclusive (32 bit)
1364   \details Executes a STL exclusive instruction for 32 bit values.
1365   \param [in]  value  Value to store
1366   \param [in]    ptr  Pointer to location
1367   \return          0  Function succeeded
1368   \return          1  Function failed
1369  */
1370 #define     __STLEX                  (uint32_t)__builtin_arm_stlex
1371
1372 #endif /* ((defined (__ARM_ARCH_8M_MAIN__  ) && (__ARM_ARCH_8M_MAIN__   == 1)) || \
1373            (defined (__ARM_ARCH_8M_BASE__  ) && (__ARM_ARCH_8M_BASE__   == 1)) || \
1374            (defined (__ARM_ARCH_8_1M_MAIN__) && (__ARM_ARCH_8_1M_MAIN__ == 1))     ) */
1375
1376 /*@}*/ /* end of group CMSIS_Core_InstructionInterface */
1377
1378
1379 /* ###################  Compiler specific Intrinsics  ########################### */
1380 /** \defgroup CMSIS_SIMD_intrinsics CMSIS SIMD Intrinsics
1381   Access to dedicated SIMD instructions
1382   @{
1383 */
1384
1385 #if (defined (__ARM_FEATURE_DSP) && (__ARM_FEATURE_DSP == 1))
1386
1387 #define     __SADD8                 __builtin_arm_sadd8
1388 #define     __QADD8                 __builtin_arm_qadd8
1389 #define     __SHADD8                __builtin_arm_shadd8
1390 #define     __UADD8                 __builtin_arm_uadd8
1391 #define     __UQADD8                __builtin_arm_uqadd8
1392 #define     __UHADD8                __builtin_arm_uhadd8
1393 #define     __SSUB8                 __builtin_arm_ssub8
1394 #define     __QSUB8                 __builtin_arm_qsub8
1395 #define     __SHSUB8                __builtin_arm_shsub8
1396 #define     __USUB8                 __builtin_arm_usub8
1397 #define     __UQSUB8                __builtin_arm_uqsub8
1398 #define     __UHSUB8                __builtin_arm_uhsub8
1399 #define     __SADD16                __builtin_arm_sadd16
1400 #define     __QADD16                __builtin_arm_qadd16
1401 #define     __SHADD16               __builtin_arm_shadd16
1402 #define     __UADD16                __builtin_arm_uadd16
1403 #define     __UQADD16               __builtin_arm_uqadd16
1404 #define     __UHADD16               __builtin_arm_uhadd16
1405 #define     __SSUB16                __builtin_arm_ssub16
1406 #define     __QSUB16                __builtin_arm_qsub16
1407 #define     __SHSUB16               __builtin_arm_shsub16
1408 #define     __USUB16                __builtin_arm_usub16
1409 #define     __UQSUB16               __builtin_arm_uqsub16
1410 #define     __UHSUB16               __builtin_arm_uhsub16
1411 #define     __SASX                  __builtin_arm_sasx
1412 #define     __QASX                  __builtin_arm_qasx
1413 #define     __SHASX                 __builtin_arm_shasx
1414 #define     __UASX                  __builtin_arm_uasx
1415 #define     __UQASX                 __builtin_arm_uqasx
1416 #define     __UHASX                 __builtin_arm_uhasx
1417 #define     __SSAX                  __builtin_arm_ssax
1418 #define     __QSAX                  __builtin_arm_qsax
1419 #define     __SHSAX                 __builtin_arm_shsax
1420 #define     __USAX                  __builtin_arm_usax
1421 #define     __UQSAX                 __builtin_arm_uqsax
1422 #define     __UHSAX                 __builtin_arm_uhsax
1423 #define     __USAD8                 __builtin_arm_usad8
1424 #define     __USADA8                __builtin_arm_usada8
1425 #define     __SSAT16                __builtin_arm_ssat16
1426 #define     __USAT16                __builtin_arm_usat16
1427 #define     __UXTB16                __builtin_arm_uxtb16
1428 #define     __UXTAB16               __builtin_arm_uxtab16
1429 #define     __SXTB16                __builtin_arm_sxtb16
1430 #define     __SXTAB16               __builtin_arm_sxtab16
1431 #define     __SMUAD                 __builtin_arm_smuad
1432 #define     __SMUADX                __builtin_arm_smuadx
1433 #define     __SMLAD                 __builtin_arm_smlad
1434 #define     __SMLADX                __builtin_arm_smladx
1435 #define     __SMLALD                __builtin_arm_smlald
1436 #define     __SMLALDX               __builtin_arm_smlaldx
1437 #define     __SMUSD                 __builtin_arm_smusd
1438 #define     __SMUSDX                __builtin_arm_smusdx
1439 #define     __SMLSD                 __builtin_arm_smlsd
1440 #define     __SMLSDX                __builtin_arm_smlsdx
1441 #define     __SMLSLD                __builtin_arm_smlsld
1442 #define     __SMLSLDX               __builtin_arm_smlsldx
1443 #define     __SEL                   __builtin_arm_sel
1444 #define     __QADD                  __builtin_arm_qadd
1445 #define     __QSUB                  __builtin_arm_qsub
1446
1447 #define __PKHBT(ARG1,ARG2,ARG3)          ( ((((uint32_t)(ARG1))          ) & 0x0000FFFFUL) |  \
1448                                            ((((uint32_t)(ARG2)) << (ARG3)) & 0xFFFF0000UL)  )
1449
1450 #define __PKHTB(ARG1,ARG2,ARG3)          ( ((((uint32_t)(ARG1))          ) & 0xFFFF0000UL) |  \
1451                                            ((((uint32_t)(ARG2)) >> (ARG3)) & 0x0000FFFFUL)  )
1452
1453 #define __SXTB16_RORn(ARG1, ARG2)        __SXTB16(__ROR(ARG1, ARG2))
1454
1455 __STATIC_FORCEINLINE int32_t __SMMLA (int32_t op1, int32_t op2, int32_t op3)
1456 {
1457   int32_t result;
1458
1459   __ASM volatile ("smmla %0, %1, %2, %3" : "=r" (result): "r"  (op1), "r" (op2), "r" (op3) );
1460   return(result);
1461 }
1462
1463 #endif /* (__ARM_FEATURE_DSP == 1) */
1464 /*@} end of group CMSIS_SIMD_intrinsics */
1465
1466
1467 #endif /* __CMSIS_ARMCLANG_H */