]> git.sur5r.net Git - freertos/commitdiff
Update the names of some of the newly introduced API functions so they are more consi...
authorrichardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Sun, 7 Aug 2011 10:22:20 +0000 (10:22 +0000)
committerrichardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Sun, 7 Aug 2011 10:22:20 +0000 (10:22 +0000)
git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@1542 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

Source/include/FreeRTOS.h
Source/include/task.h
Source/include/timers.h

index ffed4cbed30f96430db459622401692f2cbfdd3e..88a711c596e9a3243b28aedde9a7cc3d973d31e7 100644 (file)
@@ -134,12 +134,16 @@ typedef portBASE_TYPE (*pdTASK_HOOK_CODE)( void * );
        #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
 #endif\r
 \r
-#ifndef INCLUDE_xTaskGetIdleTaskHandle\r
-       #define INCLUDE_xTaskGetIdleTaskHandle 0\r
+#ifndef INCLUDE_xTaskIdleTaskHandleGet\r
+       #define INCLUDE_xTaskIdleTaskHandleGet 0\r
 #endif\r
 \r
-#ifndef INCLUDE_xTimerGetTimerTaskHandle\r
-       #define INCLUDE_xTimerGetTimerTaskHandle 0\r
+#ifndef INCLUDE_xTimerDaemonTaskHandleGet\r
+       #define INCLUDE_xTimerDaemonTaskHandleGet 0\r
+#endif\r
+\r
+#ifndef INCLUDE_pcTaskNameGet\r
+       #define INCLUDE_pcTaskNameGet 0\r
 #endif\r
 \r
 #ifndef configUSE_APPLICATION_TASK_TAG\r
index 01c2a584fbc06de8e3b5136ada87e1a8852a0e6f..44950ee451e87f2dfce1303523b664786b38994a 100644 (file)
@@ -1007,16 +1007,17 @@ unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION;
 \r
 /**\r
  * task. h\r
- * <PRE>signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery );</PRE>\r
+ * <PRE>signed char *pcTaskNameGet( 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.\r
+ * handle, or by setting xTaskToQuery to NULL.  INCLUDE_pcTaskNameGet must be\r
+ * set to 1 in FreeRTOSConfig.h for pcTaskNameGet() to be available.\r
  *\r
- * \page pcTaskGetTaskName pcTaskGetTaskName\r
+ * \page pcTaskNameGet pcTasknameGet\r
  * \ingroup TaskUtils\r
  */\r
-signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery );\r
+signed char *pcTaskNameGet( xTaskHandle xTaskToQuery );\r
 \r
 /**\r
  * task. h\r
@@ -1171,13 +1172,13 @@ constant. */
 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
+ * xTaskIdleTaskHandleGet() is only available if \r
+ * INCLUDE_xTaskIdleTaskHandleGet 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
+ * xTaskIdleTaskHandleGet() before the scheduler has been started.\r
  */\r
-xTaskHandle xTaskGetIdleTaskHandle( void );\r
+xTaskHandle xTaskIdleTaskHandleGet( void );\r
 \r
 /*-----------------------------------------------------------\r
  * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES\r
index 578f05b432cc90911e06389998344c744d2c6f13..849f048924549a24a4edb65bd54e21a6b4422d41 100644 (file)
@@ -67,6 +67,7 @@
 \r
 #include "portable.h"\r
 #include "list.h"\r
+#include "task.h"\r
 \r
 #ifdef __cplusplus\r
 extern "C" {\r
@@ -284,13 +285,13 @@ void *pvTimerGetTimerID( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;
 portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;\r
 \r
 /**\r
- * xTimerGetTimerTaskHandle() is only available if \r
- * INCLUDE_xTimerGetTimerTaskHandle is set to 1 in FreeRTOSConfig.h.\r
+ * xTimerDaemonTaskHandleGet() is only available if \r
+ * INCLUDE_xTimerDaemonTaskHandleGet is set to 1 in FreeRTOSConfig.h.\r
  *\r
  * Simply returns the handle of the timer service/daemon task.  It it not valid\r
- * to call xTimerGetTimerTaskHandle() before the scheduler has been started.\r
+ * to call xTimerDaemonTaskHandleGet() before the scheduler has been started.\r
  */\r
-xTaskHandle xTimerGetTimerTaskHandle( void );\r
+xTaskHandle xTimerDaemonTaskHandleGet( void );\r
 \r
 /**\r
  * portBASE_TYPE xTimerStart( xTimerHandle xTimer, portTickType xBlockTime );\r