no_os_spi.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_SPI_H_
#define _NO_OS_SPI_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
#define NO_OS_SPI_CPHA  0x01
#define NO_OS_SPI_CPOL  0x02
#define SPI_MAX_BUS_NUMBER 8
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
enum no_os_spi_mode {
    NO_OS_SPI_MODE_0 = (0 | 0),
    NO_OS_SPI_MODE_1 = (0 | NO_OS_SPI_CPHA),
    NO_OS_SPI_MODE_2 = (NO_OS_SPI_CPOL | 0),
    NO_OS_SPI_MODE_3 = (NO_OS_SPI_CPOL | NO_OS_SPI_CPHA)
};
 
enum no_os_spi_bit_order {
    NO_OS_SPI_BIT_ORDER_MSB_FIRST = 0,
    NO_OS_SPI_BIT_ORDER_LSB_FIRST = 1,
};
 
enum no_os_spi_lanes {
    NO_OS_SPI_SINGLE_LANE,
    NO_OS_SPI_DUAL_LANE,
    NO_OS_SPI_QUAD_LANE,
    NO_OS_SPI_OCTO_LANE,
};
 
struct no_os_spi_msg {
    uint8_t         *tx_buff;
    uint8_t         *rx_buff;
    uint32_t        bytes_number;
    uint8_t         cs_change;
    uint32_t        cs_change_delay;
    uint32_t        cs_delay_first;
    uint32_t        cs_delay_last;
};
 
struct no_os_platform_spi_delays {
    uint32_t cs_delay_first;
    uint32_t cs_delay_last;
};
 
struct no_os_spi_platform_ops ;
 
struct no_os_spi_init_param {
    uint32_t    device_id;
    uint32_t    max_speed_hz;
    uint8_t     chip_select;
    enum no_os_spi_mode mode;
    enum no_os_spi_bit_order    bit_order;
    enum no_os_spi_lanes   lanes;
    const struct no_os_spi_platform_ops *platform_ops;
    struct no_os_platform_spi_delays platform_delays;
    void        *extra;
    struct no_os_spi_desc *parent;
};
 
struct no_os_spibus_desc {
    void        *mutex;
    uint8_t         slave_number;
    uint32_t    device_id;
    uint32_t    max_speed_hz;
    enum no_os_spi_mode mode;
    enum no_os_spi_bit_order    bit_order;
    enum no_os_spi_lanes   lanes;
    const struct no_os_spi_platform_ops *platform_ops;
    void        *extra;
};
 
struct no_os_spi_desc {
    struct no_os_spibus_desc    *bus;
    uint32_t    device_id;
    uint32_t    max_speed_hz;
    uint8_t     chip_select;
    enum no_os_spi_mode mode;
    enum no_os_spi_bit_order    bit_order;
    enum no_os_spi_lanes   lanes;
    const struct no_os_spi_platform_ops *platform_ops;
    struct no_os_platform_spi_delays platform_delays;
    void        *extra;
    struct no_os_spi_desc *parent;
};
 
struct no_os_spi_platform_ops {
    int32_t (*init)(struct no_os_spi_desc **, const struct no_os_spi_init_param *);
    int32_t (*write_and_read)(struct no_os_spi_desc *, uint8_t *, uint16_t);
    int32_t (*transfer)(struct no_os_spi_desc *, struct no_os_spi_msg *, uint32_t);
    int32_t (*dma_transfer_sync)(struct no_os_spi_desc *, struct no_os_spi_msg *,
                     uint32_t);
    int32_t (*dma_transfer_async)(struct no_os_spi_desc *, struct no_os_spi_msg *,
                      uint32_t, void (*)(void *), void *);
    int32_t (*remove)(struct no_os_spi_desc *);
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
/* Initialize the SPI communication peripheral. */
int32_t no_os_spi_init(struct no_os_spi_desc **desc,
               const struct no_os_spi_init_param *param);
 
/* Free the resources allocated by no_os_spi_init(). */
int32_t no_os_spi_remove(struct no_os_spi_desc *desc);
 
/* Write and read data to/from SPI. */
int32_t no_os_spi_write_and_read(struct no_os_spi_desc *desc,
                 uint8_t *data,
                 uint16_t bytes_number);
 
/* Iterate over the spi_msg array and send all messages at once */
int32_t no_os_spi_transfer(struct no_os_spi_desc *desc,
               struct no_os_spi_msg *msgs,
               uint32_t len);
 
/* Transfer a list of messages using DMA. Wait until all transfers are done */
int32_t no_os_spi_transfer_dma_sync(struct no_os_spi_desc *desc,
                    struct no_os_spi_msg *msgs,
                    uint32_t len);
/*
 * Transfer a list of messages using DMA. Return once the first one started and
 * invoke a callback when they are done.
 */
int32_t no_os_spi_transfer_dma_async(struct no_os_spi_desc *desc,
                     struct no_os_spi_msg *msgs,
                     uint32_t len,
                     void (*callback)(void *),
                     void *ctx);
 
/* Initialize SPI bus descriptor*/
int32_t no_os_spibus_init(const struct no_os_spi_init_param *param);
 
/* Free the resources allocated for SPI bus desc*/
void no_os_spibus_remove(uint32_t bus_number);
 
 
#endif // _NO_OS_SPI_H_