hierodule/hierodule__spi_8h_source.html

#ifndef __HIERODULE_SPI_H

#define __HIERODULE_SPI_H


#ifdef __cplusplus

extern "C"

{

#endif


#include <main.h>

#include <stddef.h>

#include <stdlib.h>


typedef struct

{

    SPI_TypeDef *_SPI;

    uint8_t Mode;

    uint8_t *RX_Buffer;

    uint32_t RX_Index;

    uint32_t RX_New;

    uint16_t RX_BufferSize;


    uint8_t *TX_Buffer;

    uint32_t TX_Counter;

    uint32_t TX_BufferSize;


    void (*TC_Handler)(void);


} HIERODULE_SPI_Wrapper;


uint8_t HIERODULE_SPI_GetNextByte(HIERODULE_SPI_Wrapper *Wrapper);


void HIERODULE_SPI_TransmitByte(HIERODULE_SPI_Wrapper *Wrapper, uint8_t Byte);


HIERODULE_SPI_Wrapper **HIERODULE_SPI_InitWrapper( SPI_TypeDef *_SPI, uint8_t Mode, uint16_t RX_BufferSize, void (*TC_Handler)(void) );


void HIERODULE_SPI_ReleaseWrapper(HIERODULE_SPI_Wrapper *Wrapper);


void HIERODULE_SPI_TransmitPackage(HIERODULE_SPI_Wrapper *Wrapper, uint8_t *TX_Buffer, uint32_t Size);


#ifdef __cplusplus

}

#endif


#endif /* __HIERODULE_SPI_H */


HIERODULE_SPI_InitWrapper
HIERODULE_SPI_Wrapper ** HIERODULE_SPI_InitWrapper(SPI_TypeDef *_SPI, uint8_t Mode, uint16_t RX_BufferSize, void(*TC_Handler)(void))
Initializes a wrapper for the specified SPI peripheral.
Definition hierodule_spi.c:123

HIERODULE_SPI_GetNextByte
uint8_t HIERODULE_SPI_GetNextByte(HIERODULE_SPI_Wrapper *Wrapper)
Fetches the next byte in the RX ring buffer.
Definition hierodule_spi.c:94

HIERODULE_SPI_TransmitByte
void HIERODULE_SPI_TransmitByte(HIERODULE_SPI_Wrapper *Wrapper, uint8_t Byte)
Writes a byte into the data register of the SPI peripheral.
Definition hierodule_spi.c:114

HIERODULE_SPI_TransmitPackage
void HIERODULE_SPI_TransmitPackage(HIERODULE_SPI_Wrapper *Wrapper, uint8_t *TX_Buffer, uint32_t Size)
Starts a transmission as the master.
Definition hierodule_spi.c:204

HIERODULE_SPI_ReleaseWrapper
void HIERODULE_SPI_ReleaseWrapper(HIERODULE_SPI_Wrapper *Wrapper)
Frees the memory allocated to an SPI wrapper.
Definition hierodule_spi.c:193

Wrapper
HIERODULE_USB_Wrapper Wrapper
Extern declaration for the wrapper instance in the source file.
Definition hierodule_usb.c:27

HIERODULE_SPI_Wrapper
Struct that keeps variables for the data buffers, a pointer to the SPI peripheral,...
Definition hierodule_spi.h:43

HIERODULE_SPI_Wrapper::RX_Buffer
uint8_t * RX_Buffer
The ring buffer where the data received is appended.
Definition hierodule_spi.h:57

HIERODULE_SPI_Wrapper::TX_Counter
uint32_t TX_Counter
Used to continue transmission until buffer size is received.
Definition hierodule_spi.h:79

HIERODULE_SPI_Wrapper::RX_New
uint32_t RX_New
Number of new bytes in the ring buffer. .
Definition hierodule_spi.h:65

HIERODULE_SPI_Wrapper::RX_BufferSize
uint16_t RX_BufferSize
Number of elements in the ring buffer. .
Definition hierodule_spi.h:69

HIERODULE_SPI_Wrapper::TX_Buffer
uint8_t * TX_Buffer
Buffer that keeps data to be transmitted.
Definition hierodule_spi.h:75

HIERODULE_SPI_Wrapper::_SPI
SPI_TypeDef * _SPI
Pointer to the SPI peripheral.
Definition hierodule_spi.h:47

HIERODULE_SPI_Wrapper::Mode
uint8_t Mode
Master/Slave mode. 0 if Slave, 1 if Master.
Definition hierodule_spi.h:51

HIERODULE_SPI_Wrapper::TX_BufferSize
uint32_t TX_BufferSize
Number of bytes to be transmitted in the buffer.
Definition hierodule_spi.h:83

HIERODULE_SPI_Wrapper::RX_Index
uint32_t RX_Index
Index of next-byte-to-be-received in the ring buffer. .
Definition hierodule_spi.h:61