summaryrefslogtreecommitdiff
path: root/content.tex
AgeCommit message (Collapse)Author
2014-05-12VIRTIO-99: Typo fixes.rusty
As passed at meeting 2014-05-06: https://lists.oasis-open.org/archives/virtio/201405/msg00016.html Reported-by: Thomas Huth <thuth@linux.vnet.ibm.com> Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@363 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-05-07net: fix device conformance sectionscornelia.huck
For the network device, we had two device normative sections both called "setting up receive buffers", neither of which was referenced in the conformance section. Let's rename the second one to "processing of packets" which seems to better match the actual contents and reference both of them from the conformance statement for network devices. Resolves VIRTIO-97. Agreed on the 2014/05/06 TC meeting. Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@362 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13VIRTIO-60: avoid vring and VIRTIO_RING.rusty
These are never introduced, so use simpler names: virtq* for structures and VIRTIO_ for features. I added two notes about the old names, for helping people coming from the old spec. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@327 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13net: make num_buffers field compulsory (VIRTIO-86)rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@326 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13block: deprecate FLUSH_OUT (VIRTIO-85)rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@325 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13net: clean up mq definition, receive buf size (VIRTIO-84)rusty
1) Instead of using N-1 everywhere, use N, and start receiveq etc at 1. This is less C like, but less confusing in english. 2) Weaken requirements for automatic steering to SHOULD, as otherwise we're insisting device record all flows forever. 3) Receive buffers must be able to hold data, so must be > header. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> Conflicts: content.tex git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@324 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13VIRTIO-62: Explicit and specific.rusty
Avoid these words where they are redundant. This also lead me to notice that we were not consistent in the use of the term "device-specific configuration" in the PCI section, so cleaned that up too. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@323 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13VIRTIO-63: Make sure examples are marked clearly.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@322 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13VIRTIO-72: SHOULD/shouldrusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@321 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13VIRTIO-73: MAY/may.rusty
Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@320 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13VIRTIO-74: required vs REQUIRED.rusty
Some really are clearest as they are, but most are changed to avoid confusion. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@319 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-13VIRTIO-81: MUST vs mustrusty
Clean up the remaining lowercase "musts". We actually introduce a new normative section in the balloon; for the rest we clarify them one way or another. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@318 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-05legacy framing: scsi hostmstsirkin
git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@316 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-05legacy message framing: console devicemstsirkin
git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@315 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-05block: legacy message framingmstsirkin
git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@314 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-05message framing: rusty's commentsmstsirkin
generic note on message framing specific requirements listed for net device only git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@313 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-05legacy devices: get rid of MUST assumemstsirkin
as Rusty points out MUST assume is not very good requirement. clarify it. git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@312 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-05transitional driver features: fix typos noted by Rustymstsirkin
git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@311 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-03Formatting: use latex-style quoting everywhere.rusty
Doesn't look any different, but consistent. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@310 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-03Use ellipsis (aka \ldots) everywhere.rusty
And use the ellipsis package, which makes it symmetrical. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@309 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-03PCI: Tighten requirements.rusty
1) make it clear that queue_enable is 0 on reset. 2) device MUST present a VIRTIO_PCI_CAP_DEVICE_CFG if needed for type. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@308 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02initialization: minor clarificationmstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 "it" could refer to failed bit or the driver. clarify. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@307 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02feedback: clarify device status bitsmstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 VIRTIO-70 Cc: Patrick Durusau <patrick@durusau.net> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@304 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy interface: move to terminologymstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 VIRTIO-64 Cc: Patrick Durusau <patrick@durusau.net Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@303 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02non-transitional devices with legacy driversmstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 weaken hacky requirements helpful for graceful failure for non transitional PCI devices from MUST to SHOULD. It's nice to have but it's not like it makes things work, and you can avoid trouble simply by using the most recent drivers. also move them out to a separate section Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@301 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy device initialization: confirmance statementsmstsirkin
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@299 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy virtqueue layout: confirmancemstsirkin
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@298 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy: make all notes on endian-ness confirmance clausesmstsirkin
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@297 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy feature bits: confirmance statementsmstsirkin
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@296 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02leacy: layout detection confirmancemstsirkin
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@295 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy pci layout: extra confirmance statementmstsirkin
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@294 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy pci layout: confirmance statementsmstsirkin
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@293 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy: make message framing normativemstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 TODO: we really should be more specific Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@292 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy: make note on legacy VQ endian-ness normativemstsirkin
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@291 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02Legacy Interface: Device Configuration Spacemstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 legacy has no generation field. add SHOULD statement to document multi-byte field access rules. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@290 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02legacy: clarify general note on endian-nessmstsirkin
Change accepted on VIRTIO TC Meeting, 3 December 2013 this is a non normative section. we merely mention that details are given for each device. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@289 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
2014-03-02content: explain that legacy support is optionalmstsirkin
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@288 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
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-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: 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