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

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 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 \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
  36     kernel.\r
  37 \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
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \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
  65 \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
  69 \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
  73 */\r
  74 \r
  75 /*\r
  76  * Basic task to demonstrate the xQueueOverwrite() function.  See the comments\r
  77  * in the function itself.\r
  78  */\r
  79 \r
  80 /* Scheduler include files. */\r
  81 #include "FreeRTOS.h"\r
  82 #include "task.h"\r
  83 #include "queue.h"\r
  84 \r
  85 /* Demo program include files. */\r
  86 #include "QueueOverwrite.h"\r
  87 \r
  88 /* A block time of 0 just means "don't block". */\r
  89 #define qoDONT_BLOCK            0\r
  90 \r
  91 /* Number of times to overwrite the value in the queue. */\r
  92 #define qoLOOPS                 5\r
  93 \r
  94 /* The task that uses the queue. */\r
  95 static void prvQueueOverwriteTask( void *pvParameters );\r
  96 \r
  97 /* Variable that is incremented on each loop of prvQueueOverwriteTask() provided\r
  98 prvQueueOverwriteTask() has not found any errors. */\r
  99 static unsigned long ulLoopCounter = 0;\r
 100 \r
 101 /* Set to pdFALSE if an error is discovered by the\r
 102 vQueueOverwritePeriodicISRDemo() function. */\r
 103 static portBASE_TYPE xISRTestStatus = pdPASS;\r
 104 \r
 105 /* The queue that is accessed from the ISR.  The queue accessed by the task is\r
 106 created inside the task itself. */\r
 107 static xQueueHandle xISRQueue = NULL;\r
 108 \r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 void vStartQueueOverwriteTask( unsigned portBASE_TYPE uxPriority )\r
 112 {\r
 113 const unsigned portBASE_TYPE uxQueueLength = 1;\r
 114 \r
 115         /* Create the queue used by the ISR.  xQueueOverwriteFromISR() should only\r
 116         be used on queues that have a length of 1. */\r
 117         xISRQueue = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( unsigned long ) );\r
 118 \r
 119         /* Create the test task.  The queue used by the test task is created inside\r
 120         the task itself. */\r
 121         xTaskCreate( prvQueueOverwriteTask, ( signed char * ) "QOver", configMINIMAL_STACK_SIZE, NULL, uxPriority, ( xTaskHandle * ) NULL );\r
 122 }\r
 123 /*-----------------------------------------------------------*/\r
 124 \r
 125 static void prvQueueOverwriteTask( void *pvParameters )\r
 126 {\r
 127 xQueueHandle xTaskQueue;\r
 128 const unsigned portBASE_TYPE uxQueueLength = 1;\r
 129 unsigned long ulValue, ulStatus = pdPASS, x;\r
 130 \r
 131         /* The parameter is not used. */\r
 132         ( void ) pvParameters;\r
 133 \r
 134         /* Create the queue.  xQueueOverwrite() should only be used on queues that\r
 135         have a length of 1. */\r
 136         xTaskQueue = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( unsigned long ) );\r
 137         configASSERT( xTaskQueue );\r
 138 \r
 139         for( ;; )\r
 140         {\r
 141                 /* The queue is empty.  Writing to the queue then reading from the queue\r
 142                 should return the item written. */\r
 143                 ulValue = 10;\r
 144                 xQueueOverwrite( xTaskQueue, &ulValue );\r
 145 \r
 146                 ulValue = 0;\r
 147                 xQueueReceive( xTaskQueue, &ulValue, qoDONT_BLOCK );\r
 148 \r
 149                 if( ulValue != 10 )\r
 150                 {\r
 151                         ulStatus = pdFAIL;\r
 152                 }\r
 153 \r
 154                 /* Now try writing to the queue several times.  Each time the value\r
 155                 in the queue should get overwritten. */\r
 156                 for( x = 0; x < qoLOOPS; x++ )\r
 157                 {\r
 158                         /* Write to the queue. */\r
 159                         xQueueOverwrite( xTaskQueue, &x );\r
 160 \r
 161                         /* Check the value in the queue is that written, even though the\r
 162                         queue was not necessarily empty. */\r
 163                         xQueuePeek( xTaskQueue, &ulValue, qoDONT_BLOCK );\r
 164                         if( ulValue != x )\r
 165                         {\r
 166                                 ulStatus = pdFAIL;\r
 167                         }\r
 168 \r
 169                         /* There should always be one item in the queue. */\r
 170                         if( uxQueueMessagesWaiting( xTaskQueue ) != uxQueueLength )\r
 171                         {\r
 172                                 ulStatus = pdFAIL;\r
 173                         }\r
 174                 }\r
 175 \r
 176                 /* Empty the queue again. */\r
 177                 xQueueReceive( xTaskQueue, &ulValue, qoDONT_BLOCK );\r
 178 \r
 179                 if( uxQueueMessagesWaiting( xTaskQueue ) != 0 )\r
 180                 {\r
 181                         ulStatus = pdFAIL;\r
 182                 }\r
 183 \r
 184                 if( ulStatus != pdFAIL )\r
 185                 {\r
 186                         /* Increment a counter to show this task is still running without\r
 187                         error. */\r
 188                         ulLoopCounter++;\r
 189                 }\r
 190         }\r
 191 }\r
 192 /*-----------------------------------------------------------*/\r
 193 \r
 194 portBASE_TYPE xIsQueueOverwriteTaskStillRunning( void )\r
 195 {\r
 196 portBASE_TYPE xReturn;\r
 197 \r
 198         if( xISRTestStatus != pdPASS )\r
 199         {\r
 200                 xReturn = pdFAIL;\r
 201         }\r
 202         else if( ulLoopCounter > 0 )\r
 203         {\r
 204                 xReturn = pdPASS;\r
 205         }\r
 206         else\r
 207         {\r
 208                 /* The task has either stalled of discovered an error. */\r
 209                 xReturn = pdFAIL;\r
 210         }\r
 211 \r
 212         ulLoopCounter = 0;\r
 213 \r
 214         return xReturn;\r
 215 }\r
 216 /*-----------------------------------------------------------*/\r
 217 \r
 218 void vQueueOverwritePeriodicISRDemo( void )\r
 219 {\r
 220 static unsigned long ulCallCount = 0;\r
 221 const unsigned long ulTx1 = 10UL, ulTx2 = 20UL, ulNumberOfSwitchCases = 3UL;\r
 222 unsigned long ulRx;\r
 223 \r
 224         /* This function should be called from an interrupt, such as the tick hook\r
 225         function vApplicationTickHook(). */\r
 226 \r
 227         configASSERT( xISRQueue );\r
 228 \r
 229         switch( ulCallCount )\r
 230         {\r
 231                 case 0:\r
 232                         /* The queue is empty.  Write ulTx1 to the queue.  In this demo the\r
 233                         last parameter is not used because there are no tasks blocked on\r
 234                         this queue. */\r
 235                         xQueueOverwriteFromISR( xISRQueue, &ulTx1, NULL );\r
 236 \r
 237                         /* Peek the queue to check it holds the expected value. */\r
 238                         xQueuePeekFromISR( xISRQueue, &ulRx );\r
 239                         if( ulRx != ulTx1 )\r
 240                         {\r
 241                                 xISRTestStatus = pdFAIL;\r
 242                         }\r
 243                         break;\r
 244 \r
 245                 case 1:\r
 246                         /* The queue already holds ulTx1.  Overwrite the value in the queue\r
 247                         with ulTx2. */\r
 248                         xQueueOverwriteFromISR( xISRQueue, &ulTx2, NULL );                      \r
 249                         break;\r
 250 \r
 251                 case 2:\r
 252                         /* Read from the queue to empty the queue again.  The value read\r
 253                         should be ulTx2. */\r
 254                         xQueueReceiveFromISR( xISRQueue, &ulRx, NULL );\r
 255 \r
 256                         if( ulRx != ulTx2 )\r
 257                         {\r
 258                                 xISRTestStatus = pdFAIL;\r
 259                         }\r
 260                         break;\r
 261         }\r
 262 \r
 263         /* Run the next case in the switch statement above next time this function\r
 264         is called. */\r
 265         ulCallCount++;\r
 266 \r
 267         if( ulCallCount >= ulNumberOfSwitchCases )\r
 268         {\r
 269                 /* Go back to the start. */\r
 270                 ulCallCount = 0;\r
 271         }\r
 272 }\r
 273 \r