]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/FreeRTOS.h
Add trace macros into the event groups implementation.
[freertos] / FreeRTOS / Source / include / FreeRTOS.h
index a84be03c08ce37ae710d7a495628466882f8a127..e4a1edd312dcd8bd38309b22370941bf03aa3e56 100644 (file)
@@ -1,48 +1,41 @@
 /*\r
-    FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
+    FreeRTOS V7.6.0 - Copyright (C) 2013 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
-    >>>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.  FreeRTOS is distributed in the hope that it will be useful, but\r
-    WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
-    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
-    more details. You should have received a copy of the GNU General Public\r
-    License and the FreeRTOS license exception along with FreeRTOS; if not it\r
-    can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
-    by writing to Richard Barry, contact details for whom are available on the\r
-    FreeRTOS WEB site.\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
      *                                                                       *\r
      *    Having a problem?  Start by reading the FAQ "My application does   *\r
      *                                                                       *\r
     ***************************************************************************\r
 \r
-    \r
-    http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
-    and contact details.  \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.\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
-    Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
-    the code with commercial support, indemnification, and middleware, under \r
-    the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
-    provide a safety engineered and independently SIL3 certified version under \r
-    the SafeRTOS brand: http://www.SafeRTOS.com.\r
+    1 tab == 4 spaces!\r
 */\r
 \r
 #ifndef INC_FREERTOS_H\r
@@ -95,9 +92,10 @@ is included as it is used by the port layer. */
 conform. */\r
 typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );\r
 \r
-\r
-\r
-\r
+/* The type that holds event bits always matches portTickType - therefore the\r
+number of bits it holds is set by configUSE_16_BIT_TICKS (16 bits if set to 1,\r
+32 bits if set to 0. */\r
+typedef portTickType xEventBitsType;\r
 \r
 /*\r
  * Check all the required application specific macros have been defined.\r
@@ -105,48 +103,66 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
  * within FreeRTOSConfig.h.\r
  */\r
 \r
+#ifndef configMINIMAL_STACK_SIZE\r
+       #error Missing definition:  configMINIMAL_STACK_SIZE must be defined in FreeRTOSConfig.h.  configMINIMAL_STACK_SIZE defines the size (in words) of the stack allocated to the idle task.  Refer to the demo project provided for your port for a suitable value.\r
+#endif\r
+\r
+#ifndef configMAX_PRIORITIES\r
+       #error Missing definition:  configMAX_PRIORITIES must be defined in FreeRTOSConfig.h.  See the Configuration section of the FreeRTOS API documentation for details.\r
+#endif\r
+\r
 #ifndef configUSE_PREEMPTION\r
-       #error Missing definition:  configUSE_PREEMPTION should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
+       #error Missing definition:  configUSE_PREEMPTION 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_IDLE_HOOK\r
-       #error Missing definition:  configUSE_IDLE_HOOK should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
+       #error Missing definition:  configUSE_IDLE_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_TICK_HOOK\r
-       #error Missing definition:  configUSE_TICK_HOOK should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
+       #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 should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\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 should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\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
 \r
 #ifndef INCLUDE_uxTaskPriorityGet\r
-       #error Missing definition:  INCLUDE_uxTaskPriorityGet should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
+       #error Missing definition:  INCLUDE_uxTaskPriorityGet 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_vTaskDelete            \r
-       #error Missing definition:  INCLUDE_vTaskDelete          should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
+#ifndef INCLUDE_vTaskDelete\r
+       #error Missing definition:  INCLUDE_vTaskDelete 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_vTaskSuspend   \r
-       #error Missing definition:  INCLUDE_vTaskSuspend         should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
+#ifndef INCLUDE_vTaskSuspend\r
+       #error Missing definition:  INCLUDE_vTaskSuspend 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_vTaskDelayUntil\r
-       #error Missing definition:  INCLUDE_vTaskDelayUntil should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
+       #error Missing definition:  INCLUDE_vTaskDelayUntil 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_vTaskDelay\r
-       #error Missing definition:  INCLUDE_vTaskDelay should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
+       #error Missing definition:  INCLUDE_vTaskDelay 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_16_BIT_TICKS\r
-       #error Missing definition:  configUSE_16_BIT_TICKS should be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.\r
+       #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
+#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
@@ -193,6 +209,10 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #define configUSE_TIMERS 0\r
 #endif\r
 \r
