cortex-m-log 0.8.0

Logging facilities for Cortex-M processors
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

//! Itm module

use cortex_m::interrupt::Mutex;

use crate::destination;
use crate::modes::InterruptModer;

use core::marker::PhantomData;
use core::fmt::{self, Write};

/// ITM backed printer
pub struct Itm<M: InterruptModer> {
    inner: destination::Itm,
    _mod: PhantomData<M>
}

impl<M: InterruptModer> Itm<M> {
    ///Constructs new instance
    pub fn new(itm: destination::Itm) -> Self {
        Self { inner: itm, _mod: PhantomData }
    }
}

impl<Mode: InterruptModer> super::Printer for Itm<Mode> {
    type W = destination::Itm;
    type M = Mode;

    #[inline]
    fn destination(&mut self) -> &mut Self::W {
        &mut self.inner
    }
}

/// ITM backed printer with `Sync`
pub struct ItmSync<M: InterruptModer> {
    inner: destination::Itm,
    lock: Mutex<()>,
    _mod: PhantomData<M>,
}

impl<M: InterruptModer> ItmSync<M> {
    ///Constructs new instance
    pub fn new(itm: destination::Itm) -> Self {
        Self { inner: itm, lock: Mutex::new(()), _mod: PhantomData }
    }
}

impl<Mode: InterruptModer> super::Printer for ItmSync<Mode> {
    type W = destination::Itm;
    type M = Mode;

    #[inline]
    fn destination(&mut self) -> &mut Self::W {
        &mut self.inner
    }

    #[inline]
    ///Prints formatted output to destination
    fn print(&mut self, args: fmt::Arguments) {
        cortex_m::interrupt::free(|cs| {
            let _lock = self.lock.borrow(cs);
            let _ = self.inner.write_fmt(args);
        });
    }

    #[inline]
    ///Prints formatted output to destination with newline
    fn println(&mut self, args: fmt::Arguments) {
        cortex_m::interrupt::free(|cs| {
            let _lock = self.lock.borrow(cs);
            let _ = self.inner.write_fmt(args);
            let _ = self.inner.write_str("\n");
        });
    }
}

unsafe impl<Mode: InterruptModer> Sync for ItmSync<Mode> {}

/// ITM backed printer with the assumption of `Sync`
/// This does *not* actually `Sync`'ronize access to the ITM
/// For proper `Sync`, use `ItmSync`.
pub struct ItmAssumeSync {
    inner: destination::Itm,
}

impl ItmAssumeSync {
    ///Constructs new instance.
    ///
    ///This is unsafe, because type is assumed to be `Sync` while it is not.
    pub unsafe fn new(itm: destination::Itm) -> Self {
        Self { inner: itm }
    }
}

impl super::Printer for ItmAssumeSync {
    type W = destination::Itm;
    type M = crate::modes::InterruptOk;

    #[inline]
    fn destination(&mut self) -> &mut Self::W {
        &mut self.inner
    }

    #[inline]
    ///Prints formatted output to destination
    fn print(&mut self, args: fmt::Arguments) {
        let _ = self.inner.write_fmt(args);
    }

    #[inline]
    ///Prints formatted output to destination with newline
    fn println(&mut self, args: fmt::Arguments) {
        let _ = self.inner.write_fmt(args);
        let _ = self.inner.write_str("\n");
    }
}

unsafe impl Sync for ItmAssumeSync {}

/// Alias for Interrupt free Printer
pub type InterruptFree = Itm<crate::modes::InterruptFree>;
/// Alias for Printer without control over interrupts
pub type InterruptOk = Itm<crate::modes::InterruptOk>;
/// Alias for Synced Itm.
pub type InterruptSync = ItmSync<crate::modes::InterruptFree>;