[PATCH v1 0/3] virtio-net: Define cvq configuration related device parts

[PATCH v1 0/3] virtio-net: Define cvq configuration related device parts

[Parav Pandit]

virtio net driver sends the control virtqueue commands for
device configuration. Such driver configuration is currently
not captured in the device parts.

This series adds several of such device parts which represents
the network device specific configuration.

It is done by utilizing the existing device parts structure.
A new generic selector format is added to enable device type
specific device parts.

This series also reuses the existing control virtqueue command
structures, fields, and values to define the network device parts.

Patch summary:
patch-1 fixes a duplicate part name
patch-2 adds device type specific raw selector
patch-3 defines several cvq command related device parts

Fixes: https://github.com/oasis-tcs/virtio-spec/issues/209

---
changelog:
v0->v1:
- fixed comments from Matias
- fixed spelling of selectors
- rewrote description of selector without writing the actual
  part_type range along with description that it is device type
  specific

Parav Pandit (3):
  device-parts: editorial: Replace duplicated part type
  device-parts: Add device type specific raw selector
  virtio-net: Define cvq configuration related device parts

 device-parts.tex                 |  7 ++-
 device-types/net/description.tex | 90 ++++++++++++++++++++++++++++++++
 2 files changed, 96 insertions(+), 1 deletion(-)

-- 
2.34.1

[PATCH v1 1/3] device-parts: editorial: Replace duplicated part type

[Parav Pandit]

Device part type VIRTIO_DEV_PART_VQ_CFG was duplicated in
the description; it is supposed to be VIRTIO_DEV_PART_VQ_NOTIFY_CFG.
Fix it.

Fixes: https://github.com/oasis-tcs/virtio-spec/issues/209
Fixes: 617aa2d62a88 ("Signed-off-by: Parav Pandit <parav@nvidia.com>")
Reviewed-by: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 device-parts.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/device-parts.tex b/device-parts.tex
index 7197929..e59c0f9 100644
--- a/device-parts.tex
+++ b/device-parts.tex
@@ -75,7 +75,7 @@ \section{Device parts}\label{sec:Basic Facilities of a Virtio Device / Device pa
 
 \field{selector.vq_index.index} is the index of the virtqueue. It is valid
 only when the \field{part_type} is VIRTIO_DEV_PART_VQ_CFG or
-VIRTIO_DEV_PART_VQ_CFG.
+VIRTIO_DEV_PART_VQ_NOTIFY_CFG.
 
 \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts}
 
-- 
2.34.1

[PATCH v1 2/3] device-parts: Add device type specific raw selector

[Parav Pandit]

The subsequent patch defines the device-type-specific parts. For
these parts, the raw selector format is defined to ensure that
each device type can specify its format accurately.

Fixes: https://github.com/oasis-tcs/virtio-spec/issues/209
Signed-off-by: Parav Pandit <parav@nvidia.com>

---
changelog:
v0->v1:
- addressed comment from Matias
- rewrote description of selector without writing the actual
  part_type range, add description that it is device type specific
---
 device-parts.tex | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/device-parts.tex b/device-parts.tex
index e59c0f9..1d6be87 100644
--- a/device-parts.tex
+++ b/device-parts.tex
@@ -21,6 +21,7 @@ \section{Device parts}\label{sec:Basic Facilities of a Virtio Device / Device pa
                         le16 index;
                         u8 reserved[6];
                 } vq_index;
+		u8 device_type_raw[8];
         } selector;
         le32 length;
 };
@@ -77,6 +78,10 @@ \section{Device parts}\label{sec:Basic Facilities of a Virtio Device / Device pa
 only when the \field{part_type} is VIRTIO_DEV_PART_VQ_CFG or
 VIRTIO_DEV_PART_VQ_NOTIFY_CFG.
 
+\field{selector.device_type_raw} is applicable only when the \field{part_type}
+corresponds to a device-specific range. The format of
+\field{selector.device_type_raw} is device type specific.
+
 \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts}
 
 Common parts are independent of the device type.
-- 
2.34.1

[PATCH v1 3/3] virtio-net: Define cvq configuration related device parts

[Parav Pandit]

virtio net driver sends the control virtqueue commands for
device configuration. Such driver configuration is currently
not captured in the device parts.

This series adds several of such device parts which represents
the network device specific configuration.

It is done by utilizing the existing device parts structure.
A new generic selector format is added to enable device type
specific device parts.

This series also reuses the existing control virtqueue command
structures, fields, and values to define the network device parts.

Fixes: https://github.com/oasis-tcs/virtio-spec/issues/209
Reviewed-by: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>

