Release/v3.0.5

.xmos_ignore_source_check

@@ -0,0 +1,5 @@
+modules/FreeRTOS
+modules/drivers/wifi
+fatfs_mkimage/argtable/
+fatfs_mkimage/src/tinydir.h
+thirdparty

CHANGELOG.rst

@@ -1,6 +1,16 @@
 RTOS Framework change log
 =========================
 
+3.0.5
+-----
+
+  * FIXED: Added dummy definitions of vTaskCoreAffinitySet() and vTaskCoreAffinitySet() functions to
+    avoid warnings when configNUM_CORES is set to 1.
+  * UPDATED: Updated xmos_cmake_toolchain to v1.0.0 from untagged commit e577fbc
+  * UPDATED: Tested against fwk_io v3.3.0 updated from v3.0.1
+  * UPDATED: Tested against fwk_core v1.0.2 updated from v1.0.0
+  * ADDED: Runtime check for I2S RPC functions called for I2S Slave
+
 3.0.4
 -----
 

Jenkinsfile

@@ -1,11 +1,9 @@
-@Library('xmos_jenkins_shared_library@v0.20.0') _
+@Library('xmos_jenkins_shared_library@v0.27.0') _
 
 getApproval()
 
 pipeline {
-    agent {
-        label 'xcore.ai-explorer-us'
-    }
+    agent none
     options {
         disableConcurrentBuilds()
         skipDefaultCheckout()
@@ -32,99 +30,151 @@ pipeline {
         LOCAL_WIFI_PASS = credentials('hampton-office-network-wifi-password')
     }    
     stages {
-        stage('Checkout') {
-            steps {
-                checkout scm
-                sh 'git submodule update --init --recursive --depth 1 --jobs \$(nproc)'
-            }
-        }
-        stage('Build tests and host apps') {
-            steps {
-                script {
-                    uid = sh(returnStdout: true, script: 'id -u').trim()
-                    gid = sh(returnStdout: true, script: 'id -g').trim()
-                }
-                withTools(params.TOOLS_VERSION) {
-                    sh "bash tools/ci/build_rtos_tests.sh"
-                    sh "bash tools/ci/build_host_apps.sh"
-                }
-                // List built files for log
-                sh "ls -la dist/"
-                sh "ls -la dist_host/"
-            }
-        }
-        stage('Create virtual environment') {
-            steps {
-                // Create venv
-                sh "pyenv install -s $PYTHON_VERSION"
-                sh "~/.pyenv/versions/$PYTHON_VERSION/bin/python -m venv $VENV_DIRNAME"
-                // Install dependencies
-                withVenv() {
-                    sh "pip install git+https://github0.xmos.com/xmos-int/xtagctl.git"
-                    sh "pip install -r test/requirements.txt"
-                }
-            }
-        }
-        stage('Cleanup xtagctl') {
-            steps {
-                // Cleanup any xtagctl cruft from previous failed runs
-                withTools(params.TOOLS_VERSION) {
-                    withVenv {
-                        sh "xtagctl reset_all $RTOS_TEST_RIG_TARGET"
+        stage('Build and Docs') {
+            parallel {
+                stage('Build Docs') {
+                    agent { label "docker" }
+                    environment { XMOSDOC_VERSION = "v4.0" }
+                    steps {
+                        checkout scm
+                        sh 'git submodule update --init --recursive --depth 1'
+                        sh "docker pull ghcr.io/xmos/xmosdoc:$XMOSDOC_VERSION"
+                        sh """docker run -u "\$(id -u):\$(id -g)" \
+                            --rm \
+                            -v ${WORKSPACE}:/build \
+                            ghcr.io/xmos/xmosdoc:$XMOSDOC_VERSION -v"""
+                        archiveArtifacts artifacts: "doc/_build/**", allowEmptyArchive: true
                     }
-                }
-                sh "rm -f ~/.xtag/status.lock ~/.xtag/acquired"
-            }
-        }
-        stage('Run RTOS Drivers HIL test') {
-            steps {
-                withTools(params.TOOLS_VERSION) {
-                    withVenv {
-                        script {
-                            withXTAG(["$RTOS_TEST_RIG_TARGET"]) { adapterIDs ->
-                                sh "test/rtos_drivers/hil/check_drivers_hil.sh " + adapterIDs[0]
-                            }
-                            sh "pytest test/rtos_drivers/hil"
+                    post {
+                        cleanup {
+                            xcoreCleanSandbox()
                         }
                     }
                 }
-            }
-        }
-        stage('Run RTOS Drivers HIL_Add test') {
-            steps {
-                withTools(params.TOOLS_VERSION) {
-                    withVenv {
-                        script {
-                            withXTAG(["$RTOS_TEST_RIG_TARGET"]) { adapterIDs ->
-                                sh "test/rtos_drivers/hil_add/check_drivers_hil_add.sh " + adapterIDs[0]
+
+                stage('Build and Test') {
+                    when {
+                        expression { !env.GH_LABEL_DOC_ONLY.toBoolean() }
+                    }
+                    agent {
+                        label 'xcore.ai-explorer-us'
+                    }
+                    stages {
+                        stage('Checkout') {
+                            steps {
+                                checkout scm
+                                sh 'git submodule update --init --recursive --depth 1 --jobs \$(nproc)'
                             }
-                            sh "pytest test/rtos_drivers/hil_add"
                         }
-                    }
-                }
-            }
-        }
-        stage('Run RTOS Drivers WiFi test') {
-            steps {
-                withTools(params.TOOLS_VERSION) {
-                    withVenv {
-                        script {
-                            withXTAG(["$RTOS_TEST_RIG_TARGET"]) { adapterIDs ->
-                                sh "test/rtos_drivers/wifi/check_wifi.sh " + adapterIDs[0]
+                        stage('Build tests and host apps') {
+                            steps {
+                                script {
+                                    uid = sh(returnStdout: true, script: 'id -u').trim()
+                                    gid = sh(returnStdout: true, script: 'id -g').trim()
+                                }
+                                // pull docker
+                                sh "docker pull ghcr.io/xmos/xcore_voice_tester:develop"
+                                withTools(params.TOOLS_VERSION) {
+                                    sh "bash tools/ci/build_rtos_tests.sh"
+                                    sh "bash tools/ci/build_host_apps.sh"
+                                }
+                                // List built files for log
+                                sh "ls -la dist/"
+                                sh "ls -la dist_host/"
+                            }
+                        }
+                        stage('Create virtual environment') {
+                            steps {
+                                // Create venv
+                                sh "pyenv install -s $PYTHON_VERSION"
+                                sh "~/.pyenv/versions/$PYTHON_VERSION/bin/python -m venv $VENV_DIRNAME"
+                                // Install dependencies
+                                withVenv() {
+                                    sh "pip install git+https://github0.xmos.com/xmos-int/xtagctl.git"
+                                    sh "pip install -r test/requirements.txt"
+                                }
+                            }
+                        }
+                        stage('Cleanup xtagctl') {
+                            steps {
+                                // Cleanup any xtagctl cruft from previous failed runs
+                                withTools(params.TOOLS_VERSION) {
+                                    withVenv {
+                                        sh "xtagctl reset_all $RTOS_TEST_RIG_TARGET"
+                                    }
+                                }
+                                sh "rm -f ~/.xtag/status.lock ~/.xtag/acquired"
+                            }
+                        }
+                        stage('Run RTOS Drivers WiFi test') {
+                            steps {
+                                withTools(params.TOOLS_VERSION) {
+                                    withVenv {
+                                        script {
+                                            withXTAG(["$RTOS_TEST_RIG_TARGET"]) { adapterIDs ->
+                                                sh "test/rtos_drivers/wifi/check_wifi.sh " + adapterIDs[0]
+                                            }
+                                            sh "pytest test/rtos_drivers/wifi"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                        stage('Run RTOS Drivers HIL test') {
+                            steps {
+                                withTools(params.TOOLS_VERSION) {
+                                    withVenv {
+                                        script {
+                                            withXTAG(["$RTOS_TEST_RIG_TARGET"]) { adapterIDs ->
+                                                sh "test/rtos_drivers/hil/check_drivers_hil.sh " + adapterIDs[0]
+                                            }
+                                            sh "pytest test/rtos_drivers/hil"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                        stage('Run RTOS Drivers HIL_Add test') {
+                            steps {
+                                withTools(params.TOOLS_VERSION) {
+                                    withVenv {
+                                        script {
+                                            withXTAG(["$RTOS_TEST_RIG_TARGET"]) { adapterIDs ->
+                                                sh "test/rtos_drivers/hil_add/check_drivers_hil_add.sh " + adapterIDs[0]
+                                            }
+                                            sh "pytest test/rtos_drivers/hil_add"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                        stage('Run RTOS Drivers USB test') {
+                            steps {
+                                withTools(params.TOOLS_VERSION) {
+                                    withVenv {
+                                        script {
+                                            uid = sh(returnStdout: true, script: 'id -u').trim()
+                                            gid = sh(returnStdout: true, script: 'id -g').trim()
+                                            withXTAG(["$RTOS_TEST_RIG_TARGET"]) { adapterIDs ->
+                                                sh "docker run --rm -u $uid:$gid --privileged -v /dev:/dev -w /fwk_rtos -v $WORKSPACE:/fwk_rtos ghcr.io/xmos/xcore_voice_tester:develop bash -l test/rtos_drivers/usb/check_usb.sh " + adapterIDs[0]
+                                            }
+                                            sh "pytest test/rtos_drivers/usb"
+                                        }
+                                    }
+                                }
                             }
-                            sh "pytest test/rtos_drivers/wifi"
+                        }
+                    }
+                    post {
+                        cleanup {
+                            // cleanWs removes all output and artifacts of the Jenkins pipeline
+                            //   Comment out this post section to leave the workspace which can be useful for running items on the Jenkins agent. 
+                            //   However, beware that this pipeline will not run if the workspace is not manually cleaned.
+                            xcoreCleanSandbox()
                         }
                     }
                 }
             }
         }
     }
-    post {
-        cleanup {
-            // cleanWs removes all output and artifacts of the Jenkins pipeline
-            //   Comment out this post section to leave the workspace which can be useful for running items on the Jenkins agent. 
-            //   However, beware that this pipeline will not run if the workspace is not manually cleaned.
-            cleanWs()
-        }
-    }
 }

README.md

@@ -32,7 +32,7 @@ Supported RTOS stacks and software services include:
 - TinyUSB
 - Generic processing pipeline
 - Inferencing
-- Device control 
+- Device control
 - FatFS
 - HTTP
 - TLS
@@ -55,15 +55,17 @@ Some dependent components are included as git submodules. These can be obtained
 
 ## Testing
 
-Several tests for the RTOS framework modules exist in the [test folder](https://github.com/xmos/fwk_rtos/tree/develop/test).  
+Several tests for the RTOS framework modules exist in the [test folder](https://github.com/xmos/fwk_rtos/tree/develop/test).
 
 ## Documentation
 
-Information on building the documentation can be found in the docs [README](https://github.com/xmos/fwk_rtos/blob/develop/doc/README.rst).
+This folder contains source files for the documentation and is intended for XMOS users. Pre-built documentation is published on https://www.xmos.com.
+
+The sources do not render well in GitHub or an RST viewer.
 
 ## License
 
 This Software is subject to the terms of the [XMOS Public Licence: Version 1](https://github.com/xmos/fwk_rtos/blob/develop/LICENSE.rst)
 
-Third party copyrighted code is specified in the fwk_rtos [Copyrights and Licenses](https://github.com/xmos/fwk_rtos/blob/develop/doc/copyright.rst).  
+Third party copyrighted code is specified in the fwk_rtos [Copyrights and Licenses](https://github.com/xmos/fwk_rtos/blob/develop/doc/copyright.rst).