From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Sender: List-Post: List-Help: List-Unsubscribe: List-Subscribe: References: <20230217154529.33508-1-parav@nvidia.com> <20230217154529.33508-3-parav@nvidia.com> From: David Edmondson Date: Mon, 20 Feb 2023 14:42:40 +0000 In-reply-to: <20230217154529.33508-3-parav@nvidia.com> Message-ID: MIME-Version: 1.0 Subject: Re: [virtio-comment] [PATCH v3 2/2] virtio-net: Define cfg fields before description Content-Type: text/plain To: Parav Pandit Cc: mst@redhat.com, virtio-dev@lists.oasis-open.org, cohuck@redhat.com, shahafs@nvidia.com, virtio-comment@lists.oasis-open.org List-ID: On Friday, 2023-02-17 at 17:45:29 +02, Parav Pandit wrote: > Currently some fields of the virtio_net_config structure are defined > before introducing the structure and some are defined after > introducing virtio_net_config. > Better to define the configuration layout first followed by > description of all the fields. > > Device configuration fields are described in the section. Change wording > from 'listed' to 'described' as suggested in patch [1]. > > [1] https://lists.oasis-open.org/archives/virtio-dev/202302/msg00004.html > > Fixes: https://github.com/oasis-tcs/virtio-spec/issues/161 > Signed-off-by: Parav Pandit Reviewed-by: David Edmondson > --- > changelog: > v2->v3: > - split the patch for read only description as prepration patch > v1->v2: > - remove read-only wording from multiple places > v0->v1: > - Change wording about device configuration field introduction > - remove duplicate read-only wording for status field > - reword sentence to read it better > --- > device-types/net/description.tex | 40 ++++++++++++++++++-------------- > 1 file changed, 22 insertions(+), 18 deletions(-) > > diff --git a/device-types/net/description.tex b/device-types/net/description.tex > index 81e1135..c4bb64e 100644 > --- a/device-types/net/description.tex > +++ b/device-types/net/description.tex > @@ -156,11 +156,28 @@ \subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types / Network > \subsection{Device configuration layout}\label{sec:Device Types / Network Device / Device configuration layout} > \label{sec:Device Types / Block Device / Feature bits / Device configuration layout} > > -Device configuration fields are listed below. The \field{mac} address field > -always exists (though is only valid if VIRTIO_NET_F_MAC is set), and > -\field{status} only exists if VIRTIO_NET_F_STATUS is set. Two > -bits (for the driver) are currently defined for the status field: > -VIRTIO_NET_S_LINK_UP and VIRTIO_NET_S_ANNOUNCE. > +The network device has the following device configuration layout. > + > +\begin{lstlisting} > +struct virtio_net_config { > + u8 mac[6]; > + le16 status; > + le16 max_virtqueue_pairs; > + le16 mtu; > + le32 speed; > + u8 duplex; > + u8 rss_max_key_size; > + le16 rss_max_indirection_table_length; > + le32 supported_hash_types; > +}; > +\end{lstlisting} > + > +The \field{mac} address field always exists (although it is only > +valid if VIRTIO_NET_F_MAC is set). > + > +The \field{status} only exists if VIRTIO_NET_F_STATUS is set. > +Two bits are currently defined for the status field: VIRTIO_NET_S_LINK_UP > +and VIRTIO_NET_S_ANNOUNCE. > > \begin{lstlisting} > #define VIRTIO_NET_S_LINK_UP 1 > @@ -190,19 +207,6 @@ \subsection{Device configuration layout}\label{sec:Device Types / Network Device > is expected to re-read these values after receiving a > configuration change notification. > > -\begin{lstlisting} > -struct virtio_net_config { > - u8 mac[6]; > - le16 status; > - le16 max_virtqueue_pairs; > - le16 mtu; > - le32 speed; > - u8 duplex; > - u8 rss_max_key_size; > - le16 rss_max_indirection_table_length; > - le32 supported_hash_types; > -}; > -\end{lstlisting} > The following field, \field{rss_max_key_size} only exists if VIRTIO_NET_F_RSS or VIRTIO_NET_F_HASH_REPORT is set. > It specifies the maximum supported length of RSS key in bytes. -- Tell me sweet little lies. This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC. In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting. Subscribe: virtio-comment-subscribe@lists.oasis-open.org Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org List help: virtio-comment-help@lists.oasis-open.org List archive: https://lists.oasis-open.org/archives/virtio-comment/ Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists Committee: https://www.oasis-open.org/committees/virtio/ Join OASIS: https://www.oasis-open.org/join/