efi_console.c File Reference

#include <stddef.h>
#include <string.h>
#include <errno.h>
#include <assert.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/Protocol/ConsoleControl/ConsoleControl.h>
#include <ipxe/ansiesc.h>
#include <ipxe/utf8.h>
#include <ipxe/console.h>
#include <ipxe/keymap.h>
#include <ipxe/init.h>
#include <config/console.h>

Go to the source code of this file.

Macros
#define	ATTR_BOLD   0x08
#define	ATTR_FCOL_MASK   0x07
#define	ATTR_FCOL_BLACK   0x00
#define	ATTR_FCOL_BLUE   0x01
#define	ATTR_FCOL_GREEN   0x02
#define	ATTR_FCOL_CYAN   0x03
#define	ATTR_FCOL_RED   0x04
#define	ATTR_FCOL_MAGENTA   0x05
#define	ATTR_FCOL_YELLOW   0x06
#define	ATTR_FCOL_WHITE   0x07
#define	ATTR_BCOL_MASK   0x70
#define	ATTR_BCOL_BLACK   0x00
#define	ATTR_BCOL_BLUE   0x10
#define	ATTR_BCOL_GREEN   0x20
#define	ATTR_BCOL_CYAN   0x30
#define	ATTR_BCOL_RED   0x40
#define	ATTR_BCOL_MAGENTA   0x50
#define	ATTR_BCOL_YELLOW   0x60
#define	ATTR_BCOL_WHITE   0x70
#define	ATTR_DEFAULT   ATTR_FCOL_WHITE
#define	CONSOLE_EFI   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )

Functions
	FILE_LICENCE (GPL2_OR_LATER)
	FILE_SECBOOT (PERMITTED)
	EFI_REQUEST_PROTOCOL (EFI_CONSOLE_CONTROL_PROTOCOL, &conctrl)
static void	efi_handle_cup (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[])
	Handle ANSI CUP (cursor position)
static void	efi_handle_ed (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused)
	Handle ANSI ED (erase in page)
static void	efi_handle_sgr (struct ansiesc_context *ctx __unused, unsigned int count, int params[])
	Handle ANSI SGR (set graphics rendition)
static void	efi_handle_dectcem_set (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused)
	Handle ANSI DECTCEM set (show cursor)
static void	efi_handle_dectcem_reset (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused)
	Handle ANSI DECTCEM reset (hide cursor)
static void	efi_putchar (int character)
	Print a character to EFI console.
static const char *	scancode_to_ansi_seq (unsigned int scancode)
	Get ANSI escape sequence corresponding to EFI scancode.
static int	efi_getchar (void)
	Get character from EFI console.
static int	efi_iskey (void)
	Check for character ready to read from EFI console.
static void	efi_console_init (void)
	Initialise EFI console.
struct init_fn efi_console_init_fn	__init_fn (INIT_EARLY)
	EFI console initialisation function.

Variables
static unsigned int	efi_attr = ATTR_DEFAULT
	Current character attribute.
static EFI_CONSOLE_CONTROL_PROTOCOL *	conctrl
	Console control protocol.
static EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *	efi_conin_ex
	Extended simple text input protocol, if present.
static struct ansiesc_handler	efi_ansiesc_handlers []
	EFI console ANSI escape sequence handlers.
static struct ansiesc_context	efi_ansiesc_ctx
	EFI console ANSI escape sequence context.
static struct utf8_accumulator	efi_utf8_acc
	EFI console UTF-8 accumulator.
static const char *	ansi_input = ""
	Pointer to current ANSI output sequence.
static const char *	ansi_sequences []
	Mapping from EFI scan codes to ANSI escape sequences.
struct console_driver efi_console	__console_driver
	EFI console driver.

Macro Definition Documentation

ATTR_BOLD

#define ATTR_BOLD   0x08

Definition at line 36 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_FCOL_MASK

#define ATTR_FCOL_MASK   0x07

Definition at line 38 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_FCOL_BLACK

#define ATTR_FCOL_BLACK   0x00

Definition at line 39 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_FCOL_BLUE

#define ATTR_FCOL_BLUE   0x01

Definition at line 40 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_FCOL_GREEN

#define ATTR_FCOL_GREEN   0x02

