OvmfPkg/Virtio: Fix few typos

[mirror_edk2.git] / OvmfPkg / Library / VirtioLib / VirtioLib.c

diff --git a/OvmfPkg/Library/VirtioLib/VirtioLib.c b/OvmfPkg/Library/VirtioLib/VirtioLib.c
index 40ea17dfaf86ad0dc1aed0c2a3dd55bcf64eb992..e09324813c2df8ef83f9e2730d9a6bc1e733e1ed 100644 (file)
--- a/OvmfPkg/Library/VirtioLib/VirtioLib.c
+++ b/OvmfPkg/Library/VirtioLib/VirtioLib.c
@@ -6,13 +6,7 @@
   Portion of Copyright (C) 2013, ARM Ltd.\r
   Copyright (C) 2017, AMD Inc, All rights reserved.<BR>\r
 \r
-  This program and the accompanying materials are licensed and made available\r
-  under the terms and conditions of the BSD License which accompanies this\r
-  distribution. The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
-  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -189,7 +183,6 @@ VirtioPrepare (
   Indices->NextDescIdx = Indices->HeadDescIdx;\r
 }\r
 \r
-\r
 /**\r
 \r
   Append a contiguous buffer for transmission / reception via the virtio ring.\r
@@ -205,33 +198,34 @@ VirtioPrepare (
   The caller is responsible for initializing *Indices with VirtioPrepare()\r
   first.\r
 \r
-  @param[in,out] Ring        The virtio ring to append the buffer to, as a\r
-                             descriptor.\r
+  @param[in,out] Ring               The virtio ring to append the buffer to,\r
+                                    as a descriptor.\r
 \r
-  @param[in] BufferPhysAddr  (Guest pseudo-physical) start address of the\r
-                             transmit / receive buffer.\r
+  @param[in] BufferDeviceAddress    (Bus master device) start address of the\r
+                                    transmit / receive buffer.\r
 \r
-  @param[in] BufferSize      Number of bytes to transmit or receive.\r
+  @param[in] BufferSize             Number of bytes to transmit or receive.\r
 \r
-  @param[in] Flags           A bitmask of VRING_DESC_F_* flags. The caller\r
-                             computes this mask dependent on further buffers to\r
-                             append and transfer direction.\r
-                             VRING_DESC_F_INDIRECT is unsupported. The\r
-                             VRING_DESC.Next field is always set, but the host\r
-                             only interprets it dependent on VRING_DESC_F_NEXT.\r
+  @param[in] Flags                  A bitmask of VRING_DESC_F_* flags. The\r
+                                    caller computes this mask dependent on\r
+                                    further buffers to append and transfer\r
+                                    direction. VRING_DESC_F_INDIRECT is\r
+                                    unsupported. The VRING_DESC.Next field is\r
+                                    always set, but the host only interprets\r
+                                    it dependent on VRING_DESC_F_NEXT.\r
 \r
-  @param[in,out] Indices     Indices->HeadDescIdx is not accessed.\r
-                             On input, Indices->NextDescIdx identifies the next\r
-                             descriptor to carry the buffer. On output,\r
-                             Indices->NextDescIdx is incremented by one, modulo\r
-                             2^16.\r
+  @param[in,out] Indices            Indices->HeadDescIdx is not accessed.\r
+                                    On input, Indices->NextDescIdx identifies\r
+                                    the next descriptor to carry the buffer.\r
+                                    On output, Indices->NextDescIdx is\r
+                                    incremented by one, modulo 2^16.\r
 \r
 **/\r
 VOID\r
 EFIAPI\r
 VirtioAppendDesc (\r
   IN OUT VRING        *Ring,\r
-  IN     UINTN        BufferPhysAddr,\r
+  IN     UINT64       BufferDeviceAddress,\r
   IN     UINT32       BufferSize,\r
   IN     UINT16       Flags,\r
   IN OUT DESC_INDICES *Indices\r
@@ -240,7 +234,7 @@ VirtioAppendDesc (
   volatile VRING_DESC *Desc;\r
 \r
   Desc        = &Ring->Desc[Indices->NextDescIdx++ % Ring->QueueSize];\r
-  Desc->Addr  = BufferPhysAddr;\r
+  Desc->Addr  = BufferDeviceAddress;\r
   Desc->Len   = BufferSize;\r
   Desc->Flags = Flags;\r
   Desc->Next  = Indices->NextDescIdx % Ring->QueueSize;\r
@@ -458,7 +452,7 @@ Virtio10WriteFeatures (
                                   VIRTIO_UNMAP_SHARED.\r
 \r
 \r
-  @retval EFI_SUCCESS             The NumberOfBytes is succesfully mapped.\r
+  @retval EFI_SUCCESS             The NumberOfBytes is successfully mapped.\r
   @retval EFI_UNSUPPORTED         The HostAddress cannot be mapped as a\r
                                   common buffer.\r
   @retval EFI_INVALID_PARAMETER   One or more parameters are invalid.\r