diff --git a/platform/mbed_wait_api.h b/platform/mbed_wait_api.h index a58509f741a..10948c84ef5 100644 --- a/platform/mbed_wait_api.h +++ b/platform/mbed_wait_api.h @@ -53,18 +53,32 @@ extern "C" { * the accuracy of single precision floating point). * * @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); /** Waits a number of milliseconds. * * @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); /** Waits a number of microseconds. * * @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);