log_rpc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef LOG_RPC_H_
#define LOG_RPC_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

 
#ifdef __cplusplus
extern "C" {
#endif

enum log_rpc_level {
        LOG_RPC_LEVEL_NONE = 0,
        LOG_RPC_LEVEL_ERR,
        LOG_RPC_LEVEL_WRN,
        LOG_RPC_LEVEL_INF,
        LOG_RPC_LEVEL_DBG,
};

struct nrf_rpc_crash_info {
        uint32_t uuid;
        uint16_t reason;
        uint32_t pc;
        uint32_t lr;
        uint32_t sp;
        uint32_t xpsr;
        uint32_t assert_line;
        char assert_filename[CONFIG_LOG_BACKED_RPC_CRASH_INFO_FILENAME_SIZE];
};

typedef void (*log_rpc_history_handler_t)(enum log_rpc_level level, const char *msg,
                                          size_t msg_len);

typedef void (*log_rpc_history_threshold_reached_handler_t)(void);

void log_rpc_set_stream_level(enum log_rpc_level level);

void log_rpc_set_history_level(enum log_rpc_level level);

uint8_t log_rpc_get_history_usage_threshold(void);

size_t log_rpc_get_history_usage_current(void);

size_t log_rpc_get_history_usage_max(void);

void log_rpc_set_history_usage_threshold(log_rpc_history_threshold_reached_handler_t handler,
                                         uint8_t threshold);

int log_rpc_fetch_history(log_rpc_history_handler_t handler);

void log_rpc_stop_fetch_history(bool pause);

int log_rpc_get_crash_dump(size_t offset, uint8_t *buffer, size_t buffer_length);

int log_rpc_invalidate_crash_dump(void);

int log_rpc_get_crash_info(struct nrf_rpc_crash_info *info);

void log_rpc_echo(enum log_rpc_level level, const char *message);

void log_rpc_set_time(uint64_t now_us);
 
#ifdef __cplusplus
}
#endif

 
#endif /* LOG_RPC_H_ */