]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/list.h
Starting to prepare for the next release...
[freertos] / FreeRTOS / Source / include / list.h
index 7126334406e5b3fcb2afc2276a63410e27e493a4..21353f3d27f65d027f6e9d825d1631d87e41f6cf 100644 (file)
@@ -1,66 +1,22 @@
 /*\r
-    FreeRTOS V8.0.0 - Copyright (C) 2014 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
-    ***************************************************************************\r
-     *                                                                       *\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
-     *    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
-     *    Thank you!                                                         *\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
-\r
-    >>! NOTE: The modification to the GPL is included to allow you to distribute\r
-    >>! a combined work that includes FreeRTOS without being obliged to provide\r
-    >>! the source code for proprietary components outside of the FreeRTOS\r
-    >>! 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.  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
-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\r
-     *                                                                       *\r
-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\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, 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
+       OpenRTOS V8.2.1  Copyright (C) 2015 Real Time Engineers Ltd.\r
+\r
+       This file is part of the OpenRTOS product.\r
+\r
+       OpenRTOS is distributed exclusively by WITTENSTEIN high integrity systems,\r
+       and is subject to the terms of the License granted to your organization,\r
+       including its warranties and limitations on use and distribution. It cannot be\r
+       copied or reproduced in any way except as permitted by the License.\r
+\r
+       Licenses authorize use by processor, compiler, business unit, and product.\r
+       \r
+       WITTENSTEIN high integrity systems is a trading name of WITTENSTEIN\r
+       aerospace & simulation ltd, Registered Office: Brown's Court, Long Ashton\r
+       Business Park, Yanley Lane, Long Ashton, Bristol, BS41 9LB, UK.\r
+       Tel: +44 (0) 1275 395 600, fax: +44 (0) 1275 393 630.\r
+       E-mail: info@HighIntegritySystems.com\r
+\r
+       http://www.HighIntegritySystems.com\r
 */\r
 \r
 /*\r
@@ -91,6 +47,9 @@
  * \ingroup FreeRTOSIntro\r
  */\r
 \r
