]> git.proxmox.com Git - mirror_edk2.git/commitdiff
OvmfPkg/Xen: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:08:13 +0000 (02:08 +0100)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Mon, 10 Feb 2020 22:30:07 +0000 (22:30 +0000)
Fix various typos in comments and documentation.

Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Anthony Perard <anthony.perard@citrix.com>
Cc: Julien Grall <julien@xen.org>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Acked-by: Anthony PERARD <anthony.perard@citrix.com>
Acked-by: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-61-philmd@redhat.com>

18 files changed:
OvmfPkg/Include/IndustryStandard/Xen/arch-arm/xen.h
OvmfPkg/Include/IndustryStandard/Xen/grant_table.h
OvmfPkg/Include/IndustryStandard/Xen/io/blkif.h
OvmfPkg/Include/Protocol/XenBus.h
OvmfPkg/Include/Protocol/XenIo.h
OvmfPkg/Library/PciHostBridgeLib/XenSupport.c
OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c
OvmfPkg/XenBusDxe/DriverBinding.h
OvmfPkg/XenBusDxe/EventChannel.h
OvmfPkg/XenBusDxe/GrantTable.h
OvmfPkg/XenBusDxe/XenBus.c
OvmfPkg/XenBusDxe/XenBusDxe.c
OvmfPkg/XenBusDxe/XenStore.c
OvmfPkg/XenPvBlkDxe/BlockFront.c
OvmfPkg/XenPvBlkDxe/BlockIo.c
OvmfPkg/XenPvBlkDxe/BlockIo.h
OvmfPkg/XenPvBlkDxe/DriverBinding.h
OvmfPkg/XenPvBlkDxe/XenPvBlkDxe.c

index a394f8d85a5d9cf9a71f11b38f70fec11bfe0bf7..36338d063a9da4000651a27c572b99b10e37acf2 100644 (file)
@@ -96,7 +96,7 @@
  *   All generic sub-operations\r
  *\r
  *  HYPERVISOR_physdev_op\r
- *   No sub-operations are currenty supported\r
+ *   No sub-operations are currently supported\r
  *\r
  *  HYPERVISOR_sysctl\r
  *   All generic sub-operations, with the exception of:\r
index da8d6c2705f090dc580daf933a094441f49524a7..54af1dbc383c5addc05d7399807f9fc965326287 100644 (file)
@@ -365,7 +365,7 @@ DEFINE_XEN_GUEST_HANDLE(gnttab_unmap_grant_ref_t);
  /*\r
   * GNTMAP_contains_pte subflag:\r
   *  0 => This map request contains a host virtual address.\r
-  *  1 => This map request contains the machine addess of the PTE to update.\r
+  *  1 => This map request contains the machine address of the PTE to update.\r
   */\r
 #define _GNTMAP_contains_pte    (4)\r
 #define GNTMAP_contains_pte     (1<<_GNTMAP_contains_pte)\r
@@ -386,7 +386,7 @@ DEFINE_XEN_GUEST_HANDLE(gnttab_unmap_grant_ref_t);
 /* ` enum grant_status { */\r
 #define GNTST_okay             (0)  /* Normal return.                        */\r
 #define GNTST_general_error    (-1) /* General undefined error.              */\r
-#define GNTST_bad_domain       (-2) /* Unrecognsed domain id.                */\r
+#define GNTST_bad_domain       (-2) /* Unrecognised domain id.               */\r
 #define GNTST_bad_gntref       (-3) /* Unrecognised or inappropriate gntref. */\r
 #define GNTST_bad_handle       (-4) /* Unrecognised or inappropriate handle. */\r
 #define GNTST_bad_virt_addr    (-5) /* Inappropriate virtual address to map. */\r
index ff8e77589f92b23abffca50ef284772a08d05c85..5939610a9616d9ea01bc0f3ac174a6c291ae0c16 100644 (file)
  *      access (even when it should be read-only). If the frontend hits the\r
  *      maximum number of allowed persistently mapped grants, it can fallback\r
  *      to non persistent mode. This will cause a performance degradation,\r
- *      since the the backend driver will still try to map those grants\r
+ *      since the backend driver will still try to map those grants\r
  *      persistently. Since the persistent grants protocol is compatible with\r
  *      the previous protocol, a frontend driver can choose to work in\r
  *      persistent mode even when the backend doesn't support it.\r
