]> git.proxmox.com Git - mirror_edk2.git/commitdiff
MdeModulePkg/Bus/Isa: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:07:26 +0000 (02:07 +0100)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Mon, 10 Feb 2020 22:30:07 +0000 (22:30 +0000)
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>

MdeModulePkg/Bus/Isa/IsaBusDxe/IsaBusDxe.c
MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdCtrller.c
MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.c
MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.c
MdeModulePkg/Bus/Isa/Ps2MouseDxe/CommPs2.h
MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.c
MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2Mouse.h
MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.inf
MdeModulePkg/Bus/Isa/Ps2MouseDxe/Ps2MouseDxe.uni

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