iPXE
Data Structures | Macros | Functions | Variables
bios_console.c File Reference
#include <assert.h>
#include <realmode.h>
#include <bios.h>
#include <biosint.h>
#include <ipxe/console.h>
#include <ipxe/ansiesc.h>
#include <ipxe/keys.h>
#include <ipxe/keymap.h>
#include <ipxe/init.h>
#include <config/console.h>

Go to the source code of this file.

Data Structures

struct  bios_key
 A BIOS key. More...
 

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_BLINK   0x80
 
#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_PCBIOS   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )
 
#define bios_inject_lock   __use_text16 ( bios_inject_lock )
 
#define int16_vector   __use_text16 ( int16_vector )
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
static uint8_t __text16 (bios_inject_lock)
 Keypress injection lock. More...
 
static struct segoff __text16 (int16_vector)
 Vector for chaining to other INT 16 handlers. More...
 
void int16_wrapper (void)
 Assembly wrapper. More...
 
static void bios_handle_cup (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[])
 Handle ANSI CUP (cursor position) More...
 
static void bios_handle_ed (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused)
 Handle ANSI ED (erase in page) More...
 
static void bios_handle_sgr (struct ansiesc_context *ctx __unused, unsigned int count, int params[])
 Handle ANSI SGR (set graphics rendition) More...
 
static void bios_handle_dectcem_set (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused)
 Handle ANSI DECTCEM set (show cursor) More...
 
static void bios_handle_dectcem_reset (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused)
 Handle ANSI DECTCEM reset (hide cursor) More...
 
static void bios_putchar (int character)
 Print a character to BIOS console. More...
 
static const char * bios_ansi_seq (unsigned int scancode)
 Get ANSI escape sequence corresponding to BIOS scancode. More...
 
static int bios_keymap (unsigned int character)
 Map a key. More...
 
static int bios_getchar (void)
 Get character from BIOS console. More...
 
static int bios_iskey (void)
 Check for character ready to read from BIOS console. More...
 
static __asmcall void bios_inject (struct i386_all_regs *ix86)
 Inject keypresses. More...
 
static void bios_inject_startup (void)
 Start up keypress injection. More...
 
static void bios_inject_shutdown (int booting __unused)
 Shut down keypress injection. More...
 
struct startup_fn bios_inject_startup_fn __startup_fn (STARTUP_NORMAL)
 Keypress injection startup function. More...
 

Variables

static unsigned int bios_attr = ATTR_DEFAULT
 Current character attribute. More...
 
static struct ansiesc_handler bios_ansiesc_handlers []
 BIOS console ANSI escape sequence handlers. More...
 
static struct ansiesc_context bios_ansiesc_ctx
 BIOS console ANSI escape sequence context. More...
 
static const char * bios_ansi_input = ""
 Pointer to current ANSI output sequence. More...
 
static const struct bios_key bios_keys []
 Mapping from BIOS scan codes to iPXE key codes. More...
 
struct console_driver bios_console __console_driver
 BIOS console. More...
 

Macro Definition Documentation

◆ ATTR_BOLD

#define ATTR_BOLD   0x08

Definition at line 37 of file bios_console.c.

◆ ATTR_FCOL_MASK

#define ATTR_FCOL_MASK   0x07

Definition at line 39 of file bios_console.c.

◆ ATTR_FCOL_BLACK

#define ATTR_FCOL_BLACK   0x00

Definition at line 40 of file bios_console.c.

◆ ATTR_FCOL_BLUE

#define ATTR_FCOL_BLUE   0x01

Definition at line 41 of file bios_console.c.

◆ ATTR_FCOL_GREEN

#define ATTR_FCOL_GREEN   0x02

Definition at line 42 of file bios_console.c.

◆ ATTR_FCOL_CYAN

#define ATTR_FCOL_CYAN   0x03

Definition at line 43 of file bios_console.c.

◆ ATTR_FCOL_RED

#define ATTR_FCOL_RED   0x04

Definition at line 44 of file bios_console.c.

◆ ATTR_FCOL_MAGENTA

#define ATTR_FCOL_MAGENTA   0x05

Definition at line 45 of file bios_console.c.

◆ ATTR_FCOL_YELLOW

#define ATTR_FCOL_YELLOW   0x06

Definition at line 46 of file bios_console.c.

◆ ATTR_FCOL_WHITE

#define ATTR_FCOL_WHITE   0x07

Definition at line 47 of file bios_console.c.

◆ ATTR_BLINK

#define ATTR_BLINK   0x80

Definition at line 49 of file bios_console.c.

◆ ATTR_BCOL_MASK

#define ATTR_BCOL_MASK   0x70

Definition at line 51 of file bios_console.c.

◆ ATTR_BCOL_BLACK

