From 298278d34b44935768c4e63b010f3c89ddf34580 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Sun, 15 Mar 2015 11:10:13 +0000 Subject: cl: move out cs02 changelog start adding one for cs03 Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@482 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 58 ++++++++-------------------------------------------------- 1 file changed, 8 insertions(+), 50 deletions(-) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 61aa6fd..9abd1f4 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -1,52 +1,10 @@ -448 & 22 Dec 2014 & Michael S. Tsirkin & {VIRTIO-120: virtio: -fix used element size - -General ring description lists size for -used ring elements as 4, it must be 8. - -See \ref{sec:Basic Facilities of a Virtio Device / Virtqueues}. - } \\ -\hline -449 & 22 Doc 2014 & Cornelia Huck & {VIRTIO-125: block: fixup section levels - The specification for the configuration layout for block devices - should be its own subsection as for all other devices and not be - hidden beneath "Feature bits". - - The normative sections for device operation should appear under - the device operation section. -See \ref{sec:Device Types / Block Device / Device configuration -layout}. - } \\ -\hline -450 & 22 Dec 2014 & Cornelia Huck & {VIRTIO-127: ccw: two-stage -indicators for legacy devices - - Some legacy devices will support two-stage queue indicators -and therefore - won't reject CCW_CMD_SET_IND_ADAPTER. Note this. - -See \ref{sec:Virtio Transport Options / Virtio over channel I/O / -Device Initialization / Setting Up Indicators / Legacy -Interfaces: A Note on Setting Up Indicators}. +478 & 15 Mar 2015 & Cornelia Huck & {VIRTIO-129: legacy: +clean up virtqueue layout definitions + +Generalize "Legacy Interfaces: A Note on Virtqueue Layout" to allow +for different alignment requirements. Have pci and ccw refer to that +section for legacy devices. Remove the double definition of virtqueue +alignment (which referred to legacy, but was not tagged as such) from +the ccw section. } \\ \hline -452 & 22 Dec 2014 & Michael S. Tsirkin & {VIRTIO-115: -formatting: escape {\textbackslash}ldots in lstlisting - - {\textbackslash}ldots does not work within lstlisting, the result is - {\textbackslash}ldots verbatim in the PDF output. - - To fix, make \$ an escape character, and escape the sequence: - \${\textbackslash}ldots\$ - -See \ref{sec:Device Types / SCSI Host Device / Device Operation / -Device Operation: controlq}. -} \\ -\hline -455,457 & 23 Dec 2014 & Michael S. Tsirkin & {acknowledgements: acknowledge dgilbert - - Acknowledge David Alan Gilbert for reporting VIRTIO-120. - -See \ref{chap:Acknowledgements}. -} \\ -\hline -- cgit v1.2.3 From 27e14c7cea0fc4f1e25d8b44cde3d282bc46a020 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:07:22 +0000 Subject: cl: drop contents temporarily This is helpful for diff generation. Will re-add shortly. Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@489 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 10 ---------- 1 file changed, 10 deletions(-) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 9abd1f4..e69de29 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -1,10 +0,0 @@ -478 & 15 Mar 2015 & Cornelia Huck & {VIRTIO-129: legacy: -clean up virtqueue layout definitions - -Generalize "Legacy Interfaces: A Note on Virtqueue Layout" to allow -for different alignment requirements. Have pci and ccw refer to that -section for legacy devices. Remove the double definition of virtqueue -alignment (which referred to legacy, but was not tagged as such) from -the ccw section. - } \\ -\hline -- cgit v1.2.3 From b03b5688eea99b40ac8a83589f28be30746ab841 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:08:14 +0000 Subject: cl: list virtio-129 This reverts commit de1e7c191a168195f67aa5259603f83264b35e28. Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@492 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index e69de29..9abd1f4 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -0,0 +1,10 @@ +478 & 15 Mar 2015 & Cornelia Huck & {VIRTIO-129: legacy: +clean up virtqueue layout definitions + +Generalize "Legacy Interfaces: A Note on Virtqueue Layout" to allow +for different alignment requirements. Have pci and ccw refer to that +section for legacy devices. Remove the double definition of virtqueue +alignment (which referred to legacy, but was not tagged as such) from +the ccw section. + } \\ +\hline -- cgit v1.2.3 From 76341d2a6a45b36fa49dc0d1c0ba1a8e0a383522 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:08:32 +0000 Subject: cl: list virtio-116 change Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@493 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 9abd1f4..a4dbbee 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -8,3 +8,13 @@ alignment (which referred to legacy, but was not tagged as such) from the ccw section. } \\ \hline +479 & 15 Mar 2015 & Cornelia Huck & {VIRTIO-116: +ccw: allow WRITE_STATUS to fail + +We want to be able to fail setting a status on the device +(e.g. FEATURES_OK if the device can't work with the features +negotiated). +The easiest way to do that is to allow the device to fail the +WRITE_STATUS command by posting a command reject. + } \\ +\hline -- cgit v1.2.3 From 4c2ad7e26fae8f3e3ddf5f53b4ddafb9012ba4a1 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:08:50 +0000 Subject: cl: list more changes Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@494 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index a4dbbee..4648156 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -6,6 +6,8 @@ for different alignment requirements. Have pci and ccw refer to that section for legacy devices. Remove the double definition of virtqueue alignment (which referred to legacy, but was not tagged as such) from the ccw section. +See \ref{ +}. } \\ \hline 479 & 15 Mar 2015 & Cornelia Huck & {VIRTIO-116: @@ -16,5 +18,26 @@ We want to be able to fail setting a status on the device negotiated). The easiest way to do that is to allow the device to fail the WRITE_STATUS command by posting a command reject. +See \ref{ +}. + } \\ +\hline +485 & 15 Mar 2015 & Jason Wang & {VIRTIO-135: +virtio-ring: comment fixup + +virtio_ring.h included with spec has this text: +/* Support for avail_idx and used_idx fields */ +it should really refer to avail_event and used_event. +See \ref{ +}. + } \\ +\hline +486 & 15 Mar 2015 & Jason Wang & {VIRTIO-136: +document idx field in virtqueue used ring + +Section 2.4.8 The Virtqueue Used Ring +lists the idx field, but never documents it. +See \ref{ +}. } \\ \hline -- cgit v1.2.3 From 86ef23688f7091a0fb00177ffe4e26ed0138d969 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:09:46 +0000 Subject: cl: add cross-references to changes since cs02 Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@497 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 4648156..084e327 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -6,8 +6,14 @@ for different alignment requirements. Have pci and ccw refer to that section for legacy devices. Remove the double definition of virtqueue alignment (which referred to legacy, but was not tagged as such) from the ccw section. -See \ref{ -}. +See \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / +Legacy Interfaces: A Note on Virtqueue Layout}, \ref{sec:Virtio +Transport Options / Virtio Over PCI Bus / PCI-specific +Initialization And Device Operation / Device Initialization / +Virtqueue Configuration / Legacy Interface: A Note on Virtqueue +Configuration} and \ref{sec:Virtio Transport Options / Virtio +over channel I/O / Device Initialization / Configuring a +Virtqueue / Legacy Interface: A Note on Configuring a Virtqueue}. } \\ \hline 479 & 15 Mar 2015 & Cornelia Huck & {VIRTIO-116: @@ -18,8 +24,8 @@ We want to be able to fail setting a status on the device negotiated). The easiest way to do that is to allow the device to fail the WRITE_STATUS command by posting a command reject. -See \ref{ -}. +See \ref{sec:Virtio Transport Options / Virtio over channel I/O / +Device Initialization / Communicating Status Information}. } \\ \hline 485 & 15 Mar 2015 & Jason Wang & {VIRTIO-135: @@ -28,16 +34,16 @@ virtio-ring: comment fixup virtio_ring.h included with spec has this text: /* Support for avail_idx and used_idx fields */ it should really refer to avail_event and used_event. -See \ref{ -}. +See \ref{sec:virtio-ring.h}. } \\ \hline 486 & 15 Mar 2015 & Jason Wang & {VIRTIO-136: document idx field in virtqueue used ring -Section 2.4.8 The Virtqueue Used Ring -lists the idx field, but never documents it. -See \ref{ -}. +Section \ref{sec:Basic Facilities of a Virtio Device / Virtqueues +/ The Virtqueue Used Ring} The Virtqueue Used Ring +listed the idx field, but never documented it. +See \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / +The Virtqueue Used Ring}. } \\ \hline -- cgit v1.2.3 From 6e7b2573da4f83dabb8b0add0f56751ca088bc85 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:10:25 +0000 Subject: cl: tweak changelog slightly Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@499 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 084e327..08aea99 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -34,7 +34,7 @@ virtio-ring: comment fixup virtio_ring.h included with spec has this text: /* Support for avail_idx and used_idx fields */ it should really refer to avail_event and used_event. -See \ref{sec:virtio-ring.h}. +See Appendix \ref{sec:virtio-ring.h}. } \\ \hline 486 & 15 Mar 2015 & Jason Wang & {VIRTIO-136: -- cgit v1.2.3 From 8bce9fca4ad831d618b9e5d56ab5ce078bbbc29f Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:10:43 +0000 Subject: cl: add more changelog text Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@500 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 08aea99..05c1f16 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -16,6 +16,15 @@ over channel I/O / Device Initialization / Configuring a Virtqueue / Legacy Interface: A Note on Configuring a Virtqueue}. } \\ \hline +479 & 15 Mar 2015 & Cornelia Huck & {VIRTIO-118: +ccw: clarify basic channel commands + +"Basic channel commands" seems to be not as clear as it +could, so let's spell out which channel commands we refer to. +See \ref{sec:Virtio Transport Options / Virtio over channel I/O / +Basic Concepts}. +} \\ +\hline 479 & 15 Mar 2015 & Cornelia Huck & {VIRTIO-116: ccw: allow WRITE_STATUS to fail -- cgit v1.2.3 From 930364b1f7237263fc4ef47157cd10b65b08daf6 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:11:02 +0000 Subject: cl: list virtio-130 Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@501 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 05c1f16..64a83a7 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -56,3 +56,17 @@ See \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}. } \\ \hline +486 & 15 Mar 2015 & Rusty Russell & {VIRTIO-130: +ISR status: Fix incorrect diagram + +ISR status capability diagram has the "Device Configuration +Interrupt " as bit 0, and the "Queue Interrupt" as bit 1. This is +the wrong way around: it disagrees with the legacy +implementations, as well as the spec elsewhere. + +All current guests correctly follow the text, fix +up the diagram to match. +See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI +Device Layout / ISR status capability}. + } \\ +\hline -- cgit v1.2.3 From 54f331fd3460295cf5c2c2264a3c0346818adf7d Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:11:19 +0000 Subject: cl: add virtio-133 Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@502 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 64a83a7..4f16391 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -70,3 +70,16 @@ See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / ISR status capability}. } \\ \hline +486 & 15 Mar 2015 & Rusty Russell & {VIRTIO-133: +Change 4.1.5.1.2.1 to device requirement + +4.1.5.1.2.1 is incorrectly labelled as a driver requirement; it's +self-evidently referring to the device. +See \ref{sec:Conformance / Driver Conformance / PCI Driver +Conformance}, \ref{sec:Conformance / Device Conformance / PCI +Device Conformance} and \ref{devicenormative:Virtio +Transport Options / Virtio Over PCI Bus / PCI-specific +Initialization And Device Operation / Device Initialization / +Non-transitional Device With Legacy Driver}. + } \\ +\hline -- cgit v1.2.3 From 37648703597b09fa2db9a3db77504e41608ff3c4 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 25 Mar 2015 17:11:36 +0000 Subject: cl: tweak revisions Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@503 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 4f16391..05b6dfa 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -56,7 +56,7 @@ See \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}. } \\ \hline -486 & 15 Mar 2015 & Rusty Russell & {VIRTIO-130: +487 & 15 Mar 2015 & Rusty Russell & {VIRTIO-130: ISR status: Fix incorrect diagram ISR status capability diagram has the "Device Configuration @@ -70,7 +70,7 @@ See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / ISR status capability}. } \\ \hline -486 & 15 Mar 2015 & Rusty Russell & {VIRTIO-133: +488 & 15 Mar 2015 & Rusty Russell & {VIRTIO-133: Change 4.1.5.1.2.1 to device requirement 4.1.5.1.2.1 is incorrectly labelled as a driver requirement; it's -- cgit v1.2.3 From e0ce988563106c29a5d88219b92ee63eb79a8cc7 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 22 Apr 2015 11:25:38 +0000 Subject: cl: document VIRTIO-137 Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@513 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 05b6dfa..6ae3180 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -83,3 +83,29 @@ Initialization And Device Operation / Device Initialization / Non-transitional Device With Legacy Driver}. } \\ \hline +504 & 22 Apr 2015 & Rusty Russell & {VIRTIO-137: +define the meaning and requirements of the len field. + +We said what it was for, and noted why. We didn't place any +requirements on it, nor clearly spell out the implications of its use. + +This clarification comes particularly from noticing that QEMU +didn't set len correctly, and philosophising over the correct value +when an error has occurred. +See \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / +The Virtqueue Used Ring}, \ref{devicenormative:Basic Facilities +of a Virtio Device / Virtqueues / The Virtqueue Used Ring} and +\ref{sec:Basic Facilities of a Virtio Device / Virtqueues / The +Virtqueue Used Ring}. + } \\ +\hline +510 & 22 Apr 2015 & Michael Tsirkin & {conformance: +add VIRTIO-137 statement links + +Add links to new conformance statements added to +resolve VIRTIO-137 (describing used ring entry len usage). + +See \ref{sec:Conformance / Device Conformance} +and \ref{sec:Conformance / Driver Conformance}. + } \\ +\hline -- cgit v1.2.3 From 8aae5034956b183536aae59586541a783e78c4e4 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 22 Apr 2015 11:25:58 +0000 Subject: cl: document r508: VIRTIO-139 Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@514 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 6ae3180..5278658 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -99,6 +99,26 @@ of a Virtio Device / Virtqueues / The Virtqueue Used Ring} and Virtqueue Used Ring}. } \\ \hline +508 & 22 Apr 2015 & Michael Tsirkin & {VIRTIO-139: +pci: missing documentation for dealing with 64 bit config fields + +pci spec says what width access to use for 32, 16 and 8 +bit fields, but does not explicitly say what to do for +32 bit fields. As we have text that says driver must +treat 64 bit accesses as non-atomic, this seems +to imply driver should always do two 32 bit wide accesses. + +Let's make this an explicit requirement, and require +devices to support this. + +See \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI +Device Layout}, \ref{drivernormative:Virtio Transport Options / +Virtio Over PCI Bus / PCI Device Layout}, +\ref{devicenormative:Virtio Transport Options / Virtio Over PCI +Bus / PCI Device Layout} and \ref{sec:Conformance / Driver +Conformance / PCI Driver Conformance}. + } \\ +\hline 510 & 22 Apr 2015 & Michael Tsirkin & {conformance: add VIRTIO-137 statement links -- cgit v1.2.3 From 29b3906c61385501ec846d5163cabf1bcc32b73f Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 22 Apr 2015 11:26:17 +0000 Subject: cl: list r506 and VIRTIO-138 Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@515 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 5278658..ffa3601 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -99,6 +99,38 @@ of a Virtio Device / Virtqueues / The Virtqueue Used Ring} and Virtqueue Used Ring}. } \\ \hline +506 & 22 Apr 2015 & Michael Tsirkin & {VIRTIO-138: +multiple errors: Non-transitional With Legacy + +virtio 1.0 has two sections titled "Non-transitional Device With +Legacy Driver" the first says devices SHOULD fail, the second +says devices MUST fail. Clearly a mistake. + +Other issues: devices don't really fail - they cause drivers to +fail. second section seems to be in the wrong place, and also +have a section followed by subsection with no explanatory text in +between, which is ugly. +Finally, this text was originally ritten to handle buggy windows +drivers gracefully, but later we changed device IDs so it's not +really required there. Might be handy for some other buggy legacy +drivers, though no such drivers are known. + +To fix, drop the duplicate section variant, add some explanatory +text, clarify what does "same ID" mean here, and clarify +that the work-around is only needed if a buggy driver +is known to bind to a transitional device. + +See \ref{sec:Virtio Transport Options / Virtio +Over PCI Bus / PCI Device Layout / Non-transitional Device With +Legacy Driver: A Note on PCI Device Layout}, +\ref{devicenormative:Virtio Transport Options / Virtio Over PCI +Bus / PCI-specific Initialization And Device Operation / Device +Initialization / Non-transitional Device With Legacy Driver} and +\ref{sec:Virtio Transport Options / Virtio Over PCI Bus / +PCI-specific Initialization And Device Operation / Device +Initialization}. +} \\ +\hline 508 & 22 Apr 2015 & Michael Tsirkin & {VIRTIO-139: pci: missing documentation for dealing with 64 bit config fields -- cgit v1.2.3 From 4a135df4116c17baf70e222b20eeabfba4b3c53d Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 22 Apr 2015 11:26:37 +0000 Subject: cl: document r509 wording tweak in balloon. Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@516 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index ffa3601..c744dbb 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -151,6 +151,16 @@ Bus / PCI Device Layout} and \ref{sec:Conformance / Driver Conformance / PCI Driver Conformance}. } \\ \hline +509 & 22 Apr 2015 & Michael Tsirkin & {balloon: +MUST -> has to + +MUST shouldn't be used outside normative statements, +that's confusing. Replace with "has to". + +See \ref{sec:Device Types / Memory Balloon Device / Feature +bits}. + } \\ +\hline 510 & 22 Apr 2015 & Michael Tsirkin & {conformance: add VIRTIO-137 statement links -- cgit v1.2.3 From 1a776d986d1b9ebe6bb5c5bb757be81bd3bf2e86 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 22 Apr 2015 11:32:25 +0000 Subject: cl: document r517 Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@518 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index c744dbb..a201f90 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -171,3 +171,12 @@ See \ref{sec:Conformance / Device Conformance} and \ref{sec:Conformance / Driver Conformance}. } \\ \hline +517 & 22 Apr 2015 & Michael Tsirkin & {acknowledgements: +contributors+minor fixup + +acknowledge feedback by Jason Wang, add Richard Sohn who +joined the TC, sort acknowledged reviewers alphabetically. + +See \ref{chap:Acknowledgements}. +} \\ +\hline -- cgit v1.2.3 From 4ce541760523e7e1dba274d4e0c98473d93f61c0 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 22 Apr 2015 11:32:51 +0000 Subject: cl: fix name for MST Should be Michael S. Tsirkin, not Michael Tsirkin. Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@519 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index a201f90..1a6f799 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -99,7 +99,7 @@ of a Virtio Device / Virtqueues / The Virtqueue Used Ring} and Virtqueue Used Ring}. } \\ \hline -506 & 22 Apr 2015 & Michael Tsirkin & {VIRTIO-138: +506 & 22 Apr 2015 & Michael S. Tsirkin & {VIRTIO-138: multiple errors: Non-transitional With Legacy virtio 1.0 has two sections titled "Non-transitional Device With @@ -131,7 +131,7 @@ PCI-specific Initialization And Device Operation / Device Initialization}. } \\ \hline -508 & 22 Apr 2015 & Michael Tsirkin & {VIRTIO-139: +508 & 22 Apr 2015 & Michael S. Tsirkin & {VIRTIO-139: pci: missing documentation for dealing with 64 bit config fields pci spec says what width access to use for 32, 16 and 8 @@ -151,7 +151,7 @@ Bus / PCI Device Layout} and \ref{sec:Conformance / Driver Conformance / PCI Driver Conformance}. } \\ \hline -509 & 22 Apr 2015 & Michael Tsirkin & {balloon: +509 & 22 Apr 2015 & Michael S. Tsirkin & {balloon: MUST -> has to MUST shouldn't be used outside normative statements, @@ -161,7 +161,7 @@ See \ref{sec:Device Types / Memory Balloon Device / Feature bits}. } \\ \hline -510 & 22 Apr 2015 & Michael Tsirkin & {conformance: +510 & 22 Apr 2015 & Michael S. Tsirkin & {conformance: add VIRTIO-137 statement links Add links to new conformance statements added to @@ -171,7 +171,7 @@ See \ref{sec:Conformance / Device Conformance} and \ref{sec:Conformance / Driver Conformance}. } \\ \hline -517 & 22 Apr 2015 & Michael Tsirkin & {acknowledgements: +517 & 22 Apr 2015 & Michael S. Tsirkin & {acknowledgements: contributors+minor fixup acknowledge feedback by Jason Wang, add Richard Sohn who -- cgit v1.2.3 From c6f96d66e73a132172d186fd57d468b87a86ec56 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Wed, 29 Apr 2015 11:10:14 +0000 Subject: cl: document VIRTIO-134, VIRTIO-140, VIRTIO-141, VIRTIO-142 document changes made by commits r520 to r523 inclusive Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@525 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index 1a6f799..ee65be3 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -180,3 +180,63 @@ joined the TC, sort acknowledged reviewers alphabetically. See \ref{chap:Acknowledgements}. } \\ \hline +520 & 30 Apr 2015 & James Bottomley & {VIRTIO-140: +give explicit guidance on the use of 64 bit fields + +Just saying 64 bit fields may not be atomic is true, but less +helpful than it might be. Add explicit guidance about what the +consequences of non-atomicity are. + +See \ref{sec:Creating New Device Types / What Device +Configuration Space Layout?} +} \\ +\hline +521 & 30 Apr 2015 & Rusty Russell & {VIRTIO-134: +Spell out details of indirect elements in chains + +1) It's implied that a chain terminates with an indirect descriptor (since +VIRTIO-15) but we didn't spell out that a device MUST NOT +continue it. + +2) We allow [direct]->[direct]->[indirect], and qemu and +bhyve both accept it. Make it clear that this is valid, thus devices MUST +handle it. + +See \ref{drivernormative:Basic Facilities of a Virtio Device / +Virtqueues / The Virtqueue Descriptor Table / Indirect +Descriptors} and \ref{devicenormative:Basic Facilities of a +Virtio Device / Virtqueues / The Virtqueue Descriptor Table / +Indirect Descriptors} +} \\ +\hline +522 & 30 Apr 2015 & Michael S. Tsirkin & {VIRTIO-141: +used ring: specify legacy behaviour for len field + +many hypervisors implemented len field incorrectly. +Document existing bugs in the legacy sections. + +See \ref{sec:Basic Facilities of a Virtio Device / Virtqueues +/ The Virtqueue Used Ring/ Legacy Interface: The Virtqueue Used +Ring}, \ref{sec:Device Types / Network Device / Device Operation +/ Legacy Interface: Device Operation}, \ref{sec:Device Types / +Block Device / Device Operation / Legacy Interface: Device +Operation}, \ref{sec:Device Types / Console Device / Device +Operation / Legacy Interface: Device Operation}, \ref{sec:Device +Types / Memory Balloon Device / Device Operation / Legacy +Interface: Device Operation}, \ref{sec:Device +Types / SCSI Host Device / Device Operation / Legacy +Interface: Device Operation} and \ref{sec:Conformance / Legacy +Interface: Transitional Device and Transitional Driver +Conformance}. +} \\ +\hline +523 & 30 Apr 2015 & Michael S. Tsirkin & {VIRTIO-142: +entropy device: typo fix + +Current text: "The driver MUST examine the length written by the +driver" makes no sense. length is written by the device. + +See \ref{drivernormative:Device Types / Entropy Device / Device +Operation}. +} \\ +\hline -- cgit v1.2.3 From 12527ecbbe4f6b4b5fabfe35d45bc2ce71650d62 Mon Sep 17 00:00:00 2001 From: mstsirkin Date: Thu, 21 May 2015 10:12:25 +0000 Subject: cl-os: VIRTIO-123, VIRTIO-124, VIRTIO-126, VIRTIO-143 Document resolutions to VIRTIO-123, VIRTIO-124, VIRTIO-126 and VIRTIO-143. Signed-off-by: Michael S. Tsirkin git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@531 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652 --- cl-os.tex | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) (limited to 'cl-os.tex') diff --git a/cl-os.tex b/cl-os.tex index ee65be3..ab26d64 100644 --- a/cl-os.tex +++ b/cl-os.tex @@ -240,3 +240,89 @@ See \ref{drivernormative:Device Types / Entropy Device / Device Operation}. } \\ \hline +526 & 18 May 2015 & Michael S. Tsirkin & {VIRTIO-143: +balloon: transitional device support + +Support a transitional balloon device: this has the advantage of supporting +existing drivers, transparently, as well as transports that don't allow mixing +virtio 0 and virtio 1 devices. And balloon is an easy device to test, so it's +also useful for people to test virtio core handling of transitional devices. + +Three issues with legacy hypervisors have been identified: +\begin{enumerate} +\item +Actual value is actually used, and is necessary for management +to work. Luckily 4 byte config space writes are now atomic. +When using old guests, hypervisors can detect access to the last byte. +When using old hypervisors, drivers can use atomic 4-byte accesses. +\item Hypervisors actually didn't ignore the stats from the first +buffer supplied. This means the values there would be +incorrect until hypervisor resends the request. +Add a note suggesting hypervisors ignore the 1st buffer. +\item QEMU simply over-writes stats from each buffer it gets. +Thus if driver supplies a different subset of stats +on each request, stale values will be there. +Require drivers to supply the same subset on each +request. This also gives us a simple way to figure out +which stats are supported. +\end{enumerate} + +See +\ref{sec:Device Types / Memory Balloon Device}, +\ref{devicenormative:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Discovery}, +\ref{sec:Conformance / Driver Conformance / Traditional Memory Balloon Driver Conformance}, +\ref{sec:Conformance / Device Conformance / Traditional Memory Balloon Device Conformance}, +\ref{sec:Conformance / Legacy Interface: Transitional Device and Transitional Driver Conformance}, +\ref{sec:Conformance / Device Conformance} and \ref{sec:Conformance / Driver Conformance}. +} \\ +\hline +527 & 18 May 2015 & Michael S. Tsirkin & {VIRTIO-126: +document deflate on oom + +Document the new option, and also clarify behaviour +without it. + +In particular, actual field is not the +actual number of pages in the balloon as +driver might do inflate followed by deflate. + +Also, device isn't always driven by interrupts, +driver can inflate/deflate in response to e.g. +memory compaction. + +See \ref{sec:Device Types / Memory Balloon Device / Feature bits}, +\ref{sec:Device Types / Memory Balloon Device / Device Operation} and +\ref{drivernormative:Device Types / Memory Balloon Device / Device Operation}. +} \\ +\hline +528 & 18 May 2015 & Michael S. Tsirkin & {VIRTIO-123: +network device: xmit/receive cleanup + +Fix up multiple issues in xmit/receive sections: +\begin{itemize} + \item drop MAY/MUST/SHOULD outside normative statements + \item spell out conformance requirements for both drivers and + devices, for xmit and receive paths + \item document the missing VIRTIO_NET_HDR_F_DATA_VALID + \item document handling of unrecognized flag bits so we can extend + flags in the future, similar to VIRTIO_NET_HDR_F_DATA_VALID +\end{itemize} + +\ref{sec:Device Types / Network Device / Device Initialization}, +\ref{drivernormative:Device Types / Network Device / Device Operation / Packet Transmission}, +\ref{devicenormative:Device Types / Network Device / Device Operation / Packet Transmission}, +\ref{sec:Device Types / Network Device / Device Operation / Processing of Incoming Packets}, +\ref{sec:Conformance / Driver Conformance / Network Driver Conformance} and +\ref{sec:Conformance / Device Conformance / Network Device Conformance}. +} \\ +\hline +529 & 18 May 2015 & Michael S. Tsirkin & {VIRTIO-124: +network device: document VIRTIO_NET_F_CTRL_RX_EXTRA + +See +\ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Packet Receive Filtering}, +\ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Setting MAC Address Filtering}, +\ref{sec:Conformance / Driver Conformance / Network Driver Conformance} and +\ref{sec:Conformance / Device Conformance / Network Device Conformance}. +} \\ +\hline -- cgit v1.2.3