sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merged in antmerlino/nuttx/clock_doc (pull request #982)

Browse Source 
clock.h: Copies in missing function documentation from C file.

Approved-by: Gregory Nutt <gnutt@nuttx.org>
This commit is contained in:
Anthony Merlino 2019-08-10 17:53:48 +00:00 committed by Gregory Nutt
parent 7c06438315
commit e2ac83dff0
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
include/nuttx/clock.h
View File

@ -270,9 +270,41 @@ EXTERN volatile clock_t g_system_timer;
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: clock_timespec_add
*
* Description:
* Add timespec ts1 to to2 and return the result in ts3
*
* Input Parameters:
* ts1 and ts2: The two timespecs to be added
* t23: The location to return the result (may be ts1 or ts2)
*
* Returned Value:
* None
*
****************************************************************************/
void clock_timespec_add(FAR const struct timespec *ts1,
FAR const struct timespec *ts2,
FAR struct timespec *ts3);
/****************************************************************************
* Name: clock_timespec_subtract
*
* Description:
* Subtract timespec ts2 from to1 and return the result in ts3.
* Zero is returned if the time difference is negative.
*
* Input Parameters:
* ts1 and ts2: The two timespecs to be subtracted (ts1 - ts2)
* t23: The location to return the result (may be ts1 or ts2)
*
* Returned Value:
* None
*
****************************************************************************/
void clock_timespec_subtract(FAR const struct timespec *ts1,
FAR const struct timespec *ts2,
FAR struct timespec *ts3);