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

//! Semihosting module
//!
//! Semihosting can direct to either stdout or stderr,
//! which is determined by second type parameter
//!
//! ## Example
//!
//! ```rust,no_run
//! use cortex_m_log::printer::Printer;
//! use cortex_m_log::printer::semihosting;
//! use cortex_m_log::printer::semihosting::Semihosting;
//! use cortex_m_log::modes::InterruptFree;
//!
//! //Create new printer to stdout with interrupt free mode
//! let mut shost = Semihosting::<InterruptFree, _>::stdout().unwrap();
//!
//! shost.println(format_args!("Write interrupt free to {}", "stdout"));
//!
//! //Create new printer to stderr without need for interrupt control using special alias
//! let mut shost = semihosting::InterruptOk::<_>::stderr().unwrap();
//!
//! shost.println(format_args!("Write to {}", "stderr"));
//! ```

extern crate cortex_m_semihosting as sh;

pub use self::sh::hio;

use crate::destination::semihosting::SemihostingComp;
use crate::modes::InterruptModer;

use core::marker::PhantomData;

/// Semihosting backed printer
pub struct Semihosting<M: InterruptModer, T: SemihostingComp> {
    inner: T,
    _mod: PhantomData<M>
}

impl<M: InterruptModer, T: SemihostingComp> Semihosting<M, T> {
    #[inline(always)]
    ///Constructs new instance
    pub fn new(inner: T) -> Self {
        Self { inner, _mod: PhantomData }
    }
}

impl<M: InterruptModer> Semihosting<M, hio::HostStream> {
    #[inline(always)]
    ///Constructs new Semihosting Printer by using `hstdout`
    pub fn stdout() -> Result<Self, ()> {
        hio::hstdout().map(Self::new)
    }

    #[inline(always)]
    ///Constructs new Semihosting Printer by using `hstderr`
    pub fn stderr() -> Result<Self, ()> {
        hio::hstderr().map(Self::new)
    }
}

impl<Mode: InterruptModer, T: SemihostingComp> super::Printer for Semihosting<Mode, T> {
    type W = T;
    type M = Mode;

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

/// Alias for Interrupt free Printer
pub type InterruptFree<T> = Semihosting<crate::modes::InterruptFree, T>;
/// Alias for Printer without control over interrupts
pub type InterruptOk<T> = Semihosting<crate::modes::InterruptOk, T>;