Definition at line 41 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_FCOL_CYAN

#define ATTR_FCOL_CYAN   0x03

Definition at line 42 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_FCOL_RED

#define ATTR_FCOL_RED   0x04

Definition at line 43 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_FCOL_MAGENTA

#define ATTR_FCOL_MAGENTA   0x05

Definition at line 44 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_FCOL_YELLOW

#define ATTR_FCOL_YELLOW   0x06

Definition at line 45 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_FCOL_WHITE

#define ATTR_FCOL_WHITE   0x07

Definition at line 46 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_BCOL_MASK

#define ATTR_BCOL_MASK   0x70

Definition at line 48 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_BCOL_BLACK

#define ATTR_BCOL_BLACK   0x00

Definition at line 49 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_BCOL_BLUE

#define ATTR_BCOL_BLUE   0x10

Definition at line 50 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_BCOL_GREEN

#define ATTR_BCOL_GREEN   0x20

Definition at line 51 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_BCOL_CYAN

#define ATTR_BCOL_CYAN   0x30

Definition at line 52 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_BCOL_RED

#define ATTR_BCOL_RED   0x40

Definition at line 53 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_BCOL_MAGENTA

#define ATTR_BCOL_MAGENTA   0x50

Definition at line 54 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_BCOL_YELLOW

#define ATTR_BCOL_YELLOW   0x60

Definition at line 55 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_BCOL_WHITE

#define ATTR_BCOL_WHITE   0x70

Definition at line 56 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

ATTR_DEFAULT

#define ATTR_DEFAULT   ATTR_FCOL_WHITE

Definition at line 58 of file efi_console.c.

Referenced by bios_handle_sgr(), and efi_handle_sgr().

CONSOLE_EFI

#define CONSOLE_EFI   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )

Definition at line 63 of file efi_console.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

EFI_REQUEST_PROTOCOL()

EFI_REQUEST_PROTOCOL	(	EFI_CONSOLE_CONTROL_PROTOCOL	,
		&	conctrl )

References conctrl.

efi_handle_cup()

void efi_handle_cup ( struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] )

static

Handle ANSI CUP (cursor position)

Parameters

ctx	ANSI escape sequence context
count	Parameter count
params[0]	Row (1 is top)
params[1]	Column (1 is left)

Definition at line 84 of file efi_console.c.

                                                                         {
        EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
        int cx = ( params[1] - 1 );
        int cy = ( params[0] - 1 );
 
        if ( cx < 0 )
                cx = 0;
        if ( cy < 0 )
                cy = 0;
 
        conout->SetCursorPosition ( conout, cx, cy );
}

References __unused, count, ctx, cx, efi_systab, and _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::SetCursorPosition.

efi_handle_ed()

void efi_handle_ed ( struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused )

static

Handle ANSI ED (erase in page)

Parameters

ctx	ANSI escape sequence context
count	Parameter count
params[0]	Region to erase

Definition at line 105 of file efi_console.c.

                                                    {
        EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
 
        /* We assume that we always clear the whole screen */
        assert ( params[0] == ANSIESC_ED_ALL );
 
        conout->ClearScreen ( conout );
}

References __unused, ANSIESC_ED_ALL, assert, _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::ClearScreen, count, ctx, and efi_systab.

efi_handle_sgr()

void efi_handle_sgr ( struct ansiesc_context *ctx __unused, unsigned int count, int params[] )

static

Handle ANSI SGR (set graphics rendition)

Parameters

ctx	ANSI escape sequence context
count	Parameter count
params	List of graphic rendition aspects

