git.sur5r.net Git - freertos/blob - Source/list.c

   1 /*\r
   2     FreeRTOS V7.0.1 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5         FreeRTOS supports many tools and architectures. V7.0.0 is sponsored by:\r
   6         Atollic AB - Atollic provides professional embedded systems development \r
   7         tools for C/C++ development, code analysis and test automation.  \r
   8         See http://www.atollic.com\r
   9         \r
  10 \r
  11     ***************************************************************************\r
  12      *                                                                       *\r
  13      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  14      *    Complete, revised, and edited pdf reference manuals are also       *\r
  15      *    available.                                                         *\r
  16      *                                                                       *\r
  17      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  18      *    ensuring you get running as quickly as possible and with an        *\r
  19      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  20      *    the FreeRTOS project to continue with its mission of providing     *\r
  21      *    professional grade, cross platform, de facto standard solutions    *\r
  22      *    for microcontrollers - completely free of charge!                  *\r
  23      *                                                                       *\r
  24      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  25      *                                                                       *\r
  26      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  27      *                                                                       *\r
  28     ***************************************************************************\r
  29 \r
  30 \r
  31     This file is part of the FreeRTOS distribution.\r
  32 \r
  33     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  34     the terms of the GNU General Public License (version 2) as published by the\r
  35     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  36     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  37     distribute a combined work that includes FreeRTOS without being obliged to\r
  38     provide the source code for proprietary components outside of the FreeRTOS\r
  39     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  40     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  41     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  42     more details. You should have received a copy of the GNU General Public\r
  43     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  44     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  45     by writing to Richard Barry, contact details for whom are available on the\r
  46     FreeRTOS WEB site.\r
  47 \r
  48     1 tab == 4 spaces!\r
  49 \r
  50     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  51     contact details.\r
  52 \r
  53     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  54     critical systems.\r
  55 \r
  56     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  57     licensing and training services.\r
  58 */\r
  59 \r
  60 \r
  61 #include <stdlib.h>\r
  62 #include "FreeRTOS.h"\r
  63 #include "list.h"\r
  64 \r
  65 /*-----------------------------------------------------------\r
  66  * PUBLIC LIST API documented in list.h\r
  67  *----------------------------------------------------------*/\r
  68 \r
  69 void vListInitialise( xList *pxList )\r
  70 {\r
  71         /* The list structure contains a list item which is used to mark the\r
  72         end of the list.  To initialise the list the list end is inserted\r
  73         as the only list entry. */\r
  74         pxList->pxIndex = ( xListItem * ) &( pxList->xListEnd );\r
  75 \r
  76         /* The list end value is the highest possible value in the list to\r
  77         ensure it remains at the end of the list. */\r
  78         pxList->xListEnd.xItemValue = portMAX_DELAY;\r
  79 \r
  80         /* The list end next and previous pointers point to itself so we know\r
  81         when the list is empty. */\r
  82         pxList->xListEnd.pxNext = ( xListItem * ) &( pxList->xListEnd );\r
  83         pxList->xListEnd.pxPrevious = ( xListItem * ) &( pxList->xListEnd );\r
  84 \r
  85         pxList->uxNumberOfItems = ( unsigned portBASE_TYPE ) 0U;\r
  86 }\r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 void vListInitialiseItem( xListItem *pxItem )\r
  90 {\r
  91         /* Make sure the list item is not recorded as being on a list. */\r
  92         pxItem->pvContainer = NULL;\r
  93 }\r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96 void vListInsertEnd( xList *pxList, xListItem *pxNewListItem )\r
  97 {\r
  98 volatile xListItem * pxIndex;\r
  99 \r
 100         /* Insert a new list item into pxList, but rather than sort the list,\r
 101         makes the new list item the last item to be removed by a call to\r
 102         pvListGetOwnerOfNextEntry.  This means it has to be the item pointed to by\r
 103         the pxIndex member. */\r
 104         pxIndex = pxList->pxIndex;\r
 105 \r
 106         pxNewListItem->pxNext = pxIndex->pxNext;\r
 107         pxNewListItem->pxPrevious = pxList->pxIndex;\r
 108         pxIndex->pxNext->pxPrevious = ( volatile xListItem * ) pxNewListItem;\r
 109         pxIndex->pxNext = ( volatile xListItem * ) pxNewListItem;\r
 110         pxList->pxIndex = ( volatile xListItem * ) pxNewListItem;\r
 111 \r
 112         /* Remember which list the item is in. */\r
 113         pxNewListItem->pvContainer = ( void * ) pxList;\r
 114 \r
 115         ( pxList->uxNumberOfItems )++;\r
 116 }\r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 void vListInsert( xList *pxList, xListItem *pxNewListItem )\r
 120 {\r
 121 volatile xListItem *pxIterator;\r
 122 portTickType xValueOfInsertion;\r
 123 \r
 124         /* Insert the new list item into the list, sorted in ulListItem order. */\r
 125         xValueOfInsertion = pxNewListItem->xItemValue;\r
 126 \r
 127         /* If the list already contains a list item with the same item value then\r
 128         the new list item should be placed after it.  This ensures that TCB's which\r
 129         are stored in ready lists (all of which have the same ulListItem value)\r
 130         get an equal share of the CPU.  However, if the xItemValue is the same as\r
 131         the back marker the iteration loop below will not end.  This means we need\r
 132         to guard against this by checking the value first and modifying the\r
 133         algorithm slightly if necessary. */\r
 134         if( xValueOfInsertion == portMAX_DELAY )\r
 135         {\r
 136                 pxIterator = pxList->xListEnd.pxPrevious;\r
 137         }\r
 138         else\r
 139         {\r
 140                 /* *** NOTE ***********************************************************\r
 141                 If you find your application is crashing here then likely causes are:\r
 142                         1) Stack overflow -\r
 143                            see http://www.freertos.org/Stacks-and-stack-overflow-checking.html\r
 144                         2) Incorrect interrupt priority assignment, especially on Cortex-M3\r
 145                            parts where numerically high priority values denote low actual\r
 146                            interrupt priories, which can seem counter intuitive.  See\r
 147                            configMAX_SYSCALL_INTERRUPT_PRIORITY on http://www.freertos.org/a00110.html\r
 148                         3) Calling an API function from within a critical section or when\r
 149                            the scheduler is suspended.\r
 150                         4) Using a queue or semaphore before it has been initialised or\r
 151                            before the scheduler has been started (are interrupts firing\r
 152                            before vTaskStartScheduler() has been called?).\r
 153                 See http://www.freertos.org/FAQHelp.html for more tips.\r
 154                 **********************************************************************/\r
 155                 \r
 156                 for( pxIterator = ( xListItem * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext )\r
 157                 {\r
 158                         /* There is nothing to do here, we are just iterating to the\r
 159                         wanted insertion position. */\r
 160                 }\r
 161         }\r
 162 \r
 163         pxNewListItem->pxNext = pxIterator->pxNext;\r
 164         pxNewListItem->pxNext->pxPrevious = ( volatile xListItem * ) pxNewListItem;\r
 165         pxNewListItem->pxPrevious = pxIterator;\r
 166         pxIterator->pxNext = ( volatile xListItem * ) pxNewListItem;\r
 167 \r
 168         /* Remember which list the item is in.  This allows fast removal of the\r
 169         item later. */\r
 170         pxNewListItem->pvContainer = ( void * ) pxList;\r
 171 \r
 172         ( pxList->uxNumberOfItems )++;\r
 173 }\r
 174 /*-----------------------------------------------------------*/\r
 175 \r
 176 void vListRemove( xListItem *pxItemToRemove )\r
 177 {\r
 178 xList * pxList;\r
 179 \r
 180         pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious;\r
 181         pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;\r
 182         \r
 183         /* The list item knows which list it is in.  Obtain the list from the list\r
 184         item. */\r
 185         pxList = ( xList * ) pxItemToRemove->pvContainer;\r
 186 \r
 187         /* Make sure the index is left pointing to a valid item. */\r
 188         if( pxList->pxIndex == pxItemToRemove )\r
 189         {\r
 190                 pxList->pxIndex = pxItemToRemove->pxPrevious;\r
 191         }\r
 192 \r
 193         pxItemToRemove->pvContainer = NULL;\r
 194         ( pxList->uxNumberOfItems )--;\r
 195 }\r
 196 /*-----------------------------------------------------------*/\r
 197 \r