iPXE
Data Structures | Defines | Typedefs | Functions | Variables
SimpleTextIn.h File Reference

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

Go to the source code of this file.

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...

Defines

#define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
#define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
 Protocol GUID name defined in EFI1.1.
#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.
typedef EFI_STATUS(EFIAPIEFI_INPUT_RESET )(IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
 Reset the input device and optionally run diagnostics.
typedef EFI_STATUS(EFIAPIEFI_INPUT_READ_KEY )(IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, OUT EFI_INPUT_KEY *Key)
 Reads the next keystroke from the input device.

Functions

 FILE_LICENCE (BSD3)

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.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file SimpleTextIn.h.


Define Documentation

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

Definition at line 23 of file SimpleTextIn.h.

Protocol GUID name defined in EFI1.1.

Definition at line 33 of file SimpleTextIn.h.

#define CHAR_BACKSPACE   0x0008

Definition at line 51 of file SimpleTextIn.h.

#define CHAR_TAB   0x0009

Definition at line 52 of file SimpleTextIn.h.

#define CHAR_LINEFEED   0x000A

Definition at line 53 of file SimpleTextIn.h.

#define CHAR_CARRIAGE_RETURN   0x000D

Definition at line 54 of file SimpleTextIn.h.

#define SCAN_NULL   0x0000

Definition at line 59 of file SimpleTextIn.h.

#define SCAN_UP   0x0001

Definition at line 60 of file SimpleTextIn.h.

#define SCAN_DOWN   0x0002

Definition at line 61 of file SimpleTextIn.h.

#define SCAN_RIGHT   0x0003

Definition at line 62 of file SimpleTextIn.h.

#define SCAN_LEFT   0x0004

Definition at line 63 of file SimpleTextIn.h.

#define SCAN_HOME   0x0005

Definition at line 64 of file SimpleTextIn.h.

#define SCAN_END   0x0006

Definition at line 65 of file SimpleTextIn.h.

#define SCAN_INSERT   0x0007

Definition at line 66 of file SimpleTextIn.h.

#define SCAN_DELETE   0x0008

Definition at line 67 of file SimpleTextIn.h.

#define SCAN_PAGE_UP   0x0009

Definition at line 68 of file SimpleTextIn.h.

#define SCAN_PAGE_DOWN   0x000A

Definition at line 69 of file SimpleTextIn.h.

#define SCAN_F1   0x000B

Definition at line 70 of file SimpleTextIn.h.

#define SCAN_F2   0x000C

Definition at line 71 of file SimpleTextIn.h.

#define SCAN_F3   0x000D

Definition at line 72 of file SimpleTextIn.h.

#define SCAN_F4   0x000E

Definition at line 73 of file SimpleTextIn.h.

#define SCAN_F5   0x000F

Definition at line 74 of file SimpleTextIn.h.

#define SCAN_F6   0x0010

Definition at line 75 of file SimpleTextIn.h.

#define SCAN_F7   0x0011

Definition at line 76 of file SimpleTextIn.h.

#define SCAN_F8   0x0012

Definition at line 77 of file SimpleTextIn.h.

#define SCAN_F9   0x0013

Definition at line 78 of file SimpleTextIn.h.

#define SCAN_F10   0x0014

Definition at line 79 of file SimpleTextIn.h.

#define SCAN_ESC   0x0017

Definition at line 80 of file SimpleTextIn.h.


Typedef Documentation

Definition at line 28 of file SimpleTextIn.h.

Protocol name in EFI1.1 for backward-compatible.

Definition at line 38 of file SimpleTextIn.h.

Reset the input device and optionally run diagnostics.

Parameters:
ThisProtocol instance pointer.
ExtendedVerificationDriver may perform diagnostics on reset.
Return values:
EFI_SUCCESSThe device was reset.
EFI_DEVICE_ERRORThe device is not functioning properly and could not be reset.

Definition at line 94 of file SimpleTextIn.h.

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:
ThisProtocol instance pointer.
KeyA pointer to a buffer that is filled in with the keystroke information for the key that was pressed.
Return values:
EFI_SUCCESSThe keystroke information was returned.
EFI_NOT_READYThere was no keystroke data available.
EFI_DEVICE_ERRORThe keystroke information was not returned due to hardware errors.

Definition at line 115 of file SimpleTextIn.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation