summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-08 17:59:15 +1100
committerMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-26 17:27:47 +1100
commitcd128853f392960ceec44476f37f0d569a680db5 (patch)
treebad1f909c502729a402f111322b5dc71edaec54e
parent3b62055c816764ff02aeb3a548e9bba36df8aae4 (diff)
Update docs to include loopback
Signed-off-by: Mark Farrugia <mark.farrugia@fiberdyne.com.au>
-rw-r--r--docs/1.Introduction.md2
-rw-r--r--docs/3.Usage.md6
-rw-r--r--docs/4.4A-Integration.md7
3 files changed, 11 insertions, 4 deletions
diff --git a/docs/1.Introduction.md b/docs/1.Introduction.md
index 2ddaf57..e189c7c 100644
--- a/docs/1.Introduction.md
+++ b/docs/1.Introduction.md
@@ -33,4 +33,4 @@ AVIRT attempts to address the aforementioned problems by:
A sample dummy Audio Path is provided as an example to show how a low-level audio driver would subscribe to AVIRT, and accept audio routing for playback.
-Currently, the Fiberdyne DSP hardmixer is supported on the Renesas R-Car M3 AGL reference platform, and a default loopback softmixer is in development.
+Currently, the Fiberdyne DSP hardmixer is supported on the Renesas R-Car M3 AGL reference platform, and the default loopback softmixer can be used to emulate this in cases where the former is not available.
diff --git a/docs/3.Usage.md b/docs/3.Usage.md
index 6d4d9f1..df56cf1 100644
--- a/docs/3.Usage.md
+++ b/docs/3.Usage.md
@@ -19,7 +19,8 @@ As an example, the Dummy Audiopath is being loaded here.
```sh
insmod avirt_core.ko
-insmod dummy/dummy_audiopath.ko
+insmod dummy/avirt_dummyap.ko
+insmod loopback/avirt_loopbackap.ko
```
### Note:
@@ -46,7 +47,7 @@ For example, in AGL:
```sh
mkdir -p /lib/modules/$(uname -r)/extra
-cp avirt_core.ko avirt_dummyap.ko /lib/modules/$(uname -r)/extra
+cp avirt_core.ko avirt_dummyap.ko avirt_loopbackap.ko /lib/modules/$(uname -r)/extra
depmod
```
@@ -55,6 +56,7 @@ Once the modules are in place, we can load the modules using:
```sh
modprobe avirt_core
modprobe avirt_dummyap
+modprobe avirt_loopbackap
```
<a name="configure-avirt" />
diff --git a/docs/4.4A-Integration.md b/docs/4.4A-Integration.md
index da4eeb7..cb88dd3 100644
--- a/docs/4.4A-Integration.md
+++ b/docs/4.4A-Integration.md
@@ -9,9 +9,14 @@ transition from the existing aloop implementation to the future AVIRT loopback i
The user-space library [libavirt](https://github.com/fiberdyne/libavirt) can be used to configure AVIRT from within a given AGL 4A binding.
+### Softmixer
+
+The AVIRT loopback can be used in-place of the standard aloop module. Modifications are currently underway
+to port the current 4a-softmixer to the new AVIRT loopback.
+
### Hardmixer
-A new 4A mixer binding has been developed to demonstrate the capabilities of the
+A new 4A mixer controller plugin (`.ctlso`) has been developed to demonstrate the capabilities of the
Fiberdyne DSP mixer operating on the HiFi2 core on-board the Renesas R-Car M3 M3ULCB
AGL reference platform. This is called the '**hardmixer**', and is a faster, lower
latency alternative to the softmixer.