begriffs open source - freertos/blob - Demo/Common/Minimal/countsem.c

   1 /*\r
   2         FreeRTOS.org V5.1.2 - Copyright (C) 2003-2009 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     * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  30         *                                                                         *\r
  31         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  32         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  33         * explains numerous examples that are written using the FreeRTOS API.     *\r
  34         * Full source code for all the examples is provided in an accompanying    *\r
  35         * .zip file.                                                              *\r
  36     *                                                                         *\r
  37     ***************************************************************************\r
  38     ***************************************************************************\r
  39 \r
  40         Please ensure to read the configuration and relevant port sections of the\r
  41         online documentation.\r
  42 \r
  43         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  44         contact details.\r
  45 \r
  46         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  47         critical systems.\r
  48 \r
  49         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  50         licensing and training services.\r
  51 */\r
  52 \r
  53 \r
  54 /* \r
  55  * Simple demonstration of the usage of counting semaphore.\r
  56  */\r
  57 \r
  58 /* Scheduler include files. */\r
  59 #include "FreeRTOS.h"\r
  60 #include "task.h"\r
  61 #include "semphr.h"\r
  62 \r
  63 /* Demo program include files. */\r
  64 #include "countsem.h"\r
  65 \r
  66 /* The maximum count value that the semaphore used for the demo can hold. */\r
  67 #define countMAX_COUNT_VALUE    ( 200 )\r
  68 \r
  69 /* Constants used to indicate whether or not the semaphore should have been\r
  70 created with its maximum count value, or its minimum count value.  These \r
  71 numbers are used to ensure that the pointers passed in as the task parameters\r
  72 are valid. */\r
  73 #define countSTART_AT_MAX_COUNT ( 0xaa )\r
  74 #define countSTART_AT_ZERO              ( 0x55 )\r
  75 \r
  76 /* Two tasks are created for the test.  One uses a semaphore created with its\r
  77 count value set to the maximum, and one with the count value set to zero. */\r
  78 #define countNUM_TEST_TASKS             ( 2 )\r
  79 #define countDONT_BLOCK                 ( 0 )\r
  80 \r
  81 /*-----------------------------------------------------------*/\r
  82 \r
  83 /* Flag that will be latched to pdTRUE should any unexpected behaviour be\r
  84 detected in any of the tasks. */\r
  85 static volatile portBASE_TYPE xErrorDetected = pdFALSE;\r
  86 \r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 /*\r
  90  * The demo task.  This simply counts the semaphore up to its maximum value,\r
  91  * the counts it back down again.  The result of each semaphore 'give' and\r
  92  * 'take' is inspected, with an error being flagged if it is found not to be\r
  93  * the expected result.\r
  94  */\r
  95 static void prvCountingSemaphoreTask( void *pvParameters );\r
  96 \r
  97 /*\r
  98  * Utility function to increment the semaphore count value up from zero to\r
  99  * countMAX_COUNT_VALUE.\r
 100  */\r
 101 static void prvIncrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter );\r
 102 \r
 103 /*\r
 104  * Utility function to decrement the semaphore count value up from \r
 105  * countMAX_COUNT_VALUE to zero.\r
 106  */\r
 107 static void prvDecrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter );\r
 108 \r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 /* The structure that is passed into the task as the task parameter. */\r
 112 typedef struct COUNT_SEM_STRUCT\r
 113 {\r
 114         /* The semaphore to be used for the demo. */\r
 115         xSemaphoreHandle xSemaphore;\r
 116 \r
 117         /* Set to countSTART_AT_MAX_COUNT if the semaphore should be created with\r
 118         its count value set to its max count value, or countSTART_AT_ZERO if it\r
 119         should have been created with its count value set to 0. */\r
 120         unsigned portBASE_TYPE uxExpectedStartCount;    \r
 121 \r
 122         /* Incremented on each cycle of the demo task.  Used to detect a stalled\r
 123         task. */\r
 124         unsigned portBASE_TYPE uxLoopCounter;                   \r
 125 } xCountSemStruct;\r
 126 \r
 127 /* Two structures are defined, one is passed to each test task. */\r
 128 static volatile xCountSemStruct xParameters[ countNUM_TEST_TASKS ];\r
 129 \r
 130 /*-----------------------------------------------------------*/\r
 131 \r
 132 void vStartCountingSemaphoreTasks( void )\r
 133 {\r
 134         /* Create the semaphores that we are going to use for the test/demo.  The\r
 135         first should be created such that it starts at its maximum count value,\r
 136         the second should be created such that it starts with a count value of zero. */\r
 137         xParameters[ 0 ].xSemaphore = xSemaphoreCreateCounting( countMAX_COUNT_VALUE, countMAX_COUNT_VALUE );\r
 138         xParameters[ 0 ].uxExpectedStartCount = countSTART_AT_MAX_COUNT;\r
 139         xParameters[ 0 ].uxLoopCounter = 0;\r
 140 \r
 141         xParameters[ 1 ].xSemaphore = xSemaphoreCreateCounting( countMAX_COUNT_VALUE, 0 );\r
 142         xParameters[ 1 ].uxExpectedStartCount = 0;\r
 143         xParameters[ 1 ].uxLoopCounter = 0;\r
 144 \r
 145         /* vQueueAddToRegistry() adds the semaphore to the registry, if one is\r
 146         in use.  The registry is provided as a means for kernel aware \r
 147         debuggers to locate semaphores and has no purpose if a kernel aware debugger\r
 148         is not being used.  The call to vQueueAddToRegistry() will be removed\r
 149         by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is \r
 150         defined to be less than 1. */\r
 151         vQueueAddToRegistry( ( xQueueHandle ) xParameters[ 0 ].xSemaphore, ( signed portCHAR * ) "Counting_Sem_1" );\r
 152         vQueueAddToRegistry( ( xQueueHandle ) xParameters[ 1 ].xSemaphore, ( signed portCHAR * ) "Counting_Sem_2" );\r
 153 \r
 154 \r
 155         /* Were the semaphores created? */\r
 156         if( ( xParameters[ 0 ].xSemaphore != NULL ) || ( xParameters[ 1 ].xSemaphore != NULL ) )\r
 157         {\r
 158                 /* Create the demo tasks, passing in the semaphore to use as the parameter. */\r
 159                 xTaskCreate( prvCountingSemaphoreTask, ( signed portCHAR * ) "CNT1", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 0 ] ), tskIDLE_PRIORITY, NULL );\r
 160                 xTaskCreate( prvCountingSemaphoreTask, ( signed portCHAR * ) "CNT2", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 1 ] ), tskIDLE_PRIORITY, NULL );              \r
 161         }\r
 162 }\r
 163 /*-----------------------------------------------------------*/\r
 164 \r
 165 static void prvDecrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter )\r
 166 {\r
 167 unsigned portBASE_TYPE ux;\r
 168 \r
 169         /* If the semaphore count is at its maximum then we should not be able to\r
 170         'give' the semaphore. */\r
 171         if( xSemaphoreGive( xSemaphore ) == pdPASS )\r
 172         {\r
 173                 xErrorDetected = pdTRUE;\r
 174         }\r
 175 \r
 176         /* We should be able to 'take' the semaphore countMAX_COUNT_VALUE times. */\r
 177         for( ux = 0; ux < countMAX_COUNT_VALUE; ux++ )\r
 178         {\r
 179                 if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) != pdPASS )\r
 180                 {\r
 181                         /* We expected to be able to take the semaphore. */\r
 182                         xErrorDetected = pdTRUE;\r
 183                 }\r
 184 \r
 185                 ( *puxLoopCounter )++;\r
 186         }\r
 187 \r
 188         #if configUSE_PREEMPTION == 0\r
 189                 taskYIELD();\r
 190         #endif\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 /*-----------------------------------------------------------*/\r
 200 \r
 201 static void prvIncrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter )\r
 202 {\r
 203 unsigned portBASE_TYPE ux;\r
 204 \r
 205         /* If the semaphore count is zero then we should not be able to 'take' \r
 206         the semaphore. */\r
 207         if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) == pdPASS )\r
 208         {\r
 209                 xErrorDetected = pdTRUE;\r
 210         }\r
 211 \r
 212         /* We should be able to 'give' the semaphore countMAX_COUNT_VALUE times. */\r
 213         for( ux = 0; ux < countMAX_COUNT_VALUE; ux++ )\r
 214         {\r
 215                 if( xSemaphoreGive( xSemaphore ) != pdPASS )\r
 216                 {\r
 217                         /* We expected to be able to take the semaphore. */\r
 218                         xErrorDetected = pdTRUE;\r
 219                 }\r
 220 \r
 221                 ( *puxLoopCounter )++;\r
 222         }\r
 223 \r
 224         #if configUSE_PREEMPTION == 0\r
 225                 taskYIELD();\r
 226         #endif\r
 227 \r
 228         /* If the semaphore count is at its maximum then we should not be able to\r
 229         'give' the semaphore. */\r
 230         if( xSemaphoreGive( xSemaphore ) == pdPASS )\r
 231         {\r
 232                 xErrorDetected = pdTRUE;\r
 233         }\r
 234 }\r
 235 /*-----------------------------------------------------------*/\r
 236 \r
 237 static void prvCountingSemaphoreTask( void *pvParameters )\r
 238 {\r
 239 xCountSemStruct *pxParameter;\r
 240 \r
 241         #ifdef USE_STDIO\r
 242         void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );\r
 243         \r
 244                 const portCHAR * const pcTaskStartMsg = "Counting semaphore demo started.\r\n";\r
 245 \r
 246                 /* Queue a message for printing to say the task has started. */\r
 247                 vPrintDisplayMessage( &pcTaskStartMsg );\r
 248         #endif\r
 249 \r
 250         /* The semaphore to be used was passed as the parameter. */\r
 251         pxParameter = ( xCountSemStruct * ) pvParameters;\r
 252 \r
 253         /* Did we expect to find the semaphore already at its max count value, or\r
 254         at zero? */\r
 255         if( pxParameter->uxExpectedStartCount == countSTART_AT_MAX_COUNT )\r
 256         {\r
 257                 prvDecrementSemaphoreCount( pxParameter->xSemaphore, &( pxParameter->uxLoopCounter ) );\r
 258         }\r
 259 \r
 260         /* Now we expect the semaphore count to be 0, so this time there is an\r
 261         error if we can take the semaphore. */\r
 262         if( xSemaphoreTake( pxParameter->xSemaphore, 0 ) == pdPASS )\r
 263         {\r
 264                 xErrorDetected = pdTRUE;\r
 265         }\r
 266 \r
 267         for( ;; )\r
 268         {\r
 269                 prvIncrementSemaphoreCount( pxParameter->xSemaphore, &( pxParameter->uxLoopCounter ) );\r
 270                 prvDecrementSemaphoreCount( pxParameter->xSemaphore, &( pxParameter->uxLoopCounter ) );\r
 271         }\r
 272 }\r
 273 /*-----------------------------------------------------------*/\r
 274 \r
 275 portBASE_TYPE xAreCountingSemaphoreTasksStillRunning( void )\r
 276 {\r
 277 static unsigned portBASE_TYPE uxLastCount0 = 0, uxLastCount1 = 0;\r
 278 portBASE_TYPE xReturn = pdPASS;\r
 279 \r
 280         /* Return fail if any 'give' or 'take' did not result in the expected\r
 281         behaviour. */\r
 282         if( xErrorDetected != pdFALSE )\r
 283         {\r
 284                 xReturn = pdFAIL;\r
 285         }\r
 286 \r
 287         /* Return fail if either task is not still incrementing its loop counter. */\r
 288         if( uxLastCount0 == xParameters[ 0 ].uxLoopCounter )\r
 289         {\r
 290                 xReturn = pdFAIL;\r
 291         }\r
 292         else\r
 293         {\r
 294                 uxLastCount0 = xParameters[ 0 ].uxLoopCounter;\r
 295         }\r
 296 \r
 297         if( uxLastCount1 == xParameters[ 1 ].uxLoopCounter )\r
 298         {\r
 299                 xReturn = pdFAIL;\r
 300         }\r
 301         else\r
 302         {\r
 303                 uxLastCount1 = xParameters[ 1 ].uxLoopCounter;\r
 304         }\r
 305 \r
 306         return xReturn;\r
 307 }\r
 308 \r
 309 \r