MaxOS::drivers::console::VESABootConsole Class Reference

Driver for the VESA Console during boot, handles the printing of characters and strings to the screen using VESA protocol. More...

#include <vesaboot.h>

Inheritance diagram for MaxOS::drivers::console::VESABootConsole:

Public Member Functions
	VESABootConsole (common::GraphicsContext *)
	Constructs a new VESA Boot Console object, initializing the console area for text output.
uint16_t	width () final
	Gets the width of the console.
uint16_t	height () final
	Gets the height of the console.
void	finish () const
	Cleans up the boot console.
void	put_character (uint16_t x, uint16_t y, char) final
	Places a character at the specified location.
void	set_foreground_color (uint16_t x, uint16_t y, common::ConsoleColour) final
	Sets the foreground color at the specified location.
void	set_background_color (uint16_t x, uint16_t y, common::ConsoleColour) final
	Sets the background color at the specified location.
void	scroll_up (uint16_t left, uint16_t top, uint16_t width, uint16_t height, common::ConsoleColour foreground, common::ConsoleColour background, char fill) final
	Scrolls the console up by 1 line.
char	get_character (uint16_t x, uint16_t y) final
	Gets the character at the specified location.
common::ConsoleColour	get_foreground_color (uint16_t x, uint16_t y) final
	Gets the foreground color at the specified location.
common::ConsoleColour	get_background_color (uint16_t x, uint16_t y) final
	Gets the background color at the specified location.
Public Member Functions inherited from MaxOS::drivers::Driver
virtual void	activate ()
	Activate the driver.
virtual void	deactivate ()
	Deactivate the driver.
virtual void	initialise ()
	Initialise the driver.
virtual uint32_t	reset ()
	Reset the driver.
virtual string	vendor_name ()
	Get who created the device.
virtual string	device_name ()
	Get the device name of the driver.
Public Member Functions inherited from MaxOS::drivers::console::Console
virtual void	put_character (uint16_t x, uint16_t y, char c, common::ConsoleColour foreground, common::ConsoleColour background)
	Put a character on the console with a given foreground and background color.
virtual void	put_string (uint16_t x, uint16_t y, string s, common::ConsoleColour foreground=common::ConsoleColour::LightGrey, common::ConsoleColour background=common::ConsoleColour::Black)
	Put a string on the console.
virtual void	scroll_up ()
	Scroll the entire console up by 1 line.
virtual void	clear ()
virtual void	clear (uint16_t left, uint16_t top, uint16_t width, uint16_t height, common::ConsoleColour foreground=common::ConsoleColour::LightGrey, common::ConsoleColour background=common::ConsoleColour::Black, char fill=' ')
	Clear an area of the console.
virtual void	invert_colors (uint16_t x, uint16_t y)
	Invert the colors of a character on the console.

Static Public Member Functions
static void	print_logo (bool is_panic=false)
	Prints the logo to the center of the screen.
static void	update_progress_bar (uint8_t percentage)
	Updates the progress bar.

Public Attributes
ConsoleStream *	cout
	The boot console output stream.

Detailed Description

Driver for the VESA Console during boot, handles the printing of characters and strings to the screen using VESA protocol.

Definition at line 30 of file vesaboot.h.

Constructor & Destructor Documentation

VESABootConsole()

VESABootConsole::VESABootConsole ( common::GraphicsContext *  graphics_context )

explicit

Constructs a new VESA Boot Console object, initializing the console area for text output.

Parameters

graphics_context

The graphics context to use for rendering

Definition at line 25 of file vesaboot.cpp.

        : m_font((uint8_t*) AMIGA_FONT) {
 
    // Set up
    Logger::INFO() << "Setting up VESA console\n";
    s_graphics_context = graphics_context;
    m_video_memory_meta = (uint16_t*) MemoryManager::kmalloc(width() * height() * sizeof(uint16_t));
 
    // Prepare the console
    VESABootConsole::clear();
    print_logo();
    m_console_area = new ConsoleArea(this, 0, 0, width() / 2 - 25, height(), ConsoleColour::DarkGrey, ConsoleColour::Black);
    cout = new ConsoleStream(m_console_area);
 
    // Only log to the screen when debugging
#ifndef NDEBUG
    Logger::active_logger()->add_log_writer(cout);
    Logger::INFO() << "Console Stream set up \n";
#endif
}