---
changelog:
v0->v1:
- addressed comments from Matias
- fixed spelling of selectors
---
 device-types/net/description.tex | 90 ++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)

diff --git a/device-types/net/description.tex b/device-types/net/description.tex
index e45ecbd..9a87bfb 100644
--- a/device-types/net/description.tex
+++ b/device-types/net/description.tex
@@ -433,6 +433,96 @@ \subsection{Device resource objects}\label{sec:Device Types / Network Device / D
 \hline
 \end{tabularx}
 
+\subsection{Device parts}\label{sec:Device Types / Network Device / Device parts}
+
+Network device parts represent the configuration done by the driver using control
+virtqueue commands. Network device part is in the format of
+\field{struct virtio_dev_part}.
+
+\begin{tabularx}{\textwidth}{ |l||l|X| }
+\hline
+Type & Name & Description \\
+\hline \hline
+0x200 & VIRTIO_NET_DEV_PART_CVQ_CFG_PART & Represents device configuration done through a control virtqueue command, see \ref{sec:Device Types / Network Device / Device parts / VIRTIO-NET-DEV-PART-CVQ-CFG-PART} \\
+\hline
+0x201 - 0x5FF & - & reserved for future \\
+\hline
+\hline
+\end{tabularx}
+
+\subsubsection{VIRTIO_NET_DEV_PART_CVQ_CFG_PART}\label{sec:Device Types / Network Device / Device parts / VIRTIO-NET-DEV-PART-CVQ-CFG-PART}
+
+For VIRTIO_NET_DEV_PART_CVQ_CFG_PART, \field{part_type} is set to 0x200. The
+VIRTIO_NET_DEV_PART_CVQ_CFG_PART part indicates configuration performed by the
+driver using a control virtqueue command.
+
+\begin{lstlisting}
+struct virtio_net_dev_part_cvq_selector {
+        u8 class;
+        u8 command;
+        u8 reserved[6];
+};
+\end{lstlisting}
+
+There is one device part of type VIRTIO_NET_DEV_PART_CVQ_CFG_PART for each
+individual configuration. Each part is identified by a unique selector value.
+The selector, \field{device_type_raw}, is in the format
+\field{struct virtio_net_dev_part_cvq_selector}.
+
+The selector consists of two fields: \field{class} and \field{command}. These
+fields correspond to the \field{class} and \field{command} defined in
+\field{struct virtio_net_ctrl}, as described in the relevant sections of
+\ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue}.
+
+The value corresponding to each part’s selector follows the same format as the
+respective \field{command-specific-data} described in the relevant sections of
+\ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue}.
+
+For example, when the \field{class} is VIRTIO_NET_CTRL_MAC, the \field{command}
+can be either VIRTIO_NET_CTRL_MAC_TABLE_SET or VIRTIO_NET_CTRL_MAC_ADDR_SET;
+when \field{command} is set to VIRTIO_NET_CTRL_MAC_TABLE_SET, \field{value}
+is in the format of \field{struct virtio_net_ctrl_mac}.
+
+Supported selectors are listed in the table:
+
+\begin{tabularx}{\textwidth}{ |l|X| }
+\hline
+Class selector & Command selector \\
+\hline \hline
+VIRTIO_NET_CTRL_RX & VIRTIO_NET_CTRL_RX_PROMISC \\
+\hline
+VIRTIO_NET_CTRL_RX & VIRTIO_NET_CTRL_RX_ALLMULTI \\
+\hline
+VIRTIO_NET_CTRL_RX & VIRTIO_NET_CTRL_RX_ALLUNI \\
+\hline
+VIRTIO_NET_CTRL_RX & VIRTIO_NET_CTRL_RX_NOMULTI \\
+\hline
+VIRTIO_NET_CTRL_RX & VIRTIO_NET_CTRL_RX_NOUNI \\
+\hline
+VIRTIO_NET_CTRL_RX & VIRTIO_NET_CTRL_RX_NOBCAST \\
+\hline
+VIRTIO_NET_CTRL_MAC & VIRTIO_NET_CTRL_MAC_TABLE_SET \\
+\hline
+VIRTIO_NET_CTRL_MAC & VIRTIO_NET_CTRL_MAC_ADDR_SET \\
+\hline
+VIRTIO_NET_CTRL_VLAN & VIRTIO_NET_CTRL_VLAN_ADD \\
+\hline
+VIRTIO_NET_CTRL_ANNOUNCE & VIRTIO_NET_CTRL_ANNOUNCE_ACK \\
+\hline
+VIRTIO_NET_CTRL_MQ & VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET \\
+\hline
+VIRTIO_NET_CTRL_MQ & VIRTIO_NET_CTRL_MQ_RSS_CONFIG \\
+\hline
+VIRTIO_NET_CTRL_MQ & VIRTIO_NET_CTRL_MQ_HASH_CONFIG \\
+\hline
+\hline
+\end{tabularx}
+
+For command selector VIRTIO_NET_CTRL_VLAN_ADD, device part consists of a whole
+VLAN table.
+
+\field{reserved} is reserved and set to zero.
+
 \subsection{Device Operation}\label{sec:Device Types / Network Device / Device Operation}
 
 Packets are transmitted by placing them in the
