ph-esp32-mac 0.1.1

no_std, no_alloc Rust implementation of the ESP32 Ethernet MAC (EMAC) driver
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

//! Integration facades for external stacks and runtimes.
//!
//! This module provides optional adapters for common embedded networking
//! stacks and runtimes.
//!
//! # Overview
//!
//! - **esp-hal** (`esp_hal`): HAL-friendly builders and ISR helpers
//! - **smoltcp** (`smoltcp`): `smoltcp::phy::Device` implementation
//! - **embassy-net** (`embassy-net`): `embassy_net_driver::Driver` implementation
//!
//! # Feature Flags
//!
//! - `esp-hal`: Enables esp-hal integration (`esp_hal` submodule)
//! - `smoltcp`: Enables smoltcp integration (`smoltcp` submodule)
//! - `embassy-net`: Enables Embassy integration (`embassy_net` submodule)
//!
//! # Usage
//!
//! ```ignore
//! // esp-hal
//! use ph_esp32_mac::integration::esp_hal::{EmacExt, Priority};
//! emac.bind_interrupt(handler);
//!
//! // smoltcp
//! use smoltcp::phy::Device;
//! let (rx, tx) = emac.receive(Instant::ZERO).unwrap();
//!
//! // embassy-net
//! use embassy_net_driver::Driver;
//! let _ = emac.capabilities();
//! ```
//!
//! # See Also
//!
//! - [`crate::esp_hal`] - re-exported esp-hal facade at the crate root

#[cfg(feature = "esp-hal")]
#[cfg_attr(docsrs, doc(cfg(feature = "esp-hal")))]
pub mod esp_hal;

#[cfg(feature = "smoltcp")]
#[cfg_attr(docsrs, doc(cfg(feature = "smoltcp")))]
pub mod smoltcp;

#[cfg(feature = "embassy-net")]
#[cfg_attr(docsrs, doc(cfg(feature = "embassy-net")))]
pub mod embassy_net;

// Re-export key types for convenience when both features are enabled
#[cfg(feature = "esp-hal")]
#[cfg_attr(docsrs, doc(cfg(feature = "esp-hal")))]
pub use esp_hal::{EMAC_INTERRUPT, EmacBuilder, EmacExt, EmacPhyBundle};

#[cfg(feature = "smoltcp")]
#[cfg_attr(docsrs, doc(cfg(feature = "smoltcp")))]
pub use smoltcp::{EmacRxToken, EmacTxToken, ethernet_address};

#[cfg(feature = "embassy-net")]
#[cfg_attr(docsrs, doc(cfg(feature = "embassy-net")))]
pub use embassy_net::{EmbassyEmac, EmbassyEmacState, EmbassyRxToken, EmbassyTxToken};