pixy2_transport.h

Go to the documentation of this file.

/*
 * Copyright 2025 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef _PIXY2_TRANSPORT_H_
#define _PIXY2_TRANSPORT_H_
 
#include <zephyr/device.h>
 
struct pixy2_checksum_header {
    uint8_t sync0;
    uint8_t sync1;
    uint8_t type;
    uint8_t len;
    uint16_t checksum;
} __packed;
 
struct pixy2_header {
    uint8_t sync0;
    uint8_t sync1;
    uint8_t type;
    uint8_t len;
} __packed;
 
/*
 * @struct pixy2_message
 * @brief Pixy2 message
 *
 * A Pixy2 message is either a request or a reply.
 */
struct pixy2_message {
    struct pixy2_checksum_header hdr;
    bool checksum;
    uint8_t *payload;
};
 
struct pixy2_transport {
    /* peripheral controller device */
    const struct device *ctlr;
    /* transport API */
    const struct pixy2_transport_api *api;
};
 
struct pixy2_i2c_transport {
    struct pixy2_transport t;
    const uint32_t address;
};
 
struct pixy2_spi_transport {
    struct pixy2_transport t;
    const uint32_t sidx;
};
 
struct pixy2_transport_api {
    int (*transceive)(struct pixy2_transport *t,
              struct pixy2_message *req,
              struct pixy2_message *reply);
};
 
static inline int pixy2_transport_transceive(struct pixy2_transport *t,
                         struct pixy2_message *req,
                         struct pixy2_message *reply)
{
    /* sanity checks */
    if (!t || !t->ctlr || !t->api->transceive) {
        return -EINVAL;
    }
 
    return t->api->transceive(t, req, reply);
}
 
#ifdef CONFIG_NXPCUP_PIXY2_SPI_TRANSPORT
extern const struct pixy2_transport_api pixy2_transport_spi_api;
#endif /* CONFIG_PIXY2_SPI_TRANSPORT */
 
#ifdef CONFIG_NXPCUP_PIXY2_I2C_TRANSPORT
extern const struct pixy2_transport_api pixy2_transport_i2c_api;
#endif /* CONFIG_PIXY2_I2C_TRANSPORT */
 
#endif /* _PIXY2_TRANSPORT_H_ */