esp_log.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
/* The enumerator spellings below are fixed by ESP-IDF: the vendored core
   passes them to esp_log_level_set() and compares against them, so they
   cannot take this project's k_ prefix. clang-tidy's naming rule is
   suppressed across the block, following the ThreadX shim precedent in
   libs/ra8_wdt_supervisor. */
/* NOLINTBEGIN(readability-identifier-naming) -- ESP-IDF-fixed spellings. */

typedef enum : uint8_t {
  ESP_LOG_NONE    = 0, 
  ESP_LOG_ERROR   = 1, 
  ESP_LOG_WARN    = 2, 
  ESP_LOG_INFO    = 3, 
  ESP_LOG_DEBUG   = 4, 
  ESP_LOG_VERBOSE = 5, 
} esp_log_level_t;
 
/* NOLINTEND(readability-identifier-naming) */
 
#ifndef LOG_LOCAL_LEVEL
#define LOG_LOCAL_LEVEL ESP_LOG_INFO
#endif /* LOG_LOCAL_LEVEL */

[[gnu::format(printf, 3, 4)]] void
ra8_esp_hosted_log_write(int level, const char* tag, const char* fmt, ...);

void ra8_esp_hosted_log_hexdump(int level, const char* tag, const void* buf, uint32_t len);

void ra8_esp_hosted_log_level_set(const char* tag, int level);

[[noreturn]] void ra8_esp_hosted_log_fatal(const char* tag, const char* expr, int code);

#define ESP_LOG_LEVEL_LOCAL(level, tag, ...)                                                       \
  do {                                                                                             \
    if ((int)(level) <= (int)LOG_LOCAL_LEVEL) {                                                    \
      ra8_esp_hosted_log_write((int)(level), (tag), __VA_ARGS__);                                  \
    }                                                                                              \
  } while (0)

#define ESP_LOGE(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_ERROR, (tag), __VA_ARGS__)

#define ESP_LOGW(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_WARN, (tag), __VA_ARGS__)

#define ESP_LOGI(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_INFO, (tag), __VA_ARGS__)

#define ESP_LOGD(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_DEBUG, (tag), __VA_ARGS__)

#define ESP_LOGV(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_VERBOSE, (tag), __VA_ARGS__)

#define ESP_EARLY_LOGE(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_ERROR, (tag), __VA_ARGS__)

#define ESP_EARLY_LOGW(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_WARN, (tag), __VA_ARGS__)

#define ESP_EARLY_LOGI(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_INFO, (tag), __VA_ARGS__)

#define ESP_EARLY_LOGD(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_DEBUG, (tag), __VA_ARGS__)

#define ESP_EARLY_LOGV(tag, ...) ESP_LOG_LEVEL_LOCAL(ESP_LOG_VERBOSE, (tag), __VA_ARGS__)

#define ESP_LOG_BUFFER_HEXDUMP(tag, buf, len, level)                                               \
  do {                                                                                             \
    if ((int)(level) <= (int)LOG_LOCAL_LEVEL) {                                                    \
      ra8_esp_hosted_log_hexdump((int)(level), (tag), (buf), (uint32_t)(len));                     \
    }                                                                                              \
  } while (0)

/* NOLINTNEXTLINE(readability-identifier-naming) -- ESP-IDF-fixed lower-case spelling. */
#define esp_log_level_set(tag, level) ra8_esp_hosted_log_level_set((tag), (int)(level))

#define ESP_ERROR_CHECK(x)                                                                         \
  do {                                                                                             \
    const int ra8_esp_hosted_rc_ = (int)(x);                                                       \
    if (ra8_esp_hosted_rc_ != 0) {                                                                 \
      ra8_esp_hosted_log_fatal(TAG, #x, ra8_esp_hosted_rc_);                                       \
    }                                                                                              \
  } while (0)

#define ESP_ERROR_CHECK_WITHOUT_ABORT(x)                                                           \
  do {                                                                                             \
    const int ra8_esp_hosted_rc_ = (int)(x);                                                       \
    if (ra8_esp_hosted_rc_ != 0) {                                                                 \
      ESP_LOGE(TAG, "%s returned 0x%x", #x, ra8_esp_hosted_rc_);                                   \
    }                                                                                              \
  } while (0)