Crate w5500_ll

Platform agnostic rust driver for the Wiznet W5500 SPI internet offload chip.

This is a low-level (ll) crate. The scope of this crate is:

1. Register accessors.
2. Networking data types.

Higher level functionality (such as socket operations) should be built on-top of what is provided here.

Example

Reading the VERSIONR register (a constant value).

use w5500_ll::{eh1::vdm::W5500, Registers};

let mut w5500 = W5500::new(spi);
let version: u8 = w5500.version()?;
assert_eq!(version, 0x04);

Feature Flags

All features are disabled by default.

• defmt: Enable formatting most types with defmt.
• eh0: Enables the eh0 module which contains implementations of the Registers trait using the embedded-hal version 0.2 traits.
• eh1: Enables the eh1 module which contains implementations of the Registers trait using the embedded-hal version 1 traits.
• eha1: Implements the aio::Registers trait for types in the eh1 module using the embedded-hal-async traits.

Modules

• aio
  Asynchronous W5500 traits.
• eh0eh0
  Blocking implementations of the Registers trait using the embedded-hal version 0.2 blocking SPI traits.
• eh1eh1
  Blocking implementations of the Registers trait using the embedded-hal version 1 blocking SPI traits.
• net
  Networking data types.
• spi
  Helpers and functions relating to W5500 SPI transfers.

Structs

• Interrupt
  Interrupt and interrupt mask register (IR and IMR).
• Mode
  Mode register (MR).
• PhyCfg
  PHY configuration register (PHYCFGR).
• RxPtrs
  RX socket buffer pointers.
• SocketInterrupt
  Socket Interrupt Register (Sn_IR).
• SocketInterruptMask
  Socket Interrupt Mask Register (Sn_IMR).
• SocketMode
  Socket Mode Register (Sn_MR).
• TxPtrs
  TX socket buffer pointers.

Enums

• BufferSize
  RX and TX buffer sizes.
• DuplexStatus
  PHY duplex status.
• LinkStatus
  PHY link status.
• OperationMode
  PHY operation mode.
• Protocol
  Socket protocol.
• Reg
  W5500 common register addresses.
• Sn
  W5500 socket numbers.
• SnReg
  W5500 socket register addresses.
• SocketCommand
  Socket commands.
• SocketStatus
  Socket status.
• SpeedStatus
  PHY speed status.

Constants

• COMMON_BLOCK_OFFSET
  Common register block address offset.
• SOCKETS
  Array of all sockets.
• VERSION
  Value of the W5500 VERSIONR register.

Traits

• Registers
  W5500 register setters and getters.