]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/FreeRTOS.h
Changes to the FreeRTOS code:
[freertos] / FreeRTOS / Source / include / FreeRTOS.h
index bfe731eee3be917fa68b48211827bc7bb6bb31cd..a0e55e6d8f0b4ab88d26267811f6367bcf80e343 100644 (file)
@@ -1,60 +1,64 @@
 /*\r
-    FreeRTOS V8.0.0:rc1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
+    FreeRTOS V8.2.3 - Copyright (C) 2015 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
+    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
+    >>!   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 from the following\r
+    FOR A PARTICULAR PURPOSE.  Full license text is available on 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
+     *    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 - Documentation, books, training, latest versions,\r
-    license and Real Time Engineers Ltd. contact details.\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.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
+    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
 #ifndef INC_FREERTOS_H\r
 #define INC_FREERTOS_H\r
 \r
-\r
 /*\r
  * Include the generic headers required for the FreeRTOS port being used.\r
  */\r
 #include <stddef.h>\r
-#include <stdint.h>\r
 \r
-/* Basic FreeRTOS definitions. */\r
-#include "projdefs.h"\r
+/*\r
+ * If stdint.h cannot be located then:\r
+ *   + If using GCC ensure the -nostdint options is *not* being used.\r
+ *   + Ensure the project's include path includes the directory in which your\r
+ *     compiler stores stdint.h.\r
+ *   + Set any compiler options necessary for it to support C99, as technically\r
+ *     stdint.h is only mandatory with C99 (FreeRTOS does not require C99 in any\r
+ *     other way).\r
+ *   + The FreeRTOS download includes a simple stdint.h definition that can be\r
+ *     used in cases where none is provided by the compiler.  The files only\r
+ *     contains the typedefs required to build FreeRTOS.  Read the instructions\r
+ *     in FreeRTOS/source/stdint.readme for more information.\r
+ */\r
+#include <stdint.h> /* READ COMMENT ABOVE. */\r
+\r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif\r
 \r
 /* Application specific configuration options. */\r
 #include "FreeRTOSConfig.h"\r
 \r
-/* configUSE_PORT_OPTIMISED_TASK_SELECTION must be defined before portable.h\r
-is included as it is used by the port layer. */\r
-#ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
-       #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0\r
-#endif\r
+/* Basic FreeRTOS definitions. */\r
+#include "projdefs.h"\r
 \r
 /* Definitions specific to the port being used. */\r
 #include "portable.h"\r
@@ -114,10 +129,6 @@ is included as it is used by the port layer. */
        #error Missing definition:  configUSE_TICK_HOOK must be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
 #endif\r
 \r
-#ifndef configUSE_CO_ROUTINES\r
-       #error  Missing definition:  configUSE_CO_ROUTINES must be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
 #ifndef INCLUDE_vTaskPrioritySet\r
        #error Missing definition:  INCLUDE_vTaskPrioritySet must be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
 #endif\r
@@ -146,16 +157,20 @@ is included as it is used by the port layer. */
        #error Missing definition:  configUSE_16_BIT_TICKS must be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
 #endif\r
 \r
+#ifndef configMAX_PRIORITIES\r
+       #error configMAX_PRIORITIES must be defined to be greater than or equal to 1.\r
+#endif\r
+\r
+#ifndef configUSE_CO_ROUTINES\r
+       #define configUSE_CO_ROUTINES 0\r
+#endif\r
+\r
 #if configUSE_CO_ROUTINES != 0\r
        #ifndef configMAX_CO_ROUTINE_PRIORITIES\r
                #error configMAX_CO_ROUTINE_PRIORITIES must be greater than or equal to 1.\r
        #endif\r
 #endif\r
 \r
-#ifndef configMAX_PRIORITIES\r
-       #error configMAX_PRIORITIES must be defined to be greater than or equal to 1.\r
-#endif\r
-\r
 #ifndef INCLUDE_xTaskGetIdleTaskHandle\r
        #define INCLUDE_xTaskGetIdleTaskHandle 0\r
 #endif\r
@@ -180,6 +195,10 @@ is included as it is used by the port layer. */
        #define configUSE_APPLICATION_TASK_TAG 0\r
 #endif\r
 \r
