2 FreeRTOS.org V5.1.0 - Copyright (C) 2003-2008 Richard Barry.
\r
4 This file is part of the FreeRTOS.org distribution.
\r
6 FreeRTOS.org is free software; you can redistribute it and/or modify
\r
7 it under the terms of the GNU General Public License as published by
\r
8 the Free Software Foundation; either version 2 of the License, or
\r
9 (at your option) any later version.
\r
11 FreeRTOS.org is distributed in the hope that it will be useful,
\r
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
14 GNU General Public License for more details.
\r
16 You should have received a copy of the GNU General Public License
\r
17 along with FreeRTOS.org; if not, write to the Free Software
\r
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
\r
20 A special exception to the GPL can be applied should you wish to distribute
\r
21 a combined work that includes FreeRTOS.org, without being obliged to provide
\r
22 the source code for any proprietary components. See the licensing section
\r
23 of http://www.FreeRTOS.org for full details of how and when the exception
\r
26 ***************************************************************************
\r
27 ***************************************************************************
\r
29 * SAVE TIME AND MONEY! We can port FreeRTOS.org to your own hardware, *
\r
30 * and even write all or part of your application on your behalf. *
\r
31 * See http://www.OpenRTOS.com for details of the services we provide to *
\r
32 * expedite your project. *
\r
34 ***************************************************************************
\r
35 ***************************************************************************
\r
37 Please ensure to read the configuration and relevant port sections of the
\r
38 online documentation.
\r
40 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
43 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
46 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
47 licensing and training services.
\r
51 * Creates six tasks that operate on three queues as follows:
\r
53 * The first two tasks send and receive an incrementing number to/from a queue.
\r
54 * One task acts as a producer and the other as the consumer. The consumer is a
\r
55 * higher priority than the producer and is set to block on queue reads. The queue
\r
56 * only has space for one item - as soon as the producer posts a message on the
\r
57 * queue the consumer will unblock, pre-empt the producer, and remove the item.
\r
59 * The second two tasks work the other way around. Again the queue used only has
\r
60 * enough space for one item. This time the consumer has a lower priority than the
\r
61 * producer. The producer will try to post on the queue blocking when the queue is
\r
62 * full. When the consumer wakes it will remove the item from the queue, causing
\r
63 * the producer to unblock, pre-empt the consumer, and immediately re-fill the
\r
66 * The last two tasks use the same queue producer and consumer functions. This time the queue has
\r
67 * enough space for lots of items and the tasks operate at the same priority. The
\r
68 * producer will execute, placing items into the queue. The consumer will start
\r
69 * executing when either the queue becomes full (causing the producer to block) or
\r
70 * a context switch occurs (tasks of the same priority will time slice).
\r
72 * \page BlockQC blockQ.c
\r
73 * \ingroup DemoFiles
\r
80 + Reversed the priority and block times of the second two demo tasks so
\r
81 they operate as per the description above.
\r
85 + Delay periods are now specified using variables and constants of
\r
86 portTickType rather than unsigned portLONG.
\r
90 + The second set of tasks were created the wrong way around. This has been
\r
97 /* Scheduler include files. */
\r
98 #include "FreeRTOS.h"
\r
102 /* Demo program include files. */
\r
103 #include "BlockQ.h"
\r
106 #define blckqSTACK_SIZE ( ( unsigned portSHORT ) configMINIMAL_STACK_SIZE )
\r
107 #define blckqNUM_TASK_SETS ( 3 )
\r
109 /* Structure used to pass parameters to the blocking queue tasks. */
\r
110 typedef struct BLOCKING_QUEUE_PARAMETERS
\r
112 xQueueHandle xQueue; /*< The queue to be used by the task. */
\r
113 portTickType xBlockTime; /*< The block time to use on queue reads/writes. */
\r
114 volatile portSHORT *psCheckVariable; /*< Incremented on each successful cycle to check the task is still running. */
\r
115 } xBlockingQueueParameters;
\r
117 /* Task function that creates an incrementing number and posts it on a queue. */
\r
118 static void vBlockingQueueProducer( void *pvParameters );
\r
120 /* Task function that removes the incrementing number from a queue and checks that
\r
121 it is the expected number. */
\r
122 static void vBlockingQueueConsumer( void *pvParameters );
\r
124 /* Variables which are incremented each time an item is removed from a queue, and
\r
125 found to be the expected value.
\r
126 These are used to check that the tasks are still running. */
\r
127 static volatile portSHORT sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( portSHORT ) 0, ( portSHORT ) 0, ( portSHORT ) 0 };
\r
129 /* Variable which are incremented each time an item is posted on a queue. These
\r
130 are used to check that the tasks are still running. */
\r
131 static volatile portSHORT sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( portSHORT ) 0, ( portSHORT ) 0, ( portSHORT ) 0 };
\r
133 /*-----------------------------------------------------------*/
\r
135 void vStartBlockingQueueTasks( unsigned portBASE_TYPE uxPriority )
\r
137 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;
\r
138 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;
\r
139 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;
\r
140 const unsigned portBASE_TYPE uxQueueSize1 = 1, uxQueueSize5 = 5;
\r
141 const portTickType xBlockTime = ( portTickType ) 1000 / portTICK_RATE_MS;
\r
142 const portTickType xDontBlock = ( portTickType ) 0;
\r
144 /* Create the first two tasks as described at the top of the file. */
\r
146 /* First create the structure used to pass parameters to the consumer tasks. */
\r
147 pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );
\r
149 /* Create the queue used by the first two tasks to pass the incrementing number.
\r
150 Pass a pointer to the queue in the parameter structure. */
\r
151 pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );
\r
153 /* The consumer is created first so gets a block time as described above. */
\r
154 pxQueueParameters1->xBlockTime = xBlockTime;
\r
156 /* Pass in the variable that this task is going to increment so we can check it
\r
157 is still running. */
\r
158 pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );
\r
160 /* Create the structure used to pass parameters to the producer task. */
\r
161 pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );
\r
163 /* Pass the queue to this task also, using the parameter structure. */
\r
164 pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;
\r
166 /* The producer is not going to block - as soon as it posts the consumer will
\r
167 wake and remove the item so the producer should always have room to post. */
\r
168 pxQueueParameters2->xBlockTime = xDontBlock;
\r
170 /* Pass in the variable that this task is going to increment so we can check
\r
171 it is still running. */
\r
172 pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );
\r
175 /* Note the producer has a lower priority than the consumer when the tasks are
\r
177 xTaskCreate( vBlockingQueueConsumer, "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );
\r
178 xTaskCreate( vBlockingQueueProducer, "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );
\r
182 /* Create the second two tasks as described at the top of the file. This uses
\r
183 the same mechanism but reverses the task priorities. */
\r
185 pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );
\r
186 pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );
\r
187 pxQueueParameters3->xBlockTime = xDontBlock;
\r
188 pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );
\r
190 pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );
\r
191 pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;
\r
192 pxQueueParameters4->xBlockTime = xBlockTime;
\r
193 pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );
\r
195 xTaskCreate( vBlockingQueueProducer, "QProdB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );
\r
196 xTaskCreate( vBlockingQueueConsumer, "QConsB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );
\r
200 /* Create the last two tasks as described above. The mechanism is again just
\r
201 the same. This time both parameter structures are given a block time. */
\r
202 pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );
\r
203 pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );
\r
204 pxQueueParameters5->xBlockTime = xBlockTime;
\r
205 pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );
\r
207 pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );
\r
208 pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;
\r
209 pxQueueParameters6->xBlockTime = xBlockTime;
\r
210 pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] );
\r
212 xTaskCreate( vBlockingQueueProducer, "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );
\r
213 xTaskCreate( vBlockingQueueConsumer, "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );
\r
215 /*-----------------------------------------------------------*/
\r
217 static void vBlockingQueueProducer( void *pvParameters )
\r
219 unsigned portSHORT usValue = 0;
\r
220 xBlockingQueueParameters *pxQueueParameters;
\r
221 const portCHAR * const pcTaskStartMsg = "Blocking queue producer started.\r\n";
\r
222 const portCHAR * const pcTaskErrorMsg = "Could not post on blocking queue\r\n";
\r
223 portSHORT sErrorEverOccurred = pdFALSE;
\r
225 pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;
\r
227 /* Queue a message for printing to say the task has started. */
\r
228 vPrintDisplayMessage( &pcTaskStartMsg );
\r
232 if( xQueueSendToBack( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )
\r
234 vPrintDisplayMessage( &pcTaskErrorMsg );
\r
235 sErrorEverOccurred = pdTRUE;
\r
239 /* We have successfully posted a message, so increment the variable
\r
240 used to check we are still running. */
\r
241 if( sErrorEverOccurred == pdFALSE )
\r
243 ( *pxQueueParameters->psCheckVariable )++;
\r
246 /* Increment the variable we are going to post next time round. The
\r
247 consumer will expect the numbers to follow in numerical order. */
\r
252 /*-----------------------------------------------------------*/
\r
254 static void vBlockingQueueConsumer( void *pvParameters )
\r
256 unsigned portSHORT usData, usExpectedValue = 0;
\r
257 xBlockingQueueParameters *pxQueueParameters;
\r
258 const portCHAR * const pcTaskStartMsg = "Blocking queue consumer started.\r\n";
\r
259 const portCHAR * const pcTaskErrorMsg = "Incorrect value received on blocking queue.\r\n";
\r
260 portSHORT sErrorEverOccurred = pdFALSE;
\r
262 /* Queue a message for printing to say the task has started. */
\r
263 vPrintDisplayMessage( &pcTaskStartMsg );
\r
265 pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;
\r
269 if( xQueueReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )
\r
271 if( usData != usExpectedValue )
\r
273 vPrintDisplayMessage( &pcTaskErrorMsg );
\r
276 usExpectedValue = usData;
\r
278 sErrorEverOccurred = pdTRUE;
\r
282 /* We have successfully received a message, so increment the
\r
283 variable used to check we are still running. */
\r
284 if( sErrorEverOccurred == pdFALSE )
\r
286 ( *pxQueueParameters->psCheckVariable )++;
\r
289 /* Increment the value we expect to remove from the queue next time
\r
296 /*-----------------------------------------------------------*/
\r
298 /* This is called to check that all the created tasks are still running. */
\r
299 portBASE_TYPE xAreBlockingQueuesStillRunning( void )
\r
301 static portSHORT sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( portSHORT ) 0, ( portSHORT ) 0, ( portSHORT ) 0 };
\r
302 static portSHORT sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( portSHORT ) 0, ( portSHORT ) 0, ( portSHORT ) 0 };
\r
303 portBASE_TYPE xReturn = pdPASS, xTasks;
\r
305 /* Not too worried about mutual exclusion on these variables as they are 16
\r
306 bits and we are only reading them. We also only care to see if they have
\r
309 Loop through each check variable and return pdFALSE if any are found not
\r
310 to have changed since the last call. */
\r
312 for( xTasks = 0; xTasks < blckqNUM_TASK_SETS; xTasks++ )
\r
314 if( sBlockingConsumerCount[ xTasks ] == sLastBlockingConsumerCount[ xTasks ] )
\r
318 sLastBlockingConsumerCount[ xTasks ] = sBlockingConsumerCount[ xTasks ];
\r
321 if( sBlockingProducerCount[ xTasks ] == sLastBlockingProducerCount[ xTasks ] )
\r
325 sLastBlockingProducerCount[ xTasks ] = sBlockingProducerCount[ xTasks ];
\r