xt_hal_spi.h

浏览该文件的文档.

 
#ifndef __XT_HAL_SPI_H__
#define __XT_HAL_SPI_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xt_hal_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
#define XT_HAL_SPI_INVALID_ID         (0xFF)
 
#define XT_HAL_SPI_FRAME_FORMAT_S     (0)
#define XT_HAL_SPI_FRAME_FORMAT_W     (2)
#define XT_HAL_SPI_BIT_ORDER_S        (2)
#define XT_HAL_SPI_BIT_ORDER_W        (1)
#define XT_HAL_SPI_DATA_BITS_S        (3)
#define XT_HAL_SPI_DATA_BITS_W        (2)
 
#define XT_HAL_SPI_CPOL0_CPHA0        ((0) << (XT_HAL_SPI_FRAME_FORMAT_S))  
#define XT_HAL_SPI_CPOL0_CPHA1        ((1) << (XT_HAL_SPI_FRAME_FORMAT_S))  
#define XT_HAL_SPI_CPOL1_CPHA0        ((2) << (XT_HAL_SPI_FRAME_FORMAT_S))  
#define XT_HAL_SPI_CPOL1_CPHA1        ((3) << (XT_HAL_SPI_FRAME_FORMAT_S))  
 
#define XT_HAL_SPI_MSB_FIRST          ((0) << (XT_HAL_SPI_BIT_ORDER_S)) 
#define XT_HAL_SPI_LSB_FIRST          ((1) << (XT_HAL_SPI_BIT_ORDER_S)) 
 
#define XT_HAL_SPI_DATA_BITS_8        ((0) << (XT_HAL_SPI_DATA_BITS_S))  
#define XT_HAL_SPI_DATA_BITS_16       ((1) << (XT_HAL_SPI_DATA_BITS_S))  
#define XT_HAL_SPI_DATA_BITS_32       ((3) << (XT_HAL_SPI_DATA_BITS_S))  
 
/* ==================== [Typedefs] ========================================== */

enum xt_hal_spi_event_id {
    XT_HAL_SPI_EVENT_DONE = 0x00, 
};

typedef void (*xt_hal_spi_cb_t)(uint8_t spi_id, uint32_t event_id);
 
/* ==================== [Global Prototypes] ================================= */

xt_err_t xt_hal_spim_setup(
    uint8_t spi_id, uint32_t mode, uint32_t speed,
    uint8_t mosi_pin, uint8_t miso_pin,
    uint8_t sclk_pin, uint8_t cs_pin);

xt_err_t xt_hal_spim_close(uint8_t spi_id);

void xt_hal_spi_set_cb(uint8_t spi_id, xt_hal_spi_cb_t cb);

int32_t xt_hal_spim_tx_0copy(uint8_t spi_id, const void *tx_buffer, size_t size);

int32_t xt_hal_spim_rx_0copy(uint8_t spi_id, void *rx_buffer, size_t size);

int32_t xt_hal_spim_txrx_0copy(uint8_t spi_id,
                               const void *tx_buffer,
                               void *rx_buffer,
                               size_t size);

int32_t xt_hal_spim_tx_block(uint8_t spi_id, const void *tx_buffer, size_t size);

int32_t xt_hal_spim_rx_block(uint8_t spi_id, void *rx_buffer, size_t size);

int32_t xt_hal_spim_txrx_block(uint8_t spi_id,
                               const void *tx_buffer,
                               void *rx_buffer,
                               size_t size);
 
/* ==================== [Macros] ============================================ */
  /* xt_hal_spi */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_HAL_SPI_H__ */