]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/Common/Minimal/semtest.c
Update version number in preparation for maintenance release.
[freertos] / FreeRTOS / Demo / Common / Minimal / semtest.c
index 4530f430c43151c7ed79bf4a20fbd986a4d1def7..c4dad6c680c02d0600e93e2459d6271c28a405f5 100644 (file)
@@ -1,96 +1,91 @@
 /*\r
-    FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
-\r
-    FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
-    http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
-     *    Complete, revised, and edited pdf reference manuals are also       *\r
-     *    available.                                                         *\r
-     *                                                                       *\r
-     *    Purchasing FreeRTOS documentation will not only help you, by       *\r
-     *    ensuring you get running as quickly as possible and with an        *\r
-     *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
-     *    the FreeRTOS project to continue with its mission of providing     *\r
-     *    professional grade, cross platform, de facto standard solutions    *\r
-     *    for microcontrollers - completely free of charge!                  *\r
-     *                                                                       *\r
-     *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
-     *                                                                       *\r
-     *    Thank you for using FreeRTOS, and thank you for your support!      *\r
-     *                                                                       *\r
-    ***************************************************************************\r
+    FreeRTOS V9.0.1 - Copyright (C) 2017 Real Time Engineers Ltd.\r
+    All rights reserved\r
 \r
+    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
 \r
     This file is part of the FreeRTOS distribution.\r
 \r
     FreeRTOS is free software; you can redistribute it and/or modify it under\r
     the terms of the GNU General Public License (version 2) as published by the\r
-    Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
+    Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
 \r
-    >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
-    distribute a combined work that includes FreeRTOS without being obliged to\r
-    provide the source code for proprietary components outside of the FreeRTOS\r
-    kernel.\r
+    ***************************************************************************\r
+    >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
+    >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
+    >>!   obliged to provide the source code for proprietary components     !<<\r
+    >>!   outside of the FreeRTOS kernel.                                   !<<\r
+    ***************************************************************************\r
 \r
     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
-    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
-    details. You should have received a copy of the GNU General Public License\r
-    and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
-    viewed here: http://www.freertos.org/a00114.html and also obtained by\r
-    writing to Real Time Engineers Ltd., contact details for whom are available\r
-    on the FreeRTOS WEB site.\r
-\r
-    1 tab == 4 spaces!\r
+    FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
+    link: http://www.freertos.org/a00114.html\r
 \r
     ***************************************************************************\r
      *                                                                       *\r
-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\r
+     *    FreeRTOS provides completely free yet professionally developed,    *\r
+     *    robust, strictly quality controlled, supported, and cross          *\r
+     *    platform software that is more than just the market leader, it     *\r
+     *    is the industry's de facto standard.                               *\r
      *                                                                       *\r
-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
+     *    Help yourself get started quickly while simultaneously helping     *\r
+     *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
+     *    tutorial book, reference manual, or both:                          *\r
+     *    http://www.FreeRTOS.org/Documentation                              *\r
      *                                                                       *\r
     ***************************************************************************\r
 \r
+    http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
+    the FAQ page "My application does not run, what could be wrong?".  Have you\r
+    defined configASSERT()?\r
 \r
-    http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
-    license and Real Time Engineers Ltd. contact details.\r
+    http://www.FreeRTOS.org/support - In return for receiving this top quality\r
+    embedded software for free we request you assist our global community by\r
+    participating in the support forum.\r
+\r
+    http://www.FreeRTOS.org/training - Investing in training allows your team to\r
+    be as productive as possible as early as possible.  Now you can receive\r
+    FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
+    Ltd, and the world's leading authority on the world's leading RTOS.\r
 \r
     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
-    including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
-    fully thread aware and reentrant UDP/IP stack.\r
-\r
-    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
-    Integrity Systems, who sell the code with commercial support, \r
-    indemnification and middleware, under the OpenRTOS brand.\r
-    \r
-    http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
-    engineered and independently SIL3 certified version for use in safety and \r
+    including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
+    compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
+\r
+    http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
+    Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
+\r
+    http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
+    Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
+    licenses offer ticketed support, indemnification and commercial middleware.\r
+\r
+    http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
+    engineered and independently SIL3 certified version for use in safety and\r
     mission critical applications that require provable dependability.\r
+\r
+    1 tab == 4 spaces!\r
 */\r
 \r
 /*\r
- * Creates two sets of two tasks.  The tasks within a set share a variable, access \r
+ * Creates two sets of two tasks.  The tasks within a set share a variable, access\r
  * to which is guarded by a semaphore.\r
- * \r
- * Each task starts by attempting to obtain the semaphore.  On obtaining a \r
- * semaphore a task checks to ensure that the guarded variable has an expected \r
- * value.  It then clears the variable to zero before counting it back up to the \r
- * expected value in increments of 1.  After each increment the variable is checked \r
- * to ensure it contains the value to which it was just set. When the starting \r
- * value is again reached the task releases the semaphore giving the other task in \r
- * the set a chance to do exactly the same thing.  The starting value is high \r
+ *\r
+ * Each task starts by attempting to obtain the semaphore.  On obtaining a\r
+ * semaphore a task checks to ensure that the guarded variable has an expected\r
+ * value.  It then clears the variable to zero before counting it back up to the\r
+ * expected value in increments of 1.  After each increment the variable is checked\r
+ * to ensure it contains the value to which it was just set. When the starting\r
+ * value is again reached the task releases the semaphore giving the other task in\r
+ * the set a chance to do exactly the same thing.  The starting value is high\r
  * enough to ensure that a tick is likely to occur during the incrementing loop.\r
  *\r
- * An error is flagged if at any time during the process a shared variable is \r
- * found to have a value other than that expected.  Such an occurrence would \r
- * suggest an error in the mutual exclusion mechanism by which access to the \r
+ * An error is flagged if at any time during the process a shared variable is\r
+ * found to have a value other than that expected.  Such an occurrence would\r
+ * suggest an error in the mutual exclusion mechanism by which access to the\r
  * variable is restricted.\r
  *\r
- * The first set of two tasks poll their semaphore.  The second set use blocking \r
+ * The first set of two tasks poll their semaphore.  The second set use blocking\r
  * calls.\r
  *\r
  */\r
 #include "semtest.h"\r
 \r
 /* The value to which the shared variables are counted. */\r
