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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
use crate::{utils::*, Error, Result, Time, MAX_BITS};
use std::{fmt, str};

/// Line offset
pub type LineId = u32;

/// Bit offset
pub type BitId = u8;

/// Line offset to bit offset mapping
#[derive(Debug, Clone)]
pub struct LineMap {
    map: Vec<BitId>,
}

impl LineMap {
    const NOT_LINE: BitId = MAX_BITS;

    /// Create line map
    pub fn new(lines: &[LineId]) -> Self {
        let mut map: Vec<BitId> = (0..=lines.iter().max().copied().unwrap_or(0))
            .map(|_| Self::NOT_LINE)
            .collect();
        for i in 0..lines.len() {
            map[lines[i] as usize] = i as _;
        }
        Self { map }
    }

    /// Get bit position by line offset
    pub fn get(&self, line: LineId) -> Result<BitId> {
        let line = line as usize;
        if line < self.map.len() {
            let val = self.map[line];
            if val != Self::NOT_LINE {
                return Ok(val as _);
            }
        }
        Err(invalid_data("Unknown line offset"))
    }
}

/// The information of a specific GPIO line
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct LineInfo {
    /// GPIO line direction
    pub direction: Direction,

    /// GPIO line active state
    pub active: Active,

    /// GPIO line edge detection
    pub edge: EdgeDetect,

    /// GPIO line usage status
    ///
    /// `true` means that kernel uses this line for some purposes.
    pub used: bool,

    /// GPIO line input bias
    pub bias: Bias,

    /// GPIO line output drive mode
    pub drive: Drive,

    /// GPIO line name
    pub name: String,

    /// GPIO line consumer name
    pub consumer: String,
}

impl fmt::Display for LineInfo {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.name.is_empty() {
            write!(f, "\t unnamed")?;
        } else {
            write!(f, "\t {:?}", self.name)?;
        }
        if self.consumer.is_empty() {
            write!(f, "\t unused")?;
        } else {
            write!(f, "\t {:?}", self.consumer)?;
        }
        write!(f, "\t {}", self.direction)?;
        write!(f, "\t active-{}", self.active)?;
        if !matches!(self.edge, EdgeDetect::Disable) {
            write!(f, "\t {}-edge", self.edge)?;
        }
        if !matches!(self.bias, Bias::Disable) {
            write!(f, "\t {}", self.edge)?;
        }
        if !matches!(self.drive, Drive::PushPull) {
            write!(f, "\t {}", self.drive)?;
        }
        if self.used {
            write!(f, "\t [used]")?;
        }
        Ok(())
    }
}

/// Direction of a GPIO line
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[repr(u8)]
pub enum Direction {
    /// Line acts as input (default)
    #[cfg_attr(feature = "clap", clap(aliases = ["i", "in"]))]
    Input,
    /// Line acts as output
    #[cfg_attr(feature = "clap", clap(aliases = ["o", "out"]))]
    Output,
}

impl Default for Direction {
    fn default() -> Self {
        Self::Input
    }
}

impl AsRef<str> for Direction {
    fn as_ref(&self) -> &str {
        match self {
            Self::Input => "input",
            Self::Output => "output",
        }
    }
}

impl fmt::Display for Direction {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.as_ref().fmt(f)
    }
}

impl str::FromStr for Direction {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        Ok(match s {
            "i" | "in" | "input" => Self::Input,
            "o" | "out" | "output" => Self::Output,
            _ => return Err(invalid_input("Not recognized direction")),
        })
    }
}

/// Active state condition of a line
///
/// If active state of line is **high** then physical and logical levels is same.
/// Otherwise if it is **low** then physical level will be inverted from logical.
///
/// Also this may be treated as polarity.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[repr(u8)]
pub enum Active {
    /// Active level is low
    #[cfg_attr(feature = "clap", clap(aliases = ["l", "lo"]))]
    Low,
    /// Active level is high (default)
    #[cfg_attr(feature = "clap", clap(aliases = ["h", "hi"]))]
    High,
}

impl Default for Active {
    fn default() -> Self {
        Self::High
    }
}

impl AsRef<str> for Active {
    fn as_ref(&self) -> &str {
        match self {
            Self::Low => "low",
            Self::High => "high",
        }
    }
}

impl fmt::Display for Active {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.as_ref().fmt(f)
    }
}

impl str::FromStr for Active {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        Ok(match s {
            "l" | "lo" | "low" | "active-low" => Self::Low,
            "h" | "hi" | "high" | "active-high" => Self::High,
            _ => return Err(invalid_input("Not recognized active state")),
        })
    }
}

/// Signal edge or level transition of a GPIO line
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[repr(u8)]
pub enum Edge {
    /// Rising edge detected
    #[cfg_attr(feature = "clap", clap(aliases = ["r", "rise"]))]
    Rising,
    /// Falling edge detected
    #[cfg_attr(feature = "clap", clap(aliases = ["f", "fall"]))]
    Falling,
}

impl AsRef<str> for Edge {
    fn as_ref(&self) -> &str {
        match self {
            Self::Rising => "rising",
            Self::Falling => "falling",
        }
    }
}

