Driver for STM32 low level SPI peripheral. More...

#include <SPIBus.h>

Inheritance diagram for Boardcore::SPIBus:

[legend]

Collaboration diagram for Boardcore::SPIBus:

Public Member Functions
	SPIBus (SPIType *spi)
	Delete copy/move contructors/operators.

	SPIBus (const SPIBus &)=delete

SPIBus &	operator= (const SPIBus &)=delete

	SPIBus (SPIBus &&)=delete

SPIBus &	operator= (SPIBus &&)=delete

SPIType *	getSpi ()
	Retrieve the pointer to the peripheral currently used.

void	reset ()
	Resets the peripheral configuration.

void	enable ()
	Enables the peripheral.

void	disable ()
	Disables the peripheral.

void	set8BitFrameFormat ()

void	enableSoftwareSlaveManagement ()

void	disableSoftwareSlaveManagement ()

void	enableInternalSlaveSelection ()

void	disableInternalSlaveSelection ()

void	setBitOrder (SPI::Order bitOrder)

void	setClockDiver (SPI::ClockDivider divider)

void	setSlaveConfiguration ()

void	setMasterConfiguration ()

void	setMode (SPI::Mode mode)

void	enableTxDMARequest ()

void	disableTxDMARequest ()

void	enableRxDMARequest ()

void	disableRxDMARequest ()

void	waitPeripheral ()

void	flushRxBuffer ()

void	configure (SPIBusConfig newConfig) override
	Configures and enables the bus with the provided configuration.

void	select (GpioType cs) override
	See SPIBusInterface::select().

void	deselect (GpioType cs) override
	See SPIBusInterface::deselect().

uint8_t	read () override
	Reads 8 bits from the bus.

uint16_t	read16 () override
	Reads 16 bits from the bus.

uint32_t	read24 () override
	Reads 24 bits from the bus.

uint32_t	read32 () override
	Reads 32 bits from the bus.

void	read (uint8_t *data, size_t size) override
	Reads multiple bytes from the bus.

void	read16 (uint16_t *data, size_t size) override
	Reads multiple half words from the bus.

void	write (uint8_t data) override
	Writes 8 bits to the bus.

void	write16 (uint16_t data) override
	Writes 16 bits to the bus.

void	write24 (uint32_t data) override
	Writes 24 bits to the bus.

void	write32 (uint32_t data) override
	Writes 32 bits to the bus.

void	write (const uint8_t *data, size_t size) override
	Writes multiple bytes to the bus.

void	write16 (const uint16_t *data, size_t size) override
	Writes multiple half words to the bus.

uint8_t	transfer (uint8_t data) override
	Full duplex transmission of 8 bits on the bus.

uint16_t	transfer16 (uint16_t data) override
	Full duplex transmission of 16 bits on the bus.

uint32_t	transfer24 (uint32_t data) override
	Full duplex transmission of 24 bits on the bus.

uint32_t	transfer32 (uint32_t data) override
	Full duplex transmission of 32 bits on the bus.

void	transfer (uint8_t *data, size_t size) override
	Full duplex transmission of multiple bytes on the bus.

void	transfer16 (uint16_t *data, size_t size) override
	Full duplex transmission of multiple half words on the bus.

Public Member Functions inherited from Boardcore::SPIBusInterface
	SPIBusInterface ()
	Delete copy/move constructors/operators.

	SPIBusInterface (const SPIBusInterface &)=delete

SPIBusInterface &	operator= (const SPIBusInterface &)=delete

	SPIBusInterface (SPIBusInterface &&)=delete

SPIBusInterface &	operator= (SPIBusInterface &&)=delete

Detailed Description

Driver for STM32 low level SPI peripheral.

This driver applies to the whole STM32F4xx family.

The serial peripheral interface (SPI) allows half/full-duplex, synchronous, serial communication with external devices. The interface can be configured as the master and in this case it provides the communication clock (SCK) to the external slave device. The peripheral is also capable of reliable communication using CRC checking.

Supported SPI main features:

Full-duplex synchronous transfers on three lines
8 or 16-bit transfer frame formats
Master operation
8 master mode baud rate prescaler values (f_PCLK/2 max.)
Programmable clock polarity and phase
Programmable data order (MSBit-first or LSBit-first)

Definition at line 60 of file SPIBus.h.

Constructor & Destructor Documentation

◆ SPIBus() [1/3]

Boardcore::SPIBus::SPIBus ( SPIType * spi )

inline

Delete copy/move contructors/operators.

Definition at line 301 of file SPIBus.h.

◆ SPIBus() [2/3]

Boardcore::SPIBus::SPIBus ( const SPIBus & )

delete

◆ SPIBus() [3/3]

Boardcore::SPIBus::SPIBus ( SPIBus && )

delete

Member Function Documentation

◆ configure()

void Boardcore::SPIBus::configure ( SPIBusConfig newConfig )

inlineoverridevirtual

Configures and enables the bus with the provided configuration.

Since this implementation is not synchronized, if configure() is called on an already in use bus nothing will be done.

Use SyncedSPIBus if you need to synchronize access to the bus.

data	Buffer to be filled with received data.
size	Size of the buffer.

data	Buffer containing data to trasfer.
size	Size of the buffer.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SPIBus() [1/3]

◆ SPIBus() [2/3]

◆ SPIBus() [3/3]

Member Function Documentation

◆ configure()

◆ deselect()

◆ disable()

◆ disableInternalSlaveSelection()

◆ disableRxDMARequest()

◆ disableSoftwareSlaveManagement()

◆ disableTxDMARequest()

◆ enable()

◆ enableInternalSlaveSelection()

◆ enableRxDMARequest()

◆ enableSoftwareSlaveManagement()

◆ enableTxDMARequest()

◆ flushRxBuffer()

◆ getSpi()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ read() [1/2]

◆ read() [2/2]

◆ read16() [1/2]

◆ read16() [2/2]

◆ read24()

◆ read32()

◆ reset()

◆ select()

◆ set8BitFrameFormat()

◆ setBitOrder()

◆ setClockDiver()

◆ setMasterConfiguration()

◆ setMode()

◆ setSlaveConfiguration()

◆ transfer() [1/2]

◆ transfer() [2/2]

◆ transfer16() [1/2]

◆ transfer16() [2/2]

◆ transfer24()

◆ transfer32()

◆ waitPeripheral()

◆ write() [1/2]

◆ write() [2/2]

◆ write16() [1/2]

◆ write16() [2/2]

◆ write24()

◆ write32()