hpm_log.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef HPM_LOG_H
#define HPM_LOG_H
 
#include <stdint.h>
#include <string.h>
#include <stdio.h>
 
#ifndef HPM_LOG_CONFIG_MAX_ENGINE_NUM
#define HPM_LOG_CONFIG_MAX_ENGINE_NUM 1
#endif
 
#ifndef HPM_LOG_CONFIG_MAX_MESSAGE_LEN
#define HPM_LOG_CONFIG_MAX_MESSAGE_LEN 256
#endif
 
#ifndef HPM_LOG_CONFIG_ENABLE_TIMESTAMP
#define HPM_LOG_CONFIG_ENABLE_TIMESTAMP 1
#endif
 
#ifndef HPM_LOG_CONFIG_ENABLE_FUNC_NAME
#define HPM_LOG_CONFIG_ENABLE_FUNC_NAME 1
#endif
 
#ifndef HPM_LOG_CONFIG_LEVEL
#define HPM_LOG_CONFIG_LEVEL HPM_LOG_LEVEL_DEBUG
#endif
 
#define HPM_LOG_FAST_FUNC
 
#define HPM_LOG_LEVEL_DEBUG 4
 
#define HPM_LOG_LEVEL_INFO  3
 
#define HPM_LOG_LEVEL_WARN  2
 
#define HPM_LOG_LEVEL_ERR   1
 
typedef struct hpm_log_engine hpm_log_engine_t;
 
typedef struct hpm_log_engine_config {
    void (*transfer_start)(const char *buf, uint32_t len);
    void (*transfer_block)(const char *buf, uint32_t len);
    char *transfer_buf;
    uint32_t max_transfer_size;
    char *fifo_buf;
    uint32_t fifo_buf_size;
} hpm_log_engine_config_t;
 
typedef struct hpm_log_config {
    uint64_t (*get_timestamp)(void);
    long (*critical_enter)(void);
    void (*critical_exit)(long val);
} hpm_log_config_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
hpm_log_engine_t *hpm_log_engine_create(hpm_log_engine_config_t *cfg);
 
int hpm_log_engine_destroy(hpm_log_engine_t *engine);
 
void hpm_log_engine_enable(hpm_log_engine_t *engine);
 
void hpm_log_engine_disable(hpm_log_engine_t *engine);
 
HPM_LOG_FAST_FUNC void hpm_log_engine_transfer_finish(hpm_log_engine_t *engine);
 
HPM_LOG_FAST_FUNC void hpm_log_engine_dump(hpm_log_engine_t *engine);
 
void hpm_log_init(hpm_log_config_t *cfg);
 
void hpm_log_printf(const char *fmt, ...);
 
void hpm_log_write(int level, const char *func, const int line, const char *fmt, ...);
 
#ifdef __cplusplus
}
#endif
 
#define HPM_LOG_PRINTF(fmt, ...) hpm_log_printf(fmt, ##__VA_ARGS__);
 
#if HPM_LOG_CONFIG_LEVEL >= HPM_LOG_LEVEL_DEBUG
#define HPM_LOG_DEBUG(fmt, ...) ({\
    hpm_log_write(HPM_LOG_LEVEL_DEBUG, __func__, __LINE__, fmt, ##__VA_ARGS__);\
})
#else
#define HPM_LOG_DEBUG(fmt, ...)
#endif
 
#if HPM_LOG_CONFIG_LEVEL >= HPM_LOG_LEVEL_INFO
#define HPM_LOG_INFO(fmt, ...) ({\
    hpm_log_write(HPM_LOG_LEVEL_INFO, __func__, __LINE__, fmt, ##__VA_ARGS__);\
})
#else
#define HPM_LOG_INFO(fmt, ...)
#endif
 
#if HPM_LOG_CONFIG_LEVEL >= HPM_LOG_LEVEL_WARN
#define HPM_LOG_WARN(fmt, ...) ({\
    hpm_log_write(HPM_LOG_LEVEL_WARN, __func__, __LINE__, fmt, ##__VA_ARGS__);\
})
#else
#define HPM_LOG_WARN(fmt, ...)
#endif
 
#if HPM_LOG_CONFIG_LEVEL >= HPM_LOG_LEVEL_ERR
#define HPM_LOG_ERR(fmt, ...) ({\
    hpm_log_write(HPM_LOG_LEVEL_ERR, __func__, __LINE__, fmt, ##__VA_ARGS__);\
})
#else
#define HPM_LOG_ERR(fmt, ...)
#endif
 
#endif