SimpleTextIn.h File Reference

Data Structures
struct	EFI_INPUT_KEY
struct	_EFI_SIMPLE_TEXT_INPUT_PROTOCOL

Macros
#define	EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
#define	SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
#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
typedef EFI_STATUS(EFIAPI *	EFI_INPUT_RESET )(IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
typedef EFI_STATUS(EFIAPI *	EFI_INPUT_READ_KEY )(IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, OUT EFI_INPUT_KEY *Key)

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

Macro Definition Documentation

#define CHAR_BACKSPACE   0x0008

#define CHAR_CARRIAGE_RETURN   0x000D

#define CHAR_LINEFEED   0x000A

#define CHAR_TAB   0x0009

#define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID

Value:

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

#define SCAN_DELETE   0x0008

#define SCAN_DOWN   0x0002

#define SCAN_END   0x0006

#define SCAN_ESC   0x0017

#define SCAN_F1   0x000B

#define SCAN_F10   0x0014

#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_HOME   0x0005

#define SCAN_INSERT   0x0007

#define SCAN_LEFT   0x0004

#define SCAN_NULL   0x0000

#define SCAN_PAGE_DOWN   0x000A

#define SCAN_PAGE_UP   0x0009

#define SCAN_RIGHT   0x0003

#define SCAN_UP   0x0001

#define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID

Protocol GUID name defined in EFI1.1.

Typedef Documentation

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.

Parameters

This	Protocol instance pointer.
Key	A pointer to a buffer that is filled in with the keystroke information for the key that was pressed.

Return values

EFI_SUCCESS	The keystroke information was returned.
EFI_NOT_READY	There was no keystroke data available.
EFI_DEVICE_ERROR	The keystroke information was not returned due to hardware errors.

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.

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.

Variable Documentation

EFI_GUID gEfiSimpleTextInProtocolGuid