MaxOS::console::SerialConsole Class Reference

A driver for the serial output. More...

#include <serial.h>

Inheritance diagram for MaxOS::console::SerialConsole:

Public Member Functions
	SerialConsole ()
	Constructs a new Serial Console object and initialises the serial port.
	SerialConsole (Logger *logger)
	Constructs a new Serial Console object and initialises the serial port.
void	put_character (char c)
	Waits for the serial port to be ready, then writes a character to it.
void	write_char (char c) final
	Waits for the serial port to be ready, then writes a character to it.
bool	can_read ()
	Checks if data can be read from the serial port.
char	read_char ()
	Read data from the serial port.

Detailed Description

A driver for the serial output.

Definition at line 25 of file serial.h.

Constructor & Destructor Documentation

SerialConsole() [1/2]

SerialConsole::SerialConsole ( )

explicit

Constructs a new Serial Console object and initialises the serial port.

Definition at line 19 of file serial.cpp.

: m_data_port(0x3F8),
  m_interrupt_enable_port(0x3F9),
  m_fifo_control_port(0x3FA),
  m_line_control_port(0x3FB),
  m_modem_control_port(0x3FC),
  m_line_status_port(0x3FD)
{
    // Disable all interrupts
    m_interrupt_enable_port.write(0x00);
 
    // Enable DLAB (set baud rate divisor)
    m_line_control_port.write(0x80);
 
    // Set divisor to 3
    m_data_port.write(0x03);
    m_interrupt_enable_port.write(0x00);
 
    // 8 bits, no parity, one stop bit
    m_line_control_port.write(0x03);
 
    // Enable FIFO, clear them, with 14-byte threshold
    m_fifo_control_port.write(0x07);
 
    // IRQs enabled, RTS/DSR set
    m_modem_control_port.write(0x0B);
 
    // Test serial chip
    m_modem_control_port.write(0x1E);
    m_data_port.write(0xAE);
    if (m_data_port.read() != 0xAE)
        return;
 
    // Enable serial chip
    m_modem_control_port.write(0x0F);
 
    // Enable interrupts
    m_interrupt_enable_port.write(0x01);
 
    // Clear any prexisting state
    m_fifo_control_port.read();
    while (can_read())
        read_char();
}

References can_read(), and read_char().

SerialConsole() [2/2]

SerialConsole::SerialConsole ( Logger *  logger )

explicit

Constructs a new Serial Console object and initialises the serial port.

Parameters

logger

The logger which will use this serial console as a log writer

Definition at line 69 of file serial.cpp.

: SerialConsole()
{
    // Set the active serial console
    if (!DO_DEBUGGING)
        logger->add_log_writer(this);
}

References MaxOS::Logger::add_log_writer(), and MaxOS::runtime::DO_DEBUGGING.

Member Function Documentation

can_read()

bool SerialConsole::can_read

(

)

Checks if data can be read from the serial port.

Returns

True if data is ready to be read

Definition at line 108 of file serial.cpp.

                             {
    return m_line_status_port.read() & 1;
}

Referenced by SerialConsole().

put_character()

void SerialConsole::put_character

(

char

c

)

Waits for the serial port to be ready, then writes a character to it.

Parameters

c	The character to write

Definition at line 84 of file serial.cpp.

                                        {
 
    // Wait for the serial port to be ready
    while (0 == (m_line_status_port.read() & 0x20));
 
    // Write the character
    m_data_port.write(c);
 
}

Referenced by write_char().

read_char()

char SerialConsole::read_char

(

)

Read data from the serial port.

Returns

The data read

Definition at line 117 of file serial.cpp.

                              {
    return m_data_port.read();
}

Referenced by SerialConsole().

write_char()

void SerialConsole::write_char ( char  c )

final

Waits for the serial port to be ready, then writes a character to it.

Parameters

c	The character to write

Definition at line 99 of file serial.cpp.

                                     {
    put_character(c);
}

References put_character().

Referenced by MaxOS::runtime::GDBServer::handle_continue(), and MaxOS::runtime::GDBServer::handle_step_instruction().

---

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

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