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

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