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

   1 /*\r
   2         FreeRTOS.org V5.0.2 - Copyright (C) 2003-2008 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \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
  10 \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
  15 \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
  19 \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
  24         can be applied.\r
  25 \r
  26     ***************************************************************************\r
  27     ***************************************************************************\r
  28     *                                                                         *\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
  33     *                                                                         *\r
  34     ***************************************************************************\r
  35     ***************************************************************************\r
  36 \r
  37         Please ensure to read the configuration and relevant port sections of the\r
  38         online documentation.\r
  39 \r
  40         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  41         contact details.\r
  42 \r
  43         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  44         critical systems.\r
  45 \r
  46         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  47         licensing and training services.\r
  48 */\r
  49 \r
  50 /*\r
  51  * This version of PollQ. c is for use on systems that have limited stack\r
  52  * space and no display facilities.  The complete version can be found in\r
  53  * the Demo/Common/Full directory.\r
  54  *\r
  55  * Creates two tasks that communicate over a single queue.  One task acts as a\r
  56  * producer, the other a consumer.\r
  57  *\r
  58  * The producer loops for three iteration, posting an incrementing number onto the\r
  59  * queue each cycle.  It then delays for a fixed period before doing exactly the\r
  60  * same again.\r
  61  *\r
  62  * The consumer loops emptying the queue.  Each item removed from the queue is\r
  63  * checked to ensure it contains the expected value.  When the queue is empty it\r
  64  * blocks for a fixed period, then does the same again.\r
  65  *\r
  66  * All queue access is performed without blocking.  The consumer completely empties\r
  67  * the queue each time it runs so the producer should never find the queue full.\r
  68  *\r
  69  * An error is flagged if the consumer obtains an unexpected value or the producer\r
  70  * find the queue is full.\r
  71  */\r
  72 \r
  73 /*\r
  74 Changes from V2.0.0\r
  75 \r
  76         + Delay periods are now specified using variables and constants of\r
  77           portTickType rather than unsigned portLONG.\r
  78 */\r
  79 \r
  80 #include <stdlib.h>\r
  81 \r
  82 /* Scheduler include files. */\r
  83 #include "FreeRTOS.h"\r
  84 #include "task.h"\r
  85 #include "queue.h"\r
  86 \r
  87 /* Demo program include files. */\r
  88 #include "PollQ.h"\r
  89 \r
  90 #define pollqSTACK_SIZE                 configMINIMAL_STACK_SIZE\r
  91 #define pollqQUEUE_SIZE                 ( 10 )\r
  92 #define pollqPRODUCER_DELAY             ( ( portTickType ) 200 / portTICK_RATE_MS )\r
  93 #define pollqCONSUMER_DELAY             ( pollqPRODUCER_DELAY - ( portTickType ) ( 20 / portTICK_RATE_MS ) )\r
  94 #define pollqNO_DELAY                   ( ( portTickType ) 0 )\r
  95 #define pollqVALUES_TO_PRODUCE  ( ( signed portBASE_TYPE ) 3 )\r
  96 #define pollqINITIAL_VALUE              ( ( signed portBASE_TYPE ) 0 )\r
  97 \r
  98 /* The task that posts the incrementing number onto the queue. */\r
  99 static portTASK_FUNCTION_PROTO( vPolledQueueProducer, pvParameters );\r
 100 \r
 101 /* The task that empties the queue. */\r
 102 static portTASK_FUNCTION_PROTO( vPolledQueueConsumer, pvParameters );\r
 103 \r
 104 /* Variables that are used to check that the tasks are still running with no\r
 105 errors. */\r
 106 static volatile signed portBASE_TYPE xPollingConsumerCount = pollqINITIAL_VALUE, xPollingProducerCount = pollqINITIAL_VALUE;\r
 107 \r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 void vStartPolledQueueTasks( unsigned portBASE_TYPE uxPriority )\r
 111 {\r
 112 static xQueueHandle xPolledQueue;\r
 113 \r
 114         /* Create the queue used by the producer and consumer. */\r
 115         xPolledQueue = xQueueCreate( pollqQUEUE_SIZE, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 116 \r
 117         /* vQueueAddToRegistry() adds the queue to the queue registry, if one is\r
 118         in use.  The queue registry is provided as a means for kernel aware \r
 119         debuggers to locate queues and has no purpose if a kernel aware debugger\r
 120         is not being used.  The call to vQueueAddToRegistry() will be removed\r
 121         by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is \r
 122         defined to be less than 1. */\r
 123         vQueueAddToRegistry( xPolledQueue, ( signed portCHAR * ) "Poll_Test_Queue" );\r
 124 \r
 125         /* Spawn the producer and consumer. */\r
 126         xTaskCreate( vPolledQueueConsumer, ( signed portCHAR * ) "QConsNB", pollqSTACK_SIZE, ( void * ) &xPolledQueue, uxPriority, ( xTaskHandle * ) NULL );\r
 127         xTaskCreate( vPolledQueueProducer, ( signed portCHAR * ) "QProdNB", pollqSTACK_SIZE, ( void * ) &xPolledQueue, uxPriority, ( xTaskHandle * ) NULL );\r
 128 }\r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 static portTASK_FUNCTION( vPolledQueueProducer, pvParameters )\r
 132 {\r
 133 unsigned portSHORT usValue = ( unsigned portSHORT ) 0;\r
 134 signed portBASE_TYPE xError = pdFALSE, xLoop;\r
 135 \r
 136         for( ;; )\r
 137         {               \r
 138                 for( xLoop = 0; xLoop < pollqVALUES_TO_PRODUCE; xLoop++ )\r
 139                 {\r
 140                         /* Send an incrementing number on the queue without blocking. */\r
 141                         if( xQueueSend( *( ( xQueueHandle * ) pvParameters ), ( void * ) &usValue, pollqNO_DELAY ) != pdPASS )\r
 142                         {\r
 143                                 /* We should never find the queue full so if we get here there\r
 144                                 has been an error. */\r
 145                                 xError = pdTRUE;\r
 146                         }\r
 147                         else\r
 148                         {\r
 149                                 if( xError == pdFALSE )\r
 150                                 {\r
 151                                         /* If an error has ever been recorded we stop incrementing the\r
 152                                         check variable. */\r
 153                                         portENTER_CRITICAL();\r
 154                                                 xPollingProducerCount++;\r
 155                                         portEXIT_CRITICAL();\r
 156                                 }\r
 157 \r
 158                                 /* Update the value we are going to post next time around. */\r
 159                                 usValue++;\r
 160                         }\r
 161                 }\r
 162 \r
 163                 /* Wait before we start posting again to ensure the consumer runs and\r
 164                 empties the queue. */\r
 165                 vTaskDelay( pollqPRODUCER_DELAY );\r
 166         }\r
 167 }  /*lint !e818 Function prototype must conform to API. */\r
 168 /*-----------------------------------------------------------*/\r
 169 \r
 170 static portTASK_FUNCTION( vPolledQueueConsumer, pvParameters )\r
 171 {\r
 172 unsigned portSHORT usData, usExpectedValue = ( unsigned portSHORT ) 0;\r
 173 signed portBASE_TYPE xError = pdFALSE;\r
 174 \r
 175         for( ;; )\r
 176         {               \r
 177                 /* Loop until the queue is empty. */\r
 178                 while( uxQueueMessagesWaiting( *( ( xQueueHandle * ) pvParameters ) ) )\r
 179                 {\r
 180                         if( xQueueReceive( *( ( xQueueHandle * ) pvParameters ), &usData, pollqNO_DELAY ) == pdPASS )\r
 181                         {\r
 182                                 if( usData != usExpectedValue )\r
 183                                 {\r
 184                                         /* This is not what we expected to receive so an error has\r
 185                                         occurred. */\r
 186                                         xError = pdTRUE;\r
 187 \r
 188                                         /* Catch-up to the value we received so our next expected\r
 189                                         value should again be correct. */\r
 190                                         usExpectedValue = usData;\r
 191                                 }\r
 192                                 else\r
 193                                 {\r
 194                                         if( xError == pdFALSE )\r
 195                                         {\r
 196                                                 /* Only increment the check variable if no errors have\r
 197                                                 occurred. */\r
 198                                                 portENTER_CRITICAL();\r
 199                                                         xPollingConsumerCount++;\r
 200                                                 portEXIT_CRITICAL();\r
 201                                         }\r
 202                                 }\r
 203 \r
 204                                 /* Next time round we would expect the number to be one higher. */\r
 205                                 usExpectedValue++;\r
 206                         }\r
 207                 }\r
 208 \r
 209                 /* Now the queue is empty we block, allowing the producer to place more\r
 210                 items in the queue. */\r
 211                 vTaskDelay( pollqCONSUMER_DELAY );\r
 212         }\r
 213 } /*lint !e818 Function prototype must conform to API. */\r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 /* This is called to check that all the created tasks are still running with no errors. */\r
 217 portBASE_TYPE xArePollingQueuesStillRunning( void )\r
 218 {\r
 219 portBASE_TYPE xReturn;\r
 220 \r
 221         /* Check both the consumer and producer poll count to check they have both\r
 222         been changed since out last trip round.  We do not need a critical section\r
 223         around the check variables as this is called from a higher priority than\r
 224         the other tasks that access the same variables. */\r
 225         if( ( xPollingConsumerCount == pollqINITIAL_VALUE ) ||\r
 226                 ( xPollingProducerCount == pollqINITIAL_VALUE )\r
 227           )\r
 228         {\r
 229                 xReturn = pdFALSE;\r
 230         }\r
 231         else\r
 232         {\r
 233                 xReturn = pdTRUE;\r
 234         }\r
 235 \r
 236         /* Set the check variables back down so we know if they have been\r
 237         incremented the next time around. */\r
 238         xPollingConsumerCount = pollqINITIAL_VALUE;\r
 239         xPollingProducerCount = pollqINITIAL_VALUE;\r
 240 \r
 241         return xReturn;\r
 242 }\r