]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/Common/Minimal/QueueOverwrite.c
Update version number in preparation for maintenance release.
[freertos] / FreeRTOS / Demo / Common / Minimal / QueueOverwrite.c
index e554201bd753e281246b0e1ad2a9e72b195abad8..6a5a47ca77433e0cb4c246241572931fcbe49f0b 100644 (file)
@@ -1,75 +1,70 @@
 /*\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/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, and our new\r
-    fully thread aware and reentrant UDP/IP stack.\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, who sell the code with commercial support,\r
-    indemnification and middleware, under the OpenRTOS brand.\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
@@ -96,40 +91,55 @@ static void prvQueueOverwriteTask( void *pvParameters );
 \r
 /* Variable that is incremented on each loop of prvQueueOverwriteTask() provided\r
 prvQueueOverwriteTask() has not found any errors. */\r
-static unsigned long ulLoopCounter = 0;\r
+static uint32_t ulLoopCounter = 0;\r
+\r
+/* Set to pdFALSE if an error is discovered by the\r
+vQueueOverwritePeriodicISRDemo() function. */\r
+static BaseType_t xISRTestStatus = pdPASS;\r
+\r
+/* The queue that is accessed from the ISR.  The queue accessed by the task is\r
+created inside the task itself. */\r
+static QueueHandle_t xISRQueue = NULL;\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
-void vStartQueueOverwriteTask( unsigned portBASE_TYPE uxPriority )\r
+void vStartQueueOverwriteTask( UBaseType_t uxPriority )\r
 {\r
-       /* Create the test task. */\r
-       xTaskCreate( prvQueueOverwriteTask, ( signed char * ) "QOver", configMINIMAL_STACK_SIZE, NULL, uxPriority, ( xTaskHandle * ) NULL );\r
+const UBaseType_t uxQueueLength = 1;\r
+\r
+       /* Create the queue used by the ISR.  xQueueOverwriteFromISR() should only\r
+       be used on queues that have a length of 1. */\r
+       xISRQueue = xQueueCreate( uxQueueLength, ( UBaseType_t ) sizeof( uint32_t ) );\r
+\r
+       /* Create the test task.  The queue used by the test task is created inside\r
+       the task itself. */\r
+       xTaskCreate( prvQueueOverwriteTask, "QOver", configMINIMAL_STACK_SIZE, NULL, uxPriority, ( TaskHandle_t * ) NULL );\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
 static void prvQueueOverwriteTask( void *pvParameters )\r
 {\r
-xQueueHandle xQueue;\r
-const unsigned portBASE_TYPE uxQueueLength = 1;\r
-unsigned long ulValue, ulStatus = pdPASS, x;\r
+QueueHandle_t xTaskQueue;\r
+const UBaseType_t uxQueueLength = 1;\r
+uint32_t ulValue, ulStatus = pdPASS, x;\r
 \r
        /* The parameter is not used. */\r
        ( void ) pvParameters;\r
 \r
        /* Create the queue.  xQueueOverwrite() should only be used on queues that\r
        have a length of 1. */\r
-       xQueue = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( unsigned long ) );\r
-       configASSERT( xQueue );\r
+       xTaskQueue = xQueueCreate( uxQueueLength, ( UBaseType_t ) sizeof( uint32_t ) );\r
+       configASSERT( xTaskQueue );\r
 \r
        for( ;; )\r
        {\r
                /* The queue is empty.  Writing to the queue then reading from the queue\r
                should return the item written. */\r
                ulValue = 10;\r
-               xQueueOverwrite( xQueue, &ulValue );\r
+               xQueueOverwrite( xTaskQueue, &ulValue );\r
 \r
                ulValue = 0;\r
-               xQueueReceive( xQueue, &ulValue, qoDONT_BLOCK );\r
+               xQueueReceive( xTaskQueue, &ulValue, qoDONT_BLOCK );\r
 \r
                if( ulValue != 10 )\r
                {\r
@@ -141,27 +151,27 @@ unsigned long ulValue, ulStatus = pdPASS, x;
                for( x = 0; x < qoLOOPS; x++ )\r
                {\r
                        /* Write to the queue. */\r
-                       xQueueOverwrite( xQueue, &x );\r
+                       xQueueOverwrite( xTaskQueue, &x );\r
 \r
                        /* Check the value in the queue is that written, even though the\r
                        queue was not necessarily empty. */\r
-                       xQueuePeek( xQueue, &ulValue, qoDONT_BLOCK );\r
+                       xQueuePeek( xTaskQueue, &ulValue, qoDONT_BLOCK );\r
                        if( ulValue != x )\r
                        {\r
                                ulStatus = pdFAIL;\r
                        }\r
 \r
                        /* There should always be one item in the queue. */\r
-                       if( uxQueueMessagesWaiting( xQueue ) != uxQueueLength )\r
+                       if( uxQueueMessagesWaiting( xTaskQueue ) != uxQueueLength )\r
                        {\r
                                ulStatus = pdFAIL;\r
                        }\r
                }\r
 \r
                /* Empty the queue again. */\r
-               xQueueReceive( xQueue, &ulValue, qoDONT_BLOCK );\r
+               xQueueReceive( xTaskQueue, &ulValue, qoDONT_BLOCK );\r
 \r
-               if( uxQueueMessagesWaiting( xQueue ) != 0 )\r
+               if( uxQueueMessagesWaiting( xTaskQueue ) != 0 )\r
                {\r
                        ulStatus = pdFAIL;\r
                }\r
@@ -172,15 +182,23 @@ unsigned long ulValue, ulStatus = pdPASS, x;
                        error. */\r
                        ulLoopCounter++;\r
                }\r
+\r
+               #if( configUSE_PREEMPTION == 0 )\r
+                       taskYIELD();\r
+               #endif\r
        }\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-portBASE_TYPE xIsQueueOverwriteTaskStillRunning( void )\r
+BaseType_t xIsQueueOverwriteTaskStillRunning( void )\r
 {\r
-portBASE_TYPE xReturn;\r
+BaseType_t xReturn;\r
 \r
-       if( ulLoopCounter > 0 )\r
+       if( xISRTestStatus != pdPASS )\r
+       {\r
+               xReturn = pdFAIL;\r
+       }\r
+       else if( ulLoopCounter > 0 )\r
        {\r
                xReturn = pdPASS;\r
        }\r
@@ -194,4 +212,61 @@ portBASE_TYPE xReturn;
 \r
        return xReturn;\r
 }\r
+/*-----------------------------------------------------------*/\r
+\r
+void vQueueOverwritePeriodicISRDemo( void )\r
+{\r
+static uint32_t ulCallCount = 0;\r
+const uint32_t ulTx1 = 10UL, ulTx2 = 20UL, ulNumberOfSwitchCases = 3UL;\r
+uint32_t ulRx;\r
+\r
+       /* This function should be called from an interrupt, such as the tick hook\r
+       function vApplicationTickHook(). */\r
+\r
+       configASSERT( xISRQueue );\r
+\r
+       switch( ulCallCount )\r
+       {\r
+               case 0:\r
+                       /* The queue is empty.  Write ulTx1 to the queue.  In this demo the\r
+                       last parameter is not used because there are no tasks blocked on\r
+                       this queue. */\r
+                       xQueueOverwriteFromISR( xISRQueue, &ulTx1, NULL );\r
+\r
+                       /* Peek the queue to check it holds the expected value. */\r
+                       xQueuePeekFromISR( xISRQueue, &ulRx );\r
+                       if( ulRx != ulTx1 )\r
+                       {\r
+                               xISRTestStatus = pdFAIL;\r
+                       }\r
+                       break;\r
+\r
+               case 1:\r
+                       /* The queue already holds ulTx1.  Overwrite the value in the queue\r
+                       with ulTx2. */\r
+                       xQueueOverwriteFromISR( xISRQueue, &ulTx2, NULL );\r
+                       break;\r
+\r
+               case 2:\r
+                       /* Read from the queue to empty the queue again.  The value read\r
+                       should be ulTx2. */\r
+                       xQueueReceiveFromISR( xISRQueue, &ulRx, NULL );\r
+\r
+                       if( ulRx != ulTx2 )\r
+                       {\r
+                               xISRTestStatus = pdFAIL;\r
+                       }\r
+                       break;\r
+       }\r
+\r
+       /* Run the next case in the switch statement above next time this function\r
+       is called. */\r
+       ulCallCount++;\r
+\r
+       if( ulCallCount >= ulNumberOfSwitchCases )\r
+       {\r
+               /* Go back to the start. */\r
+               ulCallCount = 0;\r
+       }\r
+}\r
 \r