From d7e9567c00c300045435f3593a117883642f8b65 Mon Sep 17 00:00:00 2001 From: Renz Bagaporo Date: Tue, 9 Mar 2021 09:12:24 +0800 Subject: [PATCH] esp_system, esp_timer: fix time function description --- components/esp_system/include/esp_private/system_internal.h | 4 ++-- components/esp_timer/include/esp_timer.h | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/components/esp_system/include/esp_private/system_internal.h b/components/esp_system/include/esp_private/system_internal.h index 66912a54b4..2125fa7ff4 100644 --- a/components/esp_system/include/esp_private/system_internal.h +++ b/components/esp_system/include/esp_private/system_internal.h @@ -61,11 +61,11 @@ void esp_reset_reason_set_hint(esp_reset_reason_t hint); */ esp_reset_reason_t esp_reset_reason_get_hint(void); - /** * @brief Get the time in microseconds since startup * - * @returns time since startup in microseconds + * @returns time since g_startup_time; definition should be fixed by system time provider + * no matter the underlying timer used. */ int64_t esp_system_get_time(void); diff --git a/components/esp_timer/include/esp_timer.h b/components/esp_timer/include/esp_timer.h index 97459b45eb..bb8879cd93 100644 --- a/components/esp_timer/include/esp_timer.h +++ b/components/esp_timer/include/esp_timer.h @@ -184,8 +184,7 @@ esp_err_t esp_timer_delete(esp_timer_handle_t timer); /** * @brief Get time in microseconds since boot - * @return number of microseconds since esp_timer_init was called (this normally - * happens early during application startup). + * @return number of microseconds since underlying timer has been started */ int64_t esp_timer_get_time(void);