]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/FreeRTOS.h
Add the default definition of configPRECONDITION to FreeRTOS.h.
[freertos] / FreeRTOS / Source / include / FreeRTOS.h
index bb3229ad84c94e2d647a47579adf18ee89c494d7..14f98d0b0172fb6b689f8531b5c28b2dafae5c71 100644 (file)
@@ -1,71 +1,29 @@
 /*\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
-\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
-    ***************************************************************************\r
-     *                                                                       *\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
-     *    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/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
-    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 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
+ * FreeRTOS Kernel V10.2.1\r
+ * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
+ *\r
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
+ * this software and associated documentation files (the "Software"), to deal in\r
+ * the Software without restriction, including without limitation the rights to\r
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
+ * the Software, and to permit persons to whom the Software is furnished to do so,\r
+ * subject to the following conditions:\r
+ *\r
+ * The above copyright notice and this permission notice shall be included in all\r
+ * copies or substantial portions of the Software.\r
+ *\r
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
+ *\r
+ * http://www.FreeRTOS.org\r
+ * http://aws.amazon.com/freertos\r
+ *\r
+ * 1 tab == 4 spaces!\r
+ */\r
 \r
 #ifndef INC_FREERTOS_H\r
 #define INC_FREERTOS_H\r
@@ -198,6 +156,10 @@ extern "C" {
        #define INCLUDE_uxTaskGetStackHighWaterMark 0\r
 #endif\r
 \r
+#ifndef INCLUDE_uxTaskGetStackHighWaterMark2\r
+       #define INCLUDE_uxTaskGetStackHighWaterMark2 0\r
+#endif\r
+\r
 #ifndef INCLUDE_eTaskGetState\r
        #define INCLUDE_eTaskGetState 0\r
 #endif\r
@@ -279,6 +241,23 @@ extern "C" {
        #define configASSERT_DEFINED 1\r
 #endif\r
 \r
+/* configPRECONDITION should resolve to configASSERT. The CBMC proofs need a way\r
+to track assumptions and assertions.\r
+- A configPRECONDITION statement should express an implicit invariant or\r
+assumption made.\r
+- A configASSERT statement should express an invariant that must hold explicit\r
+before calling the code. */\r
+#ifndef configPRECONDITION\r
+       #define configPRECONDITION( X ) configASSERT(X)\r
+       #define configPRECONDITION_DEFINED 0\r
+#else\r
+       #define configPRECONDITION_DEFINED 1\r
+#endif\r
+\r
+#ifndef portMEMORY_BARRIER\r
+       #define portMEMORY_BARRIER()\r
+#endif\r
+\r
 /* The timers module relies on xTaskGetSchedulerState(). */\r
 #if configUSE_TIMERS == 1\r
 \r
@@ -396,6 +375,14 @@ extern "C" {
        #define traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue )\r
 #endif\r
 \r
+#ifndef traceBLOCKING_ON_QUEUE_PEEK\r
+       /* Task is about to block because it cannot read from a\r
+       queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore\r
+       upon which the read was attempted.  pxCurrentTCB points to the TCB of the\r
+       task that attempted the read. */\r
+       #define traceBLOCKING_ON_QUEUE_PEEK( pxQueue )\r
+#endif\r
+\r
 #ifndef traceBLOCKING_ON_QUEUE_SEND\r
        /* Task is about to block because it cannot write to a\r
        queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore\r
@@ -482,6 +469,10 @@ extern "C" {
        #define traceQUEUE_PEEK( pxQueue )\r
 #endif\r
 \r
+#ifndef traceQUEUE_PEEK_FAILED\r
+       #define traceQUEUE_PEEK_FAILED( pxQueue )\r
+#endif\r
+\r
 #ifndef traceQUEUE_PEEK_FROM_ISR\r
        #define traceQUEUE_PEEK_FROM_ISR( pxQueue )\r
 #endif\r
@@ -666,6 +657,58 @@ extern "C" {
        #define traceTASK_NOTIFY_GIVE_FROM_ISR()\r
 #endif\r
 \r
+#ifndef traceSTREAM_BUFFER_CREATE_FAILED\r
+       #define traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_CREATE_STATIC_FAILED\r
+       #define traceSTREAM_BUFFER_CREATE_STATIC_FAILED( xReturn, xIsMessageBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_CREATE\r
+       #define traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_DELETE\r
+       #define traceSTREAM_BUFFER_DELETE( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_RESET\r
+       #define traceSTREAM_BUFFER_RESET( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceBLOCKING_ON_STREAM_BUFFER_SEND\r
+       #define traceBLOCKING_ON_STREAM_BUFFER_SEND( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_SEND\r
+       #define traceSTREAM_BUFFER_SEND( xStreamBuffer, xBytesSent )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_SEND_FAILED\r
+       #define traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_SEND_FROM_ISR\r
+       #define traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xBytesSent )\r
+#endif\r
+\r
+#ifndef traceBLOCKING_ON_STREAM_BUFFER_RECEIVE\r
+       #define traceBLOCKING_ON_STREAM_BUFFER_RECEIVE( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_RECEIVE\r
+       #define traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_RECEIVE_FAILED\r
+       #define traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer )\r
+#endif\r
+\r
+#ifndef traceSTREAM_BUFFER_RECEIVE_FROM_ISR\r
+       #define traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength )\r
+#endif\r
+\r
 #ifndef configGENERATE_RUN_TIME_STATS\r
        #define configGENERATE_RUN_TIME_STATS 0\r
 #endif\r
@@ -736,6 +779,14 @@ extern "C" {
        #define portTASK_USES_FLOATING_POINT()\r
 #endif\r
 \r
+#ifndef portALLOCATE_SECURE_CONTEXT\r
+       #define portALLOCATE_SECURE_CONTEXT( ulSecureStackSize )\r
+#endif\r
+\r
+#ifndef portDONT_DISCARD\r
+       #define portDONT_DISCARD\r
+#endif\r
+\r
 #ifndef configUSE_TIME_SLICING\r
        #define configUSE_TIME_SLICING 1\r
 #endif\r
@@ -780,6 +831,10 @@ extern "C" {
        #define configUSE_TASK_NOTIFICATIONS 1\r
 #endif\r
 \r
+#ifndef configUSE_POSIX_ERRNO\r
+       #define configUSE_POSIX_ERRNO 0\r
+#endif\r
+\r
 #ifndef portTICK_TYPE_IS_ATOMIC\r
        #define portTICK_TYPE_IS_ATOMIC 0\r
 #endif\r
@@ -800,6 +855,13 @@ extern "C" {
        #define configSTACK_DEPTH_TYPE uint16_t\r
 #endif\r
 \r
+#ifndef configMESSAGE_BUFFER_LENGTH_TYPE\r
+       /* Defaults to size_t for backward compatibility, but can be overridden\r
+       in FreeRTOSConfig.h if lengths will always be less than the number of bytes\r
+       in a size_t. */\r
+       #define configMESSAGE_BUFFER_LENGTH_TYPE size_t\r
+#endif\r
+\r
 /* Sanity check the configuration. */\r
 #if( configUSE_TICKLESS_IDLE != 0 )\r
        #if( INCLUDE_vTaskSuspend != 1 )\r
@@ -842,6 +904,32 @@ V8 if desired. */
        #define configENABLE_BACKWARD_COMPATIBILITY 1\r
 #endif\r
 \r
+#ifndef configPRINTF\r
+       /* configPRINTF() was not defined, so define it away to nothing.  To use\r
+       configPRINTF() then define it as follows (where MyPrintFunction() is\r
+       provided by the application writer):\r
+\r
+       void MyPrintFunction(const char *pcFormat, ... );\r
+       #define configPRINTF( X )   MyPrintFunction X\r
+\r
+       Then call like a standard printf() function, but placing brackets around\r
+       all parameters so they are passed as a single parameter.  For example:\r
+       configPRINTF( ("Value = %d", MyVariable) ); */\r
+       #define configPRINTF( X )\r
+#endif\r
+\r
+#ifndef configMAX\r
+       /* The application writer has not provided their own MAX macro, so define\r
+       the following generic implementation. */\r
+       #define configMAX( a, b ) ( ( ( a ) > ( b ) ) ? ( a ) : ( b ) )\r
+#endif\r
+\r
+#ifndef configMIN\r
+       /* The application writer has not provided their own MAX macro, so define\r
+       the following generic implementation. */\r
+       #define configMIN( a, b ) ( ( ( a ) < ( b ) ) ? ( a ) : ( b ) )\r
+#endif\r
+\r
 #if configENABLE_BACKWARD_COMPATIBILITY == 1\r
        #define eTaskStateGet eTaskGetState\r
        #define portTickType TickType_t\r
@@ -869,6 +957,10 @@ V8 if desired. */
        #define pdTASK_CODE TaskFunction_t\r
        #define xListItem ListItem_t\r
        #define xList List_t\r
+\r
+       /* For libraries that break the list data hiding, and access list structure\r
+       members directly (which is not supposed to be done). */\r
+       #define pxContainer pvContainer\r
 #endif /* configENABLE_BACKWARD_COMPATIBILITY */\r
 \r
 #if( configUSE_ALTERNATIVE_API != 0 )\r
@@ -883,6 +975,75 @@ point support. */
        #define configUSE_TASK_FPU_SUPPORT 1\r
 #endif\r
 \r
+/* Set configENABLE_MPU to 1 to enable MPU support and 0 to disable it. This is\r
+currently used in ARMv8M ports. */\r
+#ifndef configENABLE_MPU\r
+       #define configENABLE_MPU 0\r
+#endif\r
+\r
+/* Set configENABLE_FPU to 1 to enable FPU support and 0 to disable it. This is\r
+currently used in ARMv8M ports. */\r
+#ifndef configENABLE_FPU\r
+       #define configENABLE_FPU 1\r
+#endif\r
+\r
+/* Set configENABLE_TRUSTZONE to 1 enable TrustZone support and 0 to disable it.\r
+This is currently used in ARMv8M ports. */\r
+#ifndef configENABLE_TRUSTZONE\r
+       #define configENABLE_TRUSTZONE 1\r
+#endif\r
+\r
+/* Set configRUN_FREERTOS_SECURE_ONLY to 1 to run the FreeRTOS ARMv8M port on\r
+the Secure Side only. */\r
+#ifndef configRUN_FREERTOS_SECURE_ONLY\r
+       #define configRUN_FREERTOS_SECURE_ONLY 0\r
+#endif\r
+\r
+/* Sometimes the FreeRTOSConfig.h settings only allow a task to be created using\r
+ * dynamically allocated RAM, in which case when any task is deleted it is known\r
+ * that both the task's stack and TCB need to be freed.  Sometimes the\r
+ * FreeRTOSConfig.h settings only allow a task to be created using statically\r
+ * allocated RAM, in which case when any task is deleted it is known that neither\r
+ * the task's stack or TCB should be freed.  Sometimes the FreeRTOSConfig.h\r
+ * settings allow a task to be created using either statically or dynamically\r
+ * allocated RAM, in which case a member of the TCB is used to record whether the\r
+ * stack and/or TCB were allocated statically or dynamically, so when a task is\r
+ * deleted the RAM that was allocated dynamically is freed again and no attempt is\r
+ * made to free the RAM that was allocated statically.\r
+ * tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is only true if it is possible for a\r
+ * task to be created using either statically or dynamically allocated RAM.  Note\r
+ * that if portUSING_MPU_WRAPPERS is 1 then a protected task can be created with\r
+ * a statically allocated stack and a dynamically allocated TCB.\r
+ *\r
+ * The following table lists various combinations of portUSING_MPU_WRAPPERS,\r
+ * configSUPPORT_DYNAMIC_ALLOCATION and configSUPPORT_STATIC_ALLOCATION and\r
+ * when it is possible to have both static and dynamic allocation:\r
+ *  +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+\r
+ * | MPU | Dynamic | Static |     Available Functions     |       Possible Allocations        | Both Dynamic and | Need Free |\r
+ * |     |         |        |                             |                                   | Static Possible  |           |\r
+ * +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+\r
+ * | 0   | 0       | 1      | xTaskCreateStatic           | TCB - Static, Stack - Static      | No               | No        |\r
+ * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|\r
+ * | 0   | 1       | 0      | xTaskCreate                 | TCB - Dynamic, Stack - Dynamic    | No               | Yes       |\r
+ * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|\r
+ * | 0   | 1       | 1      | xTaskCreate,                | 1. TCB - Dynamic, Stack - Dynamic | Yes              | Yes       |\r
+ * |     |         |        | xTaskCreateStatic           | 2. TCB - Static, Stack - Static   |                  |           |\r
+ * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|\r
+ * | 1   | 0       | 1      | xTaskCreateStatic,          | TCB - Static, Stack - Static      | No               | No        |\r
+ * |     |         |        | xTaskCreateRestrictedStatic |                                   |                  |           |\r
+ * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|\r
+ * | 1   | 1       | 0      | xTaskCreate,                | 1. TCB - Dynamic, Stack - Dynamic | Yes              | Yes       |\r
+ * |     |         |        | xTaskCreateRestricted       | 2. TCB - Dynamic, Stack - Static  |                  |           |\r
+ * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|\r
+ * | 1   | 1       | 1      | xTaskCreate,                | 1. TCB - Dynamic, Stack - Dynamic | Yes              | Yes       |\r
+ * |     |         |        | xTaskCreateStatic,          | 2. TCB - Dynamic, Stack - Static  |                  |           |\r
+ * |     |         |        | xTaskCreateRestricted,      | 3. TCB - Static, Stack - Static   |                  |           |\r
+ * |     |         |        | xTaskCreateRestrictedStatic |                                   |                  |           |\r
+ * +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+\r
+ */\r
+#define tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE      ( ( ( portUSING_MPU_WRAPPERS == 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) || \\r
+                                                                                                         ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) )\r
+\r
 /*\r
  * In line with software engineering best practice, FreeRTOS implements a strict\r
  * data hiding policy, so the real structures used by FreeRTOS to maintain the\r
@@ -895,25 +1056,40 @@ point support. */
  */\r
 struct xSTATIC_LIST_ITEM\r
 {\r
-       TickType_t xDummy1;\r
-       void *pvDummy2[ 4 ];\r
+       #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )\r
+               TickType_t xDummy1;\r
+       #endif\r
+       TickType_t xDummy2;\r
+       void *pvDummy3[ 4 ];\r
+       #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )\r
+               TickType_t xDummy4;\r
+       #endif\r
 };\r
 typedef struct xSTATIC_LIST_ITEM StaticListItem_t;\r
 \r
 /* See the comments above the struct xSTATIC_LIST_ITEM definition. */\r
 struct xSTATIC_MINI_LIST_ITEM\r
 {\r
-       TickType_t xDummy1;\r
-       void *pvDummy2[ 2 ];\r
+       #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )\r
+               TickType_t xDummy1;\r
+       #endif\r
+       TickType_t xDummy2;\r
+       void *pvDummy3[ 2 ];\r
 };\r
 typedef struct xSTATIC_MINI_LIST_ITEM StaticMiniListItem_t;\r
 \r
 /* See the comments above the struct xSTATIC_LIST_ITEM definition. */\r
 typedef struct xSTATIC_LIST\r
 {\r
-       UBaseType_t uxDummy1;\r
-       void *pvDummy2;\r
-       StaticMiniListItem_t xDummy3;\r
+       #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )\r
+               TickType_t xDummy1;\r
+       #endif\r
+       UBaseType_t uxDummy2;\r
+       void *pvDummy3;\r
+       StaticMiniListItem_t xDummy4;\r
+       #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )\r
+               TickType_t xDummy5;\r
+       #endif\r
 } StaticList_t;\r
 \r
 /*\r
@@ -967,14 +1143,16 @@ typedef struct xSTATIC_TCB
                uint32_t                ulDummy18;\r
                uint8_t                 ucDummy19;\r
        #endif\r
-       #if( ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) || ( portUSING_MPU_WRAPPERS == 1 ) )\r
+       #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )\r
                uint8_t                 uxDummy20;\r
        #endif\r
 \r
        #if( INCLUDE_xTaskAbortDelay == 1 )\r
                uint8_t ucDummy21;\r
        #endif\r
-\r
+       #if ( configUSE_POSIX_ERRNO == 1 )\r
+               int                             iDummy22;\r
+       #endif\r
 } StaticTask_t;\r
 \r
 /*\r
@@ -1069,17 +1247,41 @@ typedef struct xSTATIC_TIMER
        void                            *pvDummy1;\r
        StaticListItem_t        xDummy2;\r
        TickType_t                      xDummy3;\r
-       UBaseType_t                     uxDummy4;\r
-       void                            *pvDummy5[ 2 ];\r
+       void                            *pvDummy5;\r
+       TaskFunction_t          pvDummy6;\r
        #if( configUSE_TRACE_FACILITY == 1 )\r
-               UBaseType_t             uxDummy6;\r
+               UBaseType_t             uxDummy7;\r
        #endif\r
+       uint8_t                         ucDummy8;\r
 \r
-       #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-               uint8_t                 ucDummy7;\r
+} StaticTimer_t;\r
+\r
+/*\r
+* In line with software engineering best practice, especially when supplying a\r
+* library that is likely to change in future versions, FreeRTOS implements a\r
+* strict data hiding policy.  This means the stream buffer structure used\r
+* internally by FreeRTOS is not accessible to application code.  However, if\r
+* the application writer wants to statically allocate the memory required to\r
+* create a stream buffer then the size of the stream buffer object needs to be\r
+* know.  The StaticStreamBuffer_t structure below is provided for this purpose.\r
+* Its size and alignment requirements are guaranteed to match those of the\r
+* genuine structure, no matter which architecture is being used, and no matter\r
+* how the values in FreeRTOSConfig.h are set.  Its contents are somewhat\r
+* obfuscated in the hope users will recognise that it would be unwise to make\r
+* direct use of the structure members.\r
+*/\r
+typedef struct xSTATIC_STREAM_BUFFER\r
+{\r
+       size_t uxDummy1[ 4 ];\r
+       void * pvDummy2[ 3 ];\r
+       uint8_t ucDummy3;\r
+       #if ( configUSE_TRACE_FACILITY == 1 )\r
+               UBaseType_t uxDummy4;\r
        #endif\r
+} StaticStreamBuffer_t;\r
 \r
-} StaticTimer_t;\r
+/* Message buffers are built on stream buffers. */\r
+typedef StaticStreamBuffer_t StaticMessageBuffer_t;\r
 \r
 #ifdef __cplusplus\r
 }\r