-#define semtstBLOCKING_EXPECTED_VALUE          ( ( unsigned long ) 0xfff )\r
-#define semtstNON_BLOCKING_EXPECTED_VALUE      ( ( unsigned long ) 0xff  )\r
+#define semtstBLOCKING_EXPECTED_VALUE          ( ( uint32_t ) 0xfff )\r
+#define semtstNON_BLOCKING_EXPECTED_VALUE      ( ( uint32_t ) 0xff  )\r
 \r
 #define semtstSTACK_SIZE                       configMINIMAL_STACK_SIZE\r
 \r
 #define semtstNUM_TASKS                                ( 4 )\r
 \r
-#define semtstDELAY_FACTOR                     ( ( portTickType ) 10 )\r
+#define semtstDELAY_FACTOR                     ( ( TickType_t ) 10 )\r
 \r
 /* The task function as described at the top of the file. */\r
 static portTASK_FUNCTION_PROTO( prvSemaphoreTest, pvParameters );\r
@@ -122,9 +117,9 @@ static portTASK_FUNCTION_PROTO( prvSemaphoreTest, pvParameters );
 /* Structure used to pass parameters to each task. */\r
 typedef struct SEMAPHORE_PARAMETERS\r
 {\r
-       xSemaphoreHandle xSemaphore;\r
-       volatile unsigned long *pulSharedVariable;\r
-       portTickType xBlockTime;\r
+       SemaphoreHandle_t xSemaphore;\r
+       volatile uint32_t *pulSharedVariable;\r
+       TickType_t xBlockTime;\r
 } xSemaphoreParameters;\r
 \r
 /* Variables used to check that all the tasks are still running without errors. */\r
@@ -133,10 +128,10 @@ static volatile short sNextCheckVariable = 0;
 \r
 /*-----------------------------------------------------------*/\r
 \r
