ifx-logger.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) 2024-2026 Infineon Technologies AG
// SPDX-License-Identifier: MIT
 
#ifndef IFX_LOGGER_H
#define IFX_LOGGER_H
 
#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
 
#include "infineon/ifx-error.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define LIB_LOGGER              UINT8_C(0x0C)
 
#define IFX_LOGGER_INITIALIZE   UINT8_C(0x01)
 
#define IFX_LOGGER_LOG          UINT8_C(0x02)
 
#define IFX_LOGGER_SET_LEVEL    UINT8_C(0x03)
 
#define IFX_LOGGER_FORMAT_ERROR 0x01u
 
// Forward declaration only
typedef struct ifx_logger ifx_logger_t;
 
typedef enum
{
    IFX_LOG_DEBUG = 0,
 
    IFX_LOG_INFO = 1,
 
    IFX_LOG_WARN = 2,
 
    IFX_LOG_ERROR = 3,
 
    IFX_LOG_FATAL = 4
} ifx_log_level;
 
ifx_status_t ifx_logger_initialize(ifx_logger_t *self);
 
ifx_status_t ifx_logger_log(const ifx_logger_t *self, const char *source,
                            ifx_log_level level, const char *formatter, ...);
 
ifx_status_t ifx_logger_log_bytes(const ifx_logger_t *self, const char *source,
                                  ifx_log_level level, const char *msg,
                                  const uint8_t *data, size_t data_len,
                                  const char *delimiter);
 
typedef ifx_status_t (*ifx_logger_log_callback_t)(const ifx_logger_t *self,
                                                  const char *source,
                                                  ifx_log_level level,
                                                  const char *message);
 
ifx_status_t ifx_logger_set_level(ifx_logger_t *self, ifx_log_level level);
 
typedef ifx_status_t (*ifx_logger_set_level_callback_t)(ifx_logger_t *self,
                                                        ifx_log_level level);
 
void ifx_logger_destroy(ifx_logger_t *self);
 
typedef void (*ifx_logger_destroy_callback_t)(ifx_logger_t *self);
 
void ifx_logger_set_default(ifx_logger_t *logger);
 
extern ifx_logger_t *ifx_logger_default;
 
struct ifx_logger
{
    ifx_logger_log_callback_t _log;
 
    ifx_logger_set_level_callback_t _set_level;
 
    ifx_logger_destroy_callback_t _destructor;
 
    ifx_log_level _level;
 
    void *_data;
};
 
#ifdef __cplusplus
}
#endif
 
#endif // IFX_LOGGER_H