]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/Common/Minimal/recmutex.c
Update version number to 9.0.0rc2.
[freertos] / FreeRTOS / Demo / Common / Minimal / recmutex.c
index 998e533eae88b816d9495f13d2b4a16a1a710a1a..9c648428a1928c6da766dcdc051d81dcce734709 100644 (file)
@@ -1,67 +1,70 @@
 /*\r
-    FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
-       \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.0rc2 - Copyright (C) 2016 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
-    >>>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.  FreeRTOS is distributed in the hope that it will be useful, but\r
-    WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
-    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
-    more details. You should have received a copy of the GNU General Public\r
-    License and the FreeRTOS license exception along with FreeRTOS; if not it\r
-    can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
-    by writing to Richard Barry, contact details for whom are available on the\r
-    FreeRTOS WEB site.\r
+    Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
+\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.  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?                                      *\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
-    \r
-    http://www.FreeRTOS.org - Documentation, training, latest information, \r
-    license and contact details.\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/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.\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
-    Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
-    the code with commercial support, indemnification, and middleware, under \r
-    the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
-    provide a safety engineered and independently SIL3 certified version under \r
-    the SafeRTOS brand: http://www.SafeRTOS.com.\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
        This demo creates three tasks all of which access the same recursive mutex:\r
 \r
-       prvRecursiveMutexControllingTask() has the highest priority so executes \r
-       first and grabs the mutex.  It then performs some recursive accesses - \r
-       between each of which it sleeps for a short period to let the lower \r
+       prvRecursiveMutexControllingTask() has the highest priority so executes\r
+       first and grabs the mutex.  It then performs some recursive accesses -\r
+       between each of which it sleeps for a short period to let the lower\r
        priority tasks execute.  When it has completed its demo functionality\r
        it gives the mutex back before suspending itself.\r
 \r
        prvRecursiveMutexBlockingTask() attempts to access the mutex by performing\r
-       a blocking 'take'.  The blocking task has a lower priority than the \r
+       a blocking 'take'.  The blocking task has a lower priority than the\r
        controlling     task so by the time it executes the mutex has already been\r
-       taken by the controlling task,  causing the blocking task to block.  It \r
-       does not unblock until the controlling task has given the mutex back, \r
-       and it does not actually run until the controlling task has suspended \r
+       taken by the controlling task,  causing the blocking task to block.  It\r
+       does not unblock until the controlling task has given the mutex back,\r
+       and it does not actually run until the controlling task has suspended\r
        itself (due to the relative priorities).  When it eventually does obtain\r
-       the mutex all it does is give the mutex back prior to also suspending \r
-       itself.  At this point both the controlling task and the blocking task are \r
+       the mutex all it does is give the mutex back prior to also suspending\r
+       itself.  At this point both the controlling task and the blocking task are\r
        suspended.\r
 \r
        prvRecursiveMutexPollingTask() runs at the idle priority.  It spins round\r
        a tight loop attempting to obtain the mutex with a non-blocking call.  As\r
        the lowest priority task it will not successfully obtain the mutex until\r
-       both the controlling and blocking tasks are suspended.  Once it eventually \r
+       both the controlling and blocking tasks are suspended.  Once it eventually\r
        does obtain the mutex it first unsuspends both the controlling task and\r
        blocking task prior to giving the mutex back - resulting in the polling\r
        task temporarily inheriting the controlling tasks priority.\r
 /* Demo app include files. */\r
 #include "recmutex.h"\r
 \r
-/* Priorities assigned to the three tasks. */\r
-#define recmuCONTROLLING_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )\r
+/* Priorities assigned to the three tasks.  recmuCONTROLLING_TASK_PRIORITY can\r
+be overridden by a definition in FreeRTOSConfig.h. */\r
+#ifndef recmuCONTROLLING_TASK_PRIORITY\r
+       #define recmuCONTROLLING_TASK_PRIORITY  ( tskIDLE_PRIORITY + 2 )\r
+#endif\r
 #define recmuBLOCKING_TASK_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
 #define recmuPOLLING_TASK_PRIORITY             ( tskIDLE_PRIORITY + 0 )\r
 \r
 #define recmuMAX_COUNT                                 ( 10 )\r
 \r
 /* Misc. */\r
