1. Currently, virtqueue is identified between driver and device interchangeably using either number of 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 as Number. Solution: a. Use virtqueue number description, and rename MMIO register as QueueSize. b. Replace virtqueue index to virtqueue number c. RSS area of virtio net has inherited some logic, describe it using abstract rq_handle. Patch summary: patch-1 introduce vq number as generic term patch-2 renames index to number for pci transport patch-3 renames mmio register from Num to Size patch-4 renames index to number for mmio transport patch-5 renames num field to size for ccw transport patch-6 renames index field to queue_select for ccw transport patch-7 for virtio-net removes duplicate example from requirements patch-8 for virtio-net updates rss description to use vq number 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: v6->v7: - remove text around first vq as it is already covered in the basic virtqueues facility section v5->v6: - moved the vq number description from middle of vq operation to beginning of vq introduction v4->v5: - fixed accidental removal of "unclassifed packets". - simplfied text around indirection_table mask - removed rss_rq_id references as indirection table and unclassified_queue data type is self explanatory v3->v4: - moved note to comment for ccw - renamed rq_handle to rss_rq_id - moved rss_rq_id next to rss_config structure - define rss_config structure using rss_rq_id v2->v3: - addressed comments from Michael - added previous definitions for ccw fields - moved rq_handle definition before using it - added first patch to describe vq number - updated pci for available buffer notification section v1->v2: - added patches for virtio net for rss area - added patches for covering ccw transport - added missing entries to refer in mmio transport Parav Pandit (8): content: Add vq number text transport-pci: Refer to the vq by its number transport-mmio: Rename QueueNum register transport-mmio: Refer to the vq by its number transport-ccw: Rename queue depth/size to other transports transport-ccw: Refer to the vq by its number virtio-net: Avoid duplicate receive queue example virtio-net: Describe RSS using rss rq id content.tex | 3 ++ device-types/net/description.tex | 28 ++++++++++---- transport-ccw.tex | 27 ++++++++------ transport-mmio.tex | 63 ++++++++++++++++++-------------- transport-pci.tex | 14 ++++--- 5 files changed, 82 insertions(+), 53 deletions(-) -- 2.26.2 --------------------------------------------------------------------- To unsubscribe, e-mail: virtio-dev-unsubscr...@lists.oasis-open.org For additional commands, e-mail: virtio-dev-h...@lists.oasis-open.org
