spi_driver.h

Go to the documentation of this file.

/* This file has been prepared for Doxygen automatic documentation generation.*/
#ifndef SPI_DRIVER_H
#define SPI_DRIVER_H

#include "avr_compiler.h"

/* Hardware defines */

#define SPI_SS_bm             0x10 
#define SPI_MOSI_bm           0x20 
#define SPI_MISO_bm           0x40 
#define SPI_SCK_bm            0x80 
/* SPI master status code defines. */

#define SPI_OK              0     
#define SPI_INTERRUPTED     1     
#define SPI_BUSY            2     
typedef struct SPI_DataPacket
{
        PORT_t *ssPort;                     
        uint8_t ssPinMask;                  
        const uint8_t *transmitData;        
        volatile uint8_t *receiveData;      
        volatile uint8_t bytesToTransceive; 
        volatile uint8_t bytesTransceived;  
        volatile bool complete;             
} SPI_DataPacket_t;


typedef struct SPI_Master
{
        SPI_t *module;                
        PORT_t *port;                 
        bool interrupted;             
        SPI_DataPacket_t *dataPacket; 
} SPI_Master_t;


typedef struct SPI_Slave
{
        SPI_t *module;      
        PORT_t *port;       
} SPI_Slave_t;


/* Definitions of macros. */


#define SPI_MasterInterruptTransmissionComplete(_spi) ( (_spi)->dataPacket->complete )



#define SPI_MasterSSLow(_port, _pinBM) ( (_port)->OUTCLR = (_pinBM) )



#define SPI_MasterSSHigh(_port, _pinBM) ( (_port)->OUTSET = (_pinBM) )



#define SPI_SlaveWriteByte(_spi, _data) ( (_spi)->module->DATA = (_data) )



#define SPI_SlaveReadByte(_spi) ( (_spi)->module->DATA )



#define SPI_SlaveDataAvailable(_spi) ( (_spi)->module->STATUS & SPI_IF_bm )


/* Prototype functions. Documentation found in source file */

void SPI_MasterInit(SPI_Master_t *spi,
                    SPI_t *module,
                    PORT_t *port,
                                        bool lsbFirst,
                    SPI_MODE_t mode,
                    SPI_INTLVL_t intLevel,
                    bool clk2x,
                    SPI_PRESCALER_t clockDivision);

void SPI_SlaveInit(SPI_Slave_t *spi,
                   SPI_t *module,
                   PORT_t *port,
                   bool lsbFirst,
                   SPI_MODE_t mode,
                   SPI_INTLVL_t intLevel);

void SPI_MasterCreateDataPacket(SPI_DataPacket_t *dataPacket,
                                const uint8_t *transmitData,
                                uint8_t *receiveData,
                                uint8_t bytesToTransceive,
                                PORT_t *ssPort,
                                uint8_t ssPinMask);

void SPI_MasterInterruptHandler(SPI_Master_t *spi);

uint8_t SPI_MasterInterruptTransceivePacket(SPI_Master_t *spi,
                                            SPI_DataPacket_t *dataPacket);

uint8_t SPI_MasterTransceiveByte(SPI_Master_t *spi, uint8_t TXdata);

bool SPI_MasterTransceivePacket(SPI_Master_t *spi,
                                SPI_DataPacket_t *dataPacket);

#endif