[v6,12/12] docs/system: add basic virtio-snd documentation

Commit Message

Manos Pitsidianakis Aug. 15, 2023, 9:07 a.m. UTC

This commit adds basic documentation for using virtio-snd.

Signed-off-by: Emmanouil Pitsidianakis <[e-mail]>
---
 docs/system/device-emulation.rst   |  1 +
 docs/system/devices/virtio-snd.rst | 36 ++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)
 create mode 100644 docs/system/devices/virtio-snd.rst

Patch

diff --git a/docs/system/device-emulation.rst b/docs/system/device-emulation.rst
index 4491c4cbf7..dae19446e5 100644
--- a/docs/system/device-emulation.rst
+++ b/docs/system/device-emulation.rst
@@ -92,6 +92,7 @@  Emulated Devices
    devices/usb.rst
    devices/vhost-user.rst
    devices/virtio-pmem.rst
+   devices/virtio-snd.rst
    devices/vhost-user-rng.rst
    devices/canokey.rst
    devices/usb-u2f.rst
diff --git a/docs/system/devices/virtio-snd.rst b/docs/system/devices/virtio-snd.rst
new file mode 100644
index 0000000000..b73de6b42d
--- /dev/null
+++ b/docs/system/devices/virtio-snd.rst
@@ -0,0 +1,36 @@ 
+virtio-snd
+==========
+
+This document explains the setup and usage of the virtio-snd device.
+The virtio-snd device is a paravirtualized sound card device.
+
+Linux kernel support
+--------------------
+
+virtio-snd requires a guest Linux kernel built with the
+``CONFIG_SND_VIRTIO`` option.
+
+Description
+-----------
+
+virtio-snd implements capture and playback from inside a guest using the
+configured audio backend of the host machine.
+
+Examples
+--------
+
+Add a PCI device:
+
+::
+
+  -device virtio-sound-pci,disable-legacy=on
+
+And an audio backend listed with ``-audio driver=help`` that works on
+your host machine, e.g.:
+
+ * pulseaudio: ``-audio driver=pa,model=virtio-sound``
+   or ``-audio driver=pa,model=virtio-sound,server=/run/user/1000/pulse/native``
+ * sdl: ``-audio driver=sdl,model=virtio-sound``
+ * coreaudio: ``-audio driver=coreaudio,model=virtio-sound``
+
+etc.