ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

updating the comment header for set_interrupt() with a note.

pull/932/head
Rohit Grover 2015-02-25 15:02:11 +00:00 committed by Rohit Grover
parent 7c0e814bd4
commit ca9050e1ef
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
libraries/mbed/targets/hal/TARGET_NORDIC/TARGET_MCU_NRF51822/us_ticker.c
View File

@ -183,7 +183,7 @@ uint32_t us_ticker_read()
/**
* Setup the us_ticker callback interrupt to go at the given timestamp.
*
* @Note: only one callback is pending at any time.
* @Note: Only one callback is pending at any time.
*
* @Note: If a callback is pending, and this function is called again, the new
* callback-time overrides the existing callback setting. It is the caller's
@ -193,6 +193,12 @@ uint32_t us_ticker_read()
* @Note: If this function is used to setup an interrupt which is immediately
* pending--such as for 'now' or a time in the past,--then the callback is
* invoked right-away.
*
* @Note: Calling this function may result in the invocation of the callback.
* Data-structures accessed by the callback (such as linked list of
* timerEvents) should therefore be in a sane state before calling this function.
* We recommend that invoking this function should be the last thing done by the
* caller.
*/
void us_ticker_set_interrupt(timestamp_t timestamp)
{