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

   1 /*
   2         FreeRTOS.org V5.0.0 - Copyright (C) 2003-2008 Richard Barry.
   3
   4         This file is part of the FreeRTOS.org distribution.
   5
   6         FreeRTOS.org is free software; you can redistribute it and/or modify
   7         it under the terms of the GNU General Public License as published by
   8         the Free Software Foundation; either version 2 of the License, or
   9         (at your option) any later version.
  10
  11         FreeRTOS.org is distributed in the hope that it will be useful,
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14         GNU General Public License for more details.
  15
  16         You should have received a copy of the GNU General Public License
  17         along with FreeRTOS.org; if not, write to the Free Software
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19
  20         A special exception to the GPL can be applied should you wish to distribute
  21         a combined work that includes FreeRTOS.org, without being obliged to provide
  22         the source code for any proprietary components.  See the licensing section
  23         of http://www.FreeRTOS.org for full details of how and when the exception
  24         can be applied.
  25
  26     ***************************************************************************
  27     ***************************************************************************
  28     *                                                                         *
  29     * SAVE TIME AND MONEY!  We can port FreeRTOS.org to your own hardware,    *
  30     * and even write all or part of your application on your behalf.          *
  31     * See http://www.OpenRTOS.com for details of the services we provide to   *
  32     * expedite your project.                                                  *
  33     *                                                                         *
  34     ***************************************************************************
  35     ***************************************************************************
  36
  37         Please ensure to read the configuration and relevant port sections of the
  38         online documentation.
  39
  40         http://www.FreeRTOS.org - Documentation, latest information, license and
  41         contact details.
  42
  43         http://www.SafeRTOS.com - A version that is certified for use in safety
  44         critical systems.
  45
  46         http://www.OpenRTOS.com - Commercial support, development, porting,
  47         licensing and training services.
  48 */
  49
  50
  51 /*
  52  * Simple demonstration of the usage of counting semaphore.
  53  */
  54
  55 /* Scheduler include files. */
  56 #include "FreeRTOS.h"
  57 #include "task.h"
  58 #include "semphr.h"
  59
  60 /* Demo program include files. */
  61 #include "countsem.h"
  62
  63 /* The maximum count value that the semaphore used for the demo can hold. */
  64 #define countMAX_COUNT_VALUE    ( 200 )
  65
  66 /* Constants used to indicate whether or not the semaphore should have been
  67 created with its maximum count value, or its minimum count value.  These
  68 numbers are used to ensure that the pointers passed in as the task parameters
  69 are valid. */
  70 #define countSTART_AT_MAX_COUNT ( 0xaa )
  71 #define countSTART_AT_ZERO              ( 0x55 )
  72
  73 /* Two tasks are created for the test.  One uses a semaphore created with its
  74 count value set to the maximum, and one with the count value set to zero. */
  75 #define countNUM_TEST_TASKS             ( 2 )
  76 #define countDONT_BLOCK                 ( 0 )
  77
  78 /*-----------------------------------------------------------*/
  79
  80 /* Flag that will be latched to pdTRUE should any unexpected behaviour be
  81 detected in any of the tasks. */
  82 static volatile portBASE_TYPE xErrorDetected = pdFALSE;
  83
  84 /*-----------------------------------------------------------*/
  85
  86 /*
  87  * The demo task.  This simply counts the semaphore up to its maximum value,
  88  * the counts it back down again.  The result of each semaphore 'give' and
  89  * 'take' is inspected, with an error being flagged if it is found not to be
  90  * the expected result.
  91  */
  92 static void prvCountingSemaphoreTask( void *pvParameters );
  93
  94 /*
  95  * Utility function to increment the semaphore count value up from zero to
  96  * countMAX_COUNT_VALUE.
  97  */
  98 static void prvIncrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter );
  99
 100 /*
 101  * Utility function to decrement the semaphore count value up from
 102  * countMAX_COUNT_VALUE to zero.
 103  */
 104 static void prvDecrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter );
 105
 106 /*-----------------------------------------------------------*/
 107
 108 /* The structure that is passed into the task as the task parameter. */
 109 typedef struct COUNT_SEM_STRUCT
 110 {
 111         /* The semaphore to be used for the demo. */
 112         xSemaphoreHandle xSemaphore;
 113
 114         /* Set to countSTART_AT_MAX_COUNT if the semaphore should be created with
 115         its count value set to its max count value, or countSTART_AT_ZERO if it
 116         should have been created with its count value set to 0. */
 117         unsigned portBASE_TYPE uxExpectedStartCount;
 118
 119         /* Incremented on each cycle of the demo task.  Used to detect a stalled
 120         task. */
 121         unsigned portBASE_TYPE uxLoopCounter;
 122 } xCountSemStruct;
 123
 124 /* Two structures are defined, one is passed to each test task. */
 125 static volatile xCountSemStruct xParameters[ countNUM_TEST_TASKS ];
 126
 127 /*-----------------------------------------------------------*/
 128
 129 void vStartCountingSemaphoreTasks( void )
 130 {
 131         /* Create the semaphores that we are going to use for the test/demo.  The
 132         first should be created such that it starts at its maximum count value,
 133         the second should be created such that it starts with a count value of zero. */
 134         xParameters[ 0 ].xSemaphore = xSemaphoreCreateCounting( countMAX_COUNT_VALUE, countMAX_COUNT_VALUE );
 135         xParameters[ 0 ].uxExpectedStartCount = countSTART_AT_MAX_COUNT;
 136         xParameters[ 0 ].uxLoopCounter = 0;
 137
 138         xParameters[ 1 ].xSemaphore = xSemaphoreCreateCounting( countMAX_COUNT_VALUE, 0 );
 139         xParameters[ 1 ].uxExpectedStartCount = 0;
 140         xParameters[ 1 ].uxLoopCounter = 0;
 141 \r
 142         /* vQueueAddToRegistry() adds the semaphore to the registry, if one is\r
 143         in use.  The registry is provided as a means for kernel aware \r
 144         debuggers to locate semaphores and has no purpose if a kernel aware debugger\r
 145         is not being used.  The call to vQueueAddToRegistry() will be removed\r
 146         by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is \r
 147         defined to be less than 1. */\r
 148         vQueueAddToRegistry( ( xQueueHandle ) xParameters[ 0 ].xSemaphore, ( signed portCHAR * ) "Counting_Sem_1" );\r
 149         vQueueAddToRegistry( ( xQueueHandle ) xParameters[ 1 ].xSemaphore, ( signed portCHAR * ) "Counting_Sem_2" );\r
 150 \r
 151
 152         /* Were the semaphores created? */
 153         if( ( xParameters[ 0 ].xSemaphore != NULL ) || ( xParameters[ 1 ].xSemaphore != NULL ) )
 154         {
 155                 /* Create the demo tasks, passing in the semaphore to use as the parameter. */
 156                 xTaskCreate( prvCountingSemaphoreTask, ( signed portCHAR * ) "CNT1", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 0 ] ), tskIDLE_PRIORITY, NULL );
 157                 xTaskCreate( prvCountingSemaphoreTask, ( signed portCHAR * ) "CNT2", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 1 ] ), tskIDLE_PRIORITY, NULL );
 158         }
 159 }
 160 /*-----------------------------------------------------------*/
 161
 162 static void prvDecrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter )
 163 {
 164 unsigned portBASE_TYPE ux;
 165
 166         /* If the semaphore count is at its maximum then we should not be able to
 167         'give' the semaphore. */
 168         if( xSemaphoreGive( xSemaphore ) == pdPASS )
 169         {
 170                 xErrorDetected = pdTRUE;
 171         }
 172
 173         /* We should be able to 'take' the semaphore countMAX_COUNT_VALUE times. */
 174         for( ux = 0; ux < countMAX_COUNT_VALUE; ux++ )
 175         {
 176                 if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) != pdPASS )
 177                 {
 178                         /* We expected to be able to take the semaphore. */
 179                         xErrorDetected = pdTRUE;
 180                 }
 181
 182                 ( *puxLoopCounter )++;
 183         }
 184
 185         #if configUSE_PREEMPTION == 0
 186                 taskYIELD();
 187         #endif
 188
 189         /* If the semaphore count is zero then we should not be able to 'take'
 190         the semaphore. */
 191         if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) == pdPASS )
 192         {
 193                 xErrorDetected = pdTRUE;
 194         }
 195 }
 196 /*-----------------------------------------------------------*/
 197
 198 static void prvIncrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter )
 199 {
 200 unsigned portBASE_TYPE ux;
 201
 202         /* If the semaphore count is zero then we should not be able to 'take'
 203         the semaphore. */
 204         if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) == pdPASS )
 205         {
 206                 xErrorDetected = pdTRUE;
 207         }
 208
 209         /* We should be able to 'give' the semaphore countMAX_COUNT_VALUE times. */
 210         for( ux = 0; ux < countMAX_COUNT_VALUE; ux++ )
 211         {
 212                 if( xSemaphoreGive( xSemaphore ) != pdPASS )
 213                 {
 214                         /* We expected to be able to take the semaphore. */
 215                         xErrorDetected = pdTRUE;
 216                 }
 217
 218                 ( *puxLoopCounter )++;
 219         }
 220
 221         #if configUSE_PREEMPTION == 0
 222                 taskYIELD();
 223         #endif
 224
 225         /* If the semaphore count is at its maximum then we should not be able to
 226         'give' the semaphore. */
 227         if( xSemaphoreGive( xSemaphore ) == pdPASS )
 228         {
 229                 xErrorDetected = pdTRUE;
 230         }
 231 }
 232 /*-----------------------------------------------------------*/
 233
 234 static void prvCountingSemaphoreTask( void *pvParameters )
 235 {
 236 xCountSemStruct *pxParameter;
 237
 238         #ifdef USE_STDIO
 239         void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );
 240
 241                 const portCHAR * const pcTaskStartMsg = "Counting semaphore demo started.\r\n";
 242
 243                 /* Queue a message for printing to say the task has started. */
 244                 vPrintDisplayMessage( &pcTaskStartMsg );
 245         #endif
 246
 247         /* The semaphore to be used was passed as the parameter. */
 248         pxParameter = ( xCountSemStruct * ) pvParameters;
 249
 250         /* Did we expect to find the semaphore already at its max count value, or
 251         at zero? */
 252         if( pxParameter->uxExpectedStartCount == countSTART_AT_MAX_COUNT )
 253         {
 254                 prvDecrementSemaphoreCount( pxParameter->xSemaphore, &( pxParameter->uxLoopCounter ) );
 255         }
 256
 257         /* Now we expect the semaphore count to be 0, so this time there is an
 258         error if we can take the semaphore. */
 259         if( xSemaphoreTake( pxParameter->xSemaphore, 0 ) == pdPASS )
 260         {
 261                 xErrorDetected = pdTRUE;
 262         }
 263
 264         for( ;; )
 265         {
 266                 prvIncrementSemaphoreCount( pxParameter->xSemaphore, &( pxParameter->uxLoopCounter ) );
 267                 prvDecrementSemaphoreCount( pxParameter->xSemaphore, &( pxParameter->uxLoopCounter ) );
 268         }
 269 }
 270 /*-----------------------------------------------------------*/
 271
 272 portBASE_TYPE xAreCountingSemaphoreTasksStillRunning( void )
 273 {
 274 static unsigned portBASE_TYPE uxLastCount0 = 0, uxLastCount1 = 0;
 275 portBASE_TYPE xReturn = pdPASS;
 276
 277         /* Return fail if any 'give' or 'take' did not result in the expected
 278         behaviour. */
 279         if( xErrorDetected != pdFALSE )
 280         {
 281                 xReturn = pdFAIL;
 282         }
 283
 284         /* Return fail if either task is not still incrementing its loop counter. */
 285         if( uxLastCount0 == xParameters[ 0 ].uxLoopCounter )
 286         {
 287                 xReturn = pdFAIL;
 288         }
 289         else
 290         {
 291                 uxLastCount0 = xParameters[ 0 ].uxLoopCounter;
 292         }
 293
 294         if( uxLastCount1 == xParameters[ 1 ].uxLoopCounter )
 295         {
 296                 xReturn = pdFAIL;
 297         }
 298         else
 299         {
 300                 uxLastCount1 = xParameters[ 1 ].uxLoopCounter;
 301         }
 302
 303         return xReturn;
 304 }
 305
 306