Struct embassy_net_enc28j60::Enc28j60

pub struct Enc28j60<S, O> { /* private fields */ }

ENC28J60 embassy-net driver

Implementations

impl<S, O> Enc28j60<S, O>

where S: SpiDevice, O: OutputPin,

pub fn new(spi: S, rst: Option<O>, mac_addr: [u8; 6]) -> Self

Create a new ENC28J60 driver instance.

The RST pin is optional. If None, reset will be done with a SPI soft reset command, instead of via the RST pin.

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

Returns the device’s MAC address

pub fn receive(&mut self, buf: &mut [u8]) -> Option<usize>

Flushes the transmit buffer, ensuring all pending transmissions have completed NOTE: The returned packet must be read or ignore-d, otherwise this method will always return None on subsequent invocations

pub fn transmit(&mut self, bytes: &[u8])

Starts the transmission of bytes

It’s up to the caller to ensure that bytes is a valid Ethernet frame. The interface will take care of appending a (4 byte) CRC to the frame and of padding the frame to the minimum size allowed by the Ethernet specification (64 bytes, or 46 bytes of payload).

NOTE This method will flush any previous transmission that’s in progress

Panics

If bytes length is greater than 1514, the maximum frame length allowed by the interface, or greater than the transmit buffer

pub fn is_link_up(&mut self) -> bool

Get whether the link is up

pub fn mtu(&self) -> u16

Returns the interface Maximum Transmission Unit (MTU)

The value returned by this function will never exceed 1514 bytes. The actual value depends on the memory assigned to the transmission buffer when initializing the device

pub fn pending_packets(&mut self) -> u8

Returns the number of packets that have been received but have not been processed yet

pub fn accept(&mut self, packets: &[Packet])

Adjusts the receive filter to accept these packet types

pub fn ignore(&mut self, packets: &[Packet])

Adjusts the receive filter to ignore these packet types

Trait Implementations

impl<S, O> Driver for Enc28j60<S, O>

where S: SpiDevice, O: OutputPin,

type RxToken<'a> = RxToken<'a> where Self: 'a

A token to receive a single network packet.

type TxToken<'a> = TxToken<'a, S, O> 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.