#define ATTR_BCOL_BLACK   0x00

Definition at line 52 of file bios_console.c.

◆ ATTR_BCOL_BLUE

#define ATTR_BCOL_BLUE   0x10

Definition at line 53 of file bios_console.c.

◆ ATTR_BCOL_GREEN

#define ATTR_BCOL_GREEN   0x20

Definition at line 54 of file bios_console.c.

◆ ATTR_BCOL_CYAN

#define ATTR_BCOL_CYAN   0x30

Definition at line 55 of file bios_console.c.

◆ ATTR_BCOL_RED

#define ATTR_BCOL_RED   0x40

Definition at line 56 of file bios_console.c.

◆ ATTR_BCOL_MAGENTA

#define ATTR_BCOL_MAGENTA   0x50

Definition at line 57 of file bios_console.c.

◆ ATTR_BCOL_YELLOW

#define ATTR_BCOL_YELLOW   0x60

Definition at line 58 of file bios_console.c.

◆ ATTR_BCOL_WHITE

#define ATTR_BCOL_WHITE   0x70

Definition at line 59 of file bios_console.c.

◆ ATTR_DEFAULT

#define ATTR_DEFAULT   ATTR_FCOL_WHITE

Definition at line 61 of file bios_console.c.

◆ CONSOLE_PCBIOS

#define CONSOLE_PCBIOS   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )

Definition at line 66 of file bios_console.c.

◆ bios_inject_lock

#define bios_inject_lock   __use_text16 ( bios_inject_lock )

Definition at line 74 of file bios_console.c.

◆ int16_vector

#define int16_vector   __use_text16 ( int16_vector )

Definition at line 78 of file bios_console.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ __text16() [1/2]

static uint8_t __text16 ( bios_inject_lock  )
static

Keypress injection lock.

◆ __text16() [2/2]

static struct segoff __text16 ( int16_vector  )
static

Vector for chaining to other INT 16 handlers.

◆ int16_wrapper()

void int16_wrapper ( void  )

Assembly wrapper.

Referenced by bios_inject_shutdown(), and bios_inject_startup().

◆ bios_handle_cup()

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

Handle ANSI CUP (cursor position)

Parameters
ctxANSI escape sequence context
countParameter count
params[0]Row (1 is top)
params[1]Column (1 is left)

Definition at line 91 of file bios_console.c.