-#define recmuSHORT_DELAY                               ( 20 / portTICK_RATE_MS )\r
-#define recmuNO_DELAY                                  ( ( portTickType ) 0 )\r
-#define recmuTWO_TICK_DELAY                            ( ( portTickType ) 2 )\r
+#define recmuSHORT_DELAY                               ( pdMS_TO_TICKS( 20 ) )\r
+#define recmuNO_DELAY                                  ( ( TickType_t ) 0 )\r
+#define recmu15ms_DELAY                                        ( pdMS_TO_TICKS( 15 ) )\r
 \r
 /* The three tasks as described at the top of this file. */\r
 static void prvRecursiveMutexControllingTask( void *pvParameters );\r
@@ -127,15 +133,15 @@ static void prvRecursiveMutexBlockingTask( void *pvParameters );
 static void prvRecursiveMutexPollingTask( void *pvParameters );\r
 \r
 /* The mutex used by the demo. */\r
-static xSemaphoreHandle xMutex;\r
+static SemaphoreHandle_t xMutex;\r
 \r
 /* Variables used to detect and latch errors. */\r
-static volatile portBASE_TYPE xErrorOccurred = pdFALSE, xControllingIsSuspended = pdFALSE, xBlockingIsSuspended = pdFALSE;\r
-static volatile unsigned portBASE_TYPE uxControllingCycles = 0, uxBlockingCycles = 0, uxPollingCycles = 0;\r
+static volatile BaseType_t xErrorOccurred = pdFALSE, xControllingIsSuspended = pdFALSE, xBlockingIsSuspended = pdFALSE;\r
+static volatile UBaseType_t uxControllingCycles = 0, uxBlockingCycles = 0, uxPollingCycles = 0;\r
 \r
-/* Handles of the two higher priority tasks, required so they can be resumed \r
+/* Handles of the two higher priority tasks, required so they can be resumed\r
 (unsuspended). */\r
-static xTaskHandle xControllingTaskHandle, xBlockingTaskHandle;\r
+static TaskHandle_t xControllingTaskHandle, xBlockingTaskHandle;\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
@@ -145,27 +151,26 @@ void vStartRecursiveMutexTasks( void )
 \r
        xMutex = xSemaphoreCreateRecursiveMutex();\r
 \r
-       /* vQueueAddToRegistry() adds the mutex to the registry, if one is\r
-       in use.  The registry is provided as a means for kernel aware \r
-       debuggers to locate mutex 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 ) xMutex, ( signed portCHAR * ) "Recursive_Mutex" );\r
-\r
-\r
        if( xMutex != NULL )\r
        {\r
-               xTaskCreate( prvRecursiveMutexControllingTask, ( signed portCHAR * ) "Rec1", configMINIMAL_STACK_SIZE, NULL, recmuCONTROLLING_TASK_PRIORITY, &xControllingTaskHandle );\r
-        xTaskCreate( prvRecursiveMutexBlockingTask, ( signed portCHAR * ) "Rec2", configMINIMAL_STACK_SIZE, NULL, recmuBLOCKING_TASK_PRIORITY, &xBlockingTaskHandle );\r
-        xTaskCreate( prvRecursiveMutexPollingTask, ( signed portCHAR * ) "Rec3", configMINIMAL_STACK_SIZE, NULL, recmuPOLLING_TASK_PRIORITY, NULL );\r
+               /* vQueueAddToRegistry() adds the mutex to the registry, if one is\r
+               in use.  The registry is provided as a means for kernel aware\r
+               debuggers to locate mutex 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 ) xMutex, "Recursive_Mutex" );\r
+\r
+               xTaskCreate( prvRecursiveMutexControllingTask, "Rec1", configMINIMAL_STACK_SIZE, NULL, recmuCONTROLLING_TASK_PRIORITY, &xControllingTaskHandle );\r
+               xTaskCreate( prvRecursiveMutexBlockingTask, "Rec2", configMINIMAL_STACK_SIZE, NULL, recmuBLOCKING_TASK_PRIORITY, &xBlockingTaskHandle );\r
+               xTaskCreate( prvRecursiveMutexPollingTask, "Rec3", configMINIMAL_STACK_SIZE, NULL, recmuPOLLING_TASK_PRIORITY, NULL );\r
        }\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
 static void prvRecursiveMutexControllingTask( void *pvParameters )\r
 {\r
-unsigned portBASE_TYPE ux;\r
+UBaseType_t ux;\r
 \r
        /* Just to remove compiler warning. */\r
        ( void ) pvParameters;\r
