atsamd-hal 0.23.3

HAL and Peripheral access API for ATSAMD11, ATSAMD21, ATSAMD51, ATSAME51, ATSAME53 and ATSAME54 microcontrollers
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

//! Character size definitions

use super::DataReg;
use crate::typelevel::Sealed;
use num_traits::{AsPrimitive, PrimInt};

/// Type-level `enum` representing the UART character size
///
/// The UART character size affects the word size for the embedded HAL traits.
/// Eight or less bit transactions use a `u8` word, while nine-bit transactions
/// use a `u16` word.
pub trait CharSize: Sealed {
    /// Word size for the character size
    type Word: 'static + PrimInt + AsPrimitive<DataReg> + Copy;
}

/// Type-level `enum` indicating a [`CharSize`] that is not dynamic
pub trait FixedCharSize: CharSize {
    /// Bits to write into the `LENGTH` register
    const SIZE: CharSizeEnum;
}

/// Type alias to recover the `Word` type from an implementation of [`CharSize`]
pub type Word<C> = <C as CharSize>::Word;

/// [`CharSize`] variant for 5-bit transactions
pub enum FiveBit {}

/// [`CharSize`] variant for 6-bit transactions
pub enum SixBit {}

/// [`CharSize`] variant for 7-bit transactions
pub enum SevenBit {}

/// [`CharSize`] variant for 8-bit transactions
pub enum EightBit {}

/// [`CharSize`] variant for 9-bit transactions
pub enum NineBit {}

/// Dynamic [`CharSize`] that can be changed on the fly
pub enum DynCharSize {}

/// `enum` version of [`CharSize`]
#[repr(u8)]
pub enum CharSizeEnum {
    FiveBit = 0x5,
    SixBit = 0x6,
    SevenBit = 0x7,
    EightBit = 0x0,
    NineBit = 0x1,
}

impl Sealed for FiveBit {}
impl CharSize for FiveBit {
    type Word = u8;
}
impl FixedCharSize for FiveBit {
    const SIZE: CharSizeEnum = CharSizeEnum::FiveBit;
}

impl Sealed for SixBit {}
impl CharSize for SixBit {
    type Word = u8;
}
impl FixedCharSize for SixBit {
    const SIZE: CharSizeEnum = CharSizeEnum::SixBit;
}

impl Sealed for SevenBit {}
impl CharSize for SevenBit {
    type Word = u8;
}
impl FixedCharSize for SevenBit {
    const SIZE: CharSizeEnum = CharSizeEnum::SevenBit;
}

impl Sealed for EightBit {}
impl CharSize for EightBit {
    type Word = u8;
}
impl FixedCharSize for EightBit {
    const SIZE: CharSizeEnum = CharSizeEnum::EightBit;
}

impl Sealed for NineBit {}
impl CharSize for NineBit {
    type Word = u16;
}
impl FixedCharSize for NineBit {
    const SIZE: CharSizeEnum = CharSizeEnum::NineBit;
}

impl Sealed for DynCharSize {}
impl CharSize for DynCharSize {
    type Word = u16;
}