From: Dandan Bi <dandan.bi@intel.com>
To: edk2-devel@lists.01.org
Cc: Star Zeng <star.zeng@intel.com>, Ruiyu Ni <ruiyu.ni@intel.com>
Subject: [patch 3/8] MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7
Date: Mon, 19 Jun 2017 09:21:27 +0800 [thread overview]
Message-ID: <1497835292-34476-4-git-send-email-dandan.bi@intel.com> (raw)
In-Reply-To: <1497835292-34476-1-git-send-email-dandan.bi@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>
---
MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c | 12 ++++++++----
MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h | 12 ++++++++----
MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c | 11 +++++++----
MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h | 11 +++++++----
MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h | 7 +++++--
MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c | 11 +++++++----
6 files changed, 42 insertions(+), 22 deletions(-)
diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
index cdd1684..da61ef2 100644
--- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
+++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
@@ -1,10 +1,10 @@
/** @file
USB Keyboard Driver that manages USB keyboard and produces Simple Text Input
Protocol and Simple Text Input Ex Protocol.
-Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2004 - 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
@@ -1053,14 +1053,18 @@ USBKeyboardSetState (
/**
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.
+ @param KeyData A pointer to a buffer that is filled in with
+ the keystroke information 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 necessary data structures.
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle or KeyNotificationFunction is NULL.
diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h
index 089f113..c727c73 100644
--- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h
+++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h
@@ -1,9 +1,9 @@
/** @file
Header file for USB Keyboard Driver's Data Structures.
-Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2004 - 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
@@ -500,14 +500,18 @@ USBKeyboardSetState (
/**
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.
+ @param KeyData A pointer to a buffer that is filled in with
+ the keystroke information 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/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
index b230f5e..0ebef09 100644
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
@@ -3840,15 +3840,18 @@ ConSplitterTextInSetState (
/**
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.
+ @param KeyData A pointer to a buffer that is filled in with
+ the keystroke information 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.
diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
index eeea061..2b79b4b 100644
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
@@ -1394,15 +1394,18 @@ ConSplitterTextInSetState (
/**
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.
+ @param KeyData A pointer to a buffer that is filled in with
+ the keystroke information 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.
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
index c15d17c..8c805ea 100644
--- a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
@@ -341,13 +341,16 @@ TerminalConInSetState (
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.
+ 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.
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
index 1392f16..6508f26 100644
--- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
@@ -308,15 +308,18 @@ TerminalConInSetState (
/**
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.
+ @param KeyData A pointer to a buffer that is filled in with
+ the keystroke information 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.
--
1.9.5.msysgit.1
next prev parent reply other threads:[~2017-06-19 1:20 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-19 1:21 [patch 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
2017-06-19 1:21 ` [patch 1/8] MdePkg/SimpleTextInEx: Update comments according to UEFI 2.7 spec Dandan Bi
2017-06-19 2:31 ` Ni, Ruiyu
2017-06-19 2:39 ` Zeng, Star
2017-06-19 1:21 ` [patch 2/8] IntelFrameworkModulePkg: Update comments in SimpleTextInEx Dandan Bi
2017-06-19 2:31 ` Ni, Ruiyu
2017-06-19 2:40 ` Zeng, Star
2017-06-19 1:21 ` Dandan Bi [this message]
2017-06-19 2:31 ` [patch 3/8] MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7 Ni, Ruiyu
2017-06-19 2:41 ` Zeng, Star
2017-06-19 2:57 ` Bi, Dandan
2017-06-19 1:21 ` [patch 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments Dandan Bi
2017-06-19 2:31 ` Ni, Ruiyu
2017-06-19 1:21 ` [patch 5/8] MdePkg: Update comments in EFI_MEMORY_DESCRIPTOR according to UEFI2.7 Dandan Bi
2017-06-19 2:43 ` Zeng, Star
2017-06-19 1:21 ` [patch 6/8] MdePkg: update comments in ResetSystem() " Dandan Bi
2017-06-19 2:31 ` Ni, Ruiyu
2017-06-19 1:21 ` [patch 7/8] MdePkg: Clean ACPI 2.0 characters in UEFI spec Dandan Bi
2017-06-19 2:55 ` Zeng, Star
2017-06-19 1:21 ` [patch 8/8] MdeModulePkg: " Dandan Bi
2017-06-19 2:57 ` Zeng, Star
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1497835292-34476-4-git-send-email-dandan.bi@intel.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox