psi5.h

Go to the documentation of this file.

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

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


enum psi5_frame_type {
        PSI5_SERIAL_FRAME_4_BIT_ID,
        PSI5_SERIAL_FRAME_8_BIT_ID,
        PSI5_DATA_FRAME
};

struct psi5_frame {
        enum psi5_frame_type type;

        union {
                uint32_t data;

                struct {
                        uint8_t id;
                        uint16_t data;
                } serial;
        };

        uint32_t timestamp;
        uint8_t crc;
        uint8_t slot_number;
};

typedef void (*psi5_tx_callback_t)(const struct device *dev, uint8_t channel, int status,
                                   void *user_data);

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


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

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

typedef int (*psi5_send_t)(const struct device *dev, uint8_t channel, const uint64_t data,
                           k_timeout_t timeout, psi5_tx_callback_t callback, void *user_data);

struct psi5_rx_callback_config {
        psi5_rx_frame_callback_t callback;
        struct psi5_frame *frame;
        uint32_t max_num_frame;
        void *user_data;
};

struct psi5_rx_callback_configs {
        struct psi5_rx_callback_config *serial_frame;
        struct psi5_rx_callback_config *data_frame;
};

typedef int (*psi5_register_callback_t)(const struct device *dev, uint8_t channel,
                                        struct psi5_rx_callback_configs callback_configs);

__subsystem struct psi5_driver_api {
        psi5_start_sync_t start_sync;
        psi5_stop_sync_t stop_sync;
        psi5_send_t send;
        psi5_register_callback_t register_callback;
};


__syscall int psi5_start_sync(const struct device *dev, uint8_t channel);
 
static inline int z_impl_psi5_start_sync(const struct device *dev, uint8_t channel)
{
        const struct psi5_driver_api *api = DEVICE_API_GET(psi5, dev);
 
        if (api->start_sync) {
                return api->start_sync(dev, channel);
        }
 
        return -ENOSYS;
}

__syscall int psi5_stop_sync(const struct device *dev, uint8_t channel);
 
static inline int z_impl_psi5_stop_sync(const struct device *dev, uint8_t channel)
{
        const struct psi5_driver_api *api = DEVICE_API_GET(psi5, dev);
 
        if (api->stop_sync) {
                return api->stop_sync(dev, channel);
        }
 
        return -ENOSYS;
}

__syscall int psi5_send(const struct device *dev, uint8_t channel, const uint64_t data,
                        k_timeout_t timeout, psi5_tx_callback_t callback, void *user_data);
 
static inline int z_impl_psi5_send(const struct device *dev, uint8_t channel, const uint64_t data,
                                   k_timeout_t timeout, psi5_tx_callback_t callback,
                                   void *user_data)
{
        const struct psi5_driver_api *api = DEVICE_API_GET(psi5, dev);
 
        if (api->send) {
                return api->send(dev, channel, data, timeout, callback, user_data);
        }
 
        return -ENOSYS;
}

__syscall int psi5_register_callback(const struct device *dev, uint8_t channel,
                                     struct psi5_rx_callback_configs callback_configs);
 
static inline int z_impl_psi5_register_callback(const struct device *dev, uint8_t channel,
                                                struct psi5_rx_callback_configs callback_configs)
{
        const struct psi5_driver_api *api = DEVICE_API_GET(psi5, dev);
 
        if (api->register_callback) {
                return api->register_callback(dev, channel, callback_configs);
        }
 
        return -ENOSYS;
}
 
#ifdef __cplusplus
}
#endif

 
#include <zephyr/syscalls/psi5.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_PSI5_H_ */