mu_lib 0.2.2

XCENA mu Library
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

//! Print module providing output functionality
//!
//! This module provides macros and functions for UART, host, and general output.
//! All output functions use null-terminated strings.

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]

pub use crate::bindings::root::{
    hostPrintfSingleStringRB, printf_SingleStringRB, uartPrintfSingleStringRB,
};

/// Macro for printing a single string to UART
///
/// # Examples
/// ```
/// uart_print!("Hello, World! Value: {}\n", 42);
/// ```
#[macro_export]
macro_rules! uart_print {
    ($($arg:tt)*) => {{
        let mut output = alloc::format!($($arg)*);
        output.push('\0');
        unsafe { $crate::print::uartPrintfSingleStringRB(output.as_ptr() as *const u8) }
    }};
}

/// Macro for printing a single string to UART followed by a newline
///
/// # Examples
/// ```
/// uart_println!("Hello, World! Count: {}", 5);
/// ```
#[macro_export]
macro_rules! uart_println {
    ($($arg:tt)*) => {{
        let mut output = alloc::format!($($arg)*);
        output.push_str("\n\0");
        unsafe { $crate::print::uartPrintfSingleStringRB(output.as_ptr() as *const u8) }
    }};
}

/// Macro for printing a single string to the host
///
/// # Examples
/// ```
/// host_print!("Hello, Host! Status: {}\n", "OK");
/// ```
#[macro_export]
macro_rules! host_print {
    ($($arg:tt)*) => {{
        let mut output = alloc::format!($($arg)*);
        output.push('\0');
        unsafe { $crate::print::hostPrintfSingleStringRB(output.as_ptr() as *const u8) }
    }};
}

/// Macro for printing a single string to the host followed by a newline
///
/// # Examples
/// ```
/// host_println!("Hello, Host! Error code: {}", 404);
/// ```
#[macro_export]
macro_rules! host_println {
    ($($arg:tt)*) => {{
        let mut output = alloc::format!($($arg)*);
        output.push_str("\n\0");
        unsafe { $crate::print::hostPrintfSingleStringRB(output.as_ptr() as *const u8) }
    }};
}

#[doc(hidden)]
#[macro_export]
macro_rules! printf{
    ($($arg:tt)*) => {{
        let mut output = alloc::format!($($arg)*);
        output.push('\0');
        unsafe { $crate::print::sprintf_SingleStringRB(output.as_ptr() as *const u8) }
    }};
}