MdeModulePkg/Graphics: Fix spelling mistakes

Fix various spelling mistakes in GraphicsConsoleDxe, ConsPlitter,
and SimpleTextOut header

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Cc: Zhichao Gao <zhichao.gao@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Ard Biesheuvel <Ard.Biesheuvel@arm.com>
Cc: Pete Batard <pete@akeo.ie>
Signed-off-by: Samer El-Haj-Mahmoud <Samer.El-Haj-Mahmoud@arm.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>

diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
index 9c38271b65f9e0663825ed552d482da96cb80280..b090de288517780c52e1b9e2ebf492f17101a135 100644 (file)
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
@@ -1,5 +1,5 @@
 /** @file\r
-  Console Splitter Driver. Any Handle that attatched console I/O protocols\r
+  Console Splitter Driver. Any Handle that attached console I/O protocols\r
   (Console In device, Console Out device, Console Error device, Simple Pointer\r
   protocol, Absolute Pointer protocol) can be bound by this driver.\r
 \r
@@ -13,7 +13,7 @@
 \r
   Each virtual handle, that supports the Console I/O protocol, will be produced\r
   in the driver entry point. The virtual handle are added on driver entry and\r
-  never removed. Such design ensures sytem function well during none console\r
+  never removed. Such design ensures system function well during none console\r
   device situation.\r
 \r
 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
@@ -381,7 +381,7 @@ ToggleStateSyncInitialization (
 }\r
 \r
 /**\r
-  Reinitialization for toggle state sync.\r
+  Re-initialization for toggle state sync.\r
 \r
   @param Private                    Text In Splitter pointer.\r
 \r
@@ -594,7 +594,7 @@ ConSplitterDriverEntry(
                                    structure.\r
 \r
   @retval EFI_OUT_OF_RESOURCES     Out of resources.\r
-  @retval EFI_SUCCESS              Text Input Devcie's private data has been constructed.\r
+  @retval EFI_SUCCESS              Text Input Device's private data has been constructed.\r
   @retval other                    Failed to construct private data.\r
 \r
 **/\r
@@ -761,7 +761,7 @@ ConSplitterTextOutConstructor (
   }\r
 \r
   //\r
-  // Initilize console output splitter's private data.\r
+  // Initialize console output splitter's private data.\r
   //\r
   ConOutPrivate->TextOut.Mode = &ConOutPrivate->TextOutMode;\r
 \r
