mirror of https://github.com/acidanthera/audk.git
IntelFrameworkModulePkg: Update comments in SimpleTextInEx
Update comments in SimpleTextInEx according to UEFI 2.7. Cc: Star Zeng <star.zeng@intel.com> Cc: Ruiyu Ni <ruiyu.ni@intel.com> Cc: Jeff Fan <jeff.fan@intel.com> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Dandan Bi <dandan.bi@intel.com> Reviewed-by: Star Zeng <star.zeng@intel.com> Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
This commit is contained in:
parent
d4225da16f
commit
cc9a430c51
|
@ -2,7 +2,7 @@
|
|||
Routines implements SIMPLE_TEXT_IN protocol's interfaces based on 8042 interfaces
|
||||
provided by Ps2KbdCtrller.c.
|
||||
|
||||
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2006 - 2017, 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
|
||||
|
@ -533,9 +533,13 @@ Exit:
|
|||
|
||||
@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.
|
||||
information data for the key that was pressed. If KeyData.Key,
|
||||
KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState
|
||||
are 0, then any incomplete keystroke will trigger a notification of
|
||||
the KeyNotificationFunction.
|
||||
@param KeyNotificationFunction Points to the function to be called when the key
|
||||
sequence is typed specified by KeyData.
|
||||
sequence is typed specified by KeyData. This notification function
|
||||
should be called at <=TPL_CALLBACK.
|
||||
@param NotifyHandle Points to the unique handle assigned to the registered notification.
|
||||
|
||||
@retval EFI_SUCCESS The notification function was registered successfully.
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
PS/2 keyboard driver header file
|
||||
|
||||
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2006 - 2017, 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
|
||||
|
@ -494,9 +494,13 @@ KeyboardSetState (
|
|||
|
||||
@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.
|
||||
information data for the key that was pressed. If KeyData.Key,
|
||||
KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState
|
||||
are 0, then any incomplete keystroke will trigger a notification of
|
||||
the KeyNotificationFunction.
|
||||
@param KeyNotificationFunction - Points to the function to be called when the key
|
||||
sequence is typed specified by KeyData.
|
||||
sequence is typed specified by KeyData. This notification function
|
||||
should be called at <=TPL_CALLBACK.
|
||||
@param NotifyHandle - Points to the unique handle assigned to the registered notification.
|
||||
|
||||
@retval EFI_SUCCESS - The notification function was registered successfully.
|
||||
|
|
|
@ -2313,17 +2313,20 @@ Exit:
|
|||
|
||||
@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.
|
||||
information data for the key that was pressed. If KeyData.Key,
|
||||
KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState
|
||||
are 0, then any incomplete keystroke will trigger a notification of
|
||||
the KeyNotificationFunction.
|
||||
@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.
|
||||
sequence is typed specified by KeyData. This notification function
|
||||
should be called at <=TPL_CALLBACK.
|
||||
@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 necesssary data structures.
|
||||
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.
|
||||
|
||||
**/
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
BiosKeyboardRegisterKeyNotify (
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
/** @file
|
||||
|
||||
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
|
||||
|
||||
This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions
|
||||
|
@ -635,17 +635,21 @@ BiosKeyboardSetState (
|
|||
|
||||
@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.
|
||||
information data for the key that was pressed. If KeyData.Key,
|
||||
KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState
|
||||
are 0, then any incomplete keystroke will trigger a notification of
|
||||
the KeyNotificationFunction.
|
||||
@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.
|
||||
sequence is typed specified by KeyData. This notification function
|
||||
should be called at <=TPL_CALLBACK.
|
||||
@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 necesssary data structures.
|
||||
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.
|
||||
|
||||
**/
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
BiosKeyboardRegisterKeyNotify (
|
||||
|
|
Loading…
Reference in New Issue