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 <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	CONSOLE_PORT   0
#define	CONSOLE_BAUD   COMSPEED
#define	CONSOLE_LCR   UART_LCR_WPS ( COMDATA, COMPARITY, COMSTOP )

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
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...

Variables
struct uart	serial_console
	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 44 of file serial.c.

CONSOLE_PORT

#define CONSOLE_PORT   0

Definition at line 51 of file serial.c.

CONSOLE_BAUD

#define CONSOLE_BAUD   COMSPEED

Definition at line 58 of file serial.c.

CONSOLE_LCR

#define CONSOLE_LCR   UART_LCR_WPS ( COMDATA, COMPARITY, COMSTOP )

Definition at line 65 of file serial.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

serial_putchar()

static void serial_putchar ( int  character )

static

Print a character to serial console.

Parameters

character

Character to be printed

Definition at line 76 of file serial.c.

                                             {

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

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

References uart::base, serial_console, and uart_transmit().

serial_getchar()

static int serial_getchar ( void  )

static

Get character from serial console.

Return values

character

Character read from console

Definition at line 91 of file serial.c.

                                   {
        uint8_t data;

        /* Do nothing if we have no UART */
        if ( ! serial_console.base )
                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 uart::base, data, serial_console, uart_data_ready(), and uart_receive().

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 118 of file serial.c.

                                 {

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

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

References uart::base, serial_console, and uart_data_ready().

serial_init()

static void serial_init ( void  )

static

Initialise serial console.

Definition at line 137 of file serial.c.

                                 {
        int rc;

        /* Do nothing if we have no default port */
        if ( ! CONSOLE_PORT )
                return;

        /* Select UART */
        if ( ( rc = uart_select ( &serial_console, CONSOLE_PORT ) ) != 0 ) {
                DBG ( "Could not select UART %d: %s\n",
                      CONSOLE_PORT, strerror ( rc ) );
                return;
        }

        /* Initialise UART */
        if ( ( rc = uart_init ( &serial_console, CONSOLE_BAUD,
                                CONSOLE_LCR ) ) != 0 ) {
                DBG ( "Could not initialise UART %d baud %d LCR %#02x: %s\n",
                      CONSOLE_PORT, CONSOLE_BAUD, CONSOLE_LCR, strerror ( rc ));
                return;
        }
}

References CONSOLE_BAUD, CONSOLE_LCR, CONSOLE_PORT, DBG, rc, serial_console, strerror(), uart_init(), and uart_select().

serial_shutdown()

static void serial_shutdown ( int flags  __unused )

static

Shut down serial console.

Parameters

flags

Shutdown flags

Definition at line 165 of file serial.c.

                                                   {

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

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

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

References uart::base, serial_console, and uart_flush().

__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.

Variable Documentation

serial_console

struct uart serial_console

Serial console UART.

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 129 of file serial.c.