@@ -185,7 +190,7 @@ unsigned portBASE_TYPE ux;
                {\r
                        /* We should now be able to take the mutex as many times as\r
                        we like.\r
-                       \r
+\r
                        The first time through the mutex will be immediately available, on\r
                        subsequent times through the mutex will be held by the polling task\r
                        at this point and this Take will cause the polling task to inherit\r
@@ -193,14 +198,14 @@ unsigned portBASE_TYPE ux;
                        long enough to ensure the polling task will execute again before the\r
                        block time expires.  If the block time does expire then the error\r
                        flag will be set here. */\r
-                       if( xSemaphoreTakeRecursive( xMutex, recmuTWO_TICK_DELAY ) != pdPASS )\r
+                       if( xSemaphoreTakeRecursive( xMutex, recmu15ms_DELAY ) != pdPASS )\r
                        {\r
                                xErrorOccurred = pdTRUE;\r
                        }\r
 \r
                        /* Ensure the other task attempting to access the mutex (and the\r
                        other demo tasks) are able to execute to ensure they either block\r
-                       (where a block time is specified) or return an error (where no \r
+                       (where a block time is specified) or return an error (where no\r
                        block time is specified) as the mutex is held by this task. */\r
                        vTaskDelay( recmuSHORT_DELAY );\r
                }\r
@@ -221,20 +226,24 @@ unsigned portBASE_TYPE ux;
                        {\r
                                xErrorOccurred = pdTRUE;\r
                        }\r
+\r
+                       #if( configUSE_PREEMPTION == 0 )\r
+                               taskYIELD();\r
+                       #endif\r
                }\r
 \r
                /* Having given it back the same number of times as it was taken, we\r
-               should no longer be the mutex owner, so the next give sh ould fail. */\r
+               should no longer be the mutex owner, so the next give should fail. */\r
                if( xSemaphoreGiveRecursive( xMutex ) == pdPASS )\r
                {\r
                        xErrorOccurred = pdTRUE;\r
                }\r
 \r
-               /* Keep count of the number of cycles this task has performed so a \r
+               /* Keep count of the number of cycles this task has performed so a\r
                stall can be detected. */\r
                uxControllingCycles++;\r
 \r
-               /* Suspend ourselves to the blocking task can execute. */\r
+               /* Suspend ourselves so the blocking task can execute. */\r
                xControllingIsSuspended = pdTRUE;\r
                vTaskSuspend( NULL );\r
                xControllingIsSuspended = pdFALSE;\r