References MaxOS::Logger::active_logger(), MaxOS::drivers::console::Console::clear(), cout, height(), MaxOS::Logger::INFO(), MaxOS::memory::MemoryManager::kmalloc(), print_logo(), and width().

Member Function Documentation

finish()

void VESABootConsole::finish

(

)

const

Cleans up the boot console.

Definition at line 349 of file vesaboot.cpp.

                                   {
 
    // Done
    Logger::HEADER() << "MaxOS Kernel Successfully Booted\n" << ANSI_COLOURS[ANSIColour::Reset];
    cout->set_cursor(0, 0);
    Logger::active_logger()->disable_log_writer(cout);
}

References MaxOS::Logger::active_logger(), MaxOS::common::ANSI_COLOURS, cout, MaxOS::Logger::HEADER(), and MaxOS::drivers::console::ConsoleStream::set_cursor().

Referenced by kernel_main().

get_background_color()

ConsoleColour VESABootConsole::get_background_color ( uint16_t  x, uint16_t  y  )

finalvirtual

Gets the background color at the specified location.

Parameters

x	The x coordinate
y	The y coordinate

Returns

The background color at the specified location or black if the coordinates are out of bounds

Reimplemented from MaxOS::drivers::console::Console.

Definition at line 229 of file vesaboot.cpp.

                                                                          {
 
    if(CPU::panic_lock.is_locked())
        return ConsoleColour::Red;
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return ConsoleColour::Black;
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Return the background color at the offset, by masking the background color with the current background color (bits 12-15)
    return (ConsoleColour) ((m_video_memory_meta[offset] & 0xF000) >> 12);
}

References height(), MaxOS::system::CPU::panic_lock, and width().

Referenced by put_character(), and scroll_up().

get_character()

char VESABootConsole::get_character ( uint16_t  x, uint16_t  y  )

finalvirtual

Gets the character at the specified location.

Parameters

x	The x coordinate
y	The y coordinate

Returns

The character at the specified location or a space if the coordinates are out of bounds

Reimplemented from MaxOS::drivers::console::Console.

Definition at line 186 of file vesaboot.cpp.

                                                          {
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return ' ';
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Return the character at the offset, by masking the character with the current character (last 8 bits)
    return (char) (m_video_memory_meta[offset] & 0x00FF);
}

References height(), and width().

get_foreground_color()

ConsoleColour VESABootConsole::get_foreground_color ( uint16_t  x, uint16_t  y  )

finalvirtual

Gets the foreground color at the specified location.

Parameters

x	The x coordinate
y	The y coordinate

Returns

The foreground color at the specified location or white if the coordinates are out of bounds

Reimplemented from MaxOS::drivers::console::Console.

Definition at line 206 of file vesaboot.cpp.

                                                                          {
 
    if(CPU::panic_lock.is_locked())
        return ConsoleColour::White;
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return ConsoleColour::White;
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Return the foreground color at the offset, by masking the foreground color with the current foreground color (bits 8-11)
    return (ConsoleColour) ((m_video_memory_meta[offset] & 0x0F00) >> 8);
}

References height(), MaxOS::system::CPU::panic_lock, and width().

Referenced by put_character(), and scroll_up().

height()

uint16_t VESABootConsole::height ( )

finalvirtual

Gets the height of the console.

Returns

The height of the console in characters

Reimplemented from MaxOS::drivers::console::Console.

Definition at line 62 of file vesaboot.cpp.

                                 {
    return s_graphics_context->height() / FONT_HEIGHT;
}

References MaxOS::gui::FONT_HEIGHT, and MaxOS::common::Rectangle< Type >::height.

Referenced by get_background_color(), get_character(), get_foreground_color(), put_character(), scroll_up(), set_background_color(), set_foreground_color(), and VESABootConsole().

print_logo()

void VESABootConsole::print_logo ( bool  is_panic = false )

static

Prints the logo to the center of the screen.

