ACDC_SPI.h File Reference

Header file for SPI driver. More...

#include "stm32f1xx.h"
#include "ACDC_stdbool.h"

Go to the source code of this file.

Enumerations
enum	SPI_BaudDivider {   SPI_BAUD_DIV_2 = 0b000 , SPI_BAUD_DIV_4 = 0b001 , SPI_BAUD_DIV_8 = 0b010 , SPI_BAUD_DIV_16 = 0b011 ,   SPI_BAUD_DIV_32 = 0b100 , SPI_BAUD_DIV_64 = 0b101 , SPI_BAUD_DIV_128 = 0b110 , SPI_BAUD_DIV_256 = 0b111 }
enum	SPI_BitMode { SPI_MODE_8Bit = 0 , SPI_MODE_16Bit = 1 }

Functions
void	SPI_InitCS (SPI_TypeDef *SPIx, bool isMaster, GPIO_TypeDef *GPIOx, uint16_t GPIO_PIN)
	Initializes the SPIx peripheral to master or slave, using the chip select pin of your choosing. (Default Values: SPI_MODE_16Bit, SPI_BAUD_DIV_2, MSB First)
void	SPI_EnableSoftwareCS (SPI_TypeDef *SPIx, GPIO_TypeDef *GPIOx, uint16_t GPIO_PIN)
	Enables the software CS for SPIx. (Disables Hardware CS)
void	SPI_EnableRemap (const SPI_TypeDef *SPIx, bool enable)
	Enables pin remapping on SPIx depending on the value of enable (Only SPI1 can be remapped)
void	SPI_Transmit (SPI_TypeDef *SPIx, uint16_t data)
	Transmits data over the given SPI.
void	SPI_TransmitCS (SPI_TypeDef *SPIx, uint16_t data, GPIO_TypeDef *GPIOx, uint16_t GPIO_PIN)
	Transmits data over the given SPI, and toggles the CS pins accordingly.
uint16_t	SPI_Receive (const SPI_TypeDef *SPIx)
	Recieves data from a SPI.
uint16_t	SPI_TransmitReceive (SPI_TypeDef *SPIx, uint16_t data)
	Transmits and recieves data over the SPI.
uint16_t	SPI_TransmitReceiveCS (SPI_TypeDef *SPIx, uint16_t data, GPIO_TypeDef *GPIOx, uint16_t GPIO_PIN)
	Transmits and recieves data over the SPI, also takes care of the software chip select.
void	SPI_SetBaudDivider (SPI_TypeDef *SPIx, SPI_BaudDivider SPI_BAUD_DIV_x)
	Changes the Baud rate divider of the SPIx peripheral.
void	SPI_CalculateAndSetBaudDivider (SPI_TypeDef *SPIx, uint32_t maxPeripheralClockSpeed)
	Calculates and sets the SPI baud divider to accompany the current peripherals maximum clock speed.
void	SPI_SetBitMode (SPI_TypeDef *SPIx, SPI_BitMode SPI_MODE_x)
	Changes the SPIx peripheral between 8-bit and 16-bit mode.
void	SPI_SetLsbFirst (SPI_TypeDef *SPIx, bool LsbFirst)
	Sets SPIx into either MsbFirst or LsbFirst mode.
void	SPI_SetClockPhaseAndPolarity (SPI_TypeDef *SPIx, bool ClkPhase, bool ClkPolarity)
	Sets the clock phase and polarity for SPIx.
void	SPI_SetToMaster (SPI_TypeDef *SPIx, bool isMaster)
	Configures SPIx peripheral as master or slave mode.
bool	SPI_HasDataToRecieve (SPI_TypeDef *SPIx)
	Checks if there is data available in the SPIx recieve buffer.

Detailed Description

Header file for SPI driver.

Author

Liam Bramley, Devin Marx

Version

0.1

Date

2024-01-30

Copyright

Copyright (c) 2023-2024

Enumeration Type Documentation

SPI_BaudDivider

enum SPI_BaudDivider

Enumerator
SPI_BAUD_DIV_2	Baud rate: SysClk / 2 bps
SPI_BAUD_DIV_4	Baud rate: SysClk / 4 bps
SPI_BAUD_DIV_8	Baud rate: SysClk / 8 bps
SPI_BAUD_DIV_16	Baud rate: SysClk / 16 bps
SPI_BAUD_DIV_32	Baud rate: SysClk / 32 bps
SPI_BAUD_DIV_64	Baud rate: SysClk / 64 bps
SPI_BAUD_DIV_128	Baud rate: SysClk / 128 bps
SPI_BAUD_DIV_256	Baud rate: SysClk / 256 bps

SPI_BitMode

enum SPI_BitMode

Enumerator
SPI_MODE_8Bit	8-bit data frame format for Tx/Rx
SPI_MODE_16Bit	16-bit data frame format for Tx/Rx

Function Documentation

SPI_CalculateAndSetBaudDivider()

void SPI_CalculateAndSetBaudDivider	(	SPI_TypeDef *	SPIx,
		uint32_t	maxPeripheralClockSpeed )

Calculates and sets the SPI baud divider to accompany the current peripherals maximum clock speed.

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)
maxPeripheralClockSpeed	Maximum clock speed the SPI peripheral can run at

SPI_EnableRemap()

void SPI_EnableRemap	(	const SPI_TypeDef *	SPIx,
		bool	enable )

Enables pin remapping on SPIx depending on the value of enable (Only SPI1 can be remapped)

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)
enable	True if the system should enable remapping for SPIx, false if it should not remap SPIx

SPI_EnableSoftwareCS()

void SPI_EnableSoftwareCS	(	SPI_TypeDef *	SPIx,
		GPIO_TypeDef *	GPIOx,
		uint16_t	GPIO_PIN )

Enables the software CS for SPIx. (Disables Hardware CS)

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)
GPIOx	Port of the GPIO (Ex. GPIOA, GPIOB, ...)
GPIO_PIN	Desired pin on port GPIOx (Ex. GPIO_PIN_0, GPIO_PIN_1, ...)

SPI_HasDataToRecieve()

bool SPI_HasDataToRecieve

(

SPI_TypeDef *

SPIx

)

Checks if there is data available in the SPIx recieve buffer.

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)

Returns

True if there is data available to recieve, false otherwise.

SPI_InitCS()

void SPI_InitCS	(	SPI_TypeDef *	SPIx,
		bool	isMaster,
		GPIO_TypeDef *	GPIOx,
		uint16_t	GPIO_PIN )

Initializes the SPIx peripheral to master or slave, using the chip select pin of your choosing. (Default Values: SPI_MODE_16Bit, SPI_BAUD_DIV_2, MSB First)

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)
isMaster	True if SPIx should act as the master, false if it should act as the slave
GPIOx	GPIO Port for the chip select pin (Ex. GPIOA, GPIOB, ...)
GPIO_PIN	Desired chip select pin on port GPIOx (Ex. GPIO_PIN_0, GPIO_PIN_1, ...)

SPI_Receive()

uint16_t SPI_Receive

(

const SPI_TypeDef *

SPIx

)

Recieves data from a SPI.

Parameters

SPIx	SPI to recieve from

Returns

Data recieved

SPI_SetBaudDivider()

void SPI_SetBaudDivider	(	SPI_TypeDef *	SPIx,
		SPI_BaudDivider	SPI_BAUD_DIV_x )

Changes the Baud rate divider of the SPIx peripheral.

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)
SPI_BAUD_DIV_x	SPI Tx Baud rate divider (Ex. SPI_BAUD_DIV_2, SPI_BAUD_DIV_4, ...)

SPI_SetBitMode()

void SPI_SetBitMode	(	SPI_TypeDef *	SPIx,
		SPI_BitMode	SPI_MODE_x )

Changes the SPIx peripheral between 8-bit and 16-bit mode.

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)
SPI_MODE_x	Bit mode selection for SPIx (Ex. SPI_MODE_8bit or SPI_MODE_16bit)

SPI_SetClockPhaseAndPolarity()

void SPI_SetClockPhaseAndPolarity	(	SPI_TypeDef *	SPIx,
		bool	ClkPhase,
		bool	ClkPolarity )

Sets the clock phase and polarity for SPIx.

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)
ClkPhase	True for second clock transition as first data capture edge, False for first clock transition. {See RM-744}
ClkPolarity	True to set clock to 1 when idle, else false to set low while idle.

SPI_SetLsbFirst()

void SPI_SetLsbFirst	(	SPI_TypeDef *	SPIx,
		bool	LsbFirst )

Sets SPIx into either MsbFirst or LsbFirst mode.

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)
LsbFirst	True if the data format should be LsbFirst, else false for MsbFirst.

SPI_SetToMaster()

void SPI_SetToMaster	(	SPI_TypeDef *	SPIx,
		bool	isMaster )

Configures SPIx peripheral as master or slave mode.

Parameters

SPIx	SPI Peripheral (Ex. SPI1 or SPI2)
isMaster	True to configure SPI as master, False to configure it as slave.

SPI_Transmit()

void SPI_Transmit	(	SPI_TypeDef *	SPIx,
		uint16_t	data )

Transmits data over the given SPI.

Parameters

SPIx	SPI to transmit over
data	Data to transmit

SPI_TransmitCS()

void SPI_TransmitCS	(	SPI_TypeDef *	SPIx,
		uint16_t	data,
		GPIO_TypeDef *	GPIOx,
		uint16_t	GPIO_PIN )

Transmits data over the given SPI, and toggles the CS pins accordingly.

Parameters

SPIx	SPI to transmit over
data	Data to transmit
GPIOx	GPIO Port for the chip select pin (Ex. GPIOA, GPIOB, ...)
GPIO_PIN	Desired chip select pin on port GPIOx (Ex. GPIO_PIN_0, GPIO_PIN_1, ...)

SPI_TransmitReceive()

uint16_t SPI_TransmitReceive	(	SPI_TypeDef *	SPIx,
		uint16_t	data )

Transmits and recieves data over the SPI.

Parameters

SPIx	SPI to transmit over
data	Data to transmit

Returns

Data recieved

SPI_TransmitReceiveCS()

uint16_t SPI_TransmitReceiveCS	(	SPI_TypeDef *	SPIx,
		uint16_t	data,
		GPIO_TypeDef *	GPIOx,
		uint16_t	GPIO_PIN )

Transmits and recieves data over the SPI, also takes care of the software chip select.

Parameters

SPIx	SPI to transmit over
data	Data to transmit
GPIOx	GPIO Port for the chip select pin (Ex. GPIOA, GPIOB, ...)
GPIO_PIN	Desired chip select pin on port GPIOx (Ex. GPIO_PIN_0, GPIO_PIN_1, ...)

Returns

Data recieved