]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/ARM7_LPC23xx/portmacro.h
Update version numbers in preparation for new release.
[freertos] / FreeRTOS / Source / portable / GCC / ARM7_LPC23xx / portmacro.h
1 /*\r
2     FreeRTOS V8.2.2 - Copyright (C) 2015 Real Time Engineers Ltd.\r
3     All rights reserved\r
4 \r
5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     This file is part of the FreeRTOS distribution.\r
8 \r
9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
10     the terms of the GNU General Public License (version 2) as published by the\r
11     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
12 \r
13     ***************************************************************************\r
14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
16     >>!   obliged to provide the source code for proprietary components     !<<\r
17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
18     ***************************************************************************\r
19 \r
20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
23     link: http://www.freertos.org/a00114.html\r
24 \r
25     ***************************************************************************\r
26      *                                                                       *\r
27      *    FreeRTOS provides completely free yet professionally developed,    *\r
28      *    robust, strictly quality controlled, supported, and cross          *\r
29      *    platform software that is more than just the market leader, it     *\r
30      *    is the industry's de facto standard.                               *\r
31      *                                                                       *\r
32      *    Help yourself get started quickly while simultaneously helping     *\r
33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
34      *    tutorial book, reference manual, or both:                          *\r
35      *    http://www.FreeRTOS.org/Documentation                              *\r
36      *                                                                       *\r
37     ***************************************************************************\r
38 \r
39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
41     defined configASSERT()?\r
42 \r
43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
44     embedded software for free we request you assist our global community by\r
45     participating in the support forum.\r
46 \r
47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
48     be as productive as possible as early as possible.  Now you can receive\r
49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
50     Ltd, and the world's leading authority on the world's leading RTOS.\r
51 \r
52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
55 \r
56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
58 \r
59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
61     licenses offer ticketed support, indemnification and commercial middleware.\r
62 \r
63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
64     engineered and independently SIL3 certified version for use in safety and\r
65     mission critical applications that require provable dependability.\r
66 \r
67     1 tab == 4 spaces!\r
68 */\r
69 \r
70 /*\r
71         Changes from V3.2.3\r
72 \r
73         + Modified portENTER_SWITCHING_ISR() to allow use with GCC V4.0.1.\r
74 \r
75         Changes from V3.2.4\r
76 \r
77         + Removed the use of the %0 parameter within the assembler macros and\r
78           replaced them with hard coded registers.  This will ensure the\r
79           assembler does not select the link register as the temp register as\r
80           was occasionally happening previously.\r
81 \r
82         + The assembler statements are now included in a single asm block rather\r
83           than each line having its own asm block.\r
84 \r
85         Changes from V4.5.0\r
86 \r
87         + Removed the portENTER_SWITCHING_ISR() and portEXIT_SWITCHING_ISR() macros\r
88           and replaced them with portYIELD_FROM_ISR() macro.  Application code\r
89           should now make use of the portSAVE_CONTEXT() and portRESTORE_CONTEXT()\r
90           macros as per the V4.5.1 demo code.\r
91 */\r
92 \r
93 #ifndef PORTMACRO_H\r
94 #define PORTMACRO_H\r
95 \r
96 #ifdef __cplusplus\r
97 extern "C" {\r
98 #endif\r
99 \r
100 /*-----------------------------------------------------------\r
101  * Port specific definitions.\r
102  *\r
103  * The settings in this file configure FreeRTOS correctly for the\r
104  * given hardware and compiler.\r
105  *\r
106  * These settings should not be altered.\r
107  *-----------------------------------------------------------\r
108  */\r
109 \r
110 /* Type definitions. */\r
111 #define portCHAR                char\r
112 #define portFLOAT               float\r
113 #define portDOUBLE              double\r
114 #define portLONG                long\r
115 #define portSHORT               short\r
116 #define portSTACK_TYPE  uint32_t\r
117 #define portBASE_TYPE   portLONG\r
118 \r
119 typedef portSTACK_TYPE StackType_t;\r
120 typedef long BaseType_t;\r
121 typedef unsigned long UBaseType_t;\r
122 \r
123 #if( configUSE_16_BIT_TICKS == 1 )\r
124         typedef uint16_t TickType_t;\r
125         #define portMAX_DELAY ( TickType_t ) 0xffff\r
126 #else\r
127         typedef uint32_t TickType_t;\r
128         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
129 #endif\r
130 /*-----------------------------------------------------------*/\r
131 \r
132 /* Architecture specifics. */\r
133 #define portSTACK_GROWTH                        ( -1 )\r
134 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
135 #define portBYTE_ALIGNMENT                      8\r
136 #define portNOP()                                       __asm volatile ( "NOP" );\r
137 /*-----------------------------------------------------------*/\r
138 \r
139 \r
140 /* Scheduler utilities. */\r
141 \r
142 /*\r
143  * portRESTORE_CONTEXT, portRESTORE_CONTEXT, portENTER_SWITCHING_ISR\r
144  * and portEXIT_SWITCHING_ISR can only be called from ARM mode, but\r
145  * are included here for efficiency.  An attempt to call one from\r
146  * THUMB mode code will result in a compile time error.\r
147  */\r
148 \r
149 #define portRESTORE_CONTEXT()                                                                                   \\r
150 {                                                                                                                                               \\r
151 extern volatile void * volatile pxCurrentTCB;                                                   \\r
152 extern volatile uint32_t ulCriticalNesting;                                     \\r
153                                                                                                                                                 \\r
154         /* Set the LR to the task stack. */                                                                     \\r
155         __asm volatile (                                                                                                        \\r
156         "LDR            R0, =pxCurrentTCB                                                               \n\t"   \\r
157         "LDR            R0, [R0]                                                                                \n\t"   \\r
158         "LDR            LR, [R0]                                                                                \n\t"   \\r
159                                                                                                                                                 \\r
160         /* The critical nesting depth is the first item on the stack. */        \\r
161         /* Load it into the ulCriticalNesting variable. */                                      \\r
162         "LDR            R0, =ulCriticalNesting                                                  \n\t"   \\r
163         "LDMFD  LR!, {R1}                                                                                       \n\t"   \\r
164         "STR            R1, [R0]                                                                                \n\t"   \\r
165                                                                                                                                                 \\r
166         /* Get the SPSR from the stack. */                                                                      \\r
167         "LDMFD  LR!, {R0}                                                                                       \n\t"   \\r
168         "MSR            SPSR, R0                                                                                \n\t"   \\r
169                                                                                                                                                 \\r
170         /* Restore all system mode registers for the task. */                           \\r
171         "LDMFD  LR, {R0-R14}^                                                                           \n\t"   \\r
172         "NOP                                                                                                            \n\t"   \\r
173                                                                                                                                                 \\r
174         /* Restore the return address. */                                                                       \\r
175         "LDR            LR, [LR, #+60]                                                                  \n\t"   \\r
176                                                                                                                                                 \\r
177         /* And return - correcting the offset in the LR to obtain the */        \\r
178         /* correct address. */                                                                                          \\r
179         "SUBS   PC, LR, #4                                                                                      \n\t"   \\r
180         );                                                                                                                                      \\r
181         ( void ) ulCriticalNesting;                                                                                     \\r
182         ( void ) pxCurrentTCB;                                                                                          \\r
183 }\r
184 /*-----------------------------------------------------------*/\r
185 \r
186 #define portSAVE_CONTEXT()                                                                                              \\r
187 {                                                                                                                                               \\r
188 extern volatile void * volatile pxCurrentTCB;                                                   \\r
189 extern volatile uint32_t ulCriticalNesting;                                     \\r
190                                                                                                                                                 \\r
191         /* Push R0 as we are going to use the register. */                                      \\r
192         __asm volatile (                                                                                                        \\r
193         "STMDB  SP!, {R0}                                                                                       \n\t"   \\r
194                                                                                                                                                 \\r
195         /* Set R0 to point to the task stack pointer. */                                        \\r
196         "STMDB  SP,{SP}^                                                                                        \n\t"   \\r
197         "NOP                                                                                                            \n\t"   \\r
198         "SUB    SP, SP, #4                                                                                      \n\t"   \\r
199         "LDMIA  SP!,{R0}                                                                                        \n\t"   \\r
200                                                                                                                                                 \\r
201         /* Push the return address onto the stack. */                                           \\r
202         "STMDB  R0!, {LR}                                                                                       \n\t"   \\r
203                                                                                                                                                 \\r
204         /* Now we have saved LR we can use it instead of R0. */                         \\r
205         "MOV    LR, R0                                                                                          \n\t"   \\r
206                                                                                                                                                 \\r
207         /* Pop R0 so we can save it onto the system mode stack. */                      \\r
208         "LDMIA  SP!, {R0}                                                                                       \n\t"   \\r
209                                                                                                                                                 \\r
210         /* Push all the system mode registers onto the task stack. */           \\r
211         "STMDB  LR,{R0-LR}^                                                                                     \n\t"   \\r
212         "NOP                                                                                                            \n\t"   \\r
213         "SUB    LR, LR, #60                                                                                     \n\t"   \\r
214                                                                                                                                                 \\r
215         /* Push the SPSR onto the task stack. */                                                        \\r
216         "MRS    R0, SPSR                                                                                        \n\t"   \\r
217         "STMDB  LR!, {R0}                                                                                       \n\t"   \\r
218                                                                                                                                                 \\r
219         "LDR    R0, =ulCriticalNesting                                                          \n\t"   \\r
220         "LDR    R0, [R0]                                                                                        \n\t"   \\r
221         "STMDB  LR!, {R0}                                                                                       \n\t"   \\r
222                                                                                                                                                 \\r
223         /* Store the new top of stack for the task. */                                          \\r
224         "LDR    R0, =pxCurrentTCB                                                                       \n\t"   \\r
225         "LDR    R0, [R0]                                                                                        \n\t"   \\r
226         "STR    LR, [R0]                                                                                        \n\t"   \\r
227         );                                                                                                                                      \\r
228         ( void ) ulCriticalNesting;                                                                                     \\r
229         ( void ) pxCurrentTCB;                                                                                          \\r
230 }\r
231 \r
232 \r
233 #define portYIELD_FROM_ISR()            vTaskSwitchContext()\r
234 #define portYIELD()                                     __asm volatile ( "SWI 0" )\r
235 /*-----------------------------------------------------------*/\r
236 \r
237 \r
238 /* Critical section management. */\r
239 \r
240 /*\r
241  * The interrupt management utilities can only be called from ARM mode.  When\r
242  * THUMB_INTERWORK is defined the utilities are defined as functions in\r
243  * portISR.c to ensure a switch to ARM mode.  When THUMB_INTERWORK is not\r
244  * defined then the utilities are defined as macros here - as per other ports.\r
245  */\r
246 \r
247 #ifdef THUMB_INTERWORK\r
248 \r
249         extern void vPortDisableInterruptsFromThumb( void ) __attribute__ ((naked));\r
250         extern void vPortEnableInterruptsFromThumb( void ) __attribute__ ((naked));\r
251 \r
252         #define portDISABLE_INTERRUPTS()        vPortDisableInterruptsFromThumb()\r
253         #define portENABLE_INTERRUPTS()         vPortEnableInterruptsFromThumb()\r
254 \r
255 #else\r
256 \r
257         #define portDISABLE_INTERRUPTS()                                                                                        \\r
258                 __asm volatile (                                                                                                                        \\r
259                         "STMDB  SP!, {R0}               \n\t"   /* Push R0.                                             */      \\r
260                         "MRS    R0, CPSR                \n\t"   /* Get CPSR.                                    */      \\r
261                         "ORR    R0, R0, #0xC0   \n\t"   /* Disable IRQ, FIQ.                    */      \\r
262                         "MSR    CPSR, R0                \n\t"   /* Write back modified value.   */      \\r
263                         "LDMIA  SP!, {R0}                       " )     /* Pop R0.                                              */\r
264 \r
265         #define portENABLE_INTERRUPTS()                                                                                         \\r
266                 __asm volatile (                                                                                                                        \\r
267                         "STMDB  SP!, {R0}               \n\t"   /* Push R0.                                             */      \\r
268                         "MRS    R0, CPSR                \n\t"   /* Get CPSR.                                    */      \\r
269                         "BIC    R0, R0, #0xC0   \n\t"   /* Enable IRQ, FIQ.                             */      \\r
270                         "MSR    CPSR, R0                \n\t"   /* Write back modified value.   */      \\r
271                         "LDMIA  SP!, {R0}                       " )     /* Pop R0.                                              */\r
272 \r
273 #endif /* THUMB_INTERWORK */\r
274 \r
275 extern void vPortEnterCritical( void );\r
276 extern void vPortExitCritical( void );\r
277 \r
278 #define portENTER_CRITICAL()            vPortEnterCritical();\r
279 #define portEXIT_CRITICAL()                     vPortExitCritical();\r
280 /*-----------------------------------------------------------*/\r
281 \r
282 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
283 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
284 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
285 \r
286 #ifdef __cplusplus\r
287 }\r
288 #endif\r
289 \r
290 #endif /* PORTMACRO_H */\r
291 \r