MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h

   1 /** @file
   2   Header file for Terminal driver.
   3
   4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _TERMINAL_H_
  16 #define _TERMINAL_H_
  17
  18
  19 #include <Uefi.h>
  20
  21 #include <Guid/GlobalVariable.h>
  22 #include <Guid/PcAnsi.h>
  23
  24 #include <Protocol/SimpleTextOut.h>
  25 #include <Protocol/SerialIo.h>
  26 #include <Protocol/DevicePath.h>
  27 #include <Protocol/SimpleTextIn.h>
  28 #include <Protocol/SimpleTextInEx.h>
  29
  30 #include <Library/DebugLib.h>
  31 #include <Library/UefiDriverEntryPoint.h>
  32 #include <Library/UefiLib.h>
  33 #include <Library/ReportStatusCodeLib.h>
  34 #include <Library/BaseMemoryLib.h>
  35 #include <Library/MemoryAllocationLib.h>
  36 #include <Library/UefiBootServicesTableLib.h>
  37 #include <Library/UefiRuntimeServicesTableLib.h>
  38 #include <Library/DevicePathLib.h>
  39 #include <Library/PcdLib.h>
  40 #include <Library/BaseLib.h>
  41
  42
  43 #define RAW_FIFO_MAX_NUMBER 256
  44 #define FIFO_MAX_NUMBER     128
  45
  46 typedef struct {
  47   UINT8 Head;
  48   UINT8 Tail;
  49   UINT8 Data[RAW_FIFO_MAX_NUMBER + 1];
  50 } RAW_DATA_FIFO;
  51
  52 typedef struct {
  53   UINT8   Head;
  54   UINT8   Tail;
  55   UINT16  Data[FIFO_MAX_NUMBER + 1];
  56 } UNICODE_FIFO;
  57
  58 typedef struct {
  59   UINT8         Head;
  60   UINT8         Tail;
  61   EFI_INPUT_KEY Data[FIFO_MAX_NUMBER + 1];
  62 } EFI_KEY_FIFO;
  63
  64 #define TERMINAL_DEV_SIGNATURE  SIGNATURE_32 ('t', 'm', 'n', 'l')
  65
  66 #define TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('t', 'm', 'e', 'n')
  67
  68 typedef struct _TERMINAL_CONSOLE_IN_EX_NOTIFY {
  69   UINTN                                 Signature;
  70   EFI_HANDLE                            NotifyHandle;
  71   EFI_KEY_DATA                          KeyData;
  72   EFI_KEY_NOTIFY_FUNCTION               KeyNotificationFn;
  73   LIST_ENTRY                            NotifyEntry;
  74 } TERMINAL_CONSOLE_IN_EX_NOTIFY;
  75 typedef struct {
  76   UINTN                               Signature;
  77   EFI_HANDLE                          Handle;
  78   UINT8                               TerminalType;
  79   EFI_SERIAL_IO_PROTOCOL              *SerialIo;
  80   EFI_DEVICE_PATH_PROTOCOL            *DevicePath;
  81   EFI_SIMPLE_TEXT_INPUT_PROTOCOL      SimpleInput;
  82   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL     SimpleTextOutput;
  83   EFI_SIMPLE_TEXT_OUTPUT_MODE         SimpleTextOutputMode;
  84   UINTN                               SerialInTimeOut;
  85   RAW_DATA_FIFO                       *RawFiFo;
  86   UNICODE_FIFO                        *UnicodeFiFo;
  87   EFI_KEY_FIFO                        *EfiKeyFiFo;
  88   EFI_UNICODE_STRING_TABLE            *ControllerNameTable;
  89   EFI_EVENT                           TwoSecondTimeOut;
  90   UINT32                              InputState;
  91   UINT32                              ResetState;
  92
  93   //
  94   // Esc could not be output to the screen by user,
  95   // but the terminal driver need to output it to
  96   // the terminal emulation software to send control sequence.
  97   // This boolean is used by the terminal driver only
  98   // to indicate whether the Esc could be sent or not.
  99   //
 100   BOOLEAN                             OutputEscChar;
 101   EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL   SimpleInputEx;
 102   LIST_ENTRY                          NotifyList;
 103 } TERMINAL_DEV;
 104
 105 #define INPUT_STATE_DEFAULT               0x00
 106 #define INPUT_STATE_ESC                   0x01
 107 #define INPUT_STATE_CSI                   0x02
 108 #define INPUT_STATE_LEFTOPENBRACKET       0x04
 109 #define INPUT_STATE_O                     0x08
 110 #define INPUT_STATE_2                     0x10
 111
 112 #define RESET_STATE_DEFAULT               0x00
 113 #define RESET_STATE_ESC_R                 0x01
 114 #define RESET_STATE_ESC_R_ESC_R           0x02
 115
 116 #define TERMINAL_CON_IN_DEV_FROM_THIS(a)  CR (a, TERMINAL_DEV, SimpleInput, TERMINAL_DEV_SIGNATURE)
 117 #define TERMINAL_CON_OUT_DEV_FROM_THIS(a) CR (a, TERMINAL_DEV, SimpleTextOutput, TERMINAL_DEV_SIGNATURE)
 118 #define TERMINAL_CON_IN_EX_DEV_FROM_THIS(a)  CR (a, TERMINAL_DEV, SimpleInputEx, TERMINAL_DEV_SIGNATURE)
 119
 120 typedef union {
 121   UINT8 Utf8_1;
 122   UINT8 Utf8_2[2];
 123   UINT8 Utf8_3[3];
 124 } UTF8_CHAR;
 125
 126 #define PCANSITYPE                0
 127 #define VT100TYPE                 1
 128 #define VT100PLUSTYPE             2
 129 #define VTUTF8TYPE                3
 130
 131 #define LEFTOPENBRACKET           0x5b  // '['
 132 #define ACAP                      0x41
 133 #define BCAP                      0x42
 134 #define CCAP                      0x43
 135 #define DCAP                      0x44
 136
 137 #define MODE0_COLUMN_COUNT        80
 138 #define MODE0_ROW_COUNT           25
 139
 140 #define MODE1_COLUMN_COUNT        80
 141 #define MODE1_ROW_COUNT           50
 142
 143 #define MODE2_COLUMN_COUNT        100
 144 #define MODE2_ROW_COUNT           31
 145
 146 #define BACKSPACE                 8
 147 #define ESC                       27
 148 #define CSI                       0x9B
 149 #define DEL                       127
 150 #define BRIGHT_CONTROL_OFFSET     2
 151 #define FOREGROUND_CONTROL_OFFSET 6
 152 #define BACKGROUND_CONTROL_OFFSET 11
 153 #define ROW_OFFSET                2
 154 #define COLUMN_OFFSET             5
 155
 156 typedef struct {
 157   UINT16  Unicode;
 158   CHAR8   PcAnsi;
 159   CHAR8   Ascii;
 160 } UNICODE_TO_CHAR;
 161
 162 //
 163 // Global Variables
 164 //
 165 extern EFI_DRIVER_BINDING_PROTOCOL   gTerminalDriverBinding;
 166 extern EFI_COMPONENT_NAME_PROTOCOL   gTerminalComponentName;
 167 extern EFI_COMPONENT_NAME2_PROTOCOL  gTerminalComponentName2;
 168
 169 /**
 170   The user Entry Point for module Terminal. The user code starts with this function.
 171
 172   @param[in] ImageHandle    The firmware allocated handle for the EFI image.
 173   @param[in] SystemTable    A pointer to the EFI System Table.
 174
 175   @retval EFI_SUCCESS       The entry point is executed successfully.
 176   @retval other             Some error occurs when executing this entry point.
 177
 178 **/
 179 EFI_STATUS
 180 EFIAPI
 181 InitializeTerminal (
 182   IN EFI_HANDLE         ImageHandle,
 183   IN EFI_SYSTEM_TABLE   *SystemTable
 184   );
 185
 186 /**
 187   Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.Reset().
 188   This driver only perform dependent serial device reset regardless of
 189   the value of ExtendeVerification
 190
 191   @param  This                     Indicates the calling context.
 192   @param  ExtendedVerification     Skip by this driver.
 193
 194   @retval EFI_SUCCESS              The reset operation succeeds.
 195   @retval EFI_DEVICE_ERROR         The dependent serial port reset fails.
 196
 197 **/
 198 EFI_STATUS
 199 EFIAPI
 200 TerminalConInReset (
 201   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL    *This,
 202   IN  BOOLEAN                           ExtendedVerification
 203   );
 204
 205
 206 /**
 207   Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().
 208
 209   @param  This                Indicates the calling context.
 210   @param  Key                 A pointer to a buffer that is filled in with the
 211                               keystroke information for the key that was sent
 212                               from terminal.
 213
 214   @retval EFI_SUCCESS         The keystroke information is returned successfully.
 215   @retval EFI_NOT_READY       There is no keystroke data available.
 216   @retval EFI_DEVICE_ERROR    The dependent serial device encounters error.
 217
 218 **/
 219 EFI_STATUS
 220 EFIAPI
 221 TerminalConInReadKeyStroke (
 222   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This,
 223   OUT EFI_INPUT_KEY                   *Key
 224   );
 225
 226 /**
 227   Check if the key already has been registered.
 228
 229   @param  RegsiteredData           A pointer to a buffer that is filled in with the
 230                                    keystroke state data for the key that was
 231                                    registered.
 232   @param  InputData                A pointer to a buffer that is filled in with the
 233                                    keystroke state data for the key that was
 234                                    pressed.
 235
 236   @retval TRUE                     Key be pressed matches a registered key.
 237   @retval FLASE                    Match failed.
 238
 239 **/
 240 BOOLEAN
 241 IsKeyRegistered (
 242   IN EFI_KEY_DATA  *RegsiteredData,
 243   IN EFI_KEY_DATA  *InputData
 244   );
 245
 246 /**
 247   Event notification function for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event
 248   Signal the event if there is key available
 249
 250   @param  Event                    Indicates the event that invoke this function.
 251   @param  Context                  Indicates the calling context.
 252
 253 **/
 254 VOID
 255 EFIAPI
 256 TerminalConInWaitForKeyEx (
 257   IN  EFI_EVENT       Event,
 258   IN  VOID            *Context
 259   );
 260
 261 //
 262 // Simple Text Input Ex protocol prototypes
 263 //
 264
 265 /**
 266   Reset the input device and optionally run diagnostics
 267
 268   @param  This                     Protocol instance pointer.
 269   @param  ExtendedVerification     Driver may perform diagnostics on reset.
 270
 271   @retval EFI_SUCCESS              The device was reset.
 272   @retval EFI_DEVICE_ERROR         The device is not functioning properly and could
 273                                    not be reset.
 274
 275 **/
 276 EFI_STATUS
 277 EFIAPI
 278 TerminalConInResetEx (
 279   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
 280   IN BOOLEAN                            ExtendedVerification
 281   );
 282
 283 /**
 284   Reads the next keystroke from the input device. The WaitForKey Event can
 285   be used to test for existence of a keystroke via WaitForEvent () call.
 286
 287   @param  This                     Protocol instance pointer.
 288   @param  KeyData                  A pointer to a buffer that is filled in with the
 289                                    keystroke state data for the key that was
 290                                    pressed.
 291
 292   @retval EFI_SUCCESS              The keystroke information was returned.
 293   @retval EFI_NOT_READY            There was no keystroke data available.
 294   @retval EFI_DEVICE_ERROR         The keystroke information was not returned due
 295                                    to hardware errors.
 296   @retval EFI_INVALID_PARAMETER    KeyData is NULL.
 297
 298 **/
 299 EFI_STATUS
 300 EFIAPI
 301 TerminalConInReadKeyStrokeEx (
 302   IN  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
 303   OUT EFI_KEY_DATA                      *KeyData
 304   );
 305
 306 /**
 307   Set certain state for the input device.
 308
 309   @param  This                     Protocol instance pointer.
 310   @param  KeyToggleState           A pointer to the EFI_KEY_TOGGLE_STATE to set the
 311                                    state for the input device.
 312
 313   @retval EFI_SUCCESS              The device state was set successfully.
 314   @retval EFI_DEVICE_ERROR         The device is not functioning correctly and
 315                                    could not have the setting adjusted.
 316   @retval EFI_UNSUPPORTED          The device does not have the ability to set its
 317                                    state.
 318   @retval EFI_INVALID_PARAMETER    KeyToggleState is NULL.
 319
 320 **/
 321 EFI_STATUS
 322 EFIAPI
 323 TerminalConInSetState (
 324   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
 325   IN EFI_KEY_TOGGLE_STATE               *KeyToggleState
 326   );
 327
 328 /**
 329   Register a notification function for a particular keystroke for the input device.
 330
 331   @param  This                     Protocol instance pointer.
 332   @param  KeyData                  A pointer to a buffer that is filled in with the
 333                                    keystroke information data for the key that was
 334                                    pressed.
 335   @param  KeyNotificationFunction  Points to the function to be called when the key
 336                                    sequence is typed specified by KeyData.
 337   @param  NotifyHandle             Points to the unique handle assigned to the
 338                                    registered notification.
 339
 340   @retval EFI_SUCCESS              The notification function was registered
 341                                    successfully.
 342   @retval EFI_OUT_OF_RESOURCES     Unable to allocate resources for necesssary data
 343                                    structures.
 344   @retval EFI_INVALID_PARAMETER    KeyData or NotifyHandle is NULL.
 345
 346 **/
 347 EFI_STATUS
 348 EFIAPI
 349 TerminalConInRegisterKeyNotify (
 350   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
 351   IN EFI_KEY_DATA                       *KeyData,
 352   IN EFI_KEY_NOTIFY_FUNCTION            KeyNotificationFunction,
 353   OUT EFI_HANDLE                        *NotifyHandle
 354   );
 355
 356 /**
 357   Remove a registered notification function from a particular keystroke.
 358
 359   @param  This                     Protocol instance pointer.
 360   @param  NotificationHandle       The handle of the notification function being
 361                                    unregistered.
 362
 363   @retval EFI_SUCCESS              The notification function was unregistered
 364                                    successfully.
 365   @retval EFI_INVALID_PARAMETER    The NotificationHandle is invalid.
 366   @retval EFI_NOT_FOUND            Can not find the matching entry in database.
 367
 368 **/
 369 EFI_STATUS
 370 EFIAPI
 371 TerminalConInUnregisterKeyNotify (
 372   IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
 373   IN EFI_HANDLE                         NotificationHandle
 374   );
 375
 376 /**
 377   Event notification function for EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey event
 378   Signal the event if there is key available
 379
 380   @param  Event                    Indicates the event that invoke this function.
 381   @param  Context                  Indicates the calling context.
 382
 383 **/
 384 VOID
 385 EFIAPI
 386 TerminalConInWaitForKey (
 387   IN  EFI_EVENT     Event,
 388   IN  VOID          *Context
 389   );
 390
 391 /**
 392   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.Reset().
 393   If ExtendeVerification is TRUE, then perform dependent serial device reset,
 394   and set display mode to mode 0.
 395   If ExtendedVerification is FALSE, only set display mode to mode 0.
 396
 397   @param  This                  Indicates the calling context.
 398   @param  ExtendedVerification  Indicates that the driver may perform a more
 399                                 exhaustive verification operation of the device
 400                                 during reset.
 401
 402   @retval EFI_SUCCESS           The reset operation succeeds.
 403   @retval EFI_DEVICE_ERROR      The terminal is not functioning correctly or the serial port reset fails.
 404
 405 **/
 406 EFI_STATUS
 407 EFIAPI
 408 TerminalConOutReset (
 409   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *This,
 410   IN  BOOLEAN                            ExtendedVerification
 411   );
 412
 413 /**
 414   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.OutputString().
 415   The Unicode string will be converted to terminal expressible data stream
 416   and send to terminal via serial port.
 417
 418   @param  This                    Indicates the calling context.
 419   @param  WString                 The Null-terminated Unicode string to be displayed
 420                                   on the terminal screen.
 421
 422   @retval EFI_SUCCESS             The string is output successfully.
 423   @retval EFI_DEVICE_ERROR        The serial port fails to send the string out.
 424   @retval EFI_WARN_UNKNOWN_GLYPH  Indicates that some of the characters in the Unicode string could not
 425                                   be rendered and are skipped.
 426   @retval EFI_UNSUPPORTED         If current display mode is out of range.
 427
 428 **/
 429 EFI_STATUS
 430 EFIAPI
 431 TerminalConOutOutputString (
 432   IN   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 433   IN  CHAR16                            *WString
 434   );
 435
 436 /**
 437   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.TestString().
 438   If one of the characters in the *Wstring is
 439   neither valid Unicode drawing characters,
 440   not ASCII code, then this function will return
 441   EFI_UNSUPPORTED.
 442
 443   @param  This              Indicates the calling context.
 444   @param  WString           The Null-terminated Unicode string to be tested.
 445
 446   @retval EFI_SUCCESS       The terminal is capable of rendering the output string.
 447   @retval EFI_UNSUPPORTED   Some of the characters in the Unicode string cannot be rendered.
 448
 449 **/
 450 EFI_STATUS
 451 EFIAPI
 452 TerminalConOutTestString (
 453   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 454   IN  CHAR16                           *WString
 455   );
 456
 457 /**
 458   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.QueryMode().
 459   It returns information for an available text mode
 460   that the terminal supports.
 461   In this driver, we support text mode 80x25 (mode 0),
 462   80x50 (mode 1), 100x31 (mode 2).
 463
 464   @param This        Indicates the calling context.
 465   @param ModeNumber  The mode number to return information on.
 466   @param Columns     The returned columns of the requested mode.
 467   @param Rows        The returned rows of the requested mode.
 468
 469   @retval EFI_SUCCESS       The requested mode information is returned.
 470   @retval EFI_UNSUPPORTED   The mode number is not valid.
 471   @retval EFI_DEVICE_ERROR
 472
 473 **/
 474 EFI_STATUS
 475 EFIAPI
 476 TerminalConOutQueryMode (
 477   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 478   IN  UINTN                            ModeNumber,
 479   OUT UINTN                            *Columns,
 480   OUT UINTN                            *Rows
 481   );
 482
 483 /**
 484   Implements EFI_SIMPLE_TEXT_OUT.SetMode().
 485   Set the terminal to a specified display mode.
 486   In this driver, we only support mode 0.
 487
 488   @param This          Indicates the calling context.
 489   @param ModeNumber    The text mode to set.
 490
 491   @retval EFI_SUCCESS       The requested text mode is set.
 492   @retval EFI_DEVICE_ERROR  The requested text mode cannot be set
 493                             because of serial device error.
 494   @retval EFI_UNSUPPORTED   The text mode number is not valid.
 495
 496 **/
 497 EFI_STATUS
 498 EFIAPI
 499 TerminalConOutSetMode (
 500   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 501   IN  UINTN                            ModeNumber
 502   );
 503
 504 /**
 505   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetAttribute().
 506
 507   @param This        Indicates the calling context.
 508   @param Attribute   The attribute to set. Only bit0..6 are valid, all other bits
 509                      are undefined and must be zero.
 510
 511   @retval EFI_SUCCESS        The requested attribute is set.
 512   @retval EFI_DEVICE_ERROR   The requested attribute cannot be set due to serial port error.
 513   @retval EFI_UNSUPPORTED    The attribute requested is not defined by EFI spec.
 514
 515 **/
 516 EFI_STATUS
 517 EFIAPI
 518 TerminalConOutSetAttribute (
 519   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 520   IN  UINTN                            Attribute
 521   );
 522
 523 /**
 524   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.ClearScreen().
 525   It clears the ANSI terminal's display to the
 526   currently selected background color.
 527
 528   @param This     Indicates the calling context.
 529
 530   @retval EFI_SUCCESS       The operation completed successfully.
 531   @retval EFI_DEVICE_ERROR  The terminal screen cannot be cleared due to serial port error.
 532   @retval EFI_UNSUPPORTED   The terminal is not in a valid display mode.
 533
 534 **/
 535 EFI_STATUS
 536 EFIAPI
 537 TerminalConOutClearScreen (
 538   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This
 539   );
 540
 541 /**
 542   Implements EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.SetCursorPosition().
 543
 544   @param This      Indicates the calling context.
 545   @param Column    The row to set cursor to.
 546   @param Row       The column to set cursor to.
 547
 548   @retval EFI_SUCCESS       The operation completed successfully.
 549   @retval EFI_DEVICE_ERROR  The request fails due to serial port error.
 550   @retval EFI_UNSUPPORTED   The terminal is not in a valid text mode, or the cursor position
 551                             is invalid for current mode.
 552
 553 **/
 554 EFI_STATUS
 555 EFIAPI
 556 TerminalConOutSetCursorPosition (
 557   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 558   IN  UINTN                            Column,
 559   IN  UINTN                            Row
 560   );
 561
 562 /**
 563   Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
 564   In this driver, the cursor cannot be hidden.
 565
 566   @param This      Indicates the calling context.
 567   @param Visible   If TRUE, the cursor is set to be visible,
 568                    If FALSE, the cursor is set to be invisible.
 569
 570   @retval EFI_SUCCESS      The request is valid.
 571   @retval EFI_UNSUPPORTED  The terminal does not support cursor hidden.
 572
 573 **/
 574 EFI_STATUS
 575 EFIAPI
 576 TerminalConOutEnableCursor (
 577   IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *This,
 578   IN  BOOLEAN                          Visible
 579   );
 580
 581 /**
 582   Test to see if this driver supports Controller.
 583
 584   @param  This                Protocol instance pointer.
 585   @param  ControllerHandle    Handle of device to test
 586   @param  RemainingDevicePath Optional parameter use to pick a specific child
 587                               device to start.
 588
 589   @retval EFI_SUCCESS         This driver supports this device.
 590   @retval EFI_ALREADY_STARTED This driver is already running on this device.
 591   @retval other               This driver does not support this device.
 592
 593 **/
 594 EFI_STATUS
 595 EFIAPI
 596 TerminalDriverBindingSupported (
 597   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 598   IN EFI_HANDLE                     ControllerHandle,
 599   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
 600   );
 601
 602 /**
 603   Start this driver on Controller by opening a Serial IO protocol,
 604   reading Device Path, and creating a child handle with a Simple Text In,
 605   Simple Text In Ex and Simple Text Out protocol, and device path protocol.
 606   And store Console Device Environment Variables.
 607
 608   @param  This                 Protocol instance pointer.
 609   @param  Controller           Handle of device to bind driver to
 610   @param  RemainingDevicePath  Optional parameter use to pick a specific child
 611                                device to start.
 612
 613   @retval EFI_SUCCESS          This driver is added to Controller.
 614   @retval EFI_ALREADY_STARTED  This driver is already running on Controller.
 615   @retval other                This driver does not support this device.
 616
 617 **/
 618 EFI_STATUS
 619 EFIAPI
 620 TerminalDriverBindingStart (
 621   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 622   IN EFI_HANDLE                     Controller,
 623   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
 624   );
 625
 626
 627 /**
 628   Stop this driver on Controller by closing Simple Text In, Simple Text
 629   In Ex, Simple Text Out protocol, and removing parent device path from
 630   Console Device Environment Variables.
 631
 632   @param  This              Protocol instance pointer.
 633   @param  Controller        Handle of device to stop driver on
 634   @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
 635                             children is zero stop the entire bus driver.
 636   @param  ChildHandleBuffer List of Child Handles to Stop.
 637
 638   @retval EFI_SUCCESS       This driver is removed Controller.
 639   @retval other             This driver could not be removed from this device.
 640
 641 **/
 642 EFI_STATUS
 643 EFIAPI
 644 TerminalDriverBindingStop (
 645   IN  EFI_DRIVER_BINDING_PROTOCOL    *This,
 646   IN  EFI_HANDLE                     Controller,
 647   IN  UINTN                          NumberOfChildren,
 648   IN  EFI_HANDLE                     *ChildHandleBuffer
 649   );
 650
 651 /**
 652   Free notify functions list.
 653
 654   @param  ListHead               The list head
 655
 656   @retval EFI_SUCCESS            Free the notify list successfully.
 657   @retval EFI_INVALID_PARAMETER  ListHead is NULL.
 658
 659 **/
 660 EFI_STATUS
 661 TerminalFreeNotifyList (
 662   IN OUT LIST_ENTRY           *ListHead
 663   );
 664
 665 /**
 666   Retrieves a Unicode string that is the user readable name of the driver.
 667
 668   This function retrieves the user readable name of a driver in the form of a
 669   Unicode string. If the driver specified by This has a user readable name in
 670   the language specified by Language, then a pointer to the driver name is
 671   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
 672   by This does not support the language specified by Language,
 673   then EFI_UNSUPPORTED is returned.
 674
 675   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 676                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 677
 678   @param  Language[in]          A pointer to a Null-terminated ASCII string
 679                                 array indicating the language. This is the
 680                                 language of the driver name that the caller is
 681                                 requesting, and it must match one of the
 682                                 languages specified in SupportedLanguages. The
 683                                 number of languages supported by a driver is up
 684                                 to the driver writer. Language is specified
 685                                 in RFC 4646 or ISO 639-2 language code format.
 686
 687   @param  DriverName[out]       A pointer to the Unicode string to return.
 688                                 This Unicode string is the name of the
 689                                 driver specified by This in the language
 690                                 specified by Language.
 691
 692   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
 693                                 This and the language specified by Language was
 694                                 returned in DriverName.
 695
 696   @retval EFI_INVALID_PARAMETER Language is NULL.
 697
 698   @retval EFI_INVALID_PARAMETER DriverName is NULL.
 699
 700   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 701                                 the language specified by Language.
 702
 703 **/
 704 EFI_STATUS
 705 EFIAPI
 706 TerminalComponentNameGetDriverName (
 707   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 708   IN  CHAR8                        *Language,
 709   OUT CHAR16                       **DriverName
 710   );
 711
 712
 713 /**
 714   Retrieves a Unicode string that is the user readable name of the controller
 715   that is being managed by a driver.
 716
 717   This function retrieves the user readable name of the controller specified by
 718   ControllerHandle and ChildHandle in the form of a Unicode string. If the
 719   driver specified by This has a user readable name in the language specified by
 720   Language, then a pointer to the controller name is returned in ControllerName,
 721   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
 722   managing the controller specified by ControllerHandle and ChildHandle,
 723   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
 724   support the language specified by Language, then EFI_UNSUPPORTED is returned.
 725
 726   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 727                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 728
 729   @param  ControllerHandle[in]  The handle of a controller that the driver
 730                                 specified by This is managing.  This handle
 731                                 specifies the controller whose name is to be
 732                                 returned.
 733
 734   @param  ChildHandle[in]       The handle of the child controller to retrieve
 735                                 the name of.  This is an optional parameter that
 736                                 may be NULL.  It will be NULL for device
 737                                 drivers.  It will also be NULL for a bus drivers
 738                                 that wish to retrieve the name of the bus
 739                                 controller.  It will not be NULL for a bus
 740                                 driver that wishes to retrieve the name of a
 741                                 child controller.
 742
 743   @param  Language[in]          A pointer to a Null-terminated ASCII string
 744                                 array indicating the language.  This is the
 745                                 language of the driver name that the caller is
 746                                 requesting, and it must match one of the
 747                                 languages specified in SupportedLanguages. The
 748                                 number of languages supported by a driver is up
 749                                 to the driver writer. Language is specified in
 750                                 RFC 4646 or ISO 639-2 language code format.
 751
 752   @param  ControllerName[out]   A pointer to the Unicode string to return.
 753                                 This Unicode string is the name of the
 754                                 controller specified by ControllerHandle and
 755                                 ChildHandle in the language specified by
 756                                 Language from the point of view of the driver
 757                                 specified by This.
 758
 759   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 760                                 the language specified by Language for the
 761                                 driver specified by This was returned in
 762                                 DriverName.
 763
 764   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 765
 766   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 767                                 EFI_HANDLE.
 768
 769   @retval EFI_INVALID_PARAMETER Language is NULL.
 770
 771   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 772
 773   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 774                                 managing the controller specified by
 775                                 ControllerHandle and ChildHandle.
 776
 777   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 778                                 the language specified by Language.
 779
 780 **/
 781 EFI_STATUS
 782 EFIAPI
 783 TerminalComponentNameGetControllerName (
 784   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 785   IN  EFI_HANDLE                                      ControllerHandle,
 786   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 787   IN  CHAR8                                           *Language,
 788   OUT CHAR16                                          **ControllerName
 789   );
 790
 791
 792 //
 793 // internal functions
 794 //
 795
 796 /**
 797   Check for a pending key in the Efi Key FIFO or Serial device buffer.
 798
 799   @param  This                     Indicates the calling context.
 800
 801   @retval EFI_SUCCESS              There is key pending.
 802   @retval EFI_NOT_READY            There is no key pending.
 803   @retval EFI_DEVICE_ERROR         If Serial IO is not attached to serial device.
 804
 805 **/
 806 EFI_STATUS
 807 TerminalConInCheckForKey (
 808   IN  EFI_SIMPLE_TEXT_INPUT_PROTOCOL  *This
 809   );
 810
 811 /**
 812   Update terminal device path in Console Device Environment Variables.
 813
 814   @param  VariableName           The Console Device Environment Variable.
 815   @param  ParentDevicePath       The terminal device path to be updated.
 816
 817   @return None.
 818
 819 **/
 820 VOID
 821 TerminalUpdateConsoleDevVariable (
 822   IN CHAR16                    *VariableName,
 823   IN EFI_DEVICE_PATH_PROTOCOL  *ParentDevicePath
 824   );
 825
 826 /**
 827   Remove console device variable.
 828
 829   @param  VariableName           A pointer to the variable name.
 830   @param  ParentDevicePath       A pointer to the parent device path.
 831
 832 **/
 833 VOID
 834 TerminalRemoveConsoleDevVariable (
 835   IN CHAR16                    *VariableName,
 836   IN EFI_DEVICE_PATH_PROTOCOL  *ParentDevicePath
 837   );
 838
 839 /**
 840   Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
 841   buffer, and the size of the buffer. On failure return NULL.
 842
 843   @param  Name                   String part of EFI variable name
 844   @param  VendorGuid             GUID part of EFI variable name
 845   @param  VariableSize           Returns the size of the EFI variable that was read
 846
 847   @return Dynamically allocated memory that contains a copy of the EFI variable.
 848           Caller is repsoncible freeing the buffer. If variable was not read,
 849           NULL regturned.
 850
 851 **/
 852 VOID *
 853 TerminalGetVariableAndSize (
 854   IN  CHAR16              *Name,
 855   IN  EFI_GUID            *VendorGuid,
 856   OUT UINTN               *VariableSize
 857   );
 858
 859 /**
 860   Build termial device path according to terminal type.
 861
 862   @param  TerminalType           The terminal type is PC ANSI, VT100, VT100+ or VT-UTF8.
 863   @param  ParentDevicePath       Parent device path.
 864   @param  TerminalDevicePath     Returned terminal device path, if building successfully.
 865
 866   @retval EFI_UNSUPPORTED        Terminal does not belong to the supported type.
 867   @retval EFI_OUT_OF_RESOURCES   Generate terminal device path failed.
 868   @retval EFI_SUCCESS            Build terminal device path successfully.
 869
 870 **/
 871 EFI_STATUS
 872 SetTerminalDevicePath (
 873   IN  UINT8                       TerminalType,
 874   IN  EFI_DEVICE_PATH_PROTOCOL    *ParentDevicePath,
 875   OUT EFI_DEVICE_PATH_PROTOCOL    **TerminalDevicePath
 876   );
 877
 878 /**
 879   Get one key out of serial buffer.
 880
 881   @param  SerialIo           Serial I/O protocl attached to the serial device.
 882   @param  Input              The fetched key.
 883
 884   @retval EFI_NOT_READY      If serial buffer is empty.
 885   @retval EFI_DEVICE_ERROR   If reading serial buffer encounter error.
 886   @retval EFI_SUCCESS        If reading serial buffer successfully, put
 887                              the fetched key to the parameter output.
 888
 889 **/
 890 EFI_STATUS
 891 GetOneKeyFromSerial (
 892   EFI_SERIAL_IO_PROTOCOL  *SerialIo,
 893   UINT8                   *Input
 894   );
 895
 896 /**
 897   Insert one byte raw data into the Raw Data FIFO.
 898
 899   @param  TerminalDevice       Terminal driver private structure.
 900   @param  Input                The key will be input.
 901
 902   @retval TRUE                 If insert successfully.
 903   @retval FLASE                If Raw Data buffer is full before key insertion,
 904                                and the key is lost.
 905
 906 **/
 907 BOOLEAN
 908 RawFiFoInsertOneKey (
 909   TERMINAL_DEV  *TerminalDevice,
 910   UINT8         Input
 911   );
 912
 913 /**
 914   Remove one pre-fetched key out of the Raw Data FIFO.
 915
 916   @param  TerminalDevice       Terminal driver private structure.
 917   @param  Output               The key will be removed.
 918
 919   @retval TRUE                 If insert successfully.
 920   @retval FLASE                If Raw Data FIFO buffer is empty before remove operation.
 921
 922 **/
 923 BOOLEAN
 924 RawFiFoRemoveOneKey (
 925   TERMINAL_DEV  *TerminalDevice,
 926   UINT8         *Output
 927   );
 928
 929 /**
 930   Clarify whether Raw Data FIFO buffer is empty.
 931
 932   @param  TerminalDevice       Terminal driver private structure
 933
 934   @retval TRUE                 If Raw Data FIFO buffer is empty.
 935   @retval FLASE                If Raw Data FIFO buffer is not empty.
 936
 937 **/
 938 BOOLEAN
 939 IsRawFiFoEmpty (
 940   TERMINAL_DEV  *TerminalDevice
 941   );
 942
 943 /**
 944   Clarify whether Raw Data FIFO buffer is full.
 945
 946   @param  TerminalDevice       Terminal driver private structure
 947
 948   @retval TRUE                 If Raw Data FIFO buffer is full.
 949   @retval FLASE                If Raw Data FIFO buffer is not full.
 950
 951 **/
 952 BOOLEAN
 953 IsRawFiFoFull (
 954   TERMINAL_DEV  *TerminalDevice
 955   );
 956
 957 /**
 958   Insert one pre-fetched key into the FIFO buffer.
 959
 960   @param  TerminalDevice       Terminal driver private structure.
 961   @param  Key                  The key will be input.
 962
 963   @retval TRUE                 If insert successfully.
 964   @retval FLASE                If FIFO buffer is full before key insertion,
 965                                and the key is lost.
 966
 967 **/
 968 BOOLEAN
 969 EfiKeyFiFoInsertOneKey (
 970   TERMINAL_DEV      *TerminalDevice,
 971   EFI_INPUT_KEY     Key
 972   );
 973
 974 /**
 975   Remove one pre-fetched key out of the FIFO buffer.
 976
 977   @param  TerminalDevice       Terminal driver private structure.
 978   @param  Output               The key will be removed.
 979
 980   @retval TRUE                 If insert successfully.
 981   @retval FLASE                If FIFO buffer is empty before remove operation.
 982
 983 **/
 984 BOOLEAN
 985 EfiKeyFiFoRemoveOneKey (
 986   TERMINAL_DEV  *TerminalDevice,
 987   EFI_INPUT_KEY *Output
 988   );
 989
 990 /**
 991   Clarify whether FIFO buffer is empty.
 992
 993   @param  TerminalDevice       Terminal driver private structure
 994
 995   @retval TRUE                 If FIFO buffer is empty.
 996   @retval FLASE                If FIFO buffer is not empty.
 997
 998 **/
 999 BOOLEAN
