virtio-comment

Problem:

Current wording queue_msix_vector and config_msix_vector says
"for MSI-X", which is bit confusing.

config_msix_vector and queue_msix_vector are the msix vector
number for configuration change and queue related interrupts.

Hence, reword it.

---
changelog:
v2->v3:
- reword
v1->v2:
- rewrote to indicate MSI-X table entry index
v0->v1:
- added 'here'
- dropped 'receiving'
- dropped already merged patch for empty line


Parav Pandit (2):
transport-pci: Improve config msix vector description
transport-pci: Improve queue msix vector register desc

transport-pci.tex | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

--
2.26.2

config_msix_vector is the register that holds the MSI-X vector number
for receiving configuration change related interrupts.

It is not "for MSI-X".

Hence, replace the confusing text with appropriate one.

Reviewed-by: Max Gurtovoy <mgurtovoy@nvidia.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>

---
changelog:
v2->v3:
- rewrite
v1->v2:
- rewrote to indicate MSI-X table entry index
v0->v1:
- added 'here'
- dropped 'receiving'
---
transport-pci.tex | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/transport-pci.tex b/transport-pci.tex
index 5d98467..396bef7 100644
--- a/transport-pci.tex
+++ b/transport-pci.tex
@@ -343,7 +343,7 @@ \subsubsection{Common configuration structure layout}\label{sec:Virtio Transport
Driver Feature Bits selected by \field{driver_feature_select}.

\item[\field{config_msix_vector}]
- The driver sets the Configuration Vector for MSI-X.
+ Set by the driver to the MSI-X vector for configuration change notifications.

\item[\field{num_queues}]
The device specifies the maximum number of virtqueues supported here.
--
2.26.2

config_msix_vector is the register that holds the MSI-X vector number
for receiving configuration change related interrupts.

It is not "for MSI-X".

Hence, replace the confusing text with appropriate one.

Reviewed-by: Max Gurtovoy <mgurtovoy@nvidia.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>

---
changelog:
v2->v3:
- rewrite
v1->v2:
- rewrote to indicate MSI-X table entry index
v0->v1:
- added 'here'
- dropped 'receiving'
---
transport-pci.tex | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/transport-pci.tex b/transport-pci.tex
index 5d98467..396bef7 100644
--- a/transport-pci.tex
+++ b/transport-pci.tex
@@ -343,7 +343,7 @@ \subsubsection{Common configuration structure layout}\label{sec:Virtio Transport
Driver Feature Bits selected by \field{driver_feature_select}.

\item[\field{config_msix_vector}]
- The driver sets the Configuration Vector for MSI-X.
+ Set by the driver to the MSI-X vector for configuration change notifications.

\item[\field{num_queues}]
The device specifies the maximum number of virtqueues supported here.
--
2.26.2

queue_msix_vector register is for receiving virtqueue notification
interrupts from the device for the virtqueue.

"for MSI-X" is confusing term.

Also it is the register that driver "writes" to, similar to
many other registers such as queue_desc, queue_driver etc.

Hence, replace the verb from use to write.

Signed-off-by: Parav Pandit <parav@nvidia.com>
Reviewed-by: Max Gurtovoy <mgurtovoy@nvidia.com>
---
changelog:
v2->v3:
- rewrite
v1->v2:
- rewrote to indicate MSI-X table entry index
v0->v1:
- added 'here'
- dropped 'receiving'
---
transport-pci.tex | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/transport-pci.tex b/transport-pci.tex
index 396bef7..524bfff 100644
--- a/transport-pci.tex
+++ b/transport-pci.tex
@@ -366,7 +366,7 @@ \subsubsection{Common configuration structure layout}\label{sec:Virtio Transport
A 0 means the queue is unavailable.

\item[\field{queue_msix_vector}]
- The driver uses this to specify the queue vector for MSI-X.
+ Set by the driver to the MSI-X vector for virtqueue notifications.

\item[\field{queue_enable}]
The driver uses this to selectively prevent the device from executing requests from this virtqueue.
--
2.26.2

queue_msix_vector register is for receiving virtqueue notification
interrupts from the device for the virtqueue.

"for MSI-X" is confusing term.

Also it is the register that driver "writes" to, similar to
many other registers such as queue_desc, queue_driver etc.

Hence, replace the verb from use to write.

Signed-off-by: Parav Pandit <parav@nvidia.com>
Reviewed-by: Max Gurtovoy <mgurtovoy@nvidia.com>
---
changelog:
v2->v3:
- rewrite
v1->v2:
- rewrote to indicate MSI-X table entry index
v0->v1:
- added 'here'
- dropped 'receiving'
---
transport-pci.tex | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/transport-pci.tex b/transport-pci.tex
index 396bef7..524bfff 100644
--- a/transport-pci.tex
+++ b/transport-pci.tex
@@ -366,7 +366,7 @@ \subsubsection{Common configuration structure layout}\label{sec:Virtio Transport
A 0 means the queue is unavailable.

\item[\field{queue_msix_vector}]
- The driver uses this to specify the queue vector for MSI-X.
+ Set by the driver to the MSI-X vector for virtqueue notifications.

\item[\field{queue_enable}]
The driver uses this to selectively prevent the device from executing requests from this virtqueue.
--
2.26.2

On Fri, Apr 21, 2023 at 05:54:32PM +0300, Parav Pandit wrote:
> Problem:
>
> Current wording queue_msix_vector and config_msix_vector says
> "for MSI-X", which is bit confusing.
>
> config_msix_vector and queue_msix_vector are the msix vector
> number for configuration change and queue related interrupts.
>
> Hence, reword it.

LGTM.
Given the amount of back and forth, I guess we should vote.

> ---
> changelog:
> v2->v3:
> - reword
> v1->v2:
> - rewrote to indicate MSI-X table entry index
> v0->v1:
> - added 'here'
> - dropped 'receiving'
> - dropped already merged patch for empty line
>
>
> Parav Pandit (2):
> transport-pci: Improve config msix vector description
> transport-pci: Improve queue msix vector register desc
>
> transport-pci.tex | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> --
> 2.26.2

> From: Michael S. Tsirkin <mst@redhat.com>
> Sent: Saturday, April 22, 2023 6:11 AM
>
> On Fri, Apr 21, 2023 at 05:54:32PM +0300, Parav Pandit wrote:
> > Problem:
> >
> > Current wording queue_msix_vector and config_msix_vector says "for
> > MSI-X", which is bit confusing.
> >
> > config_msix_vector and queue_msix_vector are the msix vector number
> > for configuration change and queue related interrupts.
> >
> > Hence, reword it.
>
> LGTM.
> Given the amount of back and forth, I guess we should vote.
>
Ok. created github at [1].
Will wait for few more days to ask for vote for any other review comments.

[1] https://github.com/oasis-tcs/virtio-spec/issues/169

> From: Michael S. Tsirkin <mst@redhat.com>
> Sent: Saturday, April 22, 2023 6:11 AM
>
> On Fri, Apr 21, 2023 at 05:54:32PM +0300, Parav Pandit wrote:
> > Problem:
> >
> > Current wording queue_msix_vector and config_msix_vector says "for
> > MSI-X", which is bit confusing.
> >
> > config_msix_vector and queue_msix_vector are the msix vector number
> > for configuration change and queue related interrupts.
> >
> > Hence, reword it.
>
> LGTM.
> Given the amount of back and forth, I guess we should vote.
>
Ok. created github at [1].
Will wait for few more days to ask for vote for any other review comments.

[1] https://github.com/oasis-tcs/virtio-spec/issues/169

On Fri, Apr 21, 2023 at 05:54:32PM +0300, Parav Pandit wrote:
> Problem:
>
> Current wording queue_msix_vector and config_msix_vector says
> "for MSI-X", which is bit confusing.
>
> config_msix_vector and queue_msix_vector are the msix vector
> number for configuration change and queue related interrupts.
>
> Hence, reword it.

LGTM.
Given the amount of back and forth, I guess we should vote.

> ---
> changelog:
> v2->v3:
> - reword
> v1->v2:
> - rewrote to indicate MSI-X table entry index
> v0->v1:
> - added 'here'
> - dropped 'receiving'
> - dropped already merged patch for empty line
>
>
> Parav Pandit (2):
> transport-pci: Improve config msix vector description
> transport-pci: Improve queue msix vector register desc
>
> transport-pci.tex | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> --
> 2.26.2