diff options
| author | Dandan Bi <dandan.bi@intel.com> | 2017-06-16 10:53:36 +0800 |
|---|---|---|
| committer | Hao Wu <hao.a.wu@intel.com> | 2017-06-20 09:29:41 +0800 |
| commit | cc9a430c519a5c9eba5b1ed3799055af6668194c (patch) | |
| tree | 26f7d6cc70490d3632e086eb556cc9703fb17249 /IntelFrameworkModulePkg/Csm | |
| parent | d4225da16f80dbb588d6cd89e3a6e3f7f16decf3 (diff) | |
| download | edk2-cc9a430c519a5c9eba5b1ed3799055af6668194c.zip edk2-cc9a430c519a5c9eba5b1ed3799055af6668194c.tar.gz edk2-cc9a430c519a5c9eba5b1ed3799055af6668194c.tar.bz2 | |
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>
Diffstat (limited to 'IntelFrameworkModulePkg/Csm')
| -rw-r--r-- | IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c | 15 | ||||
| -rw-r--r-- | IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h | 16 |
2 files changed, 19 insertions, 12 deletions
diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c index 742d009..7308523 100644 --- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c +++ b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c @@ -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 (
diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h index f38411a..0bf28ea 100644 --- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h +++ b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h @@ -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 (
|