MdePkg/Include/Protocol/SimpleTextIn.h

   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 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
  22   { \
  23     0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  24   }
  25
  26 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  EFI_SIMPLE_TEXT_INPUT_PROTOCOL;
  27
  28 ///
  29 /// Protocol GUID name defined in EFI1.1.
  30 ///
  31 #define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
  32
  33 ///
  34 /// Protocol name in EFI1.1 for backward-compatible.
  35 ///
  36 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  SIMPLE_INPUT_INTERFACE;
  37
  38 ///
  39 /// The keystroke information for the key that was pressed.
  40 ///
  41 typedef struct {
  42   UINT16  ScanCode;
  43   CHAR16  UnicodeChar;
  44 } EFI_INPUT_KEY;
  45
  46 //
  47 // Required unicode control chars
  48 //
  49 #define CHAR_BACKSPACE        0x0008
  50 #define CHAR_TAB              0x0009
  51 #define CHAR_LINEFEED         0x000A
  52 #define CHAR_CARRIAGE_RETURN  0x000D
  53
  54 //
  55 // EFI Scan codes
  56 //
  57 #define SCAN_NULL       0x0000
  58 #define SCAN_UP         0x0001
  59 #define SCAN_DOWN       0x0002
  60 #define SCAN_RIGHT      0x0003
  61 #define SCAN_LEFT       0x0004
  62 #define SCAN_HOME       0x0005
  63 #define SCAN_END        0x0006
  64 #define SCAN_INSERT     0x0007
  65 #define SCAN_DELETE     0x0008
  66 #define SCAN_PAGE_UP    0x0009
  67 #define SCAN_PAGE_DOWN  0x000A
  68 #define SCAN_F1         0x000B
  69 #define SCAN_F2         0x000C
  70 #define SCAN_F3         0x000D
  71 #define SCAN_F4         0x000E
  72 #define SCAN_F5         0x000F
  73 #define SCAN_F6         0x0010
  74 #define SCAN_F7         0x0011
  75 #define SCAN_F8         0x0012
  76 #define SCAN_F9         0x0013
  77 #define SCAN_F10        0x0014
  78 #define SCAN_ESC        0x0017
  79
  80 /**
  81   Reset the input device and optionally run diagnostics
  82
  83   @param  This                 Protocol instance pointer.
  84   @param  ExtendedVerification Driver may perform diagnostics on reset.
  85
  86   @retval EFI_SUCCESS          The device was reset.
  87   @retval EFI_DEVICE_ERROR     The device is not functioning properly and could not be reset.
  88
  89 **/
  90 typedef
  91 EFI_STATUS
  92 (EFIAPI *EFI_INPUT_RESET)(
  93   IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL       *This,
  94   IN BOOLEAN                              ExtendedVerification
  95   );
  96
  97 /**
  98   Reads the next keystroke from the input device. The WaitForKey Event can
  99   be used to test for existence of a keystroke via WaitForEvent () call.
 100
 101   @param  This  Protocol instance pointer.
 102   @param  Key   A pointer to a buffer that is filled in with the keystroke
 103                 information for the key that was pressed.
 104
 105   @retval EFI_SUCCESS      The keystroke information was returned.
 106   @retval EFI_NOT_READY    There was no keystroke data available.
 107   @retval EFI_DEVICE_ERROR The keystroke information was not returned due to
 108                            hardware errors.
 109
 110 **/
 111 typedef
 112 EFI_STATUS
 113 (EFIAPI *EFI_INPUT_READ_KEY)(
 114   IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL       *This,
 115   OUT EFI_INPUT_KEY                       *Key
 116   );
 117
 118 ///
 119 /// The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device.
 120 /// It is the minimum required protocol for ConsoleIn.
 121 ///
 122 struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {
 123   EFI_INPUT_RESET     Reset;
 124   EFI_INPUT_READ_KEY  ReadKeyStroke;
 125   ///
 126   /// Event to use with WaitForEvent() to wait for a key to be available
 127   ///
 128   EFI_EVENT           WaitForKey;
 129 };
 130
 131 extern EFI_GUID gEfiSimpleTextInProtocolGuid;
 132
 133 #endif