-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
-Module Name:\r
-\r
- terminal.h\r
+/** @file\r
+ Header file for Terminal driver.\r
\r
-Abstract:\r
+Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
\r
- \r
-Revision History\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
---*/\r
+**/\r
\r
#ifndef _TERMINAL_H\r
#define _TERMINAL_H\r
\r
Arguments:\r
\r
- RegsiteredData - A pointer to a buffer that is filled in with the keystroke \r
+ RegsiteredData - A pointer to a buffer that is filled in with the keystroke\r
state data for the key that was registered.\r
- InputData - A pointer to a buffer that is filled in with the keystroke \r
+ InputData - A pointer to a buffer that is filled in with the keystroke\r
state data for the key that was pressed.\r
\r
Returns:\r
TRUE - Key be pressed matches a registered key.\r
- FLASE - Match failed. \r
- \r
+ FLASE - Match failed.\r
+\r
--*/\r
;\r
\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-; \r
+;\r
//\r
// Simple Text Input Ex protocol prototypes\r
//\r
\r
Returns:\r
EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning properly and could \r
+ EFI_DEVICE_ERROR - The device is not functioning properly and could\r
not be reset.\r
\r
--*/\r
/*++\r
\r
Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can \r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
Arguments:\r
This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
+ KeyData - A pointer to a buffer that is filled in with the keystroke\r
state data for the key that was pressed.\r
\r
Returns:\r
EFI_SUCCESS - The keystroke information was returned.\r
EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keystroke information was not returned due to \r
+ EFI_DEVICE_ERROR - The keystroke information was not returned due to\r
hardware errors.\r
- EFI_INVALID_PARAMETER - KeyData is NULL. \r
+ EFI_INVALID_PARAMETER - KeyData is NULL.\r
\r
--*/\r
;\r
\r
Arguments:\r
This - Protocol instance pointer.\r
- KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r
+ KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the\r
state for the input device.\r
- \r
- Returns: \r
+\r
+ Returns:\r
EFI_SUCCESS - The device state was set successfully.\r
- EFI_DEVICE_ERROR - The device is not functioning correctly and could \r
+ EFI_DEVICE_ERROR - The device is not functioning correctly and could\r
not have the setting adjusted.\r
EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
- EFI_INVALID_PARAMETER - KeyToggleState is NULL. \r
+ EFI_INVALID_PARAMETER - KeyToggleState is NULL.\r
\r
---*/ \r
+--*/\r
;\r
\r
EFI_STATUS\r
\r
Arguments:\r
This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke \r
+ KeyData - A pointer to a buffer that is filled in with the keystroke\r
information data for the key that was pressed.\r
- KeyNotificationFunction - Points to the function to be called when the key \r
- sequence is typed specified by KeyData. \r
- NotifyHandle - Points to the unique handle assigned to the registered notification. \r
+ KeyNotificationFunction - Points to the function to be called when the key\r
+ sequence is typed specified by KeyData.\r
+ NotifyHandle - Points to the unique handle assigned to the registered notification.\r
\r
Returns:\r
EFI_SUCCESS - The notification function was registered successfully.\r
EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
- EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. \r
- \r
---*/ \r
+ EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL.\r
+\r
+--*/\r
;\r
\r
EFI_STATUS\r
Remove a registered notification function from a particular keystroke.\r
\r
Arguments:\r
- This - Protocol instance pointer. \r
+ This - Protocol instance pointer.\r
NotificationHandle - The handle of the notification function being unregistered.\r
\r
Returns:\r
EFI_SUCCESS - The notification function was unregistered successfully.\r
EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
- EFI_NOT_FOUND - Can not find the matching entry in database. \r
- \r
---*/ \r
+ EFI_NOT_FOUND - Can not find the matching entry in database.\r
+\r
+--*/\r
;\r
\r
VOID\r
projects / mirror_edk2.git / blobdiff