spi.h

Go to the documentation of this file.

#ifndef _SPI_H_
#define _SPI_H_

#include <stdint.h>

#include "project_settings.h"

#include "hal_spi.h"

#ifndef SPI_MAX_SIZE
#define SPI_MAX_SIZE 8 
#endif

#ifndef SPI_MAX_TRANSACTIONS
#define SPI_MAX_TRANSACTIONS 4 
#endif

typedef struct spi_settings_t {
    uint8_t channel; 
    uint32_t bit_rate; 
    uint8_t mode; 
    hal_spi_settings_t hal_settings; 
} spi_settings_t;

struct spi_transaction {
    uint8_t writeLength; 
    uint8_t readLength; 
    uint8_t readDelay; 
    struct {
        volatile uint8_t blocking : 1; 
        volatile uint8_t finished : 1; 
        volatile uint8_t channel : 3; 
        volatile uint8_t overrun : 1; 
        volatile uint8_t unused : 2; 
    } flags;
    void (*callback)(struct spi_transaction *); 
    void (*cs_control)(uint8_t); 
    uint8_t data[SPI_MAX_SIZE]; 
};

typedef struct spi_transaction spi_transaction_t;

void SPI_Init(spi_settings_t* spi_settings);

int8_t SPI_Transact(spi_transaction_t * transaction);

void SPI_ISR(uint8_t channel);

/******************************************
 * HAL Functions
 * The following functions can be implemented in hal_spi.c or as
 * #define's in hal_spi.h
 *****************************************/

#ifndef hal_SPI_Init
void hal_SPI_Init(spi_settings_t* settings);
#endif

#ifndef hal_SPI_Enable
void hal_SPI_Enable(uint8_t channel);
#endif

#ifndef hal_SPI_Disable
void hal_SPI_Disable(uint8_t channel);
#endif

#ifndef hal_SPI_SpaceAvailable
uint8_t hal_SPI_SpaceAvailable(uint8_t channel);
#endif

#ifndef hal_SPI_DataAvailable
uint8_t hal_SPI_DataAvailable(uint8_t channel);
#endif

#ifndef hal_SPI_ClearRxIF
void hal_SPI_ClearRxIF(uint8_t channel);
#endif

#ifndef hal_SPI_ClearTxIF
void hal_SPI_ClearTxIF(uint8_t channel);
#endif

#ifndef hal_SPI_EnableRxInterrupt
void hal_SPI_EnableRxInterrupt(uint8_t channel);
#endif

#ifndef hal_SPI_EnableTxInterrupt
void hal_SPI_EnableTxInterrupt(uint8_t channel);
#endif

#ifndef hal_SPI_DisableRxInterrupt
void hal_SPI_DisableRxInterrupt(uint8_t channel);
#endif

#ifndef hal_SPI_DisableTxInterrupt
void hal_SPI_DisableTxInterrupt(uint8_t channel);
#endif

#ifndef hal_SPI_TxIntStatus
uint8_t hal_SPI_TxIntStatus(uint8_t channel);
#endif

#ifndef hal_SPI_RxIntStatus
uint8_t hal_SPI_RxIntStatus(uint8_t channel);
#endif

#ifndef hal_SPI_IsTxIntEnabled
uint8_t hal_SPI_IsTxIntEnabled(uint8_t channel);
#endif

#ifndef hal_SPI_RxByte
uint8_t hal_SPI_RxByte(uint8_t channel);
#endif

#ifndef hal_SPI_TxByte
void hal_SPI_TxByte(uint8_t channel, uint8_t b);
#endif

#ifndef hal_SPI_OverrunError
uint8_t hal_SPI_OverrunError(uint8_t channel);
#endif

#endif // _SPI_H_