iPXE
SimpleTextIn.h
Go to the documentation of this file.
1 /** @file
2  Simple Text Input protocol from the UEFI 2.0 specification.
3 
4  Abstraction of a very simple input device like a keyboard or serial
5  terminal.
6 
7  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
8  This program and the accompanying materials
9  are licensed and made available under the terms and conditions of the BSD License
10  which accompanies this distribution. The full text of the license may be found at
11  http://opensource.org/licenses/bsd-license.php
12 
13  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 
16 **/
17 
18 #ifndef __SIMPLE_TEXT_IN_PROTOCOL_H__
19 #define __SIMPLE_TEXT_IN_PROTOCOL_H__
20 
21 FILE_LICENCE ( BSD3 );
22 
23 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
24  { \
25  0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
26  }
27 
29 
30 ///
31 /// Protocol GUID name defined in EFI1.1.
32 ///
33 #define SIMPLE_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
34 
35 ///
36 /// Protocol name in EFI1.1 for backward-compatible.
37 ///
39 
40 ///
41 /// The keystroke information for the key that was pressed.
42 ///
43 typedef struct {
47 
48 //
49 // Required unicode control chars
50 //
51 #define CHAR_BACKSPACE 0x0008
52 #define CHAR_TAB 0x0009
53 #define CHAR_LINEFEED 0x000A
54 #define CHAR_CARRIAGE_RETURN 0x000D
55 
56 //
57 // EFI Scan codes
58 //
59 #define SCAN_NULL 0x0000
60 #define SCAN_UP 0x0001
61 #define SCAN_DOWN 0x0002
62 #define SCAN_RIGHT 0x0003
63 #define SCAN_LEFT 0x0004
64 #define SCAN_HOME 0x0005
65 #define SCAN_END 0x0006
66 #define SCAN_INSERT 0x0007
67 #define SCAN_DELETE 0x0008
68 #define SCAN_PAGE_UP 0x0009
69 #define SCAN_PAGE_DOWN 0x000A
70 #define SCAN_F1 0x000B
71 #define SCAN_F2 0x000C
72 #define SCAN_F3 0x000D
73 #define SCAN_F4 0x000E
74 #define SCAN_F5 0x000F
75 #define SCAN_F6 0x0010
76 #define SCAN_F7 0x0011
77 #define SCAN_F8 0x0012
78 #define SCAN_F9 0x0013
79 #define SCAN_F10 0x0014
80 #define SCAN_ESC 0x0017
81 
82 /**
83  Reset the input device and optionally run diagnostics
84 
85  @param This Protocol instance pointer.
86  @param ExtendedVerification Driver may perform diagnostics on reset.
87 
88  @retval EFI_SUCCESS The device was reset.
89  @retval EFI_DEVICE_ERROR The device is not functioning properly and could not be reset.
90 
91 **/
92 typedef
96  IN BOOLEAN ExtendedVerification
97  );
98 
99 /**
100  Reads the next keystroke from the input device. The WaitForKey Event can
101  be used to test for existence of a keystroke via WaitForEvent () call.
102 
103  @param This Protocol instance pointer.
104  @param Key A pointer to a buffer that is filled in with the keystroke
105  information for the key that was pressed.
106 
107  @retval EFI_SUCCESS The keystroke information was returned.
108  @retval EFI_NOT_READY There was no keystroke data available.
109  @retval EFI_DEVICE_ERROR The keystroke information was not returned due to
110  hardware errors.
111 
112 **/
113 typedef
117  OUT EFI_INPUT_KEY *Key
118  );
119 
120 ///
121 /// The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device.
122 /// It is the minimum required protocol for ConsoleIn.
123 ///
127  ///
128  /// Event to use with WaitForEvent() to wait for a key to be available
129  ///
131 };
132 
134 
135 #endif
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device.
Definition: SimpleTextIn.h:124
VOID * EFI_EVENT
Handle to an event structure.
Definition: UefiBaseType.h:43
unsigned char BOOLEAN
Definition: ProcessorBind.h:61
unsigned short CHAR16
Definition: ProcessorBind.h:59
EFI_EVENT WaitForKey
Event to use with WaitForEvent() to wait for a key to be available.
Definition: SimpleTextIn.h:130
CHAR16 UnicodeChar
Definition: SimpleTextIn.h:45
#define OUT
Definition: mlx_utils.h:29
EFI_INPUT_READ_KEY ReadKeyStroke
Definition: SimpleTextIn.h:126
unsigned short UINT16
Definition: ProcessorBind.h:58
#define EFIAPI
EFI_GUID gEfiSimpleTextInProtocolGuid
The keystroke information for the key that was pressed.
Definition: SimpleTextIn.h:43
UINT16 ScanCode
Definition: SimpleTextIn.h:44
EFI_STATUS(EFIAPI * EFI_INPUT_RESET)(IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
Reset the input device and optionally run diagnostics.
Definition: SimpleTextIn.h:94
#define IN
Definition: mlx_utils.h:28
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
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.
Definition: SimpleTextIn.h:115
FILE_LICENCE(BSD3)