device-driver 1.0.9

A toolkit to write better device drivers, faster
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

use device_driver::RegisterInterface;

pub struct DeviceInterface;

impl RegisterInterface for DeviceInterface {
    type Error = ();
    type AddressType = u8;

    fn write_register(
        &mut self,
        _address: Self::AddressType,
        _size_bits: u32,
        data: &[u8],
    ) -> Result<(), Self::Error> {
        // Assert data is little endian
        assert_eq!(data, &[0x34, 0x12]);

        Ok(())
    }

    fn read_register(
        &mut self,
        _address: Self::AddressType,
        _size_bits: u32,
        data: &mut [u8],
    ) -> Result<(), Self::Error> {
        data.copy_from_slice(&[0x32, 0x12]);
        Ok(())
    }
}

device_driver::create_device!(
    device_name: MyTestDevice,
    dsl: {
        config {
            type RegisterAddressType = u8;
        }
        register FooLE {
            const ADDRESS = 0;
            const SIZE_BITS = 16;
            type ByteOrder = LE;
            const ALLOW_ADDRESS_OVERLAP = true;
            const RESET_VALUE = 0x1234;

            val: uint = 0..16,
        },
        register FooLEArray {
            const ADDRESS = 0;
            const SIZE_BITS = 16;
            type ByteOrder = LE;
            const ALLOW_ADDRESS_OVERLAP = true;
            const RESET_VALUE = [0x34, 0x12]; // As the read and write functions see it

            val: uint = 0..16,
        },
        register FooBE {
            const ADDRESS = 0;
            const SIZE_BITS = 16;
            type ByteOrder = BE;
            const ALLOW_ADDRESS_OVERLAP = true;
            const RESET_VALUE = 0x3412;

            val: uint = 0..16,
        },
        register FooBEArray {
            const ADDRESS = 0;
            const SIZE_BITS = 16;
            type ByteOrder = BE;
            const ALLOW_ADDRESS_OVERLAP = true;
            const RESET_VALUE = [0x34, 0x12];

            val: uint = 0..16,
        }
    }
);

#[test]
fn little_endian_respected() {
    let mut device = MyTestDevice::new(DeviceInterface);

    device.foo_le().write(|_| {}).unwrap();
    device
        .foo_le()
        .write_with_zero(|reg| reg.set_val(0x1234))
        .unwrap();

    device.foo_le_array().write(|_| {}).unwrap();
    device
        .foo_le_array()
        .write_with_zero(|reg| reg.set_val(0x1234))
        .unwrap();
}

#[test]
fn big_endian_respected() {
    let mut device = MyTestDevice::new(DeviceInterface);

    device.foo_be().write(|_| {}).unwrap();
    device
        .foo_be()
        .write_with_zero(|reg| reg.set_val(0x3412))
        .unwrap();

    device.foo_be_array().write(|_| {}).unwrap();
    device
        .foo_be_array()
        .write_with_zero(|reg| reg.set_val(0x3412))
        .unwrap();
}