MdeModulePkg/Core/PiSmmCore: 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>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Hao A Wu <hao.a.wu@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-18-philmd@redhat.com>

MdeModulePkg/Core/PiSmmCore/Dependency.c

@@ -192,7 +192,7 @@ SmmIsSchedulable (
   if (DriverEntry->Depex == NULL) {
     //
     // A NULL Depex means that the SMM driver is not built correctly.
-    // All SMM drivers must have a valid depex expressiion.
+    // All SMM drivers must have a valid depex expression.
     //
     DEBUG ((DEBUG_DISPATCH, "  RESULT = FALSE (Depex is empty)\n"));
     ASSERT (FALSE);
@@ -371,7 +371,7 @@ SmmIsSchedulable (
     // The math is done out of order, but it should not matter. That is
     // we may add in the sizeof (EFI_GUID) before we account for the OP Code.
     // This is not an issue, since we just need the correct end result. You
-    // need to be careful using Iterator in the loop as it's intermediate value
+    // need to be careful using Iterator in the loop as its intermediate value
     // may be strange.
     //
     Iterator++;

MdeModulePkg/Core/PiSmmCore/Dispatcher.c

@@ -17,7 +17,7 @@
             and After dependencies. This is done recursively as the call to add
             to the mScheduledQueue checks for Before and recursively adds
             all Befores. It then addes the item that was passed in and then
-            processess the After dependecies by recursively calling the routine.
+            processes the After dependencies by recursively calling the routine.
 
   Dispatcher Rules:
   The rules for the dispatcher are similar to the DXE dispatcher.
@@ -25,7 +25,7 @@
   The rules for DXE dispatcher are in chapter 10 of the DXE CIS. Figure 10-3
   is the state diagram for the DXE dispatcher
 
-  Depex - Dependency Expresion.
+  Depex - Dependency Expression.
 
   Copyright (c) 2014, Hewlett-Packard Development Company, L.P.
   Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
@@ -83,12 +83,12 @@ LIST_ENTRY  mScheduledQueue = INITIALIZE_LIST_HEAD_VARIABLE (mScheduledQueue);
 LIST_ENTRY  mFvHandleList = INITIALIZE_LIST_HEAD_VARIABLE (mFvHandleList);
 
 //
-// Flag for the SMM Dispacher.  TRUE if dispatcher is execuing.
+// Flag for the SMM Dispatcher.  TRUE if dispatcher is executing.
 //
 BOOLEAN  gDispatcherRunning = FALSE;
 
 //
-// Flag for the SMM Dispacher.  TRUE if there is one or more SMM drivers ready to be dispatched
+// Flag for the SMM Dispatcher.  TRUE if there is one or more SMM drivers ready to be dispatched
 //
 BOOLEAN  gRequestDispatch = FALSE;
 
@@ -175,7 +175,7 @@ CheckAndMarkFixLoadingMemoryUsageBitMap (
      return EFI_NOT_FOUND;
    }
    //
-   // Test if the memory is avalaible or not.
+   // Test if the memory is available or not.
    //
    BaseOffsetPageNumber = EFI_SIZE_TO_PAGES((UINT32)(ImageBase - SmmCodeBase));
    TopOffsetPageNumber  = EFI_SIZE_TO_PAGES((UINT32)(ImageBase + ImageSize - SmmCodeBase));
@@ -458,7 +458,7 @@ SmmLoadImage (
     Status = GetPeCoffImageFixLoadingAssignedAddress (&ImageContext);
     if (!EFI_ERROR (Status)) {
       //
-      // Since the memory range to load Smm core alreay been cut out, so no need to allocate and free this range
+      // Since the memory range to load Smm core already been cut out, so no need to allocate and free this range
       // following statements is to bypass SmmFreePages
       //
       PageCount = 0;
@@ -664,7 +664,7 @@ SmmLoadImage (
       //
       // Copy the PDB file name to our temporary string, and replace .pdb with .efi
       // The PDB file name is limited in the range of 0~255.
-      // If the length is bigger than 255, trim the redudant characters to avoid overflow in array boundary.
+      // If the length is bigger than 255, trim the redundant characters to avoid overflow in array boundary.
       //
       for (Index = 0; Index < sizeof (EfiFileName) - 4; Index++) {
         EfiFileName[Index] = ImageContext.PdbPointer[Index + StartIndex];
@@ -741,7 +741,7 @@ SmmPreProcessDepex (
 
   @param  DriverEntry           Driver to work on.
 
-  @retval EFI_SUCCESS           Depex read and preprossesed
+  @retval EFI_SUCCESS           Depex read and preprocessed
   @retval EFI_PROTOCOL_ERROR    The section extraction protocol returned an error
                                 and  Depex reading needs to be retried.
   @retval Error                 DEPEX not found.
@@ -1093,8 +1093,8 @@ FvHasBeenProcessed (
 }
 
 /**
-  Remember that Fv protocol on FvHandle has had it's drivers placed on the
+  Remember that Fv protocol on FvHandle has had its drivers placed on the
-  mDiscoveredList. This fucntion adds entries on the mFvHandleList. Items are
+  mDiscoveredList. This function adds entries on the mFvHandleList. Items are
   never removed/freed from the mFvHandleList.
 
   @param  FvHandle              The handle of a FV that has been processed
@@ -1165,7 +1165,7 @@ SmmFvToDevicePath (
 
 /**
   Add an entry to the mDiscoveredList. Allocate memory to store the DriverEntry,
-  and initilize any state variables. Read the Depex from the FV and store it
+  and initialize any state variables. Read the Depex from the FV and store it
   in DriverEntry. Pre-process the Depex to set the Before and After state.
   The Discovered list is never free'ed and contains booleans that represent the
   other possible SMM driver states.
@@ -1473,7 +1473,7 @@ SmmDriverDispatchHandler (
 
 /**
   Traverse the discovered list for any drivers that were discovered but not loaded
-  because the dependency experessions evaluated to false.
+  because the dependency expressions evaluated to false.
 
 **/
 VOID

MdeModulePkg/Core/PiSmmCore/HeapGuard.c

@@ -497,7 +497,7 @@ IsMemoryGuarded (
 /**
   Set the page at the given address to be a Guard page.
 
-  This is done by changing the page table attribute to be NOT PRSENT.
+  This is done by changing the page table attribute to be NOT PRESENT.
 
   @param[in]  BaseAddress     Page address to Guard at.
 
@@ -527,7 +527,7 @@ SetGuardPage (
 /**
   Unset the Guard page at the given address to the normal memory.
 
-  This is done by changing the page table attribute to be PRSENT.
+  This is done by changing the page table attribute to be PRESENT.
 
   @param[in]  BaseAddress     Page address to Guard at.
 

MdeModulePkg/Core/PiSmmCore/HeapGuard.h

@@ -39,7 +39,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 //
 // For a normal configuration of system with 4G memory, two levels of tables
 // can track the whole memory, because two levels (L3+L4) of map tables have
-// already coverred 37-bit of memory address. And for a normal UEFI BIOS,
+// already covered 37-bit of memory address. And for a normal UEFI BIOS,
 // less than 128M memory would be consumed during boot. That means we just
 // need
 //

MdeModulePkg/Core/PiSmmCore/Locate.c

@@ -34,7 +34,7 @@ IHANDLE *
 /**
   Routine to get the next Handle, when you are searching for all handles.
 
-  @param  Position               Information about which Handle to seach for.
+  @param  Position               Information about which Handle to search for.
   @param  Interface              Return the interface structure for the matching
                                  protocol.
 
@@ -70,7 +70,7 @@ SmmGetNextLocateAllHandles (
   Routine to get the next Handle, when you are searching for register protocol
   notifies.
 
-  @param  Position               Information about which Handle to seach for.
+  @param  Position               Information about which Handle to search for.
   @param  Interface              Return the interface structure for the matching
                                  protocol.
 
@@ -116,7 +116,7 @@ SmmGetNextLocateByRegisterNotify (
 /**
   Routine to get the next Handle, when you are searching for a given protocol.
 
-  @param  Position               Information about which Handle to seach for.
+  @param  Position               Information about which Handle to search for.
   @param  Interface              Return the interface structure for the matching
                                  protocol.
 
@@ -173,7 +173,7 @@ SmmGetNextLocateByProtocol (
 /**
   Return the first Protocol Interface that matches the Protocol GUID. If
   Registration is pasased in return a Protocol Instance that was just add
-  to the system. If Retistration is NULL return the first Protocol Interface
+  to the system. If Registration is NULL return the first Protocol Interface
   you find.
 
   @param  Protocol               The protocol to search for

MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c

@@ -152,7 +152,7 @@ SortMemoryMap (
 }
 
 /**
-  Merge continous memory map entries whose have same attributes.
+  Merge continuous memory map entries whose have same attributes.
 
   @param[in, out]  MemoryMap              A pointer to the buffer in which firmware places
                                           the current memory map.
@@ -300,7 +300,7 @@ GetImageRecordByAddress (
   @param[in]       ImageRecord            An image record whose [ImageBase, ImageSize] covered
                                           by old memory map entry.
   @param[in, out]  NewRecord              A pointer to several new memory map entries.
-                                          The caller gurantee the buffer size be 1 +
+                                          The caller guarantee the buffer size be 1 +
                                           (SplitRecordCount * DescriptorSize) calculated
                                           below.
   @param[in]       OldRecord              A pointer to one old memory map entry.
@@ -450,7 +450,7 @@ GetMaxSplitRecordCount (
 
   @param[in]       OldRecord              A pointer to one old memory map entry.
   @param[in, out]  NewRecord              A pointer to several new memory map entries.
-                                          The caller gurantee the buffer size be 1 +
+                                          The caller guarantee the buffer size be 1 +
                                           (SplitRecordCount * DescriptorSize) calculated
                                           below.
   @param[in]       MaxSplitRecordCount    The max number of splitted entries
@@ -667,7 +667,7 @@ SplitTable (
   This function for GetMemoryMap() with memory attributes table.
 
   It calls original GetMemoryMap() to get the original memory map information. Then
-  plus the additional memory map entries for PE Code/Data seperation.
+  plus the additional memory map entries for PE Code/Data separation.
 
   @param[in, out]  MemoryMapSize          A pointer to the size, in bytes, of the
                                           MemoryMap buffer. On input, this is the size of

MdeModulePkg/Core/PiSmmCore/Page.c

@@ -83,7 +83,7 @@ SmmInternalAllocatePagesEx (
   Please Note this algorithm to allocate the memory map descriptor has a property
   that the memory allocated for memory entries always grows, and will never really be freed.
 
-  @return The Memory map descriptor dequed from the mFreeMemoryMapEntryList
+  @return The Memory map descriptor dequeued from the mFreeMemoryMapEntryList
 
 **/
 MEMORY_MAP *
@@ -117,7 +117,7 @@ AllocateMemoryMapEntry (
       FreeDescriptorEntries = (MEMORY_MAP *)(UINTN)Mem;
       //DEBUG((DEBUG_INFO, "New FreeDescriptorEntries - 0x%x\n", FreeDescriptorEntries));
       //
-      // Enque the free memmory map entries into the list
+      // Enqueue the free memory map entries into the list
       //
       for (Index = 0; Index< RUNTIME_PAGE_ALLOCATION_GRANULARITY / sizeof(MEMORY_MAP); Index++) {
         FreeDescriptorEntries[Index].Signature = MEMORY_MAP_SIGNATURE;

MdeModulePkg/Core/PiSmmCore/PiSmmCore.c

@@ -373,7 +373,7 @@ SmmReadyToLockHandler (
              );
 
   //
-  // Make sure SMM CPU I/O 2 Procol has been installed into the handle database
+  // Make sure SMM CPU I/O 2 Protocol has been installed into the handle database
   //
   Status = SmmLocateProtocol (&gEfiSmmCpuIo2ProtocolGuid, NULL, &Interface);
 
@@ -586,7 +586,7 @@ SmmEndOfS3ResumeHandler (
   ASSERT_EFI_ERROR (Status);
 
   //
-  // Uninstall the protocol here because the comsumer just hook the
+  // Uninstall the protocol here because the consumer just hook the
   // installation event.
   //
   Status = SmmUninstallProtocolInterface (
@@ -673,7 +673,7 @@ SmmEntryPoint (
   SmmEntryPointMemoryManagementHook ();
 
   //
-  // If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed
+  // If a legacy boot has occurred, then make sure gSmmCorePrivate is not accessed
   //
   InLegacyBoot = mInLegacyBoot;
   if (!InLegacyBoot) {
@@ -737,7 +737,7 @@ SmmEntryPoint (
   PlatformHookAfterSmmDispatch ();
 
   //
-  // If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed
+  // If a legacy boot has occurred, then make sure gSmmCorePrivate is not accessed
   //
   if (!InLegacyBoot) {
     //
@@ -867,7 +867,7 @@ SmmMain (
   //
   // No need to initialize memory service.
   // It is done in constructor of PiSmmCoreMemoryAllocationLib(),
-  // so that the library linked with PiSmmCore can use AllocatePool() in constuctor.
+  // so that the library linked with PiSmmCore can use AllocatePool() in constructor.
   //
 
   SmramProfileInit ();

MdeModulePkg/Core/PiSmmCore/PiSmmCore.h

@@ -171,7 +171,7 @@ typedef struct {
   EFI_GUID            ProtocolID;
   /// All protocol interfaces
   LIST_ENTRY          Protocols;
-  /// Registerd notification handlers
+  /// Registered notification handlers
   LIST_ENTRY          Notify;
 } PROTOCOL_ENTRY;
 
@@ -562,7 +562,7 @@ SmmLocateHandle (
 /**
   Return the first Protocol Interface that matches the Protocol GUID. If
   Registration is pasased in return a Protocol Instance that was just add
-  to the system. If Retistration is NULL return the first Protocol Interface
+  to the system. If Registration is NULL return the first Protocol Interface
   you find.
 
   @param  Protocol               The protocol to search for
@@ -602,7 +602,7 @@ SmmLocateProtocol (
   @retval EFI_NOT_FOUND          No handles match the search.
   @retval EFI_OUT_OF_RESOURCES   There is not enough pool memory to store the
                                  matching results.
-  @retval EFI_INVALID_PARAMETER  One or more paramters are not valid.
+  @retval EFI_INVALID_PARAMETER  One or more parameters are not valid.
 
 **/
 EFI_STATUS
@@ -641,7 +641,7 @@ SmiManage (
 /**
   Registers a handler to execute within SMM.
 
-  @param  Handler        Handler service funtion pointer.
+  @param  Handler        Handler service function pointer.
   @param  HandlerType    Points to the handler type or NULL for root SMI handlers.
   @param  DispatchHandle On return, contains a unique handle which can be used to later unregister the handler function.
 
@@ -873,12 +873,12 @@ SmmEfiNotAvailableYetArg5 (
   );
 
 //
-//Functions used during debug buils
+//Functions used during debug builds
 //
 
 /**
   Traverse the discovered list for any drivers that were discovered but not loaded
-  because the dependency experessions evaluated to false.
+  because the dependency expressions evaluated to false.
 
 **/
 VOID

MdeModulePkg/Core/PiSmmCore/PiSmmCorePrivateData.h

@@ -65,7 +65,7 @@ typedef struct {
 
   ///
   /// The SMM Foundation Entry Point.  The SMM Core fills in this field when the
-  /// SMM Core is initialized.  The SMM IPL is responsbile for registering this entry
+  /// SMM Core is initialized.  The SMM IPL is responsible for registering this entry
   /// point with the SMM Configuration Protocol.  The SMM Configuration Protocol may
   /// not be available at the time the SMM IPL and SMM Core are started, so the SMM IPL
   /// sets up a protocol notification on the SMM Configuration Protocol and registers
@@ -92,14 +92,14 @@ typedef struct {
   EFI_SMM_SYSTEM_TABLE2           *Smst;
 
   ///
-  /// This field is used by the SMM Communicatioon Protocol to pass a buffer into
+  /// This field is used by the SMM Communication Protocol to pass a buffer into
   /// a software SMI handler and for the software SMI handler to pass a buffer back to
   /// the caller of the SMM Communication Protocol.
   ///
   VOID                            *CommunicationBuffer;
 
   ///
-  /// This field is used by the SMM Communicatioon Protocol to pass the size of a buffer,
+  /// This field is used by the SMM Communication Protocol to pass the size of a buffer,
   /// in bytes, into a software SMI handler and for the software SMI handler to pass the
   /// size, in bytes, of a buffer back to the caller of the SMM Communication Protocol.
   ///

MdeModulePkg/Core/PiSmmCore/PiSmmIpl.c

@@ -707,7 +707,7 @@ SmmIplSmmConfigurationEventNotify (
   }
 
   //
-  // Register the SMM Entry Point provided by the SMM Core with the SMM COnfiguration protocol
+  // Register the SMM Entry Point provided by the SMM Core with the SMM Configuration protocol
   //
   Status = SmmConfiguration->RegisterSmmEntry (SmmConfiguration, gSmmCorePrivate->SmmEntryPoint);
   ASSERT_EFI_ERROR (Status);
@@ -964,7 +964,7 @@ ExecuteSmmCoreFromSmram (
   }
 
   //
-  // Initilize ImageContext
+  // Initialize ImageContext
   //
   ImageContext.Handle    = SourceBuffer;
   ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;
@@ -1082,7 +1082,7 @@ ExecuteSmmCoreFromSmram (
   }
 
   //
-  // Always free memory allocted by GetFileBufferByFilePath ()
+  // Always free memory allocated by GetFileBufferByFilePath ()
   //
   FreePool (SourceBuffer);
 
@@ -1763,7 +1763,7 @@ SmmIplEntry (
   ASSERT_EFI_ERROR (Status);
 
   //
-  // Create the set of protocol and event notififcations that the SMM IPL requires
+  // Create the set of protocol and event notifications that the SMM IPL requires
   //
   for (Index = 0; mSmmIplEvents[Index].NotifyFunction != NULL; Index++) {
     if (mSmmIplEvents[Index].Protocol) {

MdeModulePkg/Core/PiSmmCore/PiSmmIpl.inf

@@ -57,23 +57,23 @@
   gEfiSmmControl2ProtocolGuid                   ## CONSUMES
   ## NOTIFY
   ## SOMETIMES_CONSUMES
-  ## UNDEFINED # Used to do smm communcation
+  ## UNDEFINED # Used to do smm communication
   gEfiDxeSmmReadyToLockProtocolGuid
   gEfiCpuArchProtocolGuid                       ## SOMETIMES_CONSUMES
 
 [Guids]
   ## CONSUMES           ## Event
-  ## PRODUCES           ## UNDEFINED # Used to do smm communcation
+  ## PRODUCES           ## UNDEFINED # Used to do smm communication
   gEfiEventDxeDispatchGuid
   gEfiEventReadyToBootGuid                      ## CONSUMES             ## Event
   ## SOMETIMES_CONSUMES ## Event
-  ## SOMETIMES_PRODUCES ## UNDEFINED # Used to do smm communcation
+  ## SOMETIMES_PRODUCES ## UNDEFINED # Used to do smm communication
   gEfiEventLegacyBootGuid
   ## SOMETIMES_CONSUMES ## Event
-  ## SOMETIMES_PRODUCES ## UNDEFINED # Used to do smm communcation
+  ## SOMETIMES_PRODUCES ## UNDEFINED # Used to do smm communication
   gEfiEventExitBootServicesGuid
   ## SOMETIMES_CONSUMES ## Event
-  ## SOMETIMES_PRODUCES ## UNDEFINED # Used to do smm communcation
+  ## SOMETIMES_PRODUCES ## UNDEFINED # Used to do smm communication
   gEfiEventReadyToBootGuid
   gEfiEventVirtualAddressChangeGuid             ## CONSUMES             ## Event
   gEfiEndOfDxeEventGroupGuid                    ## CONSUMES             ## Event

MdeModulePkg/Core/PiSmmCore/Smi.c

@@ -196,7 +196,7 @@ SmiManage (
 /**
   Registers a handler to execute within SMM.
 
-  @param  Handler        Handler service funtion pointer.
+  @param  Handler        Handler service function pointer.
   @param  HandlerType    Points to the handler type or NULL for root SMI handlers.
   @param  DispatchHandle On return, contains a unique handle which can be used to later unregister the handler function.
 

MdeModulePkg/Core/PiSmmCore/SmramProfileRecord.c

@@ -78,7 +78,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_DEVICE_PATH_PROTOCOL *mSmramProfileDriverPath;
 GLOBAL_REMOVE_IF_UNREFERENCED UINTN                    mSmramProfileDriverPathSize;
 
 /**
-  Dump SMRAM infromation.
+  Dump SMRAM information.
 
 **/
 VOID
@@ -2797,7 +2797,7 @@ DumpSmramProfile (
 }
 
 /**
-  Dump SMRAM infromation.
+  Dump SMRAM information.
 
 **/
 VOID