PSI5 Driver Backend API

Data Structures
struct	psi5_rx_callback_config
	Configuration structure for RX callback. More...
struct	psi5_rx_callback_configs
	Composite configuration structure for RX callback registration. More...
struct	psi5_driver_api
	Driver Operations PSI5 driver operations More...

Typedefs
typedef int(*	psi5_start_sync_t) (const struct device *dev, uint8_t channel)
	Callback API upon starting sync PSI5 See psi5_start_sync() for argument description.
typedef int(*	psi5_stop_sync_t) (const struct device *dev, uint8_t channel)
	Callback API upon stopping sync PSI5 See psi5_stop_sync() for argument description.
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)
	Callback API upon sending PSI5 frame See psi5_send() for argument description.
typedef int(*	psi5_register_callback_t) (const struct device *dev, uint8_t channel, struct psi5_rx_callback_configs callback_configs)
	Callback API upon adding RX callback See psi5_register_callback() for argument description.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a PSI5 driver.

Typedef Documentation

psi5_register_callback_t

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

#include <zephyr/drivers/psi5/psi5.h>

Callback API upon adding RX callback See psi5_register_callback() for argument description.

psi5_send_t

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)

#include <zephyr/drivers/psi5/psi5.h>

Callback API upon sending PSI5 frame See psi5_send() for argument description.

psi5_start_sync_t

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

#include <zephyr/drivers/psi5/psi5.h>

Callback API upon starting sync PSI5 See psi5_start_sync() for argument description.

psi5_stop_sync_t

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

#include <zephyr/drivers/psi5/psi5.h>

Callback API upon stopping sync PSI5 See psi5_stop_sync() for argument description.