1/** @file
2  Simple Text In 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 - 2008, Intel Corporation
8  All rights reserved. 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#include <gpxe/efi/ProcessorBind.h>
22
23#define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
24  { \
25    0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
26  }
27
28///
29/// Protocol GUID defined in EFI1.1.
30///
31#define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
32
33typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  EFI_SIMPLE_TEXT_INPUT_PROTOCOL;
34
35///
36/// Backward-compatible with EFI1.1.
37///
38typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  SIMPLE_INPUT_INTERFACE;
39//
40// Data structures
41//
42typedef struct {
43  UINT16  ScanCode;
44  CHAR16  UnicodeChar;
45} EFI_INPUT_KEY;
46
47//
48// Required unicode control chars
49//
50#define CHAR_NULL             0x0000
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_F11        0x0015
81#define SCAN_F12        0x0016
82#define SCAN_ESC        0x0017
83
84/**
85  Reset the input device and optionaly run diagnostics
86
87  @param  This                 Protocol instance pointer.
88  @param  ExtendedVerification Driver may perform diagnostics on reset.
89
90  @retval EFI_SUCCESS          The device was reset.
91  @retval EFI_DEVICE_ERROR     The device is not functioning properly and could not be reset.
92
93**/
94typedef
95EFI_STATUS
96(EFIAPI *EFI_INPUT_RESET)(
97  IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL       *This,
98  IN BOOLEAN                              ExtendedVerification
99  );
100
101/**
102  Reads the next keystroke from the input device. The WaitForKey Event can
103  be used to test for existance of a keystroke via WaitForEvent () call.
104
105  @param  This Protocol instance pointer.
106  @param  Key  Driver may perform diagnostics on reset.
107
108  @retval EFI_SUCCESS      The keystroke information was returned.
109  @retval EFI_NOT_READY    There was no keystroke data availiable.
110  @retval EFI_DEVICE_ERROR The keydtroke information was not returned due to
111                           hardware errors.
112
113**/
114typedef
115EFI_STATUS
116(EFIAPI *EFI_INPUT_READ_KEY)(
117  IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL       *This,
118  OUT EFI_INPUT_KEY                       *Key
119  );
120
121///
122/// The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device.
123/// It is the minimum required protocol for ConsoleIn.
124///
125struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {
126  EFI_INPUT_RESET     Reset;
127  EFI_INPUT_READ_KEY  ReadKeyStroke;
128  ///
129  /// Event to use with WaitForEvent() to wait for a key to be available
130  ///
131  EFI_EVENT           WaitForKey;
132};
133
134extern EFI_GUID gEfiSimpleTextInProtocolGuid;
135
136#endif
137