spi.h

浏览该文件的文档.

 
#ifndef SPI_H
#define SPI_H
 
#include <stdint.h>
#include "errcode.h"
#include "hal_spi.h"
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
 
typedef hal_spi_attr_t spi_attr_t;
 
typedef hal_spi_extra_attr_t spi_extra_attr_t;
 
typedef hal_spi_xfer_data_t spi_xfer_data_t;
 
typedef struct spi_dma_config {
    uint8_t src_width;          
    uint8_t dest_width;         
    uint8_t burst_length;       
    uint8_t priority;           
} spi_dma_config_t;
 
errcode_t uapi_spi_init(spi_bus_t bus, spi_attr_t *attr, spi_extra_attr_t *extra_attr);
 
errcode_t uapi_spi_deinit(spi_bus_t bus);
 
errcode_t uapi_spi_set_tmod(spi_bus_t bus, hal_spi_trans_mode_t tmod, uint8_t data_frame_num);
 
errcode_t uapi_spi_set_attr(spi_bus_t bus, spi_attr_t *attr);
 
errcode_t uapi_spi_get_attr(spi_bus_t bus, spi_attr_t *attr);
 
errcode_t uapi_spi_set_extra_attr(spi_bus_t bus, spi_extra_attr_t *extra_attr);
 
errcode_t uapi_spi_get_extra_attr(spi_bus_t bus, spi_extra_attr_t *extra_attr);
 
#if defined(CONFIG_SPI_SUPPORT_MASTER) && (CONFIG_SPI_SUPPORT_MASTER == 1)
errcode_t uapi_spi_select_slave(spi_bus_t bus, spi_slave_t cs);
 
errcode_t uapi_spi_master_write(spi_bus_t bus, const spi_xfer_data_t *data, uint32_t timeout);
 
errcode_t uapi_spi_master_read(spi_bus_t bus, const spi_xfer_data_t *data, uint32_t timeout);
 
errcode_t uapi_spi_master_writeread(spi_bus_t bus, const spi_xfer_data_t *data, uint32_t timeout);
#endif  /* CONFIG_SPI_SUPPORT_MASTER */
 
#if defined(CONFIG_SPI_SUPPORT_SLAVE) && (CONFIG_SPI_SUPPORT_SLAVE == 1)
errcode_t uapi_spi_slave_write(spi_bus_t bus, const spi_xfer_data_t *data, uint32_t timeout);
 
errcode_t uapi_spi_slave_read(spi_bus_t bus, const spi_xfer_data_t *data, uint32_t timeout);
 
errcode_t uapi_spi_slave_writeread(spi_bus_t bus, const spi_xfer_data_t *data, uint32_t timeout);
#endif  /* CONFIG_SPI_SUPPORT_SLAVE */
 
#if !defined(CONFIG_SPI_SUPPORT_POLL_AND_DMA_AUTO_SWITCH)
#if defined(CONFIG_SPI_SUPPORT_DMA) && (CONFIG_SPI_SUPPORT_DMA == 1)
errcode_t uapi_spi_set_dma_mode(spi_bus_t bus, bool en, const spi_dma_config_t *dma_cfg);
#endif  /* CONFIG_SPI_SUPPORT_DMA */
 
#if defined(CONFIG_SPI_SUPPORT_INTERRUPT) && (CONFIG_SPI_SUPPORT_INTERRUPT == 1)
typedef void (*spi_tx_callback_t)(const void *buffer, uint32_t length);
 
typedef void (*spi_rx_callback_t)(const void *buffer, uint32_t length, bool error);
 
errcode_t uapi_spi_set_irq_mode(spi_bus_t bus, bool irq_en, spi_rx_callback_t rx_callback,
                                spi_tx_callback_t tx_callback);
#endif  /* CONFIG_SPI_SUPPORT_INTERRUPT */
#endif  /* NOT CONFIG_SPI_SUPPORT_POLL_AND_DMA_AUTO_SWITCH */
 
#if defined(CONFIG_SPI_SUPPORT_LOOPBACK) && (CONFIG_SPI_SUPPORT_LOOPBACK == 1)
errcode_t uapi_spi_set_loop_back_mode(spi_bus_t bus, bool loopback_en);
#endif  /* CONFIG_SPI_SUPPORT_LOOPBACK */
 
#if defined(CONFIG_SPI_SUPPORT_CRC) && (CONFIG_SPI_SUPPORT_CRC == 1)
typedef struct spi_crc_config {
    uint32_t  tx_crc_len;       
    uint32_t  rx_crc_len;       
    uint32_t  tx_crc_ini;       
    uint32_t  rx_crc_ini;       
    uint32_t  tx_crc_poly;      
    uint32_t  rx_crc_poly;      
    uint32_t  tx_crc_xor_out;   
    uint32_t  rx_crc_xor_out;   
    bool      tx_crc_refin;     
    bool      tx_crc_refout;    
    bool      rx_crc_refin;     
    bool      rx_crc_refout;    
} spi_crc_config_t;
 
typedef void (*spi_crc_err_callback_t)(spi_bus_t bus);
 
errcode_t uapi_spi_set_crc_mode(spi_bus_t bus, const spi_crc_config_t *crc_config, spi_crc_err_callback_t cb);
#endif  /* CONFIG_SPI_SUPPORT_CRC */
 
#if defined(CONFIG_SPI_SUPPORT_LPM)
errcode_t uapi_spi_suspend(uintptr_t arg);
 
errcode_t uapi_spi_resume(uintptr_t arg);
#endif
 
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#endif