Device driver toolkit #![no_std] [![crates.io](https://img.shields.io/crates/v/device-driver.svg)](https://crates.io/crates/device-driver) Documentation

A toolkit to write better device drivers, faster.

See this example to see how it works. There's also this OPL2 device driver that is used as reference register implementation for this crate.

Feedback and feature requests are appreciated! Just open an issue on github.

Example

```rust // Create our low level device. This holds all the hardware communication definitions createlowleveldevice!( /// Our test device MyDevice { // The types of errors our low level error enum must contain errors: [InterfaceError], hardwareinterfacerequirements: { RegisterInterface }, hardwareinterface_capabilities: { fn reset(&mut self) -> Result<(), InterfaceError>; }, } );

// Create a register set for the device implement_registers!( /// The global register set that uses a u8 as register address MyDevice.registers = { /// The identification register (which is RO (Read Only)) #[generate(Debug)] // We want a fancy debug impl id(RO, 0, 3) = { /// The manufacturer code manufacturer: u16 as Manufacturer = RO 0..16, // Cast the raw int to an enum /// The version of the chip version: u8 = RO 16..20, /// The edition of the chip edition: u8 = RO 20..24, }, // .... // .... // .... } );

/// Does some random register things to showcase how everything works fn run( device: &mut MyDevice>, ) -> Result<(), LowLevelError> where SPI: Transfer + Write, CS: OutputPin, RESET: OutputPin, { // We read the manufacturer let id = device.registers().id().read()?;

// Print the id. It is marked with `#[generate(Debug)]`,
// so it should only show all fields
println!("{:?}", id);

// Enable output on pin 0
device
    .registers()
    .port()
    .write(|w| w.output_0(Bit::Set).mask_0(Bit::Set))?;

// Disable the irq status bit
device
    .registers()
    .irq_settings()
    .modify(|_, w| w.irq_status(Bit::Cleared))?;
}

Ok(())

} ```

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

TODO

Stability

This crate is far from stable. But if it works for you, then I see no reason why you couldn't use it already. Only updating to a new version may break stuff and proper Semver will be used.

Changelog

0.3.1 (22-12-21)