git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/Common/Minimal/PollQ.c

   1 /*\r
   2     FreeRTOS V8.0.1 - Copyright (C) 2014 Real Time Engineers Ltd. \r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\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
  12      *                                                                       *\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
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \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
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \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
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \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
  54 \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
  58 \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
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /*\r
  67  * This version of PollQ. c is for use on systems that have limited stack\r
  68  * space and no display facilities.  The complete version can be found in\r
  69  * the Demo/Common/Full directory.\r
  70  *\r
  71  * Creates two tasks that communicate over a single queue.  One task acts as a\r
  72  * producer, the other a consumer.\r
  73  *\r
  74  * The producer loops for three iteration, posting an incrementing number onto the\r
  75  * queue each cycle.  It then delays for a fixed period before doing exactly the\r
  76  * same again.\r
  77  *\r
  78  * The consumer loops emptying the queue.  Each item removed from the queue is\r
  79  * checked to ensure it contains the expected value.  When the queue is empty it\r
  80  * blocks for a fixed period, then does the same again.\r
  81  *\r
  82  * All queue access is performed without blocking.  The consumer completely empties\r
  83  * the queue each time it runs so the producer should never find the queue full.\r
  84  *\r
  85  * An error is flagged if the consumer obtains an unexpected value or the producer\r
  86  * find the queue is full.\r
  87  */\r
  88 \r
  89 /*\r
  90 Changes from V2.0.0\r
  91 \r
  92         + Delay periods are now specified using variables and constants of\r
  93           TickType_t rather than unsigned long.\r
  94 */\r
  95 \r
  96 #include <stdlib.h>\r
  97 \r
  98 /* Scheduler include files. */\r
  99 #include "FreeRTOS.h"\r
 100 #include "task.h"\r
 101 #include "queue.h"\r
 102 \r
 103 /* Demo program include files. */\r
 104 #include "PollQ.h"\r
 105 \r
 106 #define pollqSTACK_SIZE                 configMINIMAL_STACK_SIZE\r
 107 #define pollqQUEUE_SIZE                 ( 10 )\r
 108 #define pollqPRODUCER_DELAY             ( ( TickType_t ) 200 / portTICK_PERIOD_MS )\r
 109 #define pollqCONSUMER_DELAY             ( pollqPRODUCER_DELAY - ( TickType_t ) ( 20 / portTICK_PERIOD_MS ) )\r
 110 #define pollqNO_DELAY                   ( ( TickType_t ) 0 )\r
 111 #define pollqVALUES_TO_PRODUCE  ( ( signed portBASE_TYPE ) 3 )\r
 112 #define pollqINITIAL_VALUE              ( ( signed portBASE_TYPE ) 0 )\r
 113 \r
 114 /* The task that posts the incrementing number onto the queue. */\r
 115 static portTASK_FUNCTION_PROTO( vPolledQueueProducer, pvParameters );\r
 116 \r
 117 /* The task that empties the queue. */\r
 118 static portTASK_FUNCTION_PROTO( vPolledQueueConsumer, pvParameters );\r
 119 \r
 120 /* Variables that are used to check that the tasks are still running with no\r
 121 errors. */\r
 122 static volatile signed portBASE_TYPE xPollingConsumerCount = pollqINITIAL_VALUE, xPollingProducerCount = pollqINITIAL_VALUE;\r
 123 \r
 124 /*-----------------------------------------------------------*/\r
 125 \r
 126 void vStartPolledQueueTasks( unsigned portBASE_TYPE uxPriority )\r
 127 {\r
 128 static QueueHandle_t xPolledQueue;\r
 129 \r
 130         /* Create the queue used by the producer and consumer. */\r
 131         xPolledQueue = xQueueCreate( pollqQUEUE_SIZE, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 132 \r
 133         /* vQueueAddToRegistry() adds the queue to the queue registry, if one is\r
 134         in use.  The queue registry is provided as a means for kernel aware \r
 135         debuggers to locate queues and has no purpose if a kernel aware debugger\r
 136         is not being used.  The call to vQueueAddToRegistry() will be removed\r
 137         by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is \r
 138         defined to be less than 1. */\r
 139         vQueueAddToRegistry( xPolledQueue, "Poll_Test_Queue" );\r
 140 \r
 141         /* Spawn the producer and consumer. */\r
 142         xTaskCreate( vPolledQueueConsumer, "QConsNB", pollqSTACK_SIZE, ( void * ) &xPolledQueue, uxPriority, ( TaskHandle_t * ) NULL );\r
 143         xTaskCreate( vPolledQueueProducer, "QProdNB", pollqSTACK_SIZE, ( void * ) &xPolledQueue, uxPriority, ( TaskHandle_t * ) NULL );\r
 144 }\r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 static portTASK_FUNCTION( vPolledQueueProducer, pvParameters )\r
 148 {\r
 149 unsigned short usValue = ( unsigned short ) 0;\r
 150 signed portBASE_TYPE xError = pdFALSE, xLoop;\r
 151 \r
 152         for( ;; )\r
 153         {               \r
 154                 for( xLoop = 0; xLoop < pollqVALUES_TO_PRODUCE; xLoop++ )\r
 155                 {\r
 156                         /* Send an incrementing number on the queue without blocking. */\r
 157                         if( xQueueSend( *( ( QueueHandle_t * ) pvParameters ), ( void * ) &usValue, pollqNO_DELAY ) != pdPASS )\r
 158                         {\r
 159                                 /* We should never find the queue full so if we get here there\r
 160                                 has been an error. */\r
 161                                 xError = pdTRUE;\r
 162                         }\r
 163                         else\r
 164                         {\r
 165                                 if( xError == pdFALSE )\r
 166                                 {\r
 167                                         /* If an error has ever been recorded we stop incrementing the\r
 168                                         check variable. */\r
 169                                         portENTER_CRITICAL();\r
 170                                                 xPollingProducerCount++;\r
 171                                         portEXIT_CRITICAL();\r
 172                                 }\r
 173 \r
 174                                 /* Update the value we are going to post next time around. */\r
 175                                 usValue++;\r
 176                         }\r
 177                 }\r
 178 \r
 179                 /* Wait before we start posting again to ensure the consumer runs and\r
 180                 empties the queue. */\r
 181                 vTaskDelay( pollqPRODUCER_DELAY );\r
 182         }\r
 183 }  /*lint !e818 Function prototype must conform to API. */\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 static portTASK_FUNCTION( vPolledQueueConsumer, pvParameters )\r
 187 {\r
 188 unsigned short usData, usExpectedValue = ( unsigned short ) 0;\r
 189 signed portBASE_TYPE xError = pdFALSE;\r
 190 \r
 191         for( ;; )\r
 192         {               \r
 193                 /* Loop until the queue is empty. */\r
 194                 while( uxQueueMessagesWaiting( *( ( QueueHandle_t * ) pvParameters ) ) )\r
 195                 {\r
 196                         if( xQueueReceive( *( ( QueueHandle_t * ) pvParameters ), &usData, pollqNO_DELAY ) == pdPASS )\r
 197                         {\r
 198                                 if( usData != usExpectedValue )\r
 199                                 {\r
 200                                         /* This is not what we expected to receive so an error has\r
 201                                         occurred. */\r
 202                                         xError = pdTRUE;\r
 203 \r
 204                                         /* Catch-up to the value we received so our next expected\r
 205                                         value should again be correct. */\r
 206                                         usExpectedValue = usData;\r
 207                                 }\r
 208                                 else\r
 209                                 {\r
 210                                         if( xError == pdFALSE )\r
 211                                         {\r
 212                                                 /* Only increment the check variable if no errors have\r
 213                                                 occurred. */\r
 214                                                 portENTER_CRITICAL();\r
 215                                                         xPollingConsumerCount++;\r
 216                                                 portEXIT_CRITICAL();\r
 217                                         }\r
 218                                 }\r
 219 \r
 220                                 /* Next time round we would expect the number to be one higher. */\r
 221                                 usExpectedValue++;\r
 222                         }\r
 223                 }\r
 224 \r
 225                 /* Now the queue is empty we block, allowing the producer to place more\r
 226                 items in the queue. */\r
 227                 vTaskDelay( pollqCONSUMER_DELAY );\r
 228         }\r
 229 } /*lint !e818 Function prototype must conform to API. */\r
 230 /*-----------------------------------------------------------*/\r
 231 \r
 232 /* This is called to check that all the created tasks are still running with no errors. */\r
 233 portBASE_TYPE xArePollingQueuesStillRunning( void )\r
 234 {\r
 235 portBASE_TYPE xReturn;\r
 236 \r
 237         /* Check both the consumer and producer poll count to check they have both\r
 238         been changed since out last trip round.  We do not need a critical section\r
 239         around the check variables as this is called from a higher priority than\r
 240         the other tasks that access the same variables. */\r
 241         if( ( xPollingConsumerCount == pollqINITIAL_VALUE ) ||\r
 242                 ( xPollingProducerCount == pollqINITIAL_VALUE )\r
 243           )\r
 244         {\r
 245                 xReturn = pdFALSE;\r
 246         }\r
 247         else\r
 248         {\r
 249                 xReturn = pdTRUE;\r
 250         }\r
 251 \r
 252         /* Set the check variables back down so we know if they have been\r
 253         incremented the next time around. */\r
 254         xPollingConsumerCount = pollqINITIAL_VALUE;\r
 255         xPollingProducerCount = pollqINITIAL_VALUE;\r
 256 \r
 257         return xReturn;\r
 258 }\r