diff options
author | James O'Shannessy <james.oshannessy@fiberdyne.com.au> | 2018-09-13 16:34:25 -0700 |
---|---|---|
committer | Mark Farrugia <mark.farrugia@fiberdyne.com.au> | 2018-10-26 17:27:42 +1100 |
commit | 5a2a915287e7cd12a347a03d37861310701a72fb (patch) | |
tree | 20a278a933aa14046302db37e03477e09b7293a4 | |
parent | 386c29da3416d86b66430e590aaa5c51f2942477 (diff) |
Changes to readme files
Dot points to introduction, and shifting the build instructions to
docs/2.\ Building.md
Signed-off-by: James O'Shannessy <james.oshannessy@fiberdyne.com.au>
-rw-r--r-- | docs/1. Introduction.md | 18 | ||||
-rw-r--r-- | docs/2. Building.md | 39 |
2 files changed, 57 insertions, 0 deletions
diff --git a/docs/1. Introduction.md b/docs/1. Introduction.md index e69de29..f2d088d 100644 --- a/docs/1. Introduction.md +++ b/docs/1. Introduction.md @@ -0,0 +1,18 @@ +Introduction +=================== + +## Problem +- Insecure +- Limited +- Not fully optimised for use case (ie. Routing Audio to DSP vs. Loopback) +- Not generic interface for highly configurable hardware +- + +## Solution + +## Added Features +- Dynamic Runtime Alsa Front end +- Adjustable Audio Path +- Mappable Audio Path +- Secure Audio Routing w/ SMACK +-
\ No newline at end of file diff --git a/docs/2. Building.md b/docs/2. Building.md index e69de29..983db8d 100644 --- a/docs/2. Building.md +++ b/docs/2. Building.md @@ -0,0 +1,39 @@ +Building AVIRT +=================================== + +## Table of Contents +1. [Out of Tree](#out-of-tree) +2. [In Tree](#in-tree) + +<a name="out-of-tree"/> + +## Out Of Tree + +The kernel modules can be built either in-tree, or out-of-tree. +To build both AVIRT and the dummy Audio Path out-of-tree, use the following command: + +```sh +$ CONFIG_AVIRT=m CONFIG_AVIRT_BUILDLOCAL=y CONFIG_AVIRT_DUMMYAP=m make -C /lib/modules/$(uname -r)/build/ M=$(pwd) +``` + +To build both AVIRT and the dummy Audio Path out-of-tree for [AGL](http://docs.automotivelinux.org/) (`aarch64` currently supported), use the [XDS](http://docs.automotivelinux.org/docs/devguides/en/dev/reference/xds/part-1/0_Abstract.html) build system together with the `make_agl.sh` script: + +```sh +$ ./make_agl.sh ${XDS_SDK_ID} +``` + +<a name="in-tree"/> + +## In tree + + +To build in tree, use the [Fiberdyne Linux fork](https://github.com/fiberdyne/linux), which will automatically clone the AVIRT Driver and required AudioPath modules to the `drivers/staging` directory. You can then turn AVIRT Support on by setting to `<M>`. The drivers can be found here: +``` +$ make menuconfig + +# Navigate to: Device Drivers--->Staging Drivers--->AVIRT Support +``` +Finally build the kernel with the configuration selected by making. +``` +$ make +```
\ No newline at end of file |