core_cm0plus.h 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778
  1. /**************************************************************************//**
  2. * @file core_cm0plus.h
  3. * @brief CMSIS Cortex-M0+ Core Peripheral Access Layer Header File
  4. * @version V3.01
  5. * @date 22. March 2012
  6. *
  7. * @note
  8. * Copyright (C) 2009-2012 ARM Limited. All rights reserved.
  9. *
  10. * @par
  11. * ARM Limited (ARM) is supplying this software for use with Cortex-M
  12. * processor based microcontrollers. This file can be freely distributed
  13. * within development tools that are supporting such ARM based processors.
  14. *
  15. * @par
  16. * THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED
  17. * OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
  18. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
  19. * ARM SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
  20. * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
  21. *
  22. ******************************************************************************/
  23. #if defined ( __ICCARM__ )
  24. #pragma system_include /* treat file as system include file for MISRA check */
  25. #endif
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif
  29. #ifndef __CORE_CM0PLUS_H_GENERIC
  30. #define __CORE_CM0PLUS_H_GENERIC
  31. /** \page CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions
  32. CMSIS violates the following MISRA-C:2004 rules:
  33. \li Required Rule 8.5, object/function definition in header file.<br>
  34. Function definitions in header files are used to allow 'inlining'.
  35. \li Required Rule 18.4, declaration of union type or object of union type: '{...}'.<br>
  36. Unions are used for effective representation of core registers.
  37. \li Advisory Rule 19.7, Function-like macro defined.<br>
  38. Function-like macros are used to allow more efficient code.
  39. */
  40. /*******************************************************************************
  41. * CMSIS definitions
  42. ******************************************************************************/
  43. /** \ingroup Cortex-M0+
  44. @{
  45. */
  46. /* CMSIS CM0P definitions */
  47. #define __CM0PLUS_CMSIS_VERSION_MAIN (0x03) /*!< [31:16] CMSIS HAL main version */
  48. #define __CM0PLUS_CMSIS_VERSION_SUB (0x01) /*!< [15:0] CMSIS HAL sub version */
  49. #define __CM0PLUS_CMSIS_VERSION ((__CM0PLUS_CMSIS_VERSION_MAIN << 16) | \
  50. __CM0PLUS_CMSIS_VERSION_SUB) /*!< CMSIS HAL version number */
  51. #define __CORTEX_M (0x00) /*!< Cortex-M Core */
  52. #if defined ( __CC_ARM )
  53. #define __ASM __asm /*!< asm keyword for ARM Compiler */
  54. #define __INLINE __inline /*!< inline keyword for ARM Compiler */
  55. #define __STATIC_INLINE static __inline
  56. #elif defined ( __ICCARM__ )
  57. #define __ASM __asm /*!< asm keyword for IAR Compiler */
  58. #define __INLINE inline /*!< inline keyword for IAR Compiler. Only available in High optimization mode! */
  59. #define __STATIC_INLINE static inline
  60. #elif defined ( __GNUC__ )
  61. #define __ASM __asm /*!< asm keyword for GNU Compiler */
  62. #define __INLINE inline /*!< inline keyword for GNU Compiler */
  63. #define __STATIC_INLINE static inline
  64. #elif defined ( __TASKING__ )
  65. #define __ASM __asm /*!< asm keyword for TASKING Compiler */
  66. #define __INLINE inline /*!< inline keyword for TASKING Compiler */
  67. #define __STATIC_INLINE static inline
  68. #endif
  69. /** __FPU_USED indicates whether an FPU is used or not. This core does not support an FPU at all
  70. */
  71. #define __FPU_USED 0
  72. #if defined ( __CC_ARM )
  73. #if defined __TARGET_FPU_VFP
  74. #warning "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
  75. #endif
  76. #elif defined ( __ICCARM__ )
  77. #if defined __ARMVFP__
  78. #warning "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
  79. #endif
  80. #elif defined ( __GNUC__ )
  81. #if defined (__VFP_FP__) && !defined(__SOFTFP__)
  82. #warning "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
  83. #endif
  84. #elif defined ( __TASKING__ )
  85. #if defined __FPU_VFP__
  86. #error "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
  87. #endif
  88. #endif
  89. #include <stdint.h> /* standard types definitions */
  90. #include <core_cmInstr.h> /* Core Instruction Access */
  91. #include <core_cmFunc.h> /* Core Function Access */
  92. #endif /* __CORE_CM0PLUS_H_GENERIC */
  93. #ifndef __CMSIS_GENERIC
  94. #ifndef __CORE_CM0PLUS_H_DEPENDANT
  95. #define __CORE_CM0PLUS_H_DEPENDANT
  96. /* check device defines and use defaults */
  97. #if defined __CHECK_DEVICE_DEFINES
  98. #ifndef __CM0PLUS_REV
  99. #define __CM0PLUS_REV 0x0000
  100. #warning "__CM0PLUS_REV not defined in device header file; using default!"
  101. #endif
  102. #ifndef __MPU_PRESENT
  103. #define __MPU_PRESENT 0
  104. #warning "__MPU_PRESENT not defined in device header file; using default!"
  105. #endif
  106. #ifndef __VTOR_PRESENT
  107. #define __VTOR_PRESENT 0
  108. #warning "__VTOR_PRESENT not defined in device header file; using default!"
  109. #endif
  110. #ifndef __NVIC_PRIO_BITS
  111. #define __NVIC_PRIO_BITS 2
  112. #warning "__NVIC_PRIO_BITS not defined in device header file; using default!"
  113. #endif
  114. #ifndef __Vendor_SysTickConfig
  115. #define __Vendor_SysTickConfig 0
  116. #warning "__Vendor_SysTickConfig not defined in device header file; using default!"
  117. #endif
  118. #endif
  119. /* IO definitions (access restrictions to peripheral registers) */
  120. /**
  121. \defgroup CMSIS_glob_defs CMSIS Global Defines
  122. <strong>IO Type Qualifiers</strong> are used
  123. \li to specify the access to peripheral variables.
  124. \li for automatic generation of peripheral register debug information.
  125. */
  126. #ifdef __cplusplus
  127. #define __I volatile /*!< Defines 'read only' permissions */
  128. #else
  129. #define __I volatile const /*!< Defines 'read only' permissions */
  130. #endif
  131. #define __O volatile /*!< Defines 'write only' permissions */
  132. #define __IO volatile /*!< Defines 'read / write' permissions */
  133. /*@} end of group Cortex-M0+ */
  134. /*******************************************************************************
  135. * Register Abstraction
  136. Core Register contain:
  137. - Core Register
  138. - Core NVIC Register
  139. - Core SCB Register
  140. - Core SysTick Register
  141. - Core MPU Register
  142. ******************************************************************************/
  143. /** \defgroup CMSIS_core_register Defines and Type Definitions
  144. \brief Type definitions and defines for Cortex-M processor based devices.
  145. */
  146. /** \ingroup CMSIS_core_register
  147. \defgroup CMSIS_CORE Status and Control Registers
  148. \brief Core Register type definitions.
  149. @{
  150. */
  151. /** \brief Union type to access the Application Program Status Register (APSR).
  152. */
  153. typedef union
  154. {
  155. struct
  156. {
  157. #if (__CORTEX_M != 0x04)
  158. uint32_t _reserved0:27; /*!< bit: 0..26 Reserved */
  159. #else
  160. uint32_t _reserved0:16; /*!< bit: 0..15 Reserved */
  161. uint32_t GE:4; /*!< bit: 16..19 Greater than or Equal flags */
  162. uint32_t _reserved1:7; /*!< bit: 20..26 Reserved */
  163. #endif
  164. uint32_t Q:1; /*!< bit: 27 Saturation condition flag */
  165. uint32_t V:1; /*!< bit: 28 Overflow condition code flag */
  166. uint32_t C:1; /*!< bit: 29 Carry condition code flag */
  167. uint32_t Z:1; /*!< bit: 30 Zero condition code flag */
  168. uint32_t N:1; /*!< bit: 31 Negative condition code flag */
  169. } b; /*!< Structure used for bit access */
  170. uint32_t w; /*!< Type used for word access */
  171. } APSR_Type;
  172. /** \brief Union type to access the Interrupt Program Status Register (IPSR).
  173. */
  174. typedef union
  175. {
  176. struct
  177. {
  178. uint32_t ISR:9; /*!< bit: 0.. 8 Exception number */
  179. uint32_t _reserved0:23; /*!< bit: 9..31 Reserved */
  180. } b; /*!< Structure used for bit access */
  181. uint32_t w; /*!< Type used for word access */
  182. } IPSR_Type;
  183. /** \brief Union type to access the Special-Purpose Program Status Registers (xPSR).
  184. */
  185. typedef union
  186. {
  187. struct
  188. {
  189. uint32_t ISR:9; /*!< bit: 0.. 8 Exception number */
  190. #if (__CORTEX_M != 0x04)
  191. uint32_t _reserved0:15; /*!< bit: 9..23 Reserved */
  192. #else
  193. uint32_t _reserved0:7; /*!< bit: 9..15 Reserved */
  194. uint32_t GE:4; /*!< bit: 16..19 Greater than or Equal flags */
  195. uint32_t _reserved1:4; /*!< bit: 20..23 Reserved */
  196. #endif
  197. uint32_t T:1; /*!< bit: 24 Thumb bit (read 0) */
  198. uint32_t IT:2; /*!< bit: 25..26 saved IT state (read 0) */
  199. uint32_t Q:1; /*!< bit: 27 Saturation condition flag */
  200. uint32_t V:1; /*!< bit: 28 Overflow condition code flag */
  201. uint32_t C:1; /*!< bit: 29 Carry condition code flag */
  202. uint32_t Z:1; /*!< bit: 30 Zero condition code flag */
  203. uint32_t N:1; /*!< bit: 31 Negative condition code flag */
  204. } b; /*!< Structure used for bit access */
  205. uint32_t w; /*!< Type used for word access */
  206. } xPSR_Type;
  207. /** \brief Union type to access the Control Registers (CONTROL).
  208. */
  209. typedef union
  210. {
  211. struct
  212. {
  213. uint32_t nPRIV:1; /*!< bit: 0 Execution privilege in Thread mode */
  214. uint32_t SPSEL:1; /*!< bit: 1 Stack to be used */
  215. uint32_t FPCA:1; /*!< bit: 2 FP extension active flag */
  216. uint32_t _reserved0:29; /*!< bit: 3..31 Reserved */
  217. } b; /*!< Structure used for bit access */
  218. uint32_t w; /*!< Type used for word access */
  219. } CONTROL_Type;
  220. /*@} end of group CMSIS_CORE */
  221. /** \ingroup CMSIS_core_register
  222. \defgroup CMSIS_NVIC Nested Vectored Interrupt Controller (NVIC)
  223. \brief Type definitions for the NVIC Registers
  224. @{
  225. */
  226. /** \brief Structure type to access the Nested Vectored Interrupt Controller (NVIC).
  227. */
  228. typedef struct
  229. {
  230. __IO uint32_t ISER[1]; /*!< Offset: 0x000 (R/W) Interrupt Set Enable Register */
  231. uint32_t RESERVED0[31];
  232. __IO uint32_t ICER[1]; /*!< Offset: 0x080 (R/W) Interrupt Clear Enable Register */
  233. uint32_t RSERVED1[31];
  234. __IO uint32_t ISPR[1]; /*!< Offset: 0x100 (R/W) Interrupt Set Pending Register */
  235. uint32_t RESERVED2[31];
  236. __IO uint32_t ICPR[1]; /*!< Offset: 0x180 (R/W) Interrupt Clear Pending Register */
  237. uint32_t RESERVED3[31];
  238. uint32_t RESERVED4[64];
  239. __IO uint32_t IP[8]; /*!< Offset: 0x300 (R/W) Interrupt Priority Register */
  240. } NVIC_Type;
  241. /*@} end of group CMSIS_NVIC */
  242. /** \ingroup CMSIS_core_register
  243. \defgroup CMSIS_SCB System Control Block (SCB)
  244. \brief Type definitions for the System Control Block Registers
  245. @{
  246. */
  247. /** \brief Structure type to access the System Control Block (SCB).
  248. */
  249. typedef struct
  250. {
  251. __I uint32_t CPUID; /*!< Offset: 0x000 (R/ ) CPUID Base Register */
  252. __IO uint32_t ICSR; /*!< Offset: 0x004 (R/W) Interrupt Control and State Register */
  253. #if (__VTOR_PRESENT == 1)
  254. __IO uint32_t VTOR; /*!< Offset: 0x008 (R/W) Vector Table Offset Register */
  255. #else
  256. uint32_t RESERVED0;
  257. #endif
  258. __IO uint32_t AIRCR; /*!< Offset: 0x00C (R/W) Application Interrupt and Reset Control Register */
  259. __IO uint32_t SCR; /*!< Offset: 0x010 (R/W) System Control Register */
  260. __IO uint32_t CCR; /*!< Offset: 0x014 (R/W) Configuration Control Register */
  261. uint32_t RESERVED1;
  262. __IO uint32_t SHP[2]; /*!< Offset: 0x01C (R/W) System Handlers Priority Registers. [0] is RESERVED */
  263. __IO uint32_t SHCSR; /*!< Offset: 0x024 (R/W) System Handler Control and State Register */
  264. } SCB_Type;
  265. /* SCB CPUID Register Definitions */
  266. #define SCB_CPUID_IMPLEMENTER_Pos 24 /*!< SCB CPUID: IMPLEMENTER Position */
  267. #define SCB_CPUID_IMPLEMENTER_Msk (0xFFUL << SCB_CPUID_IMPLEMENTER_Pos) /*!< SCB CPUID: IMPLEMENTER Mask */
  268. #define SCB_CPUID_VARIANT_Pos 20 /*!< SCB CPUID: VARIANT Position */
  269. #define SCB_CPUID_VARIANT_Msk (0xFUL << SCB_CPUID_VARIANT_Pos) /*!< SCB CPUID: VARIANT Mask */
  270. #define SCB_CPUID_ARCHITECTURE_Pos 16 /*!< SCB CPUID: ARCHITECTURE Position */
  271. #define SCB_CPUID_ARCHITECTURE_Msk (0xFUL << SCB_CPUID_ARCHITECTURE_Pos) /*!< SCB CPUID: ARCHITECTURE Mask */
  272. #define SCB_CPUID_PARTNO_Pos 4 /*!< SCB CPUID: PARTNO Position */
  273. #define SCB_CPUID_PARTNO_Msk (0xFFFUL << SCB_CPUID_PARTNO_Pos) /*!< SCB CPUID: PARTNO Mask */
  274. #define SCB_CPUID_REVISION_Pos 0 /*!< SCB CPUID: REVISION Position */
  275. #define SCB_CPUID_REVISION_Msk (0xFUL << SCB_CPUID_REVISION_Pos) /*!< SCB CPUID: REVISION Mask */
  276. /* SCB Interrupt Control State Register Definitions */
  277. #define SCB_ICSR_NMIPENDSET_Pos 31 /*!< SCB ICSR: NMIPENDSET Position */
  278. #define SCB_ICSR_NMIPENDSET_Msk (1UL << SCB_ICSR_NMIPENDSET_Pos) /*!< SCB ICSR: NMIPENDSET Mask */
  279. #define SCB_ICSR_PENDSVSET_Pos 28 /*!< SCB ICSR: PENDSVSET Position */
  280. #define SCB_ICSR_PENDSVSET_Msk (1UL << SCB_ICSR_PENDSVSET_Pos) /*!< SCB ICSR: PENDSVSET Mask */
  281. #define SCB_ICSR_PENDSVCLR_Pos 27 /*!< SCB ICSR: PENDSVCLR Position */
  282. #define SCB_ICSR_PENDSVCLR_Msk (1UL << SCB_ICSR_PENDSVCLR_Pos) /*!< SCB ICSR: PENDSVCLR Mask */
  283. #define SCB_ICSR_PENDSTSET_Pos 26 /*!< SCB ICSR: PENDSTSET Position */
  284. #define SCB_ICSR_PENDSTSET_Msk (1UL << SCB_ICSR_PENDSTSET_Pos) /*!< SCB ICSR: PENDSTSET Mask */
  285. #define SCB_ICSR_PENDSTCLR_Pos 25 /*!< SCB ICSR: PENDSTCLR Position */
  286. #define SCB_ICSR_PENDSTCLR_Msk (1UL << SCB_ICSR_PENDSTCLR_Pos) /*!< SCB ICSR: PENDSTCLR Mask */
  287. #define SCB_ICSR_ISRPREEMPT_Pos 23 /*!< SCB ICSR: ISRPREEMPT Position */
  288. #define SCB_ICSR_ISRPREEMPT_Msk (1UL << SCB_ICSR_ISRPREEMPT_Pos) /*!< SCB ICSR: ISRPREEMPT Mask */
  289. #define SCB_ICSR_ISRPENDING_Pos 22 /*!< SCB ICSR: ISRPENDING Position */
  290. #define SCB_ICSR_ISRPENDING_Msk (1UL << SCB_ICSR_ISRPENDING_Pos) /*!< SCB ICSR: ISRPENDING Mask */
  291. #define SCB_ICSR_VECTPENDING_Pos 12 /*!< SCB ICSR: VECTPENDING Position */
  292. #define SCB_ICSR_VECTPENDING_Msk (0x1FFUL << SCB_ICSR_VECTPENDING_Pos) /*!< SCB ICSR: VECTPENDING Mask */
  293. #define SCB_ICSR_VECTACTIVE_Pos 0 /*!< SCB ICSR: VECTACTIVE Position */
  294. #define SCB_ICSR_VECTACTIVE_Msk (0x1FFUL << SCB_ICSR_VECTACTIVE_Pos) /*!< SCB ICSR: VECTACTIVE Mask */
  295. #if (__VTOR_PRESENT == 1)
  296. /* SCB Interrupt Control State Register Definitions */
  297. #define SCB_VTOR_TBLOFF_Pos 7 /*!< SCB VTOR: TBLOFF Position */
  298. #define SCB_VTOR_TBLOFF_Msk (0x1FFFFFFUL << SCB_VTOR_TBLOFF_Pos) /*!< SCB VTOR: TBLOFF Mask */
  299. #endif
  300. /* SCB Application Interrupt and Reset Control Register Definitions */
  301. #define SCB_AIRCR_VECTKEY_Pos 16 /*!< SCB AIRCR: VECTKEY Position */
  302. #define SCB_AIRCR_VECTKEY_Msk (0xFFFFUL << SCB_AIRCR_VECTKEY_Pos) /*!< SCB AIRCR: VECTKEY Mask */
  303. #define SCB_AIRCR_VECTKEYSTAT_Pos 16 /*!< SCB AIRCR: VECTKEYSTAT Position */
  304. #define SCB_AIRCR_VECTKEYSTAT_Msk (0xFFFFUL << SCB_AIRCR_VECTKEYSTAT_Pos) /*!< SCB AIRCR: VECTKEYSTAT Mask */
  305. #define SCB_AIRCR_ENDIANESS_Pos 15 /*!< SCB AIRCR: ENDIANESS Position */
  306. #define SCB_AIRCR_ENDIANESS_Msk (1UL << SCB_AIRCR_ENDIANESS_Pos) /*!< SCB AIRCR: ENDIANESS Mask */
  307. #define SCB_AIRCR_SYSRESETREQ_Pos 2 /*!< SCB AIRCR: SYSRESETREQ Position */
  308. #define SCB_AIRCR_SYSRESETREQ_Msk (1UL << SCB_AIRCR_SYSRESETREQ_Pos) /*!< SCB AIRCR: SYSRESETREQ Mask */
  309. #define SCB_AIRCR_VECTCLRACTIVE_Pos 1 /*!< SCB AIRCR: VECTCLRACTIVE Position */
  310. #define SCB_AIRCR_VECTCLRACTIVE_Msk (1UL << SCB_AIRCR_VECTCLRACTIVE_Pos) /*!< SCB AIRCR: VECTCLRACTIVE Mask */
  311. /* SCB System Control Register Definitions */
  312. #define SCB_SCR_SEVONPEND_Pos 4 /*!< SCB SCR: SEVONPEND Position */
  313. #define SCB_SCR_SEVONPEND_Msk (1UL << SCB_SCR_SEVONPEND_Pos) /*!< SCB SCR: SEVONPEND Mask */
  314. #define SCB_SCR_SLEEPDEEP_Pos 2 /*!< SCB SCR: SLEEPDEEP Position */
  315. #define SCB_SCR_SLEEPDEEP_Msk (1UL << SCB_SCR_SLEEPDEEP_Pos) /*!< SCB SCR: SLEEPDEEP Mask */
  316. #define SCB_SCR_SLEEPONEXIT_Pos 1 /*!< SCB SCR: SLEEPONEXIT Position */
  317. #define SCB_SCR_SLEEPONEXIT_Msk (1UL << SCB_SCR_SLEEPONEXIT_Pos) /*!< SCB SCR: SLEEPONEXIT Mask */
  318. /* SCB Configuration Control Register Definitions */
  319. #define SCB_CCR_STKALIGN_Pos 9 /*!< SCB CCR: STKALIGN Position */
  320. #define SCB_CCR_STKALIGN_Msk (1UL << SCB_CCR_STKALIGN_Pos) /*!< SCB CCR: STKALIGN Mask */
  321. #define SCB_CCR_UNALIGN_TRP_Pos 3 /*!< SCB CCR: UNALIGN_TRP Position */
  322. #define SCB_CCR_UNALIGN_TRP_Msk (1UL << SCB_CCR_UNALIGN_TRP_Pos) /*!< SCB CCR: UNALIGN_TRP Mask */
  323. /* SCB System Handler Control and State Register Definitions */
  324. #define SCB_SHCSR_SVCALLPENDED_Pos 15 /*!< SCB SHCSR: SVCALLPENDED Position */
  325. #define SCB_SHCSR_SVCALLPENDED_Msk (1UL << SCB_SHCSR_SVCALLPENDED_Pos) /*!< SCB SHCSR: SVCALLPENDED Mask */
  326. /*@} end of group CMSIS_SCB */
  327. /** \ingroup CMSIS_core_register
  328. \defgroup CMSIS_SysTick System Tick Timer (SysTick)
  329. \brief Type definitions for the System Timer Registers.
  330. @{
  331. */
  332. /** \brief Structure type to access the System Timer (SysTick).
  333. */
  334. typedef struct
  335. {
  336. __IO uint32_t CTRL; /*!< Offset: 0x000 (R/W) SysTick Control and Status Register */
  337. __IO uint32_t LOAD; /*!< Offset: 0x004 (R/W) SysTick Reload Value Register */
  338. __IO uint32_t VAL; /*!< Offset: 0x008 (R/W) SysTick Current Value Register */
  339. __I uint32_t CALIB; /*!< Offset: 0x00C (R/ ) SysTick Calibration Register */
  340. } SysTick_Type;
  341. /* SysTick Control / Status Register Definitions */
  342. #define SysTick_CTRL_COUNTFLAG_Pos 16 /*!< SysTick CTRL: COUNTFLAG Position */
  343. #define SysTick_CTRL_COUNTFLAG_Msk (1UL << SysTick_CTRL_COUNTFLAG_Pos) /*!< SysTick CTRL: COUNTFLAG Mask */
  344. #define SysTick_CTRL_CLKSOURCE_Pos 2 /*!< SysTick CTRL: CLKSOURCE Position */
  345. #define SysTick_CTRL_CLKSOURCE_Msk (1UL << SysTick_CTRL_CLKSOURCE_Pos) /*!< SysTick CTRL: CLKSOURCE Mask */
  346. #define SysTick_CTRL_TICKINT_Pos 1 /*!< SysTick CTRL: TICKINT Position */
  347. #define SysTick_CTRL_TICKINT_Msk (1UL << SysTick_CTRL_TICKINT_Pos) /*!< SysTick CTRL: TICKINT Mask */
  348. #define SysTick_CTRL_ENABLE_Pos 0 /*!< SysTick CTRL: ENABLE Position */
  349. #define SysTick_CTRL_ENABLE_Msk (1UL << SysTick_CTRL_ENABLE_Pos) /*!< SysTick CTRL: ENABLE Mask */
  350. /* SysTick Reload Register Definitions */
  351. #define SysTick_LOAD_RELOAD_Pos 0 /*!< SysTick LOAD: RELOAD Position */
  352. #define SysTick_LOAD_RELOAD_Msk (0xFFFFFFUL << SysTick_LOAD_RELOAD_Pos) /*!< SysTick LOAD: RELOAD Mask */
  353. /* SysTick Current Register Definitions */
  354. #define SysTick_VAL_CURRENT_Pos 0 /*!< SysTick VAL: CURRENT Position */
  355. #define SysTick_VAL_CURRENT_Msk (0xFFFFFFUL << SysTick_VAL_CURRENT_Pos) /*!< SysTick VAL: CURRENT Mask */
  356. /* SysTick Calibration Register Definitions */
  357. #define SysTick_CALIB_NOREF_Pos 31 /*!< SysTick CALIB: NOREF Position */
  358. #define SysTick_CALIB_NOREF_Msk (1UL << SysTick_CALIB_NOREF_Pos) /*!< SysTick CALIB: NOREF Mask */
  359. #define SysTick_CALIB_SKEW_Pos 30 /*!< SysTick CALIB: SKEW Position */
  360. #define SysTick_CALIB_SKEW_Msk (1UL << SysTick_CALIB_SKEW_Pos) /*!< SysTick CALIB: SKEW Mask */
  361. #define SysTick_CALIB_TENMS_Pos 0 /*!< SysTick CALIB: TENMS Position */
  362. #define SysTick_CALIB_TENMS_Msk (0xFFFFFFUL << SysTick_VAL_CURRENT_Pos) /*!< SysTick CALIB: TENMS Mask */
  363. /*@} end of group CMSIS_SysTick */
  364. #if (__MPU_PRESENT == 1)
  365. /** \ingroup CMSIS_core_register
  366. \defgroup CMSIS_MPU Memory Protection Unit (MPU)
  367. \brief Type definitions for the Memory Protection Unit (MPU)
  368. @{
  369. */
  370. /** \brief Structure type to access the Memory Protection Unit (MPU).
  371. */
  372. typedef struct
  373. {
  374. __I uint32_t TYPE; /*!< Offset: 0x000 (R/ ) MPU Type Register */
  375. __IO uint32_t CTRL; /*!< Offset: 0x004 (R/W) MPU Control Register */
  376. __IO uint32_t RNR; /*!< Offset: 0x008 (R/W) MPU Region RNRber Register */
  377. __IO uint32_t RBAR; /*!< Offset: 0x00C (R/W) MPU Region Base Address Register */
  378. __IO uint32_t RASR; /*!< Offset: 0x010 (R/W) MPU Region Attribute and Size Register */
  379. } MPU_Type;
  380. /* MPU Type Register */
  381. #define MPU_TYPE_IREGION_Pos 16 /*!< MPU TYPE: IREGION Position */
  382. #define MPU_TYPE_IREGION_Msk (0xFFUL << MPU_TYPE_IREGION_Pos) /*!< MPU TYPE: IREGION Mask */
  383. #define MPU_TYPE_DREGION_Pos 8 /*!< MPU TYPE: DREGION Position */
  384. #define MPU_TYPE_DREGION_Msk (0xFFUL << MPU_TYPE_DREGION_Pos) /*!< MPU TYPE: DREGION Mask */
  385. #define MPU_TYPE_SEPARATE_Pos 0 /*!< MPU TYPE: SEPARATE Position */
  386. #define MPU_TYPE_SEPARATE_Msk (1UL << MPU_TYPE_SEPARATE_Pos) /*!< MPU TYPE: SEPARATE Mask */
  387. /* MPU Control Register */
  388. #define MPU_CTRL_PRIVDEFENA_Pos 2 /*!< MPU CTRL: PRIVDEFENA Position */
  389. #define MPU_CTRL_PRIVDEFENA_Msk (1UL << MPU_CTRL_PRIVDEFENA_Pos) /*!< MPU CTRL: PRIVDEFENA Mask */
  390. #define MPU_CTRL_HFNMIENA_Pos 1 /*!< MPU CTRL: HFNMIENA Position */
  391. #define MPU_CTRL_HFNMIENA_Msk (1UL << MPU_CTRL_HFNMIENA_Pos) /*!< MPU CTRL: HFNMIENA Mask */
  392. #define MPU_CTRL_ENABLE_Pos 0 /*!< MPU CTRL: ENABLE Position */
  393. #define MPU_CTRL_ENABLE_Msk (1UL << MPU_CTRL_ENABLE_Pos) /*!< MPU CTRL: ENABLE Mask */
  394. /* MPU Region Number Register */
  395. #define MPU_RNR_REGION_Pos 0 /*!< MPU RNR: REGION Position */
  396. #define MPU_RNR_REGION_Msk (0xFFUL << MPU_RNR_REGION_Pos) /*!< MPU RNR: REGION Mask */
  397. /* MPU Region Base Address Register */
  398. #define MPU_RBAR_ADDR_Pos 8 /*!< MPU RBAR: ADDR Position */
  399. #define MPU_RBAR_ADDR_Msk (0xFFFFFFUL << MPU_RBAR_ADDR_Pos) /*!< MPU RBAR: ADDR Mask */
  400. #define MPU_RBAR_VALID_Pos 4 /*!< MPU RBAR: VALID Position */
  401. #define MPU_RBAR_VALID_Msk (1UL << MPU_RBAR_VALID_Pos) /*!< MPU RBAR: VALID Mask */
  402. #define MPU_RBAR_REGION_Pos 0 /*!< MPU RBAR: REGION Position */
  403. #define MPU_RBAR_REGION_Msk (0xFUL << MPU_RBAR_REGION_Pos) /*!< MPU RBAR: REGION Mask */
  404. /* MPU Region Attribute and Size Register */
  405. #define MPU_RASR_ATTRS_Pos 16 /*!< MPU RASR: MPU Region Attribute field Position */
  406. #define MPU_RASR_ATTRS_Msk (0xFFFFUL << MPU_RASR_ATTRS_Pos) /*!< MPU RASR: MPU Region Attribute field Mask */
  407. #define MPU_RASR_XN_Pos 28 /*!< MPU RASR: ATTRS.XN Position */
  408. #define MPU_RASR_XN_Msk (1UL << MPU_RASR_XN_Pos) /*!< MPU RASR: ATTRS.XN Mask */
  409. #define MPU_RASR_AP_Pos 24 /*!< MPU RASR: ATTRS.AP Position */
  410. #define MPU_RASR_AP_Msk (0x7UL << MPU_RASR_AP_Pos) /*!< MPU RASR: ATTRS.AP Mask */
  411. #define MPU_RASR_TEX_Pos 19 /*!< MPU RASR: ATTRS.TEX Position */
  412. #define MPU_RASR_TEX_Msk (0x7UL << MPU_RASR_TEX_Pos) /*!< MPU RASR: ATTRS.TEX Mask */
  413. #define MPU_RASR_S_Pos 18 /*!< MPU RASR: ATTRS.S Position */
  414. #define MPU_RASR_S_Msk (1UL << MPU_RASR_S_Pos) /*!< MPU RASR: ATTRS.S Mask */
  415. #define MPU_RASR_C_Pos 17 /*!< MPU RASR: ATTRS.C Position */
  416. #define MPU_RASR_C_Msk (1UL << MPU_RASR_C_Pos) /*!< MPU RASR: ATTRS.C Mask */
  417. #define MPU_RASR_B_Pos 16 /*!< MPU RASR: ATTRS.B Position */
  418. #define MPU_RASR_B_Msk (1UL << MPU_RASR_B_Pos) /*!< MPU RASR: ATTRS.B Mask */
  419. #define MPU_RASR_SRD_Pos 8 /*!< MPU RASR: Sub-Region Disable Position */
  420. #define MPU_RASR_SRD_Msk (0xFFUL << MPU_RASR_SRD_Pos) /*!< MPU RASR: Sub-Region Disable Mask */
  421. #define MPU_RASR_SIZE_Pos 1 /*!< MPU RASR: Region Size Field Position */
  422. #define MPU_RASR_SIZE_Msk (0x1FUL << MPU_RASR_SIZE_Pos) /*!< MPU RASR: Region Size Field Mask */
  423. #define MPU_RASR_ENABLE_Pos 0 /*!< MPU RASR: Region enable bit Position */
  424. #define MPU_RASR_ENABLE_Msk (1UL << MPU_RASR_ENABLE_Pos) /*!< MPU RASR: Region enable bit Disable Mask */
  425. /*@} end of group CMSIS_MPU */
  426. #endif
  427. /** \ingroup CMSIS_core_register
  428. \defgroup CMSIS_CoreDebug Core Debug Registers (CoreDebug)
  429. \brief Cortex-M0+ Core Debug Registers (DCB registers, SHCSR, and DFSR)
  430. are only accessible over DAP and not via processor. Therefore
  431. they are not covered by the Cortex-M0 header file.
  432. @{
  433. */
  434. /*@} end of group CMSIS_CoreDebug */
  435. /** \ingroup CMSIS_core_register
  436. \defgroup CMSIS_core_base Core Definitions
  437. \brief Definitions for base addresses, unions, and structures.
  438. @{
  439. */
  440. /* Memory mapping of Cortex-M0+ Hardware */
  441. #define SCS_BASE (0xE000E000UL) /*!< System Control Space Base Address */
  442. #define SysTick_BASE (SCS_BASE + 0x0010UL) /*!< SysTick Base Address */
  443. #define NVIC_BASE (SCS_BASE + 0x0100UL) /*!< NVIC Base Address */
  444. #define SCB_BASE (SCS_BASE + 0x0D00UL) /*!< System Control Block Base Address */
  445. #define SCB ((SCB_Type *) SCB_BASE ) /*!< SCB configuration struct */
  446. #define SysTick ((SysTick_Type *) SysTick_BASE ) /*!< SysTick configuration struct */
  447. #define NVIC ((NVIC_Type *) NVIC_BASE ) /*!< NVIC configuration struct */
  448. #if (__MPU_PRESENT == 1)
  449. #define MPU_BASE (SCS_BASE + 0x0D90UL) /*!< Memory Protection Unit */
  450. #define MPU ((MPU_Type *) MPU_BASE ) /*!< Memory Protection Unit */
  451. #endif
  452. /*@} */
  453. /*******************************************************************************
  454. * Hardware Abstraction Layer
  455. Core Function Interface contains:
  456. - Core NVIC Functions
  457. - Core SysTick Functions
  458. - Core Register Access Functions
  459. ******************************************************************************/
  460. /** \defgroup CMSIS_Core_FunctionInterface Functions and Instructions Reference
  461. */
  462. /* ########################## NVIC functions #################################### */
  463. /** \ingroup CMSIS_Core_FunctionInterface
  464. \defgroup CMSIS_Core_NVICFunctions NVIC Functions
  465. \brief Functions that manage interrupts and exceptions via the NVIC.
  466. @{
  467. */
  468. /* Interrupt Priorities are WORD accessible only under ARMv6M */
  469. /* The following MACROS handle generation of the register offset and byte masks */
  470. #define _BIT_SHIFT(IRQn) ( (((uint32_t)(IRQn) ) & 0x03) * 8 )
  471. #define _SHP_IDX(IRQn) ( ((((uint32_t)(IRQn) & 0x0F)-8) >> 2) )
  472. #define _IP_IDX(IRQn) ( ((uint32_t)(IRQn) >> 2) )
  473. /** \brief Enable External Interrupt
  474. The function enables a device-specific interrupt in the NVIC interrupt controller.
  475. \param [in] IRQn External interrupt number. Value cannot be negative.
  476. */
  477. __STATIC_INLINE void NVIC_EnableIRQ(IRQn_Type IRQn)
  478. {
  479. NVIC->ISER[0] = (1 << ((uint32_t)(IRQn) & 0x1F));
  480. }
  481. /** \brief Disable External Interrupt
  482. The function disables a device-specific interrupt in the NVIC interrupt controller.
  483. \param [in] IRQn External interrupt number. Value cannot be negative.
  484. */
  485. __STATIC_INLINE void NVIC_DisableIRQ(IRQn_Type IRQn)
  486. {
  487. NVIC->ICER[0] = (1 << ((uint32_t)(IRQn) & 0x1F));
  488. }
  489. /** \brief Get Pending Interrupt
  490. The function reads the pending register in the NVIC and returns the pending bit
  491. for the specified interrupt.
  492. \param [in] IRQn Interrupt number.
  493. \return 0 Interrupt status is not pending.
  494. \return 1 Interrupt status is pending.
  495. */
  496. __STATIC_INLINE uint32_t NVIC_GetPendingIRQ(IRQn_Type IRQn)
  497. {
  498. return((uint32_t) ((NVIC->ISPR[0] & (1 << ((uint32_t)(IRQn) & 0x1F)))?1:0));
  499. }
  500. /** \brief Set Pending Interrupt
  501. The function sets the pending bit of an external interrupt.
  502. \param [in] IRQn Interrupt number. Value cannot be negative.
  503. */
  504. __STATIC_INLINE void NVIC_SetPendingIRQ(IRQn_Type IRQn)
  505. {
  506. NVIC->ISPR[0] = (1 << ((uint32_t)(IRQn) & 0x1F));
  507. }
  508. /** \brief Clear Pending Interrupt
  509. The function clears the pending bit of an external interrupt.
  510. \param [in] IRQn External interrupt number. Value cannot be negative.
  511. */
  512. __STATIC_INLINE void NVIC_ClearPendingIRQ(IRQn_Type IRQn)
  513. {
  514. NVIC->ICPR[0] = (1 << ((uint32_t)(IRQn) & 0x1F)); /* Clear pending interrupt */
  515. }
  516. /** \brief Set Interrupt Priority
  517. The function sets the priority of an interrupt.
  518. \note The priority cannot be set for every core interrupt.
  519. \param [in] IRQn Interrupt number.
  520. \param [in] priority Priority to set.
  521. */
  522. __STATIC_INLINE void NVIC_SetPriority(IRQn_Type IRQn, uint32_t priority)
  523. {
  524. if(IRQn < 0) {
  525. SCB->SHP[_SHP_IDX(IRQn)] = (SCB->SHP[_SHP_IDX(IRQn)] & ~(0xFF << _BIT_SHIFT(IRQn))) |
  526. (((priority << (8 - __NVIC_PRIO_BITS)) & 0xFF) << _BIT_SHIFT(IRQn)); }
  527. else {
  528. NVIC->IP[_IP_IDX(IRQn)] = (NVIC->IP[_IP_IDX(IRQn)] & ~(0xFF << _BIT_SHIFT(IRQn))) |
  529. (((priority << (8 - __NVIC_PRIO_BITS)) & 0xFF) << _BIT_SHIFT(IRQn)); }
  530. }
  531. /** \brief Get Interrupt Priority
  532. The function reads the priority of an interrupt. The interrupt
  533. number can be positive to specify an external (device specific)
  534. interrupt, or negative to specify an internal (core) interrupt.
  535. \param [in] IRQn Interrupt number.
  536. \return Interrupt Priority. Value is aligned automatically to the implemented
  537. priority bits of the microcontroller.
  538. */
  539. __STATIC_INLINE uint32_t NVIC_GetPriority(IRQn_Type IRQn)
  540. {
  541. if(IRQn < 0) {
  542. return((uint32_t)((SCB->SHP[_SHP_IDX(IRQn)] >> _BIT_SHIFT(IRQn) ) >> (8 - __NVIC_PRIO_BITS))); } /* get priority for Cortex-M0+ system interrupts */
  543. else {
  544. return((uint32_t)((NVIC->IP[ _IP_IDX(IRQn)] >> _BIT_SHIFT(IRQn) ) >> (8 - __NVIC_PRIO_BITS))); } /* get priority for device specific interrupts */
  545. }
  546. /** \brief System Reset
  547. The function initiates a system reset request to reset the MCU.
  548. */
  549. __STATIC_INLINE void NVIC_SystemReset(void)
  550. {
  551. __DSB(); /* Ensure all outstanding memory accesses included
  552. buffered write are completed before reset */
  553. SCB->AIRCR = ((0x5FA << SCB_AIRCR_VECTKEY_Pos) |
  554. SCB_AIRCR_SYSRESETREQ_Msk);
  555. __DSB(); /* Ensure completion of memory access */
  556. while(1); /* wait until reset */
  557. }
  558. /*@} end of CMSIS_Core_NVICFunctions */
  559. /* ################################## SysTick function ############################################ */
  560. /** \ingroup CMSIS_Core_FunctionInterface
  561. \defgroup CMSIS_Core_SysTickFunctions SysTick Functions
  562. \brief Functions that configure the System.
  563. @{
  564. */
  565. #if (__Vendor_SysTickConfig == 0)
  566. /** \brief System Tick Configuration
  567. The function initializes the System Timer and its interrupt, and starts the System Tick Timer.
  568. Counter is in free running mode to generate periodic interrupts.
  569. \param [in] ticks Number of ticks between two interrupts.
  570. \return 0 Function succeeded.
  571. \return 1 Function failed.
  572. \note When the variable <b>__Vendor_SysTickConfig</b> is set to 1, then the
  573. function <b>SysTick_Config</b> is not included. In this case, the file <b><i>device</i>.h</b>
  574. must contain a vendor-specific implementation of this function.
  575. */
  576. __STATIC_INLINE uint32_t SysTick_Config(uint32_t ticks)
  577. {
  578. if (ticks > SysTick_LOAD_RELOAD_Msk) return (1); /* Reload value impossible */
  579. SysTick->LOAD = (ticks & SysTick_LOAD_RELOAD_Msk) - 1; /* set reload register */
  580. NVIC_SetPriority (SysTick_IRQn, (1<<__NVIC_PRIO_BITS) - 1); /* set Priority for Systick Interrupt */
  581. SysTick->VAL = 0; /* Load the SysTick Counter Value */
  582. SysTick->CTRL = SysTick_CTRL_CLKSOURCE_Msk |
  583. SysTick_CTRL_TICKINT_Msk |
  584. SysTick_CTRL_ENABLE_Msk; /* Enable SysTick IRQ and SysTick Timer */
  585. return (0); /* Function successful */
  586. }
  587. #endif
  588. /*@} end of CMSIS_Core_SysTickFunctions */
  589. #endif /* __CORE_CM0PLUS_H_DEPENDANT */
  590. #endif /* __CMSIS_GENERIC */
  591. #ifdef __cplusplus
  592. }
  593. #endif