xf_hal_spi.h

浏览该文件的文档.

 
#ifndef __XF_HAL_SPI_H__
#define __XF_HAL_SPI_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_hal_device_config.h"
 
#if XF_HAL_SPI_IS_ENABLE
 
#include "xf_hal_gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
typedef uint32_t xf_spi_num_t;
 
typedef void (*xf_hal_spi_cb_t)(xf_spi_num_t spi_num, void *user_data);
 
typedef struct _xf_hal_spi_callback_t {
    xf_hal_spi_cb_t callback;
    void *user_data;
} xf_hal_spi_callback_t;
 
typedef enum _xf_hal_spi_hosts_t {
    _XF_HAL_SPI_HOSTS_BASE = 0,
 
    XF_HAL_SPI_HOSTS_MASTER = _XF_HAL_SPI_HOSTS_BASE, 
    XF_HAL_SPI_HOSTS_SLAVE, 
    _XF_HAL_SPI_HOSTS_MAX
} xf_hal_spi_hosts_t;
 
typedef enum _xf_hal_spi_bit_order_t {
    _XF_HAL_SPI_BIT_ORDER_BASE = 0,
 
    XF_HAL_SPI_BIT_ORDER_LSB_FIRST = _XF_HAL_SPI_BIT_ORDER_BASE, 
    XF_HAL_SPI_BIT_ORDER_MSB_FIRST, 
    _XF_HAL_SPI_BIT_ORDER_MAX
} xf_hal_spi_bit_order_t;
 
typedef enum _xf_hal_spi_mode_t {
    _XF_HAL_SPI_MODE_BASE = 0,
 
    XF_HAL_SPI_MODE_0 = _XF_HAL_SPI_MODE_BASE, 
    XF_HAL_SPI_MODE_1,  
    XF_HAL_SPI_MODE_2,  
    XF_HAL_SPI_MODE_3,  
    _XF_HAL_SPI_MODE_MAX
} xf_hal_spi_mode_t;
 
typedef enum _xf_hal_spi_data_width_t {
    _XF_HAL_SPI_DATA_WIDTH_BASE = 0,
 
    XF_HAL_SPI_DATA_WIDTH_8_BITS = _XF_HAL_SPI_DATA_WIDTH_BASE, 
    XF_HAL_SPI_DATA_WIDTH_16_BITS,  
    XF_HAL_SPI_DATA_WIDTH_32_BITS,  
    _XF_HAL_SPI_DATA_WIDTH_MAX
} xf_hal_spi_data_width_t;
 
typedef enum _xf_hal_spi_cmd_t {
    XF_HAL_SPI_CMD_DEFAULT          = 0x0,          
    XF_HAL_SPI_CMD_HOSTS            = 0x1 << 0,     
    XF_HAL_SPI_CMD_ENABLE           = 0x1 << 1,     
    XF_HAL_SPI_CMD_BIT_ORDER        = 0x1 << 2,     
    XF_HAL_SPI_CMD_MODE             = 0x1 << 3,     
    XF_HAL_SPI_CMD_DATA_WIDTH       = 0x1 << 4,     
    XF_HAL_SPI_CMD_TIMEOUT          = 0x1 << 5,     
    XF_HAL_SPI_CMD_SPEED            = 0x1 << 6,     
    XF_HAL_SPI_CMD_GPIO             = 0x1 << 7,     
    XF_HAL_SPI_CMD_PREV_CB          = 0x1 << 8,     
    XF_HAL_SPI_CMD_POST_CB          = 0x1 << 9,     
    XF_HAL_SPI_CMD_ALL             = 0x7FFFFFFF,  
} xf_hal_spi_cmd_t;
 
typedef struct _xf_hal_spi_gpio_t {
    xf_gpio_num_t sclk_num;
    xf_gpio_num_t cs_num;
    union {
        xf_gpio_num_t data0_num;
        xf_gpio_num_t mosi_num;
    };
    union {
        xf_gpio_num_t data1_num;
        xf_gpio_num_t miso_num;
    };
    union {
        xf_gpio_num_t data2_num;
        xf_gpio_num_t quadwp_num;
    };
    union {
        xf_gpio_num_t data3_num;
        xf_gpio_num_t quadhd_num;
    };
} xf_hal_spi_gpio_t;
 
typedef struct _xf_hal_spi_config_t {
    uint32_t hosts      : 1;        
    uint32_t enable     : 1;        
    uint32_t bit_order  : 1;        
    uint32_t mode       : 2;        
    uint32_t data_width : 2;        
    uint32_t reserve    : 25;
    uint32_t timeout_ms;            
    uint32_t speed;                 
    xf_hal_spi_gpio_t gpio;         
    xf_hal_spi_callback_t prev_cb;  
    xf_hal_spi_callback_t post_cb;  
} xf_hal_spi_config_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_hal_spi_init(xf_spi_num_t spi_num, xf_hal_spi_hosts_t hosts, uint32_t speed);
 
xf_err_t xf_hal_spi_deinit(xf_spi_num_t spi_num);
 
xf_err_t xf_hal_spi_enable(xf_spi_num_t spi_num);
 
xf_err_t xf_hal_spi_disable(xf_spi_num_t spi_num);
 
xf_err_t xf_hal_spi_set_prev_cb(xf_spi_num_t spi_num, xf_hal_spi_cb_t callback, void *user_data);
 
xf_err_t xf_hal_spi_set_post_cb(xf_spi_num_t spi_num, xf_hal_spi_cb_t callback, void *user_data);
 
xf_err_t xf_hal_spi_set_gpio(xf_spi_num_t spi_num, const xf_hal_spi_gpio_t *spi_gpio);
 
xf_err_t xf_hal_spi_set_bit_order(xf_spi_num_t spi_num, xf_hal_spi_bit_order_t bit_order);
 
xf_err_t xf_hal_spi_set_mode(xf_spi_num_t spi_num, xf_hal_spi_mode_t mode);
 
xf_err_t xf_hal_spi_set_data_width(xf_spi_num_t spi_num, xf_hal_spi_data_width_t data_width);
 
xf_err_t xf_hal_spi_set_speed(xf_spi_num_t spi_num, uint32_t speed);
 
int xf_hal_spi_write(xf_spi_num_t spi_num, const uint8_t *buffer, uint32_t size, uint32_t timeout_ms);
 
int xf_hal_spi_read(xf_spi_num_t spi_num, uint8_t *buffer, uint32_t size, uint32_t timeout_ms);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // __XF_HAL_SPI_H__
 
#endif