idfxx::spi::master_bus Class Reference

A SPI master bus. More...

Public Member Functions
	master_bus (enum host_device host, enum dma_chan dma_chan, struct bus_config config)
	Constructs a new SPI master bus.
	~master_bus ()
	master_bus (const master_bus &)=delete
master_bus &	operator= (const master_bus &)=delete
	master_bus (master_bus &&)=delete
master_bus &	operator= (master_bus &&)=delete
enum host_device	host () const
	Returns the host device ID the bus is using.

Static Public Member Functions
static result< std::unique_ptr< master_bus > >	make (enum host_device host, enum dma_chan dma_chan, struct bus_config config)
	Creates a new SPI master bus.

Detailed Description

A SPI master bus.

Represents a SPI bus operating in master mode.

Definition at line 157 of file master.hpp.

Constructor & Destructor Documentation

master_bus() [1/3]

idfxx::spi::master_bus::master_bus ( enum host_device  host, enum dma_chan  dma_chan, struct bus_config  config  )

explicit

Constructs a new SPI master bus.

Parameters

host	SPI host device (e.g., SPI2_HOST).
dma_chan	DMA channel, or idfxx::spi::dma_chan::disabled.
config	Bus configuration.

Note

Only available when CONFIG_COMPILER_CXX_EXCEPTIONS is enabled in menuconfig.

Exceptions

std::system_error

on failure.

~master_bus()

idfxx::spi::master_bus::~master_bus

(

)

master_bus() [2/3]

idfxx::spi::master_bus::master_bus ( const master_bus &  )

delete

master_bus() [3/3]

idfxx::spi::master_bus::master_bus ( master_bus &&  )

delete

Member Function Documentation

host()

enum host_device idfxx::spi::master_bus::host ( ) const

inline

Returns the host device ID the bus is using.

Definition at line 193 of file master.hpp.

make()

static result< std::unique_ptr< master_bus > > idfxx::spi::master_bus::make ( enum host_device  host, enum dma_chan  dma_chan, struct bus_config  config  )

static

Creates a new SPI master bus.

Parameters

host	SPI host device (e.g., SPI2_HOST).
dma_chan	DMA channel, or idfxx::spi::dma_chan::disabled.
config	Bus configuration.

Returns

The new bus, or an error.

operator=() [1/2]

master_bus & idfxx::spi::master_bus::operator= ( const master_bus &  )

delete

operator=() [2/2]

master_bus & idfxx::spi::master_bus::operator= ( master_bus &&  )

delete

---

The documentation for this class was generated from the following file:

• idfxx_spi/include/idfxx/spi/master.hpp