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
//! A crate providing the [`qemu_print`] and [`qemu_println`] macros to print strings to the
//! console using QEMU's serial port support.
//!
//! # Usage
//!
//! Add `-serial stdio` to the QEMU's commandline parameters.
//!
//! ```text
//! qemu-system-x86_64 -serial stdio /* other parameters... */
//! ```
//!
//! Invoke macros like as [`print!`] and [`println!`].
//!
//! [`print!`]: https://doc.rust-lang.org/std/macro.print.html
//! [`println!`]: https://doc.rust-lang.org/std/macro.println.html
//!
//! ```rust,no_run
//! use qemu_print::qemu_println;
//!
//! qemu_println!("This string will be printed to the console.");
//!
//! let x = 3;
//! qemu_println!("x = {}", x);
//! ```

#![no_std]

use conquer_once::spin::Lazy;
use core::fmt;
use core::fmt::Write;
use spinning_top::Spinlock;
use uart_16550::SerialPort;

#[cfg(not(any(feature = "stable", feature = "nightly")))]
compile_error!("Specify either `stable` or `nightly` feature.");

#[cfg(all(feature = "stable", feature = "nightly"))]
compile_error!("`stable` and `nightly` features cannot be enabled at the same time.");

static PORT: Lazy<Spinlock<SerialPort>> = Lazy::new(|| {
    let mut port = unsafe { SerialPort::new(0x3f8) };

    port.init();

    Spinlock::new(port)
});

/// Print a string to the console.
///
/// # Examples
///
/// ```rust,no_run
/// use qemu_print::qemu_print;
///
/// qemu_print!("hello world.");
/// ```
#[macro_export]
macro_rules! qemu_print{
    ($($arg:tt)*)=>{
        $crate::_print(format_args!($($arg)*));
    }
}

/// Print a string with newline to the console.
///
/// ```rust,no_run
/// use qemu_print::qemu_println;
///
/// qemu_println!("hello world.");
/// ```
#[macro_export]
macro_rules! qemu_println {
    () => {
        $crate::qemu_print!("\n");
    };
    ($($arg:tt)*) => {
        $crate::qemu_print!("{}\n", format_args!($($arg)*));
    };
}

#[doc(hidden)]
pub fn _print(args: fmt::Arguments<'_>) {
    let _ = PORT.lock().write_fmt(args);
}