merged with develop

Signed-off-by: keithm-xmos <[email protected]>

.github/ISSUE_TEMPLATE/bug_issue.md

@@ -9,7 +9,7 @@ assignees: keithm-xmos
 
 **System information**
  - OS: [e.g. Mac, Linux, Windows]
- - XCore board [e.g. Explorer, Osprey]
+ - xcore board [e.g. Explorer, Osprey]
  - SDK version tag or commit SHA
 
 **Describe the current behavior**

.github/ISSUE_TEMPLATE/documentation_issue.md

@@ -11,7 +11,7 @@ Thank you for submitting an SDK documentation issue. Please provide as much info
 
 **System information**
  - OS: [e.g. Mac, Linux, Windows]
- - XCore board [e.g. Explorer, Osprey]
+ - xcore board [e.g. Explorer, Osprey]
  - SDK version tag or commit SHA
 
 **Describe the documentation issue**

.github/workflows/ci_examples.yml

@@ -94,20 +94,6 @@ jobs:
         with:
           submodules: recursive
 
-      - name: Install Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: '3.8' 
-
-      - name: Install Python requirements
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r tools/install/requirements.txt
-
-      - name: Make input data for examples
-        run: |
-          cd ./examples/freertos/cifar10/filesystem_support/test_inputs && python make_test_tensors.py
-
       - name: Pull SDK builder
         run: |
           docker pull ${SDK_BUILDER_IMAGE}

.gitmodules

@@ -5,7 +5,7 @@
 	path = xmos_cmake_toolchain
 	url = [email protected]:xmos/xmos_cmake_toolchain.git
 [submodule "avona"]
-	path = modules/avona
+	path = modules/voice
 	url = [email protected]:xmos/sw_avona.git
 [submodule "frameworks/core"]
 	path = modules/core

CHANGELOG.rst

@@ -1,10 +1,12 @@
-XCore SDK change log
+XCORE SDK change log
 ====================
 
-In progress
------------
-
+0.11.0
+------
 
+  * Removed of the FreeRTOS cifar10 example application
+  * Removed visual_wake_word bare-metal example application
+  * Removed inferencing modules
 
 0.10.0
 ------

Jenkinsfile

@@ -109,15 +109,6 @@ pipeline {
                                 echo 'SKIPPED: example_freertos_explorer_board'
                             }
                         } 
-                        script {
-                            if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_cifar10.xe")) {
-                                withXTAG("$SDK_TEST_RIG_TARGET") { adapterID ->
-                                    sh "test/examples/run_freertos_cifar10_tests.sh $adapterID"
-                                }
-                            } else {
-                                echo 'SKIPPED: example_freertos_cifar10'
-                            }
-                        } 
                         script {
                             if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_dispatcher.xe")) {
                                 withXTAG("$SDK_TEST_RIG_TARGET") { adapterID ->
@@ -140,23 +131,16 @@ pipeline {
                 }
             }
         }