@@ -251,10 +260,12 @@ static void prvRecursiveMutexBlockingTask( void *pvParameters )
        {\r
                /* This task will run while the controlling task is blocked, and the\r
                controlling task will block only once it has the mutex - therefore\r
-               this call should block until the controlling task has given up the \r
-               mutex, and not actually execute past this call until the controlling \r
-               task is suspended. */\r
-               if( xSemaphoreTakeRecursive( xMutex, portMAX_DELAY ) == pdPASS )\r
+               this call should block until the controlling task has given up the\r
+               mutex, and not actually execute past this call until the controlling\r
+               task is suspended.  portMAX_DELAY - 1 is used instead of portMAX_DELAY\r
+               to ensure the task's state is reported as Blocked and not Suspended in\r
+               a later call to configASSERT() (within the polling task). */\r
+               if( xSemaphoreTakeRecursive( xMutex, ( portMAX_DELAY - 1 ) ) == pdPASS )\r
                {\r
                        if( xControllingIsSuspended != pdTRUE )\r
                        {\r
@@ -289,7 +300,7 @@ static void prvRecursiveMutexBlockingTask( void *pvParameters )
                        xErrorOccurred = pdTRUE;\r
                }\r
 \r
-               /* Keep count of the number of cycles this task has performed so a \r
+               /* Keep count of the number of cycles this task has performed so a\r
                stall can be detected. */\r
                uxBlockingCycles++;\r
        }\r
@@ -308,6 +319,13 @@ static void prvRecursiveMutexPollingTask( void *pvParameters )
                happen when the controlling task is also suspended. */\r
                if( xSemaphoreTakeRecursive( xMutex, recmuNO_DELAY ) == pdPASS )\r
                {\r
+                       #if( INCLUDE_eTaskGetState == 1 )\r
+                       {\r
+                               configASSERT( eTaskGetState( xControllingTaskHandle ) == eSuspended );\r
+                               configASSERT( eTaskGetState( xBlockingTaskHandle ) == eSuspended );\r
+                       }\r
+                       #endif /* INCLUDE_eTaskGetState */\r
+\r
                        /* Is the blocking task suspended? */\r
                        if( ( xBlockingIsSuspended != pdTRUE ) || ( xControllingIsSuspended != pdTRUE ) )\r
                        {\r
@@ -315,7 +333,7 @@ static void prvRecursiveMutexPollingTask( void *pvParameters )
                        }\r
                        else\r
                        {\r
-                               /* Keep count of the number of cycles this task has performed \r
+                               /* Keep count of the number of cycles this task has performed\r
                                so a stall can be detected. */\r
                                uxPollingCycles++;\r
 \r
@@ -329,20 +347,48 @@ static void prvRecursiveMutexPollingTask( void *pvParameters )
                                error will be latched if the polling task has not returned the\r
                                mutex by the time this fixed period has expired. */\r
                                vTaskResume( xBlockingTaskHandle );\r
-                vTaskResume( xControllingTaskHandle );\r
-                       \r
+                               #if( configUSE_PREEMPTION == 0 )\r
+                                       taskYIELD();\r
+                               #endif\r
+\r
+                               vTaskResume( xControllingTaskHandle );\r
+                               #if( configUSE_PREEMPTION == 0 )\r
+                                       taskYIELD();\r
+                               #endif\r
+\r
                                /* The other two tasks should now have executed and no longer\r
                                be suspended. */\r
                                if( ( xBlockingIsSuspended == pdTRUE ) || ( xControllingIsSuspended == pdTRUE ) )\r
                                {\r
                                        xErrorOccurred = pdTRUE;\r
-                               }                               \r
-                       \r
+                               }\r
+\r
+                               #if( INCLUDE_uxTaskPriorityGet == 1 )\r
+                               {\r
+                                       /* Check priority inherited. */\r
+                                       configASSERT( uxTaskPriorityGet( NULL ) == recmuCONTROLLING_TASK_PRIORITY );\r
+                               }\r
+                               #endif /* INCLUDE_uxTaskPriorityGet */\r
+\r
+                               #if( INCLUDE_eTaskGetState == 1 )\r
+                               {\r
+                                       configASSERT( eTaskGetState( xControllingTaskHandle ) == eBlocked );\r
+                                       configASSERT( eTaskGetState( xBlockingTaskHandle ) == eBlocked );\r
+                               }\r
+                               #endif /* INCLUDE_eTaskGetState */\r
+\r
                                /* Release the mutex, disinheriting the higher priority again. */\r
                                if( xSemaphoreGiveRecursive( xMutex ) != pdPASS )\r
                                {\r
                                        xErrorOccurred = pdTRUE;\r
                                }\r
+\r
+                               #if( INCLUDE_uxTaskPriorityGet == 1 )\r
+                               {\r
+                                       /* Check priority disinherited. */\r
+                                       configASSERT( uxTaskPriorityGet( NULL ) == recmuPOLLING_TASK_PRIORITY );\r
+                               }\r
+                               #endif /* INCLUDE_uxTaskPriorityGet */\r
                        }\r
                }\r
 \r
@@ -356,10 +402,10 @@ static void prvRecursiveMutexPollingTask( void *pvParameters )
 /*-----------------------------------------------------------*/\r
 \r
 /* This is called to check that all the created tasks are still running. */\r
-portBASE_TYPE xAreRecursiveMutexTasksStillRunning( void )\r
+BaseType_t xAreRecursiveMutexTasksStillRunning( void )\r
 {\r
-portBASE_TYPE xReturn;\r
-static unsigned portBASE_TYPE uxLastControllingCycles = 0, uxLastBlockingCycles = 0, uxLastPollingCycles = 0;\r
+BaseType_t xReturn;\r
+static UBaseType_t uxLastControllingCycles = 0, uxLastBlockingCycles = 0, uxLastPollingCycles = 0;\r
 \r
        /* Is the controlling task still cycling? */\r
        if( uxLastControllingCycles == uxControllingCycles )\r
@@ -397,7 +443,7 @@ static unsigned portBASE_TYPE uxLastControllingCycles = 0, uxLastBlockingCycles
        }\r
        else\r
        {\r
-               xReturn = pdTRUE;\r
+               xReturn = pdPASS;\r
        }\r
 \r
        return xReturn;\r