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 /*-----------------------------------------------------------*/\r
 102 \r
 103 void vStartQueueOverwriteTask( unsigned portBASE_TYPE uxPriority )\r
 104 {\r
 105         /* Create the test task. */\r
 106         xTaskCreate( prvQueueOverwriteTask, ( signed char * ) "QOver", configMINIMAL_STACK_SIZE, NULL, uxPriority, ( xTaskHandle * ) NULL );\r
 107 }\r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 static void prvQueueOverwriteTask( void *pvParameters )\r
 111 {\r
 112 xQueueHandle xQueue;\r
 113 const unsigned portBASE_TYPE uxQueueLength = 1;\r
 114 unsigned long ulValue, ulStatus = pdPASS, x;\r
 115 \r
 116         /* The parameter is not used. */\r
 117         ( void ) pvParameters;\r
 118 \r
 119         /* Create the queue.  xQueueOverwrite() should only be used on queues that\r
 120         have a length of 1. */\r
 121         xQueue = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( unsigned long ) );\r
 122         configASSERT( xQueue );\r
 123 \r
 124         for( ;; )\r
 125         {\r
 126                 /* The queue is empty.  Writing to the queue then reading from the queue\r
 127                 should return the item written. */\r
 128                 ulValue = 10;\r
 129                 xQueueOverwrite( xQueue, &ulValue );\r
 130 \r
 131                 ulValue = 0;\r
 132                 xQueueReceive( xQueue, &ulValue, qoDONT_BLOCK );\r
 133 \r
 134                 if( ulValue != 10 )\r
 135                 {\r
 136                         ulStatus = pdFAIL;\r
 137                 }\r
 138 \r
 139                 /* Now try writing to the queue several times.  Each time the value\r
 140                 in the queue should get overwritten. */\r
 141                 for( x = 0; x < qoLOOPS; x++ )\r
 142                 {\r
 143                         /* Write to the queue. */\r
 144                         xQueueOverwrite( xQueue, &x );\r
 145 \r
 146                         /* Check the value in the queue is that written, even though the\r
 147                         queue was not necessarily empty. */\r
 148                         xQueuePeek( xQueue, &ulValue, qoDONT_BLOCK );\r
 149                         if( ulValue != x )\r
 150                         {\r
 151                                 ulStatus = pdFAIL;\r
 152                         }\r
 153 \r
 154                         /* There should always be one item in the queue. */\r
 155                         if( uxQueueMessagesWaiting( xQueue ) != uxQueueLength )\r
 156                         {\r
 157                                 ulStatus = pdFAIL;\r
 158                         }\r
 159                 }\r
 160 \r
 161                 /* Empty the queue again. */\r
 162                 xQueueReceive( xQueue, &ulValue, qoDONT_BLOCK );\r
 163 \r
 164                 if( uxQueueMessagesWaiting( xQueue ) != 0 )\r
 165                 {\r
 166                         ulStatus = pdFAIL;\r
 167                 }\r
 168 \r
 169                 if( ulStatus != pdFAIL )\r
 170                 {\r
 171                         /* Increment a counter to show this task is still running without\r
 172                         error. */\r
 173                         ulLoopCounter++;\r
 174                 }\r
 175         }\r
 176 }\r
 177 /*-----------------------------------------------------------*/\r
 178 \r
 179 portBASE_TYPE xIsQueueOverwriteTaskStillRunning( void )\r
 180 {\r
 181 portBASE_TYPE xReturn;\r
 182 \r
 183         if( ulLoopCounter > 0 )\r
 184         {\r
 185                 xReturn = pdPASS;\r
 186         }\r
 187         else\r
 188         {\r
 189                 /* The task has either stalled of discovered an error. */\r
 190                 xReturn = pdFAIL;\r
 191         }\r
 192 \r
 193         ulLoopCounter = 0;\r
 194 \r
 195         return xReturn;\r
 196 }\r
 197 \r