summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-25 17:37:07 +1100
committerMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-26 17:27:50 +1100
commitd66dbf0820e9e7e14a6f723c1ce92b7ac4e0280d (patch)
treea63bb7dea2279c61cdfa52c78d3b889e6e0c8869 /docs
parentd8ff159e37cb3768358b350b2dc80118d81d4b2c (diff)
Refactor all avirt_ symbols to have have snd prefix, as per Linux sound
This will aid the eventual migration the the upstream mainline Linux kernel Fix some checkpatch warnings, and other compiler warnings Signed-off-by: Mark Farrugia <mark.farrugia@fiberdyne.com.au>
Diffstat (limited to 'docs')
-rw-r--r--docs/2.Building.md2
-rw-r--r--docs/3.Usage.md40
2 files changed, 21 insertions, 21 deletions
diff --git a/docs/2.Building.md b/docs/2.Building.md
index 3e42746..5fd9d23 100644
--- a/docs/2.Building.md
+++ b/docs/2.Building.md
@@ -28,7 +28,7 @@ $ make
or
```sh
-$ CONFIG_AVIRT=m CONFIG_AVIRT_BUILDLOCAL=y CONFIG_AVIRT_DUMMYAP=m make -C /lib/modules/$(uname -r)/build/ M=$(pwd)
+$ CONFIG_AVIRT=m CONFIG_AVIRT_BUILDLOCAL=y CONFIG_AVIRT_AP_DUMMY=m CONFIG_AVIRT_AP_LOOPBACK=m make -C /lib/modules/$(uname -r)/build/ M=$(pwd)
```
The latter is executed internally with the make file.
diff --git a/docs/3.Usage.md b/docs/3.Usage.md
index d65d50d..f535a07 100644
--- a/docs/3.Usage.md
+++ b/docs/3.Usage.md
@@ -18,9 +18,9 @@ As root, load the required `avirt_core.ko` and subsequent audio path.
As an example, the Dummy Audiopath is being loaded here.
```sh
-insmod avirt_core.ko
-insmod dummy/avirt_dummyap.ko
-insmod loopback/avirt_loopbackap.ko
+insmod snd-avirt-core.ko
+insmod dummy/snd-avirt-ap-dummy.ko
+insmod loopback/snd-avirt-ap-loopback.ko
```
### Note:
@@ -47,16 +47,16 @@ For example, in AGL:
```sh
mkdir -p /lib/modules/$(uname -r)/extra
-cp avirt_core.ko avirt_dummyap.ko avirt_loopbackap.ko /lib/modules/$(uname -r)/extra
+cp snd-avirt-core.ko snd-avirt-ap-dummy.ko snd-avirt-ap-loopback.ko /lib/modules/$(uname -r)/extra
depmod
```
Once the modules are in place, we can load the modules using:
```sh
-modprobe avirt_core
-modprobe avirt_dummyap
-modprobe avirt_loopbackap
+modprobe snd-avirt-core
+modprobe snd-avirt-ap-dummy
+modprobe snd-avirt-ap-loopback
```
<a name="configure-avirt" />
@@ -93,24 +93,24 @@ Finally, we can configure AVIRT, for example:
```sh
# Set up each of the cards channels
-mkdir /config/avirt/streams/playback_media
-echo "2">/config/avirt/streams/playback_media/channels
-echo "ap_dummy">/config/avirt/streams/playback_media/map
+mkdir /config/snd-avirt/streams/playback_media
+echo "2">/config/snd-avirt/streams/playback_media/channels
+echo "ap_dummy">/config/snd-avirt/streams/playback_media/map
-mkdir /config/avirt/streams/playback_navigation
-echo "1">/config/avirt/streams/playback_navigation/channels
-echo "ap_dummy">/config/avirt/streams/playback_navigation/map
+mkdir /config/snd-avirt/streams/playback_navigation
+echo "1">/config/snd-avirt/streams/playback_navigation/channels
+echo "ap_dummy">/config/snd-avirt/streams/playback_navigation/map
-mkdir /config/avirt/streams/playback_emergency
-echo "1">/config/avirt/streams/playback_emergency/channels
-echo "ap_dummy">/config/avirt/streams/playback_emergency/map
+mkdir /config/snd-avirt/streams/playback_emergency
+echo "1">/config/snd-avirt/streams/playback_emergency/channels
+echo "ap_dummy">/config/snd-avirt/streams/playback_emergency/map
-mkdir /config/avirt/streams/capture_voice
-echo "1">/config/avirt/streams/capture_voice/channels
-echo "ap_dummy">/config/avirt/streams/capture_voice/map
+mkdir /config/snd-avirt/streams/capture_voice
+echo "1">/config/snd-avirt/streams/capture_voice/channels
+echo "ap_dummy">/config/snd-avirt/streams/capture_voice/map
# Finally, seal the card, and initiate configuration
-echo "1">/config/avirt/streams/sealed
+echo "1">/config/snd-avirt/streams/sealed
```
Alternatively, the test script at `scripts/test_configfs.sh` can be used.