[Sound-open-firmware] [RFC PATCH 6/6] doc: add README for host testbench
Ranjani Sridharan
ranjani.sridharan at linux.intel.com
Fri Jun 1 04:29:10 CEST 2018
Signed-off-by: Ranjani Sridharan <ranjani.sridharan at linux.intel.com>
---
doc/README-HOST | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
create mode 100644 doc/README-HOST
diff --git a/doc/README-HOST b/doc/README-HOST
new file mode 100644
index 0000000..30ad583
--- /dev/null
+++ b/doc/README-HOST
@@ -0,0 +1,23 @@
+The host testbench is meant to serve as a vehicle to test components for functionality
+and quality of processed samples.
+
+Compilation steps:
+
+Run the host-build-all.sh to build the required libraries for the testbench.
+It should also build the testbench executable.
+
+Running the Testbench:
+
+The test can be invoked by running the "testbench" bin in the src/host directory.
+
+Compile and run using script provided (Recommended):
+
+Set up the input arguments for the test in
+"host-testbench.sh" and invoke it to compile the host libraries
+and execute the testbench.
+
+Known Limitations:
+
+1. Currently, testbench code supports simple volume topologies only.
+
+2. When setting up arguments, please keep the same file format for input and output files
--
2.17.0
More information about the Sound-open-firmware
mailing list