]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/list.c
Update version number to 8.1.2 after moving the defaulting of configUSE_PORT_OPTIMISE...
[freertos] / FreeRTOS / Source / list.c
index f0cacafa2dc0de1b8093be9352336918a5c8808d..01546e66efaf170c6cd6a5bd25da397ae4960629 100644 (file)
@@ -1,48 +1,38 @@
 /*\r
-    FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
+    FreeRTOS V8.1.2 - Copyright (C) 2014 Real Time Engineers Ltd.\r
+    All rights reserved\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
+    VISIT 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
+     *    FreeRTOS provides completely free yet professionally developed,    *\r
+     *    robust, strictly quality controlled, supported, and cross          *\r
+     *    platform software that has become a de facto standard.             *\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
+     *    Help yourself get started quickly and support the FreeRTOS         *\r
+     *    project by purchasing a FreeRTOS tutorial book, reference          *\r
+     *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
      *                                                                       *\r
-     *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
-     *                                                                       *\r
-     *    Thank you for using FreeRTOS, and thank you for your support!      *\r
+     *    Thank you!                                                         *\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
+    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
+    >>!   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.  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
+    FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
+    link: http://www.freertos.org/a00114.html\r
 \r
     1 tab == 4 spaces!\r
 \r
      *                                                                       *\r
     ***************************************************************************\r
 \r
-\r
-    http://www.FreeRTOS.org - Documentation, books, training, latest versions, \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
+    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.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
+    Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
+    licenses offer ticketed support, indemnification and 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
  * PUBLIC LIST API documented in list.h\r
  *----------------------------------------------------------*/\r
 \r
