cotton_w5500/
lib.rs

1//! A Wiznet W5500 driver for smoltcp
2//!
3//! This crate includes an implementation of `smoltcp::phy::Device`
4//! which uses the [W5500](https://crates.io/crates/w5500) crate to
5//! target [smoltcp](https://crates.io/crates/smoltcp) to the Wiznet
6//! W5500 SPI-to-Ethernet chip, as found on the
7//! [W5500-EVB-Pico](https://thepihut.com/products/wiznet-w5100s-evb-pico-rp2040-board-with-ethernet)
8//! board (and in many other places). The W5500 is operated in
9//! "MACRAW" (raw packet) mode, which allows more flexible networking
10//! (via smoltcp) than is possible using the W5500's onboard TCP/UDP
11//! mode -- for instance, it enables IPv6 support, which would
12//! otherwise require the somewhat rarer W6100 chip.
13//!
14//! Although cotton-w5500 works well with cotton-unique, it is
15//! relatively stand-alone: it does not depend on cotton-unique nor on
16//! any other part of the Cotton project.
17#![cfg_attr(not(feature = "std"), no_std)]
18#![warn(missing_docs)]
19#![warn(rustdoc::missing_crate_level_docs)]
20
21/// Using W5500 with smoltcp
22#[cfg(feature = "smoltcp")]
23pub mod smoltcp;