]> begriffs open source - freertos/blob - FreeRTOS/Source/portable/Tasking/ARM_CM4F/portmacro.h
Update to MIT licensed FreeRTOS V10.0.0 - see https://www.freertos.org/History.txt
[freertos] / FreeRTOS / Source / portable / Tasking / ARM_CM4F / portmacro.h
1 /*\r
2  * FreeRTOS Kernel V10.0.0\r
3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
6  * this software and associated documentation files (the "Software"), to deal in\r
7  * the Software without restriction, including without limitation the rights to\r
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
10  * subject to the following conditions:\r
11  *\r
12  * The above copyright notice and this permission notice shall be included in all\r
13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
15  *\r
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
22  *\r
23  * http://www.FreeRTOS.org\r
24  * http://aws.amazon.com/freertos\r
25  *\r
26  * 1 tab == 4 spaces!\r
27  */\r
28 \r
29 \r
30 #ifndef PORTMACRO_H\r
31 #define PORTMACRO_H\r
32 \r
33 #ifdef __cplusplus\r
34 extern "C" {\r
35 #endif\r
36 \r
37 /*-----------------------------------------------------------\r
38  * Port specific definitions.\r
39  *\r
40  * The settings in this file configure FreeRTOS correctly for the\r
41  * given hardware and compiler.\r
42  *\r
43  * These settings should not be altered.\r
44  *-----------------------------------------------------------\r
45  */\r
46 \r
47 /* Type definitions. */\r
48 #define portCHAR                char\r
49 #define portFLOAT               float\r
50 #define portDOUBLE              double\r
51 #define portLONG                long\r
52 #define portSHORT               short\r
53 #define portSTACK_TYPE  uint32_t\r
54 #define portBASE_TYPE   long\r
55 \r
56 typedef portSTACK_TYPE StackType_t;\r
57 typedef long BaseType_t;\r
58 typedef unsigned long UBaseType_t;\r
59 \r
60 \r
61 #if( configUSE_16_BIT_TICKS == 1 )\r
62         typedef uint16_t TickType_t;\r
63         #define portMAX_DELAY ( TickType_t ) 0xffff\r
64 #else\r
65         typedef uint32_t TickType_t;\r
66         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
67 \r
68         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
69         not need to be guarded with a critical section. */\r
70         #define portTICK_TYPE_IS_ATOMIC 1\r
71 #endif\r
72 /*-----------------------------------------------------------*/\r
73 \r
74 /* Architecture specifics. */\r
75 #define portSTACK_GROWTH                        ( -1 )\r
76 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
77 #define portBYTE_ALIGNMENT                      8\r
78 /*-----------------------------------------------------------*/\r
79 \r
80 \r
81 /* Scheduler utilities. */\r
82 extern void vPortYield( void );\r
83 #define portNVIC_INT_CTRL                       ( ( volatile uint32_t * ) 0xe000ed04 )\r
84 #define portNVIC_PENDSVSET                      0x10000000\r
85 #define portYIELD()                                     vPortYield()\r
86 \r
87 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET\r
88 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
89 /*-----------------------------------------------------------*/\r
90 \r
91 \r
92 /* Critical section management. */\r
93 \r
94 /*\r
95  * Set basepri to portMAX_SYSCALL_INTERRUPT_PRIORITY without effecting other\r
96  * registers.  r0 is clobbered.\r
97  */\r
98 #define portSET_INTERRUPT_MASK() __set_BASEPRI( configMAX_SYSCALL_INTERRUPT_PRIORITY )\r
99 \r
100 /*\r
101  * Set basepri back to 0 without effective other registers.\r
102  * r0 is clobbered.  FAQ:  Setting BASEPRI to 0 is not a bug.  Please see\r
103  * http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html before disagreeing.\r
104  */\r
105 #define portCLEAR_INTERRUPT_MASK() __set_BASEPRI( 0 )\r
106 \r
107 extern uint32_t ulPortSetInterruptMask( void );\r
108 extern void vPortClearInterruptMask( uint32_t ulNewMask );\r
109 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
110 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask( x )\r
111 \r
112 \r
113 extern void vPortEnterCritical( void );\r
114 extern void vPortExitCritical( void );\r
115 \r
116 #define portDISABLE_INTERRUPTS()        portSET_INTERRUPT_MASK()\r
117 #define portENABLE_INTERRUPTS()         portCLEAR_INTERRUPT_MASK()\r
118 #define portENTER_CRITICAL()            vPortEnterCritical()\r
119 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
120 \r
121 /*-----------------------------------------------------------*/\r
122 \r
123 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
124 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
125 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
126 \r
127 #define portNOP()\r
128 \r
129 #ifdef __cplusplus\r
130 }\r
131 #endif\r
132 \r
133 #endif /* PORTMACRO_H */\r
134 \r