Definition at line 123 of file efi_console.c.

                                                                {
        EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
        static const uint8_t efi_attr_fcols[10] = {
                ATTR_FCOL_BLACK, ATTR_FCOL_RED, ATTR_FCOL_GREEN,
                ATTR_FCOL_YELLOW, ATTR_FCOL_BLUE, ATTR_FCOL_MAGENTA,
                ATTR_FCOL_CYAN, ATTR_FCOL_WHITE,
                ATTR_FCOL_WHITE, ATTR_FCOL_WHITE /* defaults */
        };
        static const uint8_t efi_attr_bcols[10] = {
                ATTR_BCOL_BLACK, ATTR_BCOL_RED, ATTR_BCOL_GREEN,
                ATTR_BCOL_YELLOW, ATTR_BCOL_BLUE, ATTR_BCOL_MAGENTA,
                ATTR_BCOL_CYAN, ATTR_BCOL_WHITE,
                ATTR_BCOL_BLACK, ATTR_BCOL_BLACK /* defaults */
        };
        unsigned int i;
        int aspect;
 
        for ( i = 0 ; i < count ; i++ ) {
                aspect = params[i];
                if ( aspect == 0 ) {
                        efi_attr = ATTR_DEFAULT;
                } else if ( aspect == 1 ) {
                        efi_attr |= ATTR_BOLD;
                } else if ( aspect == 22 ) {
                        efi_attr &= ~ATTR_BOLD;
                } else if ( ( aspect >= 30 ) && ( aspect <= 39 ) ) {
                        efi_attr &= ~ATTR_FCOL_MASK;
                        efi_attr |= efi_attr_fcols[ aspect - 30 ];
                } else if ( ( aspect >= 40 ) && ( aspect <= 49 ) ) {
                        efi_attr &= ~ATTR_BCOL_MASK;
                        efi_attr |= efi_attr_bcols[ aspect - 40 ];
                }
        }
 
        conout->SetAttribute ( conout, efi_attr );
}

References __unused, ATTR_BCOL_BLACK, ATTR_BCOL_BLUE, ATTR_BCOL_CYAN, ATTR_BCOL_GREEN, ATTR_BCOL_MAGENTA, ATTR_BCOL_MASK, ATTR_BCOL_RED, ATTR_BCOL_WHITE, ATTR_BCOL_YELLOW, ATTR_BOLD, ATTR_DEFAULT, ATTR_FCOL_BLACK, ATTR_FCOL_BLUE, ATTR_FCOL_CYAN, ATTR_FCOL_GREEN, ATTR_FCOL_MAGENTA, ATTR_FCOL_MASK, ATTR_FCOL_RED, ATTR_FCOL_WHITE, ATTR_FCOL_YELLOW, count, ctx, efi_attr, efi_systab, and _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::SetAttribute.

efi_handle_dectcem_set()

void efi_handle_dectcem_set ( struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused )

static

Handle ANSI DECTCEM set (show cursor)

Parameters

ctx	ANSI escape sequence context
count	Parameter count
params	List of graphic rendition aspects

Definition at line 168 of file efi_console.c.

                                                             {
        EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
 
        conout->EnableCursor ( conout, TRUE );
}

References __unused, count, ctx, efi_systab, _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::EnableCursor, and TRUE.

efi_handle_dectcem_reset()

void efi_handle_dectcem_reset ( struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused )

static

Handle ANSI DECTCEM reset (hide cursor)

Parameters

ctx	ANSI escape sequence context
count	Parameter count
params	List of graphic rendition aspects

Definition at line 183 of file efi_console.c.

                                                               {
        EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
 
        conout->EnableCursor ( conout, FALSE );
}

References __unused, count, ctx, efi_systab, _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::EnableCursor, and FALSE.

efi_putchar()

void efi_putchar ( int character )

static

Print a character to EFI console.

Parameters

character

Character to be printed

Definition at line 214 of file efi_console.c.

                                          {
        EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
        wchar_t wstr[2];
 
        /* Intercept ANSI escape sequences */
        character = ansiesc_process ( &efi_ansiesc_ctx, character );
        if ( character < 0 )
                return;
 
        /* Accumulate Unicode characters */
        character = utf8_accumulate ( &efi_utf8_acc, character );
        if ( character == 0 )
                return;
 
        /* Treat unrepresentable (non-UCS2) characters as invalid */
        if ( character & ~( ( wchar_t ) -1UL ) )
                character = UTF8_INVALID;
 
        /* Output character */
        wstr[0] = character;
        wstr[1] = L'\0';
        conout->OutputString ( conout, wstr );
}

References ansiesc_process(), utf8_accumulator::character, efi_ansiesc_ctx, efi_systab, efi_utf8_acc, _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::OutputString, utf8_accumulate(), and UTF8_INVALID.

scancode_to_ansi_seq()