@@ -860,7 +860,7 @@ ConSplitterTextOutConstructor (
   @param  Guid                The specified protocol.\r
 \r
   @retval EFI_SUCCESS         The specified protocol is supported on this device.\r
-  @retval EFI_UNSUPPORTED     The specified protocol attempts to be installed on virtul handle.\r
+  @retval EFI_UNSUPPORTED     The specified protocol attempts to be installed on virtual handle.\r
   @retval other               Failed to open specified protocol on this device.\r
 \r
 **/\r
@@ -1108,7 +1108,7 @@ ConSplitterStart (
   }\r
 \r
   //\r
-  // Open InterfaceGuid on the virtul handle.\r
+  // Open InterfaceGuid on the virtual handle.\r
   //\r
   Status =  gBS->OpenProtocol (\r
                 ControllerHandle,\r
@@ -1174,7 +1174,7 @@ ConSplitterConInDriverBindingStart (
 \r
   //\r
   // Start ConSplitter on ControllerHandle, and create the virtual\r
-  // agrogated console device on first call Start for a SimpleTextIn handle.\r
+  // aggregated console device on first call Start for a SimpleTextIn handle.\r
   //\r
   Status = ConSplitterStart (\r
             This,\r
@@ -1241,7 +1241,7 @@ ConSplitterSimplePointerDriverBindingStart (
 \r
   //\r
   // Start ConSplitter on ControllerHandle, and create the virtual\r
-  // agrogated console device on first call Start for a SimplePointer handle.\r
+  // aggregated console device on first call Start for a SimplePointer handle.\r
   //\r
   Status = ConSplitterStart (\r
             This,\r
@@ -1287,7 +1287,7 @@ ConSplitterAbsolutePointerDriverBindingStart (
 \r
   //\r
   // Start ConSplitter on ControllerHandle, and create the virtual\r
-  // agrogated console device on first call Start for a AbsolutePointer handle.\r
+  // aggregated console device on first call Start for a AbsolutePointer handle.\r
   //\r
   Status = ConSplitterStart (\r
              This,\r
@@ -1338,7 +1338,7 @@ ConSplitterConOutDriverBindingStart (
 \r
   //\r
   // Start ConSplitter on ControllerHandle, and create the virtual\r
-  // agrogated console device on first call Start for a ConsoleOut handle.\r
+  // aggregated console device on first call Start for a ConsoleOut handle.\r
   //\r
   Status = ConSplitterStart (\r
             This,\r
@@ -1451,7 +1451,7 @@ ConSplitterStdErrDriverBindingStart (
 \r
   //\r
   // Start ConSplitter on ControllerHandle, and create the virtual\r
-  // agrogated console device on first call Start for a StandardError handle.\r
+  // aggregated console device on first call Start for a StandardError handle.\r
   //\r
   Status = ConSplitterStart (\r
             This,\r
@@ -1522,7 +1522,7 @@ ConSplitterStop (
     return Status;\r
   }\r
   //\r
-  // close the protocol refered.\r
+  // close the protocol referred.\r
   //\r
   gBS->CloseProtocol (\r
         ControllerHandle,\r
@@ -1543,7 +1543,7 @@ ConSplitterStop (
 \r
 \r
 /**\r
-  Stop Console In ConSplitter on ControllerHandle by closing Console In Devcice GUID.\r
+  Stop Console In ConSplitter on ControllerHandle by closing Console In Device GUID.\r
 \r
   @param  This              Driver Binding protocol instance pointer.\r
   @param  ControllerHandle  Handle of device to stop driver on\r
@@ -1718,7 +1718,7 @@ ConSplitterAbsolutePointerDriverBindingStop (
 \r
 \r
 /**\r
-  Stop Console Out ConSplitter on device handle by closing Console Out Devcice GUID.\r
+  Stop Console Out ConSplitter on device handle by closing Console Out Devcie GUID.\r
 \r
   @param  This              Driver Binding protocol instance pointer.\r
   @param  ControllerHandle  Handle of device to stop driver on\r
@@ -2725,7 +2725,7 @@ ConSplitterGetIntersectionBetweenConOutAndStrErr (
 \r
 \r
 /**\r
-  Add Grahpics Output modes into Consplitter Text Out list.\r
+  Add Graphics Output modes into Consplitter Text Out list.\r
 \r
   @param  Private               Text Out Splitter pointer.\r
   @param  GraphicsOutput        Graphics Output protocol pointer.\r
@@ -3392,7 +3392,7 @@ ConSplitterTextOutDeleteDevice (
     return EFI_SUCCESS;\r
   }\r
   //\r
-  // Max Mode is realy an intersection of the QueryMode command to all\r
+  // Max Mode is really an intersection of the QueryMode command to all\r
   // devices. So we must copy the QueryMode of the first device to\r
   // QueryData.\r
   //\r
@@ -3430,7 +3430,7 @@ ConSplitterTextOutDeleteDevice (
 \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
@@ -3514,7 +3514,7 @@ ConSplitterTextInExDequeueKey (
 \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  Private                  Protocol instance pointer.\r
   @param  Key                      Driver may perform diagnostics on reset.\r
@@ -3587,7 +3587,7 @@ ConSplitterTextInPrivateReadKeyStroke (
 \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  This                     Protocol instance pointer.\r
   @param  Key                      Driver may perform diagnostics on reset.\r
@@ -3631,7 +3631,7 @@ ConSplitterTextInReadKeyStroke (
   spliter event. This will cause the calling code to call\r
   ConSplitterTextInReadKeyStroke ().\r
 \r
-  @param  Event                    The Event assoicated with callback.\r
+  @param  Event                    The Event associated with callback.\r
   @param  Context                  Context registered when Event was created.\r
 \r
 **/\r
@@ -3681,7 +3681,7 @@ ConSplitterTextInWaitForKey (
                                    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
@@ -3715,7 +3715,7 @@ IsKeyRegistered (
 \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
@@ -3769,7 +3769,7 @@ ConSplitterTextInResetEx (
 \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  This                     Protocol instance pointer.\r
   @param  KeyData                  A pointer to a buffer that is filled in with the\r
@@ -3978,7 +3978,7 @@ ConSplitterTextInSetState (
 \r
   @retval EFI_SUCCESS              The notification function was registered\r
                                    successfully.\r
-  @retval EFI_OUT_OF_RESOURCES     Unable to allocate resources for necesssary data\r
+  @retval EFI_OUT_OF_RESOURCES     Unable to allocate resources for necessary data\r
                                    structures.\r
   @retval EFI_INVALID_PARAMETER    KeyData or KeyNotificationFunction or NotifyHandle is NULL.\r
 \r
@@ -4126,7 +4126,7 @@ ConSplitterTextInUnregisterKeyNotify (
 \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
@@ -4174,7 +4174,7 @@ ConSplitterSimplePointerReset (
 \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  Private                  Protocol instance pointer.\r
   @param  State                    The state information of simple pointer device.\r
@@ -4279,12 +4279,12 @@ ConSplitterSimplePointerGetState (
 \r
 \r
 /**\r
-  This event agregates all the events of the ConIn devices in the spliter.\r
+  This event aggregates all the events of the ConIn devices in the spliter.\r
   If any events of physical ConIn devices are signaled, signal the ConIn\r
   spliter event. This will cause the calling code to call\r
   ConSplitterTextInReadKeyStroke ().\r
 \r
-  @param  Event                    The Event assoicated with callback.\r
+  @param  Event                    The Event associated with callback.\r
   @param  Context                  Context registered when Event was created.\r
 \r
 **/\r
@@ -4493,12 +4493,12 @@ ConSplitterAbsolutePointerGetState (
 \r
 \r
 /**\r
-  This event agregates all the events of the pointer devices in the splitter.\r
+  This event aggregates all the events of the pointer devices in the splitter.\r
   If any events of physical pointer devices are signaled, signal the pointer\r
   splitter event. This will cause the calling code to call\r
   ConSplitterAbsolutePointerGetState ().\r
 \r
-  @param  Event                    The Event assoicated with callback.\r
+  @param  Event                    The Event associated with callback.\r
   @param  Context                  Context registered when Event was created.\r
 \r
 **/\r
@@ -4537,10 +4537,10 @@ ConSplitterAbsolutePointerWaitForInput (
 \r
 \r
 /**\r
-  Reset the text output device hardware and optionaly run diagnostics\r
+  Reset the text output device hardware and optionally run diagnostics\r
 \r
   @param  This                     Protocol instance pointer.\r
-  @param  ExtendedVerification     Driver may perform more exhaustive verfication\r
+  @param  ExtendedVerification     Driver may perform more exhaustive verification\r
                                    operation of the device during reset.\r
 \r
   @retval EFI_SUCCESS              The text output device was reset.\r

diff --git a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.c b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.c
index 6b8d11d587d1fd077e5d07e183d95424f64afabb..d6d8db51d5e960b8fdb4e22f7049a32ef679bbbb 100644 (file)
--- a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.c
+++ b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.c
@@ -214,7 +214,7 @@ Error:
 \r
   @param[in]  HorizontalResolution     The size of video screen in pixels in the X dimension.\r
   @param[in]  VerticalResolution       The size of video screen in pixels in the Y dimension.\r
-  @param[in]  GopModeNumber            The graphics mode number which graphis console is based on.\r
+  @param[in]  GopModeNumber            The graphics mode number which graphics console is based on.\r
   @param[out] TextModeCount            The total number of text modes that graphics console supports.\r
   @param[out] TextModeData             The buffer to the text modes column and row information.\r
                                        Caller is responsible to free it when it's non-NULL.\r
@@ -491,7 +491,7 @@ GraphicsConsoleControllerDriverStart (
         Mode = Private->GraphicsOutput->Mode;\r
         if (EFI_ERROR (Status) && Mode->MaxMode != 0) {\r
           //\r
-          // Set default mode failed or device don't support default mode, then get the current mode information\r
+          // If set default mode failed or device doesn't support default mode, then get the current mode information\r
           //\r
           HorizontalResolution = Mode->Info->HorizontalResolution;\r
           VerticalResolution = Mode->Info->VerticalResolution;\r
@@ -501,7 +501,7 @@ GraphicsConsoleControllerDriverStart (
     }\r
     if (ModeNumber != Private->GraphicsOutput->Mode->Mode) {\r
       //\r
-      // Current graphics mode is not set or is not set to the mode which we has found,\r
+      // Current graphics mode is not set or is not set to the mode which we have found,\r
       // set the new graphic mode.\r
       //\r
       Status = Private->GraphicsOutput->SetMode (Private->GraphicsOutput, ModeNumber);\r
@@ -740,7 +740,7 @@ GraphicsConsoleControllerDriverStop (
   Check if the current specific mode supported the user defined resolution\r
   for the Graphics Console device based on Graphics Output Protocol.\r
 \r
-  If yes, set the graphic devcice's current mode to this specific mode.\r
+  If yes, set the graphic device's current mode to this specific mode.\r
 \r
   @param  GraphicsOutput        Graphics Output Protocol instance pointer.\r
   @param  HorizontalResolution  User defined horizontal resolution\r
@@ -843,7 +843,7 @@ EfiLocateHiiProtocol (
   Reset the text output device hardware and optionally run diagnostics.\r
 \r
   Implements SIMPLE_TEXT_OUTPUT.Reset().\r
-  If ExtendeVerification is TRUE, then perform dependent Graphics Console\r
+  If ExtendedVerification is TRUE, then perform dependent Graphics Console\r
   device reset, and set display mode to mode 0.\r
   If ExtendedVerification is FALSE, only set display mode to mode 0.\r
 \r
@@ -1713,7 +1713,7 @@ GraphicsConsoleConOutEnableCursor (
 }\r
 \r
 /**\r
-  Gets Graphics Console devcie's foreground color and background color.\r
+  Gets Graphics Console device's foreground color and background color.\r
 \r
   @param  This                  Protocol instance pointer.\r
   @param  Foreground            Returned text foreground color.\r

diff --git a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.h b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.h
index 28d47ac7cb1e0ada8834bc620f45ba81cb812f4f..11d254b70f322ce83c9d60eb05484c77aa12c58a 100644 (file)
--- a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.h
+++ b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsole.h
@@ -205,7 +205,7 @@ GraphicsConsoleComponentNameGetControllerName (
   Reset the text output device hardware and optionally run diagnostics.\r
 \r
   Implements SIMPLE_TEXT_OUTPUT.Reset().\r
-  If ExtendeVerification is TRUE, then perform dependent Graphics Console\r
+  If ExtendedVerification is TRUE, then perform dependent Graphics Console\r
   device reset, and set display mode to mode 0.\r
   If ExtendedVerification is FALSE, only set display mode to mode 0.\r
 \r
@@ -286,7 +286,7 @@ GraphicsConsoleConOutTestString (
   supports\r
 \r
   Implements SIMPLE_TEXT_OUTPUT.QueryMode().\r
-  It returnes information for an available text mode that the Graphics Console supports.\r
+  It returns information for an available text mode that the Graphics Console supports.\r
   In this driver,we only support text mode 80x25, which is defined as mode 0.\r
 \r
   @param  This                  Protocol instance pointer.\r
@@ -422,7 +422,7 @@ GraphicsConsoleConOutEnableCursor (
 /**\r
   Test to see if Graphics Console could be supported on the Controller.\r
 \r
-  Graphics Console could be supported if Graphics Output Protocol or UGA Draw\r
+  Graphics Console could be supported if Graphics Output Protocol or UGADraw\r
   Protocol exists on the Controller. (UGA Draw Protocol could be skipped\r
   if PcdUgaConsumeSupport is set to FALSE.)\r
 \r
@@ -510,7 +510,7 @@ EfiLocateHiiProtocol (
 \r
 \r
 /**\r
-  Gets Graphics Console devcie's foreground color and background color.\r
+  Gets Graphics Console device's foreground color and background color.\r
 \r
   @param  This                  Protocol instance pointer.\r
   @param  Foreground            Returned text foreground color.\r

diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h
index a849c08d66df77b061d5c548079f31d6c95c9e30..100d69a23a9bc2b71179020ef165092f07732c3b 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextOut.h
+++ b/MdePkg/Include/Protocol/SimpleTextOut.h
@@ -32,7 +32,7 @@ typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;
 typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;\r
 \r
 //\r
-// Define's for required EFI Unicode Box Draw characters\r
+// Defines for required EFI Unicode Box Draw characters\r
 //\r
 #define BOXDRAW_HORIZONTAL                  0x2500\r
 #define BOXDRAW_VERTICAL                    0x2502\r
@@ -151,7 +151,7 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
 #define EFI_WIDE_ATTRIBUTE  0x80\r
 \r
 /**\r
-  Reset the text output device hardware and optionaly run diagnostics\r
+  Reset the text output device hardware and optionally run diagnostics\r
 \r
   @param  This                 The protocol instance pointer.\r
   @param  ExtendedVerification Driver may perform more exhaustive verification\r
@@ -373,7 +373,7 @@ typedef struct {
   ///\r
   INT32   CursorRow;\r
   ///\r
-  /// The cursor is currently visbile or not.\r
+  /// The cursor is currently visible or not.\r
   ///\r
   BOOLEAN CursorVisible;\r
 } EFI_SIMPLE_TEXT_OUTPUT_MODE;\r