]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/RVDS/ARM7_LPC21xx/port.c
Update version number in readiness for V10.3.0 release. Sync SVN with reviewed releas...
[freertos] / FreeRTOS / Source / portable / RVDS / ARM7_LPC21xx / port.c
1 /*\r
2  * FreeRTOS Kernel V10.3.0\r
3  * Copyright (C) 2020 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.\r
14  *\r
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
21  *\r
22  * http://www.FreeRTOS.org\r
23  * http://aws.amazon.com/freertos\r
24  *\r
25  * 1 tab == 4 spaces!\r
26  */\r
27 \r
28 \r
29 /* Standard includes. */\r
30 #include <stdlib.h>\r
31 \r
32 /* Scheduler includes. */\r
33 #include "FreeRTOS.h"\r
34 #include "task.h"\r
35 \r
36 /* Constants required to setup the initial task context. */\r
37 #define portINITIAL_SPSR                                ( ( StackType_t ) 0x1f ) /* System mode, ARM mode, interrupts enabled. */\r
38 #define portTHUMB_MODE_BIT                              ( ( StackType_t ) 0x20 )\r
39 #define portINSTRUCTION_SIZE                    ( ( StackType_t ) 4 )\r
40 #define portNO_CRITICAL_SECTION_NESTING ( ( StackType_t ) 0 )\r
41 \r
42 /* Constants required to setup the tick ISR. */\r
43 #define portENABLE_TIMER                        ( ( uint8_t ) 0x01 )\r
44 #define portPRESCALE_VALUE                      0x00\r
45 #define portINTERRUPT_ON_MATCH          ( ( uint32_t ) 0x01 )\r
46 #define portRESET_COUNT_ON_MATCH        ( ( uint32_t ) 0x02 )\r
47 \r
48 /* Constants required to setup the VIC for the tick ISR. */\r
49 #define portTIMER_VIC_CHANNEL           ( ( uint32_t ) 0x0004 )\r
50 #define portTIMER_VIC_CHANNEL_BIT       ( ( uint32_t ) 0x0010 )\r
51 #define portTIMER_VIC_ENABLE            ( ( uint32_t ) 0x0020 )\r
52 \r
53 /* Constants required to handle interrupts. */\r
54 #define portTIMER_MATCH_ISR_BIT         ( ( uint8_t ) 0x01 )\r
55 #define portCLEAR_VIC_INTERRUPT         ( ( uint32_t ) 0 )\r
56 \r
57 /*-----------------------------------------------------------*/\r
58 \r
59 /* The code generated by the Keil compiler does not maintain separate\r
60 stack and frame pointers. The portENTER_CRITICAL macro cannot therefore\r
61 use the stack as per other ports.  Instead a variable is used to keep\r
62 track of the critical section nesting.  This variable has to be stored\r
63 as part of the task context and must be initialised to a non zero value. */\r
64 \r
65 #define portNO_CRITICAL_NESTING         ( ( uint32_t ) 0 )\r
66 volatile uint32_t ulCriticalNesting = 9999UL;\r
67 \r
68 /*-----------------------------------------------------------*/\r
69 \r
70 /* Setup the timer to generate the tick interrupts. */\r
71 static void prvSetupTimerInterrupt( void );\r
72 \r
73 /* \r
74  * The scheduler can only be started from ARM mode, so \r
75  * vPortStartFirstSTask() is defined in portISR.c. \r
76  */\r
77 extern __asm void vPortStartFirstTask( void );\r
78 \r
79 /*-----------------------------------------------------------*/\r
80 \r
81 /* \r
82  * See header file for description. \r
83  */\r
84 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
85 {\r
86 StackType_t *pxOriginalTOS;\r
87 \r
88         /* Setup the initial stack of the task.  The stack is set exactly as \r
89         expected by the portRESTORE_CONTEXT() macro.\r
90 \r
91         Remember where the top of the (simulated) stack is before we place \r
92         anything on it. */\r
93         pxOriginalTOS = pxTopOfStack;\r
94         \r
95         /* To ensure asserts in tasks.c don't fail, although in this case the assert\r
96         is not really required. */\r
97         pxTopOfStack--;\r
98 \r
99         /* First on the stack is the return address - which in this case is the\r
100         start of the task.  The offset is added to make the return address appear\r
101         as it would within an IRQ ISR. */\r
102         *pxTopOfStack = ( StackType_t ) pxCode + portINSTRUCTION_SIZE;          \r
103         pxTopOfStack--;\r
104 \r
105         *pxTopOfStack = ( StackType_t ) 0xaaaaaaaa;     /* R14 */\r
106         pxTopOfStack--; \r
107         *pxTopOfStack = ( StackType_t ) pxOriginalTOS; /* Stack used when task starts goes in R13. */\r
108         pxTopOfStack--;\r
109         *pxTopOfStack = ( StackType_t ) 0x12121212;     /* R12 */\r
110         pxTopOfStack--; \r
111         *pxTopOfStack = ( StackType_t ) 0x11111111;     /* R11 */\r
112         pxTopOfStack--; \r
113         *pxTopOfStack = ( StackType_t ) 0x10101010;     /* R10 */\r
114         pxTopOfStack--; \r
115         *pxTopOfStack = ( StackType_t ) 0x09090909;     /* R9 */\r
116         pxTopOfStack--; \r
117         *pxTopOfStack = ( StackType_t ) 0x08080808;     /* R8 */\r
118         pxTopOfStack--; \r
119         *pxTopOfStack = ( StackType_t ) 0x07070707;     /* R7 */\r
120         pxTopOfStack--; \r
121         *pxTopOfStack = ( StackType_t ) 0x06060606;     /* R6 */\r
122         pxTopOfStack--; \r
123         *pxTopOfStack = ( StackType_t ) 0x05050505;     /* R5 */\r
124         pxTopOfStack--; \r
125         *pxTopOfStack = ( StackType_t ) 0x04040404;     /* R4 */\r
126         pxTopOfStack--; \r
127         *pxTopOfStack = ( StackType_t ) 0x03030303;     /* R3 */\r
128         pxTopOfStack--; \r
129         *pxTopOfStack = ( StackType_t ) 0x02020202;     /* R2 */\r
130         pxTopOfStack--; \r
131         *pxTopOfStack = ( StackType_t ) 0x01010101;     /* R1 */\r
132         pxTopOfStack--; \r
133         *pxTopOfStack = ( StackType_t ) pvParameters; /* R0 */\r
134         pxTopOfStack--;\r
135 \r
136         /* The last thing onto the stack is the status register, which is set for\r
137         system mode, with interrupts enabled. */\r
138         *pxTopOfStack = ( StackType_t ) portINITIAL_SPSR;\r
139 \r
140         if( ( ( uint32_t ) pxCode & 0x01UL ) != 0x00UL )\r
141         {\r
142                 /* We want the task to start in thumb mode. */\r
143                 *pxTopOfStack |= portTHUMB_MODE_BIT;\r
144         }\r
145 \r
146         pxTopOfStack--;\r
147 \r
148         /* The code generated by the Keil compiler does not maintain separate\r
149         stack and frame pointers. The portENTER_CRITICAL macro cannot therefore\r
150         use the stack as per other ports.  Instead a variable is used to keep\r
151         track of the critical section nesting.  This variable has to be stored\r
152         as part of the task context and is initially set to zero. */\r
153         *pxTopOfStack = portNO_CRITICAL_SECTION_NESTING;\r
154 \r
155         return pxTopOfStack;\r
156 }\r
157 /*-----------------------------------------------------------*/\r
158 \r
159 BaseType_t xPortStartScheduler( void )\r
160 {\r
161         /* Start the timer that generates the tick ISR. */\r
162         prvSetupTimerInterrupt();\r
163 \r
164         /* Start the first task.  This is done from portISR.c as ARM mode must be\r
165         used. */\r
166         vPortStartFirstTask();\r
167 \r
168         /* Should not get here! */\r
169         return 0;\r
170 }\r
171 /*-----------------------------------------------------------*/\r
172 \r
173 void vPortEndScheduler( void )\r
174 {\r
175         /* It is unlikely that the ARM port will require this function as there\r
176         is nothing to return to.  If this is required - stop the tick ISR then\r
177         return back to main. */\r
178 }\r
179 /*-----------------------------------------------------------*/\r
180 \r
181 #if configUSE_PREEMPTION == 0\r
182 \r
183         /* \r
184          * The cooperative scheduler requires a normal IRQ service routine to \r
185          * simply increment the system tick. \r
186          */\r
187         void vNonPreemptiveTick( void ) __irq;\r
188         void vNonPreemptiveTick( void ) __irq\r
189         {\r
190                 /* Increment the tick count - this may make a delaying task ready\r
191                 to run - but a context switch is not performed. */              \r
192                 xTaskIncrementTick();\r
193 \r
194                 T0IR = portTIMER_MATCH_ISR_BIT;                         /* Clear the timer event */\r
195                 VICVectAddr = portCLEAR_VIC_INTERRUPT;          /* Acknowledge the Interrupt */\r
196         }\r
197 \r
198  #else\r
199 \r
200         /*\r
201          **************************************************************************\r
202          * The preemptive scheduler ISR is written in assembler and can be found   \r
203          * in the portASM.s file. This will only get used if portUSE_PREEMPTION\r
204          * is set to 1 in portmacro.h\r
205          ************************************************************************** \r
206          */\r
207 \r
208           void vPreemptiveTick( void );\r
209 \r
210 #endif\r
211 /*-----------------------------------------------------------*/\r
212 \r
213 static void prvSetupTimerInterrupt( void )\r
214 {\r
215 uint32_t ulCompareMatch;\r
216 \r
217         /* A 1ms tick does not require the use of the timer prescale.  This is\r
218         defaulted to zero but can be used if necessary. */\r
219         T0PR = portPRESCALE_VALUE;\r
220 \r
221         /* Calculate the match value required for our wanted tick rate. */\r
222         ulCompareMatch = configCPU_CLOCK_HZ / configTICK_RATE_HZ;\r
223 \r
224         /* Protect against divide by zero.  Using an if() statement still results\r
225         in a warning - hence the #if. */\r
226         #if portPRESCALE_VALUE != 0\r
227         {\r
228                 ulCompareMatch /= ( portPRESCALE_VALUE + 1 );\r
229         }\r
230         #endif\r
231 \r
232         T0MR0 = ulCompareMatch;\r
233 \r
234         /* Generate tick with timer 0 compare match. */\r
235         T0MCR = portRESET_COUNT_ON_MATCH | portINTERRUPT_ON_MATCH;\r
236 \r
237         /* Setup the VIC for the timer. */\r
238         VICIntSelect &= ~( portTIMER_VIC_CHANNEL_BIT );\r
239         VICIntEnable |= portTIMER_VIC_CHANNEL_BIT;\r
240         \r
241         /* The ISR installed depends on whether the preemptive or cooperative\r
242         scheduler is being used. */\r
243         #if configUSE_PREEMPTION == 1\r
244         {       \r
245                 VICVectAddr0 = ( uint32_t ) vPreemptiveTick;\r
246         }\r
247         #else\r
248         {\r
249                 VICVectAddr0 = ( uint32_t ) vNonPreemptiveTick;\r
250         }\r
251         #endif\r
252 \r
253         VICVectCntl0 = portTIMER_VIC_CHANNEL | portTIMER_VIC_ENABLE;\r
254 \r
255         /* Start the timer - interrupts are disabled when this function is called\r
256         so it is okay to do this here. */\r
257         T0TCR = portENABLE_TIMER;\r
258 }\r
259 /*-----------------------------------------------------------*/\r
260 \r
261 void vPortEnterCritical( void )\r
262 {\r
263         /* Disable interrupts as per portDISABLE_INTERRUPTS();                                                  */\r
264         __disable_irq();\r
265 \r
266         /* Now interrupts are disabled ulCriticalNesting can be accessed \r
267         directly.  Increment ulCriticalNesting to keep a count of how many times\r
268         portENTER_CRITICAL() has been called. */\r
269         ulCriticalNesting++;\r
270 }\r
271 /*-----------------------------------------------------------*/\r
272 \r
273 void vPortExitCritical( void )\r
274 {\r
275         if( ulCriticalNesting > portNO_CRITICAL_NESTING )\r
276         {\r
277                 /* Decrement the nesting count as we are leaving a critical section. */\r
278                 ulCriticalNesting--;\r
279 \r
280                 /* If the nesting level has reached zero then interrupts should be\r
281                 re-enabled. */\r
282                 if( ulCriticalNesting == portNO_CRITICAL_NESTING )\r
283                 {\r
284                         /* Enable interrupts as per portEXIT_CRITICAL(). */\r
285                         __enable_irq();\r
286                 }\r
287         }\r
288 }\r
289 /*-----------------------------------------------------------*/\r
290 \r
291 \r