]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/Common/Minimal/countsem.c
Update version number in readiness for V10.2.0 release.
[freertos] / FreeRTOS / Demo / Common / Minimal / countsem.c
index 1026b142766d442e662c67c174239841f1bb38a7..ed5042936f3cca6c7234b813dd51921b0de6e8f3 100644 (file)
@@ -1,79 +1,32 @@
 /*\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
-\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
-\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
-    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
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\r
-     *                                                                       *\r
-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-\r
-    http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
-    license and Real Time Engineers Ltd. contact details.\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
-    mission critical applications that require provable dependability.\r
-*/\r
-\r
-\r
-/* \r
+ * FreeRTOS Kernel V10.2.0\r
+ * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
+ *\r
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
+ * this software and associated documentation files (the "Software"), to deal in\r
+ * the Software without restriction, including without limitation the rights to\r
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
+ * the Software, and to permit persons to whom the Software is furnished to do so,\r
+ * subject to the following conditions:\r
+ *\r
+ * The above copyright notice and this permission notice shall be included in all\r
+ * copies or substantial portions of the Software.\r
+ *\r
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
+ *\r
+ * http://www.FreeRTOS.org\r
+ * http://aws.amazon.com/freertos\r
+ *\r
+ * 1 tab == 4 spaces!\r
+ */\r
+\r
+\r
+/*\r
  * Simple demonstration of the usage of counting semaphore.\r
  */\r
 \r
@@ -89,7 +42,7 @@
 #define countMAX_COUNT_VALUE   ( 200 )\r
 \r
 /* Constants used to indicate whether or not the semaphore should have been\r
-created with its maximum count value, or its minimum count value.  These \r
+created with its maximum count value, or its minimum count value.  These\r
 numbers are used to ensure that the pointers passed in as the task parameters\r
 are valid. */\r
 #define countSTART_AT_MAX_COUNT        ( 0xaa )\r
@@ -104,7 +57,7 @@ count value set to the maximum, and one with the count value set to zero. */
 \r
 /* Flag that will be latched to pdTRUE should any unexpected behaviour be\r
 detected in any of the tasks. */\r
-static volatile portBASE_TYPE xErrorDetected = pdFALSE;\r
+static volatile BaseType_t xErrorDetected = pdFALSE;\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
@@ -120,13 +73,13 @@ static void prvCountingSemaphoreTask( void *pvParameters );
  * Utility function to increment the semaphore count value up from zero to\r
  * countMAX_COUNT_VALUE.\r
  */\r
-static void prvIncrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter );\r
+static void prvIncrementSemaphoreCount( SemaphoreHandle_t xSemaphore, volatile UBaseType_t *puxLoopCounter );\r
 \r
 /*\r
- * Utility function to decrement the semaphore count value up from \r
+ * Utility function to decrement the semaphore count value up from\r
  * countMAX_COUNT_VALUE to zero.\r
  */\r
-static void prvDecrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter );\r
+static void prvDecrementSemaphoreCount( SemaphoreHandle_t xSemaphore, volatile UBaseType_t *puxLoopCounter );\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
@@ -134,20 +87,20 @@ static void prvDecrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned po
 typedef struct COUNT_SEM_STRUCT\r
 {\r
        /* The semaphore to be used for the demo. */\r
-       xSemaphoreHandle xSemaphore;\r
+       SemaphoreHandle_t xSemaphore;\r
 \r
        /* Set to countSTART_AT_MAX_COUNT if the semaphore should be created with\r
        its count value set to its max count value, or countSTART_AT_ZERO if it\r
        should have been created with its count value set to 0. */\r
-       unsigned portBASE_TYPE uxExpectedStartCount;    \r
+       UBaseType_t uxExpectedStartCount;\r
 \r
        /* Incremented on each cycle of the demo task.  Used to detect a stalled\r
        task. */\r
-       unsigned portBASE_TYPE uxLoopCounter;                   \r
+       volatile UBaseType_t uxLoopCounter;\r
 } xCountSemStruct;\r
 \r
 /* Two structures are defined, one is passed to each test task. */\r
-static volatile xCountSemStruct xParameters[ countNUM_TEST_TASKS ];\r
+static xCountSemStruct xParameters[ countNUM_TEST_TASKS ];\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
@@ -164,29 +117,28 @@ void vStartCountingSemaphoreTasks( void )
        xParameters[ 1 ].uxExpectedStartCount = 0;\r
        xParameters[ 1 ].uxLoopCounter = 0;\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 ) xParameters[ 0 ].xSemaphore, ( signed portCHAR * ) "Counting_Sem_1" );\r
-       vQueueAddToRegistry( ( xQueueHandle ) xParameters[ 1 ].xSemaphore, ( signed portCHAR * ) "Counting_Sem_2" );\r
-\r
-\r
        /* Were the semaphores created? */\r
        if( ( xParameters[ 0 ].xSemaphore != NULL ) || ( xParameters[ 1 ].xSemaphore != NULL ) )\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\r