-void vStartSemaphoreTasks( unsigned portBASE_TYPE uxPriority )\r
+void vStartSemaphoreTasks( UBaseType_t uxPriority )\r
 {\r
 xSemaphoreParameters *pxFirstSemaphoreParameters, *pxSecondSemaphoreParameters;\r
-const portTickType xBlockTime = ( portTickType ) 100;\r
+const TickType_t xBlockTime = ( TickType_t ) 100;\r
 \r
        /* Create the structure used to pass parameters to the first two tasks. */\r
        pxFirstSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
@@ -144,76 +139,87 @@ const portTickType xBlockTime = ( portTickType ) 100;
        if( pxFirstSemaphoreParameters != NULL )\r
        {\r
                /* Create the semaphore used by the first two tasks. */\r
-               vSemaphoreCreateBinary( pxFirstSemaphoreParameters->xSemaphore );\r
+               pxFirstSemaphoreParameters->xSemaphore = xSemaphoreCreateBinary();              \r
 \r
                if( pxFirstSemaphoreParameters->xSemaphore != NULL )\r
                {\r
+                       xSemaphoreGive( pxFirstSemaphoreParameters->xSemaphore );\r
+                       \r
                        /* Create the variable which is to be shared by the first two tasks. */\r
-                       pxFirstSemaphoreParameters->pulSharedVariable = ( unsigned long * ) pvPortMalloc( sizeof( unsigned long ) );\r
+                       pxFirstSemaphoreParameters->pulSharedVariable = ( uint32_t * ) pvPortMalloc( sizeof( uint32_t ) );\r
 \r
                        /* Initialise the share variable to the value the tasks expect. */\r
                        *( pxFirstSemaphoreParameters->pulSharedVariable ) = semtstNON_BLOCKING_EXPECTED_VALUE;\r
 \r
                        /* The first two tasks do not block on semaphore calls. */\r
-                       pxFirstSemaphoreParameters->xBlockTime = ( portTickType ) 0;\r
+                       pxFirstSemaphoreParameters->xBlockTime = ( TickType_t ) 0;\r
 \r
                        /* Spawn the first two tasks.  As they poll they operate at the idle priority. */\r
-                       xTaskCreate( prvSemaphoreTest, ( signed char * ) "PolSEM1", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
-                       xTaskCreate( prvSemaphoreTest, ( signed char * ) "PolSEM2", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
+                       xTaskCreate( prvSemaphoreTest, "PolSEM1", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( TaskHandle_t * ) NULL );\r
+                       xTaskCreate( prvSemaphoreTest, "PolSEM2", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( TaskHandle_t * ) NULL );\r
+\r
+                       /* vQueueAddToRegistry() adds the semaphore to the registry, if one\r
+                       is in use.  The registry is provided as a means for kernel aware\r
+                       debuggers to locate semaphores and has no purpose if a kernel aware\r
+                       debugger is not being used.  The call to vQueueAddToRegistry() will\r
+                       be removed by the pre-processor if configQUEUE_REGISTRY_SIZE is not\r
+                       defined or is defined to be less than 1. */\r
+                       vQueueAddToRegistry( ( QueueHandle_t ) pxFirstSemaphoreParameters->xSemaphore, "Counting_Sem_1" );\r
                }\r
        }\r
 \r
-       /* Do exactly the same to create the second set of tasks, only this time \r
+       /* Do exactly the same to create the second set of tasks, only this time\r
        provide a block time for the semaphore calls. */\r
        pxSecondSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
        if( pxSecondSemaphoreParameters != NULL )\r
        {\r
-               vSemaphoreCreateBinary( pxSecondSemaphoreParameters->xSemaphore );\r
+               pxSecondSemaphoreParameters->xSemaphore = xSemaphoreCreateBinary();             \r
 \r
                if( pxSecondSemaphoreParameters->xSemaphore != NULL )\r
                {\r
-                       pxSecondSemaphoreParameters->pulSharedVariable = ( unsigned long * ) pvPortMalloc( sizeof( unsigned long ) );\r
+                       xSemaphoreGive( pxSecondSemaphoreParameters->xSemaphore );\r
+                       \r
+                       pxSecondSemaphoreParameters->pulSharedVariable = ( uint32_t * ) pvPortMalloc( sizeof( uint32_t ) );\r
                        *( pxSecondSemaphoreParameters->pulSharedVariable ) = semtstBLOCKING_EXPECTED_VALUE;\r
-                       pxSecondSemaphoreParameters->xBlockTime = xBlockTime / portTICK_RATE_MS;\r
-\r
-                       xTaskCreate( prvSemaphoreTest, ( signed char * ) "BlkSEM1", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( xTaskHandle * ) NULL );\r
-                       xTaskCreate( prvSemaphoreTest, ( signed char * ) "BlkSEM2", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( xTaskHandle * ) NULL );\r
+                       pxSecondSemaphoreParameters->xBlockTime = xBlockTime / portTICK_PERIOD_MS;\r
+\r
+                       xTaskCreate( prvSemaphoreTest, "BlkSEM1", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( TaskHandle_t * ) NULL );\r
+                       xTaskCreate( prvSemaphoreTest, "BlkSEM2", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( TaskHandle_t * ) NULL );\r
+\r
+                       /* vQueueAddToRegistry() adds the semaphore to the registry, if one\r
+                       is in use.  The registry is provided as a means for kernel aware\r
+                       debuggers to locate semaphores and has no purpose if a kernel aware\r
+                       debugger is not being used.  The call to vQueueAddToRegistry() will\r
+                       be removed by the pre-processor if configQUEUE_REGISTRY_SIZE is not\r
+                       defined or is defined to be less than 1. */\r
+                       vQueueAddToRegistry( ( QueueHandle_t ) pxSecondSemaphoreParameters->xSemaphore, "Counting_Sem_2" );\r
                }\r
        }\r
-\r
-       /* vQueueAddToRegistry() adds the semaphore to the registry, if one is\r
-       in use.  The registry is provided as a means for kernel aware \r
-       debuggers to locate semaphores and has no purpose if a kernel aware debugger\r
-       is not being used.  The call to vQueueAddToRegistry() will be removed\r
-       by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is \r
-       defined to be less than 1. */\r
-       vQueueAddToRegistry( ( xQueueHandle ) pxFirstSemaphoreParameters->xSemaphore, ( signed char * ) "Counting_Sem_1" );\r
-       vQueueAddToRegistry( ( xQueueHandle ) pxSecondSemaphoreParameters->xSemaphore, ( signed char * ) "Counting_Sem_2" );\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
 static portTASK_FUNCTION( prvSemaphoreTest, pvParameters )\r
 {\r
 xSemaphoreParameters *pxParameters;\r
-volatile unsigned long *pulSharedVariable, ulExpectedValue;\r
-unsigned long ulCounter;\r
+volatile uint32_t *pulSharedVariable, ulExpectedValue;\r
+uint32_t ulCounter;\r
 short sError = pdFALSE, sCheckVariableToUse;\r
 \r
-       /* See which check variable to use.  sNextCheckVariable is not semaphore \r
+       /* See which check variable to use.  sNextCheckVariable is not semaphore\r
        protected! */\r
        portENTER_CRITICAL();\r
                sCheckVariableToUse = sNextCheckVariable;\r
                sNextCheckVariable++;\r
        portEXIT_CRITICAL();\r
 \r
-       /* A structure is passed in as the parameter.  This contains the shared \r
+       /* A structure is passed in as the parameter.  This contains the shared\r
        variable being guarded. */\r
        pxParameters = ( xSemaphoreParameters * ) pvParameters;\r
        pulSharedVariable = pxParameters->pulSharedVariable;\r
 \r
        /* If we are blocking we use a much higher count to ensure loads of context\r
        switches occur during the count. */\r
-       if( pxParameters->xBlockTime > ( portTickType ) 0 )\r
+       if( pxParameters->xBlockTime > ( TickType_t ) 0 )\r
        {\r
                ulExpectedValue = semtstBLOCKING_EXPECTED_VALUE;\r
        }\r
@@ -234,11 +240,11 @@ short sError = pdFALSE, sCheckVariableToUse;
                        {\r
                                sError = pdTRUE;\r
                        }\r
-                       \r
+\r
                        /* Clear the variable, then count it back up to the expected value\r
                        before releasing the semaphore.  Would expect a context switch or\r
                        two during this time. */\r
-                       for( ulCounter = ( unsigned long ) 0; ulCounter <= ulExpectedValue; ulCounter++ )\r
+                       for( ulCounter = ( uint32_t ) 0; ulCounter <= ulExpectedValue; ulCounter++ )\r
                        {\r
                                *pulSharedVariable = ulCounter;\r
                                if( *pulSharedVariable != ulCounter )\r
@@ -271,7 +277,7 @@ short sError = pdFALSE, sCheckVariableToUse;
                }\r
                else\r
                {\r
-                       if( pxParameters->xBlockTime == ( portTickType ) 0 )\r
+                       if( pxParameters->xBlockTime == ( TickType_t ) 0 )\r
                        {\r
                                /* We have not got the semaphore yet, so no point using the\r
                                processor.  We are not blocking when attempting to obtain the\r
@@ -284,10 +290,10 @@ short sError = pdFALSE, sCheckVariableToUse;
 /*-----------------------------------------------------------*/\r
 \r
 /* This is called to check that all the created tasks are still running. */\r
-portBASE_TYPE xAreSemaphoreTasksStillRunning( void )\r
+BaseType_t xAreSemaphoreTasksStillRunning( void )\r
 {\r
 static short sLastCheckVariables[ semtstNUM_TASKS ] = { 0 };\r
-portBASE_TYPE xTask, xReturn = pdTRUE;\r
+BaseType_t xTask, xReturn = pdTRUE;\r
 \r
        for( xTask = 0; xTask < semtstNUM_TASKS; xTask++ )\r
        {\r