2 FreeRTOS V8.1.0 - 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 !<<
\r
28 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
29 >>! obliged to provide the source code for proprietary components !<<
\r
30 >>! outside of the FreeRTOS kernel. !<<
\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.
\r
80 * This demo does not contain a non-kernel interrupt service routine that
\r
81 * can be used as an example for application writers to use as a reference.
\r
82 * Therefore, the framework of a dummy (not installed) handler is provided
\r
83 * in this file. The dummy function is called Dummy_IRQHandler(). Please
\r
84 * ensure to read the comments in the function itself, but more importantly,
\r
85 * the notes on the function contained on the documentation page for this demo
\r
86 * that is found on the FreeRTOS.org web site.
\r
90 * The following #error directive is to remind users that a batch file must be
\r
91 * executed prior to this project being built. The batch file *cannot* be
\r
92 * executed from within the IDE! Once it has been executed, re-open or refresh
\r
93 * the Eclipse project and remove the #error line below.
\r
95 #error Ensure CreateProjectDirectoryStructure.bat has been executed before building. See comment immediately above.
\r
98 /* Standard includes. */
\r
101 /* Kernel includes. */
\r
102 #include "FreeRTOS.h"
\r
105 /* Standard demo includes. */
\r
106 #include "QueueSet.h"
\r
107 #include "QueueOverwrite.h"
\r
109 /* Set mainCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,
\r
110 or 0 to run the more comprehensive test and demo application. */
\r
111 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY 1
\r
113 /*-----------------------------------------------------------*/
\r
116 * Set up the hardware ready to run this demo.
\r
118 static void prvSetupHardware( void );
\r
121 * main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.
\r
122 * main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
124 extern void main_blinky( void );
\r
125 extern void main_full( void );
\r
127 /*-----------------------------------------------------------*/
\r
131 /* Prepare the hardware to run this demo. */
\r
132 prvSetupHardware();
\r
134 /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top
\r
136 #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1
\r
148 /*-----------------------------------------------------------*/
\r
150 static void prvSetupHardware( void )
\r
152 configCONFIGURE_LED();
\r
154 /* Ensure all priority bits are assigned as preemption priority bits. */
\r
155 NVIC_SetPriorityGrouping( 0 );
\r
157 /*-----------------------------------------------------------*/
\r
159 void vApplicationMallocFailedHook( void )
\r
161 /* vApplicationMallocFailedHook() will only be called if
\r
162 configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h. It is a hook
\r
163 function that will get called if a call to pvPortMalloc() fails.
\r
164 pvPortMalloc() is called internally by the kernel whenever a task, queue,
\r
165 timer or semaphore is created. It is also called by various parts of the
\r
166 demo application. If heap_1.c or heap_2.c are used, then the size of the
\r
167 heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in
\r
168 FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used
\r
169 to query the size of free heap space that remains (although it does not
\r
170 provide information on how the remaining heap might be fragmented). */
\r
171 taskDISABLE_INTERRUPTS();
\r
174 __asm volatile( "NOP" );
\r
177 /*-----------------------------------------------------------*/
\r
179 void vApplicationIdleHook( void )
\r
181 /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set
\r
182 to 1 in FreeRTOSConfig.h. It will be called on each iteration of the idle
\r
183 task. It is essential that code added to this hook function never attempts
\r
184 to block in any way (for example, call xQueueReceive() with a block time
\r
185 specified, or call vTaskDelay()). If the application makes use of the
\r
186 vTaskDelete() API function (as this demo application does) then it is also
\r
187 important that vApplicationIdleHook() is permitted to return to its calling
\r
188 function, because it is the responsibility of the idle task to clean up
\r
189 memory allocated by the kernel to any task that has since been deleted. */
\r
191 /*-----------------------------------------------------------*/
\r
193 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
\r
195 ( void ) pcTaskName;
\r
198 /* Run time stack overflow checking is performed if
\r
199 configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook
\r
200 function is called if a stack overflow is detected. */
\r
201 taskDISABLE_INTERRUPTS();
\r
204 __asm volatile( "NOP" );
\r
207 /*-----------------------------------------------------------*/
\r
209 void vApplicationTickHook( void )
\r
211 /* This function will be called by each tick interrupt if
\r
212 configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h. User code can be
\r
213 added here, but the tick hook is called from an interrupt context, so
\r
214 code must not attempt to block, and only the interrupt safe FreeRTOS API
\r
215 functions can be used (those that end in FromISR()). */
\r
217 #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 0
\r
219 /* Write to a queue that is in use as part of the queue set demo to
\r
220 demonstrate using queue sets from an ISR. */
\r
221 vQueueSetAccessQueueSetFromISR();
\r
223 /* Test the ISR safe queue overwrite functions. */
\r
224 vQueueOverwritePeriodicISRDemo();
\r
226 #endif /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY */
\r
228 /*-----------------------------------------------------------*/
\r
230 #ifdef JUST_AN_EXAMPLE_ISR
\r
232 void Dummy_IRQHandler(void)
\r
234 long lHigherPriorityTaskWoken = pdFALSE;
\r
236 /* Clear the interrupt if necessary. */
\r
237 Dummy_ClearITPendingBit();
\r
239 /* This interrupt does nothing more than demonstrate how to synchronise a
\r
240 task with an interrupt. A semaphore is used for this purpose. Note
\r
241 lHigherPriorityTaskWoken is initialised to zero. */
\r
242 xSemaphoreGiveFromISR( xTestSemaphore, &lHigherPriorityTaskWoken );
\r
244 /* If there was a task that was blocked on the semaphore, and giving the
\r
245 semaphore caused the task to unblock, and the unblocked task has a priority
\r
246 higher than the current Running state task (the task that this interrupt
\r
247 interrupted), then lHigherPriorityTaskWoken will have been set to pdTRUE
\r
248 internally within xSemaphoreGiveFromISR(). Passing pdTRUE into the
\r
249 portEND_SWITCHING_ISR() macro will result in a context switch being pended to
\r
250 ensure this interrupt returns directly to the unblocked, higher priority,
\r
251 task. Passing pdFALSE into portEND_SWITCHING_ISR() has no effect. */
\r
252 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r
255 #endif /* JUST_AN_EXAMPLE_ISR */
\r