tm4c-hal 0.4.2

Common bits of HAL for the TM4C123x/TM4C129x family of 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

//! Serial code that is generic to both the TM4C123 and TM4C129, such as the pin traits.

// The macro is required for the "sealed trait" pattern to work:
// the traits and the gpios have to be defined in the same crate

///! An internal macro to generate the UART traits
#[macro_export]
macro_rules! uart_traits_macro {
    () => {
        /// TX pin
        pub trait TxPin<UART>: crate::Sealed {}

        /// RX pin
        pub trait RxPin<UART>: crate::Sealed {}

        /// CTS pin
        pub trait CtsPin<UART>: crate::Sealed {
            /// Enables the CTS functionality if a valid pin is given (not `()`).
            fn enable(&mut self, _uart: &mut UART);
        }

        /// DCD pin
        pub trait DcdPin<UART>: crate::Sealed {
            /// Enables the DCD functionality if a valid pin is given (not `()`).
            fn enable(&mut self, _uart: &mut UART);
        }

        /// DSR pin
        pub trait DsrPin<UART>: crate::Sealed {
            /// Enables the DSR functionality if a valid pin is given (not `()`).
            fn enable(&mut self, _uart: &mut UART);
        }

        /// DTR pin
        pub trait DtrPin<UART>: crate::Sealed {
            /// Enables the DTR functionality if a valid pin is given (not `()`).
            fn enable(&mut self, _uart: &mut UART);
        }

        /// RI pin
        pub trait RiPin<UART>: crate::Sealed {
            /// Enables the RI functionality if a valid pin is given (not `()`).
            fn enable(&mut self, _uart: &mut UART);
        }

        /// RTS pin
        pub trait RtsPin<UART>: crate::Sealed {
            /// Enables the RTS functionality if a valid pin is given (not `()`).
            fn enable(&mut self, _uart: &mut UART);
        }

        impl<U> TxPin<U> for () {}

        impl<U> RxPin<U> for () {}

        impl<U> CtsPin<U> for () {
            fn enable(&mut self, _uart: &mut U) {
                // Do nothing
            }
        }
        impl<U> DcdPin<U> for () {
            fn enable(&mut self, _uart: &mut U) {
                // Do nothing
            }
        }
        impl<U> DsrPin<U> for () {
            fn enable(&mut self, _uart: &mut U) {
                // Do nothing
            }
        }
        impl<U> DtrPin<U> for () {
            fn enable(&mut self, _uart: &mut U) {
                // Do nothing
            }
        }
        impl<U> RiPin<U> for () {
            fn enable(&mut self, _uart: &mut U) {
                // Do nothing
            }
        }
        impl<U> RtsPin<U> for () {
            fn enable(&mut self, _uart: &mut U) {
                // Do nothing
            }
        }
    };
}

/// writeln!() emits LF chars, so this is useful
/// if you're writing text with your UART
#[derive(PartialEq, Clone, Copy)]
pub enum NewlineMode {
    /// Emit octets as received
    Binary,
    /// Emit an extra CR before every LF
    SwapLFtoCRLF,
}