summaryrefslogtreecommitdiffstats
path: root/docs/3.Usage.md
diff options
context:
space:
mode:
authorMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-09 10:10:49 +1100
committerMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-26 17:27:47 +1100
commit964987727646a7139a3d259830f25a739937fa73 (patch)
treeb7d30653b4b91b86615b5cc84cb94e6994dc569f /docs/3.Usage.md
parentcd128853f392960ceec44476f37f0d569a680db5 (diff)
Add docs: Add architecture diagram for 4A
Tidy other docs Signed-off-by: Mark Farrugia <mark.farrugia@fiberdyne.com.au>
Diffstat (limited to 'docs/3.Usage.md')
-rw-r--r--docs/3.Usage.md30
1 files changed, 24 insertions, 6 deletions
diff --git a/docs/3.Usage.md b/docs/3.Usage.md
index df56cf1..d65d50d 100644
--- a/docs/3.Usage.md
+++ b/docs/3.Usage.md
@@ -75,13 +75,13 @@ First, verify the kernel supports the use of configfs.
fgrep configfs /proc/filesystems
```
-the expected output is:
+The expected output is:
```
nodev configfs
```
-Once confirmed, we can mount the configfs at the conventional point:
+Once confirmed, we can mount the `configfs` filesystem at the conventional point:
```sh
# Check configfs is mounted on the system
@@ -89,7 +89,7 @@ mkdir -p /config
mount -t configfs none /config
```
-Finally, we can configure AVIRT:
+Finally, we can configure AVIRT, for example:
```sh
# Set up each of the cards channels
@@ -115,7 +115,25 @@ echo "1">/config/avirt/streams/sealed
Alternatively, the test script at `scripts/test_configfs.sh` can be used.
-### Note:
+The user-space library, [libavirt](https://github.com/fiberdyne/libavirt) can be used to interact with the configfs interface. Please refer to the README in libavirt for further details.
+
+<a name="checking-avirt" />
+
+## 3. Checking AVIRT Loaded Correctly
-A simplified helper library, libavirt, is available [here](https://github.com/fiberdyne/libavirt).
-Please refer to the readme in libavirt for further details.
+We can see the newly created streams by using the `aplay` utility. For example, the device list might look a little like this:
+
+```sh
+aplay -l
+...
+card 2: avirt [avirt], device 0: multimedia [multimedia]
+ Subdevices: 1/1
+ Subdevice #0: subdevice #0
+card 2: avirt [avirt], device 1: navigation [navigation]
+ Subdevices: 1/1
+ Subdevice #0: subdevice #0
+card 2: avirt [avirt], device 2: emergency [emergency]
+ Subdevices: 1/1
+ Subdevice #0: subdevice #0
+...
+```