Introduce virtio transport virtqueue
v3 cover Introduce virtio transport virtqueue
This series introduces virtio transport virtqueue as a new transport layer for virtio devices.
This series defines the concepts of virtio management device and virtio managed devices.
This series also defines a commands set over the transport virtqueue, including:
The command to query available resources of the management device The commands to create / destroy the managed devices.
The commands to config the managed devices.
The commands to config virtqueues of the managed devices.
Changes from V2:
1)Drop Feature bit VIRTIO_F_TRANSPT_VQ_MDEV (Michael)
2)Extend the feature bits to 128 bits as required in section 2.2 Feature Bits (Michael)
3)Explicit describes the feature bit VIRTIO_F_TRANSPT_VQ should be negotiated with the management device for the commands (Michael) 4)Removed MSI mask / unmask commands (Michael)
5)Add commands to get MSI entries of vqs and config space (Michael)
6)Add a description on the behaviors when disable a MSI (Michael)
7)Removed the section “Management device discovery” (Michael)
8)Remove pre-created managed devices, it is totally depending on the HW implementation (Michael)
9)Detailed descriptions for VIRITO DEVICE ID in the creation command (Michael)
10)Better device requirements for the device config space generation (Michael)
11)Re-use struct transportq_ctrl_packed_vq_state{} for both packed vq state set/get (Michael)
Changes form V1:
1)Add a command to set per-vq asid(Jason)
2)Add a command to reset a virtqueue(Jason)
3)Add support for packed virtqueue state(Jason)
4)Allow nested managed devices(Jason)
5)Provides device feature bits in the provisioning(Jason) 6)Removed most of the error codes, only left OK and ERR(Jason) 7)“virtual devices” is renamed to “managed devices”, to be more general(Jason)
Zhu Lingshan (4):
Introduce virito transport virtqueue Introduce the commands set of the transport vq Describe the process to present a managed device Add transport vq number for virtio blk and net
content.tex | 761 +++++++++++++++++++++++++++++++++++++++++++++++ introduction.tex | 3 + 2 files changed, 764 insertions(+)
Signature · 1 line
2.35.3
PATCH v3 1/4 Introduce virito transport virtqueue
This commit introduces transport virtqueue as a new transport layer for virtio devices. And the format of the commands through the transport virtqueue is defined as well.
We also give examples for the management devices and the managed devices.
--- content.tex | 82 ++++++++++++++++++++++++++++++++++++++++++++++++ introduction.tex | 3 ++ 2 files changed, 85 insertions(+)
content.tex +82 -0
@@ -2895,6 +2895,88 @@ \subsubsection{Resetting Devices}\label{sec:Virtio Transport Options / Virtio ov MAY also choose to verify reset completion by reading \field{device status} via CCW_CMD_READ_STATUS and checking whether it is 0 afterwards. +\section{Virtio Over Transport Virtqueue}\label{sec:Virtio Transport Options Virtio Over Transport Virtqueue} + +In some cases, it is challenging to implement a virtio device in a transport specific method. + +One example is that a physical device may try to present multiple managed (maybe virtual) devices +with limited transport specific resources. + +Another example is to implement managed devices which are transport independent. + +In those cases, a transport virtqueue could be used as the transport layer to +implement virtio managed device. + +\subsection{Basic Concepts}\label{sec:Virtio Transport Options / Virtio over Transport Virtqueue / Basic Concepts} + +Feature bit VIRTIO_F_TRANSPT_VQ indicates that a device offers a transport virtqueue, +and the managed devices are created, destroyed and configured through the transport virtqueue. + +\subsubsection{The Management Device}\label{sec:Virtio Transport Options / Virtio over Transport Virtqueue / Basic Concepts / The Management Device} + +A device that offers feature bit VIRTIO_F_TRANSPT_VQ and a transport virtqueue is a management device. +It processes the commands through the transport virtqueue commands. + +For example, a PCIe device with a transport virtqueue is a management device. + +\devicenormative{\subsubsection}{The Management Device}{Virtio Transport Options / Virtio Over Transport Virtqueue / Basic Concepts / The management Device} + +The management device MUST offer feature bit VIRTIO_F_TRANSPT_VQ and a transport virtqueue as a device specific virtqueue. + +\subsubsection{The Managed Device}\label{sec:Virtio Transport Options / Virtio over Transport Virtqueue / Basic Concepts / The Managed Device} + +A managed device is a kind of device that is created through a transport virtqueue, +and utilizes the transport virtqueue as its transport layer. + +An example of managed devices is a Scalable I/O Virtualization \hyperref[intro:SIOV]{[SIOV]} device which is created and managed +through a transport virtqueue of a management device. + +\subsubsection{Managed Devices Dscovery}\label{sec:Virtio Transport Options /Virtio Over Transport Virtqueue / Managed Devices Discovery} + +Managed devices are created and discovered through a transport virtqueue. + +\subsubsection{Managed Devices Interrupts}\label{sec:Virtio Transport Options /Virtio Over Transport Virtqueue / Managed Devices Interrupts} + +The managed devices utilize MSI (Message Signaled Interrupts) to send interrupts, there are no legacy interrupts. + +A MSI entry is composed of a 32-bit data payload and a 64-bit address. + +\devicenormative{\subsubsection}{The Managed Device}{sec:Virtio Transport Options /Virtio Over Transport Virtqueue / The Managed Device} + +The managed device MUST not share its MSI entries with another manged device or with the management device. + + +\subsection{Format of Commands through Transport Virtqueue}\label{sec:Virtio Transport Options / Virtio over Transport Virtqueue / Format of Commands through Transport Virtqueue} + +All transport virtqueue commands are of the following form: + +\begin{lstlisting} +struct virtio_transportq_ctrl { + u64 device_id; + u16 class; + u16 command; + u8 command-out-data[]; + u32 ack; + u8 command-in-data[]; +}; + +/* ack values */ +#define VIRTIO_TRANSPTQ_OK 0 +#define VIRTIO_TRANSPTQ_ERR 255 +\end{lstlisting} + +The \field{device_id}, \field{class}, \field{command} and +\field{command-out-data} are set by the management device driver, +and the device sets \field{ack} and \field{command-in-data}. + +\field{device_id} is a UUID to identify a virtio managed device, +which defined in \hyperref[intro:rfc4122]{RFC4122}. The management device allocates this UUID, +it should be unique in the management device context. + +The \field{device_id} value 0 is used to identify the management device itself. + +\field{class} is an identifier of a set of commands with similar purposes. + \chapter{Device Types}\label{sec:Device Types} On top of the queues, config space and feature negotiation facilities
introduction.tex +3 -0
@@ -80,6 +80,9 @@ \section{Normative References}\label{sec:Normative References} \phantomsection\label{intro:SCMI}\textbf{[SCMI]} & Arm System Control and Management Interface, DEN0056, \newline\url{https://developer.arm.com/docs/den0056/c}, version C and any future revisions\\ + \phantomsection\label{intro:SIOV}\textbf{[SIOV]} & + Scalable I/O Virtualization, + \newline\url{https://www.opencompute.org/documents/ocp-scalable-io-virtualization-technical-specification-revision-1-v1-2-pdf}\\ \end{longtable}
Signature · 1 line
2.35.3
PATCH v3 2/4 Introduce the commands set of the transport vq
In reply to Zhu LingshanThis commit introduces the commands set of the
transport virtqueue, including:
The command to query available resources of the management device The commands to create / destroy the managed devices. The commands to config the managed devices.
The commands to config virtqueues of the managed devices.
--- content.tex | 636 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 636 insertions(+)
content.tex +636 -0
@@ -2976,6 +2976,642 @@ \subsection{Format of Commands through Transport Virtqueue}\label{sec:Virtio Tra The \field{device_id} value 0 is used to identify the management device itself. \field{class} is an identifier of a set of commands with similar purposes. + +\subsection{Available Resource of the Management Device}\label{sec:Virtio Transport Options / Virtio Over Transport Virtqueue / Available Resource of the Management Device} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +statistical information of available resources on the management device could be fetched +by the following command: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_AVAIL_RES 1 (class) + #define VIRTIO_TRANSPTQ_CTRL_AVAIL_RES_GET 0 (command) +\end{lstlisting} + +VIRTIO_TRANSPTQ_CTRL_AVAIL_RES_GET command is used to get the statistical information of the available +resource of a management device. There is no command-out-data for VIRTIO_TRANSPTQ_CTRL_AVAIL_RES_GET +command. The management device fills command-in-data in the following format: + +\begin{lstlisting} +struct virtio_mgmt_dev_avail_res { + /* The number of management device total remaining available free + * virtqueues for the managed devices + */ + u16 num_avail_vqs; + /* The minimal number of virtqueues for a managed device */ + u16 min_dev_vqs; + /* The maximum number of virtqueues for a managed device */ + u16 max_dev_vqs; + /* The number of managed devices that can be created with min_vqs virtqueues */ + u16 num_avail_dev; +}; +\end{lstlisting} + +\field{max_avail_dev} MAY not equal to \field{num_avail_vqs} divided by \field{min_vqs} +due to the limitations of of other resources. + +\devicenormative{\subsubsection}{Available Resource of the Management Device}{Virtio Transport Options / +Virtio Over Transport Virtqueue / Available Resource of the Management Device} + +The management device MUST fail VIRTIO_TRANSPTQ_CTRL_AVAIL_RES_GET command if \field{device_id} is not 0 + +\drivernormative{\subsubsection}{Available Resource of the Management Device}{Virtio Transport Options / +Virtio Over Transport Virtqueue / Available Resource of the Management Device} + +The management device driver MUST use 0 as \field{device_id} for +VIRTIO_TRANSPTQ_CTRL_AVAIL_RES_GET command. + +\subsection{Create and Destroy Managed Devices}\label{sec:Virtio Transport Options / Virtio Over Transport Virtqueue / Create and Destroy Managed Devices} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +managed devices must be created and destroyed through the transport virtqueue. + +\begin{lstlisting} +#define VIRTIO_TRANSPORTQ_CTRL_DEV 2 + #define VIRTIO_TRANSPORTQ_CTRL_DEV_CREATE 0 + #define VIRTIO_TRANSPORTQ_CTRL_DEV_DESTROY 1 + +struct virtio_transportq_ctrl_dev_attribute { + u64 device_features[2]; + u32 virtio_device_id; + u8 dev_config[]; +}; +\end{lstlisting} + +The VIRTIO_TRANSPORTQ_CTRL_DEV_CREATE command is used to create a managed device. + +As described in struct virtio_transportq_ctrl_dev_attribute, the command-out-data for VIRTIO_TRANSPTQ_CTRL_DEV_CREATE includes: +\begin{itemize*} +\item \field{device_features}: the 128-bit device feature bits (defined in section \ref{sec:Basic Facilities of a Virtio Device / Feature Bits}) +of the managed device. +\item \field{virtio_device_id}: the virtio device id defined in Chapter \ref{sec:Device Types}. +\item \field{dev_config}: the device type specific configurations. E.g., for a virtio-net device, +it is struct virtio_net_config in section \ref{sec:Device Types / Network Device / Device configuration layout}; +for a virtio-block device, it is struct virtio_blk_config in section \ref{sec:Device Types / Block Device / Device configuration layout} +\end{itemize*} + +When succeed, the device returns a 64 bits UUID as an unique identifier of the created managed device in command-in-data. + +The VIRTIO_TRANSPORTQ_CTRL_DEV_DESTROY command is used to destroy a +managed device which is identified by its 64 bits UUID +\field{device_id}. There's no command-in-data nor command-out-data for +VIRTIO_TRANSPTQ_CTRL_DEV_DESTROY command. + +\devicenormative{\subsubsection}{Create and Destroy Managed Devices}{Virtio Transport Options / Virtio Over Transport Virtqueue / Create and Destroy Managed Devices} + +The management device MUST fail VIRTIO_TRANSPORTQ_CTRL_DEV_CREATE command +if \field{device_id} is not 0. + +The management device MUST fail VIRTIO_TRANSPORTQ_CTRL_DEV CREATE command +if \field{device_features} exceeds the features that can be provided from the management device. + +The management device MUST fail VIRTO_TRANSPORTQ_CTRL_DEV_DESTROY command +if \field{device_id} is 0. + +\drivernormative{\subsubsection}{Create and Destroy Managed Devices}{Virtio Transport Options / Virtio Over Transport Virtqueue / Create and Destroy Managed Devices} + +The management device driver MUST use 0 as \field{device_id} for +TRANSPORTQ_CTRL_DEV_CREATE command. + +\subsection{Features Negotiation}\label{sec:Virtio Transport Options / Virtio +Over Transport Virtqueue / Features Negotiation} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +the features negotiation of managed devices is done by the +following commands: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_FEAT 3 + #define VIRTIO_TRANSPTQ_CTRL_FEAT_DEVICE_GET 0 + #define VIRTIO_TRANSPTQ_CTRL_FEAT_DRIVER_SET 1 + #define VIRTIO_TRANSPTQ_CTRL_FEAT_DRIVER_GET 2 +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_FEAT_DEVICE_GET command is used to get the features offered +by a managed device. The command-in-data is the 128-bit feature bits +(defined in section \ref{sec:Basic Facilities of a Virtio Device / Feature Bits}). +There is no command-out-data. + +The VIRTIO_TRANSPTQ_CTRL_FEAT_DRIVER_SET command is for the driver to accept feature +bits offered by the managed device. The command-out-data is the 128-bit feature bits +passed to the managed device. There is no command-in-data. + +The VIRTIO_TRANSPTQ_CTRL_FEAT_DRIVER_GET command is used to get the features accepted +by both the managed device driver and the managed device. The command-in-data is the +128-bit feature bits. There is no command-out-data. + +\devicenormative{\subsubsection}{Features Negotiation}{Virtio Transport Options / +Virtio Over Transport Virtqueue / Features Negotiation} + +The management device MUST fail VIRTIO_TRANSPTQ_F_CTRL_FEAT class commands if +\field{device_id} is 0. + +\subsection{Device Status}\label{sec:Virtio Transport Options / Virtio Over +Transport Virtqueue / Device Status} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +the device status of a managed device can be accessed by the following +commands: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_STATUS 4 + #define VIRTIO_TRANSPTQ_CTRL_STATUS_GET 0 + #define VIRTIO_TRANSPTQ_CTRL_STATUS_SET 1 +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_STATUS_GET command is used to get the device status of +a managed device. The command-in-data is the 8-bit status +returned from the device. There's no command-out-data for this +command. + +The VIRTIO_TRANSPTQ_CTRL_STATUS_SET command is used to set the device status of +a managed device. The command-out-data is the 8-bit status +to set to the device. There's no command-in-data for this command. + +\devicenormative{\subsubsection}{Device Status}{Virtio Transport Options / Virtio +Over Transport Virtqueue / Device Status} + +The management device MUST reset the managed device when 0 +is set via VIRTIO_TRANSPTQ_CTRL_STATUS_SET, the success of this +command demonstrates the success of the reset. + +The management device MUST present 0 through +VIRTIO_TRANSPTQ_CTRL_STATUS_GET once the reset is successfully done. + +The management device MUST fail the device status access if +\field{device_id} is 0. + +\drivernormative{\subsubsection}{Device Status}{Virtio Transport Options / Virtio +Over Transport Virtqueue / Device Status} + +After writing 0 via VIRTIO_TRANSPTQ_CTRL_STATUS_SET, the driver MUST wait +for the success of the command before re-initializing the device. + +\subsection{Device Generation}\label{sec:Virtio Transport Options / Virtio Over Transport Virtqueue / Device Generation} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +the device generation count can be read from the following commands: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_GENERATION 5 + #define VIRTIO_TRANSPTQ_CTRL_GENERATION_GET 0 +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_GENERATION_GET command is used to get the device configuration generation count +of the managed device. The command-in-data is the one byte device +generation returned from the device. There's no command-out-data for +this command. + +\devicenormative{\subsubsection}{Device Generation}{Virtio Transport Options / Virtio Over Transport Virtqueue / Device Generation} + +The managed device MUST present a changed generation count after the driver +has read any device-specific configuration values if the values have been changed +during the last read. + +The management device MUST fail the device generation access if \field{device_id} is 0. + +\subsection{Device Specific Configuration}\label{sec:Virtio Transport Options / +Virtio Over Transport Virtqueue / Device Specific Configuration} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +the device config space contents of a managed device can be accessed through +the following commands: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_CONFIG 6 + #define VIRTIO_TRANSPTQ_CTRL_CONFIG_GET 0 + #define VIRTIO_TRANSPTQ_CTRL_CONFIG_SET 1 + +struct virtio_transportq_ctrl_dev_config_get { + u32 offset; + u32 size; +}; + +struct virtio_transportq_ctrl_dev_config_set { + u32 offset; + u32 size; + u8 data[]; +}; +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_CONFIG_GET command is used to read data from the +device configuration space. The command-out-data is the \field{offset} +from the start of the config space and the \field{size} +of the data (as described in struct virtio_transportq_ctrl_dev_config_get). +The command-in-data is an array of the data that read from the config space. + +The VIRTIO_TRANSPTQ_CTRL_CONFIG_SET command is used to write data to the device +configuration space. The command-out-data contains the +\field{offset} from the start of the config space, the \field{size} of the data and +the \field{data} to be written (as described in struct virtio_transportq_ctrl_dev_config_set). +There's no command-in-data for this command. + +\devicenormative{\subsubsection}{Device Specific Configuration}{Virtio Transport +Options / Virtio Over Transport Virtqueue / Device Specific Configuration} + +The management device MUST fail the device configuration space access +if the driver access the range which is outside the config space. + +The management device MUST fail the device configuration space access +if \field{device_id} is 0. + +\subsection{MSI Configuration}\label{sec:Virtio Transport Options / Virtio Over +Transport Virtqueue / MSI Configuration} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +the MSI entries of a managed device can be accessed through the following command: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_MSI 7 + #define VIRTIO_TRANSPTQ_CTRL_MSI_VQ_GET 0 + #define VIRTIO_TRANSPTQ_CTRL_MSI_VQ_SET 1 + #define VIRTIO_TRANSPTQ_CTRL_MSI_VQ_ENABLE 2 + #define VIRTIO_TRANSPTQ_CTRL_MSI_CONFIG_GET 3 + #define VIRTIO_TRANSPTQ_CTRL_MSI_CONFIG_WET 4 + #define VIRTIO_TRANSPTQ_CTRL_MSI_CONFIG_ENABLE 5 + +struct virtio_transportq_ctrl_msi_vq_config { + u16 queue_index; + u64 address; + u32 data; + u8 padding[2]; +}; + +struct virtio_transportq_ctrl_msi_vq_enable { + u16 queue_index; + u8 enable; + u8 padding[5]; +}; + +struct virtio_transportq_ctrl_msi_config { + u64 address; + u32 data; + u8 padding[4]; +}; +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_MSI_VQ_GET command is used to read the MSI entry of a +specific virtqueue. The command-out-data is the queue index. The command-in-data contains +\field{queue_index}, the \field{address} and \field{data} +(as described in struct virtio_transportq_ctrl_msi_vq_config). + + +The VIRTIO_TRANSPTQ_CTRL_MSI_VQ_SET command is used to set the MSI entry for a +specific virtqueue. The command-out-data is the \field{queue_index}, +\field{address} and \field{data} (as described in struct virtio_transportq_ctrl_msi_vq_config). +There is no command-in-data. + +The VIRTIO_TRANSPTQ_CTRL_MSI_VQ_ENABLE command is used to enable or disable +the MSI interrupt for a specific virtqueue. The command-out-data is the +\field{queue_index} and a byte \field{enable} which representing ENABLE or DISABLE the MSI. +(as described in struct virtio_transportq_ctrl_msi_vq_enable). + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_MSI_VQ_ENABLE 1 +#define VIRTIO_TRANSPTQ_CTRL_MSI_VQ_DISABLE 0 +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_MSI_CONFIG_GET command is used to read the MSI entry +of the config interrupt. The command-in-data contains the \field{address} and +\field{data} (as described in struct virtio_transportq_ctrl_msi_config). +There is no command-out-data. + +The VIRTIO_TRANSPTQ_CTRL_MSI_CONFIG_SET command is used to set the MSI entry +for the config interrupt. The command-out-data is the \field{address} and +\field{data} (as described in struct virtio_transportq_ctrl_msi_config). +There is no command-in-data. + +The VIRTIO_TRANSPTQ_CTRL_MSI_CONFIG_ENABLE command is used to enable or disable +the MSI interrupt for config space. The command-out-data is a byte which representing +ENABLE or DISABLE the config MSI. +There is no command-in-data + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_MSI_CFG_ENABLE 1 +#define VIRTIO_TRANSPTQ_CTRL_MSI_CFG_DISABLE 0 +\end{lstlisting} + +\devicenormative{\subsubsection}{MSI Configuration}{Virtio Transport Options / Virtio +ver Transport Virtqueue / MSI Configuration} + +The managed device MUST disable the MSI interrupts for both virtqueues and config space +upon a reset. + +Once a MSI entry is disabled, the managed device MUST not send any interrupts +by this MSI entry. + +\drivernormative{\subsubsection}{MSI Configuration}{Virtio Transport Options / Virtio +Over Transport Virtqueue / MSI Configuration} + +The driver MUST allocate transport or platform specific MSI entries +for both virtqueues and config space if it wants to use interrupts. + +The driver MAY choose to disable the MSI if polling mode is used. + +\subsection{Virtqueue Address}\label{sec:Virtio Transport Options / Virtio Over +Transport Virtqueue / Virtqueue Address} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +the addresses of a specific virtqueue are accessed through the following command: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_VQ_ADDR 8 + #define VIRTIO_TRANSPTQ_CTRL_VQ_ADDR_SET 1 + +struct virtio_transportq_ctrl_vq_addr { + u16 queue_index; + u64 descriptor_area; + u64 device_area; + u64 driver_area; + u8 padding[6]; +}; +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_VQ_ADDR_SET command is used to set the addresses of a specified +virtqueue. The command-out-data contains the \field{queue_index}, the addresses of \field{device_area}, +\field{descriptor_area} and \field{driver_area} (as described in struct +virtio_transportq_ctrl_vq_addr). There's no command-in-data. + +\devicenormative{\subsubsection}{Virtqueue Address}{Virtio Transport Options / Virtio +Over Transport Virtqueue / Virtqueeu Address} + +The management device MUST fail the commands of class +VIRTIO_TRANSPTQ_CTRL_VQ_ADDR if \field{device_id} is 0. + +The management device MUST fail the commands of class +VIRTIO_TRANSPTQ_CTRL_VQ_ADDR if \field{queue_index} is out-of-range invalid. + +\subsection{Virtqueue Status}\label{sec:Virtio Transport Options / Virtio Over +Transport Virtqueue / Virtqueue Status} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +virtqueue status is accessed through the following command: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_VQ_ENABLE 9 + #define VIRTIO_TRANSPTQ_CTRL_VQ_ENABLE_GET 0 + #define VIRTIO_TRANSPTQ_CTRL_VQ_ENABLE_SET 1 + +struct virtio_transportq_ctrl_vq_status_set { + u16 queue_index; + u8 status; + u8 padding[5]; + +#define VIRTIO_TRANSPTQ_VQ_ENABLE 1 +#define VIRTIO_TRANSPTQ_VQ_DISABLE 0 + +}; + +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_VQ_ENABLE_GET is used to get the status of a +specific virtqueue. The command-out-data is the queue +index. The command-in-data is the virtqueue status. + +The VIRTIO_TRANSPTQ_CTRL_VQ_ENABLE_SET command is used to set the status of a +specific virtqueue. The command-out-data is the \field{queue_index} and the +\field{status} representing ENABLE or DISABLE that is set to the virtqueue +(as described in struct virtio_transportq_ctrl_vq_status_set). +There's no command-in-data. + +\devicenormative{\subsubsection}{Virtqueue Status}{Virtio Transport Options / Virtio +Over Transport Virtqueue / Virtqueue Status} + +When disabled, the managed device MUST stop processing requests from +this virtqueue. + +The management device MUST present a 0 via +VIRTIO_TRANSPTQ_CTRL_VQ_ENABLE_GET upon a reset of the managed device. + +The management device MUST fail the virtqueue status access if +\field{device_id} is 0. + +The management device MUST fail the virtqueue status access if +the queue_index is out-of-range invalid. + + +\drivernormative{\subsubsection}{Virtqueue Status}{Virtio Transport Options / Virtio +Over Transport Virtqueue / Virtqueue Status} + +The driver MUST configure other virtqueue fields before enabling +the virtqueue with VIRTIO_TRANSPTQ_CTRL_VQ_ENABLE_SET. + +\subsection{Virtqueue Size}\label{sec:Virtio Transport Options / Virtio Over +Transport Virtqueue / Virtqueue Size} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +virtqueue size is accessed through the following command: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_VQ_SIZE 10 + #define VIRTIO_TRANSPTQ_CTRL_VQ_SIZE_GET 0 + #define VIRTIO_TRANSPTQ_CTRL_VQ_SIZE_SET 1 + +struct virtio_transportq_ctrl_vq_size_set { + u16 queue_index; + u16 size; + u8 padding[4]; +}; +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_VQ_SIZE_GET command is used to get the virtqueue +size. On reset, the maximum queue size supported by the device is +returned. The command-out-data is the queue index. The +command-in-data is an 16-bit queue size. + +The VIRTIO_TRANSPTQ_CTRL_VQ_SIZE_SET command is used to set the virtqueue +size. The command-out-data is the \field{queue_index} and the \field{size} +of the virtqueue (as described in struct virtio_transportq_ctrl_vq_size_set). +There's no command-in-data. + +\devicenormative{\subsubsection}{Virtqueue Status}{Virtio Transport Options / Virtio +Over Transport Virtqueue / Virtqueue Size} + +The management device MUST fail the virtqueue size access if +\field{device_id} is 0. + +The management device MUST fail the virtqueue size access if +the queue index is out-of-range invalid. + +\subsection{Virtqueue Notification}\label{sec:Virtio Transport Options / Virtio +Over Transport Virtqueue / Virtqueue Notification} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +the virtqueue notification area information can be get through the following commands: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_VQ_NOTIFY 11 + #define VIRTIO_TRANSPTQ_CTRL_VQ_NOTIFY_GET 0 + +struct virtio_transportq_ctrl_vq_notification_area { + u64 address; + u64 size; +}; +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_VQ_NOTIFY_GET is used to get the transport +specific address area that can be used to notify a virtqueue. The +command-out-data is an u16 of the queue index. The command-in-data +contains the \field{address} and the \field{size} +of the notification area (as described in struct virtio_transportq_ctrl_vq_notification_area). + +\devicenormative{\subsubsection}{Virtqueue Notification}{Virtio Transport Options / +Virtio Over Transport Virtqueue / Virtqueue Notification} + +The management device MUST fail the virtqueue notification area information +access if \field{device_id} is 0. + +The management device MUST fail the virtqueue notification area information +access if the queue index is out-of-range invalid. + +\drivernormative{\subsubsection}{Virtqueue Notification}{Virtio Transport Options / +Virtio Over Transport Virtqueue / Virtqueue Notification} + +The driver MAY choose to notify the virtqueue by writing the queue +index at address \field{address} which is fetched from the +VIRTIO_TRANSPTQ_CTRL_VQ_NOTIFY_GET command. + +\subsection{Virtqueue State}\label{sec:Virtio Transport Options / Virtio +Over Transport Virtqueue / Virtqueue State} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +the virtqueue state is accessed through the following commands: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_VQ_STATE 12 + #define VIRTIO_TRANSPTQ_CTRL_VQ_STATE_GET 0 + #define VIRTIO_TRANSPTQ_CTRL_VQ_STATE_SET 1 +\end{lstlisting} + +\subsubsection{Split Virtqueue State}\label{sec:Virtio Transport Options / Virtio +Over Transport Virtqueue / Virtqueue State / Split Virtqueue State} + +\begin{lstlisting} +struct virtio_transportq_ctrl_split_vq_state_set { + u16 queue_index; + u16 avail_index; + u8 padding[4]; +}; +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_VQ_STATE_GET command can be used to get the state of a +split virtqueue. The command-out-data is the queue index, the command-in-data is the available index of the virtqueue. + +The VIRTIO_TRANSPTQ_CTRL_VQ_STATE_SET command can be used to set the state of a +split virtqueue. The command-out-data contains the \field{queue_index} and the +available index (\field{avail_index}) for the virtqueue (as described in struct virtio_transportq_ctrl_split_vq_state_set). +There is no command-in-data. + +\subsubsection{Packed Virtqueue State}\label{sec:Virtio Transport Options / Virtio +Over Transport Virtqueue / Virtqueue State / Packed Virtqueue State} + +\begin{lstlisting} +struct virtio_transportq_ctrl_packed_vq_state { + u16 queue_index; + u16 avail_counter; + u16 avail_index; + u16 used_counter; + u16 used_index; + u8 padding[6]; +}; +\end{lstlisting} + +The state of a packed virtqueue includes :\\ +\field{avail_counter}: last driver ring wrap counter observed by device.\\ +\field{avail_index}: virtqueue available index.\\ +\field{used_counter}: device ring wrap counter.\\ +\field{used_index}: virtqueue used index. + +The VIRTIO_TRANSPTQ_CTRL_VQ_STATE_GET command can be used to get the state of a packed virtqueue. +The command-out-data is the queue index, the command-in-data contains the \field{queue_index}, +\field{avail_counter}, \field{avail_index}, \field{used_counter} and \field{used_index} of the virtqueue +(as described in transportq_ctrl_packed_vq_state). + +The VIRTIO_TRANSPTQ_CTRL_VQ_STATE_SET command can be used to set the state of a packed virtqueue. +The command-out-data contains the \field{queue_index}, \field{avail_counter}, \field{avail_index}, +\field{used_counter} and \field{used_index} for the virtqueue +(as described in transportq_ctrl_packed_vq_state). +There is no command-in-data. + +\devicenormative{\subsubsection}{Virtqueue State}{Virtio Transport Options / +Virtio Over Transport Virtqueue / Virtqueue State} + +The management device MUST fail the virtqueue index access if \field{device_id} is 0. + +The management device MUST fail the virtqueue index access if \field{queue_index} is out-of-range invalid. + +\subsection{Virtqueue ASID}\label{sec:Virtio Transport Options / Virtio Over +Transport Virtqueue / Virtqueue ASID} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +the address space id of a virtqueue could be set through the following command: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_VQ_ASID 13 + #define VIRTIO_TRANSPTQ_CTRL_VQ_ASID_SET 1 + +struct virtio_transportq_ctrl_vq_asid_set { + u16 queue_index; + u32 asid; + u8 padding[2]; +}; +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_VQ_ASID_SET command is used to set the address space id(\field{asid}) +of a virtqueue. + +The address space id is an identifier of a memory space which is used to convey the address space targeted by the +memory accesses, and to distinguish memory accesses performed by different virtqueues + +One example of the address space id is PASID (Process Address Space Identifier) which is +defined in \hyperref[intro:PCIe]{[PCIe]} specification. + +The command-out-data of VIRTIO_TRANSPTQ_CTRL_VQ_ASID_SET command is the \field{queue_index} +and the address space id (\field{asid}). +(as described in struct virtio_transportq_ctrl_vq_asid_set). + +\devicenormative{\subsubsection}{Virtqueue ASID}{Virtio Transport Options / +Virtio Over Transport Virtqueue / Virtqueue ASID} + +Once a virtqueue has been set an asid, it MUST perform any memory accesses with the asid. + +The management device MUST fail the virtqueue index access if \field{device_id} is 0. + +The management device MUST fail the virtqueue index access if \field{queue_index} is out-of-range invalid. + +\subsection{Virtqueue Reset}\label{sec:Virtio Transport Options / Virtio Over +Transport Virtqueue / Virtqueue Reset} + +When VIRTIO_F_TRANSPT_VQ is negotiated with the management device, +a virtqueue can be reset through the following command: + +\begin{lstlisting} +#define VIRTIO_TRANSPTQ_CTRL_VQ_RESET 14 + #define VIRTIO_TRANSPTQ_CTRL_VQ_DO_RESET 1 +\end{lstlisting} + +The VIRTIO_TRANSPTQ_CTRL_VQ_DO_RESET command is used to reset a virtqueue. +The command-out-data is the virtqueue index, there is no command-in-data. + +\devicenormative{\subsubsection}{Virtqueue Reset}{Virtio Transport Options / +Virtio Over Transport Virtqueue / Virtqueue Reset} + +The management device MUST fail VIRTIO_TRANSPTQ_CTRL_VQ_RESET if +\field{device_id} is 0. + +The management device MUST fail VIRTIO_TRANSPTQ_CTRL_VQ_RESET if +the virtqueue index is out-of-range invalid. + +The managed device MUST stop consuming the descriptors in the virtqueue once reset it. + +The managed device MUST present default states of a virtqueue after reset it. + +\drivernormative{\subsubsection}{Virtqueue Reset}{Virtio Transport Options / +Virtio Over Transport Virtqueue / Virtqueue Reset} + +After reseting a virtqueue, the driver MUST wait until the reset is successfully +done (by verifying virtio_transportq_ctrl.ack == VIRTIO_TRANSPTQ_OK) +before re-enabling it. \chapter{Device Types}\label{sec:Device Types}
Signature · 1 line
2.35.3
PATCH v3 3/4 Describe the process to present a managed device
In reply to Zhu LingshanThis commit describes the process to present a manage device, including device creation, config and virtqueue config
--- content.tex | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+)
content.tex +37 -0
@@ -3613,6 +3613,43 @@ \subsection{Virtqueue Reset}\label{sec:Virtio Transport Options / Virtio Over done (by verifying virtio_transportq_ctrl.ack == VIRTIO_TRANSPTQ_OK) before re-enabling it. +\subsection{Presenting Managed Devices}\label{sec:Virtio Transport Options / +Virtio Over Transport Virtqueue / Presenting Managed Device} + +If VIRTIO_F_TRANSPT_VQ is negotiated with the management device. +The presenting of the managed devices requires cooperation between +the management device driver, the transport virtqueue and the managed device driver. + +The management device driver typically takes the following steps to create a +managed device: + +\begin{enumerate} +\item Determine the virtio device id and device specific configuration. +\item Create the managed devices by VIRTIO_TRANSPORTQ_CTRL_DEV_CREATE command. +\item Optionally, configure the MSI entries by VIRTIO_TRANSPTQ_CTRL_MSI class commands +\item The managed device driver probes the managed device. +\end{enumerate} + +The management device driver will then use the transport virtqueue to +process the requests from the managed device driver. + +Managed device setup performed by the managde device driver: +\begin{itemize*} +\item Features negotiation by VIRTIO_TRANSPTQ_CTRL_FEAT class commands. +\item Device status management by VIRTIO_TRANSPTQ_CTRL_STATUS class commands. +\item Device configuration space access by VIRTIO_TRANSPTQ_CTRL_CONFIG class commands. +\end{itemize*} + +Virtqueues setup performed by the managed driver: +\begin{itemize*} +\item Set the virtqueue address by VIRTIO_TRANSPTQ_CTRL_VQ_ADDR_SET command. +\item Set the virtqueue size by VIRTIO_TRANSPTQ_CTRL_VQ_SIZE class commands. +\item Get the virtqueue notification area by VIRTIO_TRANSPTQ_CTRL_VQ_NOTIFY_GET command. +\item Set the virtqueue state by VIRTIO_TRANSPTQ_CTRL_VQ_STATE_SET command. +\item Optionally, set virtqueue asid by VIRTIO_TRANSPTQ_CTRL_VQ_ASID_SET command. +\item Enable the virtqueue by VIRTIO_TRANSPTQ_CTRL_VQ_ENABLE_SET command. +\end{itemize*} + \chapter{Device Types}\label{sec:Device Types} On top of the queues, config space and feature negotiation facilities
Signature · 1 line
2.35.3
PATCH v3 4/4 Add transport vq number for virtio blk and net
In reply to Zhu LingshanThis commit add the queue number of the transport virtqueue for virtio_blk and virtio_net
--- content.tex | 6 ++++++ 1 file changed, 6 insertions(+)
content.tex +6 -0
@@ -3778,6 +3778,7 @@ \subsection{Virtqueues}\label{sec:Device Types / Network Device / Virtqueues} \item[2(N-1)] receiveqN \item[2(N-1)+1] transmitqN \item[2N] controlq +\item[2N+1] transportq \end{description} N=1 if neither VIRTIO_NET_F_MQ nor VIRTIO_NET_F_RSS are negotiated, otherwise N is set by
@@ -3785,6 +3786,8 @@ \subsection{Virtqueues}\label{sec:Device Types / Network Device / Virtqueues} controlq only exists if VIRTIO_NET_F_CTRL_VQ set. + transportq only exists if VIRTIO_F_TRANSPT_VQ set + \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits} \begin{description}
@@ -5364,11 +5367,14 @@ \subsection{Virtqueues}\label{sec:Device Types / Block Device / Virtqueues} \item[0] requestq1 \item[\ldots] \item[N-1] requestqN +\item[N] transportq \end{description} N=1 if VIRTIO_BLK_F_MQ is not negotiated, otherwise N is set by \field{num_queues}. + transportq only exists if VIRTIO_F_TRANSPT_VQ set. + \subsection{Feature bits}\label{sec:Device Types / Block Device / Feature bits} \begin{description}
Signature · 1 line
2.35.3