git.sur5r.net Git - freertos/blob - Demo/Common/Full/semtest.c

   1 /*\r
   2     FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43     \r
  44     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /**\r
  68  * Creates two sets of two tasks.  The tasks within a set share a variable, access \r
  69  * to which is guarded by a semaphore.\r
  70  * \r
  71  * Each task starts by attempting to obtain the semaphore.  On obtaining a \r
  72  * semaphore a task checks to ensure that the guarded variable has an expected \r
  73  * value.  It then clears the variable to zero before counting it back up to the \r
  74  * expected value in increments of 1.  After each increment the variable is checked \r
  75  * to ensure it contains the value to which it was just set. When the starting \r
  76  * value is again reached the task releases the semaphore giving the other task in \r
  77  * the set a chance to do exactly the same thing.  The starting value is high \r
  78  * enough to ensure that a tick is likely to occur during the incrementing loop.\r
  79  *\r
  80  * An error is flagged if at any time during the process a shared variable is \r
  81  * found to have a value other than that expected.  Such an occurrence would \r
  82  * suggest an error in the mutual exclusion mechanism by which access to the \r
  83  * variable is restricted.\r
  84  *\r
  85  * The first set of two tasks poll their semaphore.  The second set use blocking \r
  86  * calls.\r
  87  *\r
  88  * \page SemTestC semtest.c\r
  89  * \ingroup DemoFiles\r
  90  * <HR>\r
  91  */\r
  92 \r
  93 /*\r
  94 Changes from V1.2.0:\r
  95 \r
  96         + The tasks that operate at the idle priority now use a lower expected\r
  97           count than those running at a higher priority.  This prevents the low\r
  98           priority tasks from signaling an error because they have not been \r
  99           scheduled enough time for each of them to count the shared variable to\r
 100           the high value.\r
 101 \r
 102 Changes from V2.0.0\r
 103 \r
 104         + Delay periods are now specified using variables and constants of\r
 105           portTickType rather than unsigned long.\r
 106 \r
 107 Changes from V2.1.1\r
 108 \r
 109         + The stack size now uses configMINIMAL_STACK_SIZE.\r
 110         + String constants made file scope to decrease stack depth on 8051 port.\r
 111 */\r
 112 \r
 113 #include <stdlib.h>\r
 114 \r
 115 /* Scheduler include files. */\r
 116 #include "FreeRTOS.h"\r
 117 #include "task.h"\r
 118 #include "semphr.h"\r
 119 \r
 120 /* Demo app include files. */\r
 121 #include "semtest.h"\r
 122 #include "print.h"\r
 123 \r
 124 /* The value to which the shared variables are counted. */\r
 125 #define semtstBLOCKING_EXPECTED_VALUE           ( ( unsigned long ) 0xfff )\r
 126 #define semtstNON_BLOCKING_EXPECTED_VALUE       ( ( unsigned long ) 0xff  )\r
 127 \r
 128 #define semtstSTACK_SIZE                        configMINIMAL_STACK_SIZE\r
 129 \r
 130 #define semtstNUM_TASKS                         ( 4 )\r
 131 \r
 132 #define semtstDELAY_FACTOR                      ( ( portTickType ) 10 )\r
 133 \r
 134 /* The task function as described at the top of the file. */\r
 135 static void prvSemaphoreTest( void *pvParameters );\r
 136 \r
 137 /* Structure used to pass parameters to each task. */\r
 138 typedef struct SEMAPHORE_PARAMETERS\r
 139 {\r
 140         xSemaphoreHandle xSemaphore;\r
 141         volatile unsigned long *pulSharedVariable;\r
 142         portTickType xBlockTime;\r
 143 } xSemaphoreParameters;\r
 144 \r
 145 /* Variables used to check that all the tasks are still running without errors. */\r
 146 static volatile short sCheckVariables[ semtstNUM_TASKS ] = { 0 };\r
 147 static volatile short sNextCheckVariable = 0;\r
 148 \r
 149 /* Strings to print if USE_STDIO is defined. */\r
 150 const char * const pcPollingSemaphoreTaskError = "Guarded shared variable in unexpected state.\r\n";\r
 151 const char * const pcSemaphoreTaskStart = "Guarded shared variable task started.\r\n";\r
 152 \r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 void vStartSemaphoreTasks( unsigned portBASE_TYPE uxPriority )\r
 156 {\r
 157 xSemaphoreParameters *pxFirstSemaphoreParameters, *pxSecondSemaphoreParameters;\r
 158 const portTickType xBlockTime = ( portTickType ) 100;\r
 159 \r
 160         /* Create the structure used to pass parameters to the first two tasks. */\r
 161         pxFirstSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
 162 \r
 163         if( pxFirstSemaphoreParameters != NULL )\r
 164         {\r
 165                 /* Create the semaphore used by the first two tasks. */\r
 166                 vSemaphoreCreateBinary( pxFirstSemaphoreParameters->xSemaphore );\r
 167 \r
 168                 if( pxFirstSemaphoreParameters->xSemaphore != NULL )\r
 169                 {\r
 170                         /* Create the variable which is to be shared by the first two tasks. */\r
 171                         pxFirstSemaphoreParameters->pulSharedVariable = ( unsigned long * ) pvPortMalloc( sizeof( unsigned long ) );\r
 172 \r
 173                         /* Initialise the share variable to the value the tasks expect. */\r
 174                         *( pxFirstSemaphoreParameters->pulSharedVariable ) = semtstNON_BLOCKING_EXPECTED_VALUE;\r
 175 \r
 176                         /* The first two tasks do not block on semaphore calls. */\r
 177                         pxFirstSemaphoreParameters->xBlockTime = ( portTickType ) 0;\r
 178 \r
 179                         /* Spawn the first two tasks.  As they poll they operate at the idle priority. */\r
 180                         xTaskCreate( prvSemaphoreTest, "PolSEM1", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
 181                         xTaskCreate( prvSemaphoreTest, "PolSEM2", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
 182                 }\r
 183         }\r
 184 \r
 185         /* Do exactly the same to create the second set of tasks, only this time \r
 186         provide a block time for the semaphore calls. */\r
 187         pxSecondSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
 188         if( pxSecondSemaphoreParameters != NULL )\r
 189         {\r
 190                 vSemaphoreCreateBinary( pxSecondSemaphoreParameters->xSemaphore );\r
 191 \r
 192                 if( pxSecondSemaphoreParameters->xSemaphore != NULL )\r
 193                 {\r
 194                         pxSecondSemaphoreParameters->pulSharedVariable = ( unsigned long * ) pvPortMalloc( sizeof( unsigned long ) );\r
 195                         *( pxSecondSemaphoreParameters->pulSharedVariable ) = semtstBLOCKING_EXPECTED_VALUE;\r
 196                         pxSecondSemaphoreParameters->xBlockTime = xBlockTime / portTICK_RATE_MS;\r
 197 \r
 198                         xTaskCreate( prvSemaphoreTest, "BlkSEM1", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( xTaskHandle * ) NULL );\r
 199                         xTaskCreate( prvSemaphoreTest, "BlkSEM2", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( xTaskHandle * ) NULL );\r
 200                 }\r
 201         }\r
 202 }\r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 static void prvSemaphoreTest( void *pvParameters )\r
 206 {\r
 207 xSemaphoreParameters *pxParameters;\r
 208 volatile unsigned long *pulSharedVariable, ulExpectedValue;\r
 209 unsigned long ulCounter;\r
 210 short sError = pdFALSE, sCheckVariableToUse;\r
 211 \r
 212         /* See which check variable to use.  sNextCheckVariable is not semaphore \r
 213         protected! */\r
 214         portENTER_CRITICAL();\r
 215                 sCheckVariableToUse = sNextCheckVariable;\r
 216                 sNextCheckVariable++;\r
 217         portEXIT_CRITICAL();\r
 218 \r
 219         /* Queue a message for printing to say the task has started. */\r
 220         vPrintDisplayMessage( &pcSemaphoreTaskStart );\r
 221 \r
 222         /* A structure is passed in as the parameter.  This contains the shared \r
 223         variable being guarded. */\r
 224         pxParameters = ( xSemaphoreParameters * ) pvParameters;\r
 225         pulSharedVariable = pxParameters->pulSharedVariable;\r
 226 \r
 227         /* If we are blocking we use a much higher count to ensure loads of context\r
 228         switches occur during the count. */\r
 229         if( pxParameters->xBlockTime > ( portTickType ) 0 )\r
 230         {\r
 231                 ulExpectedValue = semtstBLOCKING_EXPECTED_VALUE;\r
 232         }\r
 233         else\r
 234         {\r
 235                 ulExpectedValue = semtstNON_BLOCKING_EXPECTED_VALUE;\r
 236         }\r
 237 \r
 238         for( ;; )\r
 239         {\r
 240                 /* Try to obtain the semaphore. */\r
 241                 if( xSemaphoreTake( pxParameters->xSemaphore, pxParameters->xBlockTime ) == pdPASS )\r
 242                 {\r
 243                         /* We have the semaphore and so expect any other tasks using the\r
 244                         shared variable to have left it in the state we expect to find\r
 245                         it. */\r
 246                         if( *pulSharedVariable != ulExpectedValue )\r
 247                         {\r
 248                                 vPrintDisplayMessage( &pcPollingSemaphoreTaskError );\r
 249                                 sError = pdTRUE;\r
 250                         }\r
 251                         \r
 252                         /* Clear the variable, then count it back up to the expected value\r
 253                         before releasing the semaphore.  Would expect a context switch or\r
 254                         two during this time. */\r
 255                         for( ulCounter = ( unsigned long ) 0; ulCounter <= ulExpectedValue; ulCounter++ )\r
 256                         {\r
 257                                 *pulSharedVariable = ulCounter;\r
 258                                 if( *pulSharedVariable != ulCounter )\r
 259                                 {\r
 260                                         if( sError == pdFALSE )\r
 261                                         {\r
 262                                                 vPrintDisplayMessage( &pcPollingSemaphoreTaskError );\r
 263                                         }\r
 264                                         sError = pdTRUE;\r
 265                                 }\r
 266                         }\r
 267 \r
 268                         /* Release the semaphore, and if no errors have occurred increment the check\r
 269                         variable. */\r
 270                         if(     xSemaphoreGive( pxParameters->xSemaphore ) == pdFALSE )\r
 271                         {\r
 272                                 vPrintDisplayMessage( &pcPollingSemaphoreTaskError );\r
 273                                 sError = pdTRUE;\r
 274                         }\r
 275 \r
 276                         if( sError == pdFALSE )\r
 277                         {\r
 278                                 if( sCheckVariableToUse < semtstNUM_TASKS )\r
 279                                 {\r
 280                                         ( sCheckVariables[ sCheckVariableToUse ] )++;\r
 281                                 }\r
 282                         }\r
 283 \r
 284                         /* If we have a block time then we are running at a priority higher\r
 285                         than the idle priority.  This task takes a long time to complete\r
 286                         a cycle (deliberately so to test the guarding) so will be starving\r
 287                         out lower priority tasks.  Block for some time to allow give lower\r
 288                         priority tasks some processor time. */\r
 289                         vTaskDelay( pxParameters->xBlockTime * semtstDELAY_FACTOR );\r
 290                 }\r
 291                 else\r
 292                 {\r
 293                         if( pxParameters->xBlockTime == ( portTickType ) 0 )\r
 294                         {\r
 295                                 /* We have not got the semaphore yet, so no point using the\r
 296                                 processor.  We are not blocking when attempting to obtain the\r
 297                                 semaphore. */\r
 298                                 taskYIELD();\r
 299                         }\r
 300                 }\r
 301         }\r
 302 }\r
 303 /*-----------------------------------------------------------*/\r
 304 \r
 305 /* This is called to check that all the created tasks are still running. */\r
 306 portBASE_TYPE xAreSemaphoreTasksStillRunning( void )\r
 307 {\r
 308 static short sLastCheckVariables[ semtstNUM_TASKS ] = { 0 };\r
 309 portBASE_TYPE xTask, xReturn = pdTRUE;\r
 310 \r
 311         for( xTask = 0; xTask < semtstNUM_TASKS; xTask++ )\r
 312         {\r
 313                 if( sLastCheckVariables[ xTask ] == sCheckVariables[ xTask ] )\r
 314                 {\r
 315                         xReturn = pdFALSE;\r
 316                 }\r
 317 \r
 318                 sLastCheckVariables[ xTask ] = sCheckVariables[ xTask ];\r
 319         }\r
 320 \r
 321         return xReturn;\r
 322 }\r
 323 \r
 324 \r