sent.h

Go to the documentation of this file.

/*
 * Copyright 2025 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_SENT_H_
#define ZEPHYR_INCLUDE_DRIVERS_SENT_H_
 
#include <zephyr/kernel.h>
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif


enum sent_frame_type {
        SENT_SHORT_SERIAL_FRAME,
        SENT_ENHANCED_SERIAL_FRAME_4_BIT_ID,
        SENT_ENHANCED_SERIAL_FRAME_8_BIT_ID,
        SENT_FAST_FRAME
};

#define SENT_MAX_DATA_NIBBLES 8

struct sent_frame {
        enum sent_frame_type type;

        union {
                struct {
                        uint8_t id;

                        uint16_t data;
                } serial;

                struct {
                        uint8_t data_nibbles[SENT_MAX_DATA_NIBBLES];
                } fast;
        };

        uint32_t timestamp;

        uint8_t crc;
};

typedef void (*sent_rx_frame_callback_t)(const struct device *dev, uint8_t channel,
                                         uint32_t num_frame, void *user_data);


typedef int (*sent_start_listening_t)(const struct device *dev, uint8_t channel);

typedef int (*sent_stop_listening_t)(const struct device *dev, uint8_t channel);

struct sent_rx_callback_config {
        sent_rx_frame_callback_t callback;
        struct sent_frame *frame;
        uint32_t max_num_frame;
        void *user_data;
};

struct sent_rx_callback_configs {
        struct sent_rx_callback_config *serial;
        struct sent_rx_callback_config *fast;
};

typedef int (*sent_register_callback_t)(const struct device *dev, uint8_t channel,
                                        struct sent_rx_callback_configs callback_configs);
 
__subsystem struct sent_driver_api {
        sent_start_listening_t start_listening;
        sent_stop_listening_t stop_listening;
        sent_register_callback_t register_callback;
};


__syscall int sent_start_listening(const struct device *dev, uint8_t channel);
 
static inline int z_impl_sent_start_listening(const struct device *dev, uint8_t channel)
{
        const struct sent_driver_api *api = DEVICE_API_GET(sent, dev);
 
        if (api->start_listening) {
                return api->start_listening(dev, channel);
        }
 
        return -ENOSYS;
}

__syscall int sent_stop_listening(const struct device *dev, uint8_t channel);
 
static inline int z_impl_sent_stop_listening(const struct device *dev, uint8_t channel)
{
        const struct sent_driver_api *api = DEVICE_API_GET(sent, dev);
 
        if (api->stop_listening) {
                return api->stop_listening(dev, channel);
        }
 
        return -ENOSYS;
}

__syscall int sent_register_callback(const struct device *dev, uint8_t channel,
                                     struct sent_rx_callback_configs callback_configs);
 
static inline int z_impl_sent_register_callback(const struct device *dev, uint8_t channel,
                                                struct sent_rx_callback_configs callback_configs)
{
        const struct sent_driver_api *api = DEVICE_API_GET(sent, dev);
 
        if (api->register_callback) {
                return api->register_callback(dev, channel, callback_configs);
        }
 
        return -ENOSYS;
}
 
#ifdef __cplusplus
}
#endif

 
#include <zephyr/syscalls/sent.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_SENT_H_ */