//! Wrting an [OS] in Rust: [VGA] Text Mode //! //! [os]: https://os.phil-opp.com/vga-text-mode/ //! [vga]: https://os.phil-opp.com/vga-text-mode/ #![no_std] #![no_main] use core::panic::PanicInfo; #[no_mangle] pub extern "C" fn _start() -> ! { for i in 1..BUFFER_HEIGHT { println!("Hello World #{}!", i); } panic!("Some panic message"); } // This function is called on panic. #[panic_handler] fn panic(info: &PanicInfo) -> ! { println!("{}", info); loop {} } extern crate lazy_static; extern crate spin; extern crate volatile; use core::fmt::{self, Write}; use lazy_static::lazy_static; use spin::Mutex; use volatile::Volatile; #[macro_export] macro_rules! println { () => ($crate::print!("\n")); ($($arg:tt)*) => ($crate::print!("{}\n", format_args!($($arg)*))); } #[macro_export] macro_rules! print { ($($arg:tt)*) => ($crate::_print(format_args!($($arg)*))); } #[doc(hidden)] pub fn _print(args: fmt::Arguments) { WRITER.lock().write_fmt(args).unwrap(); } lazy_static! { pub static ref WRITER: Mutex = Mutex::new(Writer { column_position: 0, color_code: ColorCode::new(Color::Yellow, Color::Black), buffer: unsafe { &mut *(0xb8000 as *mut Buffer) }, }); } pub struct Writer { column_position: usize, color_code: ColorCode, buffer: &'static mut Buffer, } #[allow(dead_code)] #[derive(Debug, Clone, Copy, PartialEq, Eq)] #[repr(u8)] pub enum Color { Black = 0, Blue = 1, Green = 2, Cyan = 4, Magenta = 5, Brown = 6, LightGray = 7, DarkGray = 8, LightBlue = 9, LightGreen = 10, LightSyan = 11, LightRed = 12, Pink = 13, Yellow = 14, White = 15, } #[derive(Debug, Clone, Copy, PartialEq, Eq)] #[repr(transparent)] struct ColorCode(u8); impl ColorCode { fn new(foreground: Color, background: Color) -> Self { Self((background as u8) << 4 | (foreground as u8)) } } #[derive(Debug, Clone, Copy, PartialEq, Eq)] #[repr(C)] struct ScreenChar { ascii_character: u8, color_code: ColorCode, } const BUFFER_HEIGHT: usize = 25; const BUFFER_WIDTH: usize = 80; #[repr(transparent)] struct Buffer { chars: [[Volatile; BUFFER_WIDTH]; BUFFER_HEIGHT], } impl fmt::Write for Writer { fn write_str(&mut self, s: &str) -> fmt::Result { self.write_string(s); Ok(()) } } impl Writer { pub fn write_string(&mut self, s: &str) { for byte in s.bytes() { match byte { // printable ASCII byte or newline 0x20..=0x7e | b'\n' => self.write_byte(byte), // not part of printable ASCII range _ => self.write_byte(0xfe), } } } pub fn write_byte(&mut self, byte: u8) { match byte { b'\n' => self.new_line(), byte => { if self.column_position >= BUFFER_WIDTH { self.new_line(); } let row = BUFFER_HEIGHT - 1; // bottom row let col = self.column_position; let color_code = self.color_code; self.buffer.chars[row][col].write(ScreenChar { ascii_character: byte, color_code, }); self.column_position += 1; } } } fn new_line(&mut self) { for row in 1..BUFFER_HEIGHT { for col in 0..BUFFER_WIDTH { let character = self.buffer.chars[row][col].read(); self.buffer.chars[row - 1][col].write(character); } } self.clear_row(BUFFER_HEIGHT - 1); self.column_position = 0; } fn clear_row(&mut self, row: usize) { let blank = ScreenChar { ascii_character: b' ', color_code: self.color_code, }; for col in 0..BUFFER_WIDTH { self.buffer.chars[row][col].write(blank); } } } #[allow(dead_code)] fn sample_write() { let mut writer = Writer { column_position: 0, color_code: ColorCode::new(Color::Black, Color::White), buffer: unsafe { &mut *(0xb8000 as *mut Buffer) }, }; writer.write_byte(b'H'); writer.color_code = ColorCode::new(Color::Yellow, Color::Blue); writer.write_string("ello! "); writer.color_code = ColorCode::new(Color::White, Color::LightRed); for i in 0..20 { #[allow(clippy::write_with_newline)] write!(writer, "The numbers are {} and {}\n", 42 + i, 1.0 / 3.0).unwrap(); } }