TerminalConIn.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Implementation for EFI_SIMPLE_TEXT_INPUT_PROTOCOL protocol.
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "Terminal.h"
/**
Reads the next keystroke from the input device. The WaitForKey Event can
be used to test for existence of a keystroke via WaitForEvent () call.
@param TerminalDevice Terminal driver private structure
@param KeyData A pointer to a buffer that is filled in with the
keystroke state data for the key that was
pressed.
@retval EFI_SUCCESS The keystroke information was returned.
@retval EFI_NOT_READY There was no keystroke data available.
@retval EFI_INVALID_PARAMETER KeyData is NULL.
**/
)
{
return EFI_INVALID_PARAMETER;
}
return EFI_NOT_READY;
}
return EFI_SUCCESS;
}
/**
Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.Reset().
This driver only perform dependent serial device reset regardless of
the value of ExtendeVerification
@param This Indicates the calling context.
@param ExtendedVerification Skip by this driver.
@retval EFI_SUCCESS The reset operation succeeds.
@retval EFI_DEVICE_ERROR The dependent serial port reset fails.
**/
)
{
//
// Report progress code here
//
);
//
// Make all the internal buffer empty for keys
//
);
}
return Status;
}
/**
Implements EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().
@param This Indicates the calling context.
@param Key A pointer to a buffer that is filled in with the
keystroke information for the key that was sent
from terminal.
@retval EFI_SUCCESS The keystroke information is returned successfully.
@retval EFI_NOT_READY There is no keystroke data available.
@retval EFI_DEVICE_ERROR The dependent serial device encounters error.
**/
)
{
//
// get TERMINAL_DEV from "This" parameter.
//
return Status;
}
return EFI_SUCCESS;
}
/**
Check if the key already has been registered.
If both RegsiteredData and InputData is NULL, then ASSERT().
@param RegsiteredData A pointer to a buffer that is filled in with the
keystroke state data for the key that was
registered.
@param InputData A pointer to a buffer that is filled in with the
keystroke state data for the key that was
pressed.
@retval TRUE Key be pressed matches a registered key.
@retval FLASE Match failed.
**/
)
{
return FALSE;
}
return TRUE;
}
/**
Event notification function for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event
Signal the event if there is key available
@param Event Indicates the event that invoke this function.
@param Context Indicates the calling context.
**/
)
{
}
//
// Simple Text Input Ex protocol functions
//
/**
Reset the input device and optionally run diagnostics
@param This Protocol instance pointer.
@param ExtendedVerification Driver may perform diagnostics on reset.
@retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The device is not functioning properly and could
not be reset.
**/
)
{
return EFI_DEVICE_ERROR;
}
return EFI_SUCCESS;
}
/**
Reads the next keystroke from the input device. The WaitForKey Event can
be used to test for existence of a keystroke via WaitForEvent () call.
@param This Protocol instance pointer.
@param KeyData A pointer to a buffer that is filled in with the
keystroke state data for the key that was
pressed.
@retval EFI_SUCCESS The keystroke information was returned.
@retval EFI_NOT_READY There was no keystroke data available.
@retval EFI_DEVICE_ERROR The keystroke information was not returned due
to hardware errors.
@retval EFI_INVALID_PARAMETER KeyData is NULL.
**/
)
{
return EFI_INVALID_PARAMETER;
}
}
/**
Set certain state for the input device.
@param This Protocol instance pointer.
@param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the
state for the input device.
@retval EFI_SUCCESS The device state was set successfully.
@retval EFI_DEVICE_ERROR The device is not functioning correctly and
could not have the setting adjusted.
@retval EFI_UNSUPPORTED The device does not have the ability to set its
state.
@retval EFI_INVALID_PARAMETER KeyToggleState is NULL.
**/
)
{
if (KeyToggleState == NULL) {
return EFI_INVALID_PARAMETER;
}
return EFI_SUCCESS;
}
/**
Register a notification function for a particular keystroke for the input device.
@param This Protocol instance pointer.
@param KeyData A pointer to a buffer that is filled in with the
keystroke information data for the key that was
pressed.
@param KeyNotificationFunction Points to the function to be called when the key
sequence is typed specified by KeyData.
@param NotifyHandle Points to the unique handle assigned to the
registered notification.
@retval EFI_SUCCESS The notification function was registered
successfully.
@retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necessary data
structures.
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.
**/
)
{
return EFI_INVALID_PARAMETER;
}
//
// Return EFI_SUCCESS if the (KeyData, NotificationFunction) is already registered.
//
for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList,Link); Link = GetNextNode (NotifyList,Link)) {
CurrentNotify = CR (
Link,
);
return EFI_SUCCESS;
}
}
}
//
// Allocate resource to save the notification function
//
NewNotify = (TERMINAL_CONSOLE_IN_EX_NOTIFY *) AllocateZeroPool (sizeof (TERMINAL_CONSOLE_IN_EX_NOTIFY));
return EFI_OUT_OF_RESOURCES;
}
return EFI_SUCCESS;
}
/**
Remove a registered notification function from a particular keystroke.
@param This Protocol instance pointer.
@param NotificationHandle The handle of the notification function being
unregistered.
@retval EFI_SUCCESS The notification function was unregistered
successfully.
@retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.
**/
)
{
if (NotificationHandle == NULL) {
return EFI_INVALID_PARAMETER;
}
if (((TERMINAL_CONSOLE_IN_EX_NOTIFY *) NotificationHandle)->Signature != TERMINAL_CONSOLE_IN_EX_NOTIFY_SIGNATURE) {
return EFI_INVALID_PARAMETER;
}
for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList,Link); Link = GetNextNode (NotifyList,Link)) {
CurrentNotify = CR (
Link,
);
//
// Remove the notification function from NotifyList and free resources
//
return EFI_SUCCESS;
}
}
//
// Can not find the matching entry in database.
//
return EFI_INVALID_PARAMETER;
}
/**
Translate raw data into Unicode (according to different encode), and
translate Unicode into key information. (according to different standard).
@param TerminalDevice Terminal driver private structure.
**/
)
{
switch (TerminalDevice->TerminalType) {
case PCANSITYPE:
case VT100TYPE:
case VT100PLUSTYPE:
break;
case VTUTF8TYPE:
//
// Process all the raw data in the RawFIFO,
// put the processed key into UnicodeFIFO.
//
//
// Translate all the Unicode data in the UnicodeFIFO to Efi key,
// then put into EfiKeyFIFO.
//
break;
}
}
/**
Event notification function for EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey event
Signal the event if there is key available
@param Event Indicates the event that invoke this function.
@param Context Indicates the calling context.
**/
)
{
//
// Someone is waiting on the keystroke event, if there's
// a key pending, signal the event
//
}
}
/**
Timer handler to poll the key from serial.
@param Event Indicates the event that invoke this function.
@param Context Indicates the calling context.
**/
)
{
return ;
}
//
// if current timeout value for serial device is not identical with
// the value saved in TERMINAL_DEV structure, then recalculate the
// timeout value again and set serial attribute according to this value.
//
SerialInTimeOut = 0;
//
// According to BAUD rate to calculate the timeout value.
//
}
);
} else {
}
}
//
// Check whether serial buffer is empty.
//
if ((Control & EFI_SERIAL_INPUT_BUFFER_EMPTY) == 0) {
//
// Fetch all the keys in the serial buffer,
// and insert the byte stream into RawFIFO.
//
while (!IsRawFiFoFull (TerminalDevice)) {
if (Status == EFI_DEVICE_ERROR) {
);
}
break;
}
}
}
//
// Translate all the raw data in RawFIFO into EFI Key,
// according to different terminal type supported.
//
}
/**
Get one key out of serial buffer.
@param SerialIo Serial I/O protocol attached to the serial device.
@param Output The fetched key.
@retval EFI_NOT_READY If serial buffer is empty.
@retval EFI_DEVICE_ERROR If reading serial buffer encounter error.
@retval EFI_SUCCESS If reading serial buffer successfully, put
the fetched key to the parameter output.
**/
)
{
Size = 1;
*Output = 0;
//
// Read one key from serial I/O device.
//
if (Status == EFI_TIMEOUT) {
return EFI_NOT_READY;
}
return EFI_DEVICE_ERROR;
}
if (*Output == 0) {
return EFI_NOT_READY;
}
return EFI_SUCCESS;
}
/**
Insert one byte raw data into the Raw Data FIFO.
@param TerminalDevice Terminal driver private structure.
@param Input The key will be input.
@retval TRUE If insert successfully.
@retval FLASE If Raw Data buffer is full before key insertion,
and the key is lost.
**/
)
{
if (IsRawFiFoFull (TerminalDevice)) {
//
// Raw FIFO is full
//
return FALSE;
}
return TRUE;
}
/**
Remove one pre-fetched key out of the Raw Data FIFO.
@param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
@retval TRUE If insert successfully.
@retval FLASE If Raw Data FIFO buffer is empty before remove operation.
**/
)
{
if (IsRawFiFoEmpty (TerminalDevice)) {
//
// FIFO is empty
//
*Output = 0;
return FALSE;
}
return TRUE;
}
/**
Clarify whether Raw Data FIFO buffer is empty.
@param TerminalDevice Terminal driver private structure
@retval TRUE If Raw Data FIFO buffer is empty.
@retval FLASE If Raw Data FIFO buffer is not empty.
**/
)
{
return TRUE;
} else {
return FALSE;
}
}
/**
Clarify whether Raw Data FIFO buffer is full.
@param TerminalDevice Terminal driver private structure
@retval TRUE If Raw Data FIFO buffer is full.
@retval FLASE If Raw Data FIFO buffer is not full.
**/
)
{
return TRUE;
}
return FALSE;
}
/**
Insert one pre-fetched key into the FIFO buffer.
@param TerminalDevice Terminal driver private structure.
@param Key The key will be input.
@retval TRUE If insert successfully.
@retval FLASE If FIFO buffer is full before key insertion,
and the key is lost.
**/
)
{
//
// Invoke notification functions if exist
//
for (Link = GetFirstNode (NotifyList); !IsNull (NotifyList,Link); Link = GetNextNode (NotifyList,Link)) {
CurrentNotify = CR (
Link,
);
}
}
if (IsEfiKeyFiFoFull (TerminalDevice)) {
//
// Efi Key FIFO is full
//
return FALSE;
}
return TRUE;
}
/**
Remove one pre-fetched key out of the FIFO buffer.
@param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
@retval TRUE If insert successfully.
@retval FLASE If FIFO buffer is empty before remove operation.
**/
)
{
if (IsEfiKeyFiFoEmpty (TerminalDevice)) {
//
// FIFO is empty
//
Output->UnicodeChar = 0;
return FALSE;
}
return TRUE;
}
/**
Clarify whether FIFO buffer is empty.
@param TerminalDevice Terminal driver private structure
@retval TRUE If FIFO buffer is empty.
@retval FLASE If FIFO buffer is not empty.
**/
)
{
return TRUE;
} else {
return FALSE;
}
}
/**
Clarify whether FIFO buffer is full.
@param TerminalDevice Terminal driver private structure
@retval TRUE If FIFO buffer is full.
@retval FLASE If FIFO buffer is not full.
**/
)
{
return TRUE;
}
return FALSE;
}
/**
Insert one pre-fetched key into the Unicode FIFO buffer.
@param TerminalDevice Terminal driver private structure.
@param Input The key will be input.
@retval TRUE If insert successfully.
@retval FLASE If Unicode FIFO buffer is full before key insertion,
and the key is lost.
**/
)
{
if (IsUnicodeFiFoFull (TerminalDevice)) {
//
// Unicode FIFO is full
//
return FALSE;
}
return TRUE;
}
/**
Remove one pre-fetched key out of the Unicode FIFO buffer.
@param TerminalDevice Terminal driver private structure.
@param Output The key will be removed.
@retval TRUE If insert successfully.
@retval FLASE If Unicode FIFO buffer is empty before remove operation.
**/
)
{
if (IsUnicodeFiFoEmpty (TerminalDevice)) {
//
// FIFO is empty
//
return FALSE;
}
return TRUE;
}
/**
Clarify whether Unicode FIFO buffer is empty.
@param TerminalDevice Terminal driver private structure
@retval TRUE If Unicode FIFO buffer is empty.
@retval FLASE If Unicode FIFO buffer is not empty.
**/
)
{
return TRUE;
} else {
return FALSE;
}
}
/**
Clarify whether Unicode FIFO buffer is full.
@param TerminalDevice Terminal driver private structure
@retval TRUE If Unicode FIFO buffer is full.
@retval FLASE If Unicode FIFO buffer is not full.
**/
)
{
return TRUE;
}
return FALSE;
}
/**
Count Unicode FIFO buffer.
@param TerminalDevice Terminal driver private structure
@return The count in bytes of Unicode FIFO.
**/
)
{
} else {
}
}
/**
Update the Unicode characters from a terminal input device into EFI Keys FIFO.
@param TerminalDevice The terminal device to use to translate raw input into EFI Keys
**/
)
{
if (IsEfiKeyFiFoFull (TerminalDevice)) {
return;
}
if ((InputState & INPUT_STATE_ESC) != 0) {
Key.UnicodeChar = 0;
}
if ((InputState & INPUT_STATE_CSI) != 0) {
}
if ((InputState & INPUT_STATE_LEFTOPENBRACKET) != 0) {
}
if ((InputState & INPUT_STATE_O) != 0) {
}
if ((InputState & INPUT_STATE_2) != 0) {
}
//
// Cancel the timer.
//
0
);
}
/**
Converts a stream of Unicode characters from a terminal input device into EFI Keys that
can be read through the Simple Input Protocol.
The table below shows the keyboard input mappings that this function supports.
If the ESC sequence listed in one of the columns is presented, then it is translated
into the corresponding EFI Scan Code. If a matching sequence is not found, then the raw
key strokes are converted into EFI Keys.
2 seconds are allowed for an ESC sequence to be completed. If the ESC sequence is not
completed in 2 seconds, then the raw key strokes of the partial ESC sequence are
converted into EFI Keys.
There is one special input sequence that will force the system to reset.
This is ESC R ESC r ESC R.
Note: current implementation support terminal types include: PC ANSI, VT100+/VTUTF8, VT100.
The table below is not same with UEFI Spec 2.3 Appendix B Table 201(not support ANSI X3.64 /
DEC VT200-500 and extra support PC ANSI, VT100)since UEFI Table 201 is just an example.
Symbols used in table below
===========================
ESC = 0x1B
CSI = 0x9B
DEL = 0x7f
^ = CTRL
+=========+======+===========+==========+==========+
| | EFI | UEFI 2.0 | | |
| | Scan | | VT100+ | |
| KEY | Code | PC ANSI | VTUTF8 | VT100 |
+=========+======+===========+==========+==========+
| NULL | 0x00 | | | |
| UP | 0x01 | ESC [ A | ESC [ A | ESC [ A |
| DOWN | 0x02 | ESC [ B | ESC [ B | ESC [ B |
| RIGHT | 0x03 | ESC [ C | ESC [ C | ESC [ C |
| LEFT | 0x04 | ESC [ D | ESC [ D | ESC [ D |
| HOME | 0x05 | ESC [ H | ESC h | ESC [ H |
| END | 0x06 | ESC [ F | ESC k | ESC [ K |
| INSERT | 0x07 | ESC [ @ | ESC + | ESC [ @ |
| | | ESC [ L | | ESC [ L |
| DELETE | 0x08 | ESC [ X | ESC - | ESC [ P |
| PG UP | 0x09 | ESC [ I | ESC ? | ESC [ V |
| | | | | ESC [ ? |
| PG DOWN | 0x0A | ESC [ G | ESC / | ESC [ U |
| | | | | ESC [ / |
| F1 | 0x0B | ESC [ M | ESC 1 | ESC O P |
| F2 | 0x0C | ESC [ N | ESC 2 | ESC O Q |
| F3 | 0x0D | ESC [ O | ESC 3 | ESC O w |
| F4 | 0x0E | ESC [ P | ESC 4 | ESC O x |
| F5 | 0x0F | ESC [ Q | ESC 5 | ESC O t |
| F6 | 0x10 | ESC [ R | ESC 6 | ESC O u |
| F7 | 0x11 | ESC [ S | ESC 7 | ESC O q |
| F8 | 0x12 | ESC [ T | ESC 8 | ESC O r |
| F9 | 0x13 | ESC [ U | ESC 9 | ESC O p |
| F10 | 0x14 | ESC [ V | ESC 0 | ESC O M |
| Escape | 0x17 | ESC | ESC | ESC |
| F11 | 0x15 | | ESC ! | |
| F12 | 0x16 | | ESC @ | |
+=========+======+===========+==========+==========+
Special Mappings
================
ESC R ESC r ESC R = Reset System
@param TerminalDevice The terminal device to use to translate raw input into EFI Keys
**/
)
{
if (!EFI_ERROR (TimerStatus)) {
}
//
// Check to see if the 2 seconds timer has expired
//
if (!EFI_ERROR (TimerStatus)) {
}
}
//
// Fetch one Unicode character from the Unicode FIFO
//
switch (TerminalDevice->InputState) {
case INPUT_STATE_DEFAULT:
break;
case INPUT_STATE_ESC:
if (UnicodeChar == LEFTOPENBRACKET) {
continue;
}
continue;
}
switch (UnicodeChar) {
case '1':
break;
case '2':
break;
case '3':
break;
case '4':
break;
case '5':
break;
case '6':
break;
case '7':
break;
case '8':
break;
case '9':
break;
case '0':
break;
case '!':
break;
case '@':
break;
case 'h':
break;
case 'k':
break;
case '+':
break;
case '-':
break;
case '/':
break;
case '?':
break;
default :
break;
}
}
switch (UnicodeChar) {
case 'R':
}
break;
case 'r':
}
break;
default :
break;
}
if (SetDefaultResetState) {
}
Key.UnicodeChar = 0;
continue;
}
break;
case INPUT_STATE_ESC | INPUT_STATE_O:
switch (UnicodeChar) {
case 'P':
break;
case 'Q':
break;
case 'w':
break;
case 'x':
break;
case 't':
break;
case 'u':
break;
case 'q':
break;
case 'r':
break;
case 'p':
break;
case 'M':
break;
default :
break;
}
}
Key.UnicodeChar = 0;
continue;
}
break;
switch (UnicodeChar) {
case 'A':
break;
case 'B':
break;
case 'C':
break;
case 'D':
break;
case 'H':
}
break;
case 'F':
}
break;
case 'K':
}
break;
case 'L':
case '@':
}
break;
case 'X':
}
break;
case 'P':
}
break;
case 'I':
}
break;
case 'V':
}
case '?':
}
break;
case 'G':
}
break;
case 'U':
}
case '/':
}
break;
case 'M':
}
break;
case 'N':
}
break;
case 'O':
}
break;
case 'Q':
}
break;
case 'R':
}
break;
case 'S':
}
break;
case 'T':
}
break;
default :
break;
}
}
Key.UnicodeChar = 0;
continue;
}
break;
default:
//
// Invalid state. This should never happen.
//
break;
}
if (UnicodeChar == ESC) {
}
if (UnicodeChar == CSI) {
}
(UINT64)20000000
);
continue;
}
if (SetDefaultResetState) {
}
if (UnicodeChar == DEL) {
Key.UnicodeChar = 0;
} else {
}
}
}