Skip to content

Commit

Permalink
Fix #225, Add timer callback context restrictions
Browse files Browse the repository at this point in the history
Comment/document only
  • Loading branch information
skliper committed Mar 15, 2020
1 parent 1aa87de commit 4b19a1a
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions src/os/inc/osapi-os-timer.h
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,9 @@ int32 OS_TimeBaseGetFreeRun (uint32 timebase_id, uint32 *freerun_val);
* @note clock_accuracy comes from the underlying OS tick value. The nearest integer
* microsecond value is returned, so may not be exact.
*
* @warning Depending on the OS, the timer_callback function may be similar to an
* interrupt service routine. System calls the cause the code to block are
* generally not supported.
* @warning Depending on the OS, the callback_ptr function may be similar to an
* interrupt service routine. Calls that cause the code to block or require
* an application context (like sending events) are generally not supported.
*
* @param[out] timer_id The resource ID of the timer object
* @param[in] timer_name Name of the timer object
Expand Down Expand Up @@ -241,6 +241,10 @@ int32 OS_TimerCreate (uint32 *timer_id, const char *timer_name, uint3
* allowing a single opaque argument to be passed to the callback routine.
* The OSAL implementation does not use this parameter, and may be set NULL.
*
* @warning Depending on the OS, the callback_ptr function may be similar to an
* interrupt service routine. Calls that cause the code to block or require
* an application context (like sending events) are generally not supported.
*
* @param[out] timer_id The resource ID of the timer object
* @param[in] timer_name Name of the timer object
* @param[in] timebase_id The time base resource to use as a reference
Expand Down

0 comments on commit 4b19a1a

Please sign in to comment.