serial.c File Reference

Serial console. More...

#include <stddef.h>
#include <string.h>
#include <ipxe/init.h>
#include <ipxe/uart.h>
#include <ipxe/console.h>
#include <ipxe/serial.h>
#include <ipxe/ns16550.h>
#include <config/console.h>
#include <config/serial.h>

Go to the source code of this file.

Macros
#define	CONSOLE_SERIAL   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )
#define	SERIAL_PREFIX_fixed   __fixed_
#define	COMCONSOLE   NULL
#define	COMSPEED   0

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
struct uart *	fixed_serial_console (void)
	Get fixed serial console UART. More...
static void	serial_putchar (int character)
	Print a character to serial console. More...
static int	serial_getchar (void)
	Get character from serial console. More...
static int	serial_iskey (void)
	Check for character ready to read from serial console. More...
static void	serial_init (void)
	Initialise serial console. More...
static void	serial_shutdown (int flags __unused)
	Shut down serial console. More...
struct init_fn serial_console_init_fn	__init_fn (INIT_CONSOLE)
	Serial console initialisation function. More...
struct startup_fn serial_startup_fn	__startup_fn (STARTUP_EARLY)
	Serial console startup function. More...
	PROVIDE_SERIAL_INLINE (null, default_serial_console)
	PROVIDE_SERIAL (fixed, default_serial_console, fixed_serial_console)

Variables
struct uart *	serial_console = NULL
	Active serial console UART. More...
struct console_driver serial_console_driver	__console_driver
	Serial console. More...

Detailed Description

Serial console.

Definition in file serial.c.

Macro Definition Documentation

CONSOLE_SERIAL

#define CONSOLE_SERIAL   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )

Definition at line 45 of file serial.c.

SERIAL_PREFIX_fixed

#define SERIAL_PREFIX_fixed   __fixed_

Definition at line 51 of file serial.c.

COMCONSOLE

#define COMCONSOLE   NULL

Definition at line 56 of file serial.c.

COMSPEED

#define COMSPEED   0

Definition at line 61 of file serial.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

fixed_serial_console()

struct uart* fixed_serial_console

(

void

)

Get fixed serial console UART.

Return values

uart	Serial console UART, or NULL

Definition at line 76 of file serial.c.

                                            {
        struct uart *uart = COMCONSOLE;
        unsigned int baud = COMSPEED;

        /* Set default baud rate, if applicable */
        if ( uart && baud )
                uart->baud = baud;

        return uart;
}

References uart::baud, COMCONSOLE, and COMSPEED.

Referenced by spcr_console().

serial_putchar()

static void serial_putchar ( int  character )

static

Print a character to serial console.

Parameters

character

Character to be printed

Definition at line 92 of file serial.c.

                                             {

        /* Do nothing if we have no UART */
        if ( ! serial_console )
                return;

        /* Transmit character */
        uart_transmit ( serial_console, character );
}

References serial_console.

serial_getchar()

static int serial_getchar ( void  )

static

Get character from serial console.

Return values

character

Character read from console

Definition at line 107 of file serial.c.

                                   {
        uint8_t data;

        /* Do nothing if we have no UART */
        if ( ! serial_console )
                return 0;

        /* Wait for data to be ready */
        while ( ! uart_data_ready ( serial_console ) ) {}

        /* Receive data */
        data = uart_receive ( serial_console );

        /* Strip any high bit and convert DEL to backspace */
        data &= 0x7f;
        if ( data == 0x7f )
                data = 0x08;

        return data;
}

References data, and serial_console.

serial_iskey()

static int serial_iskey ( void  )

static

Check for character ready to read from serial console.

Return values

True	Character available to read
False	No character available to read

Definition at line 134 of file serial.c.

                                 {

        /* Do nothing if we have no UART */
        if ( ! serial_console )
                return 0;

        /* Check UART */
        return uart_data_ready ( serial_console );
}

References serial_console.

serial_init()

static void serial_init ( void  )

static

Initialise serial console.

Definition at line 153 of file serial.c.

                                 {
        struct uart *uart;
        int rc;

        /* Get default serial console, if any */
        uart = default_serial_console();
        if ( ! uart )
                return;

        /* Initialise UART */
        if ( ( rc = uart_init ( uart ) ) != 0 ) {
                DBGC ( uart, "SERIAL could not initialise %s: %s\n",
                       uart->name, strerror ( rc ) );
                return;
        }

        /* Record UART as serial console */
        serial_console = uart;
        DBGC ( uart, "SERIAL using %s\n", uart->name );
}

References DBGC, default_serial_console(), uart::name, rc, serial_console, and strerror().

serial_shutdown()

static void serial_shutdown ( int flags  __unused )

static

Shut down serial console.

Parameters

flags

Shutdown flags

Definition at line 179 of file serial.c.

                                                   {

        /* Do nothing if we have no UART */
        if ( ! serial_console )
                return;

        /* Flush any pending output */
        uart_flush ( serial_console );

        /* Leave console enabled; it's still usable */
}

References serial_console.

__init_fn()

struct init_fn serial_console_init_fn __init_fn

(

INIT_CONSOLE

)

Serial console initialisation function.

__startup_fn()

struct startup_fn serial_startup_fn __startup_fn

(

STARTUP_EARLY

)

Serial console startup function.

PROVIDE_SERIAL_INLINE()

PROVIDE_SERIAL_INLINE	(	null	,
		default_serial_console
	)

PROVIDE_SERIAL()

PROVIDE_SERIAL	(	fixed	,
		default_serial_console	,
		fixed_serial_console
	)

Variable Documentation

serial_console

struct uart* serial_console = NULL

Active serial console UART.

Explicitly initialised to NULL since this variable may be accessed before .bss has been zeroed.

Definition at line 69 of file serial.c.

Referenced by serial_getchar(), serial_init(), serial_iskey(), serial_putchar(), and serial_shutdown().

__console_driver

struct console_driver serial_console_driver __console_driver

Initial value:

= {
        .putchar = serial_putchar,
        .getchar = serial_getchar,
        .iskey = serial_iskey,
        .usage = CONSOLE_SERIAL,
}

Serial console.

Definition at line 145 of file serial.c.