sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

MdePkg/SimpleTextInEx: Update comments according to UEFI 2.7 spec

Browse Source 
Cc: Liming Gao <liming.gao@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@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:
Dandan Bi 2017-06-15 13:43:00 +08:00 committed by Hao Wu
parent 53fa87286b
commit d4225da16f
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
MdePkg/Include/Protocol/SimpleTextInEx.h
View File

@ -5,7 +5,7 @@
which exposes much more state and modifier information from the input device, which exposes much more state and modifier information from the input device,
also allows one to register a notification for a particular keystroke. also allows one to register a notification for a particular keystroke.
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -251,18 +251,19 @@ EFI_STATUS
@param KeyData A pointer to a buffer that is filled in with @param KeyData A pointer to a buffer that is filled in with
the keystroke information for the key that was the keystroke information for the key that was
pressed. 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 @param KeyNotificationFunction Points to the function to be called when the key sequence
called when the key sequence is typed specified by KeyData. This notification function
is typed specified by KeyData. should be called at <=TPL_CALLBACK.
@param NotifyHandle Points to the unique handle assigned to @param NotifyHandle Points to the unique handle assigned to
the registered notification. the registered notification.
@retval EFI_SUCCESS The device state was set @retval EFI_SUCCESS Key notify was registered successfully.
appropriately.
@retval EFI_OUT_OF_RESOURCES Unable to allocate necessary @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary
data structures. data structures.
@ -286,7 +287,7 @@ EFI_STATUS
@param NotificationHandle The handle of the notification @param NotificationHandle The handle of the notification
function being unregistered. function being unregistered.
@retval EFI_SUCCESS The device state was set appropriately. @retval EFI_SUCCESS Key notify was unregistered successfully.
@retval EFI_INVALID_PARAMETER The NotificationHandle is @retval EFI_INVALID_PARAMETER The NotificationHandle is
invalid. invalid.