2 FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
7 This file is part of the FreeRTOS distribution.
9 FreeRTOS is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License (version 2) as published by the
11 Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.
13 ***************************************************************************
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
15 >>! distribute a combined work that includes FreeRTOS without being !<<
16 >>! obliged to provide the source code for proprietary components !<<
17 >>! outside of the FreeRTOS kernel. !<<
18 ***************************************************************************
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
23 link: http://www.freertos.org/a00114.html
25 ***************************************************************************
27 * FreeRTOS provides completely free yet professionally developed, *
28 * robust, strictly quality controlled, supported, and cross *
29 * platform software that is more than just the market leader, it *
30 * is the industry's de facto standard. *
32 * Help yourself get started quickly while simultaneously helping *
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
34 * tutorial book, reference manual, or both: *
35 * http://www.FreeRTOS.org/Documentation *
37 ***************************************************************************
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
40 the FAQ page "My application does not run, what could be wrong?". Have you
41 defined configASSERT()?
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
44 embedded software for free we request you assist our global community by
45 participating in the support forum.
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
48 be as productive as possible as early as possible. Now you can receive
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
50 Ltd, and the world's leading authority on the world's leading RTOS.
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
61 licenses offer ticketed support, indemnification and commercial middleware.
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
64 engineered and independently SIL3 certified version for use in safety and
65 mission critical applications that require provable dependability.
70 /******************************************************************************
71 * NOTE 1: The Win32 port is a simulation (or is that emulation?) only! Do not
72 * expect to get real time behaviour from the Win32 port or this demo
73 * application. It is provided as a convenient development and demonstration
74 * test bed only. This was tested using Windows XP on a dual core laptop.
76 * Windows will not be running the FreeRTOS simulator threads continuously, so
77 * the timing information in the FreeRTOS+Trace logs have no meaningful units.
78 * See the documentation page for the Windows simulator for an explanation of
80 * http://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html
81 * - READ THE WEB DOCUMENTATION FOR THIS PORT FOR MORE INFORMATION ON USING IT -
83 * NOTE 2: This project provides two demo applications. A simple blinky style
84 * project, and a more comprehensive test and demo application. The
85 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select
86 * between the two. See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY
87 * in main.c. This file implements the simply blinky style version.
89 * NOTE 3: This file only contains the source code that is specific to the
90 * basic demo. Generic functions, such FreeRTOS hook functions, are defined
92 ******************************************************************************
94 * main_blinky() creates one queue, and two tasks. It then starts the
97 * The Queue Send Task:
98 * The queue send task is implemented by the prvQueueSendTask() function in
99 * this file. prvQueueSendTask() sits in a loop that causes it to repeatedly
100 * block for 200 (simulated as far as the scheduler is concerned, but in
101 * reality much longer - see notes above) milliseconds, before sending the
102 * value 100 to the queue that was created within main_blinky(). Once the
103 * value is sent, the task loops back around to block for another 200
104 * (simulated) milliseconds.
106 * The Queue Receive Task:
107 * The queue receive task is implemented by the prvQueueReceiveTask() function
108 * in this file. prvQueueReceiveTask() sits in a loop where it repeatedly
109 * blocks on attempts to read data from the queue that was created within
110 * main_blinky(). When data is received, the task checks the value of the
111 * data, and if the value equals the expected 100, outputs a message. The
112 * 'block time' parameter passed to the queue receive function specifies that
113 * the task should be held in the Blocked state indefinitely to wait for data
114 * to be available on the queue. The queue receive task will only leave the
115 * Blocked state when the queue send task writes to the queue. As the queue
116 * send task writes to the queue every 200 (simulated - see notes above)
117 * milliseconds, the queue receive task leaves the Blocked state every 200
118 * milliseconds, and therefore outputs a message every 200 milliseconds.
121 /* Standard includes. */
124 /* Kernel includes. */
125 #include "FreeRTOS.h"
129 /* Priorities at which the tasks are created. */
130 #define mainQUEUE_RECEIVE_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
131 #define mainQUEUE_SEND_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
133 /* The rate at which data is sent to the queue. The 200ms value is converted
134 to ticks using the portTICK_PERIOD_MS constant. */
135 #define mainQUEUE_SEND_FREQUENCY_MS ( 200 / portTICK_PERIOD_MS )
137 /* The number of items the queue can hold. This is 1 as the receive task
138 will remove items as they are added, meaning the send task should always find
140 #define mainQUEUE_LENGTH ( 1 )
142 /* Values passed to the two tasks just to check the task parameter
144 #define mainQUEUE_SEND_PARAMETER ( 0x1111UL )
145 #define mainQUEUE_RECEIVE_PARAMETER ( 0x22UL )
147 /*-----------------------------------------------------------*/
150 * The tasks as described in the comments at the top of this file.
152 static void prvQueueReceiveTask( void *pvParameters );
153 static void prvQueueSendTask( void *pvParameters );
155 /*-----------------------------------------------------------*/
157 /* The queue used by both tasks. */
158 static QueueHandle_t xQueue = NULL;
160 /*-----------------------------------------------------------*/
162 void main_blinky( void )
164 /* Create the queue. */
165 xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );
169 /* Start the two tasks as described in the comments at the top of this
171 xTaskCreate( prvQueueReceiveTask, /* The function that implements the task. */
172 "Rx", /* The text name assigned to the task - for debug only as it is not used by the kernel. */
173 configMINIMAL_STACK_SIZE, /* The size of the stack to allocate to the task. */
174 ( void * ) mainQUEUE_RECEIVE_PARAMETER, /* The parameter passed to the task - just to check the functionality. */
175 mainQUEUE_RECEIVE_TASK_PRIORITY, /* The priority assigned to the task. */
176 NULL ); /* The task handle is not required, so NULL is passed. */
178 xTaskCreate( prvQueueSendTask, "TX", configMINIMAL_STACK_SIZE, ( void * ) mainQUEUE_SEND_PARAMETER, mainQUEUE_SEND_TASK_PRIORITY, NULL );
180 /* Start the tasks and timer running. */
181 vTaskStartScheduler();
184 /* If all is well, the scheduler will now be running, and the following
185 line will never be reached. If the following line does execute, then
186 there was insufficient FreeRTOS heap memory available for the idle and/or
187 timer tasks to be created. See the memory management section on the
188 FreeRTOS web site for more details. */
191 /*-----------------------------------------------------------*/
193 static void prvQueueSendTask( void *pvParameters )
195 TickType_t xNextWakeTime;
196 const unsigned long ulValueToSend = 100UL;
197 const TickType_t xBlockTime = pdMS_TO_TICKS( mainQUEUE_SEND_FREQUENCY_MS );
199 /* Remove compiler warning in the case that configASSERT() is not
201 ( void ) pvParameters;
203 /* Check the task parameter is as expected. */
204 configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_SEND_PARAMETER );
206 /* Initialise xNextWakeTime - this only needs to be done once. */
207 xNextWakeTime = xTaskGetTickCount();
211 /* Place this task in the blocked state until it is time to run again.
212 The block time is specified in ticks, the constant used converts ticks
213 to ms. While in the Blocked state this task will not consume any CPU
215 vTaskDelayUntil( &xNextWakeTime, xBlockTime );
217 /* Send to the queue - causing the queue receive task to unblock and
218 toggle the LED. 0 is used as the block time so the sending operation
219 will not block - it shouldn't need to block as the queue should always
220 be empty at this point in the code. */
221 xQueueSend( xQueue, &ulValueToSend, 0U );
224 /*-----------------------------------------------------------*/
226 static void prvQueueReceiveTask( void *pvParameters )
228 unsigned long ulReceivedValue;
230 /* Remove compiler warning in the case that configASSERT() is not
232 ( void ) pvParameters;
234 /* Check the task parameter is as expected. */
235 configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_RECEIVE_PARAMETER );
239 /* Wait until something arrives in the queue - this task will block
240 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in
242 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );
244 /* To get here something must have been received from the queue, but
245 is it the expected value? If it is, toggle the LED. */
246 if( ulReceivedValue == 100UL )
248 /* Normally calling printf() from a task is not a good idea. Here
249 there is lots of stack space and only one task is using console IO
251 printf( "Message received\r\n" );
253 ulReceivedValue = 0U;
257 /*-----------------------------------------------------------*/