2 FreeRTOS V7.4.1 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
4 FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME. PLEASE VISIT
\r
5 http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\r
9 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
10 * Complete, revised, and edited pdf reference manuals are also *
\r
13 * Purchasing FreeRTOS documentation will not only help you, by *
\r
14 * ensuring you get running as quickly as possible and with an *
\r
15 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
16 * the FreeRTOS project to continue with its mission of providing *
\r
17 * professional grade, cross platform, de facto standard solutions *
\r
18 * for microcontrollers - completely free of charge! *
\r
20 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
22 * Thank you for using FreeRTOS, and thank you for your support! *
\r
24 ***************************************************************************
\r
27 This file is part of the FreeRTOS distribution.
\r
29 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
30 the terms of the GNU General Public License (version 2) as published by the
\r
31 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
33 >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to
\r
34 distribute a combined work that includes FreeRTOS without being obliged to
\r
35 provide the source code for proprietary components outside of the FreeRTOS
\r
38 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
39 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
40 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
\r
41 details. You should have received a copy of the GNU General Public License
\r
42 and the FreeRTOS license exception along with FreeRTOS; if not it can be
\r
43 viewed here: http://www.freertos.org/a00114.html and also obtained by
\r
44 writing to Real Time Engineers Ltd., contact details for whom are available
\r
45 on the FreeRTOS WEB site.
\r
49 ***************************************************************************
\r
51 * Having a problem? Start by reading the FAQ "My application does *
\r
52 * not run, what could be wrong?" *
\r
54 * http://www.FreeRTOS.org/FAQHelp.html *
\r
56 ***************************************************************************
\r
59 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
60 license and Real Time Engineers Ltd. contact details.
\r
62 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
63 including FreeRTOS+Trace - an indispensable productivity tool, and our new
\r
64 fully thread aware and reentrant UDP/IP stack.
\r
66 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
67 Integrity Systems, who sell the code with commercial support,
\r
68 indemnification and middleware, under the OpenRTOS brand.
\r
70 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
71 engineered and independently SIL3 certified version for use in safety and
\r
72 mission critical applications that require provable dependability.
\r
76 * This version of PollQ. c is for use on systems that have limited stack
\r
77 * space and no display facilities. The complete version can be found in
\r
78 * the Demo/Common/Full directory.
\r
80 * Creates two tasks that communicate over a single queue. One task acts as a
\r
81 * producer, the other a consumer.
\r
83 * The producer loops for three iteration, posting an incrementing number onto the
\r
84 * queue each cycle. It then delays for a fixed period before doing exactly the
\r
87 * The consumer loops emptying the queue. Each item removed from the queue is
\r
88 * checked to ensure it contains the expected value. When the queue is empty it
\r
89 * blocks for a fixed period, then does the same again.
\r
91 * All queue access is performed without blocking. The consumer completely empties
\r
92 * the queue each time it runs so the producer should never find the queue full.
\r
94 * An error is flagged if the consumer obtains an unexpected value or the producer
\r
95 * find the queue is full.
\r
101 + Delay periods are now specified using variables and constants of
\r
102 portTickType rather than unsigned long.
\r
105 #include <stdlib.h>
\r
107 /* Scheduler include files. */
\r
108 #include "FreeRTOS.h"
\r
112 /* Demo program include files. */
\r
115 #define pollqSTACK_SIZE configMINIMAL_STACK_SIZE
\r
116 #define pollqQUEUE_SIZE ( 10 )
\r
117 #define pollqPRODUCER_DELAY ( ( portTickType ) 200 / portTICK_RATE_MS )
\r
118 #define pollqCONSUMER_DELAY ( pollqPRODUCER_DELAY - ( portTickType ) ( 20 / portTICK_RATE_MS ) )
\r
119 #define pollqNO_DELAY ( ( portTickType ) 0 )
\r
120 #define pollqVALUES_TO_PRODUCE ( ( signed portBASE_TYPE ) 3 )
\r
121 #define pollqINITIAL_VALUE ( ( signed portBASE_TYPE ) 0 )
\r
123 /* The task that posts the incrementing number onto the queue. */
\r
124 static portTASK_FUNCTION_PROTO( vPolledQueueProducer, pvParameters );
\r
126 /* The task that empties the queue. */
\r
127 static portTASK_FUNCTION_PROTO( vPolledQueueConsumer, pvParameters );
\r
129 /* Variables that are used to check that the tasks are still running with no
\r
131 static volatile signed portBASE_TYPE xPollingConsumerCount = pollqINITIAL_VALUE, xPollingProducerCount = pollqINITIAL_VALUE;
\r
133 /*-----------------------------------------------------------*/
\r
135 void vStartPolledQueueTasks( unsigned portBASE_TYPE uxPriority )
\r
137 static xQueueHandle xPolledQueue;
\r
139 /* Create the queue used by the producer and consumer. */
\r
140 xPolledQueue = xQueueCreate( pollqQUEUE_SIZE, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );
\r
142 /* vQueueAddToRegistry() adds the queue to the queue registry, if one is
\r
143 in use. The queue registry is provided as a means for kernel aware
\r
144 debuggers to locate queues and has no purpose if a kernel aware debugger
\r
145 is not being used. The call to vQueueAddToRegistry() will be removed
\r
146 by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is
\r
147 defined to be less than 1. */
\r
148 vQueueAddToRegistry( xPolledQueue, ( signed char * ) "Poll_Test_Queue" );
\r
150 /* Spawn the producer and consumer. */
\r
151 xTaskCreate( vPolledQueueConsumer, ( signed char * ) "QConsNB", pollqSTACK_SIZE, ( void * ) &xPolledQueue, uxPriority, ( xTaskHandle * ) NULL );
\r
152 xTaskCreate( vPolledQueueProducer, ( signed char * ) "QProdNB", pollqSTACK_SIZE, ( void * ) &xPolledQueue, uxPriority, ( xTaskHandle * ) NULL );
\r
154 /*-----------------------------------------------------------*/
\r
156 static portTASK_FUNCTION( vPolledQueueProducer, pvParameters )
\r
158 unsigned short usValue = ( unsigned short ) 0;
\r
159 signed portBASE_TYPE xError = pdFALSE, xLoop;
\r
163 for( xLoop = 0; xLoop < pollqVALUES_TO_PRODUCE; xLoop++ )
\r
165 /* Send an incrementing number on the queue without blocking. */
\r
166 if( xQueueSend( *( ( xQueueHandle * ) pvParameters ), ( void * ) &usValue, pollqNO_DELAY ) != pdPASS )
\r
168 /* We should never find the queue full so if we get here there
\r
169 has been an error. */
\r
174 if( xError == pdFALSE )
\r
176 /* If an error has ever been recorded we stop incrementing the
\r
178 portENTER_CRITICAL();
\r
179 xPollingProducerCount++;
\r
180 portEXIT_CRITICAL();
\r
183 /* Update the value we are going to post next time around. */
\r
188 /* Wait before we start posting again to ensure the consumer runs and
\r
189 empties the queue. */
\r
190 vTaskDelay( pollqPRODUCER_DELAY );
\r
192 } /*lint !e818 Function prototype must conform to API. */
\r
193 /*-----------------------------------------------------------*/
\r
195 static portTASK_FUNCTION( vPolledQueueConsumer, pvParameters )
\r
197 unsigned short usData, usExpectedValue = ( unsigned short ) 0;
\r
198 signed portBASE_TYPE xError = pdFALSE;
\r
202 /* Loop until the queue is empty. */
\r
203 while( uxQueueMessagesWaiting( *( ( xQueueHandle * ) pvParameters ) ) )
\r
205 if( xQueueReceive( *( ( xQueueHandle * ) pvParameters ), &usData, pollqNO_DELAY ) == pdPASS )
\r
207 if( usData != usExpectedValue )
\r
209 /* This is not what we expected to receive so an error has
\r
213 /* Catch-up to the value we received so our next expected
\r
214 value should again be correct. */
\r
215 usExpectedValue = usData;
\r
219 if( xError == pdFALSE )
\r
221 /* Only increment the check variable if no errors have
\r
223 portENTER_CRITICAL();
\r
224 xPollingConsumerCount++;
\r
225 portEXIT_CRITICAL();
\r
229 /* Next time round we would expect the number to be one higher. */
\r
234 /* Now the queue is empty we block, allowing the producer to place more
\r
235 items in the queue. */
\r
236 vTaskDelay( pollqCONSUMER_DELAY );
\r
238 } /*lint !e818 Function prototype must conform to API. */
\r
239 /*-----------------------------------------------------------*/
\r
241 /* This is called to check that all the created tasks are still running with no errors. */
\r
242 portBASE_TYPE xArePollingQueuesStillRunning( void )
\r
244 portBASE_TYPE xReturn;
\r
246 /* Check both the consumer and producer poll count to check they have both
\r
247 been changed since out last trip round. We do not need a critical section
\r
248 around the check variables as this is called from a higher priority than
\r
249 the other tasks that access the same variables. */
\r
250 if( ( xPollingConsumerCount == pollqINITIAL_VALUE ) ||
\r
251 ( xPollingProducerCount == pollqINITIAL_VALUE )
\r
261 /* Set the check variables back down so we know if they have been
\r
262 incremented the next time around. */
\r
263 xPollingConsumerCount = pollqINITIAL_VALUE;
\r
264 xPollingProducerCount = pollqINITIAL_VALUE;
\r