+#ifndef INC_FREERTOS_H\r
+       #error FreeRTOS.h must be included before list.h\r
+#endif\r
 \r
 #ifndef LIST_H\r
 #define LIST_H\r
 #ifdef __cplusplus\r
 extern "C" {\r
 #endif\r
+\r
+/* Macros that can be used to place known values within the list structures,\r
+then check that the known values do not get corrupted during the execution of\r
+the application.   These may catch the list data structures being overwritten in\r
+memory.  They will not catch data errors caused by incorrect configuration or\r
+use of FreeRTOS.*/\r
+#if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 0 )\r
+       /* Define the macros to do nothing. */\r
+       #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
+       #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
+       #define listFIRST_LIST_INTEGRITY_CHECK_VALUE\r
+       #define listSECOND_LIST_INTEGRITY_CHECK_VALUE\r
+       #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
+       #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
+       #define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList )\r
+       #define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList )\r
+       #define listTEST_LIST_ITEM_INTEGRITY( pxItem )\r
+       #define listTEST_LIST_INTEGRITY( pxList )\r
+#else\r
+       /* Define macros that add new members into the list structures. */\r
+       #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE                               TickType_t xListItemIntegrityValue1;\r
+       #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE                              TickType_t xListItemIntegrityValue2;\r
+       #define listFIRST_LIST_INTEGRITY_CHECK_VALUE                                    TickType_t xListIntegrityValue1;\r
+       #define listSECOND_LIST_INTEGRITY_CHECK_VALUE                                   TickType_t xListIntegrityValue2;\r
+\r
+       /* Define macros that set the new structure members to known values. */\r
+       #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )         ( pxItem )->xListItemIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
+       #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )        ( pxItem )->xListItemIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
+       #define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList )          ( pxList )->xListIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
+       #define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList )          ( pxList )->xListIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
+\r
+       /* Define macros that will assert if one of the structure members does not\r
+       contain its expected value. */\r
+       #define listTEST_LIST_ITEM_INTEGRITY( pxItem )          configASSERT( ( ( pxItem )->xListItemIntegrityValue1 == pdINTEGRITY_CHECK_VALUE ) && ( ( pxItem )->xListItemIntegrityValue2 == pdINTEGRITY_CHECK_VALUE ) )\r
+       #define listTEST_LIST_INTEGRITY( pxList )                       configASSERT( ( ( pxList )->xListIntegrityValue1 == pdINTEGRITY_CHECK_VALUE ) && ( ( pxList )->xListIntegrityValue2 == pdINTEGRITY_CHECK_VALUE ) )\r
+#endif /* configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES */\r
+\r
+\r
 /*\r
  * Definition of the only type of object that a list can contain.\r
  */\r
 struct xLIST_ITEM\r
 {\r
+       listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE                               /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
        configLIST_VOLATILE TickType_t xItemValue;                      /*< The value being listed.  In most cases this is used to sort the list in descending order. */\r
        struct xLIST_ITEM * configLIST_VOLATILE pxNext;         /*< Pointer to the next ListItem_t in the list. */\r
        struct xLIST_ITEM * configLIST_VOLATILE pxPrevious;     /*< Pointer to the previous ListItem_t in the list. */\r
        void * pvOwner;                                                                         /*< Pointer to the object (normally a TCB) that contains the list item.  There is therefore a two way link between the object containing the list item and the list item itself. */\r
        void * configLIST_VOLATILE pvContainer;                         /*< Pointer to the list in which this list item is placed (if any). */\r
+       listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE                              /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
 };\r
 typedef struct xLIST_ITEM ListItem_t;                                  /* For some reason lint wants this as two separate definitions. */\r
 \r
 struct xMINI_LIST_ITEM\r
 {\r
+       listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE                               /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
        configLIST_VOLATILE TickType_t xItemValue;\r
        struct xLIST_ITEM * configLIST_VOLATILE pxNext;\r
        struct xLIST_ITEM * configLIST_VOLATILE pxPrevious;\r
@@ -156,9 +156,11 @@ typedef struct xMINI_LIST_ITEM MiniListItem_t;
  */\r
 typedef struct xLIST\r
 {\r
+       listFIRST_LIST_INTEGRITY_CHECK_VALUE                            /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
        configLIST_VOLATILE UBaseType_t uxNumberOfItems;\r
        ListItem_t * configLIST_VOLATILE pxIndex;               /*< Used to walk through the list.  Points to the last item returned by a call to listGET_OWNER_OF_NEXT_ENTRY (). */\r
        MiniListItem_t xListEnd;                                                /*< List item that contains the maximum possible item value meaning it is always at the end of the list and is therefore used as a marker. */\r
+       listSECOND_LIST_INTEGRITY_CHECK_VALUE                           /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
 } List_t;\r
 \r
 /*\r
@@ -333,7 +335,7 @@ List_t * const pxConstList = ( pxList );                                                                                                    \
  * \page vListInitialise vListInitialise\r
  * \ingroup LinkedList\r
  */\r
-void vListInitialise( List_t * const pxList );\r
+void vListInitialise( List_t * const pxList ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Must be called before a list item is used.  This sets the list container to\r
@@ -344,7 +346,7 @@ void vListInitialise( List_t * const pxList );
  * \page vListInitialiseItem vListInitialiseItem\r
  * \ingroup LinkedList\r
  */\r
-void vListInitialiseItem( ListItem_t * const pxItem );\r
+void vListInitialiseItem( ListItem_t * const pxItem ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Insert a list item into a list.  The item will be inserted into the list in\r
@@ -357,7 +359,7 @@ void vListInitialiseItem( ListItem_t * const pxItem );
  * \page vListInsert vListInsert\r
  * \ingroup LinkedList\r
  */\r
-void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem );\r
+void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Insert a list item into a list.  The item will be inserted in a position\r
@@ -378,7 +380,7 @@ void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem );
  * \page vListInsertEnd vListInsertEnd\r
  * \ingroup LinkedList\r
  */\r
-void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem );\r
+void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem ) PRIVILEGED_FUNCTION;\r
 \r
 /*\r
  * Remove an item from a list.  The list item has a pointer to the list that\r
@@ -393,7 +395,7 @@ void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem );
  * \page uxListRemove uxListRemove\r
  * \ingroup LinkedList\r
  */\r
-UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove );\r
+UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove ) PRIVILEGED_FUNCTION;\r
 \r
 #ifdef __cplusplus\r
 }\r