Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-05-26 10:46:28 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

sched/hrtimer: Update the documentation.

Browse Source 
This commit updated the documentation.

Signed-off-by: ouyangxiangzhen <ouyangxiangzhen@xiaomi.com>
This commit is contained in:
ouyangxiangzhen
2026-01-12 10:03:22 +08:00
committed by GUIDINGLI
parent 02aaa976fd
commit b968070829
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/reference/os/time_clock.rst
+6 -2
View File
@@ -745,12 +745,15 @@ that returns immediately without waiting for the timer to stop executing.
**POSIX Compatibility:** This is a NON-POSIX interface.
.. c:function:: int hrtimer_start(FAR hrtimer_t *hrtimer, uint64_t ns, \
.. c:function:: int hrtimer_start(FAR hrtimer_t *hrtimer, \
hrtimer_entry_t func, \
uint64_t expired, \
enum hrtimer_mode_e mode)
This function starts a high-resolution timer in absolute or relative mode.
:param hrtimer: Timer instance to cancel
:param func: Expiration callback function
:param ns: Timer expiration in nanoseconds (absolute or relative)
:param mode: HRTIMER_MODE_ABS or HRTIMER_MODE_REL
@@ -758,7 +761,8 @@ that returns immediately without waiting for the timer to stop executing.
**POSIX Compatibility:** This is a NON-POSIX interface.
.. c:type:: uint64_t (*hrtimer_cb)(FAR hrtimer_t *hrtimer, uint64_t expired)
.. c:type:: uint64_t (*hrtimer_entry_t)(FAR hrtimer_t *hrtimer, \
uint64_t expired)
**High-resolution Timer Callback**: when a hrtimer expires,
the callback function with this type is called.