Merge branch 'develop' into feature/xlink_example

xmos · Sep 14, 2022 · 6d8fa13 · 6d8fa13
2 parents 92b68c4 + e934f3f
commit 6d8fa13
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 29 deletions.
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -1,14 +1,4 @@
-@Library('[email protected]') _
-
-def withXTAG(String target, Closure body) {
-    // Acquire an xtag adapter-id by target name
-    def adapterID = sh (script: "xtagctl acquire ${target}", returnStdout: true).trim()
-    // Run the closure
-    body(adapterID)
-    // Release the xtag by adapter-id
-    sh ("xtagctl release ${adapterID}")
-}
-
+@Library('[email protected]') _
 
 // Wait here until specified artifacts appear
 def artifactUrls = getGithubArtifactUrls([
@@ -93,35 +83,35 @@ pipeline {
                     withVenv {
                         script {
                             if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_getting_started.xe")) {
-                                withXTAG("$SDK_TEST_RIG_TARGET") { adapterID ->
-                                    sh "test/examples/run_freertos_getting_started_tests.sh $adapterID"
+                                withXTAG(["$SDK_TEST_RIG_TARGET"]) { adapterIDs ->
+                                    sh "test/examples/run_freertos_getting_started_tests.sh " + adapterIDs[0]
                                 }
                             } else {
                                 echo 'SKIPPED: example_freertos_getting_started'
                             }
                         } 
                         script {
                             if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_explorer_board.xe")) {
-                                withXTAG("$SDK_TEST_RIG_TARGET") { adapterID ->
-                                    sh "test/examples/run_freertos_explorer_board_tests.sh $adapterID"
+                                withXTAG(["$SDK_TEST_RIG_TARGET"]) { adapterIDs ->
+                                    sh "test/examples/run_freertos_explorer_board_tests.sh " + adapterIDs[0]
                                 }
                             } else {
                                 echo 'SKIPPED: example_freertos_explorer_board'
                             }
                         } 
                         script {
                             if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_dispatcher.xe")) {
-                                withXTAG("$SDK_TEST_RIG_TARGET") { adapterID ->
-                                    sh "test/examples/run_freertos_dispatcher_tests.sh $adapterID"
+                                withXTAG(["$SDK_TEST_RIG_TARGET"]) { adapterIDs ->
+                                    sh "test/examples/run_freertos_dispatcher_tests.sh " + adapterIDs[0]
                                 }
                             } else {
                                 echo 'SKIPPED: example_freertos_dispatcher'
                             }
                         } 
                         script {
                             if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_l2_cache.xe")) {
-                                withXTAG("$SDK_TEST_RIG_TARGET") { adapterID ->
-                                    sh "test/examples/run_freertos_l2_cache_tests.sh $adapterID"
+                                withXTAG(["$SDK_TEST_RIG_TARGET"]) { adapterIDs ->
+                                    sh "test/examples/run_freertos_l2_cache_tests.sh " + adapterIDs[0]
                                 }
                             } else {
                                 echo 'SKIPPED: example_freertos_l2_cache'

diff --git a/doc/quick_start/index.rst b/doc/quick_start/index.rst
@@ -4,11 +4,11 @@ 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:
 
-- 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 applications, including vectorized math.  These libraries support bare-metal and RTOS application development. 
+- :ref:`Peripheral IO <fwk_io-peripherals>` libraries including; UART, I2C, I2S, SPI, QSPI, PDM microphones, and USB. These libraries support bare-metal and RTOS application development.
+- Libraries core to :ref:`DSP applications <fwk_core-optimized>`, including :ref:`vectorized math <fwk_core-optimized>`.  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 :ref:`RTOS drivers and middleware <fwk_rtos-framework>`.
+- Code Examples - Examples showing a variety of xcore features based on :ref:`bare-metal <sdk-baremetal-code-examples>` and :ref:`FreeRTOS <sdk-freertos-code-examples>` 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 :ref:`system requirements <sdk-system-requirements>`, :ref:`installing <sdk-installation>` and :ref:`using the XCORE SDK <sdk-tutorials>`.   
diff --git a/doc/quick_start/system-requirements.rst b/doc/quick_start/system-requirements.rst
@@ -10,7 +10,9 @@ The XCORE SDK is officially supported on the following platforms. Unofficial sup
 .. tab:: Windows
 
    Windows 10 is supported.
-
+
+   A standard C/C++ compiler is required to build applications and libraries on the host PC.  Windows users may use `Build Tools for Visual Studio <https://docs.microsoft.com/en-us/cpp/build/building-on-the-command-line?view=msvc-170#download-and-install-the-tools>`__ command-line interface.
+
    Windows users can also use the Windows Subsystem for Linux (WSL).  See `Windows Subsystem for Linux Installation Guide for Windows 10 <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`__ to install WSL.
 
    The SDK should also work using other Windows GNU development environments like GNU Make, MinGW or Cygwin.
@@ -19,7 +21,7 @@ The XCORE SDK is officially supported on the following platforms. Unofficial sup
 
    Operating systems macOS 10.5 (Catalina) and newer are supported. Intel processors only.  Older operating systems are likely to also work, though they are not supported.
 
-   A standard C/C++ compiler is required to build applications and libraries on the host PC.  Mac users may use the Xcode command line tools.
+   A standard C/C++ compiler is required to build applications and libraries on the host PC.  Mac users may use the Xcode command-line tools.
 
 .. tab:: Linux
 

diff --git a/doc/tutorials/bare-metal/examples/index.rst b/doc/tutorials/bare-metal/examples/index.rst
@@ -1,3 +1,5 @@
+.. _sdk-baremetal-code-examples:
+
 ########################
 Bare-metal Code Examples
 ########################

diff --git a/doc/tutorials/build_system/index.rst b/doc/tutorials/build_system/index.rst
@@ -6,7 +6,9 @@
 Build System
 ############
 
-This document describes the `CMake <https://cmake.org/>`_-based build system used by the example applications in the XCORE SDK.  The build system is designed so a user does not have to be an expert using CMake.  However, some familiarity with CMake is helpful.  You can familiarize yourself by reading the `Cmake Tutorial <https://cmake.org/cmake/help/latest/guide/tutorial/index.html>`_ or `CMake documentation <https://cmake.org/cmake/help/v3.20/>`_.  
+This document describes the `CMake <https://cmake.org/>`_-based build system used by the example applications in the XCORE SDK.  The build system is designed so a user does not have to be an expert using CMake.  However, some familiarity with CMake is helpful.  You can familiarize yourself by reading the `Cmake Tutorial <https://cmake.org/cmake/help/latest/guide/tutorial/index.html>`_ or `CMake documentation <https://cmake.org/cmake/help/v3.20/>`_.
+
+Check the :ref:`system requirement prerequisites <sdk-prerequisites>` for the supported versions of CMake.
 
 ********
 Overview

diff --git a/modules/io b/modules/io
diff --git a/modules/rtos b/modules/rtos
+2 −0		index.rst
+1 −0		test/lib_i2c/i2c_master_test/i2c_master_test.cmake