-void vListInitialise( xList *pxList )\r
+void vListInitialise( List_t * const pxList )\r
 {\r
        /* The list structure contains a list item which is used to mark the\r
        end of the list.  To initialise the list the list end is inserted\r
        as the only list entry. */\r
-       pxList->pxIndex = ( xListItem * ) &( pxList->xListEnd );\r
+       pxList->pxIndex = ( ListItem_t * ) &( pxList->xListEnd );                       /*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
 \r
        /* The list end value is the highest possible value in the list to\r
        ensure it remains at the end of the list. */\r
@@ -94,35 +85,31 @@ void vListInitialise( xList *pxList )
 \r
        /* The list end next and previous pointers point to itself so we know\r
        when the list is empty. */\r
-       pxList->xListEnd.pxNext = ( xListItem * ) &( pxList->xListEnd );\r
-       pxList->xListEnd.pxPrevious = ( xListItem * ) &( pxList->xListEnd );\r
+       pxList->xListEnd.pxNext = ( ListItem_t * ) &( pxList->xListEnd );       /*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
+       pxList->xListEnd.pxPrevious = ( ListItem_t * ) &( pxList->xListEnd );/*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
 \r
-       pxList->uxNumberOfItems = ( unsigned portBASE_TYPE ) 0U;\r
+       pxList->uxNumberOfItems = ( UBaseType_t ) 0U;\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-void vListInitialiseItem( xListItem *pxItem )\r
+void vListInitialiseItem( ListItem_t * const pxItem )\r
 {\r
        /* Make sure the list item is not recorded as being on a list. */\r
        pxItem->pvContainer = NULL;\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-void vListInsertEnd( xList *pxList, xListItem *pxNewListItem )\r
+void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem )\r
 {\r
-volatile xListItem * pxIndex;\r
+ListItem_t * const pxIndex = pxList->pxIndex;\r
 \r
        /* Insert a new list item into pxList, but rather than sort the list,\r
        makes the new list item the last item to be removed by a call to\r
-       pvListGetOwnerOfNextEntry.  This means it has to be the item pointed to by\r
-       the pxIndex member. */\r
-       pxIndex = pxList->pxIndex;\r
-\r
-       pxNewListItem->pxNext = pxIndex->pxNext;\r
-       pxNewListItem->pxPrevious = pxList->pxIndex;\r
-       pxIndex->pxNext->pxPrevious = ( volatile xListItem * ) pxNewListItem;\r
-       pxIndex->pxNext = ( volatile xListItem * ) pxNewListItem;\r
-       pxList->pxIndex = ( volatile xListItem * ) pxNewListItem;\r
+       listGET_OWNER_OF_NEXT_ENTRY(). */\r
+       pxNewListItem->pxNext = pxIndex;\r
+       pxNewListItem->pxPrevious = pxIndex->pxPrevious;\r
+       pxIndex->pxPrevious->pxNext = pxNewListItem;\r
+       pxIndex->pxPrevious = pxNewListItem;\r
 \r
        /* Remember which list the item is in. */\r
        pxNewListItem->pvContainer = ( void * ) pxList;\r
@@ -131,17 +118,16 @@ volatile xListItem * pxIndex;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-void vListInsert( xList *pxList, xListItem *pxNewListItem )\r
+void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem )\r
 {\r
-volatile xListItem *pxIterator;\r
-portTickType xValueOfInsertion;\r
+ListItem_t *pxIterator;\r
+const TickType_t xValueOfInsertion = pxNewListItem->xItemValue;\r
 \r
-       /* Insert the new list item into the list, sorted in ulListItem order. */\r
-       xValueOfInsertion = pxNewListItem->xItemValue;\r
+       /* Insert the new list item into the list, sorted in xItemValue order.\r
 \r
-       /* If the list already contains a list item with the same item value then\r
+       If the list already contains a list item with the same item value then\r
        the new list item should be placed after it.  This ensures that TCB's which\r
-       are stored in ready lists (all of which have the same ulListItem value)\r
+       are stored in ready lists (all of which have the same xItemValue value)\r
        get an equal share of the CPU.  However, if the xItemValue is the same as\r
        the back marker the iteration loop below will not end.  This means we need\r
        to guard against this by checking the value first and modifying the\r
@@ -158,17 +144,19 @@ portTickType xValueOfInsertion;
                           see http://www.freertos.org/Stacks-and-stack-overflow-checking.html\r
                        2) Incorrect interrupt priority assignment, especially on Cortex-M3\r
                           parts where numerically high priority values denote low actual\r
-                          interrupt priories, which can seem counter intuitive.  See\r
+                          interrupt priorities, which can seem counter intuitive.  See\r
                           configMAX_SYSCALL_INTERRUPT_PRIORITY on http://www.freertos.org/a00110.html\r
                        3) Calling an API function from within a critical section or when\r
-                          the scheduler is suspended.\r
+                          the scheduler is suspended, or calling an API function that does\r
+                          not end in "FromISR" from an interrupt.\r
                        4) Using a queue or semaphore before it has been initialised or\r
                           before the scheduler has been started (are interrupts firing\r
                           before vTaskStartScheduler() has been called?).\r
-               See http://www.freertos.org/FAQHelp.html for more tips.\r
+               See http://www.freertos.org/FAQHelp.html for more tips, and ensure\r
+               configASSERT() is defined!  http://www.freertos.org/a00110.html#configASSERT\r
                **********************************************************************/\r
 \r
-               for( pxIterator = ( xListItem * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext )\r
+               for( pxIterator = ( ListItem_t * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext ) /*lint !e826 !e740 The mini list structure is used as the list end to save RAM.  This is checked and valid. */\r
                {\r
                        /* There is nothing to do here, we are just iterating to the\r
                        wanted insertion position. */\r
@@ -176,9 +164,9 @@ portTickType xValueOfInsertion;
        }\r
 \r
        pxNewListItem->pxNext = pxIterator->pxNext;\r
-       pxNewListItem->pxNext->pxPrevious = ( volatile xListItem * ) pxNewListItem;\r
+       pxNewListItem->pxNext->pxPrevious = pxNewListItem;\r
        pxNewListItem->pxPrevious = pxIterator;\r
-       pxIterator->pxNext = ( volatile xListItem * ) pxNewListItem;\r
+       pxIterator->pxNext = pxNewListItem;\r
 \r
        /* Remember which list the item is in.  This allows fast removal of the\r
        item later. */\r
@@ -188,22 +176,24 @@ portTickType xValueOfInsertion;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-unsigned portBASE_TYPE uxListRemove( xListItem *pxItemToRemove )\r
+UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove )\r
 {\r
-xList * pxList;\r
+/* The list item knows which list it is in.  Obtain the list from the list\r
+item. */\r
+List_t * const pxList = ( List_t * ) pxItemToRemove->pvContainer;\r
 \r
        pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious;\r
        pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;\r
 \r
-       /* The list item knows which list it is in.  Obtain the list from the list\r
-       item. */\r
-       pxList = ( xList * ) pxItemToRemove->pvContainer;\r
-\r
        /* Make sure the index is left pointing to a valid item. */\r
        if( pxList->pxIndex == pxItemToRemove )\r
        {\r
                pxList->pxIndex = pxItemToRemove->pxPrevious;\r
        }\r
+       else\r
+       {\r
+               mtCOVERAGE_TEST_MARKER();\r
+       }\r
 \r
        pxItemToRemove->pvContainer = NULL;\r
        ( pxList->uxNumberOfItems )--;\r