From 11a5fdf43773b2418412f0800ab9770053bcef05 Mon Sep 17 00:00:00 2001 From: jljusten Date: Wed, 15 May 2013 06:22:50 +0000 Subject: [PATCH] OvmfPkg: adapt VirtioAppendDesc()'s leading comment to the coding style Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Laszlo Ersek git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@14361 6f19259b-4bc3-4df7-8a09-765794883524 --- OvmfPkg/Include/Library/VirtioLib.h | 41 +++++++++++++-------------- OvmfPkg/Library/VirtioLib/VirtioLib.c | 41 +++++++++++++-------------- 2 files changed, 40 insertions(+), 42 deletions(-) diff --git a/OvmfPkg/Include/Library/VirtioLib.h b/OvmfPkg/Include/Library/VirtioLib.h index 9a502f3e67..990219cca1 100644 --- a/OvmfPkg/Include/Library/VirtioLib.h +++ b/OvmfPkg/Include/Library/VirtioLib.h @@ -180,27 +180,26 @@ VirtioPrepare ( The caller is responsible for initializing *Indices with VirtioPrepare() first. - @param[in out] Ring The virtio ring to append the buffer to, as a - descriptor. - - @param [in] BufferPhysAddr (Guest pseudo-physical) start address of the - transmit / receive buffer. - - @param [in] BufferSize Number of bytes to transmit or receive. - - @param [in] Flags A bitmask of VRING_DESC_F_* flags. The caller - computes this mask dependent on further buffers - to append and transfer direction. - VRING_DESC_F_INDIRECT is unsupported. The - VRING_DESC.Next field is always set, but the - host only interprets it dependent on - VRING_DESC_F_NEXT. - - In *Indices: - - @param [in out] NextDescIdx On input, the index identifying the next - descriptor to carry the buffer. On output, - incremented by one, modulo 2^16. + @param[in,out] Ring The virtio ring to append the buffer to, as a + descriptor. + + @param[in] BufferPhysAddr (Guest pseudo-physical) start address of the + transmit / receive buffer. + + @param[in] BufferSize Number of bytes to transmit or receive. + + @param[in] Flags A bitmask of VRING_DESC_F_* flags. The caller + computes this mask dependent on further buffers to + append and transfer direction. + VRING_DESC_F_INDIRECT is unsupported. The + VRING_DESC.Next field is always set, but the host + only interprets it dependent on VRING_DESC_F_NEXT. + + @param[in,out] Indices Indices->HeadDescIdx is not accessed. + On input, Indices->NextDescIdx identifies the next + descriptor to carry the buffer. On output, + Indices->NextDescIdx is incremented by one, modulo + 2^16. **/ VOID diff --git a/OvmfPkg/Library/VirtioLib/VirtioLib.c b/OvmfPkg/Library/VirtioLib/VirtioLib.c index 01260b3872..97c649b44b 100644 --- a/OvmfPkg/Library/VirtioLib/VirtioLib.c +++ b/OvmfPkg/Library/VirtioLib/VirtioLib.c @@ -329,27 +329,26 @@ VirtioPrepare ( The caller is responsible for initializing *Indices with VirtioPrepare() first. - @param[in out] Ring The virtio ring to append the buffer to, as a - descriptor. - - @param [in] BufferPhysAddr (Guest pseudo-physical) start address of the - transmit / receive buffer. - - @param [in] BufferSize Number of bytes to transmit or receive. - - @param [in] Flags A bitmask of VRING_DESC_F_* flags. The caller - computes this mask dependent on further buffers - to append and transfer direction. - VRING_DESC_F_INDIRECT is unsupported. The - VRING_DESC.Next field is always set, but the - host only interprets it dependent on - VRING_DESC_F_NEXT. - - In *Indices: - - @param [in out] NextDescIdx On input, the index identifying the next - descriptor to carry the buffer. On output, - incremented by one, modulo 2^16. + @param[in,out] Ring The virtio ring to append the buffer to, as a + descriptor. + + @param[in] BufferPhysAddr (Guest pseudo-physical) start address of the + transmit / receive buffer. + + @param[in] BufferSize Number of bytes to transmit or receive. + + @param[in] Flags A bitmask of VRING_DESC_F_* flags. The caller + computes this mask dependent on further buffers to + append and transfer direction. + VRING_DESC_F_INDIRECT is unsupported. The + VRING_DESC.Next field is always set, but the host + only interprets it dependent on VRING_DESC_F_NEXT. + + @param[in,out] Indices Indices->HeadDescIdx is not accessed. + On input, Indices->NextDescIdx identifies the next + descriptor to carry the buffer. On output, + Indices->NextDescIdx is incremented by one, modulo + 2^16. **/ VOID -- 2.39.2