rdrive 0.23.5

A dyn driver manager.
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use core::ptr::NonNull;
use std::vec::Vec;

use fdt_edit::{Fdt, Node, NodeType, Property};
use rdif_pinctrl::{
    DriverGeneric, FdtPinctrlParser, Interface as PinctrlInterface, PinState, PinctrlDevice,
    PinctrlError,
};
use rdrive::{
    Platform, PlatformDevice,
    probe::{OnProbeError, fdt::ProbeFdt},
    probe_all,
    register::{DriverRegister, ProbeKind, ProbeLevel, ProbePriority},
};

struct TestPinctrl;

impl DriverGeneric for TestPinctrl {
    fn name(&self) -> &str {
        "test-pinctrl"
    }
}

impl PinctrlInterface for TestPinctrl {}

struct TestParser;

impl FdtPinctrlParser for TestParser {
    fn parse_pinctrl_node(
        &self,
        _fdt: &Fdt,
        _node: NodeType<'_>,
        _state: &mut PinState,
    ) -> Result<(), PinctrlError> {
        Err(PinctrlError::InvalidConfig)
    }
}

struct ShouldNotProbe;

impl DriverGeneric for ShouldNotProbe {
    fn name(&self) -> &str {
        "should-not-probe"
    }
}

fn register_test_pinctrl(probe: ProbeFdt<'_>) -> Result<(), OnProbeError> {
    probe
        .into_platform_device()
        .register(PinctrlDevice::with_fdt_parser(TestPinctrl, TestParser));
    Ok(())
}

fn probe_consumer(probe: ProbeFdt<'_>) -> Result<(), OnProbeError> {
    let dev: PlatformDevice = probe.into_platform_device();
    dev.register(ShouldNotProbe);
    Ok(())
}

static PINCTRL_REGISTER: DriverRegister = DriverRegister {
    name: "test pinctrl provider",
    level: ProbeLevel::PostKernel,
    priority: ProbePriority::CLK,
    probe_kinds: &[ProbeKind::Fdt {
        compatibles: &["test,pinctrl"],
        on_probe: register_test_pinctrl,
    }],
};

static CONSUMER_REGISTER: DriverRegister = DriverRegister {
    name: "bad pinctrl consumer",
    level: ProbeLevel::PostKernel,
    priority: ProbePriority::DEFAULT,
    probe_kinds: &[ProbeKind::Fdt {
        compatibles: &["test,consumer"],
        on_probe: probe_consumer,
    }],
};

#[test]
fn fdt_probe_reports_bad_default_pinctrl_before_consumer_probe() {
    let mut fdt = Fdt::new();
    let root = fdt.root_id();
    fdt.add_node(
        root,
        node_with_props(
            "pinctrl",
            &[
                prop_strs("compatible", &["test,pinctrl"]),
                prop_u32s("phandle", &[1]),
            ],
        ),
    );
    fdt.add_node(
        root,
        node_with_props(
            "consumer",
            &[
                prop_strs("compatible", &["test,consumer"]),
                prop_strs("pinctrl-names", &["default"]),
                prop_u32s("pinctrl-0", &[99]),
            ],
        ),
    );

    let encoded = fdt.encode();
    let dtb = Box::leak(encoded.as_ref().to_vec().into_boxed_slice());
    rdrive::init(Platform::Fdt {
        addr: NonNull::new(dtb.as_mut_ptr()).unwrap(),
    })
    .expect("FDT platform should initialize");
    rdrive::register_add(PINCTRL_REGISTER.clone());
    rdrive::register_add(CONSUMER_REGISTER.clone());

    let err = probe_all(true).expect_err("bad pinctrl phandle should abort consumer probe");

    assert!(format!("{err}").contains("failed to apply default pinctrl"));
    assert!(rdrive::get_one::<ShouldNotProbe>().is_none());
}

fn node_with_props(name: &str, props: &[Property]) -> Node {
    let mut node = Node::new(name);
    for prop in props {
        node.set_property(prop.clone());
    }
    node
}

fn prop_u32s(name: &str, values: &[u32]) -> Property {
    let mut data = Vec::new();
    for value in values {
        data.extend_from_slice(&value.to_be_bytes());
    }
    Property::new(name, data)
}

fn prop_strs(name: &str, values: &[&str]) -> Property {
    let mut data = Vec::new();
    for value in values {
        data.extend_from_slice(value.as_bytes());
        data.push(0);
    }
    Property::new(name, data)
}