]> git.sur5r.net Git - freertos/blobdiff - Source/include/task.h
Start to re-arrange files to include FreeRTOS+ in main download.
[freertos] / Source / include / task.h
index b8ac454f8fc2af37c3433cf80dcc449b49fce335..3f462ff3ee8e947041650d7b34eb210e523d9cf2 100644 (file)
@@ -1,12 +1,6 @@
 /*\r
-    FreeRTOS V7.0.0 - Copyright (C) 2011 Real Time Engineers Ltd.\r
-       \r
+    FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
 \r
-       FreeRTOS supports many tools and architectures. V7.0.0 is sponsored by:\r
-       Atollic AB - Atollic provides professional embedded systems development \r
-       tools for C/C++ development, code analysis and test automation.  \r
-       See http://www.atollic.com\r
-       \r
 \r
     ***************************************************************************\r
      *                                                                       *\r
 \r
     1 tab == 4 spaces!\r
 \r
-    http://www.FreeRTOS.org - Documentation, latest information, license and\r
-    contact details.\r
-\r
-    http://www.SafeRTOS.com - A version that is certified for use in safety\r
-    critical systems.\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.OpenRTOS.com - Commercial support, development, porting,\r
-    licensing and training services.\r
+       \r
+    http://www.FreeRTOS.org - Documentation, training, latest information, \r
+    license and contact details.\r
+       \r
+       http://www.FreeRTOS.org/plus - Selection of FreeRTOS ecosystem products,\r
+       including FreeRTOS+Trace - an indispensable productivity tool.\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
 */\r
 \r
 \r
@@ -76,7 +84,7 @@ extern "C" {
  * MACROS AND DEFINITIONS\r
  *----------------------------------------------------------*/\r
 \r
-#define tskKERNEL_VERSION_NUMBER "V7.0.0"\r
+#define tskKERNEL_VERSION_NUMBER "V7.1.1"\r
 \r
 /**\r
  * task. h\r
@@ -1005,6 +1013,20 @@ portTickType xTaskGetTickCountFromISR( void ) PRIVILEGED_FUNCTION;
  */\r
 unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION;\r
 \r
+/**\r
+ * task. h\r
+ * <PRE>signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery );</PRE>\r
+ *\r
+ * @return The text (human readable) name of the task referenced by the handle\r
+ * xTaskToQueury.  A task can query its own name by either passing in its own\r
+ * handle, or by setting xTaskToQuery to NULL.  INCLUDE_pcTaskGetTaskName must be\r
+ * set to 1 in FreeRTOSConfig.h for pcTaskGetTaskName() to be available.\r
+ *\r
+ * \page pcTaskGetTaskName pcTaskGetTaskName\r
+ * \ingroup TaskUtils\r
+ */\r
+signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery );\r
+\r
 /**\r
  * task. h\r
  * <PRE>void vTaskList( char *pcWriteBuffer );</PRE>\r
@@ -1157,6 +1179,14 @@ constant. */
  */\r
 portBASE_TYPE xTaskCallApplicationTaskHook( xTaskHandle xTask, void *pvParameter ) PRIVILEGED_FUNCTION;\r
 \r
+/**\r
+ * xTaskGetIdleTaskHandle() is only available if \r
+ * INCLUDE_xTaskGetIdleTaskHandle is set to 1 in FreeRTOSConfig.h.\r
+ *\r
+ * Simply returns the handle of the idle task.  It is not valid to call\r
+ * xTaskGetIdleTaskHandle() before the scheduler has been started.\r
+ */\r
+xTaskHandle xTaskGetIdleTaskHandle( void );\r
 \r
 /*-----------------------------------------------------------\r
  * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES\r
@@ -1229,19 +1259,6 @@ void vTaskPlaceOnEventListRestricted( const xList * const pxEventList, portTickT
  */\r
 signed portBASE_TYPE xTaskRemoveFromEventList( const xList * const pxEventList ) PRIVILEGED_FUNCTION;\r
 \r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE.  IT IS AN\r
- * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * INCLUDE_vTaskCleanUpResources and INCLUDE_vTaskSuspend must be defined as 1\r
- * for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Empties the ready and delayed queues of task control blocks, freeing the\r
- * memory allocated for the task control block and task stacks as it goes.\r
- */\r
-void vTaskCleanUpResources( void ) PRIVILEGED_FUNCTION;\r
-\r
 /*\r
  * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE.  IT IS ONLY\r
  * INTENDED FOR USE WHEN IMPLEMENTING A PORT OF THE SCHEDULER AND IS\r
@@ -1298,6 +1315,18 @@ void vTaskPriorityDisinherit( xTaskHandle * const pxMutexHolder ) PRIVILEGED_FUN
  */\r
 signed portBASE_TYPE xTaskGenericCreate( pdTASK_CODE pxTaskCode, const signed char * const pcName, unsigned short usStackDepth, void *pvParameters, unsigned portBASE_TYPE uxPriority, xTaskHandle *pxCreatedTask, portSTACK_TYPE *puxStackBuffer, const xMemoryRegion * const xRegions ) PRIVILEGED_FUNCTION;\r
 \r
+/*\r
+ * Get the uxTCBNumber assigned to the task referenced by the xTask parameter.\r
+ */\r
+unsigned portBASE_TYPE uxTaskGetTaskNumber( xTaskHandle xTask );\r
+\r
+/* \r
+ * Set the uxTCBNumber of the task referenced by the xTask parameter to\r
+ * ucHandle.\r
+ */\r
+void vTaskSetTaskNumber( xTaskHandle xTask, unsigned portBASE_TYPE uxHandle );\r
+\r
+\r
 #ifdef __cplusplus\r
 }\r
 #endif\r