[virtio] [PATCH v2] virtio_pci_cap64: bar/BAR cleanups

[virtio] [PATCH v2] virtio_pci_cap64: bar/BAR cleanups

[Michael S. Tsirkin]

When we mean PCI register we should say BAR.
When we mean a virtio config register we should say \field{cap.bar}.

Finally, offset_hi/length_hi are not within the cap structure.

Tweak wording slightly: "A,B,C" are fields, there's no need
to say that.

Reported-by: Christophe de Dinechin <cdupontd@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
---

changes from v1:
	minor wording tweak

 content.tex | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/content.tex b/content.tex
index f808c61..a7f4f27 100644
--- a/content.tex
+++ b/content.tex
@@ -765,7 +765,7 @@ \subsection{Virtio Structure PCI Capabilities}\label{sec:Virtio Transport Option
 Given that the \field{cap.length} and \field{cap.offset} fields
 are only 32 bit, the additional \field{offset_hi} and \field {length_hi}
 fields provide the most significant 32 bits of a total 64 bit offset and
-length within the bar specified by \field{cap.bar}.
+length within the BAR specified by \field{cap.bar}.
 
 \drivernormative{\subsubsection}{Virtio Structure PCI Capabilities}{Virtio Transport Options / Virtio Over PCI Bus / Virtio Structure PCI Capabilities}
 
@@ -1095,9 +1095,9 @@ \subsubsection{Shared memory capability}\label{sec:Virtio Transport Options / Vi
 
 \devicenormative{\paragraph}{Device-specific configuration}{Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Shared memory capability}
 
-The region defined by the combination of the \field {cap.offset},
-\field {cap.offset_hi}, and \field {cap.length}, \field
-{cap.length_hi} fields MUST be contained within the declared bar.
+The region defined by the combination of \field{cap.offset},
+\field{offset_hi}, and \field {cap.length}, \field{length_hi}
+MUST be contained within the BAR specified by \field{cap.bar}.
 
 The \field{cap.id} MUST be unique for any one device instance.
 
-- 
MST


---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that 
generates this mail.  Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php 

Re: [virtio] [PATCH v2] virtio_pci_cap64: bar/BAR cleanups

[Cornelia Huck]

On Wed, 27 Nov 2019 16:33:07 -0500
"Michael S. Tsirkin" <mst@redhat.com> wrote:

> When we mean PCI register we should say BAR.
> When we mean a virtio config register we should say \field{cap.bar}.
> 
> Finally, offset_hi/length_hi are not within the cap structure.
> 
> Tweak wording slightly: "A,B,C" are fields, there's no need
> to say that.
> 
> Reported-by: Christophe de Dinechin <cdupontd@redhat.com>
> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
> ---
> 
> changes from v1:
> 	minor wording tweak
> 
>  content.tex | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)

Reviewed-by: Cornelia Huck <cohuck@redhat.com>


---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that 
generates this mail.  Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php