mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
58 lines
1.8 KiB
C
58 lines
1.8 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Get the timestamp in milliseconds for logging.
|
|
*
|
|
* This function retrieves the timestamp in milliseconds for logging purposes.
|
|
*
|
|
* @param[in] critical Flag indicating whether the timestamp is needed for a critical log.
|
|
* If this flag is true, it means the function is called in one of the following states:
|
|
* - early stage, when the Freertos scheduler is not running,
|
|
* - ISR,
|
|
* - CACHE is disabled.
|
|
*
|
|
* If the critical flag is set then uint32 timestamp is returned due to cpu ticks being used for this case.
|
|
* For some applications this uint32 timestamp may overflow after 4294967295/1000/86400 = 49 days of operation.
|
|
*
|
|
* @return The uint64 timestamp in milliseconds.
|
|
*/
|
|
uint64_t esp_log_timestamp64(bool critical);
|
|
|
|
/**
|
|
* @brief Convert the uint64 timestamp to a string representation.
|
|
*
|
|
* This function converts the uint64 timestamp in milliseconds to a string representation.
|
|
* The string representation depends on Kconfig options:
|
|
* - Milliseconds since boot,
|
|
* - Date and time,
|
|
* - Time.
|
|
*
|
|
* @param[in] critical Flag indicating whether the timestamp is critical. If this flag is true,
|
|
* it means the function is called in one of the following states:
|
|
* - early stage, when the Freertos scheduler is not running,
|
|
* - ISR,
|
|
* - CACHE is disabled.
|
|
* @param[in] timestamp_ms The timestamp to convert, in milliseconds.
|
|
* @param[out] buffer Pointer to the buffer where the string representation will be stored.
|
|
*
|
|
* @return Pointer to the buffer containing the string representation of the timestamp.
|
|
*/
|
|
char* esp_log_timestamp_str(bool critical, uint64_t timestamp_ms, char* buffer);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|