init

lib_dsp/README.rst

@@ -0,0 +1,64 @@
+xCORE-200 DSP Library
+=====================
+
+:Version: 6.3.0
+:Vendor: XMOS
+
+Summary
+-------
+
+This API reference manual describes the XMOS fixed-point digital signal processing
+software library.  The library implements of a suite of common signal processing functions
+for use on XMOS xCORE-200 multicore microcontrollers.
+
+Required tools
+..............
+
+* xTIMEcomposer Tools Version 14.2.1 or later
+
+Required hardware
+.................
+
+Only XMOS xCORE-200 based multicore microcontrollers are supported with this library.
+The previous generation XS1 based multicore microntrollers are not supported.
+
+The xCORE-200 has a single cycle 32x32->64 bit multiply/accumulate unit,
+single cycle double-word load and store, dual issue instruction execution,
+and other instruction set enhancements.
+These features make xCORE-200 an efficient platform for executing
+digital signal processing algorithms.
+
+Prerequisites
+.............
+
+This document assumes familiarity with the XMOS xCORE architecture,
+the XMOS tool chain, the 'C' programming language,
+and digital signal processing concepts.
+
+Software version and dependencies
+.................................
+
+The CHANGELOG contains information about the current and previous versions.
+For a list of direct dependencies, look for DEPENDENT_MODULES in lib_dsp/module_build_info.
+
+Related application notes
+.........................
+
+The following application notes use this library:
+
+  * AN00209 - xCORE-200 DSP Library
+
+Required Software (dependencies)
+================================
+
+  * lib_logging (www.github.com/xmos/lib_logging)
+
+Documentation
+=============
+
+You can find the documentation for this software in the /doc directory of the package.
+
+Support
+=======
+
+This package is supported by XMOS Ltd. Issues can be raised against the software at: http://www.xmos.com/support