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 * NOTE 1: This project provides two demo applications. A simple blinky style
\r
68 * project, and a more comprehensive test and demo application. The
\r
69 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select
\r
70 * between the two. See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY
\r
71 * in main.c. This file implements the simply blinky style version.
\r
73 * NOTE 2: This file only contains the source code that is specific to the
\r
74 * basic demo. Generic functions, such FreeRTOS hook functions, and functions
\r
75 * required to configure the hardware, are defined in main.c.
\r
76 ******************************************************************************
\r
78 * main_blinky() creates one queue, two tasks, and one software timer. It then
\r
79 * starts the scheduler.
\r
81 * The Blinky Software Timer:
\r
82 * This demonstrates an auto-reload software timer. The timer callback function
\r
83 * does nothing but toggle an LED.
\r
85 * The Queue Send Task:
\r
86 * The queue send task is implemented by prvQueueSendTask() in main_blinky.c.
\r
87 * prvQueueSendTask() repeatedly blocks for 200 milliseconds before sending the
\r
88 * value 100 to the queue that was created in main_blinky().
\r
90 * The Queue Receive Task:
\r
91 * The queue receive task is implemented by prvQueueReceiveTask() in
\r
92 * main_blinky.c. prvQueueReceiveTask() repeatedly blocks on attempts to read
\r
93 * from the queue that was created in main_blinky(), toggling an LED each time
\r
94 * data is received. The queue send task sends data to the queue every 200
\r
95 * milliseconds, so the LED will toggle every 200 milliseconds.
\r
98 /* Standard includes. */
\r
101 /* Kernel includes. */
\r
102 #include "FreeRTOS.h"
\r
105 #include "timers.h"
\r
107 /* Standard demo includes. */
\r
108 #include "partest.h"
\r
109 #include "semphr.h"
\r
111 /* Priorities at which the tasks are created. */
\r
112 #define mainQUEUE_SEND_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
113 #define mainQUEUE_RECEIVE_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
115 /* The rate at which data is sent to the queue. The 200ms value is converted
\r
116 to ticks using the portTICK_PERIOD_MS constant. */
\r
117 #define mainQUEUE_SEND_FREQUENCY_MS ( 200 / portTICK_PERIOD_MS )
\r
119 /* The number of items the queue can hold. This is 1 as the receive task
\r
120 will remove items as they are added, meaning the send task should always find
\r
121 the queue empty. */
\r
122 #define mainQUEUE_LENGTH ( 1 )
\r
124 /* Values passed to the two tasks just to check the task parameter
\r
126 #define mainQUEUE_SEND_PARAMETER ( 0x1111UL )
\r
127 #define mainQUEUE_RECEIVE_PARAMETER ( 0x22UL )
\r
129 /* The period of the blinky software timer. The period is specified in ms and
\r
130 converted to ticks using the portTICK_PERIOD_MS constant. */
\r
131 #define mainBLINKY_TIMER_PERIOD ( 50 / portTICK_PERIOD_MS )
\r
133 /* The LED used by the communicating tasks and the blinky timer respectively. */
\r
134 #define mainTASKS_LED ( 0 )
\r
135 #define mainTIMER_LED ( 1 )
\r
138 #define mainDONT_BLOCK ( 0 )
\r
140 /*-----------------------------------------------------------*/
\r
143 * The tasks as described in the comments at the top of this file.
\r
145 static void prvQueueReceiveTask( void *pvParameters );
\r
146 static void prvQueueSendTask( void *pvParameters );
\r
149 * The callback function for the blinky software timer, as described at the top
\r
152 static void prvBlinkyTimerCallback( TimerHandle_t xTimer );
\r
155 * Called by main() to create the simply blinky style application if
\r
156 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.
\r
158 void main_blinky( void );
\r
160 /*-----------------------------------------------------------*/
\r
162 /* The queue used by both tasks. */
\r
163 static QueueHandle_t xQueue = NULL;
\r
165 /*-----------------------------------------------------------*/
\r
167 void main_blinky( void )
\r
169 TimerHandle_t xTimer;
\r
171 /* Create the queue. */
\r
172 xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );
\r
173 configASSERT( xQueue );
\r
175 if( xQueue != NULL )
\r
177 /* Create the two tasks as described in the comments at the top of this
\r
179 xTaskCreate( prvQueueReceiveTask, /* The function that implements the task. */
\r
180 "Rx", /* The text name assigned to the task - for debug only as it is not used by the kernel. */
\r
181 configMINIMAL_STACK_SIZE, /* The size of the stack to allocate to the task. */
\r
182 ( void * ) mainQUEUE_RECEIVE_PARAMETER, /* The parameter passed to the task - just to check the functionality. */
\r
183 mainQUEUE_RECEIVE_TASK_PRIORITY, /* The priority assigned to the task. */
\r
184 NULL ); /* The task handle is not required, so NULL is passed. */
\r
186 xTaskCreate( prvQueueSendTask, "TX", configMINIMAL_STACK_SIZE, ( void * ) mainQUEUE_SEND_PARAMETER, mainQUEUE_SEND_TASK_PRIORITY, NULL );
\r
189 /* Create the blinky software timer as described at the top of this file. */
\r
190 xTimer = xTimerCreate( "Blinky", /* A text name, purely to help debugging. */
\r
191 ( mainBLINKY_TIMER_PERIOD ),/* The timer period. */
\r
192 pdTRUE, /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */
\r
193 ( void * ) 0, /* The ID is not used, so can be set to anything. */
\r
194 prvBlinkyTimerCallback ); /* The callback function that inspects the status of all the other tasks. */
\r
195 configASSERT( xTimer );
\r
197 if( xTimer != NULL )
\r
199 xTimerStart( xTimer, mainDONT_BLOCK );
\r
202 /* Start the tasks and timer running. */
\r
203 vTaskStartScheduler();
\r
206 /* If all is well, the scheduler will now be running, and the following
\r
207 line will never be reached. If the following line does execute, then
\r
208 there was insufficient FreeRTOS heap memory available for the idle and/or
\r
209 timer tasks to be created. See the memory management section on the
\r
210 FreeRTOS web site for more details. http://www.freertos.org/a00111.html */
\r
213 /*-----------------------------------------------------------*/
\r
215 static void prvQueueSendTask( void *pvParameters )
\r
217 TickType_t xNextWakeTime;
\r
218 const unsigned long ulValueToSend = 100UL;
\r
220 /* Remove compiler warnigns in the case that configASSERT() is not dfined. */
\r
221 ( void ) pvParameters;
\r
223 /* Check the task parameter is as expected. */
\r
224 configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_SEND_PARAMETER );
\r
226 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
227 xNextWakeTime = xTaskGetTickCount();
\r
231 /* Place this task in the blocked state until it is time to run again.
\r
232 The block time is specified in ticks, the constant used converts ticks
\r
233 to ms. While in the Blocked state this task will not consume any CPU
\r
235 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );
\r
237 /* Send to the queue - causing the queue receive task to unblock and
\r
238 toggle the LED. 0 is used as the block time so the sending operation
\r
239 will not block - it shouldn't need to block as the queue should always
\r
240 be empty at this point in the code. */
\r
241 xQueueSend( xQueue, &ulValueToSend, 0U );
\r
244 /*-----------------------------------------------------------*/
\r
246 static void prvQueueReceiveTask( void *pvParameters )
\r
248 unsigned long ulReceivedValue;
\r
250 /* Remove compiler warnings in the case where configASSERT() is not defined. */
\r
251 ( void ) pvParameters;
\r
253 /* Check the task parameter is as expected. */
\r
254 configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_RECEIVE_PARAMETER );
\r
258 /* Wait until something arrives in the queue - this task will block
\r
259 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in
\r
260 FreeRTOSConfig.h. */
\r
261 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );
\r
263 /* To get here something must have been received from the queue, but
\r
264 is it the expected value? If it is, toggle the LED. */
\r
265 if( ulReceivedValue == 100UL )
\r
267 vParTestToggleLED( mainTASKS_LED );
\r
268 ulReceivedValue = 0U;
\r
272 /*-----------------------------------------------------------*/
\r
274 static void prvBlinkyTimerCallback( TimerHandle_t xTimer )
\r
276 /* Avoid compiler warnings. */
\r
279 /* This function is called when the blinky software time expires. All the
\r
280 function does is toggle the LED. LED mainTIMER_LED should therefore toggle
\r
281 with the period set by mainBLINKY_TIMER_PERIOD. */
\r
282 vParTestToggleLED( mainTIMER_LED );
\r
284 /*-----------------------------------------------------------*/
\r