From: Parav Pandit <parav@nvidia.com>
To: <virtio-comment@lists.linux.dev>, <mst@redhat.com>, <cohuck@redhat.com>
Cc: <shahafs@nvidia.com>, <xuanzhuo@linux.alibaba.com>,
<yuri.benditovich@daynix.com>, Parav Pandit <parav@nvidia.com>
Subject: [PATCH v6 3/3] virtio-net: Annotate virtio_net_hdr as field
Date: Thu, 6 Jun 2024 13:20:14 +0300 [thread overview]
Message-ID: <20240606102014.2103986-4-parav@nvidia.com> (raw)
In-Reply-To: <20240606102014.2103986-1-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>
---
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 d24ffb7..a66d6b0 100644
--- a/device-types/net/description.tex
+++ b/device-types/net/description.tex
@@ -437,11 +437,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.
@@ -735,7 +735,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
@@ -2416,7 +2416,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.34.1
prev parent reply other threads:[~2024-06-06 10:20 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-06 10:20 [PATCH v6 0/3] virtio-net: Clarify virtio_net_hdr size and rx buffer size Parav Pandit
2024-06-06 10:20 ` [PATCH v6 1/3] virtio-net: Fix receive buffer size calculation text Parav Pandit
2024-06-06 10:20 ` [PATCH v6 2/3] virtio-net: Clarify the size of the struct virtio_net_hdr for tx Parav Pandit
2024-06-06 10:20 ` Parav Pandit [this message]
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=20240606102014.2103986-4-parav@nvidia.com \
--to=parav@nvidia.com \
--cc=cohuck@redhat.com \
--cc=mst@redhat.com \
--cc=shahafs@nvidia.com \
--cc=virtio-comment@lists.linux.dev \
--cc=xuanzhuo@linux.alibaba.com \
--cc=yuri.benditovich@daynix.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.