impl fmt::Display for Edge {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.as_ref().fmt(f)
    }
}

impl str::FromStr for Edge {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        Ok(match s {
            "r" | "rise" | "rising" => Self::Rising,
            "f" | "fall" | "falling" => Self::Falling,
            _ => return Err(invalid_input("Not recognized edge")),
        })
    }
}

/// Signal edge detection event
#[derive(Debug, Clone, Copy)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Event {
    /// GPIO line where edge detected
    pub line: BitId,
    /// Detected edge or level transition
    pub edge: Edge,
    /// Time when edge actually detected
    pub time: Time,
}

impl fmt::Display for Event {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        '#'.fmt(f)?;
        self.line.fmt(f)?;
        ' '.fmt(f)?;
        self.edge.fmt(f)?;
        ' '.fmt(f)?;
        self.time.as_nanos().fmt(f)
    }
}

/// Edge detection setting for GPIO line
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[repr(u8)]
pub enum EdgeDetect {
    /// Detection disabled (default)
    #[cfg_attr(feature = "clap", clap(aliases = ["d", "dis"]))]
    Disable,
    /// Detect rising edge only
    #[cfg_attr(feature = "clap", clap(aliases = ["r", "rise"]))]
    Rising,
    /// Detect falling edge only
    #[cfg_attr(feature = "clap", clap(aliases = ["f", "fall"]))]
    Falling,
    /// Detect both rising and falling edges
    #[cfg_attr(feature = "clap", clap(aliases = ["b"]))]
    Both,
}

impl Default for EdgeDetect {
    fn default() -> Self {
        Self::Disable
    }
}

impl AsRef<str> for EdgeDetect {
    fn as_ref(&self) -> &str {
        match self {
            Self::Disable => "disable",
            Self::Rising => "rising",
            Self::Falling => "falling",
            Self::Both => "both",
        }
    }
}

impl fmt::Display for EdgeDetect {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.as_ref().fmt(f)
    }
}

impl str::FromStr for EdgeDetect {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        Ok(match s {
            "d" | "dis" | "disable" => Self::Disable,
            "r" | "rise" | "rising" => Self::Rising,
            "f" | "fall" | "falling" => Self::Falling,
            "b" | "both" | "rise-fall" | "rising-falling" => Self::Both,
            _ => return Err(invalid_input("Not recognized edge-detect")),
        })
    }
}

/// Input bias of a GPIO line
///
/// Sometimes GPIO lines shall be pulled to up (power rail) or down (ground)
/// through resistor to avoid floating level on it.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[repr(u8)]
pub enum Bias {
    /// Disabled bias (default)
    #[cfg_attr(feature = "clap", clap(aliases = ["d", "dis"]))]
    Disable,
    /// Pull line up
    #[cfg_attr(feature = "clap", clap(aliases = ["pu"]))]
    PullUp,
    /// Pull line down
    #[cfg_attr(feature = "clap", clap(aliases = ["pd"]))]
    PullDown,
}

impl Default for Bias {
    fn default() -> Self {
        Self::Disable
    }
}

impl AsRef<str> for Bias {
    fn as_ref(&self) -> &str {
        match self {
            Self::Disable => "disable",
            Self::PullUp => "pull-up",
            Self::PullDown => "pull-down",
        }
    }
}

impl fmt::Display for Bias {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.as_ref().fmt(f)
    }
}

impl str::FromStr for Bias {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        Ok(match s {
            "d" | "dis" | "disable" => Self::Disable,
            "pu" | "pull-up" => Self::PullUp,
            "pd" | "pull-down" => Self::PullUp,
            _ => return Err(invalid_input("Not recognized input bias")),
        })
    }
}

/// Output drive mode of a GPIO line
///
/// Usually GPIO lines configured as push-pull but sometimes it required to drive via open drain or source.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[repr(u8)]
pub enum Drive {
    /// Drive push-pull (default)
    #[cfg_attr(feature = "clap", clap(aliases = ["pp"]))]
    PushPull,
    /// Drive with open-drain
    #[cfg_attr(feature = "clap", clap(aliases = ["od"]))]
    OpenDrain,
    /// Drive with open-source
    #[cfg_attr(feature = "clap", clap(aliases = ["os"]))]
    OpenSource,
}

impl Default for Drive {
    fn default() -> Self {
        Self::PushPull
    }
}

impl AsRef<str> for Drive {
    fn as_ref(&self) -> &str {
        match self {
            Self::PushPull => "push-pull",
            Self::OpenDrain => "open-drain",
            Self::OpenSource => "open-source",
        }
    }
}

impl fmt::Display for Drive {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.as_ref().fmt(f)
    }
}

impl str::FromStr for Drive {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        Ok(match s {
            "pp" | "push-pull" => Self::PushPull,
            "od" | "open-drain" => Self::OpenDrain,
            "os" | "open-source" => Self::OpenSource,
            _ => return Err(invalid_input("Not recognized output drive")),
        })
    }
}