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

   1 /*\r
   2         FreeRTOS.org V5.0.0 - 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 /* \r
  52  * Simple demonstration of the usage of counting semaphore.\r
  53  */\r
  54 \r
  55 /* Scheduler include files. */\r
  56 #include "FreeRTOS.h"\r
  57 #include "task.h"\r
  58 #include "semphr.h"\r
  59 \r
  60 /* Demo program include files. */\r
  61 #include "countsem.h"\r
  62 \r
  63 /* The maximum count value that the semaphore used for the demo can hold. */\r
  64 #define countMAX_COUNT_VALUE    ( 200 )\r
  65 \r
  66 /* Constants used to indicate whether or not the semaphore should have been\r
  67 created with its maximum count value, or its minimum count value.  These \r
  68 numbers are used to ensure that the pointers passed in as the task parameters\r
  69 are valid. */\r
  70 #define countSTART_AT_MAX_COUNT ( 0xaa )\r
  71 #define countSTART_AT_ZERO              ( 0x55 )\r
  72 \r
  73 /* Two tasks are created for the test.  One uses a semaphore created with its\r
  74 count value set to the maximum, and one with the count value set to zero. */\r
  75 #define countNUM_TEST_TASKS             ( 2 )\r
  76 #define countDONT_BLOCK                 ( 0 )\r
  77 \r
  78 /*-----------------------------------------------------------*/\r
  79 \r
  80 /* Flag that will be latched to pdTRUE should any unexpected behaviour be\r
  81 detected in any of the tasks. */\r
  82 static portBASE_TYPE xErrorDetected = pdFALSE;\r
  83 \r
  84 /*-----------------------------------------------------------*/\r
  85 \r
  86 /*\r
  87  * The demo task.  This simply counts the semaphore up to its maximum value,\r
  88  * the counts it back down again.  The result of each semaphore 'give' and\r
  89  * 'take' is inspected, with an error being flagged if it is found not to be\r
  90  * the expected result.\r
  91  */\r
  92 static void prvCountingSemaphoreTask( void *pvParameters );\r
  93 \r
  94 /*\r
  95  * Utility function to increment the semaphore count value up from zero to\r
  96  * countMAX_COUNT_VALUE.\r
  97  */\r
  98 static void prvIncrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter );\r
  99 \r
 100 /*\r
 101  * Utility function to decrement the semaphore count value up from \r
 102  * countMAX_COUNT_VALUE to zero.\r
 103  */\r
 104 static void prvDecrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter );\r
 105 \r
 106 /*-----------------------------------------------------------*/\r
 107 \r
 108 /* The structure that is passed into the task as the task parameter. */\r
 109 typedef struct COUNT_SEM_STRUCT\r
 110 {\r
 111         /* The semaphore to be used for the demo. */\r
 112         xSemaphoreHandle xSemaphore;\r
 113 \r
 114         /* Set to countSTART_AT_MAX_COUNT if the semaphore should be created with\r
 115         its count value set to its max count value, or countSTART_AT_ZERO if it\r
 116         should have been created with its count value set to 0. */\r
 117         unsigned portBASE_TYPE uxExpectedStartCount;    \r
 118 \r
 119         /* Incremented on each cycle of the demo task.  Used to detect a stalled\r
 120         task. */\r
 121         unsigned portBASE_TYPE uxLoopCounter;                   \r
 122 } xCountSemStruct;\r
 123 \r
 124 /* Two structures are defined, one is passed to each test task. */\r
 125 static xCountSemStruct xParameters[ countNUM_TEST_TASKS ];\r
 126 \r
 127 /*-----------------------------------------------------------*/\r
 128 \r
 129 void vStartCountingSemaphoreTasks( void )\r
 130 {\r
 131         /* Create the semaphores that we are going to use for the test/demo.  The\r
 132         first should be created such that it starts at its maximum count value,\r
 133         the second should be created such that it starts with a count value of zero. */\r
 134         xParameters[ 0 ].xSemaphore = xSemaphoreCreateCounting( countMAX_COUNT_VALUE, countMAX_COUNT_VALUE );\r
 135         xParameters[ 0 ].uxExpectedStartCount = countSTART_AT_MAX_COUNT;\r
 136         xParameters[ 0 ].uxLoopCounter = 0;\r
 137 \r
 138         xParameters[ 1 ].xSemaphore = xSemaphoreCreateCounting( countMAX_COUNT_VALUE, 0 );\r
 139         xParameters[ 1 ].uxExpectedStartCount = 0;\r
 140         xParameters[ 1 ].uxLoopCounter = 0;\r
 141 \r
 142         /* Were the semaphores created? */\r
 143         if( ( xParameters[ 0 ].xSemaphore != NULL ) || ( xParameters[ 1 ].xSemaphore != NULL ) )\r
 144         {\r
 145                 /* Create the demo tasks, passing in the semaphore to use as the parameter. */\r
 146                 xTaskCreate( prvCountingSemaphoreTask, ( signed portCHAR * ) "CNT1", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 0 ] ), tskIDLE_PRIORITY, NULL );\r
 147                 xTaskCreate( prvCountingSemaphoreTask, ( signed portCHAR * ) "CNT2", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 1 ] ), tskIDLE_PRIORITY, NULL );              \r
 148         }\r
 149 }\r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 static void prvDecrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter )\r
 153 {\r
 154 unsigned portBASE_TYPE ux;\r
 155 \r
 156         /* If the semaphore count is at its maximum then we should not be able to\r
 157         'give' the semaphore. */\r
 158         if( xSemaphoreGive( xSemaphore ) == pdPASS )\r
 159         {\r
 160                 xErrorDetected = pdTRUE;\r
 161         }\r
 162 \r
 163         /* We should be able to 'take' the semaphore countMAX_COUNT_VALUE times. */\r
 164         for( ux = 0; ux < countMAX_COUNT_VALUE; ux++ )\r
 165         {\r
 166                 if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) != pdPASS )\r
 167                 {\r
 168                         /* We expected to be able to take the semaphore. */\r
 169                         xErrorDetected = pdTRUE;\r
 170                 }\r
 171 \r
 172                 ( *puxLoopCounter )++;\r
 173         }\r
 174 \r
 175         #if configUSE_PREEMPTION == 0\r
 176                 taskYIELD();\r
 177         #endif\r
 178 \r
 179         /* If the semaphore count is zero then we should not be able to 'take' \r
 180         the semaphore. */\r
 181         if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) == pdPASS )\r
 182         {\r
 183                 xErrorDetected = pdTRUE;\r
 184         }\r
 185 }\r
 186 /*-----------------------------------------------------------*/\r
 187 \r
 188 static void prvIncrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter )\r
 189 {\r
 190 unsigned portBASE_TYPE ux;\r
 191 \r
 192         /* If the semaphore count is zero then we should not be able to 'take' \r
 193         the semaphore. */\r
 194         if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) == pdPASS )\r
 195         {\r
 196                 xErrorDetected = pdTRUE;\r
 197         }\r
 198 \r
 199         /* We should be able to 'give' the semaphore countMAX_COUNT_VALUE times. */\r
 200         for( ux = 0; ux < countMAX_COUNT_VALUE; ux++ )\r
 201         {\r
 202                 if( xSemaphoreGive( xSemaphore ) != pdPASS )\r
 203                 {\r
 204                         /* We expected to be able to take the semaphore. */\r
 205                         xErrorDetected = pdTRUE;\r
 206                 }\r
 207 \r
 208                 ( *puxLoopCounter )++;\r
 209         }\r
 210 \r
 211         #if configUSE_PREEMPTION == 0\r
 212                 taskYIELD();\r
 213         #endif\r
 214 \r
 215         /* If the semaphore count is at its maximum then we should not be able to\r
 216         'give' the semaphore. */\r
 217         if( xSemaphoreGive( xSemaphore ) == pdPASS )\r
 218         {\r
 219                 xErrorDetected = pdTRUE;\r
 220         }\r
 221 }\r
 222 /*-----------------------------------------------------------*/\r
 223 \r
 224 static void prvCountingSemaphoreTask( void *pvParameters )\r
 225 {\r
 226 xCountSemStruct *pxParameter;\r
 227 \r
 228         #ifdef USE_STDIO\r
 229         void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );\r
 230         \r
 231                 const portCHAR * const pcTaskStartMsg = "Counting semaphore demo started.\r\n";\r
 232 \r
 233                 /* Queue a message for printing to say the task has started. */\r
 234                 vPrintDisplayMessage( &pcTaskStartMsg );\r
 235         #endif\r
 236 \r
 237         /* The semaphore to be used was passed as the parameter. */\r
 238         pxParameter = ( xCountSemStruct * ) pvParameters;\r
 239 \r
 240         /* Did we expect to find the semaphore already at its max count value, or\r
 241         at zero? */\r
 242         if( pxParameter->uxExpectedStartCount == countSTART_AT_MAX_COUNT )\r
 243         {\r
 244                 prvDecrementSemaphoreCount( pxParameter->xSemaphore, &( pxParameter->uxLoopCounter ) );\r
 245         }\r
 246 \r
 247         /* Now we expect the semaphore count to be 0, so this time there is an\r
 248         error if we can take the semaphore. */\r
 249         if( xSemaphoreTake( pxParameter->xSemaphore, 0 ) == pdPASS )\r
 250         {\r
 251                 xErrorDetected = pdTRUE;\r
 252         }\r
 253 \r
 254         for( ;; )\r
 255         {\r
 256                 prvIncrementSemaphoreCount( pxParameter->xSemaphore, &( pxParameter->uxLoopCounter ) );\r
 257                 prvDecrementSemaphoreCount( pxParameter->xSemaphore, &( pxParameter->uxLoopCounter ) );\r
 258         }\r
 259 }\r
 260 /*-----------------------------------------------------------*/\r
 261 \r
 262 portBASE_TYPE xAreCountingSemaphoreTasksStillRunning( void )\r
 263 {\r
 264 static unsigned portBASE_TYPE uxLastCount0 = 0, uxLastCount1 = 0;\r
 265 portBASE_TYPE xReturn = pdPASS;\r
 266 \r
 267         /* Return fail if any 'give' or 'take' did not result in the expected\r
 268         behaviour. */\r
 269         if( xErrorDetected != pdFALSE )\r
 270         {\r
 271                 xReturn = pdFAIL;\r
 272         }\r
 273 \r
 274         /* Return fail if either task is not still incrementing its loop counter. */\r
 275         if( uxLastCount0 == xParameters[ 0 ].uxLoopCounter )\r
 276         {\r
 277                 xReturn = pdFAIL;\r
 278         }\r
 279         else\r
 280         {\r
 281                 uxLastCount0 = xParameters[ 0 ].uxLoopCounter;\r
 282         }\r
 283 \r
 284         if( uxLastCount1 == xParameters[ 1 ].uxLoopCounter )\r
 285         {\r
 286                 xReturn = pdFAIL;\r
 287         }\r
 288         else\r
 289         {\r
 290                 uxLastCount1 = xParameters[ 1 ].uxLoopCounter;\r
 291         }\r
 292 \r
 293         return xReturn;\r
 294 }\r
 295 \r
 296 \r