aboutsummaryrefslogtreecommitdiffstats
path: root/introduction.tex
Commit message (Collapse)AuthorAgeFilesLines
* Add virtio rpmb device specificationHuang Yang2019-11-271-0/+3
| | | | | | | | | | | Add virtio RPMB (Replay Protected Memory Block) device documentation to spec. Signed-off-by: Yang Huang <yang.huang@intel.com> Reviewed-by: Bing Zhu <bing.zhu@intel.com> Reviewed-by: Tomas Winkler <tomas.winkler@intel.com> Fixes: https://github.com/oasis-tcs/virtio-spec/issues/53 Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
* content: add virtio file system deviceStefan Hajnoczi2019-09-251-0/+3
| | | | | | | | | | | | | | | | | | The virtio file system device transports Linux FUSE requests between a FUSE daemon running on the host and the FUSE driver inside the guest. The actual FUSE request definitions are not duplicated in the virtio specification, similar to how virtio-scsi does not document SCSI command details. FUSE request definitions are available here: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/fuse.h This patch documents the core virtio file system device, which is functional but lacks the DAX feature introduced in the next patch. Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Cornelia Huck <cohuck@redhat.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Fixes: https://github.com/oasis-tcs/virtio-spec/issues/49
* editorial: add labelsMichael S. Tsirkin2019-03-241-1/+1
| | | | Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
* introduction: update link to IEEE 802Michael S. Tsirkin2019-03-211-1/+1
| | | | | | | | | | Looks like all GETIEEE links got broken. Let's just point to their main page. Fixes: https://issues.oasis-open.org/browse/VIRTIO-175 Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Jens Freimann <jfreimann@redhat.com>
* introduction: simplify the designation of legacyHalil Pasic2019-02-271-2/+2
| | | | | | | | | | | | | | | | The sentence designating the documents defining what later became known as the legacy virtio interface had the most important piece of information placed in parenthesis. Let's reword this sentence so we avoid using an ambiguous designation based on a relative anchor (i.e. 'earlier drafts of this specification') and just use the absolute anchor (version 1.0). VIRTIO-164 Signed-off-by: Halil Pasic <pasic@linux.vnet.ibm.com> Reviewed-by: Cornelia Huck <cohuck@redhat.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
* introduction: document bitfield notationMichael S. Tsirkin2018-03-201-0/+41
| | | | | | | | | | | Bitfields are a useful and familiar way to specify sub-byte structure layout. The only issue is that bitfield order isn't portable across architectures. Document that we list bitfields from least to most significant one, and warn about portability issues. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Approved-by: https://www.oasis-open.org/apps/org/workgroup/virtio/ballot.php?id=3177 Fixes: https://github.com/oasis-tcs/virtio-spec/issues/3
* cl: document resolution for VIRTIO-146.mstsirkin2015-10-211-1/+1
| | | | | | | | add advice on transition from earlier drafts. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@551 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* intro: add advice on transition from legacy interfacesmstsirkin2015-10-211-0/+10
| | | | | | | | | | | | | | | Reading legacy chapters gives a hint about what changed, let's help readers discover this useful shortcut. This resolves VIRTIO-146. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Cornelia Huck <cornelia.huck@de.ibm.com> Accepted by electronic ballot: https://www.oasis-open.org/apps/org/workgroup/virtio/ballot.php?id=2866 git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio/branches/v1.0@548 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* VIRTIO-60: avoid vring and VIRTIO_RING.rusty2014-03-131-2/+2
| | | | | | | | | | | | 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
* VIRTIO-74: required vs REQUIRED.rusty2014-03-131-1/+1
| | | | | | | | | 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
* Formatting: use latex-style quoting everywhere.rusty2014-03-031-1/+1
| | | | | | | | 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
* fix rfc2119 referencemstsirkin2014-03-021-1/+3
| | | | | | | | | | | | Change accepted on VIRTIO TC Meeting, 3 December 2013 VIRTIO-68 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@306 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* legacy interface: move to terminologymstsirkin2014-03-021-31/+55
| | | | | | | | | | | | 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
* introduction: add link to 0.9.5 specificationmstsirkin2014-03-021-3/+8
| | | | | | | | | | | | | | | | | | Change accepted on VIRTIO TC Meeting, 3 December 2013 this version replaces it, so it's a non normative reference. VIRTIO-69 note: the link is added here but isn't used yet: will be used when we cleanup terminology definitions, by addressing 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@302 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* introduction: typo in terminology sectioncornelia.huck2014-02-261-1/+1
| | | | | | | | 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
* Feedback: SCSI: Separate normative and descriptive texts.rusty2014-02-261-0/+7
| | | | | | | | | 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
* Feedback: net: separate normative and instructional text.rusty2014-02-261-0/+4
| | | | | | 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
* Feedback: move legacy/transitional definitions into terminology.rusty2014-02-261-0/+27
| | | | | | 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
* Feedback: add old draft to normative references (VIRTIO-77)rusty2014-02-261-0/+3
| | | | | | 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
* Feedback: use proper list in introduction (VIRTIO-82)rusty2014-02-261-6/+7
| | | | | | | | | 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
* introduction: address lnovich commentsmstsirkin2014-02-121-5/+5
| | | | | | | | | 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
* Fix S390 normative references.rusty2014-02-121-2/+2
| | | | | | | | | | | | | | | 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
* Feedback #8: Applied.rusty2014-02-121-0/+8
| | | | | | | | | | [ 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
* Feedback #5: Applied.rusty2014-02-121-3/+4
| | | | | | | | | 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@236 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* C struct specifications.rusty2014-02-121-0/+21
| | | | | | | | | | | | Explicitly specify that our C struct specifications are without padding, and add some definitions for our integer data types. [ Rusty - added /* comments */ and removed redundant old le* explanation ] Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@231 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* REVERT LAST 15 JUNK COMMITS.rusty2014-02-101-37/+3
| | | | | | | | Back to r211. It's been a long day. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@225 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* We'll add more non-normative sections with hints forrusty2014-02-101-0/+12
| | | | | | | | | implementing registers such as PCI class, status and command registers. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@219 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* patch feedback-5.patchrusty2014-02-101-3/+4
| | | | git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@215 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* C struct specifications.rusty2014-02-101-0/+21
| | | | | | | | | | | | Explicitly specify that our C struct specifications are without padding, and add some definitions for our integer data types. [ Rusty - added /* comments */ and removed redundant old le* explanation ] Signed-off-by: Cornelia Huck <cornelia.huck@de.ibm.com> Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@212 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* 1. Introduction: Removed left-over "PCI"hornet2013-12-121-1/+1
| | | | | | | | | | | The "Extensible" paragraph of the introduction still referred to "Virtio PCI devices". Changed to "Virtio devices". Signed-off-by: Pawel Moll <pawel.moll@arm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@175 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* Formatting repair as per Chet's feedback.rusty2013-12-031-4/+0
| | | | | | | | | | 1) Populate TC member list. 2) Remove Non-Normative References section 3) Fix URLs to point to correct place. Signed-off-by: Rusty Russell <rusty@au1.ibm.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@153 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* Terminology: Device and driver, not host and guest.rusty2013-12-021-1/+1
| | | | | | | | | | | | | | | | | | We've mixed both together, whereas from a spec-reader point of view, "driver" and "device" is probably clearer. CCW part incorporated: Switch the parts of the virtio-ccw specification that did not already to device/driver instead of guest/host. For more general discussions, host/guest is kept (like when talking about guest<->host notifications in general). This should make things more consistent. 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@145 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* introduction.tex: import abstractmstsirkin2013-12-011-10/+1
| | | | | | | | import abstract from abstract.tex Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@139 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* introduction.tex: make keywords upper-casemstsirkin2013-11-281-6/+1
| | | | | | | | This seems to be the consensus. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@132 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* introduction.tex: import from text documentmstsirkin2013-11-251-15/+51
| | | | | | | | manually import introduction from main text. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@117 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652
* virtio: add latex templates from CMISmstsirkin2013-11-251-0/+30
I imported latex templates from the CMIS specifications and changed s/CMIS/VIRTIO/ everywhere. The result is very close to one produced by exporting from the ODF we were supplied, with the exception of the TOC formatting, where section numbers are in blue instead of black, and major sections don't have dots leading to page numbers. I'm guessing this isn't very important, someone with more latex knowledge can try to figure this out. Generating html doesn't actually work for me. It doesn't work for me for CMIS either, so it's probably just an issue with my local latex setup. I'm not sure we need html output at all. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> git-svn-id: https://tools.oasis-open.org/version-control/svn/virtio@103 0c8fb4dd-22a2-4bb5-bc14-6c75a5f43652