+#ifndef configNUM_THREAD_LOCAL_STORAGE_POINTERS\r
+       #define configNUM_THREAD_LOCAL_STORAGE_POINTERS 0\r
+#endif\r
+\r
 #ifndef INCLUDE_uxTaskGetStackHighWaterMark\r
        #define INCLUDE_uxTaskGetStackHighWaterMark 0\r
 #endif\r
@@ -228,12 +247,8 @@ is included as it is used by the port layer. */
        #define INCLUDE_xTaskResumeFromISR 1\r
 #endif\r
 \r
-#ifndef INCLUDE_xEventGroupSetBitFromISR\r
-       #define INCLUDE_xEventGroupSetBitFromISR 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTimerPendFunctionCallFromISR\r
-       #define INCLUDE_xTimerPendFunctionCallFromISR 0\r
+#ifndef INCLUDE_xTimerPendFunctionCall\r
+       #define INCLUDE_xTimerPendFunctionCall 0\r
 #endif\r
 \r
 #ifndef configASSERT\r
@@ -296,6 +311,7 @@ is included as it is used by the port layer. */
 #if ( configQUEUE_REGISTRY_SIZE < 1 )\r
        #define vQueueAddToRegistry( xQueue, pcName )\r
        #define vQueueUnregisterQueue( xQueue )\r
+       #define pcQueueGetQueueName( xQueue )\r
 #endif\r
 \r
 #ifndef portPOINTER_SIZE_TYPE\r
@@ -386,6 +402,10 @@ is included as it is used by the port layer. */
        #define traceMOVED_TASK_TO_READY_STATE( pxTCB )\r
 #endif\r
 \r
+#ifndef tracePOST_MOVED_TASK_TO_READY_STATE\r
+       #define tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )\r
+#endif\r
+\r
 #ifndef traceQUEUE_CREATE\r
        #define traceQUEUE_CREATE( pxNewQueue )\r
 #endif\r
@@ -550,20 +570,20 @@ is included as it is used by the port layer. */
        #define traceEVENT_GROUP_CREATE_FAILED()\r
 #endif\r
 \r
-#ifndef traceEVENT_GROUP_SYNC_START\r
-       #define traceEVENT_GROUP_SYNC_START( xEventGroup, uxBitsToSet )\r
+#ifndef traceEVENT_GROUP_SYNC_BLOCK\r
+       #define traceEVENT_GROUP_SYNC_BLOCK( xEventGroup, uxBitsToSet, uxBitsToWaitFor )\r
 #endif\r
 \r
 #ifndef traceEVENT_GROUP_SYNC_END\r
-       #define traceEVENT_GROUP_SYNC_END( xEventGroup, uxReturn )\r
+       #define traceEVENT_GROUP_SYNC_END( xEventGroup, uxBitsToSet, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred\r
 #endif\r
 \r
-#ifndef traceEVENT_GROUP_WAIT_BITS_START\r
-       #define traceEVENT_GROUP_WAIT_BITS_START( xEventGroup, uxBitsToWaitFor )\r
+#ifndef traceEVENT_GROUP_WAIT_BITS_BLOCK\r
+       #define traceEVENT_GROUP_WAIT_BITS_BLOCK( xEventGroup, uxBitsToWaitFor )\r
 #endif\r
 \r
 #ifndef traceEVENT_GROUP_WAIT_BITS_END\r
-       #define traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxReturn )\r
+       #define traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred\r
 #endif\r
 \r
 #ifndef traceEVENT_GROUP_CLEAR_BITS\r
@@ -578,10 +598,54 @@ is included as it is used by the port layer. */
        #define traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet )\r
 #endif\r
 \r
+#ifndef traceEVENT_GROUP_SET_BITS_FROM_ISR\r
+       #define traceEVENT_GROUP_SET_BITS_FROM_ISR( xEventGroup, uxBitsToSet )\r
+#endif\r
+\r
 #ifndef traceEVENT_GROUP_DELETE\r
        #define traceEVENT_GROUP_DELETE( xEventGroup )\r
 #endif\r
 \r
