RE: [PATCH v17 00/11] Rename queue number to queue index

[Parav Pandit <parav@nvidia.com>]

> From: Parav Pandit <parav@nvidia.com>
> Sent: Thursday, May 4, 2023 9:46 PM
> 
> 1. Currently, virtqueue is identified between driver and device interchangeably
> using either number or index terminology.
> 
> 2. Between PCI and MMIO transport the queue size (depth) is defined as
> queue_size and QueueNum respectively.
> 
> To avoid confusion and to have consistency, unify them to use index.
> 
> 3. Field name vqn in the driver notification structure is ambiguous as it is
> supposed to hold either vq index or device supplied vq config data.
> 
> 4. Device is really supplying queue identifier or a opaque data in the
> queue_notify_data register, and this often get confused with very similar
> looking feature bit NOTIFICATION_DATA.
> 
> Solution:
> a. Use virtqueue index description, and rename MMIO register as QueueSize.
> b. Replace virtqueue number with virtqueue index c. RSS area of virtio net has
> inherited some logic, describe it using abstract rss_rq_id.
> d. rename queue_notifify_data to queue_notify_config_data.
> e. rename vqn to vq_notify_config_data to reflect it can hold either vq index of
> device supplied some id.
> 
> Patch summary:
> patch-1 introduce vq number as generic term
> patch-2 renames index to number for pci transport
> patch-3 rename queue_notify_data to queue_notify_config_data
> patch-4 remove first vq index reference
> patch-5 renames mmio register from Num to Size
> patch-6 renames index to number for mmio transport
> patch-7 renames num field to size for ccw transport
> patch-8 renames vq by its index for ccw transport
> patch-9 for virtio-net removes duplicate example from requirements
> patch-10 for virtio-net updates rss description to use vq index
> patch-11 for virtio-net to update cvq notifications coalescing commands
> 
> This series only improves the documentation, it does not change any transport
> or device functionality.
> 
> Please review.
> This series fixes the issue [1].
> 
> [1] https://github.com/oasis-tcs/virtio-spec/issues/163
> 
> ---
> changelog:
> v16->v17:
> - improved item name
> - dropped to itemize two normatives as it reads odd in the pdf at start

Can you please start the voting for this series?

I have updated the latest links in the github.
https://github.com/oasis-tcs/virtio-spec/issues/163