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

Merge pull request #6645 from woodsking2/master 

mbed_wait_api: add comments to warn the func will lock deep sleep
pull/6842/merge
Cruz Monrreal 2018-05-08 10:54:48 -05:00 committed by GitHub
parent adcd7ec002 c9b2640f70
commit 68ad00ffb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
platform/mbed_wait_api.h
View File

@ -53,18 +53,32 @@ extern "C" {
* the accuracy of single precision floating point). * the accuracy of single precision floating point).
* *
* @param s number of seconds to wait * @param s number of seconds to wait
*
* @note
* If the RTOS is present, this function always spins to get the exact number of microseconds,
* which potentially affects power (such as preventing deep sleep) and multithread performance.
* You can avoid it by using Thread::wait().
*/ */
void wait(float s); void wait(float s);
/** Waits a number of milliseconds. /** Waits a number of milliseconds.
* *
* @param ms the whole number of milliseconds to wait * @param ms the whole number of milliseconds to wait
*
* @note
* If the RTOS is present, this function always spins to get the exact number of microseconds,
* which potentially affects power (such as preventing deep sleep) and multithread performance.
* You can avoid it by using Thread::wait().
*/ */
void wait_ms(int ms); void wait_ms(int ms);
/** Waits a number of microseconds. /** Waits a number of microseconds.
* *
* @param us the whole number of microseconds to wait * @param us the whole number of microseconds to wait
*
* @note
* If the RTOS is present, this function always spins to get the exact number of microseconds,
* which potentially affects power (such as preventing deep sleep) and multithread performance.
*/ */
void wait_us(int us); void wait_us(int us);