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