-        stage('Run bare-metal examples') {
-            steps {
-                withTools(params.TOOLS_VERSION) {
-                    withVenv {
-                        script {
-                            if (fileExists("$DOWNLOAD_DIRNAME/example_bare_metal_vww_test.xe")) {
-                                withXTAG("$SDK_TEST_RIG_TARGET") { adapterID ->
-                                    sh "test/examples/run_bare_metal_vww_tests.sh $adapterID"
-                                }
-                            } else {
-                                echo 'SKIPPED: example_bare_metal_vww'
-                            }
-                        } 
-                    }
-                }
-            }
-        }
+        // stage('Run bare-metal examples') {
+        //     steps {
+        //         withTools(params.TOOLS_VERSION) {
+        //             withVenv {
+        //                 script {
+        //                 } 
+        //             }
+        //         }
+        //     }
+        // }
     }
     post {
         cleanup {

README.md

@@ -1,17 +1,17 @@
-# XCore SDK Repository
+# XCORE:registered: SDK Repository
 
 [![Version](https://img.shields.io/github/v/release/xmos/xcore_sdk?include_prereleases)](https://github.com/xmos/xcore_sdk/releases/latest)
 [![Issues](https://img.shields.io/github/issues/xmos/xcore_sdk)](https://github.com/xmos/xcore_sdk/issues)
 [![Contributors](https://img.shields.io/github/contributors/xmos/xcore_sdk)](https://github.com/xmos/xcore_sdk/graphs/contributors)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/xmos/xcore_sdk/pulls)
 
-The XCore SDK is a collection of C/C++ software libraries designed to simplify and accelerate application development on XCore processors. It is composed of the following components:
+The XCORE SDK is a collection of C/C++ software libraries designed to simplify and accelerate application development on xcore processors. It is composed of the following components:
 
 - Peripheral IO libraries including; UART, I2C, I2S, SPI, QSPI, PDM microphones, and USB. These libraries support bare-metal and RTOS application development.
-- Libraries core to DSP and AI applications, including; vectorized math, DSP, and neural network inferencing. These libraries support bare-metal and RTOS application development. 
+- Libraries core to DSP applications, including vectorized math.  These libraries support bare-metal and RTOS application development. 
 - Voice processing libraries including; adaptive echo cancellation, adaptive gain control, noise suppression, interference cancellation (IC), and voice activity detection. These libraries support bare-metal and RTOS application development.
-- Libraries that enable [multi-core FreeRTOS development](https://www.freertos.org/symmetric-multiprocessing-introduction.html) on XCore including a wide array of RTOS drivers and middleware.
-- Code Examples - Examples showing a variety of XCore features based on bare-metal and FreeRTOS programming.
+- Libraries that enable [multi-core FreeRTOS development](https://www.freertos.org/symmetric-multiprocessing-introduction.html) on xcore including a wide array of RTOS drivers and middleware.
+- Code Examples - Examples showing a variety of xcore features based on bare-metal and FreeRTOS programming.
 
 The SDK is designed to be used in conjunction with the xcore.ai Explorer board evaluation kit. The example applications compile targeting this board. Further information about the Explorer board and xcore.ai devices is available to on [www.xmos.ai](https://www.xmos.ai/).
 
@@ -31,7 +31,7 @@ Some dependent components are included as git submodules. These can be obtained
 
 ## Development Tools
 
-Download and install the XCore [XTC Tools](https://www.xmos.ai/software-tools/) version 15.1.0 or newer. If you already have the XTC Toolchain installed, you can check the version with the following command:
+Download and install the xcore [XTC Tools](https://www.xmos.ai/software-tools/) version 15.1.0 or newer. If you already have the XTC Toolchain installed, you can check the version with the following command:
 
     xcc --version
 
@@ -46,7 +46,7 @@ See the [official documentation](https://www.xmos.ai/xcore-sdk/) for more inform
 
 ## Getting Help
 
-A [Github issue](https://github.com/xmos/xcore_sdk/issues/new/choose) should be the primary method of getting in touch with the XMOS SDK development team.
+A [Github issue](https://github.com/xmos/xcore_sdk/issues/new/choose) should be the primary method of getting in touch with the XMOS XCORE SDK development team.
 
 ## License
 

doc/Doxyfile.inc

@@ -1,7 +1,7 @@
 # This file provides overrides to the Doxyfile configuration
 
-PROJECT_NAME = XCore SDK
-PROJECT_BRIEF = "XCore Software Development Kit"
+PROJECT_NAME = XCORE SDK
+PROJECT_BRIEF = "XCORE Software Development Kit"
 
 PREDEFINED = __DOXYGEN__=1 
 PREDEFINED += DWORD_ALIGNED=
@@ -25,13 +25,13 @@ INPUT += ../modules/rtos/modules/drivers
 # RTOS SW Services
 INPUT += ../modules/rtos/modules/sw_services/device_control/host ../modules/rtos/modules/sw_services/device_control/api 
 
-# Avona library APIs
-INPUT += ../modules/avona/modules/lib_aec/api ../modules/avona/examples/bare-metal/shared_src/aec/
-INPUT += ../modules/avona/modules/lib_ns/api
-INPUT += ../modules/avona/modules/lib_agc/api
-INPUT += ../modules/avona/modules/lib_adec/api
-INPUT += ../modules/avona/modules/lib_ic/api
-INPUT += ../modules/avona/modules/lib_vad/api
+# Voice DSP library APIs
+INPUT += ../modules/voice/modules/lib_aec/api ../modules/voice/examples/bare-metal/shared_src/aec/
+INPUT += ../modules/voice/modules/lib_ns/api
+INPUT += ../modules/voice/modules/lib_agc/api
+INPUT += ../modules/voice/modules/lib_adec/api
+INPUT += ../modules/voice/modules/lib_ic/api
+INPUT += ../modules/voice/modules/lib_vad/api
 
 USE_MATHJAX = YES
 MATHJAX_FORMAT = HTML-CSS

doc/README.rst

@@ -2,7 +2,7 @@
 Documentation Source
 ####################
 
-This folder contains source files for the **XCore SDK documentation**.  The sources do not render well in GitHub or an RST viewer.  In addition, some information 
+This folder contains source files for the **XCORE SDK documentation**.  The sources do not render well in GitHub or an RST viewer.  In addition, some information 
 is not visible at all and some links will not be functional.
 
 ********************

doc/contributing.rst

@@ -38,7 +38,7 @@ Install development packages:
 
 .. code-block:: console
 
-    pip install -r tools/install/requirements.txt -r tools/install/contribute.txt -r doc/requirements.txt
+    pip install -r tools/install/requirements.txt -r tools/install/contribute.txt
 
 Run the following command to deactivate the Conda environment:
 
@@ -74,9 +74,9 @@ clang-format
 clang-format can be used to:
 
 - Reformat a block of code to the SDK style.
-- Help you follow the XCore SDK coding style.
+- Help you follow the XCORE SDK coding style.
 
-The SDK's clang-format configuration file is `.clang-format` and is in the root of the xcore_sdk repository. The rules contained in ``.clang-format`` were originally derived from the Linux Kernel coding style. A few modifications have been made by the XCore SDK authors. Not all code in the XCore SDK follows the ``.clang-format`` rules.  Some non-compliant code is intentional while some is not.  Non-intentional instances should be addressed when the non-compliant code needs to be enhanced.
+The SDK's clang-format configuration file is `.clang-format` and is in the root of the xcore_sdk repository. The rules contained in ``.clang-format`` were originally derived from the Linux Kernel coding style. A few modifications have been made by the XCORE SDK authors. Not all code in the XCORE SDK follows the ``.clang-format`` rules.  Some non-compliant code is intentional while some is not.  Non-intentional instances should be addressed when the non-compliant code needs to be enhanced.
 
 For more information about `clang-format` visit:
 

doc/exclude_patterns.inc

@@ -11,4 +11,4 @@ modules/core/modules/random
 modules/core/modules/inferencing
 modules/io/modules/xud
 modules/io/doc/substitutions.rst
-modules/avona/doc/substitutions.rst
+modules/voice/doc/substitutions.rst

doc/quick_start/index.rst

@@ -2,13 +2,13 @@
 Introduction
 ############
 
-The XCore SDK is a collection of C/C++ software libraries designed to simplify and accelerate application development on XCore processors. It is composed of the following components:
+The XCORE SDK is a collection of C/C++ software libraries designed to simplify and accelerate application development on xcore processors. It is composed of the following components:
 
 - Peripheral IO libraries including; UART, I2C, I2S, SPI, QSPI, PDM microphones, and USB. These libraries support bare-metal and RTOS application development.
-- Libraries core to DSP and AI applications, including; vectorized math, DSP, and neural network inferencing. These libraries support bare-metal and RTOS application development. 
+- Libraries core to DSP applications, including vectorized math.  These libraries support bare-metal and RTOS application development. 
 - Voice processing libraries including; adaptive echo cancellation, adaptive gain control, noise suppression, interference cancellation (IC), and voice activity detection. These libraries support bare-metal and RTOS application development.
-- Libraries that enable `multi-core FreeRTOS development <https://www.freertos.org/symmetric-multiprocessing-introduction.html>`__ on XCore including a wide array of RTOS drivers and middleware.
-- Code Examples - Examples showing a variety of XCore features based on bare-metal and FreeRTOS programming.
+- Libraries that enable `multi-core FreeRTOS development <https://www.freertos.org/symmetric-multiprocessing-introduction.html>`__ on xcore including a wide array of RTOS drivers and middleware.
+- Code Examples - Examples showing a variety of xcore features based on bare-metal and FreeRTOS programming.
 - Documentation - Getting started guides, references and API guides.
 
 The SDK is designed to be used in conjunction with the xcore.ai Explorer board and the Voice Reference evaluation kit. The example applications compile targeting these boards. Further information about the Explorer board, the Voice Reference evaluation kit, and xcore.ai devices is available to on `www.xmos.ai <https://www.xmos.ai/>`__.
@@ -17,4 +17,4 @@ The SDK is designed to be used in conjunction with the xcore.ai Explorer board a
 Getting Started
 ***************
 
-Fast-forward to the :ref:`Tutorials <sdk-tutorials>` for information on installing and using the XCore SDK.   
+Fast-forward to the :ref:`Tutorials <sdk-tutorials>` for information on installing and using the XCORE SDK.   

doc/quick_start/installation.rst

@@ -9,7 +9,7 @@ Follow the following steps to install and setup the SDK:
 Step 1. Cloning the SDK
 =======================
 
-Clone the XCore SDK repository with the following command:
+Clone the XCORE SDK repository with the following command:
 
 .. code-block:: console
 
@@ -66,9 +66,8 @@ Then use `pip` to install the required modules.
 
     $ pip install -r tools/install/requirements.txt
 
-**********************************
 Build & Run Your First Application
-**********************************
+==================================
 
-Once your have installed the SDK, the next step is to :ref:`build and run your first XCore application. <sdk-tutorials>`
+Once your have installed the SDK, the next step is to :ref:`build and run your first xcore application. <sdk-tutorials>`
 

doc/quick_start/system-requirements.rst

@@ -4,7 +4,7 @@
 System Requirements
 ###################
 
-The XCore SDK is officially supported on the following platforms. Unofficial support is mentioned where appropriate.
+The XCORE SDK is officially supported on the following platforms. Unofficial support is mentioned where appropriate.
 
 
 .. tab:: Windows

doc/reference/index.rst

@@ -7,5 +7,4 @@ References
 
    ../../modules/core/index.rst
    ../../modules/io/index.rst
-   ../../modules/avona/index.rst
    ../../modules/rtos/index.rst