Parameters

is_panic

Whether to print the kernel panic logo or the normal logo

Definition at line 250 of file vesaboot.cpp.

                                              {
 
    // Load the logo
    const char* logo = is_panic ? header_data_kp : header_data;
 
    // Find the center of the screen
    uint32_t screen_width = s_graphics_context->width();
    uint32_t screen_height = s_graphics_context->height();
    uint32_t center_x = screen_width / 2;
    uint32_t center_y = screen_height / 2 - 80;
 
    // Fill the screen with the logo colour
    auto col = Colour(is_panic ? ConsoleColour::Red : ConsoleColour::Black);
    memset(s_graphics_context->framebuffer_address(), s_graphics_context->colour_to_int(col), screen_width * screen_height * (s_graphics_context->color_depth() / 8));
 
    // Draw the logo
    for(uint32_t logo_y = 0; logo_y < LOGO_HEIGHT; ++logo_y) {
        for(uint32_t logo_x = 0; logo_x < LOGO_WIDTH; ++logo_x) {
 
            // Get the pixel from the logo
            uint8_t pixel[3] = { 0 };
            LOGO_HEADER_PIXEL(logo, pixel)
 
            // Draw the pixel
            s_graphics_context->put_pixel(center_x - LOGO_WIDTH / 2 + logo_x,
                                          center_y - LOGO_HEIGHT / 2 + logo_y,
                                          common::Colour(pixel[0], pixel[1], pixel[2]));
        }
    }
 
    update_progress_bar(0);
}

References MaxOS::common::Rectangle< Type >::height, LOGO_HEADER_PIXEL, LOGO_HEIGHT, LOGO_WIDTH, memset(), update_progress_bar(), and MaxOS::common::Rectangle< Type >::width.

Referenced by MaxOS::system::CPU::prepare_for_panic(), and VESABootConsole().

put_character()

void VESABootConsole::put_character ( uint16_t  x, uint16_t  y, char  c  )

finalvirtual

Places a character at the specified location.

Parameters

x	The x coordinate
y	The y coordinate
c	The character to place

Reimplemented from MaxOS::drivers::console::Console.

Definition at line 73 of file vesaboot.cpp.

                                                                  {
 
    // Parse any ansi codes
    if(c == '\033') {
 
        // Store the character
        ansi_code_length = 0;
        ansi_code[ansi_code_length++] = c;
 
        // Do not draw the escape character
        return;
    }
 
    if(ansi_code_length < 8) {
 
        // Add the character to the ANSI code
        ansi_code[ansi_code_length++] = c;
 
        // If the ANSI code is complete
        if(c == 'm') {
            ansi_code[ansi_code_length] = '\0';
            ansi_code_length = -1;
 
            if(strcmp("\033[0m", ansi_code) != 0) {
                m_foreground_color = ConsoleColour::Uninitialised;
                m_background_color = ConsoleColour::Uninitialised;
                return;
            }
 
            // Get the colour from the ANSI code
            const Colour colour(ansi_code);
 
            // Set the colour
            bool foreground = ansi_code[4] == '3';
            if(foreground)
                m_foreground_color = colour.to_console_colour();
            else
                m_background_color = colour.to_console_colour();
 
        }
 
        // Do not draw the escape character
        return;
    }
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return;
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Set the character at the offset, by masking the character with the current character (last 8 bits)
    m_video_memory_meta[offset] = (m_video_memory_meta[offset] & 0xFF00) | (uint16_t) c;
 
    // Convert the char into a string
    char s[] = " ";
    s[0] = c;
 
    Colour foreground = m_foreground_color == ConsoleColour::Uninitialised ? Colour(get_foreground_color(x, y)) : Colour(m_foreground_color);
    Colour background = m_background_color == ConsoleColour::Uninitialised ? Colour(get_background_color(x, y)) : Colour(m_background_color);
 
    // Use the m_font to draw the character
    m_font.draw_text(x * 8, y * FONT_HEIGHT, foreground, background, s_graphics_context, s);
}

References MaxOS::gui::Font::draw_text(), MaxOS::gui::FONT_HEIGHT, get_background_color(), get_foreground_color(), height(), strcmp(), MaxOS::common::Colour::to_console_colour(), and width().

