From: Emmanouil Pitsidianakis <manos.pitsidianakis@linaro.org>
To: qemu-devel@nongnu.org
Cc: "Emmanouil Pitsidianakis" <manos.pitsidianakis@linaro.org>,
"Igor Skalkin" <Igor.Skalkin@opensynergy.com>,
"Anton Yakovlev" <Anton.Yakovlev@opensynergy.com>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Gerd Hoffmann" <kraxel@redhat.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Eduardo Habkost" <eduardo@habkost.net>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Volker Rümelin" <vr_qemu@t-online.de>,
"Kővágó, Zoltán" <DirtY.iCE.hu@gmail.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>
Subject: [PATCH v6 12/12] docs/system: add basic virtio-snd documentation
Date: Tue, 15 Aug 2023 12:07:17 +0300 [thread overview]
Message-ID: <a3f2576f6a5198e01cf02176a85bbb39892d789e.1692089917.git.manos.pitsidianakis@linaro.org> (raw)
In-Reply-To: <cover.1692089917.git.manos.pitsidianakis@linaro.org>
This commit adds basic documentation for using virtio-snd.
Signed-off-by: Emmanouil Pitsidianakis <manos.pitsidianakis@linaro.org>
---
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
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.
--
2.39.2
next prev parent reply other threads:[~2023-08-15 9:10 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-15 9:07 [PATCH v6 00/12] Add VIRTIO sound card Emmanouil Pitsidianakis
2023-08-15 9:07 ` [PATCH v6 01/12] Add virtio-sound device stub Emmanouil Pitsidianakis
2023-08-20 9:33 ` Volker Rümelin
2023-08-21 6:06 ` Manos Pitsidianakis
2023-08-21 18:52 ` Volker Rümelin
2023-08-22 8:46 ` Alex Bennée
2023-08-15 9:07 ` [PATCH v6 02/12] Add virtio-sound-pci device Emmanouil Pitsidianakis
2023-08-20 9:08 ` Volker Rümelin
2023-08-15 9:07 ` [PATCH v6 03/12] virtio-sound: handle control messages and streams Emmanouil Pitsidianakis
2023-08-15 9:07 ` [PATCH v6 04/12] virtio-sound: set PCM stream parameters Emmanouil Pitsidianakis
2023-08-15 9:07 ` [PATCH v6 05/12] virtio-sound: handle VIRTIO_SND_R_PCM_INFO request Emmanouil Pitsidianakis
2023-08-15 9:07 ` [PATCH v6 06/12] virtio-sound: handle VIRTIO_SND_R_PCM_{START,STOP} Emmanouil Pitsidianakis
2023-08-15 9:07 ` [PATCH v6 07/12] virtio-sound: handle VIRTIO_SND_PCM_SET_PARAMS Emmanouil Pitsidianakis
2023-08-15 9:07 ` [PATCH v6 08/12] virtio-sound: handle VIRTIO_SND_R_PCM_PREPARE Emmanouil Pitsidianakis
2023-08-15 9:07 ` [PATCH v6 09/12] virtio-sound: handle VIRTIO_SND_PCM_RELEASE Emmanouil Pitsidianakis
2023-08-15 9:07 ` [PATCH v6 10/12] virtio-sound: implement audio output (TX) Emmanouil Pitsidianakis
2023-08-15 9:07 ` [PATCH v6 11/12] virtio-sound: implement audio capture (RX) Emmanouil Pitsidianakis
2023-08-15 15:04 ` 林伟6
2023-08-15 9:07 ` Emmanouil Pitsidianakis [this message]
2023-08-20 11:46 ` [PATCH v6 00/12] Add VIRTIO sound card Volker Rümelin
2023-08-21 6:10 ` Manos Pitsidianakis
2023-08-21 19:35 ` Volker Rümelin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a3f2576f6a5198e01cf02176a85bbb39892d789e.1692089917.git.manos.pitsidianakis@linaro.org \
--to=manos.pitsidianakis@linaro.org \
--cc=Anton.Yakovlev@opensynergy.com \
--cc=DirtY.iCE.hu@gmail.com \
--cc=Igor.Skalkin@opensynergy.com \
--cc=alex.bennee@linaro.org \
--cc=berrange@redhat.com \
--cc=eduardo@habkost.net \
--cc=kraxel@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=vr_qemu@t-online.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).