aboutsummaryrefslogtreecommitdiffstats
path: root/split-ring.tex
Commit message (Collapse)AuthorAgeFilesLines
* editorial: explain each structure before useMichael S. Tsirkin2019-03-211-0/+4
| | | | | | | | | | | Several structures are listed before they are introduced in some way. Add a sentence before each one so they don't appear prior to any prose. Fixes: https://issues.oasis-open.org/browse/VIRTIO-166 Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Cornelia Huck <cohuck@redhat.com>
* split-ring: document in-order operationMichael S. Tsirkin2018-12-121-0/+28
| | | | | | | | | | | | | | | The point of in-order for the device is to be able to skip writing out some used descriptors, but the documentation that we have was put in the packed ring section and written in a way specific to the packed ring. Writing it in a generic way is tricky, for now this patch just copies the text from the packed ring to the split ring section, with minor tweaks. Fixes: https://github.com/oasis-tcs/virtio-spec/issues/30 Suggested-by: Jason Wang <jasowang@redhat.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
* packed-ring/split-ring/content: fixed misc typosDaniel Marcovitch2018-11-301-2/+2
| | | | | | | | Signed-off-by: Daniel Marcovitch <danielm@mellanox.com> Reviewed-by: Cornelia Huck <cohuck@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Fixes: https://github.com/oasis-tcs/virtio-spec/issues/24 Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
* notifications: unify notifications wording in coreHalil Pasic2018-10-191-30/+42
| | | | | | | | | | | | | | | | | | | | Let us unify the wording when talking about notifications. This change establishes the terms available buffer notification for what was usually simply called notification or virtqueue notification in v1.0 and used buffer notification for what was usually called interrupt. The term configuration change notification in kept where called so and consolidated where it's called configuration change interrupt or similar. The changes done here are limited to the core part, and don't conceptually involve neither the transports nor the devices (references are updated though). Future changes should address these parts. Signed-off-by: Halil Pasic <pasic@linux.ibm.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Cornelia Huck <cohuck@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
* split-ring: Fix typo in used ring descriptionChristoffer Dall2018-05-231-1/+1
| | | | | | | | | | | | | Only the device updates the used ring. This looks like a typo as a result of copy-paste from the description of the Available Ring. Fixes: https://github.com/oasis-tcs/virtio-spec/issues/12 Signed-off-by: Christoffer Dall <christoffer.dall@arm.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Laszlo Ersek <lersek@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
* split-ring: in order featureMichael S. Tsirkin2018-03-201-0/+18
| | | | | | | | | | | For a split ring, require that drivers use descriptors in order too. This allows devices to skip reading the available ring. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Cornelia Huck <cohuck@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@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
* split-ring: typo: aligmentMichael S. Tsirkin2018-03-201-1/+1
| | | | | 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
* split-ring: generalize textMichael S. Tsirkin2018-03-201-0/+4
| | | | | | | | | | | Update generic text to talk about available/used buffers, not rings. Move some split-ring specific text to the correct section. Update conformance section with link to the new conformance clause. 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
* content: generalize transport ring part namingMichael S. Tsirkin2018-03-201-3/+3
| | | | | | | | | | | | | Replace descriptor table/available ring/used ring with descriptor area/driver area/device area in all transports. Document what's in which area. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Cornelia Huck <cohuck@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
* content: move virtqueue operation descriptionMichael S. Tsirkin2018-03-201-6/+175
| | | | | | | | | | | virtqueue operation description is specific to the virtqueue format. Move it out to split-ring.tex and update all references. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Cornelia Huck <cohuck@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
* content: move ring text out to a separate fileMichael S. Tsirkin2018-03-201-0/+498
Will be easier to manage this way. Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: Cornelia Huck <cohuck@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