]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
c8c44377 | 2 | Simple Text Input protocol from the UEFI 2.0 specification.\r |
d1f95000 | 3 | \r |
4 | Abstraction of a very simple input device like a keyboard or serial\r | |
5 | terminal.\r | |
6 | \r | |
2be21afb | 7 | Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 8 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
d1f95000 | 9 | \r |
d1f95000 | 10 | **/\r |
11 | \r | |
12 | #ifndef __SIMPLE_TEXT_IN_PROTOCOL_H__\r | |
13 | #define __SIMPLE_TEXT_IN_PROTOCOL_H__\r | |
14 | \r | |
a6508c05 | 15 | #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \\r |
d1f95000 | 16 | { \\r |
17 | 0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r | |
18 | }\r | |
19 | \r | |
992f22b9 LG |
20 | typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL;\r |
21 | \r | |
99e8ed21 | 22 | ///\r |
992f22b9 | 23 | /// Protocol GUID name defined in EFI1.1.\r |
850f13eb | 24 | ///\r |
a6508c05 | 25 | #define SIMPLE_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID\r |
d1f95000 | 26 | \r |
99e8ed21 | 27 | ///\r |
992f22b9 | 28 | /// Protocol name in EFI1.1 for backward-compatible.\r |
850f13eb | 29 | ///\r |
a6508c05 | 30 | typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL SIMPLE_INPUT_INTERFACE;\r |
992f22b9 LG |
31 | \r |
32 | ///\r | |
33 | /// The keystroke information for the key that was pressed.\r | |
34 | ///\r | |
d1f95000 | 35 | typedef struct {\r |
36 | UINT16 ScanCode;\r | |
37 | CHAR16 UnicodeChar;\r | |
38 | } EFI_INPUT_KEY;\r | |
39 | \r | |
40 | //\r | |
41 | // Required unicode control chars\r | |
42 | //\r | |
d1f95000 | 43 | #define CHAR_BACKSPACE 0x0008\r |
44 | #define CHAR_TAB 0x0009\r | |
45 | #define CHAR_LINEFEED 0x000A\r | |
46 | #define CHAR_CARRIAGE_RETURN 0x000D\r | |
47 | \r | |
48 | //\r | |
49 | // EFI Scan codes\r | |
50 | //\r | |
51 | #define SCAN_NULL 0x0000\r | |
52 | #define SCAN_UP 0x0001\r | |
53 | #define SCAN_DOWN 0x0002\r | |
54 | #define SCAN_RIGHT 0x0003\r | |
55 | #define SCAN_LEFT 0x0004\r | |
56 | #define SCAN_HOME 0x0005\r | |
57 | #define SCAN_END 0x0006\r | |
58 | #define SCAN_INSERT 0x0007\r | |
59 | #define SCAN_DELETE 0x0008\r | |
60 | #define SCAN_PAGE_UP 0x0009\r | |
61 | #define SCAN_PAGE_DOWN 0x000A\r | |
62 | #define SCAN_F1 0x000B\r | |
63 | #define SCAN_F2 0x000C\r | |
64 | #define SCAN_F3 0x000D\r | |
65 | #define SCAN_F4 0x000E\r | |
66 | #define SCAN_F5 0x000F\r | |
67 | #define SCAN_F6 0x0010\r | |
68 | #define SCAN_F7 0x0011\r | |
69 | #define SCAN_F8 0x0012\r | |
70 | #define SCAN_F9 0x0013\r | |
71 | #define SCAN_F10 0x0014\r | |
d1f95000 | 72 | #define SCAN_ESC 0x0017\r |
73 | \r | |
74 | /**\r | |
6e55477d | 75 | Reset the input device and optionally run diagnostics\r |
d1f95000 | 76 | \r |
77 | @param This Protocol instance pointer.\r | |
78 | @param ExtendedVerification Driver may perform diagnostics on reset.\r | |
79 | \r | |
80 | @retval EFI_SUCCESS The device was reset.\r | |
81 | @retval EFI_DEVICE_ERROR The device is not functioning properly and could not be reset.\r | |
82 | \r | |
83 | **/\r | |
84 | typedef\r | |
85 | EFI_STATUS\r | |
8b13229b | 86 | (EFIAPI *EFI_INPUT_RESET)(\r |
a6508c05 | 87 | IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r |
d1f95000 | 88 | IN BOOLEAN ExtendedVerification\r |
ed66e1bc | 89 | );\r |
d1f95000 | 90 | \r |
91 | /**\r | |
850f13eb | 92 | Reads the next keystroke from the input device. The WaitForKey Event can\r |
6e55477d | 93 | be used to test for existence of a keystroke via WaitForEvent () call.\r |
d1f95000 | 94 | \r |
850f13eb | 95 | @param This Protocol instance pointer.\r |
96 | @param Key A pointer to a buffer that is filled in with the keystroke\r | |
97 | information for the key that was pressed.\r | |
d1f95000 | 98 | \r |
99 | @retval EFI_SUCCESS The keystroke information was returned.\r | |
6e55477d | 100 | @retval EFI_NOT_READY There was no keystroke data available.\r |
101 | @retval EFI_DEVICE_ERROR The keystroke information was not returned due to\r | |
d1f95000 | 102 | hardware errors.\r |
103 | \r | |
104 | **/\r | |
105 | typedef\r | |
106 | EFI_STATUS\r | |
8b13229b | 107 | (EFIAPI *EFI_INPUT_READ_KEY)(\r |
a6508c05 | 108 | IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r |
d1f95000 | 109 | OUT EFI_INPUT_KEY *Key\r |
ed66e1bc | 110 | );\r |
d1f95000 | 111 | \r |
44717a39 | 112 | ///\r |
850f13eb | 113 | /// The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device.\r |
44717a39 | 114 | /// It is the minimum required protocol for ConsoleIn.\r |
115 | ///\r | |
a6508c05 | 116 | struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {\r |
d1f95000 | 117 | EFI_INPUT_RESET Reset;\r |
118 | EFI_INPUT_READ_KEY ReadKeyStroke;\r | |
1f08a159 | 119 | ///\r |
120 | /// Event to use with WaitForEvent() to wait for a key to be available\r | |
121 | ///\r | |
d1f95000 | 122 | EFI_EVENT WaitForKey;\r |
123 | };\r | |
124 | \r | |
125 | extern EFI_GUID gEfiSimpleTextInProtocolGuid;\r | |
126 | \r | |
127 | #endif\r |