device-driver 2.0.0

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
110
111
112
113
114
115

use device_driver::{FieldsetMetadata, RegisterInterface, RegisterInterfaceBase};

device_driver::compile!(
    unstable_ddsl: "
        device MyTestDevice {
            default-byte-order: LE,
            register-address-type: u8,
            default-access: RW,

            register Foo {
                address: 0,
                reset: 0xFFFFFFFF,

                fields: fieldset FooFieldSet {
                    size-bytes: 4,

                    field value 31:0 -> uint
                }
            }
        }
    "
);

pub struct DeviceInterface;

impl RegisterInterfaceBase for DeviceInterface {
    type Error = ();
    type AddressType = u8;
}
impl RegisterInterface for DeviceInterface {
    fn write_register(
        &mut self,
        _address: Self::AddressType,
        _data: &mut [u8],
        _metadata: &FieldsetMetadata,
    ) -> Result<(), Self::Error> {
        unimplemented!()
    }

    fn read_register(
        &mut self,
        _address: Self::AddressType,
        _data: &mut [u8],
        _metadata: &FieldsetMetadata,
    ) -> Result<(), Self::Error> {
        unimplemented!()
    }
}

#[cfg(test)]
mod tests {
    use device_driver::Fieldset;

    use super::*;

    #[test]
    fn and() {
        let reset_foo = MyTestDevice::new(DeviceInterface).foo().reset_value();

        assert_eq!(reset_foo & FooFieldSet::ZERO, FooFieldSet::ZERO);

        let mut test_foo = FooFieldSet::ZERO;
        test_foo.set_value(0x12345678);

        assert_eq!(reset_foo & test_foo, test_foo);
        assert_eq!(test_foo & FooFieldSet::ZERO, FooFieldSet::ZERO);

        test_foo &= FooFieldSet::ZERO;

        assert_eq!(test_foo, FooFieldSet::ZERO);
    }

    #[test]
    fn or() {
        let reset_foo = MyTestDevice::new(DeviceInterface).foo().reset_value();

        assert_eq!(FooFieldSet::ZERO | reset_foo, reset_foo);

        let mut test_foo = FooFieldSet::ZERO;
        test_foo.set_value(0x12345678);

        assert_eq!(FooFieldSet::ZERO | test_foo, test_foo);
        assert_eq!(test_foo | reset_foo, reset_foo);

        test_foo |= reset_foo;

        assert_eq!(test_foo, reset_foo);
    }

    #[test]
    fn xor() {
        let reset_foo = MyTestDevice::new(DeviceInterface).foo().reset_value();

        assert_eq!(FooFieldSet::ZERO ^ reset_foo, reset_foo);
        assert_eq!(FooFieldSet::ZERO ^ reset_foo ^ reset_foo, FooFieldSet::ZERO);

        let mut test_foo = FooFieldSet::ZERO;
        test_foo.set_value(0x12345678);

        assert_eq!(FooFieldSet::ZERO ^ test_foo, test_foo);
        assert_eq!(test_foo ^ reset_foo, !test_foo);

        test_foo ^= test_foo;

        assert_eq!(test_foo, FooFieldSet::ZERO);
    }

    #[test]
    fn not() {
        let reset_foo = MyTestDevice::new(DeviceInterface).foo().reset_value();

        assert_eq!(!FooFieldSet::ZERO, reset_foo);
        assert_eq!(!reset_foo, FooFieldSet::ZERO);
    }
}