+#ifndef configUSE_EVENT_GROUPS\r
+       #define configUSE_EVENT_GROUPS 0\r
+#endif\r
+\r
 #ifndef configUSE_COUNTING_SEMAPHORES\r
        #define configUSE_COUNTING_SEMAPHORES 0\r
 #endif\r
@@ -221,12 +241,19 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #define INCLUDE_xTaskResumeFromISR 1\r
 #endif\r
 \r
-#ifndef configASSERT\r
-       #define configASSERT( x )\r
+#ifndef INCLUDE_xEventGroupSetBitFromISR\r
+       #define INCLUDE_xEventGroupSetBitFromISR 0\r
+#endif\r
+\r
+#ifndef INCLUDE_xTimerPendCallbackFromISR\r
+       #define INCLUDE_xTimerPendCallbackFromISR 0\r
 #endif\r
 \r
-#ifndef portALIGNMENT_ASSERT_pxCurrentTCB\r
-       #define portALIGNMENT_ASSERT_pxCurrentTCB configASSERT\r
+#ifndef configASSERT\r
+       #define configASSERT( x )\r
+       #define configASSERT_DEFINED 0\r
+#else\r
+       #define configASSERT_DEFINED 1\r
 #endif\r
 \r
 /* The timers module relies on xTaskGetSchedulerState(). */\r
@@ -267,6 +294,10 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #define portCLEAN_UP_TCB( pxTCB ) ( void ) pxTCB\r
 #endif\r
 \r
+#ifndef portPRE_DELETE_HOOK\r
+       #define portPRE_DELETE_HOOK( pvTaskToDelete, pxYieldPending )\r
+#endif\r
+\r
 #ifndef portSETUP_TCB\r
        #define portSETUP_TCB( pxTCB ) ( void ) pxTCB\r
 #endif\r
@@ -303,6 +334,22 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #define traceTASK_SWITCHED_IN()\r
 #endif\r
 \r
+#ifndef traceINCREASE_TICK_COUNT\r
+       /* Called before stepping the tick count after waking from tickless idle\r
+       sleep. */\r
+       #define traceINCREASE_TICK_COUNT( x )\r
+#endif\r
+\r
+#ifndef traceLOW_POWER_IDLE_BEGIN\r
+       /* Called immediately before entering tickless idle. */\r
+       #define traceLOW_POWER_IDLE_BEGIN()\r
+#endif\r
+\r
+#ifndef        traceLOW_POWER_IDLE_END\r
+       /* Called when returning to the Idle task after a tickless idle. */\r
+       #define traceLOW_POWER_IDLE_END()\r
+#endif\r
+\r
 #ifndef traceTASK_SWITCHED_OUT\r
        /* Called before a task has been selected to run.  pxCurrentTCB holds a pointer\r
        to the task control block of the task being switched out. */\r
@@ -320,7 +367,7 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
 \r
 #ifndef traceTASK_PRIORITY_DISINHERIT\r
        /* Called when a task releases a mutex, the holding of which had resulted in\r
-       the task inheriting the priority of a higher priority task.  \r
+       the task inheriting the priority of a higher priority task.\r
        pxTCBOfMutexHolder is a pointer to the TCB of the task that is releasing the\r
        mutex.  uxOriginalPriority is the task's configured (base) priority. */\r
        #define traceTASK_PRIORITY_DISINHERIT( pxTCBOfMutexHolder, uxOriginalPriority )\r
@@ -352,7 +399,7 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #define traceMOVED_TASK_TO_READY_STATE( pxTCB )\r
 #endif\r
 \r
-#ifndef traceQUEUE_CREATE      \r
+#ifndef traceQUEUE_CREATE\r
        #define traceQUEUE_CREATE( pxNewQueue )\r
 #endif\r
 \r
@@ -408,6 +455,10 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #define traceQUEUE_PEEK( pxQueue )\r
 #endif\r
 \r
