Simple Text Input protocol from the UEFI 2.0 specification. More...

Data Structures
struct	EFI_INPUT_KEY
	The keystroke information for the key that was pressed. More...

struct	_EFI_SIMPLE_TEXT_INPUT_PROTOCOL
	The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device. More...

Macros
#define	EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID

#define	SIMPLE_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
	Protocol GUID name defined in EFI1.1. More...

#define	CHAR_BACKSPACE 0x0008

#define	CHAR_TAB 0x0009

#define	CHAR_LINEFEED 0x000A

#define	CHAR_CARRIAGE_RETURN 0x000D

#define	SCAN_NULL 0x0000

#define	SCAN_UP 0x0001

#define	SCAN_DOWN 0x0002

#define	SCAN_RIGHT 0x0003

#define	SCAN_LEFT 0x0004

#define	SCAN_HOME 0x0005

#define	SCAN_END 0x0006

#define	SCAN_INSERT 0x0007

#define	SCAN_DELETE 0x0008

#define	SCAN_PAGE_UP 0x0009

#define	SCAN_PAGE_DOWN 0x000A

#define	SCAN_F1 0x000B

#define	SCAN_F2 0x000C

#define	SCAN_F3 0x000D

#define	SCAN_F4 0x000E

#define	SCAN_F5 0x000F

#define	SCAN_F6 0x0010

#define	SCAN_F7 0x0011

#define	SCAN_F8 0x0012

#define	SCAN_F9 0x0013

#define	SCAN_F10 0x0014

#define	SCAN_ESC 0x0017

Typedefs
typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL	EFI_SIMPLE_TEXT_INPUT_PROTOCOL

typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL	SIMPLE_INPUT_INTERFACE
	Protocol name in EFI1.1 for backward-compatible. More...

typedef EFI_STATUS(EFIAPI *	EFI_INPUT_RESET) (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
	Reset the input device and optionally run diagnostics. More...

typedef EFI_STATUS(EFIAPI *	EFI_INPUT_READ_KEY) (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL This, OUT EFI_INPUT_KEY Key)
	Reads the next keystroke from the input device. More...

Functions
	FILE_LICENCE (BSD2_PATENT)

Variables
EFI_GUID	gEfiSimpleTextInProtocolGuid

Detailed Description

Simple Text Input protocol from the UEFI 2.0 specification.

Abstraction of a very simple input device like a keyboard or serial terminal.

Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SimpleTextIn.h.

Macro Definition Documentation

◆ EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID

#define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID

Value:

{ \
    0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  }

Definition at line 17 of file SimpleTextIn.h.

◆ SIMPLE_INPUT_PROTOCOL

#define SIMPLE_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID

Protocol GUID name defined in EFI1.1.

Definition at line 27 of file SimpleTextIn.h.

◆ CHAR_BACKSPACE

#define CHAR_BACKSPACE 0x0008

Definition at line 45 of file SimpleTextIn.h.

◆ CHAR_TAB

#define CHAR_TAB 0x0009

Definition at line 46 of file SimpleTextIn.h.

◆ CHAR_LINEFEED

#define CHAR_LINEFEED 0x000A

Definition at line 47 of file SimpleTextIn.h.

◆ CHAR_CARRIAGE_RETURN

#define CHAR_CARRIAGE_RETURN 0x000D

Definition at line 48 of file SimpleTextIn.h.

◆ SCAN_NULL

#define SCAN_NULL 0x0000

Definition at line 53 of file SimpleTextIn.h.

◆ SCAN_UP

#define SCAN_UP 0x0001

Definition at line 54 of file SimpleTextIn.h.

◆ SCAN_DOWN

#define SCAN_DOWN 0x0002

Definition at line 55 of file SimpleTextIn.h.

◆ SCAN_RIGHT

#define SCAN_RIGHT 0x0003

Definition at line 56 of file SimpleTextIn.h.

◆ SCAN_LEFT

#define SCAN_LEFT 0x0004

Definition at line 57 of file SimpleTextIn.h.

◆ SCAN_HOME

#define SCAN_HOME 0x0005

Definition at line 58 of file SimpleTextIn.h.

◆ SCAN_END

#define SCAN_END 0x0006

Definition at line 59 of file SimpleTextIn.h.

◆ SCAN_INSERT

#define SCAN_INSERT 0x0007

Definition at line 60 of file SimpleTextIn.h.

◆ SCAN_DELETE

#define SCAN_DELETE 0x0008

Definition at line 61 of file SimpleTextIn.h.

◆ SCAN_PAGE_UP

#define SCAN_PAGE_UP 0x0009

Definition at line 62 of file SimpleTextIn.h.

◆ SCAN_PAGE_DOWN

#define SCAN_PAGE_DOWN 0x000A

Definition at line 63 of file SimpleTextIn.h.

◆ SCAN_F1

#define SCAN_F1 0x000B

Definition at line 64 of file SimpleTextIn.h.

◆ SCAN_F2

#define SCAN_F2 0x000C

Definition at line 65 of file SimpleTextIn.h.

◆ SCAN_F3

#define SCAN_F3 0x000D

Definition at line 66 of file SimpleTextIn.h.

◆ SCAN_F4

#define SCAN_F4 0x000E

Definition at line 67 of file SimpleTextIn.h.

◆ SCAN_F5

#define SCAN_F5 0x000F

Definition at line 68 of file SimpleTextIn.h.

◆ SCAN_F6

#define SCAN_F6 0x0010

Definition at line 69 of file SimpleTextIn.h.

◆ SCAN_F7

#define SCAN_F7 0x0011

Definition at line 70 of file SimpleTextIn.h.

◆ SCAN_F8

#define SCAN_F8 0x0012

Definition at line 71 of file SimpleTextIn.h.

◆ SCAN_F9

#define SCAN_F9 0x0013

Definition at line 72 of file SimpleTextIn.h.

◆ SCAN_F10

#define SCAN_F10 0x0014

Definition at line 73 of file SimpleTextIn.h.

◆ SCAN_ESC

#define SCAN_ESC 0x0017

Definition at line 74 of file SimpleTextIn.h.

Typedef Documentation

◆ EFI_SIMPLE_TEXT_INPUT_PROTOCOL

typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL

Definition at line 22 of file SimpleTextIn.h.

◆ SIMPLE_INPUT_INTERFACE

typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL SIMPLE_INPUT_INTERFACE

Protocol name in EFI1.1 for backward-compatible.

Definition at line 32 of file SimpleTextIn.h.

◆ EFI_INPUT_RESET

typedef EFI_STATUS(EFIAPI * EFI_INPUT_RESET) (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

Reset the input device and optionally run diagnostics.

Parameters

This	Protocol instance pointer.
ExtendedVerification	Driver may perform diagnostics on reset.

Return values

EFI_SUCCESS	The device was reset.
EFI_DEVICE_ERROR	The device is not functioning properly and could not be reset.

Definition at line 88 of file SimpleTextIn.h.

◆ EFI_INPUT_READ_KEY

typedef EFI_STATUS(EFIAPI * EFI_INPUT_READ_KEY) (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, OUT EFI_INPUT_KEY *Key)

Reads the next keystroke from the input device.

The WaitForKey Event can be used to test for existence of a keystroke via WaitForEvent () call.