catnip
A no-std, panic-never, heapless, minimally-featured UDP/IP stack for bare-metal.
Intended for fixed-time data acquisition and controls on LAN.
Makes use of const generic expressions to provide flexibility in,
and guaranteed correctness of, lengths of headers and data segments without
dynamic allocation.
Because of this, the crate currently relies on the nightly channel, and as a result, may break regularly
until the required features stabilize.
This library is under active development; major functionality is yet to
be implemented and I'm sure some bugs are yet to be found.
Docs: https://docs.rs/catnip.
Example
```rust
use catnip::*;
// Some made-up data with two 32-bit words' worth of bytes and some arbitrary addresses
let data: ByteArray<8> = ByteArray([0, 1, 2, 3, 4, 5, 6, 7]);
// Build frame
let frame = EthernetFrame::>>> {
header: EthernetHeader {
dstmacaddr: MacAddr::BROADCAST,
srcmacaddr: MacAddr::new([0x02, 0xAF, 0xFF, 0x1A, 0xE5, 0x3C]),
ethertype: EtherType::IpV4,
},
data: IpV4Frame::>> {
header: IpV4Header {
versionandheaderlength: VersionAndHeaderLength::new().withversion(4).withheaderlength((IpV4Header::BYTELEN / 4) as u8),
dscp: DSCP::Standard,
totallength: IpV4Frame::>>::BYTELEN as u16,
identification: 0,
fragmentation: Fragmentation::default(),
timetolive: 10,
protocol: Protocol::Udp,
checksum: 0,
srcipaddr: IpV4Addr::new([10, 0, 0, 120]),
dstipaddr: IpV4Addr::new([10, 0, 0, 121]),
},
data: UdpFrame::> {
header: UdpHeader {
srcport: 8123,
dstport: 8125,
length: UdpFrame::>::BYTELEN as u16,
checksum: 0,
},
data: data,
},
},
checksum: 0_u32,
};
// Calculate IP and UDP checksums
frame.data.data.header.checksum = calcudpchecksum(&frame.data);
frame.data.header.checksum = calcipchecksum(&frame.data.header.tobebytes());
// Reduce to big-endian network bytes
let bytes = frame.tobebytes();
// Parse from bytes
let frameparsed = EthernetFrame::>>>::readbytes(&bytes);
asserteq!(frameparsed, frame);
```
Features
- Ethernet II frames
- IPV4
- UDP
- ARP
- DHCP (INFORM only)
To-do
- Add UDP psuedo-socket trait w/ arbitrary async send/receive functions
- Move to stable once constants defined in traits become available for parametrizing generics
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.