2 * FreeRTOS Kernel V10.3.0
\r
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\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
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\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
22 * http://www.FreeRTOS.org
\r
23 * http://aws.amazon.com/freertos
\r
25 * 1 tab == 4 spaces!
\r
28 /******************************************************************************
\r
29 * This project provides two demo applications. A simple blinky style project,
\r
30 * and a more comprehensive test and demo application. The
\r
31 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting (defined in this file) is used to
\r
32 * select between the two. The simply blinky demo is implemented and described
\r
33 * in main_blinky.c. The more comprehensive test and demo application is
\r
34 * implemented and described in main_full.c.
\r
36 * This file implements the code that is not demo specific, including the
\r
37 * hardware setup and FreeRTOS hook functions.
\r
42 * This demo does not contain a non-kernel interrupt service routine that
\r
43 * can be used as an example for application writers to use as a reference.
\r
44 * Therefore, the framework of a dummy (not installed) handler is provided
\r
45 * in this file. The dummy function is called Dummy_IRQHandler(). Please
\r
46 * ensure to read the comments in the function itself, but more importantly,
\r
47 * the notes on the function contained on the documentation page for this demo
\r
48 * that is found on the FreeRTOS.org web site.
\r
51 /* Standard includes. */
\r
54 /* Kernel includes. */
\r
55 #include "FreeRTOS.h"
\r
58 /* Standard demo includes. */
\r
59 #include "QueueSet.h"
\r
60 #include "QueueOverwrite.h"
\r
62 /* Set mainCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,
\r
63 or 0 to run the more comprehensive test and demo application. */
\r
64 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY 0
\r
66 /*-----------------------------------------------------------*/
\r
69 * Set up the hardware ready to run this demo.
\r
71 static void prvSetupHardware( void );
\r
74 * main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.
\r
75 * main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
77 extern void main_blinky( void );
\r
78 extern void main_full( void );
\r
80 /*-----------------------------------------------------------*/
\r
84 /* Prepare the hardware to run this demo. */
\r
87 /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top
\r
89 #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1
\r
101 /*-----------------------------------------------------------*/
\r
103 static void prvSetupHardware( void )
\r
105 configCONFIGURE_LED();
\r
107 /* Ensure all priority bits are assigned as preemption priority bits. */
\r
108 NVIC_SetPriorityGrouping( 0 );
\r
110 /*-----------------------------------------------------------*/
\r
112 void vApplicationMallocFailedHook( void )
\r
114 /* vApplicationMallocFailedHook() will only be called if
\r
115 configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h. It is a hook
\r
116 function that will get called if a call to pvPortMalloc() fails.
\r
117 pvPortMalloc() is called internally by the kernel whenever a task, queue,
\r
118 timer or semaphore is created. It is also called by various parts of the
\r
119 demo application. If heap_1.c or heap_2.c are used, then the size of the
\r
120 heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in
\r
121 FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used
\r
122 to query the size of free heap space that remains (although it does not
\r
123 provide information on how the remaining heap might be fragmented). */
\r
124 taskDISABLE_INTERRUPTS();
\r
127 /*-----------------------------------------------------------*/
\r
129 void vApplicationIdleHook( void )
\r
131 /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set
\r
132 to 1 in FreeRTOSConfig.h. It will be called on each iteration of the idle
\r
133 task. It is essential that code added to this hook function never attempts
\r
134 to block in any way (for example, call xQueueReceive() with a block time
\r
135 specified, or call vTaskDelay()). If the application makes use of the
\r
136 vTaskDelete() API function (as this demo application does) then it is also
\r
137 important that vApplicationIdleHook() is permitted to return to its calling
\r
138 function, because it is the responsibility of the idle task to clean up
\r
139 memory allocated by the kernel to any task that has since been deleted. */
\r
141 /*-----------------------------------------------------------*/
\r
143 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
\r
145 ( void ) pcTaskName;
\r
148 /* Run time stack overflow checking is performed if
\r
149 configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook
\r
150 function is called if a stack overflow is detected. */
\r
151 taskDISABLE_INTERRUPTS();
\r
154 /*-----------------------------------------------------------*/
\r
156 void vApplicationTickHook( void )
\r
158 /* This function will be called by each tick interrupt if
\r
159 configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h. User code can be
\r
160 added here, but the tick hook is called from an interrupt context, so
\r
161 code must not attempt to block, and only the interrupt safe FreeRTOS API
\r
162 functions can be used (those that end in FromISR()). */
\r
164 #if mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 0
\r
166 /* Write to a queue that is in use as part of the queue set demo to
\r
167 demonstrate using queue sets from an ISR. */
\r
168 vQueueSetAccessQueueSetFromISR();
\r
170 /* Test the ISR safe queue overwrite functions. */
\r
171 vQueueOverwritePeriodicISRDemo();
\r
173 #endif /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY */
\r
175 /*-----------------------------------------------------------*/
\r
177 #ifdef JUST_AN_EXAMPLE_ISR
\r
179 void Dummy_IRQHandler(void)
\r
181 long lHigherPriorityTaskWoken = pdFALSE;
\r
183 /* Clear the interrupt if necessary. */
\r
184 Dummy_ClearITPendingBit();
\r
186 /* This interrupt does nothing more than demonstrate how to synchronise a
\r
187 task with an interrupt. A semaphore is used for this purpose. Note
\r
188 lHigherPriorityTaskWoken is initialised to zero. */
\r
189 xSemaphoreGiveFromISR( xTestSemaphore, &lHigherPriorityTaskWoken );
\r
191 /* If there was a task that was blocked on the semaphore, and giving the
\r
192 semaphore caused the task to unblock, and the unblocked task has a priority
\r
193 higher than the current Running state task (the task that this interrupt
\r
194 interrupted), then lHigherPriorityTaskWoken will have been set to pdTRUE
\r
195 internally within xSemaphoreGiveFromISR(). Passing pdTRUE into the
\r
196 portEND_SWITCHING_ISR() macro will result in a context switch being pended to
\r
197 ensure this interrupt returns directly to the unblocked, higher priority,
\r
198 task. Passing pdFALSE into portEND_SWITCHING_ISR() has no effect. */
\r
199 portEND_SWITCHING_ISR( lHigherPriorityTaskWoken );
\r
202 #endif /* JUST_AN_EXAMPLE_ISR */
\r