2 FreeRTOS V8.2.0 - Copyright (C) 2015 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\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
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
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
25 ***************************************************************************
\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
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
37 ***************************************************************************
\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
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
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
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
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
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
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
70 /******************************************************************************
\r
71 * This project provides two demo applications. A simple blinky style project,
\r
72 * and a more comprehensive test and demo application. The
\r
73 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting (defined in this file) is used to
\r
74 * select between the two. The simply blinky demo is implemented and described
\r
75 * in main_blinky.c. The more comprehensive test and demo application is
\r
76 * implemented and described in main_full.c.
\r
78 * This file implements the code that is not demo specific, including the
\r
79 * hardware setup and FreeRTOS hook functions.
\r
84 * This demo does not contain a non-kernel interrupt service routine that
\r
85 * can be used as an example for application writers to use as a reference.
\r
86 * Therefore, the framework of a dummy (not installed) handler is provided
\r
87 * in this file. The dummy function is called Dummy_IRQHandler(). Please
\r
88 * ensure to read the comments in the function itself, but more importantly,
\r
89 * the notes on the function contained on the documentation page for this demo
\r
90 * that is found on the FreeRTOS.org web site.
\r
94 * The following #error directive is to remind users that a batch file must be
\r
95 * executed prior to this project being built. The batch file *cannot* be
\r
96 * executed from within the IDE! Once it has been executed, re-open or refresh
\r
97 * the Eclipse project and remove the #error line below.
\r
99 #error Ensure CreateProjectDirectoryStructure.bat has been executed before building. See comment immediately above.
\r
102 /* Standard includes. */
\r
105 /* Kernel includes. */
\r
106 #include "FreeRTOS.h"
\r
109 /* Standard demo includes. */
\r
110 #include "QueueSet.h"
\r
111 #include "QueueOverwrite.h"
\r
113 /* Set mainCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,
\r
114 or 0 to run the more comprehensive test and demo application. */
\r
115 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY 1
\r
117 /*-----------------------------------------------------------*/
\r
120 * Set up the hardware ready to run this demo.
\r
122 static void prvSetupHardware( void );
\r
125 * main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.
\r
126 * main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
128 extern void main_blinky( void );
\r
129 extern void main_full( void );
\r
131 /*-----------------------------------------------------------*/
\r
135 /* Prepare the hardware to run this demo. */
\r
136 prvSetupHardware();
\r
138 /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top
\r
140 #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1
\r
152 /*-----------------------------------------------------------*/
\r
154 static void prvSetupHardware( void )
\r
156 configCONFIGURE_LED();
\r
158 /* Ensure all priority bits are assigned as preemption priority bits. */
\r
159 NVIC_SetPriorityGrouping( 0 );
\r
161 /*-----------------------------------------------------------*/
\r
163 void vApplicationMallocFailedHook( void )
\r
165 /* vApplicationMallocFailedHook() will only be called if
\r
166 configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h. It is a hook
\r
167 function that will get called if a call to pvPortMalloc() fails.
\r
168 pvPortMalloc() is called internally by the kernel whenever a task, queue,
\r
169 timer or semaphore is created. It is also called by various parts of the
\r
170 demo application. If heap_1.c or heap_2.c are used, then the size of the
\r
171 heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in
\r
172 FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used
\r
173 to query the size of free heap space that remains (although it does not
\r
174 provide information on how the remaining heap might be fragmented). */
\r
175 taskDISABLE_INTERRUPTS();
\r
178 __asm volatile( "NOP" );
\r
181 /*-----------------------------------------------------------*/
\r
183 void vApplicationIdleHook( void )
\r
185 /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set
\r
186 to 1 in FreeRTOSConfig.h. It will be called on each iteration of the idle
\r
187 task. It is essential that code added to this hook function never attempts
\r
188 to block in any way (for example, call xQueueReceive() with a block time
\r
189 specified, or call vTaskDelay()). If the application makes use of the
\r
190 vTaskDelete() API function (as this demo application does) then it is also
\r
191 important that vApplicationIdleHook() is permitted to return to its calling
\r
192 function, because it is the responsibility of the idle task to clean up
\r
193 memory allocated by the kernel to any task that has since been deleted. */
\r
195 /*-----------------------------------------------------------*/
\r
197 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
\r
199 ( void ) pcTaskName;
\r
202 /* Run time stack overflow checking is performed if
\r
203 configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook
\r
204 function is called if a stack overflow is detected. */
\r
205 taskDISABLE_INTERRUPTS();
\r
208 __asm volatile( "NOP" );
\r
211 /*-----------------------------------------------------------*/
\r
213 void vApplicationTickHook( void )
\r
215 /* This function will be called by each tick interrupt if
\r
216 configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h. User code can be
\r
217 added here, but the tick hook is called from an interrupt context, so
\r
218 code must not attempt to block, and only the interrupt safe FreeRTOS API
\r
219 functions can be used (those that end in FromISR()). */
\r
221 #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 0
\r
223 /* Write to a queue that is in use as part of the queue set demo to
\r
224 demonstrate using queue sets from an ISR. */
\r
225 vQueueSetAccessQueueSetFromISR();
\r
227 /* Test the ISR safe queue overwrite functions. */
\r
228 vQueueOverwritePeriodicISRDemo();
\r
230 #endif /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY */
\r
232 /*-----------------------------------------------------------*/
\r
234 #ifdef JUST_AN_EXAMPLE_ISR
\r
236 void Dummy_IRQHandler(void)
\r
238 long lHigherPriorityTaskWoken = pdFALSE;
\r
240 /* Clear the interrupt if necessary. */
\r
241 Dummy_ClearITPendingBit();
\r
243 /* This interrupt does nothing more than demonstrate how to synchronise a
\r
244 task with an interrupt. A semaphore is used for this purpose. Note
\r
245 lHigherPriorityTaskWoken is initialised to zero. */
\r
246 xSemaphoreGiveFromISR( xTestSemaphore, &lHigherPriorityTaskWoken );
\r
248 /* If there was a task that was blocked on the semaphore, and giving the
\r
249 semaphore caused the task to unblock, and the unblocked task has a priority
\r
250 higher than the current Running state task (the task that this interrupt
\r
251 interrupted), then lHigherPriorityTaskWoken will have been set to pdTRUE
\r
252 internally within xSemaphoreGiveFromISR(). Passing pdTRUE into the
\r
253 portEND_SWITCHING_ISR() macro will result in a context switch being pended to
\r
254 ensure this interrupt returns directly to the unblocked, higher priority,
\r
255 task. Passing pdFALSE into portEND_SWITCHING_ISR() has no effect. */
\r
256 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r
259 #endif /* JUST_AN_EXAMPLE_ISR */
\r