+#ifndef tracePEND_FUNC_CALL\r
+       #define tracePEND_FUNC_CALL(xFunctionToPend, pvParameter1, ulParameter2, ret)\r
+#endif\r
+\r
+#ifndef tracePEND_FUNC_CALL_FROM_ISR\r
+       #define tracePEND_FUNC_CALL_FROM_ISR(xFunctionToPend, pvParameter1, ulParameter2, ret)\r
+#endif\r
+\r
+#ifndef traceQUEUE_REGISTRY_ADD\r
+       #define traceQUEUE_REGISTRY_ADD(xQueue, pcQueueName)\r
+#endif\r
+\r
+#ifndef traceTASK_NOTIFY_TAKE_BLOCK\r
+       #define traceTASK_NOTIFY_TAKE_BLOCK()\r
+#endif\r
+\r
+#ifndef traceTASK_NOTIFY_TAKE\r
+       #define traceTASK_NOTIFY_TAKE()\r
+#endif\r
+\r
+#ifndef traceTASK_NOTIFY_WAIT_BLOCK\r
+       #define traceTASK_NOTIFY_WAIT_BLOCK()\r
+#endif\r
+\r
+#ifndef traceTASK_NOTIFY_WAIT\r
+       #define traceTASK_NOTIFY_WAIT()\r
+#endif\r
+\r
+#ifndef traceTASK_NOTIFY\r
+       #define traceTASK_NOTIFY()\r
+#endif\r
+\r
+#ifndef traceTASK_NOTIFY_FROM_ISR\r
+       #define traceTASK_NOTIFY_FROM_ISR()\r
+#endif\r
+\r
+#ifndef traceTASK_NOTIFY_GIVE_FROM_ISR\r
+       #define traceTASK_NOTIFY_GIVE_FROM_ISR()\r
+#endif\r
+\r
 #ifndef configGENERATE_RUN_TIME_STATS\r
        #define configGENERATE_RUN_TIME_STATS 0\r
 #endif\r
@@ -617,7 +681,7 @@ is included as it is used by the port layer. */
 #endif\r
 \r
 #ifndef pvPortMallocAligned\r
-       #define pvPortMallocAligned( x, puxStackBuffer ) ( ( ( puxStackBuffer ) == NULL ) ? ( pvPortMalloc( ( x ) ) ) : ( puxStackBuffer ) )\r
+       #define pvPortMallocAligned( x, puxPreallocatedBuffer ) ( ( ( puxPreallocatedBuffer ) == NULL ) ? ( pvPortMalloc( ( x ) ) ) : ( puxPreallocatedBuffer ) )\r
 #endif\r
 \r
 #ifndef vPortFreeAligned\r
@@ -684,28 +748,93 @@ is included as it is used by the port layer. */
        #define mtCOVERAGE_TEST_MARKER()\r
 #endif\r
 \r
