len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-04-20 05:21:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update the names of some of the newly introduced API functions so they are more consistent with the names of pre-existing API functions.

Browse source
This commit is contained in:
Richard Barry 2011-08-07 10:22:20 +00:00
parent 405a2ca22c
commit 28629a7ea6
3 changed files with 22 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Source/include/FreeRTOS.h
View 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.
#endif
#ifndef INCLUDE_xTaskGetIdleTaskHandle
#define INCLUDE_xTaskGetIdleTaskHandle 0
#ifndef INCLUDE_xTaskIdleTaskHandleGet
#define INCLUDE_xTaskIdleTaskHandleGet 0
#endif
#ifndef INCLUDE_xTimerGetTimerTaskHandle
#define INCLUDE_xTimerGetTimerTaskHandle 0
#ifndef INCLUDE_xTimerDaemonTaskHandleGet
#define INCLUDE_xTimerDaemonTaskHandleGet 0
#endif
#ifndef INCLUDE_pcTaskNameGet
#define INCLUDE_pcTaskNameGet 0
#endif
#ifndef configUSE_APPLICATION_TASK_TAG

17
Source/include/task.h
View file

@ -1007,16 +1007,17 @@ unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION;
/**
* task. h
* <PRE>signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery );</PRE>
* <PRE>signed char *pcTaskNameGet( xTaskHandle xTaskToQuery );</PRE>
*
* @return The text (human readable) name of the task referenced by the handle
* xTaskToQueury. A task can query its own name by either passing in its own
* handle, or by setting xTaskToQuery to NULL.
* handle, or by setting xTaskToQuery to NULL. INCLUDE_pcTaskNameGet must be
* set to 1 in FreeRTOSConfig.h for pcTaskNameGet() to be available.
*
* \page pcTaskGetTaskName pcTaskGetTaskName
* \page pcTaskNameGet pcTasknameGet
* \ingroup TaskUtils
*/
signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery );
signed char *pcTaskNameGet( xTaskHandle xTaskToQuery );
/**
* task. h
@ -1171,13 +1172,13 @@ constant. */
portBASE_TYPE xTaskCallApplicationTaskHook( xTaskHandle xTask, void *pvParameter ) PRIVILEGED_FUNCTION;
/**
* xTaskGetIdleTaskHandle() is only available if
* INCLUDE_xTaskGetIdleTaskHandle is set to 1 in FreeRTOSConfig.h.
* xTaskIdleTaskHandleGet() is only available if
* INCLUDE_xTaskIdleTaskHandleGet is set to 1 in FreeRTOSConfig.h.
*
* Simply returns the handle of the idle task. It is not valid to call
* xTaskGetIdleTaskHandle() before the scheduler has been started.
* xTaskIdleTaskHandleGet() before the scheduler has been started.
*/
xTaskHandle xTaskGetIdleTaskHandle( void );
xTaskHandle xTaskIdleTaskHandleGet( void );
/*-----------------------------------------------------------
* SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES

9
Source/include/timers.h
View file

@ -67,6 +67,7 @@
#include "portable.h"
#include "list.h"
#include "task.h"
#ifdef __cplusplus
extern "C" {
@ -284,13 +285,13 @@ void *pvTimerGetTimerID( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;
portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;
/**
* xTimerGetTimerTaskHandle() is only available if
* INCLUDE_xTimerGetTimerTaskHandle is set to 1 in FreeRTOSConfig.h.
* xTimerDaemonTaskHandleGet() is only available if
* INCLUDE_xTimerDaemonTaskHandleGet is set to 1 in FreeRTOSConfig.h.
*
* Simply returns the handle of the timer service/daemon task. It it not valid
* to call xTimerGetTimerTaskHandle() before the scheduler has been started.
* to call xTimerDaemonTaskHandleGet() before the scheduler has been started.
*/
xTaskHandle xTimerGetTimerTaskHandle( void );
xTaskHandle xTimerDaemonTaskHandleGet( void );
/**
* portBASE_TYPE xTimerStart( xTimerHandle xTimer, portTickType xBlockTime );