len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-09-08 23:27:49 -04:00
Code Issues Projects Releases Packages 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
Download patch file Download diff file Expand all files Collapse all files

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 );