gpiocdev 0.8.0

Access GPIO lines on Linux using the GPIO character device
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

// ALL IT as can't construct a Chip without opening a GPIO file.
//
// Assumptions:
//  - kernel supports uAPI versions corresponding to selected build features

use gpiocdev::chip::path_compare;
use gpiosim::Bank;
use std::cmp::Ordering;

#[test]
fn find_named_line() {
    let sim = gpiosim::builder()
        .with_bank(
            Bank::new(8, "find_line 1")
                .name(3, "fl banana")
                .name(6, "fl apple"),
        )
        .with_bank(
            Bank::new(42, "find_line 2")
                .name(3, "fl piñata")
                .name(4, "fl piggly")
                .name(5, "fl apple"),
        )
        .live()
        .unwrap();

    let l = gpiocdev::find_named_line("fl banana").unwrap();
    assert_eq!(l.chip, *sim.chips()[0].dev_path());
    assert_eq!(l.info.offset, 3);

    let l = gpiocdev::find_named_line("fl piggly").unwrap();
    assert_eq!(&l.chip, sim.chips()[1].dev_path());
    assert_eq!(l.info.offset, 4);

    let l = gpiocdev::find_named_line("fl apple").unwrap();
    // depending on how other tests are running, the order of the sim chips is not 100% predictable.
    if path_compare(sim.chips()[0].dev_path(), sim.chips()[1].dev_path()) == Ordering::Less {
        assert_eq!(&l.chip, sim.chips()[0].dev_path());
        assert_eq!(l.info.offset, 6);
    } else {
        assert_eq!(&l.chip, sim.chips()[1].dev_path());
        assert_eq!(l.info.offset, 5);
    }

    assert!(gpiocdev::find_named_line("fl nada").is_none())
}

#[test]
fn find_named_lines() {
    let sim = gpiosim::builder()
        .with_bank(
            Bank::new(8, "find_lines 1")
                .name(3, "fls banana")
                .name(6, "fls apple"),
        )
        .with_bank(
            Bank::new(42, "find_lines 2")
                .name(3, "fls piñata")
                .name(4, "fls piggly")
                .name(5, "fls apple"),
        )
        .live()
        .unwrap();

    let found = gpiocdev::find_named_lines(&["fls banana"], true).unwrap();
    assert_eq!(found.len(), 1);
    let l = found.get(&"fls banana").unwrap();
    assert_eq!(&l.chip, sim.chips()[0].dev_path());
    assert_eq!(l.info.offset, 3);

    let found = gpiocdev::find_named_lines(&["fls piggly"], true).unwrap();
    assert_eq!(found.len(), 1);
    let l = found.get(&"fls piggly").unwrap();
    assert_eq!(&l.chip, sim.chips()[1].dev_path());
    assert_eq!(l.info.offset, 4);

    let found = gpiocdev::find_named_lines(&["fls apple"], false).unwrap();
    assert_eq!(found.len(), 1);
    let l = found.get(&"fls apple").unwrap();
    if path_compare(sim.chips()[0].dev_path(), sim.chips()[1].dev_path()) == Ordering::Less {
        assert_eq!(&l.chip, sim.chips()[0].dev_path());
        assert_eq!(l.info.offset, 6);
    } else {
        assert_eq!(&l.chip, sim.chips()[1].dev_path());
        assert_eq!(l.info.offset, 5);
    }

    let found = gpiocdev::find_named_lines(&["fls apple"], true);
    assert_eq!(
        found,
        Err(gpiocdev::Error::NonuniqueLineName("fls apple".to_string()))
    );

    let found = gpiocdev::find_named_lines(&["fls banana", "fls piggly"], true).unwrap();
    assert_eq!(found.len(), 2);

    let found = gpiocdev::find_named_lines(&["fls nada"], true).unwrap();
    assert_eq!(found.len(), 0);

    let found =
        gpiocdev::find_named_lines(&["fls apple", "fls banana", "fls nada"], false).unwrap();
    let l = found.get(&"fls banana").unwrap();
    assert_eq!(&l.chip, sim.chips()[0].dev_path());
    assert_eq!(l.info.offset, 3);
    let l = found.get(&"fls apple").unwrap();
    if path_compare(sim.chips()[0].dev_path(), sim.chips()[1].dev_path()) == Ordering::Less {
        assert_eq!(&l.chip, sim.chips()[0].dev_path());
        assert_eq!(l.info.offset, 6);
    } else {
        assert_eq!(&l.chip, sim.chips()[1].dev_path());
        assert_eq!(l.info.offset, 5);
    }
    assert!(!found.contains_key(&"fls nada"));
}

#[test]
fn detect_abi_version() {
    // assumes a kernel with both v1 and v2 supported.

    // can't test NoChips case, as cannot guarantee no chips
    // (even if we check there may be other tests creating them concurrently)

    // to ensure there is at least one chip
    let s = gpiosim::Simpleton::new(4);

    #[cfg(feature = "uapi_v2")]
    assert_eq!(gpiocdev::detect_abi_version(), Ok(gpiocdev::AbiVersion::V2));
    #[cfg(not(feature = "uapi_v2"))]
    assert_eq!(gpiocdev::detect_abi_version(), Ok(gpiocdev::AbiVersion::V1));

    drop(s);
}

#[test]
fn supports_abi_version() {
    // assumes a kernel with both v1 and v2 supported.

    // to ensure there is at least one chip
    let s = gpiosim::Simpleton::new(4);

    #[cfg(feature = "uapi_v1")]
    assert_eq!(
        gpiocdev::supports_abi_version(gpiocdev::AbiVersion::V1),
        Ok(())
    );
    #[cfg(not(feature = "uapi_v1"))]
    assert_eq!(
        gpiocdev::supports_abi_version(gpiocdev::AbiVersion::V1),
        Err(gpiocdev::Error::UnsupportedAbi(
            gpiocdev::AbiVersion::V1,
            gpiocdev::AbiSupportKind::Build
        ))
    );
    #[cfg(feature = "uapi_v2")]
    assert_eq!(
        gpiocdev::supports_abi_version(gpiocdev::AbiVersion::V2),
        Ok(())
    );
    #[cfg(not(feature = "uapi_v2"))]
    assert_eq!(
        gpiocdev::supports_abi_version(gpiocdev::AbiVersion::V2),
        Err(gpiocdev::Error::UnsupportedAbi(
            gpiocdev::AbiVersion::V2,
            gpiocdev::AbiSupportKind::Build
        ))
    );

    drop(s);
}