Skip to content

Conversation

@wmamills
Copy link
Collaborator

@wmamills wmamills commented Jan 15, 2026

Start with virtio-msg-rfc2 w/ Bertrand's big PR merged.
Rebase onto latest master from upstream virtio spec.
Pull in cover latter changes from never sent rfc3 branch
Break out changes to existing files into their own commits
Squash all transport-msg.tex commits to one commit
Make initial adjustments to cover letter for V1 PATCH series.

The un-squashed version of this branch is available at
virtio-msg-patch1-before-squash in wmamills/virtio-msg-spec

A PDF version is available here: virtio-msg-patch1-wmamills-draft-v39.pdf

Update: I fixed up the github deploy action to fix the expected pdf file name. This fix is now squashed into the first commit.

Update 2: Updates to the cover letter (see top commit). Added Armelle to CC list (OK from Armelle received). Made sure every patch has at least Bertrand and I as SOB.

Update 3: Drop paragraph from cover letter about how much of bus should be in spec.

@wmamills wmamills force-pushed the virtio-msg-patch1 branch 2 times, most recently from 7ff99f7 to e9b4c71 Compare January 15, 2026 13:43
stsquad and others added 4 commits January 15, 2026 08:53
Local only changes for our githib repo.
Changes to:
* make building easier for developers
* respond to local pull-requests
* automate build & publish for pushes and local PRs

Individual changes done by Alex and squashed by Bill.

github: tweak PR template for virtio-msg (!UPSTREAM)

While we are working on the virtio-msg specification in the repository
lets not confuse people by using the canned response for the upstream
repository.

REVISION: set to 1.5 working draft as a base (!UPSTREAM)

fixup name of pdf file to match new REVISION

* Makefile: add some simple make automations

This is just a helpful shortcut, especially when editing the documents
within an IDE which will offer up make targets to build the documents.

make-setup-generated: optionally add GIT metadata

This isn't a full conversion to git based metadata but it allows for
local builds to add git commit and tree status to the final built
product. The normal formal build process is unaffected and uses
manually updated VERSION, REVISION and REVISION-DATE metadata.

github: add basic test build

github: add deploy step

This pushes the PDF as a release artefact.

github: add an update step before installing texlive

Otherwise you run into issues of the upstream has updated packages
since the last snapshot.

github: use a different release/publish pipeline

Having a draft means that the final asset won't be visible outside the
project which is what we want. This entails tagging a release each
time we run the steps.

github: only run the test phase on PRs

The release is done on pushes.

Signed-off-by: Alex Bennée <[email protected]>

github: use dedicated latex image

Installing all the latext tools from scratch takes some time and can
time out. Lets use an image that already has all the bits. The
texlive-full image is based on Alpin and we need to install a few
helper tools for build.

Signed-off-by: Alex Bennée <[email protected]>

github: add liberation font

We don't need it for the HTML but the full PDF needs fonts to render
properly.

Signed-off-by: Alex Bennée <[email protected]>

github: give tag and pdf names unique to owner fork and branch

The job number is not unique for different forks and this causes issues
with the tags which are global. Use the repo owners github name in the
tag and the branch as well.  Still include the job number to make unique.

Also change the pdf file name so we know where it came from.

Signed-off-by: Bill Mills <[email protected]>
Add the cover letter and a script to send the email.
Includes cover letter fixups from Bertrands suggestions.
Includes fixed version of ignore top

Signed-off-by: Bill Mills <[email protected]>
C1: Document what we have done since RFC1.
C2: mention more todo items
C3: Adjust series title

Signed-off-by: Bill Mills <[email protected]>
* Update cover letter
* Update email subject title

Signed-off-by: Bill Mills <[email protected]>
bertrand-marquis and others added 4 commits January 15, 2026 11:07
Add a new command to have a standard way to define virtio-msg bus
normative statements.

Signed-off-by: Bertrand Marquis <[email protected]>
Signed-off-by: Bill Mills <[email protected]>
Add a new transport layer that is based on messages.

This transport layer still uses virtqueues as the other transport layers do
but implements transport layer operations by sending and receiving messages
instead of the "MMR" reads and writes used in virtio-mmio and virtio-pci.

This transport is useful when the device and driver are both implemented in
software but the trap and emulate operations of virtio-mmio and virtio-pci
can not be used.

This transport is intended to be used in many situations, including:
* between a host processor and its co-processors
* between two different systems (not SMP) connected via PCIe
* between normal and secure worlds
* host to vm
* vm to vm

Signed-off-by: Bill Mills <[email protected]>
Signed-off-by: Bertrand Marquis <[email protected]>
Signed-off-by: Edgar E. Iglesias <[email protected]>
Signed-off-by: Arnaud Pouliquen <[email protected]>
Add the new transport layer into the content table

Signed-off-by: Bertrand Marquis <[email protected]>
Signed-off-by: Bill Mills <[email protected]>
Add entries for conformance of Virtio over Message for Driver, Device
and bus.

Signed-off-by: Bertrand Marquis <[email protected]>
Signed-off-by: Bill Mills <[email protected]>
* Update cover letter
  * Add link to Arm's virtio-msg FF-A spec
  * Add link to QEMU RFC
  * Add link to LKML RFC
  * Updated Edgar's QEMU branch
  * Text to say this is not an RFC any more
* Update email subject title
* Add Armelle to CC list

Update 3:
* Remove paragraph about how much of bus should be documented

Signed-off-by: Bill Mills <[email protected]>
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