console_driver Struct Reference

A console driver. More...

#include <console.h>

Data Fields
int	disabled
	Console disabled flags.
void(*	putchar )(int character)
	Write a character to the console.
int(*	getchar )(void)
	Read a character from the console.
int(*	iskey )(void)
	Check for available input.
int(*	configure )(struct console_configuration *config)
	Configure console.
int	usage
	Console usage bitmask.

Detailed Description

A console driver.

Defines the functions that implement a particular console type. Must be made part of the console drivers table by using __console_driver.

Note

Consoles that cannot be used before their initialisation function has completed should set disabled initially. This allows other console devices to still be used to print out early debugging messages.

Definition at line 56 of file console.h.

Field Documentation

disabled

int console_driver::disabled

Console disabled flags.

This is the bitwise OR of zero or more console disabled flags.

Definition at line 63 of file console.h.

Referenced by has_input(), and putchar().

putchar

void(* console_driver::putchar) (int character)

Write a character to the console.

Parameters

character

Character to be written

Definition at line 69 of file console.h.

Referenced by putchar().

getchar

int(* console_driver::getchar) (void)

Read a character from the console.

Return values

character

Character read

If no character is available to be read, this method will block. The character read should not be echoed back to the console.

Definition at line 79 of file console.h.

Referenced by getchar().

iskey

int(* console_driver::iskey) (void)

Check for available input.

Return values

is_available

Input is available

This should return true if a subsequent call to getchar() will not block.

Definition at line 88 of file console.h.

Referenced by has_input().

configure

int(* console_driver::configure) (struct console_configuration *config)

Configure console.

Parameters

config

Console configuration, or NULL to reset

Return values

rc	Return status code

Definition at line 95 of file console.h.

Referenced by console_configure().

usage

int console_driver::usage

Console usage bitmask.

This is the bitwise OR of zero or more CONSOLE_USAGE_XXX values.

Definition at line 102 of file console.h.

Referenced by putchar().

---

The documentation for this struct was generated from the following file:

• include/ipxe/console.h