Merge pull request #220 from xmos/release/v5.3.0

Release v5.3.0
xmos · Aug 1, 2024 · e4996bd · e4996bd
2 parents 28cc9b1 + a6b315f
commit e4996bd
Show file tree

Hide file tree

Showing 22 changed files with 160 additions and 167 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,12 @@
 lib_mic_array change log
 ========================
 
+5.3.0
+-----
+
+  * FIXED:   Vanilla configuration now compiles correctly under XTC 15.3.0
+  * ADDED:   Support for XCommon CMake build system
+
 5.2.0
 -----
 
@@ -215,4 +221,3 @@ lib_mic_array change log
     - lib_logging: Added dependency 2.0.0
 
     - lib_xassert: Added dependency 2.0.0
-
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -1,4 +1,4 @@
-@Library('xmos_jenkins_shared_library@v0.25.0') _
+@Library('xmos_jenkins_shared_library@v0.33.0') _
 getApproval()
 pipeline {
     agent none
@@ -15,53 +15,82 @@ pipeline {
     parameters {
         string(
             name: 'TOOLS_VERSION',
-            defaultValue: '15.2.1',
+            defaultValue: '15.3.0',
             description: 'The XTC tools version'
         )
     }
     environment {
         REPO = 'lib_mic_array'
     }
     stages {
-        stage('Basic tests') {
-            agent {
-                label 'x86_64 && linux'
-            }
-            stages {
-                stage("Setup") {
-                    // Clone and install build dependencies
+        stage('Build and Docs') {
+            parallel {
+                stage('Build Docs') {
+                    agent { label "docker" }
+                    environment { XMOSDOC_VERSION = "v4.0" }
                     steps {
-                        // Print the build agent name
-                        println "RUNNING ON"
-                        println env.NODE_NAME
-                        // Clone infrastructure repos
-                        sh "git clone --branch v1.4.6 git@github.com:xmos/infr_apps"
-                        sh "git clone --branch v1.2.1 git@github.com:xmos/infr_scripts_py"
-                        // clone
-                        dir("$REPO") {
-                            checkout scm
-                            sh "git submodule update --init --recursive"
-                            withTools(params.TOOLS_VERSION) {
-                                installDependencies()
-                            }
+                        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
+                    }
+                    post {
+                        cleanup {
+                            xcoreCleanSandbox()
                         }
                     }
                 }
-                stage("Lib checks") {
-                    steps {
-                        println "Unlikely these will pass.."
-                        // warnError("Source Check"){ sourceCheck("${REPO}") }
-                        // warnError("Changelog Check"){ xcoreChangelogCheck("${REPO}") }
+                stage('Basic tests') {
+                    when {
+                        expression { !env.GH_LABEL_DOC_ONLY.toBoolean() }
+                    }
+                    agent {
+                        label 'x86_64 && linux'
+                    }
+                    stages {
+                        stage("Setup") {
+                            // Clone and install build dependencies
+                            steps {
+                                // Print the build agent name
+                                println "RUNNING ON"
+                                println env.NODE_NAME
+                                // Clone infrastructure repos
+                                sh "git clone --branch v1.6.0 git@github.com:xmos/infr_apps"
+                                sh "git clone --branch v1.3.0 git@github.com:xmos/infr_scripts_py"
+                                // clone
+                                dir("$REPO") {
+                                    checkout scm
+                                    sh "git submodule update --init --recursive"
+                                    withTools(params.TOOLS_VERSION) {
+                                        installDependencies()
+                                    }
+                                }
+                            }
+                        }
+                        stage("Lib checks") {
+                            steps {
+                                println "Unlikely these will pass.."
+                                // warnError("Source Check"){ sourceCheck("${REPO}") }
+                                // warnError("Changelog Check"){ xcoreChangelogCheck("${REPO}") }
+                            }
+                        }
+                    }
+                    post {
+                        cleanup {
+                            xcoreCleanSandbox()
+                        }
                     }
-                }
-            }
-            post {
-                cleanup {
-                    xcoreCleanSandbox()
                 }
             }
         }
         stage('HW tests') {
+            when {
+                expression { !env.GH_LABEL_DOC_ONLY.toBoolean() }
+            }
             agent {
                 label 'xvf3800' // We have plenty of these (6) and they have a single XTAG connected
             }
@@ -115,4 +144,4 @@ pipeline {
             }
         }
     }
-}
+}
diff --git a/demos/common/src/dac_port.c b/demos/common/src/dac_port.c
@@ -1,11 +1,12 @@
-// Copyright (c) 2022-2023 XMOS LIMITED.
+// Copyright (c) 2022-2024 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public License: Version 1
 
 #include <assert.h>
 
 #include "app_config.h"
 #include "i2c.h"
 #include "aic3204/aic3204.h"
+#include "platform.h"
 
 i2c_master_t i2c_master_ctx;
 

diff --git a/demos/demo/src/app.cpp b/demos/demo/src/app.cpp
@@ -1,8 +1,8 @@
-// Copyright 2022 XMOS LIMITED.
+// Copyright 2022-2024 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include "app.h"
-
+#include <platform.h>
 #include "mic_array/cpp/Prefab.hpp"
 
 #define DCOE_ENABLED    true

diff --git a/demos/demo/src/app_i2s.c b/demos/demo/src/app_i2s.c
@@ -1,4 +1,4 @@
-// Copyright 2022 XMOS LIMITED.
+// Copyright 2022-2024 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <platform.h>
@@ -15,6 +15,7 @@
 #include <assert.h>
 #include <stdlib.h>
 #include <string.h>
+#include <platform.h>
 
 #include <math.h>
 

diff --git a/demos/demo_par_decimator/src/app.cpp b/demos/demo_par_decimator/src/app.cpp
@@ -1,9 +1,10 @@
-// Copyright 2023 XMOS LIMITED.
+// Copyright 2023-2024 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <stdint.h>
 #include <xcore/channel_streaming.h>
 #include <xcore/interrupt.h>
+#include <platform.h>
 
 #include "app_config.h"
 #include "app_mic_array.hpp"

diff --git a/demos/demo_par_decimator/src/app_i2s.c b/demos/demo_par_decimator/src/app_i2s.c
@@ -1,4 +1,4 @@
-// Copyright 2023 XMOS LIMITED.
+// Copyright 2023-2024 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <platform.h>
@@ -18,6 +18,7 @@
 #include <assert.h>
 #include <stdlib.h>
 #include <string.h>
+#include <platform.h>
 
 #include <math.h>
 

diff --git a/demos/demo_vanilla/src/app_i2s.c b/demos/demo_vanilla/src/app_i2s.c
@@ -1,4 +1,4 @@
-// Copyright 2022 XMOS LIMITED.
+// Copyright 2022-2024 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <platform.h>
@@ -15,6 +15,7 @@
 #include <assert.h>
 #include <stdlib.h>
 #include <string.h>
+#include <platform.h>
 
 #include <math.h>
 

diff --git a/demos/measure_mips/src/app.cpp b/demos/measure_mips/src/app.cpp
@@ -1,11 +1,12 @@
-// Copyright 2022 XMOS LIMITED.
+// Copyright 2022-2024 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <iostream>
 #include <cstdio>
 #include <xcore/channel_streaming.h>
 
 #include "app.h"
+#include <platform.h>
 
 #include "mic_array/cpp/MicArray.hpp"
 #include "mic_array/cpp/Prefab.hpp"