cmsis_armcc.h 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894
  1. /**************************************************************************//**
  2. * @file cmsis_armcc.h
  3. * @brief CMSIS compiler ARMCC (Arm Compiler 5) header file
  4. * @version V5.1.0
  5. * @date 08. May 2019
  6. ******************************************************************************/
  7. /*
  8. * Copyright (c) 2009-2019 Arm Limited. All rights reserved.
  9. *
  10. * SPDX-License-Identifier: Apache-2.0
  11. *
  12. * Licensed under the Apache License, Version 2.0 (the License); you may
  13. * not use this file except in compliance with the License.
  14. * You may obtain a copy of the License at
  15. *
  16. * www.apache.org/licenses/LICENSE-2.0
  17. *
  18. * Unless required by applicable law or agreed to in writing, software
  19. * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  20. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21. * See the License for the specific language governing permissions and
  22. * limitations under the License.
  23. */
  24. #ifndef __CMSIS_ARMCC_H
  25. #define __CMSIS_ARMCC_H
  26. #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 400677)
  27. #error "Please use Arm Compiler Toolchain V4.0.677 or later!"
  28. #endif
  29. /* CMSIS compiler control architecture macros */
  30. #if ((defined (__TARGET_ARCH_6_M ) && (__TARGET_ARCH_6_M == 1)) || \
  31. (defined (__TARGET_ARCH_6S_M ) && (__TARGET_ARCH_6S_M == 1)) )
  32. #define __ARM_ARCH_6M__ 1
  33. #endif
  34. #if (defined (__TARGET_ARCH_7_M ) && (__TARGET_ARCH_7_M == 1))
  35. #define __ARM_ARCH_7M__ 1
  36. #endif
  37. #if (defined (__TARGET_ARCH_7E_M) && (__TARGET_ARCH_7E_M == 1))
  38. #define __ARM_ARCH_7EM__ 1
  39. #endif
  40. /* __ARM_ARCH_8M_BASE__ not applicable */
  41. /* __ARM_ARCH_8M_MAIN__ not applicable */
  42. /* CMSIS compiler control DSP macros */
  43. #if ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
  44. #define __ARM_FEATURE_DSP 1
  45. #endif
  46. /* CMSIS compiler specific defines */
  47. #ifndef __ASM
  48. #define __ASM __asm
  49. #endif
  50. #ifndef __INLINE
  51. #define __INLINE __inline
  52. #endif
  53. #ifndef __STATIC_INLINE
  54. #define __STATIC_INLINE static __inline
  55. #endif
  56. #ifndef __STATIC_FORCEINLINE
  57. #define __STATIC_FORCEINLINE static __forceinline
  58. #endif
  59. #ifndef __NO_RETURN
  60. #define __NO_RETURN __declspec(noreturn)
  61. #endif
  62. #ifndef __USED
  63. #define __USED __attribute__((used))
  64. #endif
  65. #ifndef __WEAK
  66. #define __WEAK __attribute__((weak))
  67. #endif
  68. #ifndef __PACKED
  69. #define __PACKED __attribute__((packed))
  70. #endif
  71. #ifndef __PACKED_STRUCT
  72. #define __PACKED_STRUCT __packed struct
  73. #endif
  74. #ifndef __PACKED_UNION
  75. #define __PACKED_UNION __packed union
  76. #endif
  77. #ifndef __UNALIGNED_UINT32 /* deprecated */
  78. #define __UNALIGNED_UINT32(x) (*((__packed uint32_t *)(x)))
  79. #endif
  80. #ifndef __UNALIGNED_UINT16_WRITE
  81. #define __UNALIGNED_UINT16_WRITE(addr, val) ((*((__packed uint16_t *)(addr))) = (val))
  82. #endif
  83. #ifndef __UNALIGNED_UINT16_READ
  84. #define __UNALIGNED_UINT16_READ(addr) (*((const __packed uint16_t *)(addr)))
  85. #endif
  86. #ifndef __UNALIGNED_UINT32_WRITE
  87. #define __UNALIGNED_UINT32_WRITE(addr, val) ((*((__packed uint32_t *)(addr))) = (val))
  88. #endif
  89. #ifndef __UNALIGNED_UINT32_READ
  90. #define __UNALIGNED_UINT32_READ(addr) (*((const __packed uint32_t *)(addr)))
  91. #endif
  92. #ifndef __ALIGNED
  93. #define __ALIGNED(x) __attribute__((aligned(x)))
  94. #endif
  95. #ifndef __RESTRICT
  96. #define __RESTRICT __restrict
  97. #endif
  98. #ifndef __COMPILER_BARRIER
  99. #define __COMPILER_BARRIER() __memory_changed()
  100. #endif
  101. /* ######################### Startup and Lowlevel Init ######################## */
  102. #ifndef __PROGRAM_START
  103. #define __PROGRAM_START __main
  104. #endif
  105. #ifndef __INITIAL_SP
  106. #define __INITIAL_SP Image$$ARM_LIB_STACK$$ZI$$Limit
  107. #endif
  108. #ifndef __STACK_LIMIT
  109. #define __STACK_LIMIT Image$$ARM_LIB_STACK$$ZI$$Base
  110. #endif
  111. #ifndef __VECTOR_TABLE
  112. #define __VECTOR_TABLE __Vectors
  113. #endif
  114. #ifndef __VECTOR_TABLE_ATTRIBUTE
  115. #define __VECTOR_TABLE_ATTRIBUTE __attribute((used, section("RESET")))
  116. #endif
  117. /* ########################### Core Function Access ########################### */
  118. /** \ingroup CMSIS_Core_FunctionInterface
  119. \defgroup CMSIS_Core_RegAccFunctions CMSIS Core Register Access Functions
  120. @{
  121. */
  122. /**
  123. \brief Enable IRQ Interrupts
  124. \details Enables IRQ interrupts by clearing the I-bit in the CPSR.
  125. Can only be executed in Privileged modes.
  126. */
  127. /* intrinsic void __enable_irq(); */
  128. /**
  129. \brief Disable IRQ Interrupts
  130. \details Disables IRQ interrupts by setting the I-bit in the CPSR.
  131. Can only be executed in Privileged modes.
  132. */
  133. /* intrinsic void __disable_irq(); */
  134. /**
  135. \brief Get Control Register
  136. \details Returns the content of the Control Register.
  137. \return Control Register value
  138. */
  139. __STATIC_INLINE uint32_t __get_CONTROL(void)
  140. {
  141. register uint32_t __regControl __ASM("control");
  142. return(__regControl);
  143. }
  144. /**
  145. \brief Set Control Register
  146. \details Writes the given value to the Control Register.
  147. \param [in] control Control Register value to set
  148. */
  149. __STATIC_INLINE void __set_CONTROL(uint32_t control)
  150. {
  151. register uint32_t __regControl __ASM("control");
  152. __regControl = control;
  153. }
  154. /**
  155. \brief Get IPSR Register
  156. \details Returns the content of the IPSR Register.
  157. \return IPSR Register value
  158. */
  159. __STATIC_INLINE uint32_t __get_IPSR(void)
  160. {
  161. register uint32_t __regIPSR __ASM("ipsr");
  162. return(__regIPSR);
  163. }
  164. /**
  165. \brief Get APSR Register
  166. \details Returns the content of the APSR Register.
  167. \return APSR Register value
  168. */
  169. __STATIC_INLINE uint32_t __get_APSR(void)
  170. {
  171. register uint32_t __regAPSR __ASM("apsr");
  172. return(__regAPSR);
  173. }
  174. /**
  175. \brief Get xPSR Register
  176. \details Returns the content of the xPSR Register.
  177. \return xPSR Register value
  178. */
  179. __STATIC_INLINE uint32_t __get_xPSR(void)
  180. {
  181. register uint32_t __regXPSR __ASM("xpsr");
  182. return(__regXPSR);
  183. }
  184. /**
  185. \brief Get Process Stack Pointer
  186. \details Returns the current value of the Process Stack Pointer (PSP).
  187. \return PSP Register value
  188. */
  189. __STATIC_INLINE uint32_t __get_PSP(void)
  190. {
  191. register uint32_t __regProcessStackPointer __ASM("psp");
  192. return(__regProcessStackPointer);
  193. }
  194. /**
  195. \brief Set Process Stack Pointer
  196. \details Assigns the given value to the Process Stack Pointer (PSP).
  197. \param [in] topOfProcStack Process Stack Pointer value to set
  198. */
  199. __STATIC_INLINE void __set_PSP(uint32_t topOfProcStack)
  200. {
  201. register uint32_t __regProcessStackPointer __ASM("psp");
  202. __regProcessStackPointer = topOfProcStack;
  203. }
  204. /**
  205. \brief Get Main Stack Pointer
  206. \details Returns the current value of the Main Stack Pointer (MSP).
  207. \return MSP Register value
  208. */
  209. __STATIC_INLINE uint32_t __get_MSP(void)
  210. {
  211. register uint32_t __regMainStackPointer __ASM("msp");
  212. return(__regMainStackPointer);
  213. }
  214. /**
  215. \brief Set Main Stack Pointer
  216. \details Assigns the given value to the Main Stack Pointer (MSP).
  217. \param [in] topOfMainStack Main Stack Pointer value to set
  218. */
  219. __STATIC_INLINE void __set_MSP(uint32_t topOfMainStack)
  220. {
  221. register uint32_t __regMainStackPointer __ASM("msp");
  222. __regMainStackPointer = topOfMainStack;
  223. }
  224. /**
  225. \brief Get Priority Mask
  226. \details Returns the current state of the priority mask bit from the Priority Mask Register.
  227. \return Priority Mask value
  228. */
  229. __STATIC_INLINE uint32_t __get_PRIMASK(void)
  230. {
  231. register uint32_t __regPriMask __ASM("primask");
  232. return(__regPriMask);
  233. }
  234. /**
  235. \brief Set Priority Mask
  236. \details Assigns the given value to the Priority Mask Register.
  237. \param [in] priMask Priority Mask
  238. */
  239. __STATIC_INLINE void __set_PRIMASK(uint32_t priMask)
  240. {
  241. register uint32_t __regPriMask __ASM("primask");
  242. __regPriMask = (priMask);
  243. }
  244. #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
  245. (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
  246. /**
  247. \brief Enable FIQ
  248. \details Enables FIQ interrupts by clearing the F-bit in the CPSR.
  249. Can only be executed in Privileged modes.
  250. */
  251. #define __enable_fault_irq __enable_fiq
  252. /**
  253. \brief Disable FIQ
  254. \details Disables FIQ interrupts by setting the F-bit in the CPSR.
  255. Can only be executed in Privileged modes.
  256. */
  257. #define __disable_fault_irq __disable_fiq
  258. /**
  259. \brief Get Base Priority
  260. \details Returns the current value of the Base Priority register.
  261. \return Base Priority register value
  262. */
  263. __STATIC_INLINE uint32_t __get_BASEPRI(void)
  264. {
  265. register uint32_t __regBasePri __ASM("basepri");
  266. return(__regBasePri);
  267. }
  268. /**
  269. \brief Set Base Priority
  270. \details Assigns the given value to the Base Priority register.
  271. \param [in] basePri Base Priority value to set
  272. */
  273. __STATIC_INLINE void __set_BASEPRI(uint32_t basePri)
  274. {
  275. register uint32_t __regBasePri __ASM("basepri");
  276. __regBasePri = (basePri & 0xFFU);
  277. }
  278. /**
  279. \brief Set Base Priority with condition
  280. \details Assigns the given value to the Base Priority register only if BASEPRI masking is disabled,
  281. or the new value increases the BASEPRI priority level.
  282. \param [in] basePri Base Priority value to set
  283. */
  284. __STATIC_INLINE void __set_BASEPRI_MAX(uint32_t basePri)
  285. {
  286. register uint32_t __regBasePriMax __ASM("basepri_max");
  287. __regBasePriMax = (basePri & 0xFFU);
  288. }
  289. /**
  290. \brief Get Fault Mask
  291. \details Returns the current value of the Fault Mask register.
  292. \return Fault Mask register value
  293. */
  294. __STATIC_INLINE uint32_t __get_FAULTMASK(void)
  295. {
  296. register uint32_t __regFaultMask __ASM("faultmask");
  297. return(__regFaultMask);
  298. }
  299. /**
  300. \brief Set Fault Mask
  301. \details Assigns the given value to the Fault Mask register.
  302. \param [in] faultMask Fault Mask value to set
  303. */
  304. __STATIC_INLINE void __set_FAULTMASK(uint32_t faultMask)
  305. {
  306. register uint32_t __regFaultMask __ASM("faultmask");
  307. __regFaultMask = (faultMask & (uint32_t)1U);
  308. }
  309. #endif /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
  310. (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
  311. /**
  312. \brief Get FPSCR
  313. \details Returns the current value of the Floating Point Status/Control register.
  314. \return Floating Point Status/Control register value
  315. */
  316. __STATIC_INLINE uint32_t __get_FPSCR(void)
  317. {
  318. #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
  319. (defined (__FPU_USED ) && (__FPU_USED == 1U)) )
  320. register uint32_t __regfpscr __ASM("fpscr");
  321. return(__regfpscr);
  322. #else
  323. return(0U);
  324. #endif
  325. }
  326. /**
  327. \brief Set FPSCR
  328. \details Assigns the given value to the Floating Point Status/Control register.
  329. \param [in] fpscr Floating Point Status/Control value to set
  330. */
  331. __STATIC_INLINE void __set_FPSCR(uint32_t fpscr)
  332. {
  333. #if ((defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)) && \
  334. (defined (__FPU_USED ) && (__FPU_USED == 1U)) )
  335. register uint32_t __regfpscr __ASM("fpscr");
  336. __regfpscr = (fpscr);
  337. #else
  338. (void)fpscr;
  339. #endif
  340. }
  341. /*@} end of CMSIS_Core_RegAccFunctions */
  342. /* ########################## Core Instruction Access ######################### */
  343. /** \defgroup CMSIS_Core_InstructionInterface CMSIS Core Instruction Interface
  344. Access to dedicated instructions
  345. @{
  346. */
  347. /**
  348. \brief No Operation
  349. \details No Operation does nothing. This instruction can be used for code alignment purposes.
  350. */
  351. #define __NOP __nop
  352. /**
  353. \brief Wait For Interrupt
  354. \details Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs.
  355. */
  356. #define __WFI __wfi
  357. /**
  358. \brief Wait For Event
  359. \details Wait For Event is a hint instruction that permits the processor to enter
  360. a low-power state until one of a number of events occurs.
  361. */
  362. #define __WFE __wfe
  363. /**
  364. \brief Send Event
  365. \details Send Event is a hint instruction. It causes an event to be signaled to the CPU.
  366. */
  367. #define __SEV __sev
  368. /**
  369. \brief Instruction Synchronization Barrier
  370. \details Instruction Synchronization Barrier flushes the pipeline in the processor,
  371. so that all instructions following the ISB are fetched from cache or memory,
  372. after the instruction has been completed.
  373. */
  374. #define __ISB() do {\
  375. __schedule_barrier();\
  376. __isb(0xF);\
  377. __schedule_barrier();\
  378. } while (0U)
  379. /**
  380. \brief Data Synchronization Barrier
  381. \details Acts as a special kind of Data Memory Barrier.
  382. It completes when all explicit memory accesses before this instruction complete.
  383. */
  384. #define __DSB() do {\
  385. __schedule_barrier();\
  386. __dsb(0xF);\
  387. __schedule_barrier();\
  388. } while (0U)
  389. /**
  390. \brief Data Memory Barrier
  391. \details Ensures the apparent order of the explicit memory operations before
  392. and after the instruction, without ensuring their completion.
  393. */
  394. #define __DMB() do {\
  395. __schedule_barrier();\
  396. __dmb(0xF);\
  397. __schedule_barrier();\
  398. } while (0U)
  399. /**
  400. \brief Reverse byte order (32 bit)
  401. \details Reverses the byte order in unsigned integer value. For example, 0x12345678 becomes 0x78563412.
  402. \param [in] value Value to reverse
  403. \return Reversed value
  404. */
  405. #define __REV __rev
  406. /**
  407. \brief Reverse byte order (16 bit)
  408. \details Reverses the byte order within each halfword of a word. For example, 0x12345678 becomes 0x34127856.
  409. \param [in] value Value to reverse
  410. \return Reversed value
  411. */
  412. #ifndef __NO_EMBEDDED_ASM
  413. __attribute__((section(".rev16_text"))) __STATIC_INLINE __ASM uint32_t __REV16(uint32_t value)
  414. {
  415. rev16 r0, r0
  416. bx lr
  417. }
  418. #endif
  419. /**
  420. \brief Reverse byte order (16 bit)
  421. \details Reverses the byte order in a 16-bit value and returns the signed 16-bit result. For example, 0x0080 becomes 0x8000.
  422. \param [in] value Value to reverse
  423. \return Reversed value
  424. */
  425. #ifndef __NO_EMBEDDED_ASM
  426. __attribute__((section(".revsh_text"))) __STATIC_INLINE __ASM int16_t __REVSH(int16_t value)
  427. {
  428. revsh r0, r0
  429. bx lr
  430. }
  431. #endif
  432. /**
  433. \brief Rotate Right in unsigned value (32 bit)
  434. \details Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits.
  435. \param [in] op1 Value to rotate
  436. \param [in] op2 Number of Bits to rotate
  437. \return Rotated value
  438. */
  439. #define __ROR __ror
  440. /**
  441. \brief Breakpoint
  442. \details Causes the processor to enter Debug state.
  443. Debug tools can use this to investigate system state when the instruction at a particular address is reached.
  444. \param [in] value is ignored by the processor.
  445. If required, a debugger can use it to store additional information about the breakpoint.
  446. */
  447. #define __BKPT(value) __breakpoint(value)
  448. /**
  449. \brief Reverse bit order of value
  450. \details Reverses the bit order of the given value.
  451. \param [in] value Value to reverse
  452. \return Reversed value
  453. */
  454. #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
  455. (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
  456. #define __RBIT __rbit
  457. #else
  458. __attribute__((always_inline)) __STATIC_INLINE uint32_t __RBIT(uint32_t value)
  459. {
  460. uint32_t result;
  461. uint32_t s = (4U /*sizeof(v)*/ * 8U) - 1U; /* extra shift needed at end */
  462. result = value; /* r will be reversed bits of v; first get LSB of v */
  463. for (value >>= 1U; value != 0U; value >>= 1U)
  464. {
  465. result <<= 1U;
  466. result |= value & 1U;
  467. s--;
  468. }
  469. result <<= s; /* shift when v's highest bits are zero */
  470. return result;
  471. }
  472. #endif
  473. /**
  474. \brief Count leading zeros
  475. \details Counts the number of leading zeros of a data value.
  476. \param [in] value Value to count the leading zeros
  477. \return number of leading zeros in value
  478. */
  479. #define __CLZ __clz
  480. #if ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
  481. (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
  482. /**
  483. \brief LDR Exclusive (8 bit)
  484. \details Executes a exclusive LDR instruction for 8 bit value.
  485. \param [in] ptr Pointer to data
  486. \return value of type uint8_t at (*ptr)
  487. */
  488. #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
  489. #define __LDREXB(ptr) ((uint8_t ) __ldrex(ptr))
  490. #else
  491. #define __LDREXB(ptr) _Pragma("push") _Pragma("diag_suppress 3731") ((uint8_t ) __ldrex(ptr)) _Pragma("pop")
  492. #endif
  493. /**
  494. \brief LDR Exclusive (16 bit)
  495. \details Executes a exclusive LDR instruction for 16 bit values.
  496. \param [in] ptr Pointer to data
  497. \return value of type uint16_t at (*ptr)
  498. */
  499. #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
  500. #define __LDREXH(ptr) ((uint16_t) __ldrex(ptr))
  501. #else
  502. #define __LDREXH(ptr) _Pragma("push") _Pragma("diag_suppress 3731") ((uint16_t) __ldrex(ptr)) _Pragma("pop")
  503. #endif
  504. /**
  505. \brief LDR Exclusive (32 bit)
  506. \details Executes a exclusive LDR instruction for 32 bit values.
  507. \param [in] ptr Pointer to data
  508. \return value of type uint32_t at (*ptr)
  509. */
  510. #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
  511. #define __LDREXW(ptr) ((uint32_t ) __ldrex(ptr))
  512. #else
  513. #define __LDREXW(ptr) _Pragma("push") _Pragma("diag_suppress 3731") ((uint32_t ) __ldrex(ptr)) _Pragma("pop")
  514. #endif
  515. /**
  516. \brief STR Exclusive (8 bit)
  517. \details Executes a exclusive STR instruction for 8 bit values.
  518. \param [in] value Value to store
  519. \param [in] ptr Pointer to location
  520. \return 0 Function succeeded
  521. \return 1 Function failed
  522. */
  523. #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
  524. #define __STREXB(value, ptr) __strex(value, ptr)
  525. #else
  526. #define __STREXB(value, ptr) _Pragma("push") _Pragma("diag_suppress 3731") __strex(value, ptr) _Pragma("pop")
  527. #endif
  528. /**
  529. \brief STR Exclusive (16 bit)
  530. \details Executes a exclusive STR instruction for 16 bit values.
  531. \param [in] value Value to store
  532. \param [in] ptr Pointer to location
  533. \return 0 Function succeeded
  534. \return 1 Function failed
  535. */
  536. #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
  537. #define __STREXH(value, ptr) __strex(value, ptr)
  538. #else
  539. #define __STREXH(value, ptr) _Pragma("push") _Pragma("diag_suppress 3731") __strex(value, ptr) _Pragma("pop")
  540. #endif
  541. /**
  542. \brief STR Exclusive (32 bit)
  543. \details Executes a exclusive STR instruction for 32 bit values.
  544. \param [in] value Value to store
  545. \param [in] ptr Pointer to location
  546. \return 0 Function succeeded
  547. \return 1 Function failed
  548. */
  549. #if defined(__ARMCC_VERSION) && (__ARMCC_VERSION < 5060020)
  550. #define __STREXW(value, ptr) __strex(value, ptr)
  551. #else
  552. #define __STREXW(value, ptr) _Pragma("push") _Pragma("diag_suppress 3731") __strex(value, ptr) _Pragma("pop")
  553. #endif
  554. /**
  555. \brief Remove the exclusive lock
  556. \details Removes the exclusive lock which is created by LDREX.
  557. */
  558. #define __CLREX __clrex
  559. /**
  560. \brief Signed Saturate
  561. \details Saturates a signed value.
  562. \param [in] value Value to be saturated
  563. \param [in] sat Bit position to saturate to (1..32)
  564. \return Saturated value
  565. */
  566. #define __SSAT __ssat
  567. /**
  568. \brief Unsigned Saturate
  569. \details Saturates an unsigned value.
  570. \param [in] value Value to be saturated
  571. \param [in] sat Bit position to saturate to (0..31)
  572. \return Saturated value
  573. */
  574. #define __USAT __usat
  575. /**
  576. \brief Rotate Right with Extend (32 bit)
  577. \details Moves each bit of a bitstring right by one bit.
  578. The carry input is shifted in at the left end of the bitstring.
  579. \param [in] value Value to rotate
  580. \return Rotated value
  581. */
  582. #ifndef __NO_EMBEDDED_ASM
  583. __attribute__((section(".rrx_text"))) __STATIC_INLINE __ASM uint32_t __RRX(uint32_t value)
  584. {
  585. rrx r0, r0
  586. bx lr
  587. }
  588. #endif
  589. /**
  590. \brief LDRT Unprivileged (8 bit)
  591. \details Executes a Unprivileged LDRT instruction for 8 bit value.
  592. \param [in] ptr Pointer to data
  593. \return value of type uint8_t at (*ptr)
  594. */
  595. #define __LDRBT(ptr) ((uint8_t ) __ldrt(ptr))
  596. /**
  597. \brief LDRT Unprivileged (16 bit)
  598. \details Executes a Unprivileged LDRT instruction for 16 bit values.
  599. \param [in] ptr Pointer to data
  600. \return value of type uint16_t at (*ptr)
  601. */
  602. #define __LDRHT(ptr) ((uint16_t) __ldrt(ptr))
  603. /**
  604. \brief LDRT Unprivileged (32 bit)
  605. \details Executes a Unprivileged LDRT instruction for 32 bit values.
  606. \param [in] ptr Pointer to data
  607. \return value of type uint32_t at (*ptr)
  608. */
  609. #define __LDRT(ptr) ((uint32_t ) __ldrt(ptr))
  610. /**
  611. \brief STRT Unprivileged (8 bit)
  612. \details Executes a Unprivileged STRT instruction for 8 bit values.
  613. \param [in] value Value to store
  614. \param [in] ptr Pointer to location
  615. */
  616. #define __STRBT(value, ptr) __strt(value, ptr)
  617. /**
  618. \brief STRT Unprivileged (16 bit)
  619. \details Executes a Unprivileged STRT instruction for 16 bit values.
  620. \param [in] value Value to store
  621. \param [in] ptr Pointer to location
  622. */
  623. #define __STRHT(value, ptr) __strt(value, ptr)
  624. /**
  625. \brief STRT Unprivileged (32 bit)
  626. \details Executes a Unprivileged STRT instruction for 32 bit values.
  627. \param [in] value Value to store
  628. \param [in] ptr Pointer to location
  629. */
  630. #define __STRT(value, ptr) __strt(value, ptr)
  631. #else /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
  632. (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
  633. /**
  634. \brief Signed Saturate
  635. \details Saturates a signed value.
  636. \param [in] value Value to be saturated
  637. \param [in] sat Bit position to saturate to (1..32)
  638. \return Saturated value
  639. */
  640. __attribute__((always_inline)) __STATIC_INLINE int32_t __SSAT(int32_t val, uint32_t sat)
  641. {
  642. if ((sat >= 1U) && (sat <= 32U))
  643. {
  644. const int32_t max = (int32_t)((1U << (sat - 1U)) - 1U);
  645. const int32_t min = -1 - max ;
  646. if (val > max)
  647. {
  648. return max;
  649. }
  650. else if (val < min)
  651. {
  652. return min;
  653. }
  654. }
  655. return val;
  656. }
  657. /**
  658. \brief Unsigned Saturate
  659. \details Saturates an unsigned value.
  660. \param [in] value Value to be saturated
  661. \param [in] sat Bit position to saturate to (0..31)
  662. \return Saturated value
  663. */
  664. __attribute__((always_inline)) __STATIC_INLINE uint32_t __USAT(int32_t val, uint32_t sat)
  665. {
  666. if (sat <= 31U)
  667. {
  668. const uint32_t max = ((1U << sat) - 1U);
  669. if (val > (int32_t)max)
  670. {
  671. return max;
  672. }
  673. else if (val < 0)
  674. {
  675. return 0U;
  676. }
  677. }
  678. return (uint32_t)val;
  679. }
  680. #endif /* ((defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
  681. (defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
  682. /*@}*/ /* end of group CMSIS_Core_InstructionInterface */
  683. /* ################### Compiler specific Intrinsics ########################### */
  684. /** \defgroup CMSIS_SIMD_intrinsics CMSIS SIMD Intrinsics
  685. Access to dedicated SIMD instructions
  686. @{
  687. */
  688. #if ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
  689. #define __SADD8 __sadd8
  690. #define __QADD8 __qadd8
  691. #define __SHADD8 __shadd8
  692. #define __UADD8 __uadd8
  693. #define __UQADD8 __uqadd8
  694. #define __UHADD8 __uhadd8
  695. #define __SSUB8 __ssub8
  696. #define __QSUB8 __qsub8
  697. #define __SHSUB8 __shsub8
  698. #define __USUB8 __usub8
  699. #define __UQSUB8 __uqsub8
  700. #define __UHSUB8 __uhsub8
  701. #define __SADD16 __sadd16
  702. #define __QADD16 __qadd16
  703. #define __SHADD16 __shadd16
  704. #define __UADD16 __uadd16
  705. #define __UQADD16 __uqadd16
  706. #define __UHADD16 __uhadd16
  707. #define __SSUB16 __ssub16
  708. #define __QSUB16 __qsub16
  709. #define __SHSUB16 __shsub16
  710. #define __USUB16 __usub16
  711. #define __UQSUB16 __uqsub16
  712. #define __UHSUB16 __uhsub16
  713. #define __SASX __sasx
  714. #define __QASX __qasx
  715. #define __SHASX __shasx
  716. #define __UASX __uasx
  717. #define __UQASX __uqasx
  718. #define __UHASX __uhasx
  719. #define __SSAX __ssax
  720. #define __QSAX __qsax
  721. #define __SHSAX __shsax
  722. #define __USAX __usax
  723. #define __UQSAX __uqsax
  724. #define __UHSAX __uhsax
  725. #define __USAD8 __usad8
  726. #define __USADA8 __usada8
  727. #define __SSAT16 __ssat16
  728. #define __USAT16 __usat16
  729. #define __UXTB16 __uxtb16
  730. #define __UXTAB16 __uxtab16
  731. #define __SXTB16 __sxtb16
  732. #define __SXTAB16 __sxtab16
  733. #define __SMUAD __smuad
  734. #define __SMUADX __smuadx
  735. #define __SMLAD __smlad
  736. #define __SMLADX __smladx
  737. #define __SMLALD __smlald
  738. #define __SMLALDX __smlaldx
  739. #define __SMUSD __smusd
  740. #define __SMUSDX __smusdx
  741. #define __SMLSD __smlsd
  742. #define __SMLSDX __smlsdx
  743. #define __SMLSLD __smlsld
  744. #define __SMLSLDX __smlsldx
  745. #define __SEL __sel
  746. #define __QADD __qadd
  747. #define __QSUB __qsub
  748. #define __PKHBT(ARG1,ARG2,ARG3) ( ((((uint32_t)(ARG1)) ) & 0x0000FFFFUL) | \
  749. ((((uint32_t)(ARG2)) << (ARG3)) & 0xFFFF0000UL) )
  750. #define __PKHTB(ARG1,ARG2,ARG3) ( ((((uint32_t)(ARG1)) ) & 0xFFFF0000UL) | \
  751. ((((uint32_t)(ARG2)) >> (ARG3)) & 0x0000FFFFUL) )
  752. #define __SMMLA(ARG1,ARG2,ARG3) ( (int32_t)((((int64_t)(ARG1) * (ARG2)) + \
  753. ((int64_t)(ARG3) << 32U) ) >> 32U))
  754. #endif /* ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
  755. /*@} end of group CMSIS_SIMD_intrinsics */
  756. #endif /* __CMSIS_ARMCC_H */