2 FreeRTOS V8.0.0:rc1 - Copyright (C) 2014 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\r
9 * FreeRTOS provides completely free yet professionally developed, *
\r
10 * robust, strictly quality controlled, supported, and cross *
\r
11 * platform software that has become a de facto standard. *
\r
13 * Help yourself get started quickly and support the FreeRTOS *
\r
14 * project by purchasing a FreeRTOS tutorial book, reference *
\r
15 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
19 ***************************************************************************
\r
21 This file is part of the FreeRTOS distribution.
\r
23 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
24 the terms of the GNU General Public License (version 2) as published by the
\r
25 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
27 >>! NOTE: The modification to the GPL is included to allow you to distribute
\r
28 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
29 >>! the source code for proprietary components outside of the FreeRTOS
\r
32 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
33 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
34 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
35 link: http://www.freertos.org/a00114.html
\r
39 ***************************************************************************
\r
41 * Having a problem? Start by reading the FAQ "My application does *
\r
42 * not run, what could be wrong?" *
\r
44 * http://www.FreeRTOS.org/FAQHelp.html *
\r
46 ***************************************************************************
\r
48 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
49 license and Real Time Engineers Ltd. contact details.
\r
51 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
52 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
53 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
55 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
56 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
57 licenses offer ticketed support, indemnification and middleware.
\r
59 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
60 engineered and independently SIL3 certified version for use in safety and
\r
61 mission critical applications that require provable dependability.
\r
66 /******************************************************************************
\r
67 * This project provides two demo applications. A simple blinky style project,
\r
68 * and a more comprehensive test and demo application. The
\r
69 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting (defined in this file) is used to
\r
70 * select between the two. The simply blinky demo is implemented and described
\r
71 * in main_blinky.c. The more comprehensive test and demo application is
\r
72 * implemented and described in main_full.c.
\r
74 * This file implements the code that is not demo specific, including the
\r
75 * hardware setup and FreeRTOS hook functions. It also contains a dummy
\r
76 * interrupt service routine called Dummy_IRQHandler() that is provided as an
\r
77 * example of how to use interrupt safe FreeRTOS API functions (those that end
\r
80 *****************************************************************************/
\r
82 /* Standard includes. */
\r
85 /* FreeRTOS includes. */
\r
86 #include "FreeRTOS.h"
\r
89 /* Hardware specific includes. */
\r
90 #include "lpc11xx.h"
\r
92 /* Set mainCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,
\r
93 or 0 to run the more comprehensive test and demo application. */
\r
94 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY 0
\r
96 /* The bit on port 0 to which the LED is wired. */
\r
97 #define mainLED_BIT ( 1UL << 7UL )
\r
99 /* The configCHECK_FOR_STACK_OVERFLOW setting in FreeRTOSConifg can be used to
\r
100 check task stacks for overflows. It does not however check the stack used by
\r
101 interrupts. This demo has a simple addition that will also check the stack used
\r
102 by interrupts if mainCHECK_INTERRUPT_STACK is set to 1. Note that this check is
\r
103 only performed from the tick hook function (which runs in an interrupt context).
\r
104 It is a good debugging aid - but won't catch interrupt stack problems until the
\r
105 tick interrupt next executes. */
\r
106 #define mainCHECK_INTERRUPT_STACK 1
\r
107 #if mainCHECK_INTERRUPT_STACK == 1
\r
108 const unsigned char ucExpectedInterruptStackValues[] = { 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC, 0xCC };
\r
111 /*-----------------------------------------------------------*/
\r
114 * Perform any application specific hardware configuration. The clocks,
\r
115 * memory, etc. are configured before main() is called.
\r
117 static void prvSetupHardware( void );
\r
120 * The hardware only has a single LED. Simply toggle it.
\r
122 void vMainToggleLED( void );
\r
124 /* main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.
\r
125 main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0. */
\r
126 void main_blinky( void );
\r
127 void main_full( void );
\r
129 /*-----------------------------------------------------------*/
\r
131 /* The GPIO port to which the LED is attached. */
\r
132 static LPC_GPIO_TypeDef * const xGPIO0 = LPC_GPIO0;
\r
134 /*-----------------------------------------------------------*/
\r
137 /* Prepare the hardware to run this demo. */
\r
138 prvSetupHardware();
\r
140 /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top
\r
142 #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1
\r
154 /*-----------------------------------------------------------*/
\r
156 void vMainToggleLED( void )
\r
158 static unsigned long ulLEDState = 0UL;
\r
160 if( ulLEDState == 0UL )
\r
162 xGPIO0->MASKED_ACCESS[ mainLED_BIT ] = 0UL;
\r
166 xGPIO0->MASKED_ACCESS[ mainLED_BIT ] = mainLED_BIT;
\r
169 ulLEDState = !ulLEDState;
\r
171 /*-----------------------------------------------------------*/
\r
173 static void prvSetupHardware( void )
\r
175 extern unsigned long _vStackTop[], _pvHeapStart[];
\r
176 unsigned long ulInterruptStackSize;
\r
178 /* Enable AHB clock for GPIO. */
\r
179 LPC_SYSCON->SYSAHBCLKCTRL |= ( 1 << 6 );
\r
181 /* Configure GPIO for LED output. */
\r
182 xGPIO0->DIR |= mainLED_BIT;
\r
184 /* The size of the stack used by main and interrupts is not defined in
\r
185 the linker, but just uses whatever RAM is left. Calculate the amount of
\r
186 RAM available for the main/interrupt/system stack, and check it against
\r
187 a reasonable number. If this assert is hit then it is likely you don't
\r
188 have enough stack to start the kernel, or to allow interrupts to nest.
\r
189 Note - this is separate to the stacks that are used by tasks. The stacks
\r
190 that are used by tasks are automatically checked if
\r
191 configCHECK_FOR_STACK_OVERFLOW is not 0 in FreeRTOSConfig.h - but the stack
\r
192 used by interrupts is not. Reducing the conifgTOTAL_HEAP_SIZE setting will
\r
193 increase the stack available to main() and interrupts. */
\r
194 ulInterruptStackSize = ( ( unsigned long ) _vStackTop ) - ( ( unsigned long ) _pvHeapStart );
\r
195 configASSERT( ulInterruptStackSize > 350UL );
\r
197 /* Fill the stack used by main() and interrupts to a known value, so its
\r
198 use can be manually checked. */
\r
199 memcpy( ( void * ) _pvHeapStart, ucExpectedInterruptStackValues, sizeof( ucExpectedInterruptStackValues ) );
\r
201 /*-----------------------------------------------------------*/
\r
203 void vApplicationMallocFailedHook( void )
\r
205 /* vApplicationMallocFailedHook() will only be called if
\r
206 configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h. It is a hook
\r
207 function that will get called if a call to pvPortMalloc() fails.
\r
208 pvPortMalloc() is called internally by the kernel whenever a task, queue,
\r
209 timer or semaphore is created. It is also called by various parts of the
\r
210 demo application. If heap_1.c or heap_2.c are used, then the size of the
\r
211 heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in
\r
212 FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used
\r
213 to query the size of free heap space that remains (although it does not
\r
214 provide information on how the remaining heap might be fragmented). */
\r
215 taskDISABLE_INTERRUPTS();
\r
218 /*-----------------------------------------------------------*/
\r
220 void vApplicationIdleHook( void )
\r
222 /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set
\r
223 to 1 in FreeRTOSConfig.h. It will be called on each iteration of the idle
\r
224 task. It is essential that code added to this hook function never attempts
\r
225 to block in any way (for example, call xQueueReceive() with a block time
\r
226 specified, or call vTaskDelay()). If the application makes use of the
\r
227 vTaskDelete() API function (as this demo application does) then it is also
\r
228 important that vApplicationIdleHook() is permitted to return to its calling
\r
229 function, because it is the responsibility of the idle task to clean up
\r
230 memory allocated by the kernel to any task that has since been deleted. */
\r
232 /*-----------------------------------------------------------*/
\r
234 void vApplicationStackOverflowHook( xTaskHandle pxTask, char *pcTaskName )
\r
236 ( void ) pcTaskName;
\r
239 /* Run time stack overflow checking is performed if
\r
240 configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook
\r
241 function is called if a stack overflow is detected. */
\r
242 taskDISABLE_INTERRUPTS();
\r
245 /*-----------------------------------------------------------*/
\r
247 void vApplicationTickHook( void )
\r
249 #if mainCHECK_INTERRUPT_STACK == 1
\r
250 extern unsigned long _pvHeapStart[];
\r
252 /* This function will be called by each tick interrupt if
\r
253 configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h. User code can be
\r
254 added here, but the tick hook is called from an interrupt context, so
\r
255 code must not attempt to block, and only the interrupt safe FreeRTOS API
\r
256 functions can be used (those that end in FromISR()). */
\r
258 /* Manually check the last few bytes of the interrupt stack to check they
\r
259 have not been overwritten. Note - the task stacks are automatically
\r
260 checked for overflow if configCHECK_FOR_STACK_OVERFLOW is set to 1 or 2
\r
261 in FreeRTOSConifg.h, but the interrupt stack is not. */
\r
262 configASSERT( memcmp( ( void * ) _pvHeapStart, ucExpectedInterruptStackValues, sizeof( ucExpectedInterruptStackValues ) ) == 0U );
\r
263 #endif /* mainCHECK_INTERRUPT_STACK */
\r
265 /*-----------------------------------------------------------*/
\r
267 #ifdef JUST_AN_EXAMPLE_ISR
\r
269 void Dummy_IRQHandler(void)
\r
271 long lHigherPriorityTaskWoken = pdFALSE;
\r
273 /* Clear the interrupt if necessary. */
\r
274 Dummy_ClearITPendingBit();
\r
276 /* This interrupt does nothing more than demonstrate how to synchronise a
\r
277 task with an interrupt. A semaphore is used for this purpose. Note
\r
278 lHigherPriorityTaskWoken is initialised to zero. Only FreeRTOS API functions
\r
279 that end in "FromISR" can be called from an ISR. */
\r
280 xSemaphoreGiveFromISR( xTestSemaphore, &lHigherPriorityTaskWoken );
\r
282 /* If there was a task that was blocked on the semaphore, and giving the
\r
283 semaphore caused the task to unblock, and the unblocked task has a priority
\r
284 higher than the current Running state task (the task that this interrupt
\r
285 interrupted), then lHigherPriorityTaskWoken will have been set to pdTRUE
\r
286 internally within xSemaphoreGiveFromISR(). Passing pdTRUE into the
\r
287 portEND_SWITCHING_ISR() macro will result in a context switch being pended to
\r
288 ensure this interrupt returns directly to the unblocked, higher priority,
\r
289 task. Passing pdFALSE into portEND_SWITCHING_ISR() has no effect. */
\r
290 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r
293 #endif /* JUST_AN_EXAMPLE_ISR */
\r