atomtimer: Add note regarding timer callback registrations from within timer callbacks.

This commit is contained in:
Kelvin Lawson
2013-10-01 21:57:23 +01:00
parent 0bebd89268
commit 1b8681efa4

View File

@@ -117,6 +117,12 @@ static void atomTimerDelayCallback (POINTER cb_data);
* through the time list, so the potential execution cycles cannot be
* determined in advance.
*
* Note that although the function can be called from interrupt context,
* it should not be called in the context of a timer callback interrupt.
* It modifies the internal timer list, and timer callbacks happen while
* walking the timer list, so you should not register a new timer in
* another timer's callback routine.
*
* @param[in] timer_ptr Pointer to timer descriptor
*
* @retval ATOM_OK Success