SonataSpi::EthernetMac Class Reference

A specialised driver for the SPI device connected to the Ethernet MAC. More...

#include <platform-spi.hh>

Inheritance diagram for SonataSpi::EthernetMac:

Collaboration diagram for SonataSpi::EthernetMac:

Public Member Functions
void	chip_select_assert (const bool Assert) volatile
	Assert the chip select line.
void	reset_assert (const bool Assert=true) volatile
	Assert the reset line.
Public Member Functions inherited from SonataSpi::Generic< 2 >
void	interrupt_enable (Interrupt interrupt) volatile
	Enable the given interrupt(s).
void	interrupt_disable (Interrupt interrupt) volatile
	Disable the given interrupt(s).
void	init (const bool ClockPolarity, const bool ClockPhase, const bool MsbFirst, const uint16_t HalfClockPeriod) volatile
	Initialises the SPI block.
void	wait_idle () volatile
	Waits for the SPI device to become idle.
void	blocking_write (const uint8_t data[], uint16_t len) volatile
	Sends len bytes from the given data buffer, where len is at most 0x7ff.
void	blocking_read (uint8_t data[], uint16_t len) volatile
void	chip_select_assert (const bool Assert=true) volatile
	Asserts/de-asserts a given chip select.

Additional Inherited Members
Public Types inherited from SonataSpi::Generic< 2 >
using	Debug
	Helper for conditional debug logs and assertions.
Public Attributes inherited from SonataSpi::Generic< 2 >
uint32_t	interruptState
	The current state of the SPI interrupts.
uint32_t	interruptEnable
	Controls which interrupts are enabled.
uint32_t	interruptTest
	Allows one to manually trigger an interrupt for testing.
uint32_t	configuration
	Configuration register.
uint32_t	control
	Controls the operation of the SPI block.
uint32_t	status
	Status information about the SPI block.
uint32_t	start
	Writes to this begin an SPI operation.
uint32_t	receiveFifo
	Data from the receive FIFO.
uint32_t	transmitFifo
	Bytes written here are pushed to the transmit FIFO.
uint32_t	info
	Information about the SPI controller.
uint32_t	chipSelects
	Chip Select lines; each bit controls a chip select line.
Static Public Attributes inherited from SonataSpi::Generic< 2 >
static constexpr bool	DebugSonataSpi
	Flag set when we're debugging this driver.

Detailed Description

A specialised driver for the SPI device connected to the Ethernet MAC.

Definition at line 350 of file platform-spi.hh.

Member Function Documentation

chip_select_assert()

void SonataSpi::EthernetMac::chip_select_assert ( const bool Assert ) volatile

inline

Assert the chip select line.

Parameters

Assert

Whether to assert (true) or de-assert (false) the chip select line.

Definition at line 364 of file platform-spi.hh.

References SonataSpi::Generic< NumChipSelects >::chip_select_assert().

reset_assert()

void SonataSpi::EthernetMac::reset_assert ( const bool Assert = true ) volatile

inline

Assert the reset line.

Parameters

Assert

Whether to assert (true) or de-assert (false) the reset line.

Definition at line 373 of file platform-spi.hh.

References SonataSpi::Generic< NumChipSelects >::chip_select_assert().

---

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

• sdk/include/platform/sunburst/platform-spi.hh