Skip to content

Commit 05ddf1c

Browse files
docs: virtio: add section about available drivers and samples
This commit adds sections to the virtio docs with the currently supported transfer methods, drivers and samples Signed-off-by: Jakub Michalski <[email protected]>
1 parent eab840b commit 05ddf1c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/hardware/virtualization/virtio.rst

+12
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,18 @@ virtqueue has to be acquired using :c:func:`get_virtqueue`. To send data consist
123123
will be invoked once the device returns the given descriptor chain. After that, the virtqueue has to be notified using
124124
:c:func:`notify_queue` from the Virtio API.
125125

126+
Guest-side Virtio drivers
127+
*************************
128+
Currently Zephyr provides a driver only for Virtio over PCI and a driver for one device using virtio - virtio-fs, used
129+
to access the filesystem of the host.
130+
131+
Virtio samples
132+
**************
133+
A sample showcasing the use of a driver relying on Virtio is provided in :zephyr:code-sample:`virtiofs`. If you wish
134+
to check code interfacing directly with the Virtio driver, you can check the virtiofs driver, especially :c:func:`virtiofs_init`
135+
for initialization and :c:func:`virtiofs_send_receive` with the :c:func:`virtiofs_recv_cb` for data transfer to/from
136+
the Virtio device.
137+
126138
API Reference
127139
*************
128140

0 commit comments

Comments
 (0)