]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/Common/Minimal/TaskNotify.c
Changes to the FreeRTOS code:
[freertos] / FreeRTOS / Demo / Common / Minimal / TaskNotify.c
index 347eb30e62751f5abbc002f28f6249bd0c975d30..2a65b86c1567d3909683e23facd02b0f88bf6b5d 100644 (file)
@@ -1,5 +1,5 @@
 /*\r
-    FreeRTOS V8.2.0rc1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
+    FreeRTOS V8.2.3 - Copyright (C) 2015 Real Time Engineers Ltd.\r
     All rights reserved\r
 \r
     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
@@ -8,29 +8,20 @@
 \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
+    ***************************************************************************\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?".  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
      *                                                                       *\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
+    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
-    ***************************************************************************\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
+    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 - Documentation, books, training, latest versions,\r
-    license and Real Time Engineers Ltd. contact details.\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, a DOS\r
@@ -82,7 +56,7 @@
     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
+    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
@@ -173,7 +147,7 @@ static void prvSingleTaskTests( void )
 {\r
 const TickType_t xTicksToWait = pdMS_TO_TICKS( 100UL );\r
 BaseType_t xReturned;\r
-uint32_t ulNotifiedValue, ulLoop, ulNotifyingValue;\r
+uint32_t ulNotifiedValue, ulLoop, ulNotifyingValue, ulPreviousValue, ulExpectedValue;\r
 TickType_t xTimeOnEntering;\r
 const uint32_t ulFirstNotifiedConst = 100001UL, ulSecondNotifiedValueConst = 5555UL, ulMaxLoops = 5UL;\r
 const uint32_t ulBit0 = 0x01UL, ulBit1 = 0x02UL;\r
@@ -198,12 +172,15 @@ const uint32_t ulBit0 = 0x01UL, ulBit1 = 0x02UL;
        Check no blocking when notifications are pending.  First notify itself -\r
        this would not be a normal thing to do and is done here for test purposes\r
        only. */\r
-       xReturned = xTaskNotify( xTaskToNotify, ulFirstNotifiedConst, eSetValueWithoutOverwrite );\r
+       xReturned = xTaskNotifyAndQuery( xTaskToNotify, ulFirstNotifiedConst, eSetValueWithoutOverwrite, &ulPreviousValue );\r
 \r
        /* Even through the 'without overwrite' action was used the update should\r
        have been successful. */\r
        configASSERT( xReturned == pdPASS );\r
 \r
+       /* No bits should have been pending previously. */\r
+       configASSERT( ulPreviousValue == 0 );\r
+\r
        /* The task should now have a notification pending, and so not time out. */\r
        xTimeOnEntering = xTaskGetTickCount();\r
        xReturned = xTaskNotifyWait( ULONG_MAX, 0, &ulNotifiedValue, xTicksToWait );\r
@@ -377,6 +354,50 @@ const uint32_t ulBit0 = 0x01UL, ulBit1 = 0x02UL;
 \r
 \r
 \r
+\r
+       /*--------------------------------------------------------------------------\r
+       Now try querying the previous value while notifying a task. */\r
+       xTaskNotifyAndQuery( xTaskToNotify, 0x00, eSetBits, &ulPreviousValue );\r
+       configASSERT( ulNotifiedValue == ( ULONG_MAX & ~( ulBit0 | ulBit1 ) ) );\r
+\r
+       /* Clear all bits. */\r
+       xTaskNotifyWait( 0x00, ULONG_MAX, &ulNotifiedValue, 0 );\r
+       xTaskNotifyAndQuery( xTaskToNotify, 0x00, eSetBits, &ulPreviousValue );\r
+       configASSERT( ulPreviousValue == 0 );\r
+\r
+       ulExpectedValue = 0;\r
+       for( ulLoop = 0x01; ulLoop < 0x80UL; ulLoop <<= 1UL )\r
+       {\r
+               /* Set the next bit up, and expect to receive the last bits set (so\r
+               the previous value will not yet have the bit being set this time\r
+               around). */\r
+               xTaskNotifyAndQuery( xTaskToNotify, ulLoop, eSetBits, &ulPreviousValue );\r
+               configASSERT( ulExpectedValue == ulPreviousValue );\r
+               ulExpectedValue |= ulLoop;\r
+       }\r
+\r
+\r
+\r
+       /* -------------------------------------------------------------------------\r
+       Clear the previous notifications. */\r
+       xTaskNotifyWait( ULONG_MAX, 0, &ulNotifiedValue, 0 );\r
+\r
+       /* The task should not have any notifications pending, so an attempt to clear\r
+       the notification state should fail. */\r
+       configASSERT( xTaskNotifyStateClear( NULL ) == pdFALSE );\r
+\r
+       /* Get the task to notify itself.  This is not a normal thing to do, and is\r
+       only done here for test purposes. */\r
+       xTaskNotifyAndQuery( xTaskToNotify, ulFirstNotifiedConst, eSetValueWithoutOverwrite, &ulPreviousValue );\r
+\r
+       /* Now the notification state should be eNotified, so it should now be\r
+       possible to clear the notification state. */\r
+       configASSERT( xTaskNotifyStateClear( NULL ) == pdTRUE );\r
+       configASSERT( xTaskNotifyStateClear( NULL ) == pdFALSE );\r
+\r
+\r
+\r
+\r
        /* Incremented to show the task is still running. */\r
        ulNotifyCycleCount++;\r
 \r
