Struct stm32_eth::Eth

pub struct Eth<'rx, 'tx> { /* fields omitted */ }

Ethernet driver for STM32 chips with a LAN8742 Phy like they're found on STM Nucleo-144 boards.

Methods

impl<'rx, 'tx> Eth<'rx, 'tx>

pub fn new(
    eth_mac: ETHERNET_MAC,
    eth_dma: ETHERNET_DMA,
    rx_buffer: &'rx mut [RingEntry<RxDescriptor>],
    tx_buffer: &'tx mut [RingEntry<TxDescriptor>]
) -> Self

Initialize and start tx and rx DMA engines.

You must call setup() before to initialize the hardware!

Make sure that the buffers reside in a memory region that is accessible by the peripheral. Core-Coupled Memory (CCM) is usually not.

Other than that, initializes and starts the Ethernet hardware so that you can send() and recv_next().

pub fn enable_interrupt(&self, nvic: &mut NVIC)

Enable RX and TX interrupts

In your handler you must call eth_interrupt_handler() to clear interrupt pending bits. Otherwise the interrupt will reoccur immediately.

pub fn interrupt_handler(&self)

Calls eth_interrupt_handler()

pub fn get_phy<'a>(&'a self) -> Phy<'a>

Construct a PHY driver

pub fn status(&self) -> PhyStatus

Obtain PHY status

pub fn rx_is_running(&self) -> bool

Is Rx DMA currently running?

It stops if the ring is full. Call recv_next() to free an entry and to demand poll from the hardware.

pub fn recv_next(&mut self) -> Result<RxPacket, RxError>

Receive the next packet (if any is ready), or return None immediately.

pub fn tx_is_running(&self) -> bool

Is Tx DMA currently running?

pub fn send<F: FnOnce(&mut [u8]) -> R, R>(
    &mut self,
    length: usize,
    f: F
) -> Result<R, TxError>

Send a packet

Trait Implementations

impl<'a, 'rx, 'tx, 'b> Device<'a> for &'b mut Eth<'rx, 'tx>

Use this Ethernet driver with smoltcp

type RxToken = EthRxToken<'a>

type TxToken = EthTxToken<'a>

fn capabilities(&self) -> DeviceCapabilities

Get a description of device capabilities.

fn receive(&mut self) -> Option<(Self::RxToken, Self::TxToken)>

Construct a token pair consisting of one receive token and one transmit token.

fn transmit(&mut self) -> Option<Self::TxToken>

Construct a transmit token.