mirror of https://github.com/acidanthera/audk.git
MdeModulePkg/Bus/Isa: Fix various typos
Fix various typos in documentation, comments and debug strings. 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-14-philmd@redhat.com>
This commit is contained in:
parent
29f7ad8b7c
commit
1d031e750b
|
@ -109,7 +109,7 @@ ISA_BUS_CHILD_PRIVATE_DATA mIsaBusChildPrivateTemplate = {
|
|||
then a new handle is created. If it is a pointer to an existing UEFI handle,
|
||||
then the protocol is added to the existing UEFI handle.
|
||||
|
||||
@retval EFI_SUCCES The protocol was added to ChildHandle.
|
||||
@retval EFI_SUCCESS The protocol was added to ChildHandle.
|
||||
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
|
||||
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
|
||||
the child
|
||||
|
@ -166,7 +166,7 @@ IsaBusCreateChild (
|
|||
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
|
||||
@param ChildHandle Handle of the child to destroy
|
||||
|
||||
@retval EFI_SUCCES The protocol was removed from ChildHandle.
|
||||
@retval EFI_SUCCESS The protocol was removed from ChildHandle.
|
||||
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
|
||||
@retval EFI_INVALID_PARAMETER Child handle is NULL.
|
||||
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
|
||||
|
@ -272,7 +272,7 @@ ISA_BUS_PRIVATE_DATA mIsaBusPrivateTemplate = {
|
|||
@retval EFI_SUCCESS The device was started.
|
||||
@retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
|
||||
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
|
||||
@retval Others The driver failded to start the device.
|
||||
@retval Others The driver failed to start the device.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
|
|
|
@ -799,7 +799,7 @@ KeyboardTimerHandler (
|
|||
//
|
||||
// To let KB driver support Hot plug, here should skip the 'resend' command for the case that
|
||||
// KB is not connected to system. If KB is not connected to system, driver will find there's something
|
||||
// error in the following code and wait for the input buffer empty, this waiting time shoulb be short enough since
|
||||
// error in the following code and wait for the input buffer empty, this waiting time should be short enough since
|
||||
// this is a NOTIFY TPL period function, or the system performance will degrade hardly when KB is not connected.
|
||||
// Just skip the 'resend' process simply.
|
||||
//
|
||||
|
@ -827,7 +827,7 @@ KeyboardTimerHandler (
|
|||
@param ConsoleIn - Pointer to instance of KEYBOARD_CONSOLE_IN_DEV
|
||||
@param Data - Pointer to outof buffer for keeping key value
|
||||
|
||||
@retval EFI_TIMEOUT Status resigter time out
|
||||
@retval EFI_TIMEOUT Status register time out
|
||||
@retval EFI_SUCCESS Success to read keyboard
|
||||
|
||||
**/
|
||||
|
@ -871,7 +871,7 @@ KeyboardRead (
|
|||
@param Data value wanted to be written
|
||||
|
||||
@retval EFI_TIMEOUT The input buffer register is full for putting new value util timeout
|
||||
@retval EFI_SUCCESS The new value is sucess put into input buffer register.
|
||||
@retval EFI_SUCCESS The new value is success put into input buffer register.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
|
@ -1688,7 +1688,7 @@ InitKeyboard (
|
|||
if (EFI_ERROR (Status)) {
|
||||
KeyboardError (
|
||||
ConsoleIn,
|
||||
L"Some specific value not aquired from 8042 controller!\n\r"
|
||||
L"Some specific value not acquired from 8042 controller!\n\r"
|
||||
);
|
||||
goto Done;
|
||||
}
|
||||
|
@ -1703,7 +1703,7 @@ InitKeyboard (
|
|||
|
||||
Status = KeyboardWaitForValue (ConsoleIn, KEYBOARD_8048_RETURN_8042_ACK);
|
||||
if (EFI_ERROR (Status)) {
|
||||
KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");
|
||||
KeyboardError (ConsoleIn, L"Some specific value not acquired from 8042 controller!\n\r");
|
||||
goto Done;
|
||||
}
|
||||
//
|
||||
|
@ -1730,7 +1730,7 @@ InitKeyboard (
|
|||
|
||||
Status = KeyboardWaitForValue (ConsoleIn, KEYBOARD_8048_RETURN_8042_ACK);
|
||||
if (EFI_ERROR (Status)) {
|
||||
KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");
|
||||
KeyboardError (ConsoleIn, L"Some specific value not acquired from 8042 controller!\n\r");
|
||||
goto Done;
|
||||
}
|
||||
|
||||
|
@ -1742,7 +1742,7 @@ InitKeyboard (
|
|||
|
||||
Status = KeyboardWaitForValue (ConsoleIn, KEYBOARD_8048_RETURN_8042_ACK);
|
||||
if (EFI_ERROR (Status)) {
|
||||
KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");
|
||||
KeyboardError (ConsoleIn, L"Some specific value not acquired from 8042 controller!\n\r");
|
||||
goto Done;
|
||||
}
|
||||
|
||||
|
@ -1757,7 +1757,7 @@ InitKeyboard (
|
|||
|
||||
Status = KeyboardWaitForValue (ConsoleIn, KEYBOARD_8048_RETURN_8042_ACK);
|
||||
if (EFI_ERROR (Status)) {
|
||||
KeyboardError (ConsoleIn, L"Some specific value not aquired from 8042 controller!\n\r");
|
||||
KeyboardError (ConsoleIn, L"Some specific value not acquired from 8042 controller!\n\r");
|
||||
goto Done;
|
||||
}
|
||||
//
|
||||
|
|
|
@ -77,7 +77,7 @@ PushEfikeyBufTail (
|
|||
}
|
||||
|
||||
/**
|
||||
Judge whether is a registed key
|
||||
Judge whether is a registered key
|
||||
|
||||
@param RegsiteredData A pointer to a buffer that is filled in with the keystroke
|
||||
state data for the key that was registered.
|
||||
|
@ -85,7 +85,7 @@ PushEfikeyBufTail (
|
|||
state data for the key that was pressed.
|
||||
|
||||
@retval TRUE Key be pressed matches a registered key.
|
||||
@retval FLASE Match failed.
|
||||
@retval FALSE Match failed.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
|
@ -120,7 +120,7 @@ IsKeyRegistered (
|
|||
|
||||
/**
|
||||
Reads the next keystroke from the input device. The WaitForKey Event can
|
||||
be used to test for existance of a keystroke via WaitForEvent () call.
|
||||
be used to test for existence of a keystroke via WaitForEvent () call.
|
||||
|
||||
@param ConsoleInDev Ps2 Keyboard private structure
|
||||
@param KeyData A pointer to a buffer that is filled in with the keystroke
|
||||
|
@ -128,7 +128,7 @@ IsKeyRegistered (
|
|||
|
||||
|
||||
@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
|
||||
hardware errors.
|
||||
@retval EFI_INVALID_PARAMETER KeyData is NULL.
|
||||
|
@ -308,7 +308,7 @@ KeyboardReadKeyStroke (
|
|||
Signal the event if there is key available
|
||||
|
||||
@param Event the event object
|
||||
@param Context waitting context
|
||||
@param Context waiting context
|
||||
|
||||
**/
|
||||
VOID
|
||||
|
@ -333,7 +333,7 @@ KeyboardWaitForKey (
|
|||
|
||||
if (!ConsoleIn->KeyboardErr) {
|
||||
//
|
||||
// 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
|
||||
// keystroke in the queue, so here skip the partial keystroke and get the
|
||||
// next key from the queue
|
||||
|
@ -381,7 +381,7 @@ KeyboardWaitForKeyEx (
|
|||
}
|
||||
|
||||
/**
|
||||
Reset the input device and optionaly run diagnostics
|
||||
Reset the input device and optionally run diagnostics
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param ExtendedVerification Driver may perform diagnostics on reset.
|
||||
|
@ -411,7 +411,7 @@ KeyboardEfiResetEx (
|
|||
|
||||
/**
|
||||
Reads the next keystroke from the input device. The WaitForKey Event can
|
||||
be used to test for existance of a keystroke via WaitForEvent () call.
|
||||
be used to test for existence of a keystroke via WaitForEvent () call.
|
||||
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
|
@ -419,7 +419,7 @@ KeyboardEfiResetEx (
|
|||
state data for the key that was pressed.
|
||||
|
||||
@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
|
||||
hardware errors.
|
||||
@retval EFI_INVALID_PARAMETER KeyData is NULL.
|
||||
|
@ -540,7 +540,7 @@ Exit:
|
|||
@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_OUT_OF_RESOURCES Unable to allocate resources for necessary data structures.
|
||||
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle or KeyNotificationFunction is NULL.
|
||||
|
||||
**/
|
||||
|
|
|
@ -77,7 +77,7 @@ KbdControllerDriverStop (
|
|||
@param ListHead Pointer to list head
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ListHead is NULL
|
||||
@retval EFI_SUCCESS Sucess to free NotifyList
|
||||
@retval EFI_SUCCESS Success to free NotifyList
|
||||
**/
|
||||
EFI_STATUS
|
||||
KbdFreeNotifyList (
|
||||
|
@ -597,7 +597,7 @@ KbdControllerDriverStop (
|
|||
@param ListHead Pointer to list head
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ListHead is NULL
|
||||
@retval EFI_SUCCESS Sucess to free NotifyList
|
||||
@retval EFI_SUCCESS Success to free NotifyList
|
||||
**/
|
||||
EFI_STATUS
|
||||
KbdFreeNotifyList (
|
||||
|
|
|
@ -352,7 +352,7 @@ KeyboardReadKeyStroke (
|
|||
Signal the event if there is key available
|
||||
|
||||
@param Event the event object
|
||||
@param Context waitting context
|
||||
@param Context waiting context
|
||||
|
||||
**/
|
||||
VOID
|
||||
|
@ -411,7 +411,7 @@ KeyboardWaitForKeyEx (
|
|||
//
|
||||
|
||||
/**
|
||||
Reset the input device and optionaly run diagnostics
|
||||
Reset the input device and optionally run diagnostics
|
||||
|
||||
@param This - Protocol instance pointer.
|
||||
@param ExtendedVerification - Driver may perform diagnostics on reset.
|
||||
|
@ -430,7 +430,7 @@ KeyboardEfiResetEx (
|
|||
|
||||
/**
|
||||
Reads the next keystroke from the input device. The WaitForKey Event can
|
||||
be used to test for existance of a keystroke via WaitForEvent () call.
|
||||
be used to test for existence of a keystroke via WaitForEvent () call.
|
||||
|
||||
|
||||
@param This - Protocol instance pointer.
|
||||
|
@ -438,7 +438,7 @@ KeyboardEfiResetEx (
|
|||
state data for the key that was pressed.
|
||||
|
||||
@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
|
||||
hardware errors.
|
||||
@retval EFI_INVALID_PARAMETER - KeyData is NULL.
|
||||
|
@ -486,7 +486,7 @@ KeyboardSetState (
|
|||
@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_OUT_OF_RESOURCES - Unable to allocate resources for necessary data structures.
|
||||
@retval EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL.
|
||||
|
||||
**/
|
||||
|
@ -531,7 +531,7 @@ PushEfikeyBufTail (
|
|||
);
|
||||
|
||||
/**
|
||||
Judge whether is a registed key
|
||||
Judge whether is a registered key
|
||||
|
||||
@param RegsiteredData A pointer to a buffer that is filled in with the keystroke
|
||||
state data for the key that was registered.
|
||||
|
@ -539,7 +539,7 @@ PushEfikeyBufTail (
|
|||
state data for the key that was pressed.
|
||||
|
||||
@retval TRUE Key be pressed matches a registered key.
|
||||
@retval FLASE Match failed.
|
||||
@retval FALSE Match failed.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
|
|
|
@ -775,7 +775,7 @@ CheckForInput (
|
|||
/**
|
||||
I/O work flow to wait input buffer empty in given time.
|
||||
|
||||
@param Timeout Wating time.
|
||||
@param Timeout Waiting time.
|
||||
|
||||
@retval EFI_TIMEOUT if input is still not empty in given time.
|
||||
@retval EFI_SUCCESS input is empty.
|
||||
|
|
|
@ -362,7 +362,7 @@ CheckForInput (
|
|||
/**
|
||||
I/O work flow to wait input buffer empty in given time.
|
||||
|
||||
@param Timeout Wating time.
|
||||
@param Timeout Waiting time.
|
||||
|
||||
@retval EFI_TIMEOUT if input is still not empty in given time.
|
||||
@retval EFI_SUCCESS input is empty.
|
||||
|
|
|
@ -587,8 +587,8 @@ MouseReset (
|
|||
|
||||
Status = EFI_SUCCESS;
|
||||
//
|
||||
// The PS2 mouse driver reset behavior is always successfully return no matter wheater or not there is mouse connected to system.
|
||||
// This behavior is needed by performance speed. The following mouse command only succeessfully finish when mouse device is
|
||||
// The PS2 mouse driver reset behavior is always successfully return no matter whether or not there is mouse connected to system.
|
||||
// This behavior is needed by performance speed. The following mouse command only successfully finish when mouse device is
|
||||
// connected to system, so if PS2 mouse device not connect to system or user not ask for, we skip the mouse configuration and enabling
|
||||
//
|
||||
if (ExtendedVerification && CheckMouseConnect (MouseDev)) {
|
||||
|
|
|
@ -124,7 +124,7 @@ PS2MouseDriverSupported (
|
|||
/**
|
||||
Start this driver on ControllerHandle by opening a IsaIo
|
||||
protocol, creating PS2_MOUSE_ABSOLUTE_POINTER_DEV device and install gEfiAbsolutePointerProtocolGuid
|
||||
finnally.
|
||||
finally.
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param ControllerHandle Handle of device to bind driver to
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
## @file
|
||||
# PS2 Mouse Driver.
|
||||
#
|
||||
# This dirver provides support for PS2 based mice.
|
||||
# This driver provides support for PS2 based mice.
|
||||
#
|
||||
# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||
#
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
// /** @file
|
||||
// PS2 Mouse Driver.
|
||||
//
|
||||
// This dirver provides support for PS2 based mice.
|
||||
// This driver provides support for PS2 based mice.
|
||||
//
|
||||
// Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
|
||||
//
|
||||
|
|
Loading…
Reference in New Issue