summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames O'Shannessy <james.oshannessy@fiberdyne.com.au>2018-10-08 16:03:12 +1100
committerMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-26 17:27:45 +1100
commit94eb09750343f0adc8f4bf56eb4ee05ce9def8f1 (patch)
tree8cfb4fd2d7d5771bc85927af78846e77a020abdb
parent056c3754bc7be349de1a41ac6d4819f3d032bd0c (diff)
Updating Introduction doc
Signed-off-by: James O'Shannessy <james.oshannessy@fiberdyne.com.au>
-rw-r--r--README.md2
-rw-r--r--docs/1.Introduction.md20
2 files changed, 18 insertions, 4 deletions
diff --git a/README.md b/README.md
index f19e7d5..dc72ff1 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
## Alsa Virtual Sound Driver
-[1. Introduction](docs/1.Introduction.md)
+1. [Introduction](docs/1.Introduction.md)
[2. Building](docs/2.Building.md)
[3. Usage](docs/3.Usage.md)
[4. 4A Integration](docs/4.4A-Integration.md)
diff --git a/docs/1.Introduction.md b/docs/1.Introduction.md
index 29cac71..25b3ea8 100644
--- a/docs/1.Introduction.md
+++ b/docs/1.Introduction.md
@@ -1,13 +1,27 @@
Introduction
===================
+## Problem
+The existing solution contains the following drawbacks:
+ 1. Non-generic interface for configurable hardware cases
+ - Unable to configure streams mapped to outputs
+ 2. Not fully optimized for certain use cases (ie. Routing Audio to DSP vs. aloop)
+ - Routing audio to hardware to reduce overhead
+ 3. Inability to secure on all audio streams
+ - Substreams cannot have SMACK labels applied, inherently leaving different audio streams insecure, or a single label applied to all.
+
+## AVIRTs Solution
The ALSA Virtual Sound Driver (AVIRT) aims to provide a Linux kernel solution to the issue of audio routing in kernel-space, as well as security per-stream, and dynamic configuration of streams at the kernel level.
A top-level abstract dynamic audio driver is presented to the user-space via an ALSA middle-layer card. From there, respective low-level "real" audio drivers can subscribe to it as an "Audio Path".
-The top-level driver is configured (currently) using module parameters, as is the norm for sound drivers in the Linux tree, however this will utilise a configfs configuration implementation in future.
+The top-level driver is configured (currently) using by utilising configfs.
+
+AVIRT attempts to address the aforementioned problems by:
+ 1. Providing a standard interface through configfs to configure a variable number of 'streams' which can be mapped to audio paths.
+ 2. Optimize the audio routing by connecting directly with the desired audio path. This can include routing audio through directly to hardware, or to an implemented loopback interface.
+ 3. Each 'stream' is separated to its own device, therefore security can be applied to each 'stream'. This means that each of the audio roles can be separately secured from each other.
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. \ No newline at end of file
+Currently, the Fiberdyne DSP hardmixer is supported on the Renesas R-Car M3 AGL reference platform, and a default loopback softmixer is in development. \ No newline at end of file