]> git.sur5r.net Git - freertos/blob
1e21e48210acc64a6e91234a5a3cebd75464b06e
[freertos] /
1 /**************************************************************************//**\r
2  * @file     core_cmFunc.h\r
3  * @brief    CMSIS Cortex-M Core Function Access Header File\r
4  * @version  V4.00\r
5  * @date     28. August 2014\r
6  *\r
7  * @note\r
8  *\r
9  ******************************************************************************/\r
10 /* Copyright (c) 2009 - 2014 ARM LIMITED\r
11 \r
12    All rights reserved.\r
13    Redistribution and use in source and binary forms, with or without\r
14    modification, are permitted provided that the following conditions are met:\r
15    - Redistributions of source code must retain the above copyright\r
16      notice, this list of conditions and the following disclaimer.\r
17    - Redistributions in binary form must reproduce the above copyright\r
18      notice, this list of conditions and the following disclaimer in the\r
19      documentation and/or other materials provided with the distribution.\r
20    - Neither the name of ARM nor the names of its contributors may be used\r
21      to endorse or promote products derived from this software without\r
22      specific prior written permission.\r
23    *\r
24    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
25    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
26    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
27    ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE\r
28    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
29    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
30    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
31    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
32    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
33    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
34    POSSIBILITY OF SUCH DAMAGE.\r
35    ---------------------------------------------------------------------------*/\r
36 \r
37 \r
38 #ifndef __CORE_CMFUNC_H\r
39 #define __CORE_CMFUNC_H\r
40 \r
41 \r
42 /* ###########################  Core Function Access  ########################### */\r
43 /** \ingroup  CMSIS_Core_FunctionInterface\r
44     \defgroup CMSIS_Core_RegAccFunctions CMSIS Core Register Access Functions\r
45   @{\r
46  */\r
47 \r
48 #if   defined ( __CC_ARM ) /*------------------RealView Compiler -----------------*/\r
49 /* ARM armcc specific functions */\r
50 \r
51 #if (__ARMCC_VERSION < 400677)\r
52   #error "Please use ARM Compiler Toolchain V4.0.677 or later!"\r
53 #endif\r
54 \r
55 /* intrinsic void __enable_irq();     */\r
56 /* intrinsic void __disable_irq();    */\r
57 \r
58 /** \brief  Get Control Register\r
59 \r
60     This function returns the content of the Control Register.\r
61 \r
62     \return               Control Register value\r
63  */\r
64 __STATIC_INLINE uint32_t __get_CONTROL(void)\r
65 {\r
66   register uint32_t __regControl         __ASM("control");\r
67   return(__regControl);\r
68 }\r
69 \r
70 \r
71 /** \brief  Set Control Register\r
72 \r
73     This function writes the given value to the Control Register.\r
74 \r
75     \param [in]    control  Control Register value to set\r
76  */\r
77 __STATIC_INLINE void __set_CONTROL(uint32_t control)\r
78 {\r
79   register uint32_t __regControl         __ASM("control");\r
80   __regControl = control;\r
81 }\r
82 \r
83 \r
84 /** \brief  Get IPSR Register\r
85 \r
86     This function returns the content of the IPSR Register.\r
87 \r
88     \return               IPSR Register value\r
89  */\r
90 __STATIC_INLINE uint32_t __get_IPSR(void)\r
91 {\r
92   register uint32_t __regIPSR          __ASM("ipsr");\r
93   return(__regIPSR);\r
94 }\r
95 \r
96 \r
97 /** \brief  Get APSR Register\r
98 \r
99     This function returns the content of the APSR Register.\r
100 \r
101     \return               APSR Register value\r
102  */\r
103 __STATIC_INLINE uint32_t __get_APSR(void)\r
104 {\r
105   register uint32_t __regAPSR          __ASM("apsr");\r
106   return(__regAPSR);\r
107 }\r
108 \r
109 \r
110 /** \brief  Get xPSR Register\r
111 \r
112     This function returns the content of the xPSR Register.\r
113 \r
114     \return               xPSR Register value\r
115  */\r
116 __STATIC_INLINE uint32_t __get_xPSR(void)\r
117 {\r
118   register uint32_t __regXPSR          __ASM("xpsr");\r
119   return(__regXPSR);\r
120 }\r
121 \r
122 \r
123 /** \brief  Get Process Stack Pointer\r
124 \r
125     This function returns the current value of the Process Stack Pointer (PSP).\r
126 \r
127     \return               PSP Register value\r
128  */\r
129 __STATIC_INLINE uint32_t __get_PSP(void)\r
130 {\r
131   register uint32_t __regProcessStackPointer  __ASM("psp");\r
132   return(__regProcessStackPointer);\r
133 }\r
134 \r
135 \r
136 /** \brief  Set Process Stack Pointer\r
137 \r
138     This function assigns the given value to the Process Stack Pointer (PSP).\r
139 \r
140     \param [in]    topOfProcStack  Process Stack Pointer value to set\r
141  */\r
142 __STATIC_INLINE void __set_PSP(uint32_t topOfProcStack)\r
143 {\r
144   register uint32_t __regProcessStackPointer  __ASM("psp");\r
145   __regProcessStackPointer = topOfProcStack;\r
146 }\r
147 \r
148 \r
149 /** \brief  Get Main Stack Pointer\r
150 \r
151     This function returns the current value of the Main Stack Pointer (MSP).\r
152 \r
153     \return               MSP Register value\r
154  */\r
155 __STATIC_INLINE uint32_t __get_MSP(void)\r
156 {\r
157   register uint32_t __regMainStackPointer     __ASM("msp");\r
158   return(__regMainStackPointer);\r
159 }\r
160 \r
161 \r
162 /** \brief  Set Main Stack Pointer\r
163 \r
164     This function assigns the given value to the Main Stack Pointer (MSP).\r
165 \r
166     \param [in]    topOfMainStack  Main Stack Pointer value to set\r
167  */\r
168 __STATIC_INLINE void __set_MSP(uint32_t topOfMainStack)\r
169 {\r
170   register uint32_t __regMainStackPointer     __ASM("msp");\r
171   __regMainStackPointer = topOfMainStack;\r
172 }\r
173 \r
174 \r
175 /** \brief  Get Priority Mask\r
176 \r
177     This function returns the current state of the priority mask bit from the Priority Mask Register.\r
178 \r
179     \return               Priority Mask value\r
180  */\r
181 __STATIC_INLINE uint32_t __get_PRIMASK(void)\r
182 {\r
183   register uint32_t __regPriMask         __ASM("primask");\r
184   return(__regPriMask);\r
185 }\r
186 \r
187 \r
188 /** \brief  Set Priority Mask\r
189 \r
190     This function assigns the given value to the Priority Mask Register.\r
191 \r
192     \param [in]    priMask  Priority Mask\r
193  */\r
194 __STATIC_INLINE void __set_PRIMASK(uint32_t priMask)\r
195 {\r
196   register uint32_t __regPriMask         __ASM("primask");\r
197   __regPriMask = (priMask);\r
198 }\r
199 \r
200 \r
201 #if       (__CORTEX_M >= 0x03) || (__CORTEX_SC >= 300)\r
202 \r
203 /** \brief  Enable FIQ\r
204 \r
205     This function enables FIQ interrupts by clearing the F-bit in the CPSR.\r
206     Can only be executed in Privileged modes.\r
207  */\r
208 #define __enable_fault_irq                __enable_fiq\r
209 \r
210 \r
211 /** \brief  Disable FIQ\r
212 \r
213     This function disables FIQ interrupts by setting the F-bit in the CPSR.\r
214     Can only be executed in Privileged modes.\r
215  */\r
216 #define __disable_fault_irq               __disable_fiq\r
217 \r
218 \r
219 /** \brief  Get Base Priority\r
220 \r
221     This function returns the current value of the Base Priority register.\r
222 \r
223     \return               Base Priority register value\r
224  */\r
225 __STATIC_INLINE uint32_t  __get_BASEPRI(void)\r
226 {\r
227   register uint32_t __regBasePri         __ASM("basepri");\r
228   return(__regBasePri);\r
229 }\r
230 \r
231 \r
232 /** \brief  Set Base Priority\r
233 \r
234     This function assigns the given value to the Base Priority register.\r
235 \r
236     \param [in]    basePri  Base Priority value to set\r
237  */\r
238 __STATIC_INLINE void __set_BASEPRI(uint32_t basePri)\r
239 {\r
240   register uint32_t __regBasePri         __ASM("basepri");\r
241   __regBasePri = (basePri & 0xff);\r
242 }\r
243 \r
244 \r
245 /** \brief  Get Fault Mask\r
246 \r
247     This function returns the current value of the Fault Mask register.\r
248 \r
249     \return               Fault Mask register value\r
250  */\r
251 __STATIC_INLINE uint32_t __get_FAULTMASK(void)\r
252 {\r
253   register uint32_t __regFaultMask       __ASM("faultmask");\r
254   return(__regFaultMask);\r
255 }\r
256 \r
257 \r
258 /** \brief  Set Fault Mask\r
259 \r
260     This function assigns the given value to the Fault Mask register.\r
261 \r
262     \param [in]    faultMask  Fault Mask value to set\r
263  */\r
264 __STATIC_INLINE void __set_FAULTMASK(uint32_t faultMask)\r
265 {\r
266   register uint32_t __regFaultMask       __ASM("faultmask");\r
267   __regFaultMask = (faultMask & (uint32_t)1);\r
268 }\r
269 \r
270 #endif /* (__CORTEX_M >= 0x03) || (__CORTEX_SC >= 300) */\r
271 \r
272 \r
273 #if       (__CORTEX_M == 0x04) || (__CORTEX_M == 0x07)\r
274 \r
275 /** \brief  Get FPSCR\r
276 \r
277     This function returns the current value of the Floating Point Status/Control register.\r
278 \r
279     \return               Floating Point Status/Control register value\r
280  */\r
281 __STATIC_INLINE uint32_t __get_FPSCR(void)\r
282 {\r
283 #if (__FPU_PRESENT == 1) && (__FPU_USED == 1)\r
284   register uint32_t __regfpscr         __ASM("fpscr");\r
285   return(__regfpscr);\r
286 #else\r
287    return(0);\r
288 #endif\r
289 }\r
290 \r
291 \r
292 /** \brief  Set FPSCR\r
293 \r
294     This function assigns the given value to the Floating Point Status/Control register.\r
295 \r
296     \param [in]    fpscr  Floating Point Status/Control value to set\r
297  */\r
298 __STATIC_INLINE void __set_FPSCR(uint32_t fpscr)\r
299 {\r
300 #if (__FPU_PRESENT == 1) && (__FPU_USED == 1)\r
301   register uint32_t __regfpscr         __ASM("fpscr");\r
302   __regfpscr = (fpscr);\r
303 #else\r
304   (void)fpscr;\r
305 #endif\r
306 }\r
307 \r
308 #endif /* (__CORTEX_M == 0x04) || (__CORTEX_M == 0x07) */\r
309 \r
310 \r
311 #elif defined ( __GNUC__ ) /*------------------ GNU Compiler ---------------------*/\r
312 /* GNU gcc specific functions */\r
313 \r
314 /** \brief  Enable IRQ Interrupts\r
315 \r
316   This function enables IRQ interrupts by clearing the I-bit in the CPSR.\r
317   Can only be executed in Privileged modes.\r
318  */\r
319 __attribute__( ( always_inline ) ) __STATIC_INLINE void __enable_irq(void)\r
320 {\r
321   __ASM volatile ("cpsie i" : : : "memory");\r
322 }\r
323 \r
324 \r
325 /** \brief  Disable IRQ Interrupts\r
326 \r
327   This function disables IRQ interrupts by setting the I-bit in the CPSR.\r
328   Can only be executed in Privileged modes.\r
329  */\r
330 __attribute__( ( always_inline ) ) __STATIC_INLINE void __disable_irq(void)\r
331 {\r
332   __ASM volatile ("cpsid i" : : : "memory");\r
333 }\r
334 \r
335 \r
336 /** \brief  Get Control Register\r
337 \r
338     This function returns the content of the Control Register.\r
339 \r
340     \return               Control Register value\r
341  */\r
342 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_CONTROL(void)\r
343 {\r
344   uint32_t result;\r
345 \r
346   __ASM volatile ("MRS %0, control" : "=r" (result) );\r
347   return(result);\r
348 }\r
349 \r
350 \r
351 /** \brief  Set Control Register\r
352 \r
353     This function writes the given value to the Control Register.\r
354 \r
355     \param [in]    control  Control Register value to set\r
356  */\r
357 __attribute__( ( always_inline ) ) __STATIC_INLINE void __set_CONTROL(uint32_t control)\r
358 {\r
359   __ASM volatile ("MSR control, %0" : : "r" (control) : "memory");\r
360 }\r
361 \r
362 \r
363 /** \brief  Get IPSR Register\r
364 \r
365     This function returns the content of the IPSR Register.\r
366 \r
367     \return               IPSR Register value\r
368  */\r
369 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_IPSR(void)\r
370 {\r
371   uint32_t result;\r
372 \r
373   __ASM volatile ("MRS %0, ipsr" : "=r" (result) );\r
374   return(result);\r
375 }\r
376 \r
377 \r
378 /** \brief  Get APSR Register\r
379 \r
380     This function returns the content of the APSR Register.\r
381 \r
382     \return               APSR Register value\r
383  */\r
384 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_APSR(void)\r
385 {\r
386   uint32_t result;\r
387 \r
388   __ASM volatile ("MRS %0, apsr" : "=r" (result) );\r
389   return(result);\r
390 }\r
391 \r
392 \r
393 /** \brief  Get xPSR Register\r
394 \r
395     This function returns the content of the xPSR Register.\r
396 \r
397     \return               xPSR Register value\r
398  */\r
399 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_xPSR(void)\r
400 {\r
401   uint32_t result;\r
402 \r
403   __ASM volatile ("MRS %0, xpsr" : "=r" (result) );\r
404   return(result);\r
405 }\r
406 \r
407 \r
408 /** \brief  Get Process Stack Pointer\r
409 \r
410     This function returns the current value of the Process Stack Pointer (PSP).\r
411 \r
412     \return               PSP Register value\r
413  */\r
414 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_PSP(void)\r
415 {\r
416   register uint32_t result;\r
417 \r
418   __ASM volatile ("MRS %0, psp\n"  : "=r" (result) );\r
419   return(result);\r
420 }\r
421 \r
422 \r
423 /** \brief  Set Process Stack Pointer\r
424 \r
425     This function assigns the given value to the Process Stack Pointer (PSP).\r
426 \r
427     \param [in]    topOfProcStack  Process Stack Pointer value to set\r
428  */\r
429 __attribute__( ( always_inline ) ) __STATIC_INLINE void __set_PSP(uint32_t topOfProcStack)\r
430 {\r
431   __ASM volatile ("MSR psp, %0\n" : : "r" (topOfProcStack) : "sp");\r
432 }\r
433 \r
434 \r
435 /** \brief  Get Main Stack Pointer\r
436 \r
437     This function returns the current value of the Main Stack Pointer (MSP).\r
438 \r
439     \return               MSP Register value\r
440  */\r
441 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_MSP(void)\r
442 {\r
443   register uint32_t result;\r
444 \r
445   __ASM volatile ("MRS %0, msp\n" : "=r" (result) );\r
446   return(result);\r
447 }\r
448 \r
449 \r
450 /** \brief  Set Main Stack Pointer\r
451 \r
452     This function assigns the given value to the Main Stack Pointer (MSP).\r
453 \r
454     \param [in]    topOfMainStack  Main Stack Pointer value to set\r
455  */\r
456 __attribute__( ( always_inline ) ) __STATIC_INLINE void __set_MSP(uint32_t topOfMainStack)\r
457 {\r
458   __ASM volatile ("MSR msp, %0\n" : : "r" (topOfMainStack) : "sp");\r
459 }\r
460 \r
461 \r
462 /** \brief  Get Priority Mask\r
463 \r
464     This function returns the current state of the priority mask bit from the Priority Mask Register.\r
465 \r
466     \return               Priority Mask value\r
467  */\r
468 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_PRIMASK(void)\r
469 {\r
470   uint32_t result;\r
471 \r
472   __ASM volatile ("MRS %0, primask" : "=r" (result) );\r
473   return(result);\r
474 }\r
475 \r
476 \r
477 /** \brief  Set Priority Mask\r
478 \r
479     This function assigns the given value to the Priority Mask Register.\r
480 \r
481     \param [in]    priMask  Priority Mask\r
482  */\r
483 __attribute__( ( always_inline ) ) __STATIC_INLINE void __set_PRIMASK(uint32_t priMask)\r
484 {\r
485   __ASM volatile ("MSR primask, %0" : : "r" (priMask) : "memory");\r
486 }\r
487 \r
488 \r
489 #if       (__CORTEX_M >= 0x03)\r
490 \r
491 /** \brief  Enable FIQ\r
492 \r
493     This function enables FIQ interrupts by clearing the F-bit in the CPSR.\r
494     Can only be executed in Privileged modes.\r
495  */\r
496 __attribute__( ( always_inline ) ) __STATIC_INLINE void __enable_fault_irq(void)\r
497 {\r
498   __ASM volatile ("cpsie f" : : : "memory");\r
499 }\r
500 \r
501 \r
502 /** \brief  Disable FIQ\r
503 \r
504     This function disables FIQ interrupts by setting the F-bit in the CPSR.\r
505     Can only be executed in Privileged modes.\r
506  */\r
507 __attribute__( ( always_inline ) ) __STATIC_INLINE void __disable_fault_irq(void)\r
508 {\r
509   __ASM volatile ("cpsid f" : : : "memory");\r
510 }\r
511 \r
512 \r
513 /** \brief  Get Base Priority\r
514 \r
515     This function returns the current value of the Base Priority register.\r
516 \r
517     \return               Base Priority register value\r
518  */\r
519 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_BASEPRI(void)\r
520 {\r
521   uint32_t result;\r
522 \r
523   __ASM volatile ("MRS %0, basepri_max" : "=r" (result) );\r
524   return(result);\r
525 }\r
526 \r
527 \r
528 /** \brief  Set Base Priority\r
529 \r
530     This function assigns the given value to the Base Priority register.\r
531 \r
532     \param [in]    basePri  Base Priority value to set\r
533  */\r
534 __attribute__( ( always_inline ) ) __STATIC_INLINE void __set_BASEPRI(uint32_t value)\r
535 {\r
536   __ASM volatile ("MSR basepri, %0" : : "r" (value) : "memory");\r
537 }\r
538 \r
539 \r
540 /** \brief  Get Fault Mask\r
541 \r
542     This function returns the current value of the Fault Mask register.\r
543 \r
544     \return               Fault Mask register value\r
545  */\r
546 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_FAULTMASK(void)\r
547 {\r
548   uint32_t result;\r
549 \r
550   __ASM volatile ("MRS %0, faultmask" : "=r" (result) );\r
551   return(result);\r
552 }\r
553 \r
554 \r
555 /** \brief  Set Fault Mask\r
556 \r
557     This function assigns the given value to the Fault Mask register.\r
558 \r
559     \param [in]    faultMask  Fault Mask value to set\r
560  */\r
561 __attribute__( ( always_inline ) ) __STATIC_INLINE void __set_FAULTMASK(uint32_t faultMask)\r
562 {\r
563   __ASM volatile ("MSR faultmask, %0" : : "r" (faultMask) : "memory");\r
564 }\r
565 \r
566 #endif /* (__CORTEX_M >= 0x03) */\r
567 \r
568 \r
569 #if       (__CORTEX_M == 0x04) || (__CORTEX_M == 0x07)\r
570 \r
571 /** \brief  Get FPSCR\r
572 \r
573     This function returns the current value of the Floating Point Status/Control register.\r
574 \r
575     \return               Floating Point Status/Control register value\r
576  */\r
577 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __get_FPSCR(void)\r
578 {\r
579 #if (__FPU_PRESENT == 1) && (__FPU_USED == 1)\r
580   uint32_t result;\r
581 \r
582   /* Empty asm statement works as a scheduling barrier */\r
583   __ASM volatile ("");\r
584   __ASM volatile ("VMRS %0, fpscr" : "=r" (result) );\r
585   __ASM volatile ("");\r
586   return(result);\r
587 #else\r
588    return(0);\r
589 #endif\r
590 }\r
591 \r
592 \r
593 /** \brief  Set FPSCR\r
594 \r
595     This function assigns the given value to the Floating Point Status/Control register.\r
596 \r
597     \param [in]    fpscr  Floating Point Status/Control value to set\r
598  */\r
599 __attribute__( ( always_inline ) ) __STATIC_INLINE void __set_FPSCR(uint32_t fpscr)\r
600 {\r
601 #if (__FPU_PRESENT == 1) && (__FPU_USED == 1)\r
602   /* Empty asm statement works as a scheduling barrier */\r
603   __ASM volatile ("");\r
604   __ASM volatile ("VMSR fpscr, %0" : : "r" (fpscr) : "vfpcc");\r
605   __ASM volatile ("");\r
606 #else\r
607   (void)fpscr;\r
608 #endif\r
609 }\r
610 \r
611 #endif /* (__CORTEX_M == 0x04) || (__CORTEX_M == 0x07) */\r
612 \r
613 \r
614 #elif defined ( __ICCARM__ ) /*------------------ ICC Compiler -------------------*/\r
615 /* IAR iccarm specific functions */\r
616 #include <cmsis_iar.h>\r
617 \r
618 \r
619 #elif defined ( __TMS470__ ) /*---------------- TI CCS Compiler ------------------*/\r
620 /* TI CCS specific functions */\r
621 #include <cmsis_ccs.h>\r
622 \r
623 \r
624 #elif defined ( __TASKING__ ) /*------------------ TASKING Compiler --------------*/\r
625 /* TASKING carm specific functions */\r
626 /*\r
627  * The CMSIS functions have been implemented as intrinsics in the compiler.\r
628  * Please use "carm -?i" to get an up to date list of all intrinsics,\r
629  * Including the CMSIS ones.\r
630  */\r
631 \r
632 \r
633 #elif defined ( __CSMC__ ) /*------------------ COSMIC Compiler -------------------*/\r
634 /* Cosmic specific functions */\r
635 #include <cmsis_csm.h>\r
636 \r
637 #endif\r
638 \r
639 /*@} end of CMSIS_Core_RegAccFunctions */\r
640 \r
641 #endif /* __CORE_CMFUNC_H */\r