@@ -404,6 +425,7 @@ static void prvNotifiedTask( void *pvParameters )
 {\r
 const TickType_t xMaxPeriod = pdMS_TO_TICKS( 90 ), xMinPeriod = pdMS_TO_TICKS( 10 ), xDontBlock = 0;\r
 TickType_t xPeriod;\r
+const uint32_t ulCyclesToRaisePriority = 50UL;\r
 \r
        /* Remove compiler warnings about unused parameters. */\r
        ( void ) pvParameters;\r
@@ -427,8 +449,8 @@ TickType_t xPeriod;
                        xPeriod = xMinPeriod;\r
                }\r
 \r
+               /* Change the timer period and start the timer. */\r
                xTimerChangePeriod( xTimer, xPeriod, portMAX_DELAY );\r
-               xTimerStart( xTimer, portMAX_DELAY );\r
 \r
                /* Block waiting for the notification again with a different period.\r
                Sometimes the period will be higher than the tasks block time, sometimes\r
@@ -461,9 +483,28 @@ TickType_t xPeriod;
                the function call. */\r
                ulTimerNotificationsReceived += ulTaskNotifyTake( pdTRUE, xPeriod );\r
 \r
-               /* Wait for the next notification again, clearing all notifications if\r
-               one is received, but this time blocking indefinitely. */\r
-               ulTimerNotificationsReceived += ulTaskNotifyTake( pdTRUE, portMAX_DELAY );\r
+               /* Occasionally raise the priority of the task being notified to test\r
+               the path where the task is notified from an ISR and becomes the highest\r
+               priority ready state task, but the pxHigherPriorityTaskWoken parameter\r
+               is NULL (which it is in the tick hook that sends notifications to this\r
+               task. */\r
+               if( ( ulNotifyCycleCount % ulCyclesToRaisePriority ) == 0 )\r
+               {\r
+                       vTaskPrioritySet( xTaskToNotify, configMAX_PRIORITIES - 1 );\r
+\r
+                       /* Wait for the next notification again, clearing all notifications if\r
+                       one is received, but this time blocking indefinitely. */\r
+                       ulTimerNotificationsReceived += ulTaskNotifyTake( pdTRUE, portMAX_DELAY );\r
+\r
+                       /* Reset the priority. */\r
+                       vTaskPrioritySet( xTaskToNotify, notifyTASK_PRIORITY );\r
+               }\r
+               else\r
+               {\r
+                       /* Wait for the next notification again, clearing all notifications if\r
+                       one is received, but this time blocking indefinitely. */\r
+                       ulTimerNotificationsReceived += ulTaskNotifyTake( pdTRUE, portMAX_DELAY );\r
+               }\r
 \r
                /* Incremented to show the task is still running. */\r
                ulNotifyCycleCount++;\r
@@ -473,8 +514,10 @@ TickType_t xPeriod;
 \r
 void xNotifyTaskFromISR( void )\r
 {\r
-static BaseType_t xCallCount = 0;\r
+static BaseType_t xCallCount = 0, xAPIToUse = 0;\r
 const BaseType_t xCallInterval = pdMS_TO_TICKS( 50 );\r
+uint32_t ulPreviousValue;\r
+const uint32_t ulUnexpectedValue = 0xff;\r
 \r
        /* The task performs some tests before starting the timer that gives the\r
        notification from this interrupt.  If the timer has not been created yet\r
@@ -489,7 +532,28 @@ const BaseType_t xCallInterval = pdMS_TO_TICKS( 50 );
                        /* It is time to 'give' the notification again. */\r
                        xCallCount = 0;\r
 \r
-                       vTaskNotifyGiveFromISR( xTaskToNotify, NULL );\r
+                       /* Test using both vTaskNotifyGiveFromISR(), xTaskNotifyFromISR()\r
+                       and xTaskNotifyAndQueryFromISR(). */\r
+                       switch( xAPIToUse )\r
+                       {\r
+                               case 0: vTaskNotifyGiveFromISR( xTaskToNotify, NULL );\r
+                                               xAPIToUse++;\r
+                                               break;\r
+\r
+                               case 1: xTaskNotifyFromISR( xTaskToNotify, 0, eIncrement, NULL );\r
+                                               xAPIToUse++;\r
+                                               break;\r
+\r
+                               case 2: ulPreviousValue = ulUnexpectedValue;\r
+                                               xTaskNotifyAndQueryFromISR( xTaskToNotify, 0, eIncrement, &ulPreviousValue, NULL );\r
+                                               configASSERT( ulPreviousValue != ulUnexpectedValue );\r
+                                               xAPIToUse = 0;\r
+                                               break;\r
+\r
+                               default:/* Should never get here!. */\r
+                                               break;\r
+                       }\r
+\r
                        ulTimerNotificationsSent++;\r
                }\r
        }\r
@@ -516,7 +580,7 @@ const uint32_t ulMaxSendReceiveDeviation = 5UL;
 \r
        /* Check the count of 'takes' from the software timer is keeping track with\r
        the amount of 'gives'. */\r
-       if( ulTimerNotificationsSent > ulTimerNotificationsSent )\r
+       if( ulTimerNotificationsSent > ulTimerNotificationsReceived )\r
        {\r
                if( ( ulTimerNotificationsSent - ulTimerNotificationsReceived ) > ulMaxSendReceiveDeviation )\r
                {\r
@@ -534,6 +598,6 @@ const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL;
 \r
        /* Utility function to generate a pseudo random number. */\r
        ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;\r
-       return( ( int ) ( ulNextRand >> 16UL ) & 0x7fffUL );\r
+       return( ( ulNextRand >> 16UL ) & 0x7fffUL );\r
 }\r
 /*-----------------------------------------------------------*/\r