Skip to main content

Crate xarxa_driver

Crate xarxa_driver 

Source
Expand description

§xarxa-driver

The driver interface of the xarxa network stack.

Driver implementations should depend on xarxa-driver instead of the full xarxa crate.

§Feature flags

  • defmt — Derive defmt::Format on the types in this crate.
  • async — Enable the async parts of the driver API: Driver::register_waker.

§Packet metadata

  • packetmeta-id — Enable the PacketMeta::id field: an opaque number that travels with a packet through the whole stack.

  • packetmeta-timestamp — Enable the PacketMeta::timestamp and PacketMeta::request_timestamp fields, and Driver::poll_tx_timestamp.

    Transmit timestamps are correlated back to the packet that produced them by PacketMeta::id, so this implies packetmeta-id.

Modules§

config
Compile-time configuration.

Structs§

Capabilities
A description of a device’s capabilities.
ChecksumCapabilities
Checksum offload capabilities per protocol direction.
ChecksumOffload
Checksum offload capabilities for a given protocol, per direction.
NotSupported
Error returned by an operation the driver does not support.
PacketBuf
An owned network packet buffer.
PacketMeta
Metadata associated with a packet.
Timestamp
A reading of a device’s own clock.
TxTimestamp
The timestamp of a transmitted packet, reported by Driver::poll_tx_timestamp.

Enums§

HardwareAddress
A hardware (link-layer) address, as reported by a driver.
LinkState
Link state of a network device.
Medium
Type of medium of a network device.

Traits§

Driver
A network device driver, sending and receiving raw network frames.