+               debugger is not being used.  The call to vQueueAddToRegistry() will be\r
+               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 ) xParameters[ 0 ].xSemaphore, "Counting_Sem_1" );\r
+               vQueueAddToRegistry( ( QueueHandle_t ) xParameters[ 1 ].xSemaphore, "Counting_Sem_2" );\r
+\r
                /* Create the demo tasks, passing in the semaphore to use as the parameter. */\r
-               xTaskCreate( prvCountingSemaphoreTask, ( signed portCHAR * ) "CNT1", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 0 ] ), tskIDLE_PRIORITY, NULL );\r
-               xTaskCreate( prvCountingSemaphoreTask, ( signed portCHAR * ) "CNT2", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 1 ] ), tskIDLE_PRIORITY, NULL );              \r
+               xTaskCreate( prvCountingSemaphoreTask, "CNT1", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 0 ] ), tskIDLE_PRIORITY, NULL );\r
+               xTaskCreate( prvCountingSemaphoreTask, "CNT2", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 1 ] ), tskIDLE_PRIORITY, NULL );\r
        }\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static void prvDecrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter )\r
+static void prvDecrementSemaphoreCount( SemaphoreHandle_t xSemaphore, volatile UBaseType_t *puxLoopCounter )\r
 {\r
-unsigned portBASE_TYPE ux;\r
+UBaseType_t ux;\r
 \r
        /* If the semaphore count is at its maximum then we should not be able to\r
        'give' the semaphore. */\r
@@ -198,6 +150,8 @@ unsigned portBASE_TYPE ux;
        /* We should be able to 'take' the semaphore countMAX_COUNT_VALUE times. */\r
        for( ux = 0; ux < countMAX_COUNT_VALUE; ux++ )\r
        {\r
+               configASSERT( uxSemaphoreGetCount( xSemaphore ) == ( countMAX_COUNT_VALUE - ux ) );\r
+\r
                if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) != pdPASS )\r
                {\r
                        /* We expected to be able to take the semaphore. */\r
@@ -211,8 +165,9 @@ unsigned portBASE_TYPE ux;
                taskYIELD();\r
        #endif\r
 \r
-       /* If the semaphore count is zero then we should not be able to 'take' \r
+       /* If the semaphore count is zero then we should not be able to 'take'\r
        the semaphore. */\r
+       configASSERT( uxSemaphoreGetCount( xSemaphore ) == 0 );\r
        if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) == pdPASS )\r
        {\r
                xErrorDetected = pdTRUE;\r
@@ -220,11 +175,11 @@ unsigned portBASE_TYPE ux;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static void prvIncrementSemaphoreCount( xSemaphoreHandle xSemaphore, unsigned portBASE_TYPE *puxLoopCounter )\r
+static void prvIncrementSemaphoreCount( SemaphoreHandle_t xSemaphore, volatile UBaseType_t *puxLoopCounter )\r
 {\r
-unsigned portBASE_TYPE ux;\r
+UBaseType_t ux;\r
 \r
-       /* If the semaphore count is zero then we should not be able to 'take' \r
+       /* If the semaphore count is zero then we should not be able to 'take'\r
        the semaphore. */\r
        if( xSemaphoreTake( xSemaphore, countDONT_BLOCK ) == pdPASS )\r
        {\r
@@ -234,6 +189,8 @@ unsigned portBASE_TYPE ux;
        /* We should be able to 'give' the semaphore countMAX_COUNT_VALUE times. */\r
        for( ux = 0; ux < countMAX_COUNT_VALUE; ux++ )\r
        {\r
+               configASSERT( uxSemaphoreGetCount( xSemaphore ) == ux );\r
+\r
                if( xSemaphoreGive( xSemaphore ) != pdPASS )\r
                {\r
                        /* We expected to be able to take the semaphore. */\r
@@ -261,9 +218,9 @@ static void prvCountingSemaphoreTask( void *pvParameters )
 xCountSemStruct *pxParameter;\r
 \r
        #ifdef USE_STDIO\r
-       void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );\r
-       \r
-               const portCHAR * const pcTaskStartMsg = "Counting semaphore demo started.\r\n";\r
+       void vPrintDisplayMessage( const char * const * ppcMessageToSend );\r
+\r
+               const char * const pcTaskStartMsg = "Counting semaphore demo started.\r\n";\r
 \r
                /* Queue a message for printing to say the task has started. */\r
                vPrintDisplayMessage( &pcTaskStartMsg );\r
@@ -294,10 +251,10 @@ xCountSemStruct *pxParameter;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-portBASE_TYPE xAreCountingSemaphoreTasksStillRunning( void )\r
+BaseType_t xAreCountingSemaphoreTasksStillRunning( void )\r
 {\r
-static unsigned portBASE_TYPE uxLastCount0 = 0, uxLastCount1 = 0;\r
-portBASE_TYPE xReturn = pdPASS;\r
+static UBaseType_t uxLastCount0 = 0, uxLastCount1 = 0;\r
+BaseType_t xReturn = pdPASS;\r
 \r
        /* Return fail if any 'give' or 'take' did not result in the expected\r
        behaviour. */\r