-- 
2.34.1

Re: [PATCH v1 2/3] device-parts: Add device type specific raw selector

[Matias Ezequiel Vara Larsen]

On Sun, Oct 20, 2024 at 02:41:40PM +0300, Parav Pandit wrote:
> The subsequent patch defines the device-type-specific parts. For
> these parts, the raw selector format is defined to ensure that
> each device type can specify its format accurately.
> 
> Fixes: https://github.com/oasis-tcs/virtio-spec/issues/209
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> 
> ---
> changelog:
> v0->v1:
> - addressed comment from Matias
> - rewrote description of selector without writing the actual
>   part_type range, add description that it is device type specific
> ---
>  device-parts.tex | 5 +++++
>  1 file changed, 5 insertions(+)

Reviewed-by: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>

> 
> diff --git a/device-parts.tex b/device-parts.tex
> index e59c0f9..1d6be87 100644
> --- a/device-parts.tex
> +++ b/device-parts.tex
> @@ -21,6 +21,7 @@ \section{Device parts}\label{sec:Basic Facilities of a Virtio Device / Device pa
>                          le16 index;
>                          u8 reserved[6];
>                  } vq_index;
> +		u8 device_type_raw[8];
>          } selector;
>          le32 length;
>  };
> @@ -77,6 +78,10 @@ \section{Device parts}\label{sec:Basic Facilities of a Virtio Device / Device pa
>  only when the \field{part_type} is VIRTIO_DEV_PART_VQ_CFG or
>  VIRTIO_DEV_PART_VQ_NOTIFY_CFG.
>  
> +\field{selector.device_type_raw} is applicable only when the \field{part_type}
> +corresponds to a device-specific range. The format of
> +\field{selector.device_type_raw} is device type specific.
> +
>  \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts}
>  
>  Common parts are independent of the device type.
> -- 
> 2.34.1
> 

RE: [PATCH v1 0/3] virtio-net: Define cvq configuration related device parts

[Parav Pandit]

Hi Matias, Michael,

> From: Parav Pandit <parav@nvidia.com>
> Sent: Sunday, October 20, 2024 5:12 PM
> To: virtio-comment@lists.linux.dev; mst@redhat.com; cohuck@redhat.com;
> mvaralar@redhat.com
> Cc: Shahaf Shuler <shahafs@nvidia.com>; Parav Pandit <parav@nvidia.com>
> Subject: [PATCH v1 0/3] virtio-net: Define cvq configuration related device
> parts
> 
> virtio net driver sends the control virtqueue commands for device
> configuration. Such driver configuration is currently not captured in the
> device parts.
> 
> This series adds several of such device parts which represents the network
> device specific configuration.
> 
> It is done by utilizing the existing device parts structure.
> A new generic selector format is added to enable device type specific device
> parts.
> 
> This series also reuses the existing control virtqueue command structures,
> fields, and values to define the network device parts.
> 
> Patch summary:
> patch-1 fixes a duplicate part name
> patch-2 adds device type specific raw selector
> patch-3 defines several cvq command related device parts
> 
> Fixes: https://github.com/oasis-tcs/virtio-spec/issues/209
> 
> ---
> changelog:
> v0->v1:
> - fixed comments from Matias
> - fixed spelling of selectors
> - rewrote description of selector without writing the actual
>   part_type range along with description that it is device type
>   specific
>

These short fixes and improvements are reviewed now.
Can you please raise for the vote?

Fixes: https://github.com/oasis-tcs/virtio-spec/issues/209

 
> Parav Pandit (3):
>   device-parts: editorial: Replace duplicated part type
>   device-parts: Add device type specific raw selector
>   virtio-net: Define cvq configuration related device parts
> 
>  device-parts.tex                 |  7 ++-
>  device-types/net/description.tex | 90
> ++++++++++++++++++++++++++++++++
>  2 files changed, 96 insertions(+), 1 deletion(-)
> 
> --
> 2.34.1