index 8ff5ca35750026f4f63c3e2b124e33700bd50800..0dac9266280f8bb74046be3f89a7db2984995b8e 100644 (file)
@@ -215,7 +215,7 @@ XENSTORE_STATUS
   Grant access to the page Frame to the domain DomainId.\r
 \r
   @param This       A pointer to XENBUS_PROTOCOL instance.\r
-  @param DomainId   ID of the domain to grant acces to.\r
+  @param DomainId   ID of the domain to grant access to.\r
   @param Frame      Frame Number of the page to grant access to.\r
   @param ReadOnly   Provide read-only or read-write access.\r
   @param RefPtr     Reference number of the grant will be written to this pointer.\r
@@ -266,7 +266,7 @@ UINT32
   Send an event to the remote end of the channel whose local endpoint is Port.\r
 \r
   @param This       A pointer to the XENBUS_PROTOCOL.\r
-  @param Port       Local port to the the event from.\r
+  @param Port       Local port to the event from.\r
 \r
   @retval UINT32    The return value from the hypercall, 0 if success.\r
 **/\r
index 6bea0a02bb3ef844b7a8b43f716fc785fd51abcc..f4051ca507296626b77fc833e7555ea28d70b193 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   XenIo protocol to abstract arch specific details\r
 \r
-  The Xen implementations for the Intel and ARM archictures differ in the way\r
+  The Xen implementations for the Intel and ARM architectures differ in the way\r
   the base address of the grant table is communicated to the guest. The former\r
   uses a virtual PCI device, while the latter uses a device tree node.\r
   In order to allow the XenBusDxe UEFI driver to be reused for the non-PCI\r
