diff options
| author | Dandan Bi <dandan.bi@intel.com> | 2017-06-15 13:43:00 +0800 |
|---|---|---|
| committer | Hao Wu <hao.a.wu@intel.com> | 2017-06-20 09:29:41 +0800 |
| commit | d4225da16f80dbb588d6cd89e3a6e3f7f16decf3 (patch) | |
| tree | 334dfa1cb2df34e7b9d98814f80c3d5165d28a9b /MdePkg | |
| parent | 53fa87286b9348d285654dda1ab2274241358ffc (diff) | |
| download | edk2-d4225da16f80dbb588d6cd89e3a6e3f7f16decf3.tar.gz edk2-d4225da16f80dbb588d6cd89e3a6e3f7f16decf3.tar.bz2 edk2-d4225da16f80dbb588d6cd89e3a6e3f7f16decf3.zip | |
MdePkg/SimpleTextInEx: Update comments according to UEFI 2.7 spec
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>
Diffstat (limited to 'MdePkg')
| -rw-r--r-- | MdePkg/Include/Protocol/SimpleTextInEx.h | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h b/MdePkg/Include/Protocol/SimpleTextInEx.h index 436ff37b14..4591bd4779 100644 --- a/MdePkg/Include/Protocol/SimpleTextInEx.h +++ b/MdePkg/Include/Protocol/SimpleTextInEx.h @@ -5,7 +5,7 @@ which exposes much more state and modifier information from the input device,
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
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
@@ -251,18 +251,19 @@ EFI_STATUS @param KeyData A pointer to a buffer that is filled in with
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
- called when the key sequence
- is typed specified by KeyData.
+ @param KeyNotificationFunction Points to the function to be called when the key 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 device state was set
- appropriately.
+ @retval EFI_SUCCESS Key notify was registered successfully.
@retval EFI_OUT_OF_RESOURCES Unable to allocate necessary
data structures.
@@ -286,7 +287,7 @@ EFI_STATUS @param NotificationHandle The handle of the notification
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
invalid.
|