aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames O'Shannessy <james.oshannessy@fiberdyne.com.au>2018-10-08 12:26:39 +1100
committerMark Farrugia <mark.farrugia@fiberdyne.com.au>2018-10-26 17:27:43 +1100
commita3e9a9eb2b927ef05161f1c2bf5feb62db84c5b3 (patch)
treeb6248e9b2bbf62465777457f34bd1f79ea16760b
parent819bbaa22430988a88999e283ceb02368ad0f7b3 (diff)
Added load/unload documentation.
Updated documentation to use load/unload Signed-off-by: James O'Shannessy <james.oshannessy@fiberdyne.com.au>
-rw-r--r--docs/3. Usage.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/3. Usage.md b/docs/3. Usage.md
index b5ec136..7eb46d3 100644
--- a/docs/3. Usage.md
+++ b/docs/3. Usage.md
@@ -11,6 +11,16 @@ Using AVIRT
## Loading and Unloading AVIRT
+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/dummy_audiopath.ko
+```
+
+### Note:
+The loading and unloading of drivers can be performed using the helper scripts.
To run, we must load the kernel modules using the `loadDrivers.sh` script, which contains sample module parameters to AVIRT:
```sh
$ ./loadDrivers.sh