mipi_stp_decoder.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DEBUG_MIPI_STP_DECODER_H__
#define ZEPHYR_INCLUDE_DEBUG_MIPI_STP_DECODER_H__
 
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum mipi_stp_decoder_ctrl_type {
        STP_DATA4 = 1,
        STP_DATA8 = 2,
        STP_DATA16 = 4,
        STP_DATA32 = 8,
        STP_DATA64 = 16,
        STP_DECODER_NULL = 128,
        STP_DECODER_MAJOR,
        STP_DECODER_MERROR,
        STP_DECODER_CHANNEL,
        STP_DECODER_VERSION,
        STP_DECODER_FREQ,
        STP_DECODER_GERROR,
        STP_DECODER_FLAG,
        STP_DECODER_ASYNC,
        STP_DECODER_NOT_SUPPORTED,
};
 
#define STP_DECODER_TYPE2STR(_type) \
        _type == STP_DATA4 ? "DATA4" : (\
        _type == STP_DATA8 ? "DATA8" : (\
        _type == STP_DATA16 ? "DATA16" : (\
        _type == STP_DATA32 ? "DATA32" : (\
        _type == STP_DATA64 ? "DATA64" : (\
        _type == STP_DECODER_NULL ? "NULL" : (\
        _type == STP_DECODER_MAJOR ? "MAJOR" : (\
        _type == STP_DECODER_MERROR ? "MERROR" : (\
        _type == STP_DECODER_CHANNEL ? "CHANNEL" : (\
        _type == STP_DECODER_VERSION ? "VERSION" : (\
        _type == STP_DECODER_FREQ ? "FREQ" : (\
        _type == STP_DECODER_GERROR ? "GERROR" : (\
        _type == STP_DECODER_FLAG ? "FLAG" : (\
        _type == STP_DECODER_ASYNC ? "ASYNC" : (\
        "Unknown"))))))))))))))
 
union mipi_stp_decoder_data {
        uint16_t id;
 
        uint64_t freq;
 
        uint32_t ver;
 
        uint32_t err;
 
        uint32_t dummy;
 
        uint64_t data;
};
 
typedef void (*mipi_stp_decoder_cb)(enum mipi_stp_decoder_ctrl_type type,
                                    union mipi_stp_decoder_data data,
                                    uint64_t *ts, bool marked);
 
struct mipi_stp_decoder_config {
        bool start_out_of_sync;
 
        mipi_stp_decoder_cb cb;
};
 
int mipi_stp_decoder_init(const struct mipi_stp_decoder_config *config);
 
int mipi_stp_decoder_decode(const uint8_t *data, size_t len);
 
void mipi_stp_decoder_sync_loss(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DEBUG_MIPI_STP_DECODER_H__ */