+#ifndef traceQUEUE_PEEK_FROM_ISR\r
+       #define traceQUEUE_PEEK_FROM_ISR( pxQueue )\r
+#endif\r
+\r
 #ifndef traceQUEUE_RECEIVE_FAILED\r
        #define traceQUEUE_RECEIVE_FAILED( pxQueue )\r
 #endif\r
@@ -428,6 +479,10 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue )\r
 #endif\r
 \r
+#ifndef traceQUEUE_PEEK_FROM_ISR_FAILED\r
+       #define traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue )\r
+#endif\r
+\r
 #ifndef traceQUEUE_DELETE\r
        #define traceQUEUE_DELETE( pxQueue )\r
 #endif\r
@@ -492,6 +547,50 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #define traceTIMER_COMMAND_RECEIVED( pxTimer, xMessageID, xMessageValue )\r
 #endif\r
 \r
+#ifndef traceMALLOC\r
+    #define traceMALLOC( pvAddress, uiSize )\r
+#endif\r
+\r
+#ifndef traceFREE\r
+    #define traceFREE( pvAddress, uiSize )\r
+#endif\r
+\r
+#ifndef traceEVENT_GROUP_CREATE\r
+       #define traceEVENT_GROUP_CREATE( xEventGroup )\r
+#endif\r
+\r
+#ifndef traceEVENT_GROUP_CREATE_FAILED\r
+       #define traceEVENT_GROUP_CREATE_FAILED()\r
+#endif\r
+\r
+#ifndef traceEVENT_GROUP_SYNC_START\r
+       #define traceEVENT_GROUP_SYNC_START( xEventGroup, uxBitsToSet )\r
+#endif\r
+\r
+#ifndef traceEVENT_GROUP_SYNC_END\r
+       #define traceEVENT_GROUP_SYNC_END( xEventGroup, uxReturn )\r
+#endif\r
+\r
+#ifndef traceEVENT_GROUP_WAIT_BITS_START\r
+       #define traceEVENT_GROUP_WAIT_BITS_START( xEventGroup, uxBitsToWaitFor )\r
+#endif\r
+\r
+#ifndef traceEVENT_GROUP_WAIT_BITS_END\r
+       #define traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxReturn )\r
+#endif\r
+\r
+#ifndef traceEVENT_GROUP_CLEAR_BITS\r
+       #define traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear )\r
+#endif\r
+\r
+#ifndef traceEVENT_GROUP_SET_BITS\r
+       #define traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet )\r
+#endif\r
+\r
+#ifndef traceEVENT_GROUP_DELETE\r
+       #define traceEVENT_GROUP_DELETE( xEventGroup )\r
+#endif\r
+\r
 #ifndef configGENERATE_RUN_TIME_STATS\r
        #define configGENERATE_RUN_TIME_STATS 0\r
 #endif\r
@@ -558,6 +657,38 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #define configPOST_SLEEP_PROCESSING( x )\r
 #endif\r
 \r
+#ifndef configUSE_QUEUE_SETS\r
+       #define configUSE_QUEUE_SETS 0\r
+#endif\r
+\r
+#ifndef portTASK_USES_FLOATING_POINT\r
+       #define portTASK_USES_FLOATING_POINT()\r
+#endif\r
+\r
+#ifndef configUSE_TIME_SLICING\r
+       #define configUSE_TIME_SLICING 1\r
+#endif\r
+\r
+#ifndef configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS\r
+       #define configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 0\r
+#endif\r
+\r
+#ifndef configUSE_NEWLIB_REENTRANT\r
+       #define configUSE_NEWLIB_REENTRANT 0\r
+#endif\r
+\r
+#ifndef configUSE_STATS_FORMATTING_FUNCTIONS\r
+       #define configUSE_STATS_FORMATTING_FUNCTIONS 0\r
+#endif\r
+\r
+#ifndef portASSERT_IF_INTERRUPT_PRIORITY_INVALID\r
+       #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()\r
+#endif\r
+\r
+#ifndef configUSE_TRACE_FACILITY\r
+       #define configUSE_TRACE_FACILITY 0\r
+#endif\r
+\r
 /* For backward compatability. */\r
 #define eTaskStateGet eTaskGetState\r
 \r