const char * scancode_to_ansi_seq ( unsigned int scancode )

static

Get ANSI escape sequence corresponding to EFI scancode.

Parameters

scancode

EFI scancode

Return values

ansi_seq

ANSI escape sequence, if any, otherwise NULL

Definition at line 287 of file efi_console.c.

                                                                   {
        if ( scancode < ( sizeof ( ansi_sequences ) /
                          sizeof ( ansi_sequences[0] ) ) ) {
                return ansi_sequences[scancode];
        }
        return NULL;
}

References ansi_sequences, and NULL.

Referenced by efi_getchar().

efi_getchar()

int efi_getchar ( void )

static

Get character from EFI console.

Return values

character

Character read from console

Definition at line 300 of file efi_console.c.

                                {
        EFI_SIMPLE_TEXT_INPUT_PROTOCOL *conin = efi_systab->ConIn;
        EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *conin_ex = efi_conin_ex;
        const char *ansi_seq;
        unsigned int character;
        unsigned int shift;
        unsigned int toggle;
        EFI_KEY_DATA key;
        EFI_STATUS efirc;
        int rc;
 
        /* If we are mid-sequence, pass out the next byte */
        if ( *ansi_input )
                return *(ansi_input++);
 
        /* Read key from real EFI console */
        memset ( &key, 0, sizeof ( key ) );
        if ( conin_ex ) {
                if ( ( efirc = conin_ex->ReadKeyStrokeEx ( conin_ex,
                                                           &key ) ) != 0 ) {
                        rc = -EEFI ( efirc );
                        DBG ( "EFI could not read extended keystroke: %s\n",
                              strerror ( rc ) );
                        return 0;
                }
        } else {
                if ( ( efirc = conin->ReadKeyStroke ( conin,
                                                      &key.Key ) ) != 0 ) {
                        rc = -EEFI ( efirc );
                        DBG ( "EFI could not read keystroke: %s\n",
                              strerror ( rc ) );
                        return 0;
                }
        }
        DBG2 ( "EFI read key stroke shift %08x toggle %02x unicode %04x "
               "scancode %04x\n", key.KeyState.KeyShiftState,
               key.KeyState.KeyToggleState, key.Key.UnicodeChar,
               key.Key.ScanCode );
 
        /* If key has a Unicode representation, remap and return it.
         * There is unfortunately no way to avoid remapping the
         * numeric keypad, since EFI destroys the scan code
         * information that would allow us to differentiate between
         * main keyboard and numeric keypad.
         */
        if ( ( character = key.Key.UnicodeChar ) != 0 ) {
 
                /* Apply shift state */
                shift = key.KeyState.KeyShiftState;
                if ( shift & EFI_SHIFT_STATE_VALID ) {
                        if ( shift & ( EFI_LEFT_CONTROL_PRESSED |
                                       EFI_RIGHT_CONTROL_PRESSED ) ) {
                                character |= KEYMAP_CTRL;
                        }
                        if ( shift & EFI_RIGHT_ALT_PRESSED ) {
                                character |= KEYMAP_ALTGR;
                        }
                }
 
                /* Apply toggle state */
                toggle = key.KeyState.KeyToggleState;
                if ( toggle & EFI_TOGGLE_STATE_VALID ) {
                        if ( toggle & EFI_CAPS_LOCK_ACTIVE ) {
                                character |= KEYMAP_CAPSLOCK_REDO;
                        }
                }
 
                /* Remap and return key */
                return key_remap ( character );
        }
 
        /* Otherwise, check for a special key that we know about */
        if ( ( ansi_seq = scancode_to_ansi_seq ( key.Key.ScanCode ) ) ) {
                /* Start of escape sequence: return ESC (0x1b) */
                ansi_input = ansi_seq;
                return 0x1b;
        }
 
        return 0;
}

References ansi_input, utf8_accumulator::character, DBG, DBG2, EEFI, EFI_CAPS_LOCK_ACTIVE, efi_conin_ex, EFI_LEFT_CONTROL_PRESSED, EFI_RIGHT_ALT_PRESSED, EFI_RIGHT_CONTROL_PRESSED, EFI_SHIFT_STATE_VALID, efi_systab, EFI_TOGGLE_STATE_VALID, key, key_remap(), KEYMAP_ALTGR, KEYMAP_CAPSLOCK_REDO, KEYMAP_CTRL, memset(), rc, _EFI_SIMPLE_TEXT_INPUT_PROTOCOL::ReadKeyStroke, _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL::ReadKeyStrokeEx, scancode_to_ansi_seq(), and strerror().

