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

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