Re: [patch 2/8] IntelFrameworkModulePkg: Update comments in SimpleTextInEx

["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: Zeng, Star <star.zeng@intel.com>; Ni, Ruiyu <ruiyu.ni@intel.com>; Fan,
> Jeff <jeff.fan@intel.com>
> Subject: [patch 2/8] 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>
> ---
>  .../Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c                | 10 +++++++---
>  .../Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h                 | 10 +++++++---
>  .../Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c             | 15 +++++++++-----
> -
>  .../Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h             | 16 ++++++++++---
> ---
>  4 files changed, 33 insertions(+), 18 deletions(-)
> 
> diff --git
> a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
> b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
> index 5825a04..12ee529 100644
> --- a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
> +++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
> @@ -1,10 +1,10 @@
>  /** @file
>    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
> http://opensource.org/licenses/bsd-license.php
> 
> @@ -531,13 +531,17 @@ Exit:
>  /**
>      Register a notification function for a particular keystroke for the input
> device.
> 
>      @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.
>      @retval EFI_OUT_OF_RESOURCES      Unable to allocate resources for
> necesssary data structures.
>      @retval EFI_INVALID_PARAMETER     KeyData or NotifyHandle or
> KeyNotificationFunction is NULL.
> diff --git
> a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
> b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
> index 82aa5a6..656d759 100644
> --- a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
> +++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
> @@ -1,9 +1,9 @@
>  /** @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
> http://opensource.org/licenses/bsd-license.php
> 
> @@ -492,13 +492,17 @@ KeyboardSetState (
>  /**
>      Register a notification function for a particular keystroke for the input
> device.
> 
>      @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.
>      @retval EFI_OUT_OF_RESOURCES    - Unable to allocate resources for
> necesssary data structures.
>      @retval EFI_INVALID_PARAMETER   - KeyData or NotifyHandle is NULL.
> diff --git
> a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.
> c
> b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.
> c
> index 742d009..b04c340 100644
> ---
> a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.
> c
> +++
> b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.
> c
> @@ -2311,21 +2311,24 @@ Exit:
>  /**
>    Register a notification function for a particular keystroke for the input
> device.
> 
>    @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 (
>    IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
>    IN EFI_KEY_DATA                       *KeyData,
> diff --git
> a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.
> h
> b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.
> h
> index f38411a..c64a131 100644
> ---
> a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.
> h
> +++
> b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.
> h
> @@ -1,8 +1,8 @@
>  /** @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
> @@ -633,21 +633,25 @@ BiosKeyboardSetState (
>  /**
>    Register a notification function for a particular keystroke for the input
> device.
> 
>    @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 (
>    IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
>    IN EFI_KEY_DATA                       *KeyData,
> --
> 1.9.5.msysgit.1