espforge-hardware 0.6.0

a scaffolding++ tool for creating esp32 no_std esphal without the hassle
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

//! `<gpio>` peripheral table.
//!
//! `<led>` / `<button>` lowering lives in [`crate::board`], which finds the
//! pin it needs by the `<gpio>` id in this table.
//!
//! Attributes come from `espf.schema.kdl` through the generated `Attrs`; this
//! module keeps the table shape and the wording of the errors.

use espf::context::ParsedNode;
use espf::diag::EspfError;
use espforge_bindings::components::attrs::Issue;
use espforge_bindings::components::generated_elements::gpio as schema;

/// One `<gpio>` peripheral: id -> pin + optional direction.
#[derive(Debug, Clone)]
pub struct GpioEntry {
    pub id: String,
    pub pin: u8,
    pub direction: Option<String>,
}

/// The `<gpio>` branch of the `# peripherals` loop.
pub fn lower_gpio(n: &ParsedNode) -> Result<GpioEntry, EspfError> {
    let attrs = schema::Attrs::from_node(n).map_err(|issue| {
        let (title, message) = describe(n.id, issue);
        EspfError::at_node(n, title, message)
    })?;
    Ok(GpioEntry {
        id: n.id.to_string(),
        pin: attrs.pin.value,
        // `direction` is compared as text by `<led>`/`<button>` (an output pin
        // for one, an input pin for the other), so keep the spelling.
        direction: attrs
            .direction
            .map(|direction| direction.value.as_str().to_string()),
    })
}

/// This element's wording for a schema-level problem: a bad pin reads as a
/// pin problem, a bad `direction` as a direction problem.
fn describe(id: &str, issue: Issue<'_>) -> (&'static str, String) {
    match issue {
        Issue::Invalid {
            attr: "direction",
            value,
        } => (
            "invalid gpio direction",
            format!("<gpio id=\"{id}\"> direction=\"{value}\" must be \"output\" or \"input\""),
        ),
        Issue::Missing { attr } | Issue::Invalid { attr, .. } => (
            "invalid gpio pin",
            format!("<gpio id=\"{id}\"> needs a numeric {attr}=\"...\""),
        ),
    }
}