92  {
93  int cx = ( params[1] - 1 );
94  int cy = ( params[0] - 1 );
95 
96  if ( cx < 0 )
97  cx = 0;
98  if ( cy < 0 )
99  cy = 0;
100 
101  __asm__ __volatile__ ( REAL_CODE ( "int $0x10\n\t" )
102  : : "a" ( 0x0200 ), "b" ( 1 ),
103  "d" ( ( cy << 8 ) | cx ) );
104 }
uint16_t cx
Definition: registers.h:51
__asm__ __volatile__("\n1:\n\t" "movb -1(%2,%1), %%al\n\t" "stosb\n\t" "loop 1b\n\t" "xorl %%eax, %%eax\n\t" "mov %3, %1\n\t" "rep stosb\n\t" :"=&D"(discard_D), "=&c"(discard_c) :"r"(data), "g"(pad_len), "0"(value0), "1"(len) :"eax")
__asm__(".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
#define REAL_CODE(asm_code_str)
Definition: libkir.h:226

References __asm__(), __volatile__(), cx, and REAL_CODE.

◆ bios_handle_ed()

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

Handle ANSI ED (erase in page)

Parameters
ctxANSI escape sequence context
countParameter count
params[0]Region to erase

Definition at line 113 of file bios_console.c.

115  {
116  /* We assume that we always clear the whole screen */
117  assert ( params[0] == ANSIESC_ED_ALL );
118 
119  __asm__ __volatile__ ( REAL_CODE ( "int $0x10\n\t" )
120  : : "a" ( 0x0600 ), "b" ( bios_attr << 8 ),
121  "c" ( 0 ),
122  "d" ( ( ( console_height - 1 ) << 8 ) |
123  ( console_width - 1 ) ) );
124 }
unsigned int console_height
Console height.
Definition: console.c:17
static unsigned int bios_attr
Current character attribute.
Definition: bios_console.c:70
#define ANSIESC_ED_ALL
Erase whole page.
Definition: ansiesc.h:115
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
__asm__ __volatile__("\n1:\n\t" "movb -1(%2,%1), %%al\n\t" "stosb\n\t" "loop 1b\n\t" "xorl %%eax, %%eax\n\t" "mov %3, %1\n\t" "rep stosb\n\t" :"=&D"(discard_D), "=&c"(discard_c) :"r"(data), "g"(pad_len), "0"(value0), "1"(len) :"eax")
__asm__(".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
#define REAL_CODE(asm_code_str)
Definition: libkir.h:226
unsigned int console_width
Console width.
Definition: console.c:14

References __asm__(), __volatile__(), ANSIESC_ED_ALL, assert(), bios_attr, console_height, console_width, and REAL_CODE.

◆ bios_handle_sgr()

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

Handle ANSI SGR (set graphics rendition)

Parameters
ctxANSI escape sequence context
countParameter count
paramsList of graphic rendition aspects

Definition at line 133 of file bios_console.c.

134  {
135  static const uint8_t bios_attr_fcols[10] = {
139  ATTR_FCOL_WHITE, ATTR_FCOL_WHITE /* defaults */
140  };
141  static const uint8_t bios_attr_bcols[10] = {
145  ATTR_BCOL_BLACK, ATTR_BCOL_BLACK /* defaults */
146  };
147  unsigned int i;
148  int aspect;
149 
150  for ( i = 0 ; i < count ; i++ ) {
151  aspect = params[i];
152  if ( aspect == 0 ) {
154  } else if ( aspect == 1 ) {
155  bios_attr |= ATTR_BOLD;
156  } else if ( aspect == 5 ) {
158  } else if ( aspect == 22 ) {
159  bios_attr &= ~ATTR_BOLD;
160  } else if ( aspect == 25 ) {
161  bios_attr &= ~ATTR_BLINK;
162  } else if ( ( aspect >= 30 ) && ( aspect <= 39 ) ) {
164  bios_attr |= bios_attr_fcols[ aspect - 30 ];
165  } else if ( ( aspect >= 40 ) && ( aspect <= 49 ) ) {
167  bios_attr |= bios_attr_bcols[ aspect - 40 ];
168  }
169  }
170 }
#define ATTR_FCOL_BLACK
Definition: bios_console.c:40
#define ATTR_FCOL_RED
Definition: bios_console.c:44
#define ATTR_BCOL_MASK
Definition: bios_console.c:51
#define ATTR_BOLD
Definition: bios_console.c:37
#define ATTR_BCOL_YELLOW
Definition: bios_console.c:58
#define ATTR_BCOL_WHITE
Definition: bios_console.c:59
#define ATTR_BCOL_GREEN
Definition: bios_console.c:54
static unsigned int bios_attr
Current character attribute.
Definition: bios_console.c:70
#define ATTR_FCOL_GREEN
Definition: bios_console.c:42
#define ATTR_BLINK
Definition: bios_console.c:49
#define ATTR_BCOL_BLACK
Definition: bios_console.c:52
#define ATTR_DEFAULT
Definition: bios_console.c:61
#define ATTR_BCOL_MAGENTA
Definition: bios_console.c:57
#define ATTR_FCOL_MASK
Definition: bios_console.c:39
#define ATTR_BCOL_CYAN
Definition: bios_console.c:55
unsigned char uint8_t
Definition: stdint.h:10
#define ATTR_FCOL_BLUE
Definition: bios_console.c:41
#define ATTR_BCOL_BLUE
Definition: bios_console.c:53
#define ATTR_FCOL_MAGENTA
Definition: bios_console.c:45
#define ATTR_FCOL_YELLOW
Definition: bios_console.c:46
uint16_t count
Number of entries.
Definition: ena.h:22
#define ATTR_BCOL_RED
Definition: bios_console.c:56
#define ATTR_FCOL_WHITE
Definition: bios_console.c:47
#define ATTR_FCOL_CYAN
Definition: bios_console.c:43

References 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_BLINK, 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, bios_attr, and count.

◆ bios_handle_dectcem_set()

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

Handle ANSI DECTCEM set (show cursor)

Parameters
ctxANSI escape sequence context
countParameter count
paramsList of graphic rendition aspects

Definition at line 179 of file bios_console.c.

181  {
182  uint8_t height;
183 
184  /* Get character height */
185  get_real ( height, BDA_SEG, BDA_CHAR_HEIGHT );
186 
187  __asm__ __volatile__ ( REAL_CODE ( "int $0x10\n\t" )
188  : : "a" ( 0x0100 ),
189  "c" ( ( ( height - 2 ) << 8 ) |
190  ( height - 1 ) ) );
191 }
#define get_real
Definition: libkir.h:151
#define BDA_CHAR_HEIGHT
Definition: bios.h:15
unsigned char uint8_t
Definition: stdint.h:10
#define BDA_SEG
Definition: bios.h:6
__asm__ __volatile__("\n1:\n\t" "movb -1(%2,%1), %%al\n\t" "stosb\n\t" "loop 1b\n\t" "xorl %%eax, %%eax\n\t" "mov %3, %1\n\t" "rep stosb\n\t" :"=&D"(discard_D), "=&c"(discard_c) :"r"(data), "g"(pad_len), "0"(value0), "1"(len) :"eax")
__asm__(".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
#define REAL_CODE(asm_code_str)
Definition: libkir.h:226

References __asm__(), __volatile__(), BDA_CHAR_HEIGHT, BDA_SEG, get_real, and REAL_CODE.

◆ bios_handle_dectcem_reset()

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

Handle ANSI DECTCEM reset (hide cursor)

Parameters
ctxANSI escape sequence context
countParameter count
paramsList of graphic rendition aspects

Definition at line 200 of file bios_console.c.

202  {
203 
204  __asm__ __volatile__ ( REAL_CODE ( "int $0x10\n\t" )
205  : : "a" ( 0x0100 ), "c" ( 0x2000 ) );
206 }
__asm__ __volatile__("\n1:\n\t" "movb -1(%2,%1), %%al\n\t" "stosb\n\t" "loop 1b\n\t" "xorl %%eax, %%eax\n\t" "mov %3, %1\n\t" "rep stosb\n\t" :"=&D"(discard_D), "=&c"(discard_c) :"r"(data), "g"(pad_len), "0"(value0), "1"(len) :"eax")
__asm__(".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
#define REAL_CODE(asm_code_str)
Definition: libkir.h:226

References __asm__(), __volatile__(), and REAL_CODE.

◆ bios_putchar()

static void bios_putchar ( int  character)
static

Print a character to BIOS console.

Parameters
characterCharacter to be printed

Definition at line 228 of file bios_console.c.

228  {
229  int discard_a, discard_b, discard_c;
230 
231  /* Intercept ANSI escape sequences */
232  character = ansiesc_process ( &bios_ansiesc_ctx, character );
233  if ( character < 0 )
234  return;
235 
236  /* Print character with attribute */
237  __asm__ __volatile__ ( REAL_CODE ( "pushl %%ebp\n\t" /* gcc bug */
238  /* Skip non-printable characters */
239  "cmpb $0x20, %%al\n\t"
240  "jb 1f\n\t"
241  /* Read attribute */
242  "movb %%al, %%cl\n\t"
243  "movb $0x08, %%ah\n\t"
244  "int $0x10\n\t"
245  "xchgb %%al, %%cl\n\t"
246  /* Skip if attribute matches */
247  "cmpb %%ah, %%bl\n\t"
248  "je 1f\n\t"
249  /* Set attribute */
250  "movw $0x0001, %%cx\n\t"
251  "movb $0x09, %%ah\n\t"
252  "int $0x10\n\t"
253  "\n1:\n\t"
254  /* Print character */
255  "xorw %%bx, %%bx\n\t"
256  "movb $0x0e, %%ah\n\t"
257  "int $0x10\n\t"
258  "popl %%ebp\n\t" /* gcc bug */ )
259  : "=a" ( discard_a ), "=b" ( discard_b ),
260  "=c" ( discard_c )
261  : "a" ( character ), "b" ( bios_attr ) );
262 }
static unsigned int bios_attr
Current character attribute.
Definition: bios_console.c:70
int ansiesc_process(struct ansiesc_context *ctx, int c)
Process character that may be part of ANSI escape sequence.
Definition: ansiesc.c:74
static struct ansiesc_context bios_ansiesc_ctx
BIOS console ANSI escape sequence context.
Definition: bios_console.c:219
__asm__ __volatile__("\n1:\n\t" "movb -1(%2,%1), %%al\n\t" "stosb\n\t" "loop 1b\n\t" "xorl %%eax, %%eax\n\t" "mov %3, %1\n\t" "rep stosb\n\t" :"=&D"(discard_D), "=&c"(discard_c) :"r"(data), "g"(pad_len), "0"(value0), "1"(len) :"eax")
__asm__(".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
long discard_c
Definition: bigint.h:30
#define REAL_CODE(asm_code_str)
Definition: libkir.h:226

References __asm__(), __volatile__(), ansiesc_process(), bios_ansiesc_ctx, bios_attr, discard_c, and REAL_CODE.

◆ bios_ansi_seq()

static const char* bios_ansi_seq ( unsigned int  scancode)
static

Get ANSI escape sequence corresponding to BIOS scancode.

Parameters
scancodeBIOS scancode
Return values
ansi_seqANSI escape sequence, if any, otherwise NULL

Definition at line 309 of file bios_console.c.

309  {
310  static char buf[ 5 /* "[" + two digits + terminator + NUL */ ];
311  unsigned int key;
312  unsigned int terminator;
313  unsigned int n;
314  unsigned int i;
315  char *tmp = buf;
316 
317  /* Construct ANSI escape sequence for scancode, if known */
318  for ( i = 0 ; i < ( sizeof ( bios_keys ) /
319  sizeof ( bios_keys[0] ) ) ; i++ ) {
320 
321  /* Look for matching scancode */
322  if ( bios_keys[i].scancode != scancode )
323  continue;
324 
325  /* Construct escape sequence */
326  key = bios_keys[i].key;
327  n = KEY_ANSI_N ( key );
329  *(tmp++) = '[';
330  if ( n )
331  tmp += sprintf ( tmp, "%d", n );
332  *(tmp++) = terminator;
333  *(tmp++) = '\0';
334  assert ( tmp <= &buf[ sizeof ( buf ) ] );
335  return buf;
336  }
337 
338  DBG ( "Unrecognised BIOS scancode %02x\n", scancode );
339  return NULL;
340 }
#define sprintf(buf, fmt,...)
Write a formatted string to a buffer.
Definition: stdio.h:36
#define KEY_ANSI_TERMINATOR(key)
Definition: keys.h:62
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
uint16_t key
Key code.
Definition: bios_console.c:279
uint8_t * tmp
Definition: entropy.h:156
#define KEY_ANSI_N(key)
Definition: keys.h:61
unsigned int n
Definition: entropy.h:159
#define DBG(...)
Print a debugging message.
Definition: compiler.h:498
struct eth_slow_terminator_tlv terminator
Terminator.
Definition: eth_slow.h:20
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
union @375 key
Sense key.
Definition: scsi.h:18
static const struct bios_key bios_keys[]
Mapping from BIOS scan codes to iPXE key codes.
Definition: bios_console.c:283

References assert(), bios_keys, DBG, key, bios_key::key, KEY_ANSI_N, KEY_ANSI_TERMINATOR, n, NULL, bios_key::scancode, sprintf, terminator, and tmp.

Referenced by bios_getchar().

◆ bios_keymap()

static int bios_keymap ( unsigned int  character)
static

Map a key.

Parameters
characterCharacter read from console
Return values
characterMapped character

Definition at line 348 of file bios_console.c.

348  {
349  struct key_mapping *mapping;
350 
351  for_each_table_entry ( mapping, KEYMAP ) {
352  if ( mapping->from == character )
353  return mapping->to;
354  }
355  return character;
356 }
#define KEYMAP
Keyboard mapping table.
Definition: keymap.h:25
uint8_t from
Character read from keyboard.
Definition: keymap.h:19
A keyboard mapping.
Definition: keymap.h:17
uint8_t to
Character to be used instead.
Definition: keymap.h:21
#define for_each_table_entry(pointer, table)
Iterate through all entries within a linker table.
Definition: tables.h:358

References for_each_table_entry, key_mapping::from, KEYMAP, and key_mapping::to.

Referenced by bios_getchar().

◆ bios_getchar()

static int bios_getchar ( void  )
static

Get character from BIOS console.

Return values
characterCharacter read from console

Definition at line 363 of file bios_console.c.

363  {
364  uint16_t keypress;
365  unsigned int character;
366  const char *ansi_seq;
367 
368  /* If we are mid-sequence, pass out the next byte */
369  if ( ( character = *bios_ansi_input ) ) {
370  bios_ansi_input++;
371  return character;
372  }
373 
374  /* Do nothing if injection is in progress */
375  if ( bios_inject_lock )
376  return 0;
377 
378  /* Read character from real BIOS console */
380  __asm__ __volatile__ ( REAL_CODE ( "sti\n\t"
381  "int $0x16\n\t"
382  "cli\n\t" )
383  : "=a" ( keypress )
384  : "a" ( 0x1000 ), "m" ( bios_inject_lock ) );
386  character = ( keypress & 0xff );
387 
388  /* If it's a normal character, just map and return it */
389  if ( character && ( character < 0x80 ) )
390  return bios_keymap ( character );
391 
392  /* Otherwise, check for a special key that we know about */
393  if ( ( ansi_seq = bios_ansi_seq ( keypress >> 8 ) ) ) {
394  /* Start of escape sequence: return ESC (0x1b) */
395  bios_ansi_input = ansi_seq;
396  return 0x1b;
397  }
398 
399  return 0;
400 }
unsigned short uint16_t
Definition: stdint.h:11
static const char * bios_ansi_input
Pointer to current ANSI output sequence.
Definition: bios_console.c:272
static const char * bios_ansi_seq(unsigned int scancode)
Get ANSI escape sequence corresponding to BIOS scancode.
Definition: bios_console.c:309
static int bios_keymap(unsigned int character)
Map a key.
Definition: bios_console.c:348
#define bios_inject_lock
Definition: bios_console.c:74
__asm__ __volatile__("\n1:\n\t" "movb -1(%2,%1), %%al\n\t" "stosb\n\t" "loop 1b\n\t" "xorl %%eax, %%eax\n\t" "mov %3, %1\n\t" "rep stosb\n\t" :"=&D"(discard_D), "=&c"(discard_c) :"r"(data), "g"(pad_len), "0"(value0), "1"(len) :"eax")
__asm__(".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
#define REAL_CODE(asm_code_str)
Definition: libkir.h:226

References __asm__(), __volatile__(), bios_ansi_input, bios_ansi_seq(), bios_inject_lock, bios_keymap(), and REAL_CODE.

◆ bios_iskey()

static int bios_iskey ( void  )
static

Check for character ready to read from BIOS console.

Return values
TrueCharacter available to read
FalseNo character available to read

Definition at line 408 of file bios_console.c.

408  {
409  unsigned int discard_a;
410  unsigned int flags;
411 
412  /* If we are mid-sequence, we are always ready */
413  if ( *bios_ansi_input )
414  return 1;
415 
416  /* Do nothing if injection is in progress */
417  if ( bios_inject_lock )
418  return 0;
419 
420  /* Otherwise check the real BIOS console */
422  __asm__ __volatile__ ( REAL_CODE ( "sti\n\t"
423  "int $0x16\n\t"
424  "pushfw\n\t"
425  "popw %w0\n\t"
426  "cli\n\t" )
427  : "=R" ( flags ), "=a" ( discard_a )
428  : "a" ( 0x1100 ), "m" ( bios_inject_lock ) );
430  return ( ! ( flags & ZF ) );
431 }
static const char * bios_ansi_input
Pointer to current ANSI output sequence.
Definition: bios_console.c:272
#define ZF
Definition: registers.h:184
#define bios_inject_lock
Definition: bios_console.c:74
__asm__ __volatile__("\n1:\n\t" "movb -1(%2,%1), %%al\n\t" "stosb\n\t" "loop 1b\n\t" "xorl %%eax, %%eax\n\t" "mov %3, %1\n\t" "rep stosb\n\t" :"=&D"(discard_D), "=&c"(discard_c) :"r"(data), "g"(pad_len), "0"(value0), "1"(len) :"eax")
__asm__(".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
#define REAL_CODE(asm_code_str)
Definition: libkir.h:226
uint8_t flags
Flags.
Definition: ena.h:18

References __asm__(), __volatile__(), bios_ansi_input, bios_inject_lock, flags, REAL_CODE, and ZF.

◆ bios_inject()

static __asmcall void bios_inject ( struct i386_all_regs ix86)
static

Inject keypresses.

Parameters
ix86Registers as passed to INT 16

Definition at line 446 of file bios_console.c.

446  {
447  unsigned int discard_a;
448  unsigned int scancode;
449  unsigned int i;
450  uint16_t keypress;
451  int key;
452 
453  /* If this is a blocking call, then loop until the
454  * non-blocking variant of the call indicates that a keypress
455  * is available. Do this without acquiring the injection
456  * lock, so that injection may take place.
457  */
458  if ( ( ix86->regs.ah & ~0x10 ) == 0x00 ) {
459  __asm__ __volatile__ ( REAL_CODE ( "sti\n\t"
460  "\n1:\n\t"
461  "pushw %%ax\n\t"
462  "int $0x16\n\t"
463  "popw %%ax\n\t"
464  "jc 2f\n\t"
465  "jz 1b\n\t"
466  "\n2:\n\t"
467  "cli\n\t" )
468  : "=a" ( discard_a )
469  : "a" ( ix86->regs.eax | 0x0100 ),
470  "m" ( bios_inject_lock ) );
471  }
472 
473  /* Acquire injection lock */
475 
476  /* Check for keypresses */
477  if ( iskey() ) {
478 
479  /* Get key */
480  key = getkey ( 0 );
481 
482  /* Reverse internal CR->LF mapping */
483  if ( key == '\n' )
484  key = '\r';
485 
486  /* Convert to keypress */
487  keypress = ( ( key << 8 ) | key );
488 
489  /* Handle special keys */
490  if ( key >= KEY_MIN ) {
491  for ( i = 0 ; i < ( sizeof ( bios_keys ) /
492  sizeof ( bios_keys[0] ) ) ; i++ ) {
493  if ( bios_keys[i].key == key ) {
494  scancode = bios_keys[i].scancode;
495  keypress = ( scancode << 8 );
496  break;
497  }
498  }
499  }
500 
501  /* Inject keypress */
502  DBGC ( &bios_console, "BIOS injecting keypress %04x\n",
503  keypress );
504  __asm__ __volatile__ ( REAL_CODE ( "int $0x16\n\t" )
505  : "=a" ( discard_a )
506  : "a" ( 0x0500 ), "c" ( keypress ),
507  "m" ( bios_inject_lock ) );
508  }
509 
510  /* Release injection lock */
512 }
int getkey(unsigned long timeout)
Get single keypress.
Definition: getkey.c:71
unsigned short uint16_t
Definition: stdint.h:11
uint8_t scancode
Scancode.
Definition: bios_console.c:277
#define DBGC(...)
Definition: compiler.h:505
uint32_t eax
Definition: registers.h:109
#define KEY_MIN
Definition: keys.h:64
struct i386_regs regs
Definition: registers.h:176
struct console_driver bios_console
Definition: vesafb.c:45
uint8_t ah
Definition: registers.h:106
#define bios_inject_lock
Definition: bios_console.c:74
__asm__ __volatile__("\n1:\n\t" "movb -1(%2,%1), %%al\n\t" "stosb\n\t" "loop 1b\n\t" "xorl %%eax, %%eax\n\t" "mov %3, %1\n\t" "rep stosb\n\t" :"=&D"(discard_D), "=&c"(discard_c) :"r"(data), "g"(pad_len), "0"(value0), "1"(len) :"eax")
__asm__(".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
#define REAL_CODE(asm_code_str)
Definition: libkir.h:226
int iskey(void)
Check for available input on any console.
Definition: console.c:127
union @375 key
Sense key.
Definition: scsi.h:18
static const struct bios_key bios_keys[]
Mapping from BIOS scan codes to iPXE key codes.
Definition: bios_console.c:283

References __asm__(), __volatile__(), i386_regs::ah, bios_console, bios_inject_lock, bios_keys, DBGC, i386_regs::eax, getkey(), iskey(), key, KEY_MIN, REAL_CODE, i386_all_regs::regs, and bios_key::scancode.

Referenced by bios_inject_startup().

◆ bios_inject_startup()

static void bios_inject_startup ( void  )
static

Start up keypress injection.

Definition at line 518 of file bios_console.c.

518  {
519 
520  /* Assembly wrapper to call bios_inject() */
522  TEXT16_CODE ( "\nint16_wrapper:\n\t"
523  "pushfw\n\t"
524  "cmpb $0, %%cs:bios_inject_lock\n\t"
525  "jnz 1f\n\t"
527  "\n1:\n\t"
528  "popfw\n\t"
529  "ljmp *%%cs:int16_vector\n\t" ) : );
530 
531  /* Hook INT 16 */
533  &int16_vector );
534 }
#define VIRT_CALL(function)
Call C function from real-mode code.
Definition: librm.h:78
unsigned long intptr_t
Definition: stdint.h:21
void hook_bios_interrupt(unsigned int interrupt, unsigned int handler, struct segoff *chain_vector)
Hook INT vector.
Definition: biosint.c:24
static __asmcall void bios_inject(struct i386_all_regs *ix86)
Inject keypresses.
Definition: bios_console.c:446
__asm__ __volatile__("\n1:\n\t" "movb -1(%2,%1), %%al\n\t" "stosb\n\t" "loop 1b\n\t" "xorl %%eax, %%eax\n\t" "mov %3, %1\n\t" "rep stosb\n\t" :"=&D"(discard_D), "=&c"(discard_c) :"r"(data), "g"(pad_len), "0"(value0), "1"(len) :"eax")
__asm__(".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
void int16_wrapper(void)
Assembly wrapper.
#define int16_vector
Definition: bios_console.c:78
#define TEXT16_CODE(asm_code_str)
Definition: libkir.h:217

References __asm__(), __volatile__(), bios_inject(), hook_bios_interrupt(), int16_vector, int16_wrapper(), TEXT16_CODE, and VIRT_CALL.

◆ bios_inject_shutdown()

static void bios_inject_shutdown ( int booting  __unused)
static

Shut down keypress injection.

Parameters
bootingSystem is shutting down for OS boot

Definition at line 541 of file bios_console.c.

541  {
542 
543  /* Unhook INT 16 */
545  &int16_vector );
546 }
unsigned long intptr_t
Definition: stdint.h:21
int unhook_bios_interrupt(unsigned int interrupt, unsigned int handler, struct segoff *chain_vector)
Unhook INT vector.
Definition: biosint.c:69
void int16_wrapper(void)
Assembly wrapper.
#define int16_vector
Definition: bios_console.c:78

References int16_vector, int16_wrapper(), and unhook_bios_interrupt().

◆ __startup_fn()

struct startup_fn bios_inject_startup_fn __startup_fn ( STARTUP_NORMAL  )

Keypress injection startup function.

Variable Documentation

◆ bios_attr

unsigned int bios_attr = ATTR_DEFAULT
static

Current character attribute.

Definition at line 70 of file bios_console.c.

Referenced by bios_handle_ed(), bios_handle_sgr(), and bios_putchar().

◆ bios_ansiesc_handlers

struct ansiesc_handler bios_ansiesc_handlers[]
static
Initial value:
= {
{ 0, NULL }
}
static void bios_handle_ed(struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused)
Handle ANSI ED (erase in page)
Definition: bios_console.c:113
#define ANSIESC_ED
Erase in page.
Definition: ansiesc.h:106
#define ANSIESC_CUP
Cursor position.
Definition: ansiesc.h:103
#define ANSIESC_SGR
Select graphic rendition.
Definition: ansiesc.h:118
static void bios_handle_dectcem_set(struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused)
Handle ANSI DECTCEM set (show cursor)
Definition: bios_console.c:179
static void bios_handle_dectcem_reset(struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[] __unused)
Handle ANSI DECTCEM reset (hide cursor)
Definition: bios_console.c:200
#define ANSIESC_DECTCEM_RESET
Hide cursor.
Definition: ansiesc.h:131
#define ANSIESC_DECTCEM_SET
Show cursor.
Definition: ansiesc.h:128
static void bios_handle_sgr(struct ansiesc_context *ctx __unused, unsigned int count, int params[])
Handle ANSI SGR (set graphics rendition)
Definition: bios_console.c:133
static void bios_handle_cup(struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[])
Handle ANSI CUP (cursor position)
Definition: bios_console.c:91
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

BIOS console ANSI escape sequence handlers.

Definition at line 209 of file bios_console.c.

◆ bios_ansiesc_ctx

struct ansiesc_context bios_ansiesc_ctx
static
Initial value:
= {
.handlers = bios_ansiesc_handlers,
}
static struct ansiesc_handler bios_ansiesc_handlers[]
BIOS console ANSI escape sequence handlers.
Definition: bios_console.c:209

BIOS console ANSI escape sequence context.

Definition at line 219 of file bios_console.c.

Referenced by bios_putchar().

◆ bios_ansi_input

const char* bios_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 272 of file bios_console.c.

Referenced by bios_getchar(), and bios_iskey().

◆ bios_keys

const struct bios_key bios_keys[]
static
Initial value:
= {
{ 0x53, KEY_DC },
{ 0x48, KEY_UP },
{ 0x50, KEY_DOWN },
{ 0x4b, KEY_LEFT },
{ 0x4d, KEY_RIGHT },
{ 0x47, KEY_HOME },
{ 0x4f, KEY_END },
{ 0x49, KEY_PPAGE },
{ 0x51, KEY_NPAGE },
{ 0x3f, KEY_F5 },
{ 0x40, KEY_F6 },
{ 0x41, KEY_F7 },
{ 0x42, KEY_F8 },
{ 0x43, KEY_F9 },
{ 0x44, KEY_F10 },
{ 0x85, KEY_F11 },
{ 0x86, KEY_F12 },
}
#define KEY_F6
F6.
Definition: keys.h:76
#define KEY_F11
F11.
Definition: keys.h:81
#define KEY_F12
F12.
Definition: keys.h:82
#define KEY_F8
F8 (for PXE)
Definition: keys.h:78
#define KEY_NPAGE
Page down.
Definition: keys.h:74
#define KEY_HOME
Home.
Definition: keys.h:70
#define KEY_F9
F9.
Definition: keys.h:79
#define KEY_DOWN
Down arrow.
Definition: keys.h:66
#define KEY_UP
Up arrow.
Definition: keys.h:65
#define KEY_PPAGE
Page up.
Definition: keys.h:73
#define KEY_END
End.
Definition: keys.h:69
#define KEY_DC
Delete.
Definition: keys.h:72
#define KEY_F10
F10.
Definition: keys.h:80
#define KEY_RIGHT
Right arrow.
Definition: keys.h:67
#define KEY_F7
F7.
Definition: keys.h:77
#define KEY_LEFT
Left arrow.
Definition: keys.h:68
#define KEY_F5
F5.
Definition: keys.h:75

Mapping from BIOS scan codes to iPXE key codes.

Definition at line 283 of file bios_console.c.

Referenced by bios_ansi_seq(), and bios_inject().

◆ __console_driver

struct console_driver bios_console __console_driver
Initial value:
= {
.putchar = bios_putchar,
.getchar = bios_getchar,
.iskey = bios_iskey,
.usage = CONSOLE_PCBIOS,
}
#define CONSOLE_PCBIOS
Definition: bios_console.c:66
static int bios_getchar(void)
Get character from BIOS console.
Definition: bios_console.c:363
static void bios_putchar(int character)
Print a character to BIOS console.
Definition: bios_console.c:228
static int bios_iskey(void)
Check for character ready to read from BIOS console.
Definition: bios_console.c:408

BIOS console.

Definition at line 434 of file bios_console.c.