From 1d031e750b673044ceee72106ba359f58e97854e Mon Sep 17 00:00:00 2001 From: Antoine Coeur Date: Fri, 7 Feb 2020 02:07:26 +0100 Subject: MdeModulePkg/Bus/Isa: Fix various typos Fix various typos in documentation, comments and debug strings. Cc: Jian J Wang Cc: Hao A Wu Cc: Ray Ni Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Acked-by: Liming Gao Signed-off-by: Philippe Mathieu-Daude Message-Id: <20200207010831.9046-14-philmd@redhat.com> --- MdeModulePkg/Bus/Isa/IsaBusDxe/IsaBusDxe.c | 6 +++--- MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c | 16 ++++++++-------- MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c | 20 ++++++++++---------- MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.c | 4 ++-- MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h | 14 +++++++------- MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c | 2 +- MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h | 2 +- MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.c | 4 ++-- MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.h | 2 +- MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.inf | 2 +- MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.uni | 2 +- 11 files changed, 37 insertions(+), 37 deletions(-) diff --git a/MdeModulePkg/Bus/Isa/IsaBusDxe/IsaBusDxe.c b/MdeModulePkg/Bus/Isa/IsaBusDxe/IsaBusDxe.c index af40410..ccda7c3 100644 --- a/MdeModulePkg/Bus/Isa/IsaBusDxe/IsaBusDxe.c +++ b/MdeModulePkg/Bus/Isa/IsaBusDxe/IsaBusDxe.c @@ -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 diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c index 87f6efd..d8d050b 100644 --- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c +++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c @@ -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; } // diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c index 458519c..835f33c 100644 --- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c +++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c @@ -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. **/ diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.c b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.c index 2ee3a52..855fda7 100644 --- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.c +++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.c @@ -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 ( diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h index 3666ebc..c2762db 100644 --- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h +++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h @@ -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 diff --git a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c index 4eb3027..d8fed87 100644 --- a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c +++ b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c @@ -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. diff --git a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h index 61380a4..60da421 100644 --- a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h +++ b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h @@ -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. diff --git a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.c b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.c index fd34e3e..ebcb2a4 100644 --- a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.c +++ b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.c @@ -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)) { diff --git a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.h b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.h index df2e283..1f7c310 100644 --- a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.h +++ b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.h @@ -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 diff --git a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.inf b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.inf index cf2699c..7e801ec 100644 --- a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.inf +++ b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.inf @@ -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.
# diff --git a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.uni b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.uni index 9e153e7..e41869a 100644 --- a/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.uni +++ b/MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.uni @@ -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.
// -- cgit v1.1