rdif-serial 0.9.3

Driver Interface base 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
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

//! Portable UART capability boundary.
//!
//! This crate contains no software queues, task policy, IRQ registration, or
//! OS wakeups. Concrete drivers split into one task-owned data/control endpoint
//! and one IRQ-owned event endpoint; the consuming runtime owns all buffering
//! and scheduling policy.

#![no_std]

mod raw;
mod types;

pub use self::{raw::*, types::*};

#[derive(thiserror::Error, Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConfigError {
    #[error("invalid baud rate")]
    InvalidBaudrate,
    #[error("unsupported data bits")]
    UnsupportedDataBits,
    #[error("unsupported stop bits")]
    UnsupportedStopBits,
    #[error("unsupported parity")]
    UnsupportedParity,
    #[error("UART register access failed")]
    RegisterError,
    #[error("UART operation timed out")]
    Timeout,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum DataBits {
    Five  = 5,
    Six   = 6,
    Seven = 7,
    Eight = 8,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum StopBits {
    One = 1,
    Two = 2,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Parity {
    None,
    Even,
    Odd,
    Mark,
    Space,
}

#[derive(Debug, Clone, Default)]
pub struct Config {
    pub baudrate: Option<u32>,
    pub data_bits: Option<DataBits>,
    pub stop_bits: Option<StopBits>,
    pub parity: Option<Parity>,
}

impl Config {
    pub const fn new() -> Self {
        Self {
            baudrate: None,
            data_bits: None,
            stop_bits: None,
            parity: None,
        }
    }

    pub const fn baudrate(mut self, baudrate: u32) -> Self {
        self.baudrate = Some(baudrate);
        self
    }

    pub const fn data_bits(mut self, data_bits: DataBits) -> Self {
        self.data_bits = Some(data_bits);
        self
    }

    pub const fn stop_bits(mut self, stop_bits: StopBits) -> Self {
        self.stop_bits = Some(stop_bits);
        self
    }

    pub const fn parity(mut self, parity: Parity) -> Self {
        self.parity = Some(parity);
        self
    }
}

#[cfg(all(axtest, feature = "axtest"))]
pub mod axtest;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn serial_event_reports_readiness_and_errors() {
        let event = SerialEventSet::RX_DATA | SerialEventSet::FAULT;

        assert!(event.has_rx());
        assert!(!event.has_tx());
        assert!(event.contains(SerialEventSet::FAULT));
    }
}