Struct esp_idf_svc::eth::EthDriver

pub struct EthDriver<'d, T> { /* private fields */ }

Implementations

impl<'d, T> EthDriver<'d, SpiEth<T>>

where T: Borrow<SpiDriver<'d>>,

pub fn new( driver: T, int: impl Peripheral<P = impl InputPin> + 'd, cs: Option<impl Peripheral<P = impl OutputPin> + 'd>, rst: Option<impl Peripheral<P = impl OutputPin> + 'd>, chipset: SpiEthChipset, baudrate: Hertz, mac_addr: Option<&[u8; 6]>, phy_addr: Option<u32>, sysloop: EspSystemEventLoop, ) -> Result<Self, EspError>

pub fn new_spi( driver: T, int: impl Peripheral<P = impl InputPin> + 'd, cs: Option<impl Peripheral<P = impl OutputPin> + 'd>, rst: Option<impl Peripheral<P = impl OutputPin> + 'd>, chipset: SpiEthChipset, baudrate: Hertz, mac_addr: Option<&[u8; 6]>, phy_addr: Option<u32>, sysloop: EspSystemEventLoop, ) -> Result<Self, EspError>

impl<'d, T> EthDriver<'d, T>

pub fn is_started(&self) -> Result<bool, EspError>

pub fn is_connected(&self) -> Result<bool, EspError>

pub fn start(&mut self) -> Result<(), EspError>

pub fn stop(&mut self) -> Result<(), EspError>

pub fn set_rx_callback<F>(&mut self, callback: F) -> Result<(), EspError>

where F: FnMut(EthFrame) + Send + 'static,

pub unsafe fn set_nonstatic_rx_callback<F>( &mut self, callback: F, ) -> Result<(), EspError>

where F: FnMut(EthFrame) + Send + 'd,

Safety

This method - in contrast to method set_rx_callback - allows the user to pass a non-static callback/closure. This enables users to borrow

• in the closure - variables that live on the stack - or more generally - in the same scope where the service is created.

HOWEVER: care should be taken NOT to call core::mem::forget() on the service, as that would immediately lead to an UB (crash). Also note that forgetting the service might happen with Rc and Arc when circular references are introduced: https://github.com/rust-lang/rust/issues/24456

The reason is that the closure is actually sent to a hidden ESP IDF thread. This means that if the service is forgotten, Rust is free to e.g. unwind the stack and the closure now owned by this other thread will end up with references to variables that no longer exist.

The destructor of the service takes care - prior to the service being dropped and e.g. the stack being unwind - to remove the closure from the hidden thread and destroy it. Unfortunately, when the service is forgotten, the un-subscription does not happen and invalid references are left dangling.

This “local borrowing” will only be possible to express in a safe way once/if !Leak types are introduced to Rust (i.e. the impossibility to “forget” a type and thus not call its destructor).

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

Trait Implementations

impl<'d, T> Drop for EthDriver<'d, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, T> Eth for EthDriver<'d, T>

type Error = EspError

fn start(&mut self) -> Result<(), Self::Error>

fn stop(&mut self) -> Result<(), Self::Error>

fn is_started(&self) -> Result<bool, Self::Error>

fn is_connected(&self) -> Result<bool, Self::Error>

impl<'d, T> RawHandle for EthDriver<'d, T>

type Handle = *mut c_void

fn handle(&self) -> Self::Handle

Care should be taken to use the returned ESP-IDF driver raw handle only while the driver is still alive, so as to avoid use-after-free errors.

impl<'d, T> Send for EthDriver<'d, T>