1000 IsEfiKeyFiFoEmpty (
1001   TERMINAL_DEV  *TerminalDevice
1002   );
1003
1004 /**
1005   Clarify whether FIFO buffer is full.
1006
1007   @param  TerminalDevice       Terminal driver private structure
1008
1009   @retval TRUE                 If FIFO buffer is full.
1010   @retval FLASE                If FIFO buffer is not full.
1011
1012 **/
1013 BOOLEAN
1014 IsEfiKeyFiFoFull (
1015   TERMINAL_DEV  *TerminalDevice
1016   );
1017
1018 /**
1019   Insert one pre-fetched key into the Unicode FIFO buffer.
1020
1021   @param  TerminalDevice       Terminal driver private structure.
1022   @param  Input                The key will be input.
1023
1024   @retval TRUE                 If insert successfully.
1025   @retval FLASE                If Unicode FIFO buffer is full before key insertion,
1026                                and the key is lost.
1027
1028 **/
1029 BOOLEAN
1030 UnicodeFiFoInsertOneKey (
1031   TERMINAL_DEV      *TerminalDevice,
1032   UINT16            Input
1033   );
1034
1035 /**
1036   Remove one pre-fetched key out of the Unicode FIFO buffer.
1037
1038   @param  TerminalDevice       Terminal driver private structure.
1039   @param  Output               The key will be removed.
1040
1041   @retval TRUE                 If insert successfully.
1042   @retval FLASE                If Unicode FIFO buffer is empty before remove operation.
1043
1044 **/
1045 BOOLEAN
1046 UnicodeFiFoRemoveOneKey (
1047   TERMINAL_DEV  *TerminalDevice,
1048   UINT16        *Output
1049   );
1050
1051 /**
1052   Clarify whether Unicode FIFO buffer is empty.
1053
1054   @param  TerminalDevice       Terminal driver private structure
1055
1056   @retval TRUE                 If Unicode FIFO buffer is empty.
1057   @retval FLASE                If Unicode FIFO buffer is not empty.
1058
1059 **/
1060 BOOLEAN
1061 IsUnicodeFiFoEmpty (
1062   TERMINAL_DEV  *TerminalDevice
1063   );
1064
1065 /**
1066   Clarify whether Unicode FIFO buffer is full.
1067
1068   @param  TerminalDevice       Terminal driver private structure
1069
1070   @retval TRUE                 If Unicode FIFO buffer is full.
1071   @retval FLASE                If Unicode FIFO buffer is not full.
1072
1073 **/
1074 BOOLEAN
1075 IsUnicodeFiFoFull (
1076   TERMINAL_DEV  *TerminalDevice
1077   );
1078
1079 /**
1080   Count Unicode FIFO buffer.
1081
1082   @param  TerminalDevice       Terminal driver private structure
1083
1084   @return The count in bytes of Unicode FIFO.
1085
1086 **/
1087 UINT8
1088 UnicodeFiFoGetKeyCount (
1089   TERMINAL_DEV    *TerminalDevice
1090   );
1091
1092 /**
1093   Translate raw data into Unicode (according to different encode), and
1094   translate Unicode into key information. (according to different standard).
1095
1096   @param  TerminalDevice       Terminal driver private structure.
1097
1098 **/
1099 VOID
1100 TranslateRawDataToEfiKey (
1101   IN  TERMINAL_DEV      *TerminalDevice
1102   );
1103
1104 //
1105 // internal functions for PC ANSI
1106 //
1107
1108 /**
1109   Translate all raw data in the Raw FIFI into unicode, and insert
1110   them into Unicode FIFO.
1111
1112   @param TerminalDevice          The terminal device.
1113
1114 **/
1115 VOID
1116 AnsiRawDataToUnicode (
1117   IN  TERMINAL_DEV    *TerminalDevice
1118   );
1119
1120 /**
1121   Converts a stream of Unicode characters from a terminal input device into EFI Keys that
1122   can be read through the Simple Input Protocol.
1123
1124   The table below shows the keyboard input mappings that this function supports.
1125   If the ESC sequence listed in one of the columns is presented, then it is translated
1126   into the coorespoding EFI Scan Code.  If a matching sequence is not found, then the raw
1127   key strokes are converted into EFI Keys.
1128
1129   2 seconds are allowed for an ESC sequence to be completed.  If the ESC sequence is not
1130   completed in 2 seconds, then the raw key strokes of the partial ESC sequence are
1131   converted into EFI Keys.
1132   There is one special input sequence that will force the system to reset.
1133   This is ESC R ESC r ESC R.
1134
1135   Symbols used in table below
1136   ===========================
1137     ESC = 0x1B
1138     CSI = 0x9B
1139     DEL = 0x7f
1140     ^   = CTRL
1141   +=========+======+===========+==========+==========+
1142   |         | EFI  | UEFI 2.0  |          |          |
1143   |         | Scan |           |  VT100+  |          |
1144   |   KEY   | Code |  PC ANSI  |  VTUTF8  |   VT100  |
1145   +=========+======+===========+==========+==========+
1146   | NULL    | 0x00 |           |          |          |
1147   | UP      | 0x01 | ESC [ A   | ESC [ A  | ESC [ A  |
1148   | DOWN    | 0x02 | ESC [ B   | ESC [ B  | ESC [ B  |
1149   | RIGHT   | 0x03 | ESC [ C   | ESC [ C  | ESC [ C  |
1150   | LEFT    | 0x04 | ESC [ D   | ESC [ D  | ESC [ D  |
1151   | HOME    | 0x05 | ESC [ H   | ESC h    | ESC [ H  |
1152   | END     | 0x06 | ESC [ F   | ESC k    | ESC [ K  |
1153   | INSERT  | 0x07 | ESC [ @   | ESC +    | ESC [ @  |
1154   |         |      | ESC [ L   |          | ESC [ L  |
1155   | DELETE  | 0x08 | ESC [ X   | ESC -    | ESC [ P  |
1156   | PG UP   | 0x09 | ESC [ I   | ESC ?    | ESC [ V  |
1157   |         |      |           |          | ESC [ ?  |
1158   | PG DOWN | 0x0A | ESC [ G   | ESC /    | ESC [ U  |
1159   |         |      |           |          | ESC [ /  |
1160   | F1      | 0x0B | ESC [ M   | ESC 1    | ESC O P  |
1161   | F2      | 0x0C | ESC [ N   | ESC 2    | ESC O Q  |
1162   | F3      | 0x0D | ESC [ O   | ESC 3    | ESC O w  |
1163   | F4      | 0x0E | ESC [ P   | ESC 4    | ESC O x  |
1164   | F5      | 0x0F | ESC [ Q   | ESC 5    | ESC O t  |
1165   | F6      | 0x10 | ESC [ R   | ESC 6    | ESC O u  |
1166   | F7      | 0x11 | ESC [ S   | ESC 7    | ESC O q  |
1167   | F8      | 0x12 | ESC [ T   | ESC 8    | ESC O r  |
1168   | F9      | 0x13 | ESC [ U   | ESC 9    | ESC O p  |
1169   | F10     | 0x14 | ESC [ V   | ESC 0    | ESC O M  |
1170   | Escape  | 0x17 | ESC       | ESC      | ESC      |
1171   | F11     | 0x15 |           | ESC !    |          |
1172   | F12     | 0x16 |           | ESC @    |          |
1173   +=========+======+===========+==========+==========+
1174
1175   Special Mappings
1176   ================
1177   ESC R ESC r ESC R = Reset System
1178
1179
1180   @param TerminalDevice   The terminal device to use to translate raw input into EFI Keys
1181
1182 **/
1183 VOID
1184 UnicodeToEfiKey (
1185   IN  TERMINAL_DEV    *TerminalDevice
1186   );
1187
1188 /**
1189   Check if input string is valid Ascii string, valid EFI control characters
1190   or valid text graphics.
1191
1192   @param  TerminalDevice          The terminal device.
1193   @param  WString                 The input string.
1194
1195   @retval EFI_UNSUPPORTED         If not all input characters are valid.
1196   @retval EFI_SUCCESS             If all input characters are valid.
1197
1198 **/
1199 EFI_STATUS
1200 AnsiTestString (
1201   IN  TERMINAL_DEV    *TerminalDevice,
1202   IN  CHAR16          *WString
1203   );
1204
1205 //
1206 // internal functions for VTUTF8
1207 //
1208
1209 /**
1210   Translate all VT-UTF8 characters in the Raw FIFI into unicode characters,
1211   and insert them into Unicode FIFO.
1212
1213   @param VtUtf8Device          The terminal device.
1214
1215 **/
1216 VOID
1217 VTUTF8RawDataToUnicode (
1218   IN  TERMINAL_DEV    *VtUtf8Device
1219   );
1220
1221 /**
1222   Check if input string is valid VT-UTF8 string.
1223
1224   @param  TerminalDevice          The terminal device.
1225   @param  WString                 The input string.
1226
1227   @retval EFI_SUCCESS             If all input characters are valid.
1228
1229 **/
1230 EFI_STATUS
1231 VTUTF8TestString (
1232   IN  TERMINAL_DEV    *TerminalDevice,
1233   IN  CHAR16          *WString
1234   );
1235
1236 /**
1237   Translate one Unicode character into VT-UTF8 characters.
1238
1239   UTF8 Encoding Table
1240   Bits per Character | Unicode Character Range | Unicode Binary  Encoding |     UTF8 Binary Encoding
1241         0-7              |     0x0000 - 0x007F      |     00000000 0xxxxxxx        |   0xxxxxxx
1242         8-11           |     0x0080 - 0x07FF        |     00000xxx xxxxxxxx       |   110xxxxx 10xxxxxx
1243        12-16            |     0x0800 - 0xFFFF       |     xxxxxxxx xxxxxxxx        |   1110xxxx 10xxxxxx 10xxxxxx
1244
1245
1246   @param  Unicode          Unicode character need translating.
1247   @param  Utf8Char         Return VT-UTF8 character set.
1248   @param  ValidBytes       The count of valid VT-UTF8 characters. If
1249                            ValidBytes is zero, no valid VT-UTF8 returned.
1250
1251 **/
1252 VOID
1253 UnicodeToUtf8 (
1254   IN  CHAR16      Unicode,
1255   OUT UTF8_CHAR   *Utf8Char,
1256   OUT UINT8       *ValidBytes
1257   );
1258
1259 /**
1260   Get one valid VT-UTF8 characters set from Raw Data FIFO.
1261
1262   @param  Utf8Device          The terminal device.
1263   @param  Utf8Char            Returned valid VT-UTF8 characters set.
1264   @param  ValidBytes          The count of returned VT-VTF8 characters.
1265                               If ValidBytes is zero, no valid VT-UTF8 returned.
1266
1267 **/
1268 VOID
1269 GetOneValidUtf8Char (
1270   IN  TERMINAL_DEV      *Utf8Device,
1271   OUT UTF8_CHAR         *Utf8Char,
1272   OUT UINT8             *ValidBytes
1273   );
1274
1275 /**
1276   Translate VT-UTF8 characters into one Unicode character.
1277
1278   UTF8 Encoding Table
1279   Bits per Character | Unicode Character Range | Unicode Binary  Encoding |     UTF8 Binary Encoding
1280         0-7              |     0x0000 - 0x007F      |     00000000 0xxxxxxx        |   0xxxxxxx
1281         8-11           |     0x0080 - 0x07FF        |     00000xxx xxxxxxxx       |   110xxxxx 10xxxxxx
1282        12-16            |     0x0800 - 0xFFFF       |     xxxxxxxx xxxxxxxx        |   1110xxxx 10xxxxxx 10xxxxxx
1283
1284
1285   @param  Utf8Char         VT-UTF8 character set needs translating.
1286   @param  ValidBytes       The count of valid VT-UTF8 characters.
1287   @param  UnicodeChar      Returned unicode character.
1288
1289 **/
1290 VOID
1291 Utf8ToUnicode (
1292   IN  UTF8_CHAR       Utf8Char,
1293   IN  UINT8           ValidBytes,
1294   OUT CHAR16          *UnicodeChar
1295   );
1296
1297 //
1298 // functions for boxdraw unicode
1299 //
1300
1301 /**
1302   Detects if a Unicode char is for Box Drawing text graphics.
1303
1304   @param  Graphic      Unicode char to test.
1305   @param  PcAnsi       Optional pointer to return PCANSI equivalent of
1306                        Graphic.
1307   @param  Ascii        Optional pointer to return ASCII equivalent of
1308                        Graphic.
1309
1310   @retval TRUE         If Graphic is a supported Unicode Box Drawing character.
1311
1312 **/
1313 BOOLEAN
1314 TerminalIsValidTextGraphics (
1315   IN  CHAR16  Graphic,
1316   OUT CHAR8   *PcAnsi, OPTIONAL
1317   OUT CHAR8   *Ascii OPTIONAL
1318   );
1319
1320 /**
1321   Detects if a valid ASCII char.
1322
1323   @param  Ascii        An ASCII character.
1324
1325   @retval TRUE         If it is a valid ASCII character.
1326   @retval FALSE        If it is not a valid ASCII character.
1327
1328 **/
1329 BOOLEAN
1330 TerminalIsValidAscii (
1331   IN  CHAR16  Ascii
1332   );
1333
1334 /**
1335   Detects if a valid EFI control character.
1336
1337   @param  CharC        An input EFI Control character.
1338
1339   @retval TRUE         If it is a valid EFI control character.
1340   @retval FALSE        If it is not a valid EFI control character.
1341
1342 **/
1343 BOOLEAN
1344 TerminalIsValidEfiCntlChar (
1345   IN  CHAR16  CharC
1346   );
1347
1348 /**
1349   Check if the device supports hot-plug through its device path.
1350
1351   This function could be updated to check more types of Hot Plug devices.
1352   Currently, it checks USB and PCCard device.
1353
1354   @param  DevicePath            Pointer to device's device path.
1355
1356   @retval TRUE                  The devcie is a hot-plug device
1357   @retval FALSE                 The devcie is not a hot-plug device.
1358
1359 **/
1360 BOOLEAN
1361 IsHotPlugDevice (
1362   IN  EFI_DEVICE_PATH_PROTOCOL    *DevicePath
1363   );
1364
1365 #endif