efi_iskey()

int efi_iskey ( void )

static

Check for character ready to read from EFI console.

Return values

True	Character available to read
False	No character available to read

Definition at line 387 of file efi_console.c.

                              {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        EFI_SIMPLE_TEXT_INPUT_PROTOCOL *conin = efi_systab->ConIn;
        EFI_STATUS efirc;
 
        /* If we are mid-sequence, we are always ready */
        if ( *ansi_input )
                return 1;
 
        /* Check to see if the WaitForKey event has fired */
        if ( ( efirc = bs->CheckEvent ( conin->WaitForKey ) ) == 0 )
                return 1;
 
        return 0;
}

References ansi_input, EFI_BOOT_SERVICES::CheckEvent, efi_systab, and _EFI_SIMPLE_TEXT_INPUT_PROTOCOL::WaitForKey.

efi_console_init()

void efi_console_init ( void )

static

Initialise EFI console.

Definition at line 415 of file efi_console.c.

                                      {
        EFI_CONSOLE_CONTROL_SCREEN_MODE mode;
        int rc;
 
        /* On some older EFI 1.10 implementations, we must use the
         * (now obsolete) EFI_CONSOLE_CONTROL_PROTOCOL to switch the
         * console into text mode.
         */
        if ( conctrl ) {
                conctrl->GetMode ( conctrl, &mode, NULL, NULL );
                if ( mode != EfiConsoleControlScreenText ) {
                        conctrl->SetMode ( conctrl,
                                           EfiConsoleControlScreenText );
                }
        }
 
        /* Attempt to open the Simple Text Input Ex protocol on the
         * console input handle.  This is provably unsafe, but is
         * apparently the expected behaviour for all UEFI
         * applications.  Don't ask.
         */
        if ( ( rc = efi_open_unsafe ( efi_systab->ConsoleInHandle,
                                      &efi_simple_text_input_ex_protocol_guid,
                                      &efi_conin_ex ) ) == 0 ) {
                DBG ( "EFI using SimpleTextInputEx\n" );
        } else {
                DBG ( "EFI has no SimpleTextInputEx: %s\n", strerror ( rc ) );
        }
}

References conctrl, DBG, efi_conin_ex, efi_open_unsafe, efi_simple_text_input_ex_protocol_guid, efi_systab, EfiConsoleControlScreenText, mode, NULL, rc, and strerror().

Referenced by __init_fn().

__init_fn()

struct init_fn efi_console_init_fn __init_fn

(

INIT_EARLY

)

EFI console initialisation function.

References __init_fn, efi_console_init(), and INIT_EARLY.

Variable Documentation

efi_attr

unsigned int efi_attr = ATTR_DEFAULT

static

Current character attribute.

Definition at line 67 of file efi_console.c.

Referenced by efi_handle_sgr().

conctrl

EFI_CONSOLE_CONTROL_PROTOCOL* conctrl

static

Console control protocol.

Definition at line 70 of file efi_console.c.

Referenced by efi_console_init(), and EFI_REQUEST_PROTOCOL().

efi_conin_ex

EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL* efi_conin_ex

static

Extended simple text input protocol, if present.

Definition at line 74 of file efi_console.c.

Referenced by efi_console_init(), and efi_getchar().

efi_ansiesc_handlers

struct ansiesc_handler efi_ansiesc_handlers[]

static

Initial value:

= {
        { ANSIESC_CUP, efi_handle_cup },
        { ANSIESC_ED, efi_handle_ed },
        { ANSIESC_SGR, efi_handle_sgr },
        { ANSIESC_DECTCEM_SET, efi_handle_dectcem_set },
        { ANSIESC_DECTCEM_RESET, efi_handle_dectcem_reset },
        { 0, NULL }
}

EFI console ANSI escape sequence handlers.

