* [PATCH v2 1/8] MdePkg/SimpleTextInEx: Update comments according to UEFI 2.7 spec
2017-06-19 4:46 [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
@ 2017-06-19 4:46 ` Dandan Bi
2017-06-19 4:46 ` [PATCH v2 2/8] IntelFrameworkModulePkg: Update comments in SimpleTextInEx Dandan Bi
` (7 subsequent siblings)
8 siblings, 0 replies; 12+ messages in thread
From: Dandan Bi @ 2017-06-19 4:46 UTC (permalink / raw)
To: edk2-devel; +Cc: Liming Gao, Star Zeng, Ruiyu Ni
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..4591bd4 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
^ permalink raw reply related [flat|nested] 12+ messages in thread* [PATCH v2 2/8] IntelFrameworkModulePkg: Update comments in SimpleTextInEx
2017-06-19 4:46 [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
2017-06-19 4:46 ` [PATCH v2 1/8] MdePkg/SimpleTextInEx: Update comments according to UEFI 2.7 spec Dandan Bi
@ 2017-06-19 4:46 ` Dandan Bi
2017-06-19 4:46 ` [PATCH v2 3/8] MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7 Dandan Bi
` (6 subsequent siblings)
8 siblings, 0 replies; 12+ messages in thread
From: Dandan Bi @ 2017-06-19 4:46 UTC (permalink / raw)
To: edk2-devel; +Cc: Star Zeng, Ruiyu Ni, Jeff Fan
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..7677955 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..76fb498 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..7308523 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..0bf28ea 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
^ permalink raw reply related [flat|nested] 12+ messages in thread* [PATCH v2 3/8] MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7
2017-06-19 4:46 [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
2017-06-19 4:46 ` [PATCH v2 1/8] MdePkg/SimpleTextInEx: Update comments according to UEFI 2.7 spec Dandan Bi
2017-06-19 4:46 ` [PATCH v2 2/8] IntelFrameworkModulePkg: Update comments in SimpleTextInEx Dandan Bi
@ 2017-06-19 4:46 ` Dandan Bi
2017-06-19 4:46 ` [PATCH v2 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments Dandan Bi
` (5 subsequent siblings)
8 siblings, 0 replies; 12+ messages in thread
From: Dandan Bi @ 2017-06-19 4:46 UTC (permalink / raw)
To: edk2-devel; +Cc: Star Zeng, Ruiyu Ni
v2: Add some missing changes Ps2KeyboardDxe.
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/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c | 9 ++++++---
MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h | 9 ++++++---
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 +++++++----
8 files changed, 54 insertions(+), 28 deletions(-)
diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
index bc58fe2..04e3365 100644
--- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
+++ b/MdeModulePkg/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,16 @@ 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/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
index e41c198..d772a97 100644
--- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
+++ b/MdeModulePkg/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
@@ -493,13 +493,16 @@ 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/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
index cdd1684..fb2bf3f 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..6049678 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..e70ff61 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..9469860 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..7dded00 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..3c1102d 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
^ permalink raw reply related [flat|nested] 12+ messages in thread* [PATCH v2 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments
2017-06-19 4:46 [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
` (2 preceding siblings ...)
2017-06-19 4:46 ` [PATCH v2 3/8] MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7 Dandan Bi
@ 2017-06-19 4:46 ` Dandan Bi
2017-06-19 4:54 ` Zeng, Star
2017-06-19 4:46 ` [PATCH v2 5/8] MdePkg: Update comments in EFI_MEMORY_DESCRIPTOR according to UEFI2.7 Dandan Bi
` (4 subsequent siblings)
8 siblings, 1 reply; 12+ messages in thread
From: Dandan Bi @ 2017-06-19 4:46 UTC (permalink / raw)
To: edk2-devel; +Cc: Liming Gao, Ruiyu Ni
Cc: Liming Gao <liming.gao@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/HiiImageDecoder.h | 9 ---------
1 file changed, 9 deletions(-)
diff --git a/MdePkg/Include/Protocol/HiiImageDecoder.h b/MdePkg/Include/Protocol/HiiImageDecoder.h
index 48a1a97..34eb5e1 100644
--- a/MdePkg/Include/Protocol/HiiImageDecoder.h
+++ b/MdePkg/Include/Protocol/HiiImageDecoder.h
@@ -16,19 +16,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __HII_IMAGE_DECODER_H__
#define __HII_IMAGE_DECODER_H__
#include <Protocol/HiiImage.h>
-
-//
-// In UEFI 2.6 spec,this guid value is duplicate with
-// EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID. Now update this guid value to
-// avoid the duplicate guid issue. So its value is not consistent with
-// UEFI spec definition now. We have proposed to update UEFI spec to
-// use this new guid. After new spec released, we will remove this
-// comments.
-//
#define EFI_HII_IMAGE_DECODER_PROTOCOL_GUID \
{0x9e66f251, 0x727c, 0x418c, { 0xbf, 0xd6, 0xc2, 0xb4, 0x25, 0x28, 0x18, 0xea }}
#define EFI_HII_IMAGE_DECODER_NAME_JPEG_GUID \
--
1.9.5.msysgit.1
^ permalink raw reply related [flat|nested] 12+ messages in thread* Re: [PATCH v2 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments
2017-06-19 4:46 ` [PATCH v2 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments Dandan Bi
@ 2017-06-19 4:54 ` Zeng, Star
2017-06-19 4:58 ` Bi, Dandan
0 siblings, 1 reply; 12+ messages in thread
From: Zeng, Star @ 2017-06-19 4:54 UTC (permalink / raw)
To: Bi, Dandan, edk2-devel@lists.01.org; +Cc: Ni, Ruiyu, Gao, Liming, Zeng, Star
Just found below comments in MdePkg.dec, should it be removed also?
##
## In UEFI 2.6 spec,this guid value is duplicate with
## EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID. Now update this guid value to
## avoid the duplicate guid issue. So its value is not consistent with
## UEFI spec definition now. We have proposed to update UEFI spec to
## use this new guid. After new spec released, we will remove this
## comments.
##
Thanks,
Star
-----Original Message-----
From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Dandan Bi
Sent: Monday, June 19, 2017 12:46 PM
To: edk2-devel@lists.01.org
Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Gao, Liming <liming.gao@intel.com>
Subject: [edk2] [PATCH v2 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments
Cc: Liming Gao <liming.gao@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/HiiImageDecoder.h | 9 ---------
1 file changed, 9 deletions(-)
diff --git a/MdePkg/Include/Protocol/HiiImageDecoder.h b/MdePkg/Include/Protocol/HiiImageDecoder.h
index 48a1a97..34eb5e1 100644
--- a/MdePkg/Include/Protocol/HiiImageDecoder.h
+++ b/MdePkg/Include/Protocol/HiiImageDecoder.h
@@ -16,19 +16,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __HII_IMAGE_DECODER_H__
#define __HII_IMAGE_DECODER_H__
#include <Protocol/HiiImage.h>
-
-//
-// In UEFI 2.6 spec,this guid value is duplicate with -// EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID. Now update this guid value to -// avoid the duplicate guid issue. So its value is not consistent with -// UEFI spec definition now. We have proposed to update UEFI spec to -// use this new guid. After new spec released, we will remove this -// comments.
-//
#define EFI_HII_IMAGE_DECODER_PROTOCOL_GUID \
{0x9e66f251, 0x727c, 0x418c, { 0xbf, 0xd6, 0xc2, 0xb4, 0x25, 0x28, 0x18, 0xea }}
#define EFI_HII_IMAGE_DECODER_NAME_JPEG_GUID \
--
1.9.5.msysgit.1
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
^ permalink raw reply related [flat|nested] 12+ messages in thread* Re: [PATCH v2 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments
2017-06-19 4:54 ` Zeng, Star
@ 2017-06-19 4:58 ` Bi, Dandan
0 siblings, 0 replies; 12+ messages in thread
From: Bi, Dandan @ 2017-06-19 4:58 UTC (permalink / raw)
To: Zeng, Star, edk2-devel@lists.01.org; +Cc: Ni, Ruiyu, Gao, Liming
Yes. I will remove it before checking in the codes. Thanks.
Regards,
Dandan
-----Original Message-----
From: Zeng, Star
Sent: Monday, June 19, 2017 12:55 PM
To: Bi, Dandan <dandan.bi@intel.com>; edk2-devel@lists.01.org
Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Gao, Liming <liming.gao@intel.com>; Zeng, Star <star.zeng@intel.com>
Subject: RE: [edk2] [PATCH v2 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments
Just found below comments in MdePkg.dec, should it be removed also?
##
## In UEFI 2.6 spec,this guid value is duplicate with
## EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID. Now update this guid value to
## avoid the duplicate guid issue. So its value is not consistent with
## UEFI spec definition now. We have proposed to update UEFI spec to
## use this new guid. After new spec released, we will remove this
## comments.
##
Thanks,
Star
-----Original Message-----
From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Dandan Bi
Sent: Monday, June 19, 2017 12:46 PM
To: edk2-devel@lists.01.org
Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Gao, Liming <liming.gao@intel.com>
Subject: [edk2] [PATCH v2 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments
Cc: Liming Gao <liming.gao@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/HiiImageDecoder.h | 9 ---------
1 file changed, 9 deletions(-)
diff --git a/MdePkg/Include/Protocol/HiiImageDecoder.h b/MdePkg/Include/Protocol/HiiImageDecoder.h
index 48a1a97..34eb5e1 100644
--- a/MdePkg/Include/Protocol/HiiImageDecoder.h
+++ b/MdePkg/Include/Protocol/HiiImageDecoder.h
@@ -16,19 +16,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __HII_IMAGE_DECODER_H__
#define __HII_IMAGE_DECODER_H__
#include <Protocol/HiiImage.h>
-
-//
-// In UEFI 2.6 spec,this guid value is duplicate with -// EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID. Now update this guid value to -// avoid the duplicate guid issue. So its value is not consistent with -// UEFI spec definition now. We have proposed to update UEFI spec to -// use this new guid. After new spec released, we will remove this -// comments.
-//
#define EFI_HII_IMAGE_DECODER_PROTOCOL_GUID \
{0x9e66f251, 0x727c, 0x418c, { 0xbf, 0xd6, 0xc2, 0xb4, 0x25, 0x28, 0x18, 0xea }}
#define EFI_HII_IMAGE_DECODER_NAME_JPEG_GUID \
--
1.9.5.msysgit.1
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
^ permalink raw reply related [flat|nested] 12+ messages in thread
* [PATCH v2 5/8] MdePkg: Update comments in EFI_MEMORY_DESCRIPTOR according to UEFI2.7
2017-06-19 4:46 [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
` (3 preceding siblings ...)
2017-06-19 4:46 ` [PATCH v2 4/8] MdePkg/HiiImageDecoder.h: Remove the unnecessary comments Dandan Bi
@ 2017-06-19 4:46 ` Dandan Bi
2017-06-19 4:46 ` [PATCH v2 6/8] MdePkg: update comments in ResetSystem() " Dandan Bi
` (3 subsequent siblings)
8 siblings, 0 replies; 12+ messages in thread
From: Dandan Bi @ 2017-06-19 4:46 UTC (permalink / raw)
To: edk2-devel; +Cc: Liming Gao, Star Zeng
Cc: Liming Gao <liming.gao@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
MdePkg/Include/Uefi/UefiSpec.h | 21 ++++++++++++++-------
1 file changed, 14 insertions(+), 7 deletions(-)
diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index 57cb4e8..4c541a6 100644
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -3,11 +3,11 @@
This include file must contain things defined in the UEFI 2.6 specification.
If a code construct is defined in the UEFI 2.6 specification it must be included
by this include 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 that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
@@ -101,25 +101,32 @@ typedef enum {
///
/// Definition of an EFI memory descriptor.
///
typedef struct {
///
- /// Type of the memory region. See EFI_MEMORY_TYPE.
+ /// Type of the memory region.
+ /// Type EFI_MEMORY_TYPE is defined in the
+ /// AllocatePages() function description.
///
UINT32 Type;
///
- /// Physical address of the first byte of the memory region. Must aligned
- /// on a 4 KB boundary.
+ /// Physical address of the first byte in the memory region. PhysicalStart must be
+ /// aligned on a 4 KiB boundary, and must not be above 0xfffffffffffff000. Type
+ /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function description
///
EFI_PHYSICAL_ADDRESS PhysicalStart;
///
- /// Virtual address of the first byte of the memory region. Must aligned
- /// on a 4 KB boundary.
+ /// Virtual address of the first byte in the memory region.
+ /// VirtualStart must be aligned on a 4 KiB boundary,
+ /// and must not be above 0xfffffffffffff000.
///
EFI_VIRTUAL_ADDRESS VirtualStart;
///
- /// Number of 4KB pages in the memory region.
+ /// NumberOfPagesNumber of 4 KiB pages in the memory region.
+ /// NumberOfPages must not be 0, and must not be any value
+ /// that would represent a memory page with a start address,
+ /// either physical or virtual, above 0xfffffffffffff000.
///
UINT64 NumberOfPages;
///
/// Attributes of the memory region that describe the bit mask of capabilities
/// for that memory region, and not necessarily the current settings for that
--
1.9.5.msysgit.1
^ permalink raw reply related [flat|nested] 12+ messages in thread* [PATCH v2 6/8] MdePkg: update comments in ResetSystem() according to UEFI2.7
2017-06-19 4:46 [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
` (4 preceding siblings ...)
2017-06-19 4:46 ` [PATCH v2 5/8] MdePkg: Update comments in EFI_MEMORY_DESCRIPTOR according to UEFI2.7 Dandan Bi
@ 2017-06-19 4:46 ` Dandan Bi
2017-06-19 4:46 ` [PATCH v2 7/8] MdePkg: Clean ACPI 2.0 characters in UEFI spec Dandan Bi
` (2 subsequent siblings)
8 siblings, 0 replies; 12+ messages in thread
From: Dandan Bi @ 2017-06-19 4:46 UTC (permalink / raw)
To: edk2-devel; +Cc: Liming Gao, Ruiyu Ni
Cc: Liming Gao <liming.gao@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/Library/UefiRuntimeLib.h | 7 +++----
MdePkg/Include/Uefi/UefiSpec.h | 3 +++
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/MdePkg/Include/Library/UefiRuntimeLib.h b/MdePkg/Include/Library/UefiRuntimeLib.h
index 99ca824..0bca416 100644
--- a/MdePkg/Include/Library/UefiRuntimeLib.h
+++ b/MdePkg/Include/Library/UefiRuntimeLib.h
@@ -1,10 +1,10 @@
/** @file
Provides library functions for each of the UEFI Runtime Services.
Only available to DXE and UEFI module types.
-Copyright (c) 2006 - 2010, 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 that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
@@ -327,13 +327,12 @@ EfiGetNextHighMonotonicCount (
@param DataSizeThe size, in bytes, of ResetData.
@param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a
Null-terminated Unicode string, optionally followed by additional binary data. The string is a
description that the caller may use to further indicate the reason for the system reset. ResetData
is only valid if ResetStatus is something other then EFI_SUCCESS. This pointer must be a physical
- address. For a ResetType of EfiRestUpdate the data buffer also starts with a Null-terminated string
- that is followed by a physical VOID * to an EFI_CAPSULE_HEADER.
-
+ address. For a ResetType of EfiResetPlatformSpecific the data buffer also starts with a Null-terminated
+ string that is followed by an EFI_GUID that describes the specific type of reset to perform.
**/
VOID
EFIAPI
EfiResetSystem (
IN EFI_RESET_TYPE ResetType,
diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index 4c541a6..637c9c7 100644
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -1018,10 +1018,13 @@ EFI_STATUS
The string is a description that the caller may use to further
indicate the reason for the system reset. ResetData is only
valid if ResetStatus is something other than EFI_SUCCESS
unless the ResetType is EfiResetPlatformSpecific
where a minimum amount of ResetData is always required.
+ For a ResetType of EfiResetPlatformSpecific the data buffer
+ also starts with a Null-terminated string that is followed
+ by an EFI_GUID that describes the specific type of reset to perform.
**/
typedef
VOID
(EFIAPI *EFI_RESET_SYSTEM)(
IN EFI_RESET_TYPE ResetType,
--
1.9.5.msysgit.1
^ permalink raw reply related [flat|nested] 12+ messages in thread* [PATCH v2 7/8] MdePkg: Clean ACPI 2.0 characters in UEFI spec
2017-06-19 4:46 [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
` (5 preceding siblings ...)
2017-06-19 4:46 ` [PATCH v2 6/8] MdePkg: update comments in ResetSystem() " Dandan Bi
@ 2017-06-19 4:46 ` Dandan Bi
2017-06-19 4:46 ` [PATCH v2 8/8] MdeModulePkg: " Dandan Bi
2017-06-19 4:51 ` [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Zeng, Star
8 siblings, 0 replies; 12+ messages in thread
From: Dandan Bi @ 2017-06-19 4:46 UTC (permalink / raw)
To: edk2-devel; +Cc: Liming Gao, Star Zeng
Cc: Liming Gao <liming.gao@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
MdePkg/Include/Protocol/PciIo.h | 25 ++++++++++++-------------
MdePkg/Include/Protocol/PciRootBridgeIo.h | 18 +++++++++---------
2 files changed, 21 insertions(+), 22 deletions(-)
diff --git a/MdePkg/Include/Protocol/PciIo.h b/MdePkg/Include/Protocol/PciIo.h
index 6068260..42bcc81 100644
--- a/MdePkg/Include/Protocol/PciIo.h
+++ b/MdePkg/Include/Protocol/PciIo.h
@@ -1,10 +1,10 @@
/** @file
EFI PCI I/O Protocol provides the basic Memory, I/O, PCI configuration,
and DMA interfaces that a driver uses to access its PCI controller.
- Copyright (c) 2006 - 2010, 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
@@ -446,31 +446,30 @@ EFI_STATUS
IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation,
IN UINT64 Attributes,
OUT UINT64 *Result OPTIONAL
);
-/**
+/**
Gets the attributes that this PCI controller supports setting on a BAR using
SetBarAttributes(), and retrieves the list of resource descriptors for a BAR.
-
- @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
+
+ @param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
@param BarIndex The BAR index of the standard PCI Configuration header to use as the
base address for resource range. The legal range for this field is 0..5.
@param Supports A pointer to the mask of attributes that this PCI controller supports
- setting for this BAR with SetBarAttributes().
- @param Resources A pointer to the ACPI 2.0 resource descriptors that describe the current
- configuration of this BAR of the PCI controller.
+ setting for this BAR with SetBarAttributes().
+ @param Resources A pointer to the resource descriptors that describe the current
+ configuration of this BAR of the PCI controller.
- @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI
- controller supports are returned in Supports. If Resources
- is not NULL, then the ACPI 2.0 resource descriptors that the PCI
- controller is currently using are returned in Resources.
+ @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI
+ controller supports are returned in Supports. If Resources
+ is not NULL, then the resource descriptors that the PCI
+ controller is currently using are returned in Resources.
@retval EFI_INVALID_PARAMETER Both Supports and Attributes are NULL.
@retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate
- Resources.
-
+ Resources.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_PCI_IO_PROTOCOL_GET_BAR_ATTRIBUTES)(
IN EFI_PCI_IO_PROTOCOL *This,
diff --git a/MdePkg/Include/Protocol/PciRootBridgeIo.h b/MdePkg/Include/Protocol/PciRootBridgeIo.h
index 449dcba..fed5385 100644
--- a/MdePkg/Include/Protocol/PciRootBridgeIo.h
+++ b/MdePkg/Include/Protocol/PciRootBridgeIo.h
@@ -3,11 +3,11 @@
PCI Root Bridge I/O protocol is used by PCI Bus Driver to perform PCI Memory, PCI I/O,
and PCI Configuration cycles on a PCI Root Bridge. It also provides services to perform
defferent types of bus mastering DMA.
- Copyright (c) 2006 - 2011, 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
@@ -385,22 +385,22 @@ EFI_STATUS
IN OUT UINT64 *ResourceBase,
IN OUT UINT64 *ResourceLength
);
/**
- Retrieves the current resource settings of this PCI root bridge in the form of a set of ACPI 2.0
- resource descriptors.
+ Retrieves the current resource settings of this PCI root bridge in the form of a set of ACPI
+ resource descriptors.
@param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
- @param Resources A pointer to the ACPI 2.0 resource descriptors that describe the current
- configuration of this PCI root bridge.
-
+ @param Resources A pointer to the resource descriptors that describe the current
+ configuration of this PCI root bridge.
+
@retval EFI_SUCCESS The current configuration of this PCI root bridge was returned in
- Resources.
+ Resources.
@retval EFI_UNSUPPORTED The current configuration of this PCI root bridge could not be
- retrieved.
-
+ retrieved.
+
**/
typedef
EFI_STATUS
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION)(
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This,
--
1.9.5.msysgit.1
^ permalink raw reply related [flat|nested] 12+ messages in thread* [PATCH v2 8/8] MdeModulePkg: Clean ACPI 2.0 characters in UEFI spec
2017-06-19 4:46 [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
` (6 preceding siblings ...)
2017-06-19 4:46 ` [PATCH v2 7/8] MdePkg: Clean ACPI 2.0 characters in UEFI spec Dandan Bi
@ 2017-06-19 4:46 ` Dandan Bi
2017-06-19 4:51 ` [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Zeng, Star
8 siblings, 0 replies; 12+ messages in thread
From: Dandan Bi @ 2017-06-19 4:46 UTC (permalink / raw)
To: edk2-devel; +Cc: Liming Gao, Star Zeng
v2: Add some missing changes.
Cc: Liming Gao <liming.gao@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.c | 6 +++---
MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.h | 6 +++---
MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridge.h | 6 +++---
MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridgeIo.c | 15 +++++++--------
4 files changed, 16 insertions(+), 17 deletions(-)
diff --git a/MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.c b/MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.c
index 3b3b53a..cc7125e 100644
--- a/MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.c
+++ b/MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.c
@@ -1,9 +1,9 @@
/** @file
EFI PCI IO protocol functions implementation for PCI Bus module.
-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
@@ -1836,16 +1836,16 @@ GetMmioAddressTranslationOffset (
@param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
@param BarIndex The BAR index of the standard PCI Configuration header to use as the
base address for resource range. The legal range for this field is 0..5.
@param Supports A pointer to the mask of attributes that this PCI controller supports
setting for this BAR with SetBarAttributes().
- @param Resources A pointer to the ACPI 2.0 resource descriptors that describe the current
+ @param Resources A pointer to the resource descriptors that describe the current
configuration of this BAR of the PCI controller.
@retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI
controller supports are returned in Supports. If Resources
- is not NULL, then the ACPI 2.0 resource descriptors that the PCI
+ is not NULL, then the resource descriptors that the PCI
controller is currently using are returned in Resources.
@retval EFI_INVALID_PARAMETER Both Supports and Attributes are NULL.
@retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate
Resources.
diff --git a/MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.h b/MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.h
index ac2def5..da3de39 100644
--- a/MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.h
+++ b/MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.h
@@ -1,9 +1,9 @@
/** @file
EFI PCI IO protocol functions declaration for PCI Bus module.
-Copyright (c) 2006 - 2009, 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
@@ -588,16 +588,16 @@ PciIoAttributes (
@param This A pointer to the EFI_PCI_IO_PROTOCOL instance.
@param BarIndex The BAR index of the standard PCI Configuration header to use as the
base address for resource range. The legal range for this field is 0..5.
@param Supports A pointer to the mask of attributes that this PCI controller supports
setting for this BAR with SetBarAttributes().
- @param Resources A pointer to the ACPI 2.0 resource descriptors that describe the current
+ @param Resources A pointer to the resource descriptors that describe the current
configuration of this BAR of the PCI controller.
@retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI
controller supports are returned in Supports. If Resources
- is not NULL, then the ACPI 2.0 resource descriptors that the PCI
+ is not NULL, then the resource descriptors that the PCI
controller is currently using are returned in Resources.
@retval EFI_INVALID_PARAMETER Both Supports and Attributes are NULL.
@retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate
Resources.
diff --git a/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridge.h b/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridge.h
index 1fec88b..d3dfb57 100644
--- a/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridge.h
+++ b/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridge.h
@@ -1,10 +1,10 @@
/** @file
The PCI Root Bridge header file.
-Copyright (c) 1999 - 2016, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 1999 - 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
@@ -552,14 +552,14 @@ RootBridgeIoSetAttributes (
;
/**
Retrieves the current resource settings of this PCI root bridge
- in the form of a set of ACPI 2.0 resource descriptor.
+ in the form of a set of ACPI resource descriptor.
@param This - Pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL instance.
- @param Resources - Pointer to the ACPI 2.0 resource descriptor that
+ @param Resources - Pointer to the resource descriptor that
describe the current configuration of this PCI root
bridge.
@retval EFI_SUCCESS - Success.
@retval EFI_UNSUPPORTED - Current configuration of the PCI root bridge
diff --git a/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridgeIo.c b/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridgeIo.c
index 8e4f032..dc06c16 100644
--- a/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridgeIo.c
+++ b/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciRootBridgeIo.c
@@ -1558,24 +1558,23 @@ RootBridgeIoSetAttributes (
return EFI_SUCCESS;
}
/**
Retrieves the current resource settings of this PCI root bridge in the form
- of a set of ACPI 2.0 resource descriptors.
+ of a set of ACPI resource descriptors.
There are only two resource descriptor types from the ACPI Specification that
may be used to describe the current resources allocated to a PCI root bridge.
- These are the QWORD Address Space Descriptor (ACPI 2.0 Section 6.4.3.5.1),
- and the End Tag (ACPI 2.0 Section 6.4.2.8). The QWORD Address Space
- Descriptor can describe memory, I/O, and bus number ranges for dynamic or
- fixed resources. The configuration of a PCI root bridge is described with one
- or more QWORD Address Space Descriptors followed by an End Tag.
+ These are the QWORD Address Space Descriptor, and the End Tag. The QWORD
+ Address Space Descriptor can describe memory, I/O, and bus number ranges for
+ dynamic or fixed resources. The configuration of a PCI root bridge is described
+ with one or more QWORD Address Space Descriptors followed by an End Tag.
@param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
- @param[out] Resources A pointer to the ACPI 2.0 resource descriptors that
+ @param[out] Resources A pointer to the resource descriptors that
describe the current configuration of this PCI root
- bridge. The storage for the ACPI 2.0 resource
+ bridge. The storage for the resource
descriptors is allocated by this function. The
caller must treat the return buffer as read-only
data, and the buffer must not be freed by the
caller.
--
1.9.5.msysgit.1
^ permalink raw reply related [flat|nested] 12+ messages in thread* Re: [PATCH v2 0/8] Update function comments according to UEFI2.7 spec
2017-06-19 4:46 [PATCH v2 0/8] Update function comments according to UEFI2.7 spec Dandan Bi
` (7 preceding siblings ...)
2017-06-19 4:46 ` [PATCH v2 8/8] MdeModulePkg: " Dandan Bi
@ 2017-06-19 4:51 ` Zeng, Star
8 siblings, 0 replies; 12+ messages in thread
From: Zeng, Star @ 2017-06-19 4:51 UTC (permalink / raw)
To: Bi, Dandan, edk2-devel@lists.01.org; +Cc: Zeng, Star
Reviewed-by: Star Zeng <star.zeng@intel.com> to this patch series.
-----Original Message-----
From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Dandan Bi
Sent: Monday, June 19, 2017 12:46 PM
To: edk2-devel@lists.01.org
Subject: [edk2] [PATCH v2 0/8] Update function comments according to UEFI2.7 spec
v2: Add some missing changes in previous pacth 3 and patch 8.
This patch serial is to update fucntion comments accoding to new UEFI spec.
Dandan Bi (8):
MdePkg/SimpleTextInEx: Update comments according to UEFI 2.7 spec
IntelFrameworkModulePkg: Update comments in SimpleTextInEx
MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7
MdePkg/HiiImageDecoder.h: Remove the unnecessary comments
MdePkg: Update comments in EFI_MEMORY_DESCRIPTOR according to UEFI2.7
MdePkg: update comments in ResetSystem() according to UEFI2.7
MdePkg: Clean ACPI 2.0 characters in UEFI spec
MdeModulePkg: Clean ACPI 2.0 characters in UEFI spec
.../Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c | 10 ++++++---
.../Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h | 10 ++++++---
.../Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c | 15 +++++++------
.../Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h | 16 ++++++++------
MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c | 9 +++++--- MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h | 9 +++++---
MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.c | 6 +++---
MdeModulePkg/Bus/Pci/PciBusDxe/PciIo.h | 6 +++---
.../Bus/Pci/PciHostBridgeDxe/PciRootBridge.h | 6 +++---
.../Bus/Pci/PciHostBridgeDxe/PciRootBridgeIo.c | 15 ++++++-------
MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c | 12 +++++++----
MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h | 12 +++++++----
.../Universal/Console/ConSplitterDxe/ConSplitter.c | 11 ++++++---- .../Universal/Console/ConSplitterDxe/ConSplitter.h | 11 ++++++----
.../Universal/Console/TerminalDxe/Terminal.h | 7 ++++--
.../Universal/Console/TerminalDxe/TerminalConIn.c | 11 ++++++----
MdePkg/Include/Library/UefiRuntimeLib.h | 7 +++---
MdePkg/Include/Protocol/HiiImageDecoder.h | 9 --------
MdePkg/Include/Protocol/PciIo.h | 25 +++++++++++-----------
MdePkg/Include/Protocol/PciRootBridgeIo.h | 18 ++++++++--------
MdePkg/Include/Protocol/SimpleTextInEx.h | 17 ++++++++-------
MdePkg/Include/Uefi/UefiSpec.h | 24 +++++++++++++++------
22 files changed, 153 insertions(+), 113 deletions(-)
--
1.9.5.msysgit.1
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
^ permalink raw reply [flat|nested] 12+ messages in thread