log_frontend_stmesp_demux.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_LOGGING_LOG_FRONTEND_STMESP_DEMUX_H_
#define ZEPHYR_INCLUDE_LOGGING_LOG_FRONTEND_STMESP_DEMUX_H_
 
#include <zephyr/kernel.h>
#include <zephyr/sys/mpsc_packet.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define LOG_FRONTEND_STMESP_DEMUX_MAJOR_BITS 3

#define LOG_FRONTEND_STMESP_DEMUX_LEVEL_BITS 3

#define LOG_FRONTEND_STMESP_DEMUX_TLENGTH_BITS 15

#define LOG_FRONTEND_STMESP_DEMUX_PLENGTH_BITS 10

#define LOG_FRONTEND_STMESP_DEMUX_HAS_DATA_BITS 1

#define LOG_FRONTEND_STMESP_DEMUX_MAJOR_MAX BIT(LOG_FRONTEND_STMESP_DEMUX_MAJOR_BITS)

#define LOG_FRONTEND_STMESP_DEMUX_TYPE_LOG 0

#define LOG_FRONTEND_STMESP_DEMUX_TYPE_TRACE_POINT 1

#define LOG_FRONTEND_STMESP_DEMUX_TYPE_HW_EVENT 2

struct log_frontend_stmesp_demux_log_header {
        uint32_t major : LOG_FRONTEND_STMESP_DEMUX_MAJOR_BITS;

        uint32_t level : LOG_FRONTEND_STMESP_DEMUX_LEVEL_BITS;

        uint32_t total_len : LOG_FRONTEND_STMESP_DEMUX_TLENGTH_BITS;

        uint32_t package_len : LOG_FRONTEND_STMESP_DEMUX_PLENGTH_BITS;

        uint32_t has_data: LOG_FRONTEND_STMESP_DEMUX_HAS_DATA_BITS;
};

union log_frontend_stmesp_demux_header {
        struct log_frontend_stmesp_demux_log_header log;

        uint32_t raw;
};

struct log_frontend_stmesp_demux_packet_generic {
        MPSC_PBUF_HDR;

        uint64_t type: 2;

        uint64_t content_invalid: 1;
};

struct log_frontend_stmesp_demux_log {
        MPSC_PBUF_HDR;

        uint64_t type: 2;

        uint64_t content_invalid: 1;

        uint64_t timestamp: 59;

        struct log_frontend_stmesp_demux_log_header hdr;

        uint32_t padding;

        uint8_t data[];
};

struct log_frontend_stmesp_demux_trace_point {
        MPSC_PBUF_HDR;

        uint64_t type: 2;

        uint64_t content_invalid: 1;

        uint64_t has_data: 1;

        uint64_t timestamp: 54;

        uint64_t major: 4;

        uint16_t source_id;

        uint16_t id;

        uint32_t data;
};

struct log_frontend_stmesp_demux_hw_event {
        MPSC_PBUF_HDR;

        uint64_t type: 2;

        uint64_t content_invalid: 1;

        uint64_t timestamp: 59;

        uint8_t evt;
};

union log_frontend_stmesp_demux_packet {
        const union mpsc_pbuf_generic *rgeneric;

        union mpsc_pbuf_generic *generic;

        struct log_frontend_stmesp_demux_log *log;

        struct log_frontend_stmesp_demux_trace_point *trace_point;

        struct log_frontend_stmesp_demux_hw_event *hw_event;

        struct log_frontend_stmesp_demux_packet_generic *generic_packet;
};

struct log_frontend_stmesp_demux_config {
        const uint16_t *m_ids;

        uint32_t m_ids_cnt;

        uint32_t *source_id_buf;

        size_t source_id_buf_len;
};

int log_frontend_stmesp_demux_init(const struct log_frontend_stmesp_demux_config *config);

void log_frontend_stmesp_demux_major(uint16_t id);

void log_frontend_stmesp_demux_channel(uint16_t id);

int log_frontend_stmesp_demux_packet_start(uint32_t *data, uint64_t *ts);

int log_frontend_stmesp_demux_log0(uint16_t source_id, uint64_t *ts);

void log_frontend_stmesp_demux_source_id(uint16_t source_id);

void log_frontend_stmesp_demux_timestamp(uint64_t ts);

void log_frontend_stmesp_demux_data(uint8_t *data, size_t len);

void log_frontend_stmesp_demux_packet_end(void);

uint32_t log_frontend_stmesp_demux_get_dropped(void);

union log_frontend_stmesp_demux_packet log_frontend_stmesp_demux_claim(void);

void log_frontend_stmesp_demux_free(union log_frontend_stmesp_demux_packet packet);

const char *log_frontend_stmesp_demux_sname_get(uint32_t m_id, uint16_t s_id);

const char *log_frontend_stmesp_demux_str_get(uint32_t m_id, uint16_t s_id);

bool log_frontend_stmesp_demux_is_idle(void);

void log_frontend_stmesp_demux_reset(void);

int log_frontend_stmesp_demux_max_utilization(void);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_LOGGING_LOG_FRONTEND_STMESP_DEMUX_H_ */