spi.h

 
#ifndef SPI_H
#define SPI_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*******************************************************************************
*                              Include files
*******************************************************************************/
 
#include <stdint.h>
#include <stdbool.h>
#include "sr110_device.h"
 
/***************************************************************************/
 
/*******************************************************************************
*                               Enumerated Types
*******************************************************************************/


typedef enum
{
    SPI_OK = 0,                         
    SPI_ERROR,                          
    SPI_ERROR_PARAMETER,                
    SPI_ERROR_BUSY,                     
    SPI_ERROR_TIMEOUT,                  
    SPI_ERROR_UNSUPPORTED,              
    SPI_ERROR_BAUDRATE,                 
    SPI_ERROR_NOT_INITIALIZED,          
    SPI_ERROR_TX_OVERFLOW,              
} spi_status_en;

typedef enum
{
    SPI_TRANSFER_IN_PROGRESS    = 0x01,            
    SPI_TRANSFER_TIMEOUT        = 0x02,            
    SPI_TRANSFER_ERROR          = 0x03,            
    SPI_TRANSFER_DONE           = 0x04,            
    SPI_FIFO_DRAINED            = 0x05,            
    SPI_ALL_DATA_IN_FIFO        = 0x06,            
} spi_transfer_status_en;

typedef enum
{
    SPI_CPHA0_CPOL0 = 0U,           
    SPI_CPHA1_CPOL0 = 1U,           
    SPI_CPHA0_CPOL1 = 2U,           
    SPI_CPHA1_CPOL1 = 3U,           
} spi_sclk_mode_en;

typedef enum
{
    SPI_TRANSMIT_AND_RECEIVE = 0u,

    SPI_TRANSMIT_ONLY = 1u,

    SPI_RECEIVE_ONLY  = 2u,

    SPI_EEPROM_READ   = 3u,
 
} spi_xfer_mode_en;

 
/*******************************************************************************
*                            Type Definitions
*******************************************************************************/


typedef void (*spi_cb_t)(spi_transfer_status_en status, void *user_data);

typedef struct spi_config
{
    bool                spi_controller;           
    spi_sclk_mode_en    clock_mode;               
    spi_xfer_mode_en    xfer_mode;                
    uint32_t            frame_size;               
    bool                toggle_peripheral_select; 
    bool                disable_peripheral_out;   
    uint32_t            spi_clk_freq_khz;         
    uint32_t            rx_sample_delay;          
} spi_config_t;

typedef struct spi_xfer_config
{
    bool            wait_for_tx_fifo_drain;  
    uint32_t        *tx_buff;                
    uint32_t        *rx_buff;                
    uint32_t        tx_dummy;                
    uint32_t        xfer_size;               
    spi_cb_t        callback;                
    void                *user_data;         
    uint32_t        timeout;                 
} spi_xfer_config_t;
 

 
/*******************************************************************************
*                          Function Prototypes
*******************************************************************************/

 
/*******************************************************************************
* Function Name: spi_init
****************************************************************************/
INIT_CODE spi_status_en spi_init(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_deinit
****************************************************************************/
INIT_CODE spi_status_en spi_deinit(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_set_configuration
****************************************************************************/
spi_status_en spi_set_configuration(spi_instance_en id, spi_config_t *config,
                                uint32_t *achieved_clk_rate_khz);
 
/*******************************************************************************
* Function Name: spi_get_configuration
****************************************************************************/
spi_status_en spi_get_configuration(spi_instance_en id, spi_config_t *config,
                                uint32_t *achieved_clk_rate_khz);
 
/*******************************************************************************
* Function Name: spi_enable
****************************************************************************/
spi_status_en spi_enable(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_disable
****************************************************************************/
spi_status_en spi_disable(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_controller_select_peripheral
****************************************************************************/
spi_status_en spi_controller_select_peripheral(spi_instance_en id,
                                            uint32_t peripheral_select);

 
/*******************************************************************************
*                          Low level functions definitions
*******************************************************************************/

 
/*******************************************************************************
* Function Name: spi_write_tx_data
****************************************************************************/
spi_status_en spi_write_tx_data(spi_instance_en id, uint32_t tx_data);
 
/*******************************************************************************
* Function Name: spi_read_rx_data
****************************************************************************/
uint32_t spi_read_rx_data(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_tx_fifo_not_full
****************************************************************************/
bool spi_tx_fifo_not_full(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_rx_fifo_not_empty
****************************************************************************/
bool spi_rx_fifo_not_empty(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_set_tx_fifo_trig_level
****************************************************************************/
spi_status_en spi_set_tx_fifo_trig_level(spi_instance_en id, uint32_t fifo_level);
 
/*******************************************************************************
* Function Name: spi_get_tx_fifo_trig_level
****************************************************************************/
uint32_t spi_get_tx_fifo_trig_level(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_set_rx_fifo_trig_level
****************************************************************************/
spi_status_en spi_set_rx_fifo_trig_level(spi_instance_en id, uint32_t fifo_level);
 
/*******************************************************************************
* Function Name: spi_get_rx_fifo_trig_level
****************************************************************************/
uint32_t spi_get_rx_fifo_trig_level(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_get_num_in_tx_fifo
****************************************************************************/
uint32_t spi_get_num_in_tx_fifo(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_get_num_in_rx_fifo
****************************************************************************/
uint32_t spi_get_num_in_rx_fifo(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_get_status
****************************************************************************/
uint32_t spi_get_status(spi_instance_en id);

 
/*******************************************************************************
*                          High level functions definitions
*******************************************************************************/
/*******************************************************************************
* Function Name: spi_transfer_blocking
****************************************************************************/
spi_status_en spi_transfer_blocking(spi_instance_en id,
                                spi_xfer_config_t *xfer);
 
/*******************************************************************************
* Function Name: spi_transfer_non_blocking
****************************************************************************/
spi_status_en spi_transfer_non_blocking(spi_instance_en id,
                                    spi_xfer_config_t *xfer);
 
/*******************************************************************************
* Function Name: spi_transfer_abort
****************************************************************************/
spi_status_en spi_transfer_abort(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_transfer_status
****************************************************************************/
spi_transfer_status_en spi_transfer_status(spi_instance_en id);
 
/*******************************************************************************
* Function Name: spi_transfer_elements_transferred
****************************************************************************/
uint32_t spi_transfer_elements_transferred(spi_instance_en id);


 
#ifdef __cplusplus
}
#endif
 
#endif /* SPI_H */