Skip to content

Conversation

@wmamills
Copy link
Collaborator

@wmamills wmamills commented Jun 15, 2025

New PDF: https://github.com/wmamills/virtio-msg-spec/releases/download/wam-review-06-09-wmamills-draft-v16/wam-review-06-09-wmamills-draft-v16.pdf

V1:

  • Eliminate EVENT_CONFIG_EMPTY
  • Fix all Virtqueue constants to 0xFFFFFFFF
  • Replace DEVICE_ADDED and DEVICE_REMOTE with EVENT_DEVICE
  • Add SHM and admin virtqueue support
  • Make field order of {SET,GET,EVENT}_CONFIG consistant
  • various typos, spelling, and wording fix-ups

V2:

  • update github to use unique tags and pdf names
  • Review fixup for EVENT_CONFIG[_EMPTY]
  • Review fixup for EVENT_DEVICE
  • Add cover letter for RFC2

V3:

  • dropped github action commit as it came via a different PR
  • Reordered cover letter to most recent (and delete mention of "all virtqueues" value)
  • Add new cover letter commit to mention FF-A and other upcoming work

Copy link
Collaborator

@bertrand-marquis bertrand-marquis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely looks good to me.
Just one minor comment

wmamills added 12 commits June 19, 2025 16:56
As decided on June 5th, the EVENT_CONFIG_EMPTY message is deleted.
Instead of documenting "invalid" settings of device status and
configuration generation count, I have removed that use case of
EVENT_CONFIG.

EVENT_CONFIG can still be used with an without changed configuration data
in the payload.  More explicit documentation on these two cases has been
added.

Signed-off-by: Bill Mills <bill.mills@linaro.org>
The hex value for this case was always intended to be "all 1s" but was
mis-specified before.  This fixes that.

This also makes it clear that for the EVENT_AVAIL use case, this would
typically be used on the device side.  (The driver side always knows which
virtqueue was updated as it originates this event.)

Signed-off-by: Bill Mills <bill.mills@linaro.org>
* writeing -> writing
* support to send -> support sending
* /msgref -> \msgref

Signed-off-by: Bill Mills <bill.mills@linaro.org>
This uses the EVENT_ name for event messages and replaces two messages
with one that includes a state value.  This allows future expansion of
state to handle things like suspend/resume and request removal.

Signed-off-by: Bill Mills <bill.mills@linaro.org>
Fix the copy and past error here.

Signed-off-by: Bill Mills <bill.mills@linaro.org>
* Add support for device owned shared memory segments from virtio v1.3
* Add support for Admin virtqueues from virtio v1.4 (draft)

Signed-off-by: Bill Mills <bill.mills@linaro.org>
Make the order of fields:
* [config gen count, if present]
* config offset
* config length
* config data

Signed-off-by: Bill Mills <bill.mills@linaro.org>
* Use full state names in description
* Use 1 & 2 as state values

Signed-off-by: Bill Mills <bill.mills@linaro.org>
* Use "\emph{MAY} be zero" for config data length

Signed-off-by: Bill Mills <bill.mills@linaro.org>
This is hard to describe and real implementations may just use a loop
anyway.  So delete this for now anyway.

A loop is required in the bus when:
* One OoB notification can trigger multiple virtio devices
* One OoB notification can trigger SOME virtqueues but not all

So this value only covers one use case and it may cause more confusion
than value.

Signed-off-by: Bill Mills <bill.mills@linaro.org>
Document what we have done since RFC1.

Signed-off-by: Bill Mills <bill.mills@linaro.org>
* As discussed Jun 19, mention work on FF-A spec is underway but don't
  promise a date.
* Do likewise for the AMP data structures and first bus message set
* Do likewise for aligned implementations and PATCH v1

Signed-off-by: Bill Mills <bill.mills@linaro.org>
@wmamills wmamills merged commit 8ca7557 into Linaro:virtio-msg-rfc1 Jun 19, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants