2 FreeRTOS V7.1.0 - Copyright (C) 2011 Real Time Engineers Ltd.
\r
5 ***************************************************************************
\r
7 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
8 * Complete, revised, and edited pdf reference manuals are also *
\r
11 * Purchasing FreeRTOS documentation will not only help you, by *
\r
12 * ensuring you get running as quickly as possible and with an *
\r
13 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
14 * the FreeRTOS project to continue with its mission of providing *
\r
15 * professional grade, cross platform, de facto standard solutions *
\r
16 * for microcontrollers - completely free of charge! *
\r
18 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
20 * Thank you for using FreeRTOS, and thank you for your support! *
\r
22 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\r
27 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
28 the terms of the GNU General Public License (version 2) as published by the
\r
29 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
30 >>>NOTE<<< The modification to the GPL is included to allow you to
\r
31 distribute a combined work that includes FreeRTOS without being obliged to
\r
32 provide the source code for proprietary components outside of the FreeRTOS
\r
33 kernel. FreeRTOS is distributed in the hope that it will be useful, but
\r
34 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
35 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
36 more details. You should have received a copy of the GNU General Public
\r
37 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
38 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
39 by writing to Richard Barry, contact details for whom are available on the
\r
44 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
47 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
50 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
51 licensing and training services.
\r
54 /******************************************************************************
\r
55 * This project provides two demo applications. A simple blinky style project,
\r
56 * and a more comprehensive test and demo application. The
\r
57 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting (defined in this file) is used to
\r
58 * select between the two. The simply blinky demo is implemented and described
\r
59 * in main_blinky.c. The more comprehensive test and demo application is
\r
60 * implemented and described in main_full.c.
\r
62 * This file implements the code that is not demo specific, including the
\r
63 * hardware setup and FreeRTOS hook functions. It also contains a dummy
\r
64 * interrupt service routine called Dummy_IRQHandler() that is provided as an
\r
65 * example of how to use interrupt safe FreeRTOS API functions (those that end
\r
68 *****************************************************************************/
\r
70 /* Standard includes. */
\r
73 /* FreeRTOS includes. */
\r
74 #include "FreeRTOS.h"
\r
77 /* Hardware specific includes. */
\r
78 #include "lpc11xx.h"
\r
80 /* Set mainCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,
\r
81 or 0 to run the more comprehensive test and demo application. */
\r
82 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY 1
\r
84 /* The bit on port 0 to which the LED is wired. */
\r
85 #define mainLED_BIT ( 1UL << 7UL )
\r
87 /* The configCHECK_FOR_STACK_OVERFLOW setting in FreeRTOSConifg can be used to
\r
88 check task stacks for overflows. It does not however check the stack used by
\r
89 interrupts. This demo has a simple addition that will also check the stack used
\r
90 by interrupts if mainCHECK_INTERRUPT_STACK is set to 1. Note that this check is
\r
91 only performed from the tick hook function (which runs in an interrupt context).
\r
92 It is a good debugging aid - but won't catch interrupt stack problems until the
\r
93 tick interrupt next executes. */
\r
94 #define mainCHECK_INTERRUPT_STACK 1
\r
95 #if mainCHECK_INTERRUPT_STACK == 1
\r
96 const unsigned char ucExpectedInterruptStackValues[] = { 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC };
\r
99 /*-----------------------------------------------------------*/
\r
102 * Perform any application specific hardware configuration. The clocks,
\r
103 * memory, etc. are configured before main() is called.
\r
105 static void prvSetupHardware( void );
\r
108 * The hardware only has a single LED. Simply toggle it.
\r
110 void vMainToggleLED( void );
\r
112 /* main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.
\r
113 main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0. */
\r
114 void main_blinky( void );
\r
115 void main_full( void );
\r
117 /*-----------------------------------------------------------*/
\r
119 /* The GPIO port to which the LED is attached. */
\r
120 static LPC_GPIO_TypeDef * const xGPIO0 = LPC_GPIO0;
\r
122 /*-----------------------------------------------------------*/
\r
125 /* Prepare the hardware to run this demo. */
\r
126 prvSetupHardware();
\r
128 /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top
\r
130 #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1
\r
140 /*-----------------------------------------------------------*/
\r
142 void vMainToggleLED( void )
\r
144 static unsigned long ulLEDState = 0UL;
\r
146 if( ulLEDState == 0UL )
\r
148 xGPIO0->MASKED_ACCESS[ mainLED_BIT ] = 0UL;
\r
152 xGPIO0->MASKED_ACCESS[ mainLED_BIT ] = mainLED_BIT;
\r
155 ulLEDState = !ulLEDState;
\r
157 /*-----------------------------------------------------------*/
\r
159 static void prvSetupHardware( void )
\r
161 extern unsigned long _vStackTop[], _pvHeapStart[];
\r
162 unsigned long ulInterruptStackSize;
\r
164 /* Enable AHB clock for GPIO. */
\r
165 LPC_SYSCON->SYSAHBCLKCTRL |= ( 1 << 6 );
\r
167 /* Configure GPIO for LED output. */
\r
168 xGPIO0->DIR |= mainLED_BIT;
\r
170 /* The size of the stack used by main and interrupts is not defined in
\r
171 the linker, but just uses whatever RAM is left. Calculate the amount of
\r
172 RAM available for the main/interrupt/system stack, and check it against
\r
173 a reasonable number. If this assert is hit then it is likely you don't
\r
174 have enough stack to start the kernel, or to allow interrupts to nest.
\r
175 Note - this is separate to the stacks that are used by tasks. The stacks
\r
176 that are used by tasks are automatically checked if
\r
177 configCHECK_FOR_STACK_OVERFLOW is not 0 in FreeRTOSConfig.h - but the stack
\r
178 used by interrupts is not. Reducing the conifgTOTAL_HEAP_SIZE setting will
\r
179 increase the stack available to main() and interrupts. */
\r
180 ulInterruptStackSize = ( ( unsigned long ) _vStackTop ) - ( ( unsigned long ) _pvHeapStart );
\r
181 configASSERT( ulInterruptStackSize > 350UL );
\r
183 /* Fill the stack used by main() and interrupts to a known value, so its
\r
184 use can be manually checked. */
\r
185 memcpy( ( void * ) _pvHeapStart, ucExpectedInterruptStackValues, sizeof( ucExpectedInterruptStackValues ) );
\r
187 /*-----------------------------------------------------------*/
\r
189 void vApplicationMallocFailedHook( void )
\r
191 /* vApplicationMallocFailedHook() will only be called if
\r
192 configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h. It is a hook
\r
193 function that will get called if a call to pvPortMalloc() fails.
\r
194 pvPortMalloc() is called internally by the kernel whenever a task, queue,
\r
195 timer or semaphore is created. It is also called by various parts of the
\r
196 demo application. If heap_1.c or heap_2.c are used, then the size of the
\r
197 heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in
\r
198 FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used
\r
199 to query the size of free heap space that remains (although it does not
\r
200 provide information on how the remaining heap might be fragmented). */
\r
201 taskDISABLE_INTERRUPTS();
\r
204 /*-----------------------------------------------------------*/
\r
206 void vApplicationIdleHook( void )
\r
208 /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set
\r
209 to 1 in FreeRTOSConfig.h. It will be called on each iteration of the idle
\r
210 task. It is essential that code added to this hook function never attempts
\r
211 to block in any way (for example, call xQueueReceive() with a block time
\r
212 specified, or call vTaskDelay()). If the application makes use of the
\r
213 vTaskDelete() API function (as this demo application does) then it is also
\r
214 important that vApplicationIdleHook() is permitted to return to its calling
\r
215 function, because it is the responsibility of the idle task to clean up
\r
216 memory allocated by the kernel to any task that has since been deleted. */
\r
218 /*-----------------------------------------------------------*/
\r
220 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )
\r
222 ( void ) pcTaskName;
\r
225 /* Run time stack overflow checking is performed if
\r
226 configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook
\r
227 function is called if a stack overflow is detected. */
\r
228 taskDISABLE_INTERRUPTS();
\r
231 /*-----------------------------------------------------------*/
\r
233 void vApplicationTickHook( void )
\r
235 #if mainCHECK_INTERRUPT_STACK == 1
\r
236 extern unsigned long _pvHeapStart[];
\r
238 /* This function will be called by each tick interrupt if
\r
239 configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h. User code can be
\r
240 added here, but the tick hook is called from an interrupt context, so
\r
241 code must not attempt to block, and only the interrupt safe FreeRTOS API
\r
242 functions can be used (those that end in FromISR()). */
\r
244 /* Manually check the last few bytes of the interrupt stack to check they
\r
245 have not been overwritten. Note - the task stacks are automatically
\r
246 checked for overflow if configCHECK_FOR_STACK_OVERFLOW is set to 1 or 2
\r
247 in FreeRTOSConifg.h, but the interrupt stack is not. */
\r
248 configASSERT( memcmp( ( void * ) _pvHeapStart, ucExpectedInterruptStackValues, sizeof( ucExpectedInterruptStackValues ) ) == 0U );
\r
249 #endif /* mainCHECK_INTERRUPT_STACK */
\r
251 /*-----------------------------------------------------------*/
\r
253 #ifdef JUST_AN_EXAMPLE_ISR
\r
255 void Dummy_IRQHandler(void)
\r
257 long lHigherPriorityTaskWoken = pdFALSE;
\r
259 /* Clear the interrupt if necessary. */
\r
260 Dummy_ClearITPendingBit();
\r
262 /* This interrupt does nothing more than demonstrate how to synchronise a
\r
263 task with an interrupt. A semaphore is used for this purpose. Note
\r
264 lHigherPriorityTaskWoken is initialised to zero. */
\r
265 xSemaphoreGiveFromISR( xTestSemaphore, &lHigherPriorityTaskWoken );
\r
267 /* If there was a task that was blocked on the semaphore, and giving the
\r
268 semaphore caused the task to unblock, and the unblocked task has a priority
\r
269 higher than the current Running state task (the task that this interrupt
\r
270 interrupted), then lHigherPriorityTaskWoken will have been set to pdTRUE
\r
271 internally within xSemaphoreGiveFromISR(). Passing pdTRUE into the
\r
272 portEND_SWITCHING_ISR() macro will result in a context switch being pended to
\r
273 ensure this interrupt returns directly to the unblocked, higher priority,
\r
274 task. Passing pdFALSE into portEND_SWITCHING_ISR() has no effect. */
\r
275 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r
278 #endif /* JUST_AN_EXAMPLE_ISR */
\r