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
116
117
118
119
120
121
122
123
124
125
126
127

use device_driver::{CommandInterface, CommandInterfaceBase, FieldsetMetadata};

pub struct DeviceInterface {
    last_command: u8,
    last_input: Vec<u8>,
}

impl CommandInterfaceBase for DeviceInterface {
    type Error = ();
    type AddressType = u8;
}
impl CommandInterface for DeviceInterface {
    fn dispatch_command(
        &mut self,
        address: Self::AddressType,
        input: &mut [u8],
        _input_metadata: &FieldsetMetadata,
        output: &mut [u8],
        _output_metadata: &FieldsetMetadata,
    ) -> Result<(), Self::Error> {
        self.last_command = address;
        self.last_input = input.to_vec();

        let len = output.len().min(input.len());
        output[..len].copy_from_slice(&input[..len]);
        Ok(())
    }
}

device_driver::compile!(
    unstable_ddsl: "
        device MyTestDevice {
            default-byte-order: LE,
            command-address-type: u8,
            default-access: RW,
            
            /// A simple command
            command Simple {
                address: 0
            },
            /// A command with only inputs
            command Input {
                address: 1,
                fields-in: fieldset InputFieldsIn {
                    size-bytes: 2,

                    /// The value!
                    field val 15:0 -> uint
                }
            },
            /// A command with only outputs
            command Output {
                address: 2,
                fields-out: fieldset OutputFieldsOut {
                    size-bytes: 1,

                    /// The value!
                    field val 7:0 -> uint
                }
            },
            /// A command with inputs and outputs
            command InOut {
                address: 3,
                fields-in: fieldset InOutFieldsIn {
                    size-bytes: 2,

                    /// The value!
                    field val 15:0 -> uint,
                },
                fields-out: fieldset InOutFieldsOut {
                    size-bytes: 1,

                    /// The value!
                    field val 7:0 -> uint
                }
            },

            command repeated[4 stride 1] {
                address: 4,
            },
            enum r {
                a: _,
                b: _,
            },
            command enum_repeated[r stride 2] {
                address: 8,
            }
        }
    "
);

#[test]
fn command_combinations() {
    let mut device = MyTestDevice::new(DeviceInterface {
        last_command: 0xFF,
        last_input: Vec::new(),
    });

    device.simple().dispatch().unwrap();
    assert_eq!(device.interface.last_command, 0);
    assert_eq!(device.interface.last_input, vec![]);

    device.input().dispatch_in(|reg| reg.set_val(123)).unwrap();
    assert_eq!(device.interface.last_command, 1);
    assert_eq!(device.interface.last_input, vec![0x7B, 0x00]);

    let out = device.output().dispatch_out().unwrap();
    assert_eq!(device.interface.last_command, 2);
    assert_eq!(device.interface.last_input, vec![]);
    assert_eq!(out.val(), 0);

    let out = device
        .in_out()
        .dispatch_inout(|reg| reg.set_val(123))
        .unwrap();
    assert_eq!(device.interface.last_command, 3);
    assert_eq!(device.interface.last_input, vec![0x7B, 0x00]);
    assert_eq!(out.val(), 0x7B);

    device.repeated().dispatch_at(3).unwrap();
    assert_eq!(device.interface.last_command, 7);
    assert_eq!(device.interface.last_input, vec![]);

    device.enum_repeated().dispatch_at(R::A).unwrap();
    assert_eq!(device.interface.last_command, 8);
    assert_eq!(device.interface.last_input, vec![]);
}