-/* For backward compatibility. */\r
-#define eTaskStateGet eTaskGetState\r
-#define portTickType TickType_t\r
-#define xTaskHandle TaskHandle_t\r
-#define xQueueHandle QueueHandle_t\r
-#define xSemaphoreHandle SemaphoreHandle_t\r
-#define xQueueSetHandle QueueSetHandle_t\r
-#define xQueueSetMemberHandle QueueSetMemberHandle_t\r
-#define xTimeOutType TimeOut_t\r
-#define xMemoryRegion MemoryRegion_t\r
-#define xTaskParameters TaskParameters_t\r
-#define xTaskStatusType        TaskStatus_t\r
-#define xTimerHandle TimerHandle_t\r
-#define xCoRoutineHandle CoRoutineHandle_t\r
-#define pdTASK_HOOK_CODE TaskHookFunction_t\r
-\r
-/* Backward compatibility within the scheduler code only - these definitions\r
-are not really required but are included for completeness. */\r
-#define tmrTIMER_CALLBACK TimerCallbackFunction_t\r
-#define pdTASK_CODE TaskFunction_t\r
-#define xListItem ListItem_t\r
-#define xList List_t\r
+#ifndef mtCOVERAGE_TEST_DELAY\r
+       #define mtCOVERAGE_TEST_DELAY()\r
+#endif\r
+\r
+#ifndef portASSERT_IF_IN_ISR\r
+       #define portASSERT_IF_IN_ISR()\r
+#endif\r
+\r
+#ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
+       #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0\r
+#endif\r
+\r
+#ifndef configAPPLICATION_ALLOCATED_HEAP\r
+       #define configAPPLICATION_ALLOCATED_HEAP 0\r
+#endif\r
+\r
+#ifndef configUSE_TASK_NOTIFICATIONS\r
+       #define configUSE_TASK_NOTIFICATIONS 1\r
+#endif\r
+\r
+#ifndef portTICK_TYPE_IS_ATOMIC\r
+       #define portTICK_TYPE_IS_ATOMIC 0\r
+#endif\r
+\r
+#ifndef configSUPPORT_STATIC_ALLOCATION\r
+       #define configSUPPORT_STATIC_ALLOCATION 0\r
+#endif\r
+\r
+#if( portTICK_TYPE_IS_ATOMIC == 0 )\r
+       /* Either variables of tick type cannot be read atomically, or\r
+       portTICK_TYPE_IS_ATOMIC was not set - map the critical sections used when\r
+       the tick count is returned to the standard critical section macros. */\r
+       #define portTICK_TYPE_ENTER_CRITICAL() portENTER_CRITICAL()\r
+       #define portTICK_TYPE_EXIT_CRITICAL() portEXIT_CRITICAL()\r
+       #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() portSET_INTERRUPT_MASK_FROM_ISR()\r
+       #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) portCLEAR_INTERRUPT_MASK_FROM_ISR( ( x ) )\r
+#else\r
+       /* The tick type can be read atomically, so critical sections used when the\r
+       tick count is returned can be defined away. */\r
+       #define portTICK_TYPE_ENTER_CRITICAL()\r
+       #define portTICK_TYPE_EXIT_CRITICAL()\r
+       #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() 0\r
+       #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) ( void ) x\r
+#endif\r
+\r
+/* Definitions to allow backward compatibility with FreeRTOS versions prior to\r
+V8 if desired. */\r
+#ifndef configENABLE_BACKWARD_COMPATIBILITY\r
+       #define configENABLE_BACKWARD_COMPATIBILITY 1\r
+#endif\r
+\r
+#if configENABLE_BACKWARD_COMPATIBILITY == 1\r
+       #define eTaskStateGet eTaskGetState\r
+       #define portTickType TickType_t\r
+       #define xTaskHandle TaskHandle_t\r
+       #define xQueueHandle QueueHandle_t\r
+       #define xSemaphoreHandle SemaphoreHandle_t\r
+       #define xQueueSetHandle QueueSetHandle_t\r
+       #define xQueueSetMemberHandle QueueSetMemberHandle_t\r
+       #define xTimeOutType TimeOut_t\r
+       #define xMemoryRegion MemoryRegion_t\r
+       #define xTaskParameters TaskParameters_t\r
+       #define xTaskStatusType TaskStatus_t\r
+       #define xTimerHandle TimerHandle_t\r
+       #define xCoRoutineHandle CoRoutineHandle_t\r
+       #define pdTASK_HOOK_CODE TaskHookFunction_t\r
+       #define portTICK_RATE_MS portTICK_PERIOD_MS\r
+\r
+       /* Backward compatibility within the scheduler code only - these definitions\r
+       are not really required but are included for completeness. */\r
+       #define tmrTIMER_CALLBACK TimerCallbackFunction_t\r
+       #define pdTASK_CODE TaskFunction_t\r
+       #define xListItem ListItem_t\r
+       #define xList List_t\r
+#endif /* configENABLE_BACKWARD_COMPATIBILITY */\r
+\r
+/* Set configUSE_TASK_FPU_SUPPORT to 0 to omit floating point support even\r
+if floating point hardware is otherwise supported by the FreeRTOS port in use.\r
+This constant is not supported by all FreeRTOS ports that include floating\r
+point support. */\r
+#ifndef configUSE_TASK_FPU_SUPPORT\r
+       #define configUSE_TASK_FPU_SUPPORT 1\r
+#endif\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
 \r
 #endif /* INC_FREERTOS_H */\r
 \r