From: Antoine Coeur Date: Fri, 7 Feb 2020 01:07:24 +0000 (+0100) Subject: MdeModulePkg/Bus/Ata: Fix various typos X-Git-Tag: edk2-stable202002~134 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=8c39253dff7b0f5722f44cf42bf1e440a38f95bb MdeModulePkg/Bus/Ata: 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-12-philmd@redhat.com> [lersek@redhat.com: replace EFI_D_xxx w/ DEBUG_xxx to shut up PatchCheck] --- diff --git a/MdeModulePkg/Bus/Ata/AhciPei/AhciMode.c b/MdeModulePkg/Bus/Ata/AhciPei/AhciMode.c index 8c491bd138..7636ad27c8 100644 --- a/MdeModulePkg/Bus/Ata/AhciPei/AhciMode.c +++ b/MdeModulePkg/Bus/Ata/AhciPei/AhciMode.c @@ -266,7 +266,7 @@ AhciWaitMemSet ( do { // - // Access sytem memory to see if the value is the tested one. + // Access system memory to see if the value is the tested one. // // The system memory pointed by Address will be updated by the // SATA Host Controller, "volatile" is introduced to prevent @@ -520,7 +520,7 @@ AhciBuildCommand ( } /** - Buid a command FIS. + Build a command FIS. @param[in,out] CmdFis A pointer to the EFI_AHCI_COMMAND_FIS data structure. @@ -801,7 +801,7 @@ AhciPioTransfer ( AhciWriteReg (AhciBar, Offset, Data64.Uint32.Upper32); // - // Single task envrionment, we only use one command table for all port + // Single task environment, we only use one command table for all port // Offset = AHCI_PORT_START + Port * AHCI_PORT_REG_WIDTH + AHCI_PORT_CLB; OldCmdListLo = AhciReadReg (AhciBar, Offset); @@ -1843,7 +1843,7 @@ AhciModeInitialization ( if (EFI_ERROR (Status)) { DEBUG (( DEBUG_ERROR, - "%a: Error occured when waiting for the first D2H register FIS - %r\n", + "%a: Error occurred when waiting for the first D2H register FIS - %r\n", __FUNCTION__, Status )); continue; diff --git a/MdeModulePkg/Bus/Ata/AhciPei/AhciPei.h b/MdeModulePkg/Bus/Ata/AhciPei/AhciPei.h index 9a34dc6e4f..2be78076be 100644 --- a/MdeModulePkg/Bus/Ata/AhciPei/AhciPei.h +++ b/MdeModulePkg/Bus/Ata/AhciPei/AhciPei.h @@ -161,7 +161,7 @@ typedef struct { UINT8 AhciD2HRegisterFis[0x14]; // D2H Register Fis: offset 0x40 UINT8 AhciD2HRegisterFisRsvd[0x04]; UINT64 AhciSetDeviceBitsFis; // Set Device Bits Fix: offset 0x58 - UINT8 AhciUnknownFis[0x40]; // Unkonwn Fis: offset 0x60 + UINT8 AhciUnknownFis[0x40]; // Unknown Fis: offset 0x60 UINT8 AhciUnknownFisRsvd[0x60]; } EFI_AHCI_RECEIVED_FIS; @@ -239,7 +239,7 @@ typedef struct { } EFI_AHCI_COMMAND_PRDT; // -// Command table Data strucute which is pointed to by the entry in the command list +// Command table Data structure which is pointed to by the entry in the command list // typedef struct { EFI_AHCI_COMMAND_FIS CommandFis; // A software constructed FIS. diff --git a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AhciMode.c b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AhciMode.c index 00aa7e686c..7e2fade400 100644 --- a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AhciMode.c +++ b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AhciMode.c @@ -219,7 +219,7 @@ AhciWaitMemSet ( do { // - // Access sytem memory to see if the value is the tested one. + // Access system memory to see if the value is the tested one. // // The system memory pointed by Address will be updated by the // SATA Host Controller, "volatile" is introduced to prevent @@ -581,7 +581,7 @@ AhciBuildCommand ( } /** - Buid a command FIS. + Build a command FIS. @param CmdFis A pointer to the EFI_AHCI_COMMAND_FIS data structure. @param AtaCommandBlock A pointer to the AhciBuildCommandFis data structure. @@ -997,7 +997,7 @@ AhciDmaTransfer ( } // - // Wait for command compelte + // Wait for command complete // FisBaseAddr = (UINTN)AhciRegisters->AhciRFis + Port * sizeof (EFI_AHCI_RECEIVED_FIS); Offset = FisBaseAddr + EFI_AHCI_D2H_FIS_OFFSET; @@ -1903,7 +1903,7 @@ AhciCreateTransferDescriptor ( PortImplementBitMap = AhciReadReg(PciIo, EFI_AHCI_PI_OFFSET); // - // Get the highest bit of implemented ports which decides how many bytes are allocated for recived FIS. + // Get the highest bit of implemented ports which decides how many bytes are allocated for received FIS. // MaxPortNumber = (UINT8)(UINTN)(HighBitSet32(PortImplementBitMap) + 1); if (MaxPortNumber == 0) { @@ -1958,7 +1958,7 @@ AhciCreateTransferDescriptor ( // // Allocate memory for command list - // Note that the implemenation is a single task model which only use a command list for all ports. + // Note that the implementation is a single task model which only use a command list for all ports. // Buffer = NULL; MaxCommandListSize = MaxCommandSlotNumber * sizeof (EFI_AHCI_COMMAND_LIST); @@ -2713,7 +2713,7 @@ AhciModeInitialization ( } else { continue; } - DEBUG ((EFI_D_INFO, "port [%d] port mulitplier [%d] has a [%a]\n", + DEBUG ((DEBUG_INFO, "port [%d] port multitplier [%d] has a [%a]\n", Port, 0, DeviceType == EfiIdeCdrom ? "cdrom" : "harddisk")); // @@ -2761,7 +2761,7 @@ AhciModeInitialization ( TransferMode.ModeNumber = (UINT8) (SupportedModes->PioMode.Mode); // - // Set supported DMA mode on this IDE device. Note that UDMA & MDMA cann't + // Set supported DMA mode on this IDE device. Note that UDMA & MDMA can't // be set together. Only one DMA mode can be set to a device. If setting // DMA mode operation fails, we can continue moving on because we only use // PIO mode at boot time. DMA modes are used by certain kind of OS booting diff --git a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AhciMode.h b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AhciMode.h index 66d5da0b71..786413930a 100644 --- a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AhciMode.h +++ b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AhciMode.h @@ -263,7 +263,7 @@ typedef struct { } EFI_AHCI_COMMAND_PRDT; // -// Command table data strucute which is pointed to by the entry in the command list +// Command table data structure which is pointed to by the entry in the command list // typedef struct { EFI_AHCI_COMMAND_FIS CommandFis; // A software constructed FIS. @@ -283,7 +283,7 @@ typedef struct { UINT8 AhciD2HRegisterFis[0x14]; // D2H Register Fis: offset 0x40 UINT8 AhciD2HRegisterFisRsvd[0x04]; UINT64 AhciSetDeviceBitsFis; // Set Device Bits Fix: offset 0x58 - UINT8 AhciUnknownFis[0x40]; // Unkonwn Fis: offset 0x60 + UINT8 AhciUnknownFis[0x40]; // Unknown Fis: offset 0x60 UINT8 AhciUnknownFisRsvd[0x60]; } EFI_AHCI_RECEIVED_FIS; diff --git a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.c b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.c index e5b8f40d03..86fe9d954f 100644 --- a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.c +++ b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.c @@ -1,5 +1,5 @@ /** @file - This file implements ATA_PASSTHRU_PROCTOCOL and EXT_SCSI_PASSTHRU_PROTOCOL interfaces + This file implements ATA_PASSTHRU_PROTOCOL and EXT_SCSI_PASSTHRU_PROTOCOL interfaces for managed ATA controllers. Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
@@ -404,7 +404,7 @@ AsyncNonBlockingTransferRoutine ( Instance = (ATA_ATAPI_PASS_THRU_INSTANCE *) Context; EntryHeader = &Instance->NonBlockingTaskList; // - // Get the Taks from the Taks List and execute it, until there is + // Get the Tasks from the Tasks List and execute it, until there is // no task in the list or the device is busy with task (EFI_NOT_READY). // while (TRUE) { @@ -538,7 +538,7 @@ AtaAtapiPassThruSupported ( EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeControllerInit; // - // SATA Controller is a device driver, and should ingore the + // SATA Controller is a device driver, and should ignore the // "RemainingDevicePath" according to UEFI spec // Status = gBS->OpenProtocol ( @@ -659,7 +659,7 @@ AtaAtapiPassThruSupported ( @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/Ata/AtaAtapiPassThru/AtaAtapiPassThru.h b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.h index de9e1ee98f..5f582b9b3e 100644 --- a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.h +++ b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/AtaAtapiPassThru.h @@ -384,7 +384,7 @@ AtaAtapiPassThruSupported ( @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 @@ -521,7 +521,7 @@ EnumerateAttachedDevice ( ); /** - Call back funtion when the timer event is signaled. + Call back function when the timer event is signaled. @param[in] Event The Event this notify function registered to. @param[in] Context Pointer to the context data registered to the diff --git a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/IdeMode.c b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/IdeMode.c index ac055f0042..d284cc600b 100644 --- a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/IdeMode.c +++ b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/IdeMode.c @@ -46,7 +46,7 @@ IdeReadPortB ( write a 1-byte data to a specific IDE port. @param PciIo A pointer to EFI_PCI_IO_PROTOCOL data structure - @param Port The IDE port to be writen + @param Port The IDE port to be written @param Data The data to write to the port **/ VOID @@ -76,7 +76,7 @@ IdeWritePortB ( write a 1-word data to a specific IDE port. @param PciIo A pointer to EFI_PCI_IO_PROTOCOL data structure - @param Port The IDE port to be writen + @param Port The IDE port to be written @param Data The data to write to the port **/ VOID @@ -106,7 +106,7 @@ IdeWritePortW ( write a 2-word data to a specific IDE port. @param PciIo A pointer to EFI_PCI_IO_PROTOCOL data structure - @param Port The IDE port to be writen + @param Port The IDE port to be written @param Data The data to write to the port **/ VOID @@ -718,12 +718,12 @@ WaitForBSYClear ( Table 2. BARs for Register Mapping @param[in] PciIo Pointer to the EFI_PCI_IO_PROTOCOL instance - @param[in, out] IdeRegisters Pointer to EFI_IDE_REGISTERS which is used to + @param[in, out] IdeRegisters Pointer to EFI_IDE_REGISTERS which is used to store the IDE i/o port registers' base addresses @retval EFI_UNSUPPORTED Return this value when the BARs is not IO type @retval EFI_SUCCESS Get the Base address successfully - @retval Other Read the pci configureation data error + @retval Other Read the pci configuration data error **/ EFI_STATUS @@ -983,7 +983,7 @@ AtaPioDataInOut ( Increment = 256; // - // used to record bytes of currently transfered data + // used to record bytes of currently transferred data // WordCount = 0; @@ -1688,7 +1688,7 @@ AtaPacketReadWrite ( RequiredWordCount = *ByteCount >> 1; // - // No data transfer is premitted. + // No data transfer is permitted. // if (RequiredWordCount == 0) { return EFI_SUCCESS; @@ -2509,7 +2509,7 @@ DetectAndConfigIdeDevice ( } // - // Set supported DMA mode on this IDE device. Note that UDMA & MDMA cann't + // Set supported DMA mode on this IDE device. Note that UDMA & MDMA can't // be set together. Only one DMA mode can be set to a device. If setting // DMA mode operation fails, we can continue moving on because we only use // PIO mode at boot time. DMA modes are used by certain kind of OS booting diff --git a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/IdeMode.h b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/IdeMode.h index 39273c5b02..c39ebd0667 100644 --- a/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/IdeMode.h +++ b/MdeModulePkg/Bus/Ata/AtaAtapiPassThru/IdeMode.h @@ -158,7 +158,7 @@ typedef struct { @retval EFI_UNSUPPORTED Return this value when the BARs is not IO type @retval EFI_SUCCESS Get the Base address successfully - @retval Other Read the pci configureation data error + @retval Other Read the pci configuration data error **/ EFI_STATUS diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c index f93afab3bb..28f8638c52 100644 --- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c +++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.c @@ -703,7 +703,7 @@ AtaBusDriverBindingSupported ( @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 @@ -1007,7 +1007,7 @@ AtaBlockIoReset ( @retval EFI_WRITE_PROTECTED The device can not be read/written to. @retval EFI_DEVICE_ERROR The device reported an error while performing the read/write. @retval EFI_NO_MEDIA There is no media in the device. - @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device. + @retval EFI_MEDIA_CHANGED The MediaId does not match the current device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_INVALID_PARAMETER The read/write request contains LBAs that are not valid, or the buffer is not on proper alignment. @@ -1101,7 +1101,7 @@ BlockIoReadWrite ( @retval EFI_SUCCESS The data was read correctly from the device. @retval EFI_DEVICE_ERROR The device reported an error while performing the read. @retval EFI_NO_MEDIA There is no media in the device. - @retval EFI_MEDIA_CHANGED The MediaId does not matched the current device. + @retval EFI_MEDIA_CHANGED The MediaId does not match the current device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, or the buffer is not on proper alignment. @@ -1135,7 +1135,7 @@ AtaBlockIoReadBlocks ( @retval EFI_WRITE_PROTECTED The device can not be written to. @retval EFI_DEVICE_ERROR The device reported an error while performing the write. @retval EFI_NO_MEDIA There is no media in the device. - @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device. + @retval EFI_MEDIA_CHANGED The MediaId does not match the current device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, or the buffer is not on proper alignment. @@ -1272,7 +1272,7 @@ AtaBlockIoReadBlocksEx ( @retval EFI_WRITE_PROTECTED The device can not be written to. @retval EFI_DEVICE_ERROR The device reported an error while performing the write. @retval EFI_NO_MEDIA There is no media in the device. - @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device. + @retval EFI_MEDIA_CHANGED The MediaId does not match the current device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, or the buffer is not on proper alignment. diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h index 54c0f3d30f..a5a8652099 100644 --- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h +++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBus.h @@ -408,7 +408,7 @@ AtaBusDriverBindingSupported ( @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 @@ -614,7 +614,7 @@ AtaBlockIoReset ( @retval EFI_SUCCESS The data was read correctly from the device. @retval EFI_DEVICE_ERROR The device reported an error while performing the read. @retval EFI_NO_MEDIA There is no media in the device. - @retval EFI_MEDIA_CHANGED The MediaId does not matched the current device. + @retval EFI_MEDIA_CHANGED The MediaId does not match the current device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, or the buffer is not on proper alignment. @@ -645,7 +645,7 @@ AtaBlockIoReadBlocks ( @retval EFI_WRITE_PROTECTED The device can not be written to. @retval EFI_DEVICE_ERROR The device reported an error while performing the write. @retval EFI_NO_MEDIA There is no media in the device. - @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device. + @retval EFI_MEDIA_CHANGED The MediaId does not match the current device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, or the buffer is not on proper alignment. @@ -679,7 +679,7 @@ AtaBlockIoFlushBlocks ( ); /** - Reset the Block Device throught Block I/O2 protocol. + Reset the Block Device through Block I/O2 protocol. @param[in] This Indicates a pointer to the calling context. @param[in] ExtendedVerification Driver may perform diagnostics on reset. @@ -749,7 +749,7 @@ AtaBlockIoReadBlocksEx ( @retval EFI_WRITE_PROTECTED The device can not be written to. @retval EFI_DEVICE_ERROR The device reported an error while performing the write. @retval EFI_NO_MEDIA There is no media in the device. - @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device. + @retval EFI_MEDIA_CHANGED The MediaId does not match the current device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, or the buffer is not on proper alignment. @@ -1061,7 +1061,7 @@ AtaStorageSecuritySendData ( Typically, there are 2 mechanism for resetting eDrive. They are: 1. TPer Reset through IEEE 1667 protocol. 2. TPer Reset through native TCG protocol. - This routine will detect what protocol the attached eDrive comform to, TCG or + This routine will detect what protocol the attached eDrive conform to, TCG or IEEE 1667 protocol. Then send out TPer Reset command separately. @param[in] AtaDevice ATA_DEVICE pointer. diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBusDxe.inf b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBusDxe.inf index c3ab5c18f1..086ec5f7c6 100644 --- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBusDxe.inf +++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBusDxe.inf @@ -1,5 +1,5 @@ ## @file -# ATA Bus driver to enumerate and identfy ATA devices. +# ATA Bus driver to enumerate and identify ATA devices. # # This driver follows UEFI driver model and layers on ATA Pass Thru protocol defined # in UEFI spec 2.2. It installs Block IO and Disk Info protocol for each ATA device diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBusDxe.uni b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBusDxe.uni index 00bebce11c..ec4aab24d5 100644 --- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBusDxe.uni +++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaBusDxe.uni @@ -1,5 +1,5 @@ // /** @file -// ATA Bus driver to enumerate and identfy ATA devices. +// ATA Bus driver to enumerate and identify ATA devices. // // This driver follows UEFI driver model and layers on ATA Pass Thru protocol defined // in UEFI spec 2.2. It installs Block IO and Disk Info protocol for each ATA device diff --git a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaPassThruExecute.c b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaPassThruExecute.c index fd483cb9a4..79026a4a95 100644 --- a/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaPassThruExecute.c +++ b/MdeModulePkg/Bus/Ata/AtaBusDxe/AtaPassThruExecute.c @@ -536,7 +536,7 @@ TransferAtaDevice ( // // As AtaBus is used to manage ATA devices, we have to use the lowest transfer rate to // calculate the possible maximum timeout value for each read/write operation. - // The timout value is rounded up to nearest integar and here an additional 30s is added + // The timeout value is rounded up to nearest integer and here an additional 30s is added // to follow ATA spec in which it mentioned that the device may take up to 30s to respond // commands in the Standby/Idle mode. // @@ -634,7 +634,7 @@ AtaTerminateNonBlockingTask ( } /** - Call back funtion when the event is signaled. + Call back function when the event is signaled. @param[in] Event The Event this notify function registered to. @param[in] Context Pointer to the context data registered to the