]> 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 a9f8c37883ade216ecfdb1d1f0738f5d99103273..ed5042936f3cca6c7234b813dd51921b0de6e8f3 100644 (file)
 /*\r
-    FreeRTOS V8.2.0rc1 - Copyright (C) 2014 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
-\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
-    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.  Full license text is available on the following\r
-    link: http://www.freertos.org/a00114.html\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?".  Have you defined configASSERT()?  *\r
-     *                                                                       *\r
-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\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
-     *    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
-    ***************************************************************************\r
-     *                                                                       *\r
-     *   Investing in training allows your team to be as productive as       *\r
-     *   possible as early as possible, lowering your overall development    *\r
-     *   cost, and enabling you to bring a more robust product to market     *\r
-     *   earlier than would otherwise be possible.  Richard Barry is both    *\r
-     *   the architect and key author of FreeRTOS, and so also the world's   *\r
-     *   leading authority on what is the world's most popular real time     *\r
-     *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
-     *   from Richard ensures your team will gain directly from his in-depth *\r
-     *   product knowledge and years of usage experience.  Contact Real Time *\r
-     *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
-     *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    You are receiving this top quality software for free.  Please play *\r
-     *    fair and reciprocate by reporting any suspected issues and         *\r
-     *    participating in the community forum:                              *\r
-     *    http://www.FreeRTOS.org/support                                    *\r
-     *                                                                       *\r
-     *    Thank you!                                                         *\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, 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
-/* \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
 #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
@@ -141,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( SemaphoreHandle_t xSemaphore, UBaseType_t *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( SemaphoreHandle_t xSemaphore, UBaseType_t *puxLoopCounter );\r
+static void prvDecrementSemaphoreCount( SemaphoreHandle_t xSemaphore, volatile UBaseType_t *puxLoopCounter );\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
@@ -160,15 +92,15 @@ typedef struct COUNT_SEM_STRUCT
        /* 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
-       UBaseType_t uxExpectedStartCount;       \r
+       UBaseType_t uxExpectedStartCount;\r
 \r
        /* Incremented on each cycle of the demo task.  Used to detect a stalled\r
        task. */\r
-       UBaseType_t 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
@@ -185,27 +117,26 @@ 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( ( QueueHandle_t ) xParameters[ 0 ].xSemaphore, "Counting_Sem_1" );\r
-       vQueueAddToRegistry( ( QueueHandle_t ) xParameters[ 1 ].xSemaphore, "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, "CNT1", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 0 ] ), tskIDLE_PRIORITY, NULL );\r
-               xTaskCreate( prvCountingSemaphoreTask, "CNT2", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 1 ] ), tskIDLE_PRIORITY, NULL );            \r
+               xTaskCreate( prvCountingSemaphoreTask, "CNT2", configMINIMAL_STACK_SIZE, ( void * ) &( xParameters[ 1 ] ), tskIDLE_PRIORITY, NULL );\r
        }\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static void prvDecrementSemaphoreCount( SemaphoreHandle_t xSemaphore, UBaseType_t *puxLoopCounter )\r
+static void prvDecrementSemaphoreCount( SemaphoreHandle_t xSemaphore, volatile UBaseType_t *puxLoopCounter )\r
 {\r
 UBaseType_t ux;\r
 \r
@@ -219,6 +150,8 @@ UBaseType_t 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
@@ -232,8 +165,9 @@ UBaseType_t 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
@@ -241,11 +175,11 @@ UBaseType_t ux;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static void prvIncrementSemaphoreCount( SemaphoreHandle_t xSemaphore, UBaseType_t *puxLoopCounter )\r
+static void prvIncrementSemaphoreCount( SemaphoreHandle_t xSemaphore, volatile UBaseType_t *puxLoopCounter )\r
 {\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
@@ -255,6 +189,8 @@ UBaseType_t 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
@@ -283,7 +219,7 @@ xCountSemStruct *pxParameter;
 \r
        #ifdef USE_STDIO\r
        void vPrintDisplayMessage( const char * const * ppcMessageToSend );\r
-       \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