Re: [patch 1/8] MdePkg/SimpleTextInEx: Update comments according to UEFI 2.7 spec

["Ni, Ruiyu" <ruiyu.ni@intel.com>]

Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>

Thanks/Ray

> -----Original Message-----
> From: Bi, Dandan
> Sent: Monday, June 19, 2017 9:21 AM
> To: edk2-devel@lists.01.org
> Cc: Gao, Liming <liming.gao@intel.com>; Zeng, Star <star.zeng@intel.com>;
> Ni, Ruiyu <ruiyu.ni@intel.com>
> Subject: [patch 1/8] 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>
> ---
>  MdePkg/Include/Protocol/SimpleTextInEx.h | 17 +++++++++--------
>  1 file changed, 9 insertions(+), 8 deletions(-)
> 
> diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h
> b/MdePkg/Include/Protocol/SimpleTextInEx.h
> index 436ff37..89f638a 100644
> --- a/MdePkg/Include/Protocol/SimpleTextInEx.h
> +++ b/MdePkg/Include/Protocol/SimpleTextInEx.h
> @@ -3,11 +3,11 @@
> 
>    This protocol defines an extension to the
> EFI_SIMPLE_TEXT_INPUT_PROTOCOL
>    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
>    http://opensource.org/licenses/bsd-license.php
> 
> @@ -249,22 +249,23 @@ EFI_STATUS
> 
>    @param This                     A pointer to the
> EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
> 
>    @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.
> 
>  **/
> @@ -284,11 +285,11 @@ EFI_STATUS
>    @param This               A pointer to the
> EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
> 
>    @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.
> 
>  **/
> --
> 1.9.5.msysgit.1