MdeModulePkg/Usb: Fix various typos
Fix various typos in comments and documentation. Cc: Jian J Wang <jian.j.wang@intel.com> Cc: Hao A Wu <hao.a.wu@intel.com> Cc: Ray Ni <ray.ni@intel.com> Signed-off-by: Antoine Coeur <coeur@gmx.fr> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com> Acked-by: Liming Gao <liming.gao@intel.com> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com> Message-Id: <20200207010831.9046-23-philmd@redhat.com>
This commit is contained in:
committed by
mergify[bot]
parent
13a623cf9c
commit
0dbaba4239
@@ -192,7 +192,7 @@ BotDataPhase (
|
|||||||
TransferredSize = 0;
|
TransferredSize = 0;
|
||||||
|
|
||||||
//
|
//
|
||||||
// retrieve the the max packet length of the given endpoint
|
// retrieve the max packet length of the given endpoint
|
||||||
//
|
//
|
||||||
if (Direction == EfiUsbDataIn) {
|
if (Direction == EfiUsbDataIn) {
|
||||||
MaxPacketLen = (PeiBotDev->BulkInEndpoint)->MaxPacketSize;
|
MaxPacketLen = (PeiBotDev->BulkInEndpoint)->MaxPacketSize;
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
/** @file
|
/** @file
|
||||||
Pei USB ATATPI command implementations.
|
Pei USB ATAPI command implementations.
|
||||||
|
|
||||||
Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
/** @file
|
/** @file
|
||||||
Common Libarary for PEI USB.
|
Common Library for PEI USB.
|
||||||
|
|
||||||
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
/** @file
|
/** @file
|
||||||
Common Libarary for PEI USB.
|
Common Library for PEI USB.
|
||||||
|
|
||||||
Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||||
|
|
||||||
|
@@ -584,7 +584,7 @@ USBKeyboardDriverBindingStop (
|
|||||||
data for the key that was pressed.
|
data for the key that was pressed.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The keystroke information was returned.
|
@retval EFI_SUCCESS The keystroke information was returned.
|
||||||
@retval EFI_NOT_READY There was no keystroke data availiable.
|
@retval EFI_NOT_READY There was no keystroke data available.
|
||||||
@retval EFI_DEVICE_ERROR The keystroke information was not returned due to
|
@retval EFI_DEVICE_ERROR The keystroke information was not returned due to
|
||||||
hardware errors.
|
hardware errors.
|
||||||
@retval EFI_INVALID_PARAMETER KeyData is NULL.
|
@retval EFI_INVALID_PARAMETER KeyData is NULL.
|
||||||
@@ -685,7 +685,7 @@ USBKeyboardReset (
|
|||||||
information for the key that was pressed.
|
information for the key that was pressed.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The keystroke information was returned.
|
@retval EFI_SUCCESS The keystroke information was returned.
|
||||||
@retval EFI_NOT_READY There was no keystroke data availiable.
|
@retval EFI_NOT_READY There was no keystroke data available.
|
||||||
@retval EFI_DEVICE_ERROR The keystroke information was not returned due to
|
@retval EFI_DEVICE_ERROR The keystroke information was not returned due to
|
||||||
hardware errors.
|
hardware errors.
|
||||||
|
|
||||||
@@ -764,7 +764,7 @@ USBKeyboardWaitForKey (
|
|||||||
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
|
OldTpl = gBS->RaiseTPL (TPL_NOTIFY);
|
||||||
|
|
||||||
//
|
//
|
||||||
// WaitforKey doesn't suppor the partial key.
|
// WaitforKey doesn't support the partial key.
|
||||||
// Considering if the partial keystroke is enabled, there maybe a partial
|
// Considering if the partial keystroke is enabled, there maybe a partial
|
||||||
// keystroke in the queue, so here skip the partial keystroke and get the
|
// keystroke in the queue, so here skip the partial keystroke and get the
|
||||||
// next key from the queue
|
// next key from the queue
|
||||||
@@ -871,7 +871,7 @@ KbdFreeNotifyList (
|
|||||||
@param InputData A pointer to keystroke data for the key that was pressed.
|
@param InputData A pointer to keystroke data for the key that was pressed.
|
||||||
|
|
||||||
@retval TRUE Key pressed matches a registered key.
|
@retval TRUE Key pressed matches a registered key.
|
||||||
@retval FLASE Key pressed does not matches a registered key.
|
@retval FALSE Key pressed does not matches a registered key.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
BOOLEAN
|
BOOLEAN
|
||||||
|
@@ -377,7 +377,7 @@ UsbKeyboardComponentNameGetControllerName (
|
|||||||
// Functions of Simple Text Input Protocol
|
// Functions of Simple Text Input Protocol
|
||||||
//
|
//
|
||||||
/**
|
/**
|
||||||
Reset the input device and optionaly run diagnostics
|
Reset the input device and optionally run diagnostics
|
||||||
|
|
||||||
There are 2 types of reset for USB keyboard.
|
There are 2 types of reset for USB keyboard.
|
||||||
For non-exhaustive reset, only keyboard buffer is cleared.
|
For non-exhaustive reset, only keyboard buffer is cleared.
|
||||||
@@ -406,8 +406,8 @@ USBKeyboardReset (
|
|||||||
information for the key that was pressed.
|
information for the key that was pressed.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The keystroke information was returned.
|
@retval EFI_SUCCESS The keystroke information was returned.
|
||||||
@retval EFI_NOT_READY There was no keystroke data availiable.
|
@retval EFI_NOT_READY There was no keystroke data available.
|
||||||
@retval EFI_DEVICE_ERROR The keydtroke information was not returned due to
|
@retval EFI_DEVICE_ERROR The keystroke information was not returned due to
|
||||||
hardware errors.
|
hardware errors.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
@@ -507,7 +507,7 @@ USBKeyboardSetState (
|
|||||||
@param NotifyHandle Points to the unique handle assigned to the registered notification.
|
@param NotifyHandle Points to the unique handle assigned to the registered notification.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The notification function was registered successfully.
|
@retval EFI_SUCCESS The notification function was registered successfully.
|
||||||
@retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data structures.
|
@retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necessary data structures.
|
||||||
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle or KeyNotificationFunction is NULL.
|
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle or KeyNotificationFunction is NULL.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
@@ -574,7 +574,7 @@ KbdFreeNotifyList (
|
|||||||
@param InputData A pointer to keystroke data for the key that was pressed.
|
@param InputData A pointer to keystroke data for the key that was pressed.
|
||||||
|
|
||||||
@retval TRUE Key pressed matches a registered key.
|
@retval TRUE Key pressed matches a registered key.
|
||||||
@retval FLASE Key pressed does not matche a registered key.
|
@retval FALSE Key pressed does not match a registered key.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
BOOLEAN
|
BOOLEAN
|
||||||
|
@@ -253,7 +253,7 @@ UINT8 EfiKeyToUsbKeyCodeConvertionTable[] = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
//
|
//
|
||||||
// Keyboard modifier value to EFI Scan Code convertion table
|
// Keyboard modifier value to EFI Scan Code conversion table
|
||||||
// EFI Scan Code and the modifier values are defined in UEFI spec.
|
// EFI Scan Code and the modifier values are defined in UEFI spec.
|
||||||
//
|
//
|
||||||
UINT8 ModifierValueToEfiScanCodeConvertionTable[] = {
|
UINT8 ModifierValueToEfiScanCodeConvertionTable[] = {
|
||||||
@@ -569,7 +569,7 @@ FindPhysicalKey (
|
|||||||
|
|
||||||
This function is registered to event of EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
|
This function is registered to event of EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID
|
||||||
group type, which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
|
group type, which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
|
||||||
It tries to get curent keyboard layout from HII database.
|
It tries to get current keyboard layout from HII database.
|
||||||
|
|
||||||
@param Event Event being signaled.
|
@param Event Event being signaled.
|
||||||
@param Context Points to USB_KB_DEV instance.
|
@param Context Points to USB_KB_DEV instance.
|
||||||
@@ -1084,7 +1084,7 @@ KeyboardHandler (
|
|||||||
|
|
||||||
//
|
//
|
||||||
// Handle modifier key's pressing or releasing situation.
|
// Handle modifier key's pressing or releasing situation.
|
||||||
// According to USB HID Firmware spec, Byte 0 uses folloing map of Modifier keys:
|
// According to USB HID Firmware spec, Byte 0 uses following map of Modifier keys:
|
||||||
// Bit0: Left Control, Keycode: 0xe0
|
// Bit0: Left Control, Keycode: 0xe0
|
||||||
// Bit1: Left Shift, Keycode: 0xe1
|
// Bit1: Left Shift, Keycode: 0xe1
|
||||||
// Bit2: Left Alt, Keycode: 0xe2
|
// Bit2: Left Alt, Keycode: 0xe2
|
||||||
|
@@ -108,7 +108,7 @@ ReleaseKeyboardLayoutResources (
|
|||||||
|
|
||||||
This function is the handler function for USB keyboard's asynchronous interrupt transfer
|
This function is the handler function for USB keyboard's asynchronous interrupt transfer
|
||||||
to manage the keyboard. It parses the USB keyboard input report, and inserts data to
|
to manage the keyboard. It parses the USB keyboard input report, and inserts data to
|
||||||
keyboard buffer according to state of modifer keys and normal keys. Timer for repeat key
|
keyboard buffer according to state of modifier keys and normal keys. Timer for repeat key
|
||||||
is also set accordingly.
|
is also set accordingly.
|
||||||
|
|
||||||
@param Data A pointer to a buffer that is filled with key data which is
|
@param Data A pointer to a buffer that is filled with key data which is
|
||||||
|
Reference in New Issue
Block a user