rdif-pinctrl 0.1.2

Driver Interface pin control definition.
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

use crate::{GpioBankId, GpioLineId, OwnerId, PinctrlError};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Direction {
    Input,
    Output { initial: bool },
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct GpioRange {
    pub bank: GpioBankId,
    pub pin_base: u32,
    pub line_base: u32,
    pub count: u32,
}

impl GpioRange {
    pub const fn new(bank: GpioBankId, pin_base: u32, line_base: u32, count: u32) -> Self {
        Self {
            bank,
            pin_base,
            line_base,
            count,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct GpioLineHandle {
    line: GpioLineId,
    owner: OwnerId,
}

impl GpioLineHandle {
    pub const fn new(line: GpioLineId, owner: OwnerId) -> Self {
        Self { line, owner }
    }

    pub const fn line(&self) -> GpioLineId {
        self.line
    }

    pub const fn owner(&self) -> OwnerId {
        self.owner
    }
}

pub trait GpioBank: Send + 'static {
    fn bank_id(&self) -> GpioBankId;

    fn line_count(&self) -> u32;

    fn request_line(
        &mut self,
        line: GpioLineId,
        owner: &str,
    ) -> Result<GpioLineHandle, PinctrlError>;

    fn release_line(&mut self, handle: GpioLineHandle) -> Result<(), PinctrlError>;

    fn set_direction(
        &mut self,
        handle: &GpioLineHandle,
        direction: Direction,
    ) -> Result<(), PinctrlError>;

    fn read(&self, handle: &GpioLineHandle) -> Result<bool, PinctrlError>;

    fn write(&mut self, handle: &GpioLineHandle, value: bool) -> Result<(), PinctrlError>;
}