public inbox for virtio-comment@lists.linux.dev
 help / color / mirror / Atom feed
From: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>
To: virtio-comment@lists.linux.dev
Cc: Parav Pandit <parav@nvidia.com>,
	cohuck@redhat.com, mst@redhat.com,
	Xuan Zhuo <xuanzhuo@linux.alibaba.com>,
	Matias Ezequiel Vara Larsen <mvaralar@redhat.com>
Subject: [PATCH 08/13] virtio-net: Annotate virtio_net_hdr as field
Date: Tue,  1 Apr 2025 15:35:08 +0200	[thread overview]
Message-ID: <20250401133543.801184-9-mvaralar@redhat.com> (raw)
In-Reply-To: <20250401133543.801184-1-mvaralar@redhat.com>

From: Parav Pandit <parav@nvidia.com>

At several places struct virtio_net_hdr missed out the field
annotation. Add it.

Reviewed-by: Xuan Zhuo <xuanzhuo@linux.alibaba.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>
Message-Id: <20240606102014.2103986-4-parav@nvidia.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
(cherry picked from commit 6abd42fd2398718ff689dc51fa93d38ede97be8f)
Signed-off-by: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>
---
 device-types/net/description.tex | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/device-types/net/description.tex b/device-types/net/description.tex
index 7f9ed38..86cdb63 100644
--- a/device-types/net/description.tex
+++ b/device-types/net/description.tex
@@ -431,11 +431,11 @@ \subsection{Device Operation}\label{sec:Device Types / Network Device / Device O
 
 \subsubsection{Legacy Interface: Device Operation}\label{sec:Device Types / Network Device / Device Operation / Legacy Interface: Device Operation}
 When using the legacy interface, transitional devices and drivers
-MUST format the fields in struct virtio_net_hdr
+MUST format the fields in \field{struct virtio_net_hdr}
 according to the native endian of the guest rather than
 (necessarily when not using the legacy interface) little-endian.
 
-The legacy driver only presented \field{num_buffers} in the struct virtio_net_hdr
+The legacy driver only presented \field{num_buffers} in the \field{struct virtio_net_hdr}
 when VIRTIO_NET_F_MRG_RXBUF was negotiated; without that feature the
 structure was 2 bytes shorter.
 
@@ -729,7 +729,7 @@ \subsubsection{Processing of Incoming Packets}\label{sec:Device Types / Network
   chains them together to form a single packet in a way similar to
   how it would store it in a single buffer spread over multiple
   descriptors.
-  The other buffers will not begin with a struct virtio_net_hdr.
+  The other buffers will not begin with a \field{struct virtio_net_hdr}.
 
 \item If
   \field{num_buffers} is one, then the entire packet will be
@@ -1825,7 +1825,7 @@ \subsubsection{Legacy Interface: Framing Requirements}\label{sec:Device
 
 When using legacy interfaces, transitional drivers which have not
 negotiated VIRTIO_F_ANY_LAYOUT MUST use a single descriptor for the
-struct virtio_net_hdr on both transmit and receive, with the
+\field{struct virtio_net_hdr} on both transmit and receive, with the
 network data in the following descriptors.
 
 Additionally, when using the control virtqueue (see \ref{sec:Device
-- 
2.42.0


  parent reply	other threads:[~2025-04-01 13:36 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-01 13:35 [PATCH 00/13] Backport 1.4 fixes to 1.3 Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 01/13] conformance: Add missing virtqueue reset conformance references Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 02/13] packed-ring: Change host,guest to device,driver Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 03/13] description: Avoid splitting the word virtqueue Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 04/13] content: Rename SPI master to SPI controller Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 05/13] virtio-blk: Fix data type of num_queues field Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 06/13] virtio-net: Fix receive buffer size calculation text Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 07/13] virtio-net: Clarify the size of the struct virtio_net_hdr for tx Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` Matias Ezequiel Vara Larsen [this message]
2025-04-01 13:35 ` [PATCH 09/13] virtio_pci_cap64: specify offset_hi, length_hi endianness Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 10/13] gpu: editorial: Fix spelling errors Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 11/13] virtio-net: clarify NEEDS_CSUM semantic for GSO packats Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 12/13] virtio-net: clarify DATA_VALID semantic for encap protos Matias Ezequiel Vara Larsen
2025-04-01 13:35 ` [PATCH 13/13] virtio-net: Fix receive buffer size typo Matias Ezequiel Vara Larsen
2025-04-02  7:02 ` [PATCH 00/13] Backport 1.4 fixes to 1.3 Michael S. Tsirkin
2025-04-02  9:22 ` Cornelia Huck
2025-04-02 10:25   ` Parav Pandit
2025-04-02 10:29     ` Matias Ezequiel Vara Larsen
2025-04-02 10:59       ` Parav Pandit
2025-04-02 15:24         ` Matias Ezequiel Vara Larsen
2025-04-03  8:14           ` Matias Ezequiel Vara Larsen
2025-04-03 12:48             ` Michael S. Tsirkin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250401133543.801184-9-mvaralar@redhat.com \
    --to=mvaralar@redhat.com \
    --cc=cohuck@redhat.com \
    --cc=mst@redhat.com \
    --cc=parav@nvidia.com \
    --cc=virtio-comment@lists.linux.dev \
    --cc=xuanzhuo@linux.alibaba.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox