Struct Ethernet 

pub struct Ethernet<'d, DM: DriverMode, P: Phy> { /* private fields */ }

EMAC Ethernet driver.

Implementations

impl<'d, P: Phy> Ethernet<'d, Blocking, P>

pub fn new<const RX: usize, const TX: usize>( eth: ETH<'d>, storage: &'d mut EthernetDmaStorage<RX, TX>, mac_addr: [u8; 6], phy: P, pins: impl EthernetPinBundle + 'd, ) -> Result<Self, Error>

Creates an Ethernet driver using RMII (RmiiPinBundle) or MII (MiiPinBundle).

pub fn receive(&mut self) -> Result<&mut [u8], Error>

Returns the received frame data if one is ready.

Call pop_rx after processing the frame.

pub fn pop_rx(&mut self)

Releases the current RX descriptor back to DMA.

pub fn into_async(self) -> Ethernet<'d, Async, P>

Converts to async mode, enabling DMA interrupts and binding the ISR.

impl<'d, Dm: DriverMode, P: Phy> Ethernet<'d, Dm, P>

pub fn set_speed(&mut self, speed: Speed)

Configures the MAC for the given speed.

pub fn set_duplex(&mut self, duplex: Duplex)

Configures the MAC for the given duplex mode.

pub fn transmit(&mut self, frame: &[u8]) -> Result<(), Error>

Copies frame into the next TX slot and initiates transmission.

pub fn poll_link(&mut self, cx: Option<&mut Context<'_>>) -> LinkState

Returns the current PHY link state.

Async callers are encouraged to pass the context to allow the PHY driver to wake them when the link state needs to be re-polled.

pub fn mac_addr(&self) -> [u8; 6]

Returns the MAC address configured during construction.

impl<'d, P: Phy> Ethernet<'d, Async, P>

pub async fn transmit_async(&mut self, frame: &[u8]) -> Result<(), Error>

Asynchronously waits for a TX slot and transmits frame.

pub async fn receive_async(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Asynchronously waits for a frame and copies it into buf.

pub fn into_blocking(self) -> Ethernet<'d, Blocking, P>

Converts back to blocking mode, disabling all DMA interrupts.

pub fn tx_has_capacity(&self) -> bool

Returns true if there is at least one free TX descriptor slot.

pub fn peek_rx(&mut self) -> Option<&mut [u8]>

Peeks at the next received frame without consuming it.

Returns Some(data_slice) if a valid frame is ready, or None. The caller must call release_rx after processing.

pub fn release_rx(&mut self)

Releases the current RX descriptor back to the DMA engine.

Trait Implementations

impl<'d, P: Phy> Driver for Ethernet<'d, Async, P>

Available on crate feature unstable only.

type RxToken<'a> = EthernetRxToken<'a, 'd> where Self: 'a

A token to receive a single network packet.

type TxToken<'a> = EthernetTxToken<'a, 'd> where Self: 'a

A token to transmit a single network packet.

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

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

fn transmit(&mut self, cx: &mut Context<'_>) -> Option<Self::TxToken<'_>>

Construct a transmit token.

fn link_state(&mut self, cx: &mut Context<'_>) -> LinkState

Get the link state.

fn capabilities(&self) -> Capabilities

Get a description of device capabilities.

fn hardware_address(&self) -> HardwareAddress

Get the device’s hardware address.