summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2014-03-02drop /* LEGACY version was not little endian */mstsirkin
Two issues with the comment: - it mixes legacy documentation in main part of the spec - it says what format *isn't* - instead of what it *is* Now that we have documented that LE can mean legacy endian, there's no need for the comment. Resolves issues: VIRTIO-58 Change accepted on VIRTIO TC Meeting, 3 December 2013 Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@287 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-27Fixed path of linux version of virtio_ring.hrusty
Signed-off-by: Holm Rauchfuss <holm.rauchfuss@huawei.com> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@286 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26mmio: Clarify normative requirement on QueueNumhornet
Minor fix: add explicit reference to QueueNumMax in the normative paragraph describing QueueNum. Signed-off-by: Pawel Moll <pawel.moll@arm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@285 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26mmio: Fix double register macrohornet
Minor fix: commit 238 wrapped register names in \field{}s and modified one of the register table macros, but missed the other one. Signed-off-by: Pawel Moll <pawel.moll@arm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@284 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26mmio: Fix Device Tree examplehornet
Minor fix: the size of 0x100 was obviously wrong, as it didn't allow for configuration space. Signed-off-by: Pawel Moll <pawel.moll@arm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@283 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26introduction: typo in terminology sectioncornelia.huck
s/device/driver/ for the transitional driver description. Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@282 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26ccw: Fix requirements for processing adapter interrupts.rusty
We currently mandate that the driver clears the summary indicator before processing the queue indicator; this is bogus, as the requirement for interrupt avoidance is rather that the driver unsets the summary indicator before before it stops looking at the queue indicator. In fact, the best way to get a race-free implementation of the interrupt handler is to process the queue indicators twice; let's add a recommondation to do that. Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> (merged) git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@281 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26VIRTIO-45: Add a reserved ID for Timer/Clock devicerusty
Just add a reserved ID for Timer/Clock device. There is no work on it yet but it is nice to have the ID which could be used safely in preliminary implementations. Signed-off-by: Daniel Kiper <daniel.kiper@oracle.com> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@280 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26VIRTIO-28: Deprecate balloon device, add number for new one.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@279 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: VIRTIO-77 Conformance clause.rusty
Now we have grouped all the normative statements, the conformance clauses for drivers and devices can simply reference them. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@278 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: Separate normative requirements for Reserved Feature Bits.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@277 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: SCSI: Separate normative and descriptive texts.rusty
This could use some more rigour, I think: there are still many implied requirements which could be called out. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@276 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: console & entropy: separate normative and descriptive texts.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@275 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: block: separate normative and descriptive text.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@274 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: net: separate normative and instructional text.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@273 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: CCW: Separate normative and descriptive sections.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@272 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: MMIO: Separate normative and descriptive text.rusty
The section on initialization is now non-normative. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@271 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: PCI: Separate explanatory and normative text.rusty
Rather than treat selectors 0 and 1 as special, the wording for features is made more general (though still the same effect). I split the interrupt handler into a separate subsection: it was misleading because it didn't handle configuration interrupts until the next section. It's also non-normative. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@270 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: Separate the rest of chapter 2 into normative vs explanatory.rusty
The big change here is in introducing new subsections for interrupt and notification suppression, and moving all requirements into them. The example processing loop is also moved into a note, to show clearly that it's not normative. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@269 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: Normative split for Basic Facilities of a Virtio Device / ↵rusty
Virtqueues / Message Framing Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@268 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: Normative split in Basic Facilities of a Virtio Device / Virtqueuesrusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@267 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: split Basic Facilities feature bits and config space into normative.rusty
Split text into descriptive and normative. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@266 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: add normative marker.rusty
From http://docs.oasis-open.org/templates/TCHandbook/ConformanceGuidelines.html: Normative statements MUST be referenceable so that a statement may be referenced from another part of a specification, but more importantly so they can be referenced from Conformance Clauses. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@265 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: 2.1 Device Status field: Separate description from normative.rusty
Start with explanation, progress to normative requirements. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@264 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: move legacy/transitional definitions into terminology.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@263 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: hoist the one legacy-related requirement out of legacy section.rusty
This requirement applies to any system which *did* have legacy drivers. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@262 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: add old draft to normative references (VIRTIO-77)rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@261 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: use proper list in introduction (VIRTIO-82)rusty
Also avoid extra spacing before footnote markers. Reported-by: Patrick Durusau <patrick@durusau.net> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@260 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: move new device design section to Appendix.rusty
It's non-normative. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@259 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: Bug TAB-553 (VIRTIO-76)rusty
Haven't marked them non-normative yet, but it makes sense to put the header in an appendix. Reported-by: Patrick Durusau <patrick@durusau.net> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@258 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: TAB-555 Bad sub-sectioning (VIRTIO-80)rusty
Reported-by: Patrick Durusau <patrick@durusau.net> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@257 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26Feedback: TAB-557 Spelling errors, etc (VIRTIO-75)rusty
Reported-by: Patrick Durusau <patrick@durusau.net> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@256 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26PCI: better document driver and device requirementsrusty
Feedback: 10) 4.1.3.1.2 Queue Vector Configuration Some of the information from section 8.4 needs to be moved to here, for example that the device may have an MSI-X table size other than 2048. Otherwise, this reads as though the MSI-X table must always have 2048 entries. 11) Please explicitly describe the device behavior when writing a vector value beyond the MSI-X table size. Address these comments. Cc: Arun Subbarao <asubbarao@lnxw.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@255 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26feedback: minor wording cleanupsrusty
We already mention requirement for natural width accesses for non device specific configuration. Don't repeat this in legacy section. Further, mention virtio pci structure in preamble to help link sections together. Cc: Arun Subbarao <asubbarao@lnxw.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Conflicts: content.tex git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@254 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-26SCSI: fix up more fields.rusty
Some missing \field{} markings, and a few redundant "the XXX field". Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@253 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-20SCSI: missing space.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@252 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-19Gratuitous Packet Sending: clarify wording.rusty
The device can ask, not the driver. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@251 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-19net: fix incorrect reference.rusty
It pointed into the block section for some reason. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@250 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-13ccw: padding annotationscornelia.huck
Remove __packed__ annotation from all ccw structures that don't need it, and make the length requirements explicit for those that do. This is the part of the patch to resolve VIRTIO-56 that had been missed. Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@249 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12PCI: minor wording changemstsirkin
Since access width requirement is a confirmance clause, make it explicit that it applies to 4,2 and 1 byte fields. Also explain what happens to fields of other widths (such as the 6 byte MAC). Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@248 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12content: more strict confirmance languagemstsirkin
Correct new language to explicitly use MAY/SHOULD/MUST in more places or simply drop the somewhat vague "can" where we are describing the only way to operate the device. Most of the changes are in the PCI section. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@247 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12introduction: address lnovich commentsmstsirkin
generally list of buses is out of date, list all supported buses. Drop explicit mention of lguest since it's not part of the spec. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@246 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12abstract: address lnovich commentmstsirkin
lnovich@redhat.com suggested rewording abstract, making the following point: . from what point of view is virtio like a physical device? it's very different from host POV . "the guest" appears out of nowhere. It's the guest that runs in the vm of course. . "not all that different" means similar so there's not need to be verbose Address this comment Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@245 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12VIRTIO-55: Add a reserved ID for GPU devicesrusty
As existing work on virtio-gpu is using device ID 16, reflect this in the spec. This closes out VIRTIO-55. As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Signed-off-by: Paul Mundt <paul.mundt@huawei.com> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@244 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12Fix S390 normative references.rusty
As pointed out in TAB-539 and TAB-540: - Add an URL to the documents. (Unfortunately, there is no link that always points to the latest version.) - State that we include any future revisions as well. As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@243 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12ccw: Further use of RFC2119 language.rusty
Some more instances of MAY and SHOULD, as reported in TAB comments TAB-548 and TAB-550. As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@242 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12PCI: explicitly document ISR status fieldrusty
Feedback on ISR status register: It would be helpful if this section provided the meaning of each bit in the register. ISR use is scattered all around the place. Add a section describing the format and semantics. [ Merged to combine with new ISR-specific section --RR ] As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Cc: Arun Subbarao <asubbarao@lnxw.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@241 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12PCI: consistent device/PCI configuration spacerusty
Re section: 4.1.3.4 Notification of Device Configuration Changes Feedback: Please use "PCI configuration space" and "device configuration state" consistently, without abbreviation. For example, from the first sentence it looks like "device configuration state" can be changed, but the first bullet claims it's "configuration space". So, which one? Does "configuration space" mean "PCI configuration space" or is it a synonym for "device configuration state"? Because those are two different things; the driver needs to know what exactly to rescan. As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Cc: Arun Subbarao <asubbarao@lnxw.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@240 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12Feedback #8: Applied.rusty
[ Includes fixup! removing MSI-X ] As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@239 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-02-12Feedback #7: Appliedrusty
Some minor merging required. As per minutes: https://lists.oasis-open.org/archives/virtio/201402/msg00121.html Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@238 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652