scroll_up()

void VESABootConsole::scroll_up ( uint16_t  left, uint16_t  top, uint16_t  width, uint16_t  height, common::ConsoleColour  foreground, common::ConsoleColour  background, char  fill  )

finalvirtual

Scrolls the console up by 1 line.

Parameters

left	The left coordinate of the area to scroll
top	The top coordinate of the area to scroll
width	The width of the area to scroll
height	The height of the area to scroll
foreground	The foreground color of the new line
background	The background color of the new line
fill	The character to fill the new line with

Reimplemented from MaxOS::drivers::console::Console.

Definition at line 295 of file vesaboot.cpp.

                                                                           {
 
 
    // Get the framebuffer info
    auto* framebuffer_address = (uint8_t*) s_graphics_context->framebuffer_address();
    uint64_t framebuffer_width = s_graphics_context->width();
    uint64_t framebuffer_bpp = s_graphics_context->color_depth(); // in bits per pixel
    uint64_t bytes_per_pixel = framebuffer_bpp / 8;
    uint64_t framebuffer_pitch = framebuffer_width * bytes_per_pixel;
 
    uint16_t line_height = FONT_HEIGHT;
 
    // Region conversions
    uint16_t region_pixel_y = top * line_height;
    uint16_t region_pixel_height = height * line_height;
    uint16_t region_pixel_left = left * FONT_WIDTH;
    uint16_t region_pixel_width = width * FONT_WIDTH;
    size_t row_bytes = region_pixel_width * bytes_per_pixel;
 
    // Decide the colour of the pixel
    ConsoleColour to_set_foreground = get_foreground_color(left, top + height - 1);
    ConsoleColour to_set_background = get_background_color(left, top + height - 1);
    uint32_t fill_value = s_graphics_context->colour_to_int(Colour(to_set_background));
 
    // Scroll the region upward by one text line
    for(uint16_t row = 0; row < region_pixel_height - line_height; row++) {
        uint8_t* src = framebuffer_address + (region_pixel_y + row + line_height) * framebuffer_pitch + region_pixel_left * bytes_per_pixel;
        uint8_t* dest = framebuffer_address + (region_pixel_y + row) * framebuffer_pitch + region_pixel_left * bytes_per_pixel;
        memmove(dest, src, row_bytes);
    }
 
    // Clear the last line of the region
    uint16_t clear_start_y = region_pixel_y + region_pixel_height - line_height;
    for(uint16_t row = 0; row < line_height; row++) {
        auto row_add = (uint32_t*) (framebuffer_address + (clear_start_y + row) * framebuffer_pitch + region_pixel_left * 4);
        for(uint16_t col = 0; col < region_pixel_width; col++) {
            row_add[col] = fill_value;
        }
    }
 
    //Update any per-pixel colour metadata
    uint16_t text_row = top + height - 1;
    for(uint16_t x = left; x < left + width; x++) {
        set_foreground_color(x, text_row, to_set_foreground);
        set_background_color(x, text_row, to_set_background);
    }
}

References MaxOS::gui::FONT_HEIGHT, MaxOS::gui::FONT_WIDTH, get_background_color(), get_foreground_color(), height(), memmove(), set_background_color(), set_foreground_color(), MaxOS::common::Rectangle< Type >::width, and width().

set_background_color()

void VESABootConsole::set_background_color ( uint16_t  x, uint16_t  y, common::ConsoleColour  background  )

finalvirtual

Sets the background color at the specified location.

Parameters

x	The x coordinate
y	The y coordinate
background	The background color

Reimplemented from MaxOS::drivers::console::Console.

Definition at line 166 of file vesaboot.cpp.

                                                                                           {
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return;
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Set the background color at the offset, by masking the background color with the current background color (bits 12-15)
    m_video_memory_meta[offset] = (m_video_memory_meta[offset] & 0x0FFF) | ((uint16_t) background << 12);
}

References height(), and width().

Referenced by scroll_up().

set_foreground_color()

