Require cspell 5.20.0

Update cspell to 5.20.0 and make appropriate spelling changes to ensure CI passes.
microsoft · Dec 18, 2023 · 820b09b · 820b09b
1 parent 4d4080f
commit 820b09b
Show file tree

Hide file tree

Showing 34 changed files with 2,247 additions and 2,167 deletions.
diff --git a/EmbeddedPkg/Drivers/AndroidFastbootTransportTcpDxe/FastbootTransportTcp.c b/EmbeddedPkg/Drivers/AndroidFastbootTransportTcpDxe/FastbootTransportTcp.c
@@ -87,7 +87,7 @@ DataReceived (
 */
 STATIC
 EFI_STATUS
-SubmitRecieveToken (
+SubmitReceiveToken (
   VOID
   )
 {
@@ -208,7 +208,7 @@ DataReceived (
       = ReceiveToken->Packet.RxData->FragmentTable[0].FragmentLength;
 
     // Prepare to receive more data
-    SubmitRecieveToken ();
+    SubmitReceiveToken ();
   } else {
     // Fatal receive error. Put an entry with NULL in the queue, signifying
     // to return EFI_DEVICE_ERROR from TcpFastbootTransportReceive.
@@ -282,7 +282,7 @@ ConnectionAccepted (
   }
 
   for (Index = 0; Index < NUM_RX_TOKENS; Index++) {
-    SubmitRecieveToken ();
+    SubmitReceiveToken ();
   }
 }
 

diff --git a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
@@ -29,7 +29,7 @@ EFI_DRIVER_BINDING_PROTOCOL  gVirtualKeyboardDriverBinding = {
 /**
   Check whether the driver supports this device.
 
-  @param  This                   The Udriver binding protocol.
+  @param  This                   The driver binding protocol.
   @param  Controller             The controller handle to check.
   @param  RemainingDevicePath    The remaining device path.
 
@@ -500,7 +500,7 @@ VirtualKeyboardWaitForKey (
   // will have a bad performance during this period,
   // e.g. usb keyboard driver.
   // Add a stall period can greatly increate other driver performance during
-  // the WaitForKey is recursivly invoked. 1ms delay will make little impact
+  // the WaitForKey is recursively invoked. 1ms delay will make little impact
   // to the thunk keyboard driver, and user can not feel the delay at all when
   // input.
   //
@@ -666,7 +666,7 @@ KeyboardReadKeyStrokeWorker (
   // bad performance during this period,
   // e.g. usb keyboard driver.
   // Add a stall period can greatly increate other driver performance during
-  // the WaitForKey is recursivly invoked. 1ms delay will make little impact
+  // the WaitForKey is recursively invoked. 1ms delay will make little impact
   // to the thunk keyboard driver, and user can not feel the delay at all when
   // input.
   //

diff --git a/EmbeddedPkg/EmbeddedPkg.ci.yaml b/EmbeddedPkg/EmbeddedPkg.ci.yaml
@@ -61,7 +61,62 @@
     "SpellCheck": {
         "AuditOnly": True,
         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
-        "ExtendWords": [],           # words to extend to the dictionary for this package
+        "ExtendWords": [
+            "ebadbufsize",
+            "qXfer",
+            "Packetq", #cspell is confused from PacketqXfer
+            "rwatch",
+            "awatch",
+            "e_lfanew",
+            "ralloc",
+            "Intialize", # Is misspelled in a library function 
+            "libfdt",
+            "ncells",
+            "badncells",
+            "phandle",
+            "phandles",
+            "badphandle",
+            "nnode",
+            "namep",
+            "pdepth",
+            "atdepth",
+            "fdtstart",
+            "fdtend",
+            "txrdy",
+            "atmel",
+            "gigadevice",
+            "stmicro",
+            "jedec",
+            "hisilicon",
+            "vtutf",
+            "ioblocks",
+            "blkio",
+            "ismultiblock",
+            "readbllen",
+            "writebllen",
+            "powerup",
+            "emmcbackward",
+            "emmchs",
+            "udriver",
+            "eunknown",
+            "strsz",
+            "ffset",
+            "mpidr",
+            "abootimg", #android boot image
+            "Maxium", # Typo in a library header function
+            "Lenght", # Typo in a library header function
+            "eoi'ed",
+            "isreadonly",
+            "stdby",
+            "tcase",
+            "mgmnt",
+            "bkops",
+            "ddisable",
+            "Lauterbach",
+            "taggs"
+
+
+        ],           # words to extend to the dictionary for this package
         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
     }

diff --git a/EmbeddedPkg/EmbeddedPkg.dec b/EmbeddedPkg/EmbeddedPkg.dec
@@ -150,7 +150,7 @@
   # Android FastBoot
   #
 
-  # The Android FastBoot utility has hard-coded USB Vendor IDs that it recognises
+  # The Android FastBoot utility has hard-coded USB Vendor IDs that it can recognise
   # (and 0xf00d isn't one of them!).
   # You'll need to pass it "-i 0xf00d" to get it to recognise this device.
   gEmbeddedTokenSpaceGuid.PcdAndroidFastbootUsbVendorId|0xf00d|UINT32|0x00000022

diff --git a/EmbeddedPkg/EmbeddedPkg.dsc b/EmbeddedPkg/EmbeddedPkg.dsc
@@ -173,7 +173,7 @@
   gEmbeddedTokenSpaceGuid.PcdPrePiStackSize|0
 
 #
-# Optinal feature to help prevent EFI memory map fragments
+# Optional feature to help prevent EFI memory map fragments
 # Turned on and off via: PcdPrePiProduceMemoryTypeInformationHob
 # Values are in EFI Pages (4K). DXE Core will make sure that
 # at least this much of each type of memory can be allocated

diff --git a/EmbeddedPkg/GdbStub/SerialIo.c b/EmbeddedPkg/GdbStub/SerialIo.c
@@ -457,7 +457,7 @@ GDB_SERIAL_DEV  gdbSerialDevTemplate = {
     0, // ControlMask
     0, // Timeout
     0, // BaudRate
-    1, // RceiveFifoDepth
+    1, // ReceiveFifoDepth
     0, // DataBits
     0, // Parity
     0  // StopBits

diff --git a/EmbeddedPkg/Include/libfdt.h b/EmbeddedPkg/Include/libfdt.h
@@ -735,7 +735,7 @@ fdt_get_property_w (
  * to within the device blob itself, not a copy of the value).  If
  * lenp is non-NULL, the length of the property value is also
  * returned, in the integer pointed to by lenp.  If namep is non-NULL,
- * the property's namne will also be returned in the char * pointed to
+ * the property's name will also be returned in the char * pointed to
  * by namep (this will be a pointer to within the device tree's string
  * block, not a new copy of the name).
  *
@@ -2246,7 +2246,7 @@ fdt_add_subnode_namelen (
  * change the offsets of some existing nodes.
 
  * returns:
- *      structure block offset of the created nodeequested subnode (>=0), on
+ *      structure block offset of the created noderequested subnode (>=0), on
  *              success
  *      -FDT_ERR_NOTFOUND, if the requested subnode does not exist
  *      -FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE
@@ -2311,7 +2311,7 @@ fdt_del_node (
  * returns:
  *      0, on success
  *      -FDT_ERR_NOSPACE, there's not enough space in the base device tree
- *      -FDT_ERR_NOTFOUND, the overlay points to some inexistant nodes or
+ *      -FDT_ERR_NOTFOUND, the overlay points to some non existant nodes or
  *              properties in the base DT
  *      -FDT_ERR_BADPHANDLE,
  *      -FDT_ERR_BADOVERLAY,

diff --git a/EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.c b/EmbeddedPkg/Library/AndroidBootImgLib/AndroidBootImgLib.c
@@ -175,7 +175,7 @@ AndroidBootImgGetImgSize (
   /* The page size is not specified, but it should be power of 2 at least */
   ASSERT (IS_VALID_ANDROID_PAGE_SIZE (Header->PageSize));
 
-  /* Get real size of abootimg */
+  /* Get real size of boot img */
   *ImgSize = ALIGN_VALUE (Header->KernelSize, Header->PageSize) +
              ALIGN_VALUE (Header->RamdiskSize, Header->PageSize) +
              ALIGN_VALUE (Header->SecondStageBootloaderSize, Header->PageSize) +

diff --git a/EmbeddedPkg/Library/VirtualRealTimeClockLib/VirtualRealTimeClockLib.c b/EmbeddedPkg/Library/VirtualRealTimeClockLib/VirtualRealTimeClockLib.c
@@ -2,7 +2,7 @@
  *
  *  Implement virtual EFI RealTimeClock runtime services.
  *
- *  Coypright (c) 2019, Pete Batard <pete@akeo.ie>
+ *  Copyright (c) 2019, Pete Batard <pete@akeo.ie>
  *  Copyright (c) 2018, Andrei Warkentin <andrey.warkentin@gmail.com>
  *  Copyright (c) 2011-2021, ARM Ltd. All rights reserved.
  *  Copyright (c) 2008-2010, Apple Inc. All rights reserved.

diff --git a/EmbeddedPkg/SimpleTextInOutSerial/SimpleTextInOut.c b/EmbeddedPkg/SimpleTextInOutSerial/SimpleTextInOut.c
@@ -554,7 +554,7 @@ OutputString (
             Mode->CursorRow++;
           }
 
-          // CHAR_CARIAGE_RETURN
+          // CHAR_CARRIAGE_RETURN
           Mode->CursorColumn = 0;
         } else {
           Mode->CursorColumn++;

diff --git a/EmbeddedPkg/Universal/MmcDxe/MmcBlockIo.c b/EmbeddedPkg/Universal/MmcDxe/MmcBlockIo.c
@@ -247,7 +247,7 @@ MmcIoBlocks (
   UINTN                  Cmd;
   MMC_HOST_INSTANCE      *MmcHostInstance;
   EFI_MMC_HOST_PROTOCOL  *MmcHost;
-  UINTN                  BytesRemainingToBeTransfered;
+  UINTN                  BytesRemainingToBeTransferred;
   UINTN                  BlockCount;
   UINTN                  ConsumeSize;
   UINT32                 MaxBlock;
@@ -301,10 +301,10 @@ MmcIoBlocks (
   }
 
   // Max block number in single cmd is 65535 blocks.
-  MaxBlock                     = 0xFFFF;
-  RemainingBlock               = BlockCount;
-  BytesRemainingToBeTransfered = BufferSize;
-  while (BytesRemainingToBeTransfered > 0) {
+  MaxBlock                      = 0xFFFF;
+  RemainingBlock                = BlockCount;
+  BytesRemainingToBeTransferred = BufferSize;
+  while (BytesRemainingToBeTransferred > 0) {
     if (RemainingBlock <= MaxBlock) {
       BlockCount = RemainingBlock;
     } else {
@@ -349,18 +349,18 @@ MmcIoBlocks (
     }
 
     ConsumeSize = BlockCount * This->Media->BlockSize;
-    if (BytesRemainingToBeTransfered < ConsumeSize) {
-      ConsumeSize = BytesRemainingToBeTransfered;
+    if (BytesRemainingToBeTransferred < ConsumeSize) {
+      ConsumeSize = BytesRemainingToBeTransferred;
     }
 
     Status = MmcTransferBlock (This, Cmd, Transfer, MediaId, Lba, ConsumeSize, Buffer);
     if (EFI_ERROR (Status)) {
       DEBUG ((DEBUG_ERROR, "%a(): Failed to transfer block and Status:%r\n", __func__, Status));
     }
 
-    RemainingBlock               -= BlockCount;
-    BytesRemainingToBeTransfered -= ConsumeSize;
-    if (BytesRemainingToBeTransfered > 0) {
+    RemainingBlock                -= BlockCount;
+    BytesRemainingToBeTransferred -= ConsumeSize;
+    if (BytesRemainingToBeTransferred > 0) {
       Lba   += BlockCount;
       Buffer = (UINT8 *)Buffer + ConsumeSize;
     }

diff --git a/SecurityPkg/Include/Library/OemTpm2InitLib.h b/SecurityPkg/Include/Library/OemTpm2InitLib.h
@@ -96,7 +96,7 @@ OemTpm2InitDxeEntryPreRegistration (
   NOTE: If this function returns an EFI_ERROR, TPM initialization WILL NOT continue.
         Make sure this is something you actually want to do.
 
-  @param[in]  BootAttemptCount  Number of ReadyToBoot events that have occured.
+  @param[in]  BootAttemptCount  Number of ReadyToBoot events that have occurred.
                                 0 indicates that this is the first ReadyToBoot event and
                                 is where most of any custom initialization should occur.
 

diff --git a/SecurityPkg/Include/Library/PlatformPKProtectionLib.h b/SecurityPkg/Include/Library/PlatformPKProtectionLib.h
@@ -19,7 +19,7 @@
 
   @retval     EFI_SUCCESS             State has been successfully updated.
   @retval     Others                  Error returned from implementation specific
-                                      underying APIs.
+                                      underlying APIs.
 
 **/
 EFI_STATUS

diff --git a/SecurityPkg/Include/Library/Tpm2CommandLib.h b/SecurityPkg/Include/Library/Tpm2CommandLib.h
@@ -1140,7 +1140,7 @@ CopyDigestListToBuffer (
   @param[in,out] DigestList         TPML_DIGEST_VALUES.
 
   @return EFI_STATUS
-  @retval EFI_SUCCESS               Buffer was succesfully copied to Digest List.
+  @retval EFI_SUCCESS               Buffer was successfully copied to Digest List.
   @retval EFI_BAD_BUFFER_SIZE       Bad buffer size passed to function.
   @retval EFI_INVALID_PARAMETER     Invalid parameter passed to function: NULL pointer or
                                     BufferSize bigger than TPML_DIGEST_VALUES
@@ -1221,7 +1221,7 @@ Tpm2PcrReadForActiveBank (
   );
 
 /**
-  MSCHANGE
+  MS_CHANGE
   Check if all hash algorithms supported in HashAlgorithmMask are
   present in the DigestList.
 

diff --git a/SecurityPkg/Library/DxeTcg2PhysicalPresenceLib/DxeTcg2PhysicalPresenceLib.c b/SecurityPkg/Library/DxeTcg2PhysicalPresenceLib/DxeTcg2PhysicalPresenceLib.c
@@ -955,7 +955,7 @@ Tcg2PhysicalPresenceLibProcessRequest (
   EFI_STATUS                  Status;
   UINTN                       DataSize;
   EFI_TCG2_PHYSICAL_PRESENCE  TcgPpData;
-  // EDKII_VARIABLE_LOCK_PROTOCOL      *VariableLockProtocol;  // MSCHANGE
+  // EDKII_VARIABLE_LOCK_PROTOCOL      *VariableLockProtocol;  // MS_CHANGE
   EFI_TCG2_PHYSICAL_PRESENCE_FLAGS  PpiFlags;
 
   // MS_CHANGE_212735

diff --git a/SecurityPkg/Library/DxeTcg2PhysicalPresenceMinimumLib/DxeTcg2PhysicalPresenceMinimumLib.inf b/SecurityPkg/Library/DxeTcg2PhysicalPresenceMinimumLib/DxeTcg2PhysicalPresenceMinimumLib.inf
@@ -9,10 +9,8 @@
 #
 ##
 
-#Override : 00000001 | SecurityPkg/Library/DxeTcg2PhysicalPresenceLib/DxeTcg2PhysicalPresenceLib.inf | 42955a1fa2de3771a2e7c1e51cb0d149 | 2021-01-09T19-05-15
-# This is not a true override, but as this is derived from the full-featured lib, we want to track if any bugs are fixed there to ensure they are fixed here
-# A minimized version of the TCG2 Physical Presence Library that implements only the features that are required by the TCG PPI 1.3 spec,
-# optional features are removed, the only supported function is to Clear the TPM, and is always approved with no UX
+#Override : 00000002 | SecurityPkg/Library/DxeTcg2PhysicalPresenceLib/DxeTcg2PhysicalPresenceLib.inf | 03382807a47736a9a698fda98cf2ba7c | 2022-05-24T09-00-00 |
+# This is not a true override, but spell changes to ensure mu_tiano_plus passes CI is required and changes the hash.
 
 [Defines]
   INF_VERSION                    = 0x00010005

diff --git a/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.c b/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.c
@@ -31,8 +31,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #include <Protocol/FirmwareVolumeBlock.h>
 
 #include <Guid/MeasuredFvHob.h>
-#include <Ppi/FirmwareVolumeInfoMeasurementExcluded.h> // mschange for excludedFvHob support
-#include <Guid/ExcludedFvHob.h>                        // Mschange
+#include <Ppi/FirmwareVolumeInfoMeasurementExcluded.h> // MsChange for excludedFvHob support
+#include <Guid/ExcludedFvHob.h>                        // MsChange
 
 #include <Library/BaseLib.h>
 #include <Library/DebugLib.h>
@@ -63,7 +63,7 @@ UINTN    mTcg2ImageSize;
 //
 EFI_HANDLE         mTcg2CacheMeasuredHandle = NULL;
 MEASURED_HOB_DATA  *mTcg2MeasuredHobData    = NULL;
-EXCLUDED_HOB_DATA  *mExcludedFvHobData      = NULL;                  // mschange
+EXCLUDED_HOB_DATA  *mExcludedFvHobData      = NULL;                  // MsChange
 
 /**
   Reads contents of a PE/COFF image in memory buffer.
@@ -518,7 +518,7 @@ Tcg2MeasurePeImage (
 
   @param  MeasureBootProtocols  Pointer to the located measure boot protocol instances.
 
-  @retval EFI_SUCCESS           Sucessfully locate the measure boot protocol instances (at least one instance).
+  @retval EFI_SUCCESS           Successfully locate the measure boot protocol instances (at least one instance).
   @retval EFI_UNSUPPORTED       Measure boot is not supported.
 **/
 EFI_STATUS
@@ -784,7 +784,7 @@ DxeTpm2MeasureBootHandler (
         }
       }
 
-      // was not found in measured list.  Now check exclude list -- mschange
+      // was not found in measured list.  Now check exclude list -- MsChange
       if ((ApplicationRequired == FALSE) && (mExcludedFvHobData != NULL)) {
         for (Index = 0; Index < mExcludedFvHobData->Num; Index++) {
           if (mExcludedFvHobData->ExcludedFvs[Index].FvBase == FvAddress) {
@@ -796,7 +796,7 @@ DxeTpm2MeasureBootHandler (
             break;
           }
         }
-      }  // -- mschange end
+      }  // -- MsChange end
     }
   }
 
@@ -913,7 +913,7 @@ DxeTpm2MeasureBootLibConstructor (
     mTcg2MeasuredHobData = GET_GUID_HOB_DATA (GuidHob);
   }
 
-  // mschange - Get excluded fv list if present
+  // MsChange - Get excluded fv list if present
   GuidHob = GetFirstGuidHob (&gExcludedFvHobGuid);
 
   if (GuidHob != NULL) {

diff --git a/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.inf b/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.inf
@@ -58,7 +58,7 @@
 
 [Guids]
   gMeasuredFvHobGuid                    ## SOMETIMES_CONSUMES ## HOB
-  gExcludedFvHobGuid                    ## SOMETIMES_CONSUMES ## HOB  # mschange
+  gExcludedFvHobGuid                    ## SOMETIMES_CONSUMES ## HOB  # MsChange
 
 [Protocols]
   gEfiTcg2ProtocolGuid                  ## SOMETIMES_CONSUMES

diff --git a/SecurityPkg/Library/OemTpm2InitLibNull/OemTpm2InitLib.c b/SecurityPkg/Library/OemTpm2InitLibNull/OemTpm2InitLib.c
@@ -53,7 +53,7 @@ OemTpm2InitPeiPreStartup (
 
   IMPLEMENTATION: Read the TPM Enablement NV Index from the TPM itself.
     - If enabled, allow init to continue.
-    - If read fails because NV Index missing or uninitialzed:
+    - If read fails because NV Index missing or uninitialized:
       - If missing, create and initialize.
       - If uninitialized, set to default value (TPM ON)
     - If disabled, discontinue TPM init.
@@ -130,7 +130,7 @@ OemTpm2InitDxeEntryPreRegistration (
   NOTE: If this function returns an EFI_ERROR, TPM initialization WILL NOT continue.
         Make sure this is something you actually want to do.
 
-  @param[in]  BootAttemptCount  Number of ReadyToBoot events that have occured.
+  @param[in]  BootAttemptCount  Number of ReadyToBoot events that have occurred.
                                 0 indicates that this is the first ReadyToBoot event and
                                 is where most of any custom initialization should occur.