Definition at line 192 of file efi_console.c.

                                                       {
        { ANSIESC_CUP, efi_handle_cup },
        { ANSIESC_ED, efi_handle_ed },
        { ANSIESC_SGR, efi_handle_sgr },
        { ANSIESC_DECTCEM_SET, efi_handle_dectcem_set },
        { ANSIESC_DECTCEM_RESET, efi_handle_dectcem_reset },
        { 0, NULL }
};

efi_ansiesc_ctx

struct ansiesc_context efi_ansiesc_ctx

static

Initial value:

= {
        .handlers = efi_ansiesc_handlers,
}

EFI console ANSI escape sequence context.

Definition at line 202 of file efi_console.c.

                                                {
        .handlers = efi_ansiesc_handlers,
};

Referenced by efi_putchar().

efi_utf8_acc

struct utf8_accumulator efi_utf8_acc

static

EFI console UTF-8 accumulator.

Definition at line 207 of file efi_console.c.

Referenced by efi_putchar().

ansi_input

const char* ansi_input = ""

static

Pointer to current ANSI output sequence.

While we are in the middle of returning an ANSI sequence for a special key, this will point to the next character to return. When not in the middle of such a sequence, this will point to a NUL (note: not "will be NULL").

Definition at line 246 of file efi_console.c.

Referenced by efi_getchar(), and efi_iskey().

ansi_sequences

const char* ansi_sequences[]

static

Initial value:

= {
        [SCAN_UP] = "[A",
        [SCAN_DOWN] = "[B",
        [SCAN_RIGHT] = "[C",
        [SCAN_LEFT] = "[D",
        [SCAN_HOME] = "[H",
        [SCAN_END] = "[F",
        [SCAN_INSERT] = "[2~",
        
        [SCAN_DELETE] = "[3~",
        [SCAN_PAGE_UP] = "[5~",
        [SCAN_PAGE_DOWN] = "[6~",
        [SCAN_F5] = "[15~",
        [SCAN_F6] = "[17~",
        [SCAN_F7] = "[18~",
        [SCAN_F8] = "[19~",
        [SCAN_F9] = "[20~",
        [SCAN_F10] = "[21~",
        [SCAN_F11] = "[23~",
        [SCAN_F12] = "[24~",
        
        [SCAN_ESC] = "",
}

Mapping from EFI scan codes to ANSI escape sequences.

Definition at line 249 of file efi_console.c.

                                      {
        [SCAN_UP] = "[A",
        [SCAN_DOWN] = "[B",
        [SCAN_RIGHT] = "[C",
        [SCAN_LEFT] = "[D",
        [SCAN_HOME] = "[H",
        [SCAN_END] = "[F",
        [SCAN_INSERT] = "[2~",
        /* EFI translates an incoming backspace via the serial console
         * into a SCAN_DELETE.  There's not much we can do about this.
         */
        [SCAN_DELETE] = "[3~",
        [SCAN_PAGE_UP] = "[5~",
        [SCAN_PAGE_DOWN] = "[6~",
        [SCAN_F5] = "[15~",
        [SCAN_F6] = "[17~",
        [SCAN_F7] = "[18~",
        [SCAN_F8] = "[19~",
        [SCAN_F9] = "[20~",
        [SCAN_F10] = "[21~",
        [SCAN_F11] = "[23~",
        [SCAN_F12] = "[24~",
        /* EFI translates some (but not all) incoming escape sequences
         * via the serial console into equivalent scancodes.  When it
         * doesn't recognise a sequence, it helpfully(!) translates
         * the initial ESC and passes the remainder through verbatim.
         * Treating SCAN_ESC as equivalent to an empty escape sequence
         * works around this bug.
         */
        [SCAN_ESC] = "",
};

Referenced by scancode_to_ansi_seq().

__console_driver

struct console_driver efi_console __console_driver

Initial value:

= {
        .putchar = efi_putchar,
        .getchar = efi_getchar,
        .iskey = efi_iskey,
        .usage = CONSOLE_EFI,
}

EFI console driver.

Definition at line 404 of file efi_console.c.

                                                     {
        .putchar = efi_putchar,
        .getchar = efi_getchar,
        .iskey = efi_iskey,
        .usage = CONSOLE_EFI,
};