index b41bd6b3002bb54105ca93b10f60038fd75af518..e161f14375ca54fd22622bcb96457e41178df5d4 100644 (file)
@@ -280,7 +280,7 @@ ScanForRootBridges (
           //\r
           if (Pci.Bridge.SubordinateBus > SubBus) {\r
             //\r
-            // If the suborinate bus number of the PCI-PCI bridge is greater\r
+            // If the subordinate bus number of the PCI-PCI bridge is greater\r
             // than the PCI root bridge's current subordinate bus number,\r
             // then update the PCI root bridge's subordinate bus number\r
             //\r
@@ -419,7 +419,7 @@ ScanForRootBridges (
 \r
         //\r
         // See if the PCI Device is a PCI - ISA or PCI - EISA\r
-        // or ISA_POSITIVIE_DECODE Bridge device\r
+        // or ISA_POSITIVE_DECODE Bridge device\r
         //\r
         if (Pci.Hdr.ClassCode[2] == PCI_CLASS_BRIDGE) {\r
           if (Pci.Hdr.ClassCode[1] == PCI_CLASS_BRIDGE_ISA ||\r
index eef9302dd5c250766625b791a75ad4e4d175109f..895dfc02f90a4b64802b29e72be5fe7405518525 100644 (file)
@@ -247,13 +247,13 @@ SerialPortGetControl (
 }\r
 \r
 /**\r
-  Sets the baud rate, receive FIFO depth, transmit/receice time out, parity,\r
+  Sets the baud rate, receive FIFO depth, transmit/receive time out, parity,\r
   data bits, and stop bits on a serial device.\r
 \r
   @param BaudRate           The requested baud rate. A BaudRate value of 0 will use the\r
                             device's default interface speed.\r
                             On output, the value actually set.\r
-  @param ReveiveFifoDepth   The requested depth of the FIFO on the receive side of the\r
+  @param ReceiveFifoDepth   The requested depth of the FIFO on the receive side of the\r
                             serial interface. A ReceiveFifoDepth value of 0 will use\r
                             the device's default FIFO depth.\r
                             On output, the value actually set.\r
@@ -266,7 +266,7 @@ SerialPortGetControl (
                             DefaultParity will use the device's default parity value.\r
                             On output, the value actually set.\r
   @param DataBits           The number of data bits to use on the serial device. A DataBits\r
-                            vaule of 0 will use the device's default data bit setting.\r
+                            value of 0 will use the device's default data bit setting.\r
                             On output, the value actually set.\r
   @param StopBits           The number of stop bits to use on this serial device. A StopBits\r
                             value of DefaultStopBits will use the device's default number of\r
index 9b0eb20644613f1b1b5ce8a43ace834da38eb9f9..43ee8aff02ae1c965f4b633c9bb904b41efbdab6 100644 (file)
@@ -75,7 +75,7 @@ XenBusDxeDriverBindingSupported (
   @retval EFI_SUCCESS              The device was started.\r
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
-  @retval Others                   The driver failded to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
index 6e98bbe46367b89141a45760063517907f0b937e..793571fab6d130c2c9ddcc97009277bb08cf8af4 100644 (file)
@@ -53,7 +53,7 @@ XenBusEventChannelAllocate (
   Send an event to the remote end of the channel whose local endpoint is Port.\r
 \r
   @param This       A pointer to the XENBUS_PROTOCOL.\r
-  @param Port       Local port to the the event from.\r
+  @param Port       Local port to the event from.\r
 \r
   @retval UINT32    The return value from the hypercall, 0 if success.\r
 **/\r
index 2cc889b6433f6f537c66887e6e9d819da01ad62e..0c1e076337e6879b09740788df13fdb3074abf15 100644 (file)
@@ -38,7 +38,7 @@ XenGrantTableDeinit (
   Grant access to the page Frame to the domain DomainId.\r
 \r
   @param This       A pointer to XENBUS_PROTOCOL instance.\r
-  @param DomainId   ID of the domain to grant acces to.\r
+  @param DomainId   ID of the domain to grant access to.\r
   @param Frame      Frame Number of the page to grant access to.\r
   @param ReadOnly   Provide read-only or read-write access.\r
   @param RefPtr     Reference number of the grant will be written to this pointer.\r
index 2451e58a5961f30436e41cfc050debd40b22bc13..a203beaaa7e74112d8a663f6bc0ada7d980b1c35 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  XenBus Bus driver implemtation.\r
+  XenBus Bus driver implementation.\r
 \r
   This file implement the necessary to discover and enumerate Xen PV devices\r
   through XenStore.\r
index 634c7b71eb551b889add898bdefa4aa22c9039d2..c47fad2e80bb922985bdf529157ddfd2251cfb17 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   This driver produces XenBus Protocol instances for each Xen PV devices.\r
 \r
-  This XenBus bus driver will first initialize differente services in order to\r
+  This XenBus bus driver will first initialize different services in order to\r
   enumerate the ParaVirtualized devices available.\r
 \r
   Those services are:\r
@@ -297,8 +297,8 @@ NotifyExitBoot (
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
   @retval EFI_UNSUPPORTED          Something is missing on the system that\r
-                                   prevent to start the edvice.\r
-  @retval Others                   The driver failded to start the device.\r
+                                   prevent to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
index 34890ae40bb2d48f5fc0eaee497a4c20861e34ba..41fcb390888c9f9282a49d119629b23cd6d98167 100644 (file)
@@ -138,7 +138,7 @@ typedef struct {
    */\r
   LIST_ENTRY WatchEvents;\r
 \r
-  /** Lock protecting the watch calback list. */\r
+  /** Lock protecting the watch callback list. */\r
   EFI_LOCK WatchEventsLock;\r
 \r
   /**\r
@@ -761,7 +761,7 @@ XenStoreReadReply (
 }\r
 \r
 /**\r
-  Send a message with an optionally muti-part body to the XenStore service.\r
+  Send a message with an optionally multi-part body to the XenStore service.\r
 \r
   @param Transaction    The transaction to use for this request.\r
   @param RequestType    The type of message to send.\r
index 8dca4c82f08a98888a9d6fb4ee78069b1ca22455..f57f8573156843260d86cbe8b0f34df88d44c545 100644 (file)
@@ -27,7 +27,7 @@
   @param FromBackend  Read frontend or backend value.\r
   @param ValuePtr     Where to put the value.\r
 \r
-  @retval XENSTORE_STATUS_SUCCESS  If succefull, will update ValuePtr.\r
+  @retval XENSTORE_STATUS_SUCCESS  If successful, will update ValuePtr.\r
   @return                          Any other return value indicate the error,\r
                                    ValuePtr is not updated in this case.\r
 **/\r
index 52cf6fc11708b8489e048cadb03af12cee0064e0..b3a527e4e3037dbb0ae75b747955ddac8af566fc 100644 (file)
@@ -52,7 +52,7 @@ EFI_BLOCK_IO_PROTOCOL  gXenPvBlkDxeBlockIo = {
 /**\r
   Read/Write BufferSize bytes from Lba into Buffer.\r
 \r
-  This function is commun to XenPvBlkDxeBlockIoReadBlocks and\r
+  This function is common to XenPvBlkDxeBlockIoReadBlocks and\r
   XenPvBlkDxeBlockIoWriteBlocks.\r
 \r
   @param  This       Indicates a pointer to the calling context.\r
@@ -172,7 +172,7 @@ XenPvBlkDxeBlockIoReadWriteBlocks (
   @retval EFI_SUCCESS           The data was read correctly from the device.\r
   @retval EFI_DEVICE_ERROR      The device reported an error while performing the read.\r
   @retval EFI_NO_MEDIA          There is no media in the device.\r
-  @retval EFI_MEDIA_CHANGED     The MediaId does not matched the current device.\r
+  @retval EFI_MEDIA_CHANGED     The MediaId does not match the current device.\r
   @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.\r
   @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
                                 or the buffer is not on proper alignment.\r
@@ -206,7 +206,7 @@ XenPvBlkDxeBlockIoReadBlocks (
   @retval EFI_WRITE_PROTECTED   The device can not be written to.\r
   @retval EFI_DEVICE_ERROR      The device reported an error while performing the write.\r
   @retval EFI_NO_MEDIA          There is no media in the device.\r
-  @retval EFI_MEDIA_CHNAGED     The MediaId does not matched the current device.\r
+  @retval EFI_MEDIA_CHANGED     The MediaId does not match the current device.\r
   @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.\r
   @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,\r
                                 or the buffer is not on proper alignment.\r
@@ -232,7 +232,7 @@ XenPvBlkDxeBlockIoWriteBlocks (
   @param  This              Indicates a pointer to the calling context.\r
 \r
   @retval EFI_SUCCESS       All outstanding data was written to the device\r
-  @retval EFI_DEVICE_ERROR  The device reported an error while writting back the data\r
+  @retval EFI_DEVICE_ERROR  The device reported an error while writing back the data\r
   @retval EFI_NO_MEDIA      There is no media in the device.\r
 \r
 **/\r
index 85278c67c02c15066682fbd68a5228ea99eb10a2..1100791183d2ac04c2db20e6748a1de3a573310f 100644 (file)
@@ -20,7 +20,7 @@
   @retval EFI_SUCCESS           The data was read correctly from the device.\r
   @retval EFI_DEVICE_ERROR      The device reported an error while performing the read.\r
   @retval EFI_NO_MEDIA          There is no media in the device.\r
-  @retval EFI_MEDIA_CHANGED     The MediaId does not matched the current device.\r
+  @retval EFI_MEDIA_CHANGED     The MediaId does not match the current device.\r
   @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.\r
   @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
                                 or the buffer is not on proper alignment.\r
@@ -50,7 +50,7 @@ XenPvBlkDxeBlockIoReadBlocks (
   @retval EFI_WRITE_PROTECTED   The device can not be written to.\r
   @retval EFI_DEVICE_ERROR      The device reported an error while performing the write.\r
   @retval EFI_NO_MEDIA          There is no media in the device.\r
-  @retval EFI_MEDIA_CHNAGED     The MediaId does not matched the current device.\r
+  @retval EFI_MEDIA_CHANGED     The MediaId does not match the current device.\r
   @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.\r
   @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,\r
                                 or the buffer is not on proper alignment.\r
@@ -72,7 +72,7 @@ XenPvBlkDxeBlockIoWriteBlocks (
   @param  This              Indicates a pointer to the calling context.\r
 \r
   @retval EFI_SUCCESS       All outstanding data was written to the device\r
-  @retval EFI_DEVICE_ERROR  The device reported an error while writting back the data\r
+  @retval EFI_DEVICE_ERROR  The device reported an error while writing back the data\r
   @retval EFI_NO_MEDIA      There is no media in the device.\r
 \r
 **/\r
index 9a4eac4b3ebf337426fd8f90c78a70b922996308..fa2983644ce970db043dc326eb335187beba1eb6 100644 (file)
@@ -90,7 +90,7 @@ XenPvBlkDxeDriverBindingSupported (
   @retval EFI_SUCCESS              The device was started.\r
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
-  @retval Others                   The driver failded to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r
index bfe7b1a754cf208031f8f651350fe6e1d6ecc61d..779a7f630c03043ec7bb0899edcdfbab8752b14f 100644 (file)
@@ -241,7 +241,7 @@ XenPvBlkDxeDriverBindingSupported (
   @retval EFI_SUCCESS              The device was started.\r
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
-  @retval Others                   The driver failded to start the device.\r
+  @retval Others                   The driver failed to start the device.\r
 \r
 **/\r
 EFI_STATUS\r