From 493dde944d77e768d3d792405638a27acf30f261 Mon Sep 17 00:00:00 2001 From: Antoine Coeur Date: Fri, 7 Feb 2020 02:08:13 +0100 Subject: OvmfPkg/Xen: Fix various typos Fix various typos in comments and documentation. Cc: Jordan Justen Cc: Laszlo Ersek Cc: Ard Biesheuvel Cc: Anthony Perard Cc: Julien Grall Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Acked-by: Anthony PERARD Acked-by: Laszlo Ersek Signed-off-by: Philippe Mathieu-Daude Message-Id: <20200207010831.9046-61-philmd@redhat.com> --- OvmfPkg/Include/IndustryStandard/Xen/arch-arm/xen.h | 2 +- OvmfPkg/Include/IndustryStandard/Xen/grant_table.h | 4 ++-- OvmfPkg/Include/IndustryStandard/Xen/io/blkif.h | 2 +- OvmfPkg/Include/Protocol/XenBus.h | 4 ++-- OvmfPkg/Include/Protocol/XenIo.h | 2 +- OvmfPkg/Library/PciHostBridgeLib/XenSupport.c | 4 ++-- OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c | 6 +++--- OvmfPkg/XenBusDxe/DriverBinding.h | 2 +- OvmfPkg/XenBusDxe/EventChannel.h | 2 +- OvmfPkg/XenBusDxe/GrantTable.h | 2 +- OvmfPkg/XenBusDxe/XenBus.c | 2 +- OvmfPkg/XenBusDxe/XenBusDxe.c | 6 +++--- OvmfPkg/XenBusDxe/XenStore.c | 4 ++-- OvmfPkg/XenPvBlkDxe/BlockFront.c | 2 +- OvmfPkg/XenPvBlkDxe/BlockIo.c | 8 ++++---- OvmfPkg/XenPvBlkDxe/BlockIo.h | 6 +++--- OvmfPkg/XenPvBlkDxe/DriverBinding.h | 2 +- OvmfPkg/XenPvBlkDxe/XenPvBlkDxe.c | 2 +- 18 files changed, 31 insertions(+), 31 deletions(-) diff --git a/OvmfPkg/Include/IndustryStandard/Xen/arch-arm/xen.h b/OvmfPkg/Include/IndustryStandard/Xen/arch-arm/xen.h index a394f8d..36338d0 100644 --- a/OvmfPkg/Include/IndustryStandard/Xen/arch-arm/xen.h +++ b/OvmfPkg/Include/IndustryStandard/Xen/arch-arm/xen.h @@ -96,7 +96,7 @@ * All generic sub-operations * * HYPERVISOR_physdev_op - * No sub-operations are currenty supported + * No sub-operations are currently supported * * HYPERVISOR_sysctl * All generic sub-operations, with the exception of: diff --git a/OvmfPkg/Include/IndustryStandard/Xen/grant_table.h b/OvmfPkg/Include/IndustryStandard/Xen/grant_table.h index da8d6c2..54af1db 100644 --- a/OvmfPkg/Include/IndustryStandard/Xen/grant_table.h +++ b/OvmfPkg/Include/IndustryStandard/Xen/grant_table.h @@ -365,7 +365,7 @@ DEFINE_XEN_GUEST_HANDLE(gnttab_unmap_grant_ref_t); /* * GNTMAP_contains_pte subflag: * 0 => This map request contains a host virtual address. - * 1 => This map request contains the machine addess of the PTE to update. + * 1 => This map request contains the machine address of the PTE to update. */ #define _GNTMAP_contains_pte (4) #define GNTMAP_contains_pte (1<<_GNTMAP_contains_pte) @@ -386,7 +386,7 @@ DEFINE_XEN_GUEST_HANDLE(gnttab_unmap_grant_ref_t); /* ` enum grant_status { */ #define GNTST_okay (0) /* Normal return. */ #define GNTST_general_error (-1) /* General undefined error. */ -#define GNTST_bad_domain (-2) /* Unrecognsed domain id. */ +#define GNTST_bad_domain (-2) /* Unrecognised domain id. */ #define GNTST_bad_gntref (-3) /* Unrecognised or inappropriate gntref. */ #define GNTST_bad_handle (-4) /* Unrecognised or inappropriate handle. */ #define GNTST_bad_virt_addr (-5) /* Inappropriate virtual address to map. */ diff --git a/OvmfPkg/Include/IndustryStandard/Xen/io/blkif.h b/OvmfPkg/Include/IndustryStandard/Xen/io/blkif.h index ff8e775..5939610 100644 --- a/OvmfPkg/Include/IndustryStandard/Xen/io/blkif.h +++ b/OvmfPkg/Include/IndustryStandard/Xen/io/blkif.h @@ -270,7 +270,7 @@ * access (even when it should be read-only). If the frontend hits the * maximum number of allowed persistently mapped grants, it can fallback * to non persistent mode. This will cause a performance degradation, - * since the the backend driver will still try to map those grants + * since the backend driver will still try to map those grants * persistently. Since the persistent grants protocol is compatible with * the previous protocol, a frontend driver can choose to work in * persistent mode even when the backend doesn't support it. diff --git a/OvmfPkg/Include/Protocol/XenBus.h b/OvmfPkg/Include/Protocol/XenBus.h index 8ff5ca3..0dac926 100644 --- a/OvmfPkg/Include/Protocol/XenBus.h +++ b/OvmfPkg/Include/Protocol/XenBus.h @@ -215,7 +215,7 @@ XENSTORE_STATUS Grant access to the page Frame to the domain DomainId. @param This A pointer to XENBUS_PROTOCOL instance. - @param DomainId ID of the domain to grant acces to. + @param DomainId ID of the domain to grant access to. @param Frame Frame Number of the page to grant access to. @param ReadOnly Provide read-only or read-write access. @param RefPtr Reference number of the grant will be written to this pointer. @@ -266,7 +266,7 @@ UINT32 Send an event to the remote end of the channel whose local endpoint is Port. @param This A pointer to the XENBUS_PROTOCOL. - @param Port Local port to the the event from. + @param Port Local port to the event from. @retval UINT32 The return value from the hypercall, 0 if success. **/ diff --git a/OvmfPkg/Include/Protocol/XenIo.h b/OvmfPkg/Include/Protocol/XenIo.h index 6bea0a0..f4051ca 100644 --- a/OvmfPkg/Include/Protocol/XenIo.h +++ b/OvmfPkg/Include/Protocol/XenIo.h @@ -1,7 +1,7 @@ /** @file XenIo protocol to abstract arch specific details - The Xen implementations for the Intel and ARM archictures differ in the way + The Xen implementations for the Intel and ARM architectures differ in the way the base address of the grant table is communicated to the guest. The former uses a virtual PCI device, while the latter uses a device tree node. In order to allow the XenBusDxe UEFI driver to be reused for the non-PCI diff --git a/OvmfPkg/Library/PciHostBridgeLib/XenSupport.c b/OvmfPkg/Library/PciHostBridgeLib/XenSupport.c index b41bd6b..e161f14 100644 --- a/OvmfPkg/Library/PciHostBridgeLib/XenSupport.c +++ b/OvmfPkg/Library/PciHostBridgeLib/XenSupport.c @@ -280,7 +280,7 @@ ScanForRootBridges ( // if (Pci.Bridge.SubordinateBus > SubBus) { // - // If the suborinate bus number of the PCI-PCI bridge is greater + // If the subordinate bus number of the PCI-PCI bridge is greater // than the PCI root bridge's current subordinate bus number, // then update the PCI root bridge's subordinate bus number // @@ -419,7 +419,7 @@ ScanForRootBridges ( // // See if the PCI Device is a PCI - ISA or PCI - EISA - // or ISA_POSITIVIE_DECODE Bridge device + // or ISA_POSITIVE_DECODE Bridge device // if (Pci.Hdr.ClassCode[2] == PCI_CLASS_BRIDGE) { if (Pci.Hdr.ClassCode[1] == PCI_CLASS_BRIDGE_ISA || diff --git a/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c b/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c index eef9302..895dfc0 100644 --- a/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c +++ b/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c @@ -247,13 +247,13 @@ SerialPortGetControl ( } /** - Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, + Sets the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits, and stop bits on a serial device. @param BaudRate The requested baud rate. A BaudRate value of 0 will use the device's default interface speed. On output, the value actually set. - @param ReveiveFifoDepth The requested depth of the FIFO on the receive side of the + @param ReceiveFifoDepth The requested depth of the FIFO on the receive side of the serial interface. A ReceiveFifoDepth value of 0 will use the device's default FIFO depth. On output, the value actually set. @@ -266,7 +266,7 @@ SerialPortGetControl ( DefaultParity will use the device's default parity value. On output, the value actually set. @param DataBits The number of data bits to use on the serial device. A DataBits - vaule of 0 will use the device's default data bit setting. + value of 0 will use the device's default data bit setting. On output, the value actually set. @param StopBits The number of stop bits to use on this serial device. A StopBits value of DefaultStopBits will use the device's default number of diff --git a/OvmfPkg/XenBusDxe/DriverBinding.h b/OvmfPkg/XenBusDxe/DriverBinding.h index 9b0eb20..43ee8af 100644 --- a/OvmfPkg/XenBusDxe/DriverBinding.h +++ b/OvmfPkg/XenBusDxe/DriverBinding.h @@ -75,7 +75,7 @@ XenBusDxeDriverBindingSupported ( @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/OvmfPkg/XenBusDxe/EventChannel.h b/OvmfPkg/XenBusDxe/EventChannel.h index 6e98bbe..793571f 100644 --- a/OvmfPkg/XenBusDxe/EventChannel.h +++ b/OvmfPkg/XenBusDxe/EventChannel.h @@ -53,7 +53,7 @@ XenBusEventChannelAllocate ( Send an event to the remote end of the channel whose local endpoint is Port. @param This A pointer to the XENBUS_PROTOCOL. - @param Port Local port to the the event from. + @param Port Local port to the event from. @retval UINT32 The return value from the hypercall, 0 if success. **/ diff --git a/OvmfPkg/XenBusDxe/GrantTable.h b/OvmfPkg/XenBusDxe/GrantTable.h index 2cc889b..0c1e076 100644 --- a/OvmfPkg/XenBusDxe/GrantTable.h +++ b/OvmfPkg/XenBusDxe/GrantTable.h @@ -38,7 +38,7 @@ XenGrantTableDeinit ( Grant access to the page Frame to the domain DomainId. @param This A pointer to XENBUS_PROTOCOL instance. - @param DomainId ID of the domain to grant acces to. + @param DomainId ID of the domain to grant access to. @param Frame Frame Number of the page to grant access to. @param ReadOnly Provide read-only or read-write access. @param RefPtr Reference number of the grant will be written to this pointer. diff --git a/OvmfPkg/XenBusDxe/XenBus.c b/OvmfPkg/XenBusDxe/XenBus.c index 2451e58..a203bea 100644 --- a/OvmfPkg/XenBusDxe/XenBus.c +++ b/OvmfPkg/XenBusDxe/XenBus.c @@ -1,5 +1,5 @@ /** @file - XenBus Bus driver implemtation. + XenBus Bus driver implementation. This file implement the necessary to discover and enumerate Xen PV devices through XenStore. diff --git a/OvmfPkg/XenBusDxe/XenBusDxe.c b/OvmfPkg/XenBusDxe/XenBusDxe.c index 634c7b7..c47fad2 100644 --- a/OvmfPkg/XenBusDxe/XenBusDxe.c +++ b/OvmfPkg/XenBusDxe/XenBusDxe.c @@ -1,7 +1,7 @@ /** @file This driver produces XenBus Protocol instances for each Xen PV devices. - This XenBus bus driver will first initialize differente services in order to + This XenBus bus driver will first initialize different services in order to enumerate the ParaVirtualized devices available. Those services are: @@ -297,8 +297,8 @@ NotifyExitBoot ( @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 EFI_UNSUPPORTED Something is missing on the system that - prevent to start the edvice. - @retval Others The driver failded to start the device. + prevent to start the device. + @retval Others The driver failed to start the device. **/ EFI_STATUS diff --git a/OvmfPkg/XenBusDxe/XenStore.c b/OvmfPkg/XenBusDxe/XenStore.c index 34890ae..41fcb39 100644 --- a/OvmfPkg/XenBusDxe/XenStore.c +++ b/OvmfPkg/XenBusDxe/XenStore.c @@ -138,7 +138,7 @@ typedef struct { */ LIST_ENTRY WatchEvents; - /** Lock protecting the watch calback list. */ + /** Lock protecting the watch callback list. */ EFI_LOCK WatchEventsLock; /** @@ -761,7 +761,7 @@ XenStoreReadReply ( } /** - Send a message with an optionally muti-part body to the XenStore service. + Send a message with an optionally multi-part body to the XenStore service. @param Transaction The transaction to use for this request. @param RequestType The type of message to send. diff --git a/OvmfPkg/XenPvBlkDxe/BlockFront.c b/OvmfPkg/XenPvBlkDxe/BlockFront.c index 8dca4c8..f57f857 100644 --- a/OvmfPkg/XenPvBlkDxe/BlockFront.c +++ b/OvmfPkg/XenPvBlkDxe/BlockFront.c @@ -27,7 +27,7 @@ @param FromBackend Read frontend or backend value. @param ValuePtr Where to put the value. - @retval XENSTORE_STATUS_SUCCESS If succefull, will update ValuePtr. + @retval XENSTORE_STATUS_SUCCESS If successful, will update ValuePtr. @return Any other return value indicate the error, ValuePtr is not updated in this case. **/ diff --git a/OvmfPkg/XenPvBlkDxe/BlockIo.c b/OvmfPkg/XenPvBlkDxe/BlockIo.c index 52cf6fc..b3a527e 100644 --- a/OvmfPkg/XenPvBlkDxe/BlockIo.c +++ b/OvmfPkg/XenPvBlkDxe/BlockIo.c @@ -52,7 +52,7 @@ EFI_BLOCK_IO_PROTOCOL gXenPvBlkDxeBlockIo = { /** Read/Write BufferSize bytes from Lba into Buffer. - This function is commun to XenPvBlkDxeBlockIoReadBlocks and + This function is common to XenPvBlkDxeBlockIoReadBlocks and XenPvBlkDxeBlockIoWriteBlocks. @param This Indicates a pointer to the calling context. @@ -172,7 +172,7 @@ XenPvBlkDxeBlockIoReadWriteBlocks ( @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. @@ -206,7 +206,7 @@ XenPvBlkDxeBlockIoReadBlocks ( @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. @@ -232,7 +232,7 @@ XenPvBlkDxeBlockIoWriteBlocks ( @param This Indicates a pointer to the calling context. @retval EFI_SUCCESS All outstanding data was written to the device - @retval EFI_DEVICE_ERROR The device reported an error while writting back the data + @retval EFI_DEVICE_ERROR The device reported an error while writing back the data @retval EFI_NO_MEDIA There is no media in the device. **/ diff --git a/OvmfPkg/XenPvBlkDxe/BlockIo.h b/OvmfPkg/XenPvBlkDxe/BlockIo.h index 85278c6..1100791 100644 --- a/OvmfPkg/XenPvBlkDxe/BlockIo.h +++ b/OvmfPkg/XenPvBlkDxe/BlockIo.h @@ -20,7 +20,7 @@ @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. @@ -50,7 +50,7 @@ XenPvBlkDxeBlockIoReadBlocks ( @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. @@ -72,7 +72,7 @@ XenPvBlkDxeBlockIoWriteBlocks ( @param This Indicates a pointer to the calling context. @retval EFI_SUCCESS All outstanding data was written to the device - @retval EFI_DEVICE_ERROR The device reported an error while writting back the data + @retval EFI_DEVICE_ERROR The device reported an error while writing back the data @retval EFI_NO_MEDIA There is no media in the device. **/ diff --git a/OvmfPkg/XenPvBlkDxe/DriverBinding.h b/OvmfPkg/XenPvBlkDxe/DriverBinding.h index 9a4eac4..fa29836 100644 --- a/OvmfPkg/XenPvBlkDxe/DriverBinding.h +++ b/OvmfPkg/XenPvBlkDxe/DriverBinding.h @@ -90,7 +90,7 @@ XenPvBlkDxeDriverBindingSupported ( @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/OvmfPkg/XenPvBlkDxe/XenPvBlkDxe.c b/OvmfPkg/XenPvBlkDxe/XenPvBlkDxe.c index bfe7b1a..779a7f6 100644 --- a/OvmfPkg/XenPvBlkDxe/XenPvBlkDxe.c +++ b/OvmfPkg/XenPvBlkDxe/XenPvBlkDxe.c @@ -241,7 +241,7 @@ XenPvBlkDxeDriverBindingSupported ( @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 -- cgit v1.1