void VESABootConsole::set_foreground_color ( uint16_t  x, uint16_t  y, common::ConsoleColour  foreground  )

finalvirtual

Sets the foreground color at the specified location.

Parameters

x	The x coordinate
y	The y coordinate
foreground	The foreground color

Reimplemented from MaxOS::drivers::console::Console.

Definition at line 146 of file vesaboot.cpp.

                                                                                           {
 
    // If the coordinates are out of bounds, return
    if(x >= width() || y >= height())
        return;
 
    // Calculate the offset
    int offset = (y * width() + x);
 
    // Set the foreground color at the offset, by masking the foreground color with the current foreground color (bits 8-11)
    m_video_memory_meta[offset] = (m_video_memory_meta[offset] & 0xF0FF) | ((uint16_t) foreground << 8);
}

References height(), and width().

Referenced by scroll_up().

update_progress_bar()

void VESABootConsole::update_progress_bar ( uint8_t  percentage )

static

Updates the progress bar.

Parameters

percentage

The percentage to update the progress bar to (0-100)

Definition at line 362 of file vesaboot.cpp.

                                                            {
 
    // Check bounds
    if(percentage > 100)
        percentage = 100;
 
    // Must have a valid graphics context
    if(s_graphics_context == nullptr)
        return;
 
    uint8_t progress_height = 15;
    uint8_t progress_spacing = 20;
    uint8_t progress_width_cull = 40;
 
    // Find the center of the screen
    uint32_t right_x = (s_graphics_context->width() / 2) - LOGO_WIDTH / 2;
    uint32_t bottom_y = (s_graphics_context->height() / 2 - 80) - LOGO_HEIGHT / 2;
 
    // Find the bounds
    uint32_t start_x = progress_width_cull;
    uint32_t start_y = LOGO_HEIGHT + progress_spacing;
    uint32_t end_x = LOGO_WIDTH - progress_width_cull;
    uint32_t end_y = LOGO_HEIGHT + progress_height + progress_spacing;
 
    // Draw the progress bar
    for(uint32_t progress_y = start_y; progress_y < end_y; ++progress_y) {
        for(uint32_t progress_x = start_x; progress_x < end_x; ++progress_x) {
 
            // Check if drawing border
            bool is_border = (progress_y == start_y) || (progress_y == end_y - 1) ||
                             (progress_x == start_x) || (progress_x == end_x - 1);
 
            // Only draw the border if it is the first time drawing it
            is_border = is_border && percentage == 0;
 
            // If it is not within the percentage, skip it
            uint32_t logo_progress_width = LOGO_WIDTH * percentage / 100;
            if(progress_x > logo_progress_width && !is_border)
                continue;
 
            s_graphics_context->put_pixel(right_x + progress_x, bottom_y + progress_y, Colour(0xFF, 0xFF, 0xFF));
 
        }
    }
}

References MaxOS::common::Rectangle< Type >::height, LOGO_HEIGHT, LOGO_WIDTH, and MaxOS::common::Rectangle< Type >::width.

Referenced by print_logo(), and MaxOS::Logger::set_log_level().

width()

uint16_t VESABootConsole::width ( )

finalvirtual

Gets the width of the console.

Returns

The width of the console in characters

Reimplemented from MaxOS::drivers::console::Console.

Definition at line 53 of file vesaboot.cpp.

                                {
    return s_graphics_context->width() / FONT_WIDTH;       // 8 pixels per character
}

References MaxOS::gui::FONT_WIDTH, and MaxOS::common::Rectangle< Type >::width.

Referenced by get_background_color(), get_character(), get_foreground_color(), put_character(), scroll_up(), set_background_color(), set_foreground_color(), and VESABootConsole().

Member Data Documentation

cout

ConsoleStream* MaxOS::drivers::console::VESABootConsole::cout

The boot console output stream.

Definition at line 51 of file vesaboot.h.

Referenced by finish(), and VESABootConsole().

---

The documentation for this class was generated from the following files:

• /home/runner/work/MaxOS/MaxOS/kernel/include/drivers/console/vesaboot.h
• /home/runner/work/MaxOS/MaxOS/kernel/src/drivers/console/vesaboot.cpp