'Release: 3.2.0rc1'

Document moving and rename. Fixes for latest xdoc.

.github/CODEOWNERS

@@ -0,0 +1 @@
+*  @xross

.gitignore

@@ -20,6 +20,9 @@
 test_results.csv
 _build*
 **/.venv/**
+**/.vscode/**
+**.egg-info
+*.pdf
 
 # waf build files
 .lock-waf_*

Brewfile

@@ -1,7 +0,0 @@
-tap 'homebrew/core'
-
-brew 'perl'
-brew 'cpanm'
-
-brew 'python@2'
-brew 'pipenv'

CHANGELOG.rst

@@ -1,13 +1,104 @@
 lib_xua Change Log
 ==================
 
+3.2.0
+-----
+
+  * CHANGED:   Updated tests to use lib_locks (was legacy module_locks)
+  * CHANGED:   Exclude HID Report functions unless the HID feature is enabled
+  * CHANGED:   Explicit feedback EP enabled by default (see
+    UAC_FORCE_FEEDBACK_EP)
+  * FIXED:     Incorrect conditional compilation of HID report code
+  * FIXED:     Input/output descriptors written when input/output not enabled.
+    (Audio class 1.0 mode using XUA_USB_DESCRIPTOR_OVERWRITE_RATE_RES)
+
+  * Changes to dependencies:
+
+    - lib_dsp: 5.0.0 -> 6.2.1
+
+    - lib_locks: Added dependency 2.1.0
+
+    - lib_logging: 3.0.0 -> 3.1.1
+
+    - lib_mic_array: 4.0.0 -> 4.5.0
+
+    - lib_spdif: 4.0.0 -> 4.1.0
+
+    - lib_xassert: 4.0.0 -> 4.1.0
+
+    - lib_xud: 2.0.0 -> 2.1.0
+
+3.1.0
+-----
+
+  * CHANGED:   Removed logic from HID API functions allowing a Report ID of 0 to
+    be used as "all/any" Report
+
+3.0.0
+-----
+
+  * ADDED:     Support for HID Report IDs
+  * CHANGED:   Renamed the HID API file xua_hid_report_descriptor.h to
+    xua_hid_report.h
+  * REMOVED:   Support for HID Reports containing controls from mixed usage
+    pages
+
+2.1.1
+-----
+
+  * CHANGED:   Setting of HID report items
+
+2.1.0
+-----
+
+  * CHANGED:   Updated clock blocks to support lib_xud v2.0.0
+
+  * Changes to dependencies:
+
+    - lib_xud: 1.2.0 -> 2.0.0
+
+2.0.0
+-----
+
+  * ADDED:     Function to get a Report item description
+  * ADDED:     Support for multiple flash specs defined by DFU_FLASH_DEVICE
+  * ADDED:     Nullable c_aud_ctl chan-end optimisation for fixed rate devices
+  * CHANGED:   Check HID Usage Page when changing a Report item description
+  * CHANGED:   HID event ID from list to bit and byte location in HID Report
+  * CHANGED:   Interface to UserHIDRecordEvent()
+
+1.3.0
+-----
+
+  * ADDED:     Build default HID Report descriptor at boot-time
+  * ADDED:     Function to return length of HID Report
+  * CHANGED:   Move HID descriptors to ease maintenance
+  * CHANGED:   Move legacy tests to separate directory
+  * CHANGED:   Replace unused GPI-specific HID event names with generic ones
+  * CHANGED:   HID Report to return multiple bytes
+  * CHANGED:   NO_USB conditional compilation switch with XUA_USB_EN
+  * CHANGED:   Clock blocks used for BCLK and MCLK
+  * CHANGED:   Arguments no longer supported by XUD_Main
+  * REMOVED:   Support for XS1 based devices
+
+1.2.0
+-----
+
+  * ADDED:     Updates for xcore.ai/XS3 compatibility
+  * ADDED:     Makefile.Win32 for xmosdfu on Windows
+  * CHANGED:   Use XMOS Public Licence Version 1
+  * FIXED:     Bump default BCD device number to v1.2.0
+  * FIXED:     xmosdfu now fails with an error when given a directory (#119)
+  * FIXED:     Compilation errors related to HID code
+  * FIXED:     Runtime error when using mic array interface
+  * FIXED:     Automate HID Report Descriptor length in AC1 HID Descriptor
+
 1.1.1
 -----
 
-  * RESOLVED: Zero length input packets generated before enumeration causing I2S
-    timing pushout at startup
-  * CHANGED: Pin Python package versions
-  * REMOVED: not necessary cpanfile
+  * CHANGED:   Pin Python package versions
+  * FIXED:     Zero length input packets generated before enumeration causing
+    I2S timing pushout at startup
 
 1.1.0
 -----
@@ -27,13 +118,12 @@ lib_xua Change Log
   * ADDED:     Support for USB HID Set Idle request
   * ADDED:     Pre-processor symbols to enable single-threaded, dual-PDM
     microphone operation
-  * FIXED:     Descriptors for XUA_ADAPTIVE incorrectly defined for IN endpoint
   * ADDED:     Guards to user_hid.h and xua_hid.h
   * ADDED:     UAC1 HID support for AC Stop (End Call), Volume Increment and
     Volume Decrement
-  * CHANGE:    UAC1 HID to report function keys f21 through f24 as specified by
+  * CHANGED:   UAC1 HID to report function keys f21 through f24 as specified by
     customer
-  * CHANGE:    HID interface for user to set and clear events from global
+  * CHANGED:   HID interface for user to set and clear events from global
     variable to function
   * CHANGE     HID report descriptor to use generic events instead of GPI
     events, to report Key-phrase detection as AC Search, and to report end-call
@@ -43,11 +133,24 @@ lib_xua Change Log
   * ADDED:     Override USB descriptor with sampling frequency and
     bit-resolution set at boot time.
   * ADDED:     Global pointer to allow external access to masterClockFreq
+  * FIXED:     Descriptors for XUA_ADAPTIVE incorrectly defined for IN endpoint
+
+  * Changes to dependencies:
+
+    - lib_spdif: 3.1.0 -> 4.0.0
+
+    - lib_xassert: 3.0.1 -> 4.0.0
 
 0.2.1
 -----
 
-  * HOTFIX: Fix descriptors for XUA_ADAPTIVE
+  * FIXED:     Fix descriptors for XUA_ADAPTIVE
+
+  * Changes to dependencies:
+
+    - lib_logging: 2.1.1 -> 3.0.0
+
+    - lib_xud: 0.1.0 -> 0.2.0
 
 0.2.0
 -----
@@ -55,17 +158,17 @@ lib_xua Change Log
   * ADDED:     Initial library documentation
   * ADDED:     Application note AN00247: Using lib_xua with lib_spdif (transmit)
   * ADDED:     Separate callbacks for input/output audio stream start/stop
-  * CHANGE:    I2S hardware resources no longer used globally and must be passed
+  * CHANGED:   I2S hardware resources no longer used globally and must be passed
     to XUA_AudioHub()
-  * CHANGE:    XUA_AudioHub() no longer pars S/PDIF transmitter task
-  * CHANGE:    Moved to lib_spdif (from module_spdif_tx & module_spdif_rx)
-  * CHANGE:    Define NUM_PDM_MICS renamed to XUA_NUM_PDM_MICS
-  * CHANGE:    Define NO_USB renamed to XUA_USB_EN
-  * CHANGE:    Build files updated to support new "xcommon" behaviour in xwaf.
-  * RESOLVED:  wChannelConfig in UAC1 descriptor set according to output channel
+  * CHANGED:   XUA_AudioHub() no longer pars S/PDIF transmitter task
+  * CHANGED:   Moved to lib_spdif (from module_spdif_tx & module_spdif_rx)
+  * CHANGED:   Define NUM_PDM_MICS renamed to XUA_NUM_PDM_MICS
+  * CHANGED:   Define NO_USB renamed to XUA_USB_EN
+  * CHANGED:   Build files updated to support new "xcommon" behaviour in xwaf.
+  * FIXED:     wChannelConfig in UAC1 descriptor set according to output channel
     count
-  * RESOLVED:  Indexing of ADAT channel strings (#18059)
-  * RESOLVED:  Rebooting device fails when PLL config "not reset" bit is set
+  * FIXED:     Indexing of ADAT channel strings (#18059)
+  * FIXED:     Rebooting device fails when PLL config "not reset" bit is set
 
   * Changes to dependencies:
 
@@ -81,20 +184,19 @@ lib_xua Change Log
 -----
 
   * ADDED:     Application note AN00246: Simple USB Audio Device using lib_xua
-  * CHANGE:    xmosdfu emits warning if empty image read via upload
-  * CHANGE:    Simplified mclk port sharing - no longer uses unsafe pointer
-  * RESOLVED:  Runtime exception issues when incorrect feedback calculated
+  * CHANGED:   xmosdfu emits warning if empty image read via upload
+  * CHANGED:   Simplified mclk port sharing - no longer uses unsafe pointer
+  * FIXED:     Runtime exception issues when incorrect feedback calculated
     (introduced in sc_usb_audio 6.13)
-  * RESOLVED:  Output sample counter reset on stream start. Caused playback
+  * FIXED:     Output sample counter reset on stream start. Caused playback
     issues on some Linux based hosts
 
 0.1.1
 -----
 
-  * RESOLVED:   Configurations where I2S_CHANS_DAC and I2S_CHANS_ADC are both 0
-    now build
-  * RESOLVED:   Deadlock in mixer when MAX_MIX_COUNT > 0 for larger channel
-    counts
+  * FIXED:   Configurations where I2S_CHANS_DAC and I2S_CHANS_ADC are both 0 now
+    build
+  * FIXED:   Deadlock in mixer when MAX_MIX_COUNT > 0 for larger channel counts
 
   * Changes to dependencies:
 
@@ -105,31 +207,31 @@ lib_xua Change Log
 0.1.0
 -----
 
-  * ADDED:      FB_USE_REF_CLOCK to allow feedback generation from xCORE
-    internal reference
-  * ADDED:      Linux Makefile for xmosdfu host application
-  * ADDED:      Raspberry Pi Makefile for xmosdfu host application
-  * ADDED:      Documentation of PID argument to xmosdfu
-  * ADDED:      Optional build time microphone delay line (MIC_BUFFER_DEPTH)
-  * CHANGE:     Removal of audManage_if, users should define their own
-    interfaces as required
-  * CHANGE:     Vendor specific control interface in UAC1 descriptor now has a
+  * ADDED:     FB_USE_REF_CLOCK to allow feedback generation from xCORE internal
+    reference
+  * ADDED:     Linux Makefile for xmosdfu host application
+  * ADDED:     Raspberry Pi Makefile for xmosdfu host application
+  * ADDED:     Documentation of PID argument to xmosdfu
+  * ADDED:     Optional build time microphone delay line (MIC_BUFFER_DEPTH)
+  * CHANGED:   Removal of audManage_if, users should define their own interfaces
+    as required
+  * CHANGED:   Vendor specific control interface in UAC1 descriptor now has a
     string descriptor so it shows up with a descriptive name in Windows Device
     Manager
-  * CHANGE:     DFU_BCD_DEVICE removed (now uses BCD_DEVICE)
-  * CHANGE:     Renaming in descriptors.h to avoid clashes with application
-  * CHANGE:     Make device reboot function no-argument (was one channel end)
-  * RESOLVED:   FIR gain compensation for PDM mics set incorrectly for divide of
+  * CHANGED:   DFU_BCD_DEVICE removed (now uses BCD_DEVICE)
+  * CHANGED:   Renaming in descriptors.h to avoid clashes with application
+  * CHANGED:   Make device reboot function no-argument (was one channel end)
+  * FIXED:     FIR gain compensation for PDM mics set incorrectly for divide of
     8
-  * RESOLVED:   Incorrect xmosdfu DYLD path in test script code
-  * RESOLVED:   xmosdfu cannot find XMOS device on modern MacBook Pro (#17897)
-  * RESOLVED:   Issue when feedback is initially incorrect when two SOF's are
-    not yet received
-  * RESOLVED:   AUDIO_TILE and PDM_TILE may now share the same value/tile
-  * RESOLVED:   Cope with out of order interface numbers in xmosdfu
-  * RESOLVED:   DSD playback not functional on xCORE-200 (introduced in
+  * FIXED:     Incorrect xmosdfu DYLD path in test script code
+  * FIXED:   xmosdfu cannot find XMOS device on modern MacBook Pro (#17897)
+  * FIXED:   Issue when feedback is initially incorrect when two SOF's are not
+    yet received
+  * FIXED:   AUDIO_TILE and PDM_TILE may now share the same value/tile
+  * FIXED:   Cope with out of order interface numbers in xmosdfu
+  * FIXED:   DSD playback not functional on xCORE-200 (introduced in
     sc_usb_audio 6.14)
-  * RESOLVED:   Improvements made to clock sync code in TDM slave mode
+  * FIXED:   Improvements made to clock sync code in TDM slave mode
 
 
 Legacy release history
@@ -139,105 +241,105 @@ Legacy release history
 
 7.4.1
 -----
-    - RESOLVED:   Exception due to null chanend when using NO_USB
+    - FIXED:   Exception due to null chanend when using NO_USB
 
 7.4.0
 -----
-    - RESOLVED:   PID_DFU now based on AUDIO_CLASS. This potentially caused issues
+    - FIXED:   PID_DFU now based on AUDIO_CLASS. This potentially caused issues
       with UAC1 DFU
 
 
 7.3.0
 -----
-    - CHANGE:     Example OSX DFU host app updated to now take PID as runtime
+    - CHANGED:    Example OSX DFU host app updated to now take PID as runtime
       argument. This enabled multiple XMOS devices to be attached to the host
       during DFU process
 
 7.2.0
 -----
     - ADDED:      DFU to UAC1 descriptors (guarded by DFU and FORCE_UAC1_DFU)
-    - RESOLVED:   Removed 'reinterpretation to type of larger alignment' warnings
-    - RESOLVED:   DFU flash code run on tile[0] even if XUD_TILE and AUDIO_IO_TILE are not 0
+    - FIXED:      Removed 'reinterpretation to type of larger alignment' warnings
+    - FIXED:      DFU flash code run on tile[0] even if XUD_TILE and AUDIO_IO_TILE are not 0
 
 7.1.0
 -----
     - ADDED:      UserBufferManagementInit() to reset any state required in UserBufferManagement()
     - ADDED:      I2S output up-sampling (enabled when AUD_TO_USB_RATIO is > 1)
     - ADDED:      PDM Mic decimator output rate can now be controlled independently (via AUD_TO_MICS_RATIO)
-    - CHANGE:     Rename I2S input down-sampling (enabled when AUD_TO_USB_RATIO is > 1, rather than via I2S_DOWNSAMPLE_FACTOR)
-    - RESOLVED:   Crosstalk between input channels when I2S input down-sampling is enabled
-    - RESOLVED:   Mic decimation data tables properly sized when mic sample-rate < USB audio sample-rate
+    - CHANGED:    Rename I2S input down-sampling (enabled when AUD_TO_USB_RATIO is > 1, rather than via I2S_DOWNSAMPLE_FACTOR)
+    - FIXED:      Crosstalk between input channels when I2S input down-sampling is enabled
+    - FIXED:      Mic decimation data tables properly sized when mic sample-rate < USB audio sample-rate
 
 7.0.1
 -----
-    - RESOLVED:   PDM microphone decimation issue at some sample rates caused by integration
+    - FIXED:      PDM microphone decimation issue at some sample rates caused by integration
 
 7.0.0
 ------
     - ADDED:      I2S down-sampling (I2S_DOWNSAMPLE_FACTOR)
     - ADDED:      I2S resynchronisation when in slave mode (CODEC_MASTER=1)
-    - CHANGE:     Various memory optimisations when MAX_FREQ = MIN_FREQ
-    - CHANGE:     Memory optimisations in audio buffering
-    - CHANGE:     Various memory optimisations in UAC1 mode
-    - CHANGE:     user_pdm_process() API change
-    - CHANGE:     PDM Mic decimator table now related to MIN_FREQ (memory optimisation)
-    - RESOLVED:   Audio request interrupt handler properly eliminated
+    - CHANGED:    Various memory optimisations when MAX_FREQ = MIN_FREQ
+    - CHANGED:    Memory optimisations in audio buffering
+    - CHANGED:    Various memory optimisations in UAC1 mode
+    - CHANGED:    user_pdm_process() API change
+    - CHANGED:    PDM Mic decimator table now related to MIN_FREQ (memory optimisation)
+    - FIXED:      Audio request interrupt handler properly eliminated
 
 6.30.0
 ------
-    - RESOLVED:   Number of PDM microphone channels configured now based on NUM_PDM_MICS define
-                  (previously hard-coded)
-    - RESOLVED:   PDM microphone clock divide now based MCLK defines (previously hard-coded)
-    - CHANGE:     Second microphone decimation core only run if NUM_PDM_MICS > 4
+    - FIXED:   Number of PDM microphone channels configured now based on NUM_PDM_MICS define
+    (previously hard-coded)
+    - FIXED:   PDM microphone clock divide now based MCLK defines (previously hard-coded)
+    - CHANGED: Second microphone decimation core only run if NUM_PDM_MICS > 4
 
 6.20.0
 ------
-    - RESOLVED:   Intra-frame sample delays of 1/2 samples on input streaming in TDM mode
-    - RESOLVED:   Build issue with NUM_USB_CHAN_OUT set to 0 and MIXER enabled
-    - RESOLVED:   SPDIF_TX_INDEX not defined build warning only emitted when SPDIF_TX defined
-    - RESOLVED:   Failure to enter DFU mode when configured without input volume control
+    - FIXED:   Intra-frame sample delays of 1/2 samples on input streaming in TDM mode
+    - FIXED:   Build issue with NUM_USB_CHAN_OUT set to 0 and MIXER enabled
+    - FIXED:   SPDIF_TX_INDEX not defined build warning only emitted when SPDIF_TX defined
+    - FIXED:   Failure to enter DFU mode when configured without input volume control
 
 6.19.0
 ------
-    - RESOLVED:   SPDIF_TX_INDEX not defined build warning only emitted when SPDIF_TX defined
-    - RESOLVED:   Failure to enter DFU mode when configured without input volume control
+    - FIXED:   SPDIF_TX_INDEX not defined build warning only emitted when SPDIF_TX defined
+    - FIXED:   Failure to enter DFU mode when configured without input volume control
 
 6.18.1
 ------
-    - ADDED:      Vendor Specific control interface added to UAC1 descriptors to allow control of
-                  XVSM params from Windows (via lib_usb)
+    - ADDED:   Vendor Specific control interface added to UAC1 descriptors to allow control of
+                XVSM params from Windows (via lib_usb)
 
 6.18.0
 ------
-    - ADDED:      Call to VendorRequests() and VendorRequests_Init() to Endpoint 0
-    - ADDED:      VENDOR_REQUESTS_PARAMS define to allow for custom parameters to VendorRequest calls
-    - RESOLVED:   FIR gain compensation set appropriately in lib_mic_array usage
-    - CHANGE:     i_dsp interface renamed i_audManage
+    - ADDED:   Call to VendorRequests() and VendorRequests_Init() to Endpoint 0
+    - ADDED:   VENDOR_REQUESTS_PARAMS define to allow for custom parameters to VendorRequest calls
+    - FIXED:   FIR gain compensation set appropriately in lib_mic_array usage
+    - CHANGED: i_dsp interface renamed i_audManage
 
 6.16.0
 ------
     - ADDED:      Call to UserBufferManagement()
     - ADDED:      PDM_MIC_INDEX in devicedefines.h and usage
-    - CHANGE:     pdm_buffer() task now combinable
-    - CHANGE:     Audio I/O task now takes i_dsp interface as a parameter
-    - CHANGE:     Removed built-in support for A/U series internal ADC
-    - CHANGE:     User PDM Microphone processing now uses an interface (previously function call)
+    - CHANGED:    pdm_buffer() task now combinable
+    - CHANGED:    Audio I/O task now takes i_dsp interface as a parameter
+    - CHANGED:    Removed built-in support for A/U series internal ADC
+    - CHANGED:    User PDM Microphone processing now uses an interface (previously function call)
 
 6.15.2
 ------
-    - RESOLVED:   interrupt.h (used in audio buffering) now compatible with xCORE-200 ABI
+    - FIXED:   interrupt.h (used in audio buffering) now compatible with xCORE-200 ABI
 
 6.15.1
 ------
-    - RESOLVED:   DAC data mis-alignment issue in TDM/I2S slave mode
-    - CHANGE:     Updates to support API changes in lib_mic_array version 2.0
+    - FIXED:   DAC data mis-alignment issue in TDM/I2S slave mode
+    - CHANGED:    Updates to support API changes in lib_mic_array version 2.0
 
 6.15.0
 ------
 
-    - RESOLVED:   UAC 1.0 descriptors now support multi-channel volume control (previously were
+    - FIXED:   UAC 1.0 descriptors now support multi-channel volume control (previously were
                   hard-coded as stereo)
-    - CHANGE:     Removed 32kHz sample-rate support when PDM microphones enabled (lib_mic_array
+    - CHANGED:    Removed 32kHz sample-rate support when PDM microphones enabled (lib_mic_array
                   currently does not support non-integer decimation factors)
 
 6.14.0
@@ -251,75 +353,75 @@ Legacy release history
                   list and UAC 1.0 descriptors
     - ADDED:      Support for the use and integration of PDM microphones (including PDM to PCM
                   conversion) via lib_mic_array
-    - RESOLVED:   MIDI data not accepted after "sleep" in OSX 10.11 (El Capitan) - related to sc_xud
+    - FIXED:   MIDI data not accepted after "sleep" in OSX 10.11 (El Capitan) - related to sc_xud
                   issue #17092
-    - CHANGE:     Asynchronous feedback system re-implemented to allow for the first two ADDED
+    - CHANGED:    Asynchronous feedback system re-implemented to allow for the first two ADDED
                   changelog items
-    - CHANGE:     Hardware divider used to generate bit-clock from master clock (xCORE-200 only).
+    - CHANGED:    Hardware divider used to generate bit-clock from master clock (xCORE-200 only).
                   Allows easy support for greater number of master-clock to sample-rate ratios.
-    - CHANGE:     module_queue no longer uses any assert module/lib
+    - CHANGED:    module_queue no longer uses any assert module/lib
 
 6.13.0
 ------
     - ADDED:      Device now uses implicit feedback when input stream is available (previously explicit
                   feedback pipe always used). This saves chanend/EP resources and means less processing
                   burden for the host. Previous behaviour available by enabling UAC_FORCE_FEEDBACK_EP
-    - RESOLVED:   Exception when SPDIF_TX and ADAT_TX both enabled due to clock-block being configured
+    - FIXED:   Exception when SPDIF_TX and ADAT_TX both enabled due to clock-block being configured
                   after already started. Caused by SPDIF_TX define check typo
-    - RESOLVED:   DFU flag address changed to properly conform to memory address range allocated to
+    - FIXED:   DFU flag address changed to properly conform to memory address range allocated to
                   apps by tools
-    - RESOLVED:   Build failure when DFU disabled
-    - RESOLVED:   Build issue when I2S_CHANS_ADC/DAC set to 0 and CODEC_MASTER enabled
-    - RESOLVED:   Typo in MCLK_441 checking for MIN_FREQ define
-    - CHANGE:     Mixer and non-mixer channel comms scheme (decouple <-> audio path) now identical
-    - CHANGE:     Input stream buffering modified such that during overflow older samples are removed
+    - FIXED:   Build failure when DFU disabled
+    - FIXED:   Build issue when I2S_CHANS_ADC/DAC set to 0 and CODEC_MASTER enabled
+    - FIXED:   Typo in MCLK_441 checking for MIN_FREQ define
+    - CHANGED:    Mixer and non-mixer channel comms scheme (decouple <-> audio path) now identical
+    - CHANGED:    Input stream buffering modified such that during overflow older samples are removed
                   rather than ignoring most recent samples. Removes any chance of stale input packets
                   being sent to host
-    - CHANGE:     module_queue (in sc_usb_audio) now uses lib_xassert rather than module_xassert
+    - CHANGED:    module_queue (in sc_usb_audio) now uses lib_xassert rather than module_xassert
 
 6.12.6
 ------
-    - RESOLVED:   Build error when DFU is disabled
-    - RESOLVED:   Build error when I2S_CHANS_ADC or I2S_CHANS_DAC set to 0 and CODEC_MASTER enabled
+    - FIXED:   Build error when DFU is disabled
+    - FIXED:   Build error when I2S_CHANS_ADC or I2S_CHANS_DAC set to 0 and CODEC_MASTER enabled
 
 6.12.5
 ------
-    - RESOLVED:   Stream issue when NUM_USB_CHAN_IN < I2S_CHANS_ADC
+    - FIXED:   Stream issue when NUM_USB_CHAN_IN < I2S_CHANS_ADC
 
 6.12.4
 ------
-    - RESOLVED:   DFU fail when DSD enabled and USB library not running on tile[0]
+    - FIXED:   DFU fail when DSD enabled and USB library not running on tile[0]
 
 6.12.3
 ------
-    - RESOLVED:   Method for storing persistent state over a DFU reboot modified to improve resilience
+    - FIXED:   Method for storing persistent state over a DFU reboot modified to improve resilience
                   against code-base and tools changes
 
 6.12.2
 ------
-    - RESOLVED:   Reboot code (used for DFU) failure in tools versions > 14.0.2 (xCORE-200 only)
-    - RESOLVED:   Run-time exception in mixer when MAX_MIX_COUNT > 0 (xCORE-200 only)
-    - RESOLVED:   MAX_MIX_COUNT checked properly for mix strings in string table
-    - CHANGE:     DFU code re-written to use an XC interface. The flash-part may now be connected
+    - FIXED:   Reboot code (used for DFU) failure in tools versions > 14.0.2 (xCORE-200 only)
+    - FIXED:   Run-time exception in mixer when MAX_MIX_COUNT > 0 (xCORE-200 only)
+    - FIXED:   MAX_MIX_COUNT checked properly for mix strings in string table
+    - CHANGED:    DFU code re-written to use an XC interface. The flash-part may now be connected
                   to a separate tile to the tile running USB code
-    - CHANGE:     DFU code can now use quad-SPI flash
-    - CHANGE:     Example xmos_dfu application now uses a list of PIDs to allow adding PIDs easier.
+    - CHANGED:    DFU code can now use quad-SPI flash
+    - CHANGED:    Example xmos_dfu application now uses a list of PIDs to allow adding PIDs easier.
                   --listdevices command also added.
-    - CHANGE:     I2S_CHANS_PER_FRAME and I2S_WIRES_xxx defines tidied
+    - CHANGED:    I2S_CHANS_PER_FRAME and I2S_WIRES_xxx defines tidied
 
 6.12.1
 ------
-    - RESOLVED:   Fixes to TDM input timing/sample-alignment when BCLK=MCLK
-    - RESOLVED:   Various minor fixes to allow ADAT_RX to run on xCORE 200 MC AUDIO hardware
-    - CHANGE:     Moved from old SPDIF define to SPDIF_TX
+    - FIXED:   Fixes to TDM input timing/sample-alignment when BCLK=MCLK
+    - FIXED:   Various minor fixes to allow ADAT_RX to run on xCORE 200 MC AUDIO hardware
+    - CHANGED:    Moved from old SPDIF define to SPDIF_TX
 
 6.12.0
 ------
     - ADDED:      Checks for XUD_200_SERIES define where required
-    - RESOLVED:   Run-time exception due to decouple interrupt not entering correct issue mode
+    - FIXED:   Run-time exception due to decouple interrupt not entering correct issue mode
                   (affects XCORE-200 only)
-    - CHANGE:     SPDIF Tx Core may now reside on a different tile from I2S
-    - CHANGE:     I2C ports now in structure to match new module_i2c_singleport/shared API.
+    - CHANGED:    SPDIF Tx Core may now reside on a different tile from I2S
+    - CHANGED:    I2C ports now in structure to match new module_i2c_singleport/shared API.
 
   * Changes to dependencies:
 
@@ -329,48 +431,48 @@ Legacy release history
 
 6.11.3
 ------
-    - RESOLVED:  (Major) Streaming issue when mixer not enabled (introduced in 6.11.2)
+    - FIXED:  (Major) Streaming issue when mixer not enabled (introduced in 6.11.2)
 
 6.11.2
 ------
-    - RESOLVED:   (Major) Enumeration issue when MAX_MIX_COUNT > 0 only. Introduced in mixer
+    - FIXED:   (Major) Enumeration issue when MAX_MIX_COUNT > 0 only. Introduced in mixer
                   optimisations in 6.11.0. Only affects designs using mixer functionality.
-    - RESOLVED:   (Normal) Audio buffering request system modified such that the mixer output is
+    - FIXED:   (Normal) Audio buffering request system modified such that the mixer output is
                   not silent when in underflow case (i.e. host output stream not active) This issue was
                   introduced with the addition of DSD functionality and only affects designs using
                   mixer functionality.
-    - RESOLVED:   (Minor) Potential build issue due to duplicate labels in inline asm in
+    - FIXED:   (Minor) Potential build issue due to duplicate labels in inline asm in
                   set_interrupt_handler macro
-    - RESOLVED:   (Minor) BCD_DEVICE define in devicedefines.h now guarded by ifndef (caused issues
+    - FIXED:   (Minor) BCD_DEVICE define in devicedefines.h now guarded by ifndef (caused issues
                   with DFU test build configs.
-    - RESOLVED:   (Minor) String descriptor for Clock Selector unit incorrectly reported
-    - RESOLVED:   (Minor) BCD_DEVICE in devicedefines.h now guarded by #ifndef (Caused issues with
+    - FIXED:   (Minor) String descriptor for Clock Selector unit incorrectly reported
+    - FIXED:   (Minor) BCD_DEVICE in devicedefines.h now guarded by #ifndef (Caused issues with
                   default DFU test build configs.
-    - CHANGE:     HID report descriptor defines added to shared user_hid.h
-    - CHANGE:     Now uses module_adat_rx from sc_adat (local module_usb_audio_adat removed)
+    - CHANGED:    HID report descriptor defines added to shared user_hid.h
+    - CHANGED:    Now uses module_adat_rx from sc_adat (local module_usb_audio_adat removed)
 
 6.11.1
 ------
     - ADDED:      ADAT transmit functionality, including SMUX. See ADAT_TX and ADAT_TX_INDEX.
-    - RESOLVED:   (Normal) Build issue with CODEC_MASTER (xCore is I2S slave) enabled
-    - RESOLVED:   (Minor) Channel ordering issue in when TDM and CODEC_MASTER mode enabled
-    - RESOLVED:   (Normal) DFU fails when SPDIF_RX enabled due to clock block being shared between SPDIF
+    - FIXED:   (Normal) Build issue with CODEC_MASTER (xCore is I2S slave) enabled
+    - FIXED:   (Minor) Channel ordering issue in when TDM and CODEC_MASTER mode enabled
+    - FIXED:   (Normal) DFU fails when SPDIF_RX enabled due to clock block being shared between SPDIF
                   core and FlashLib
 
 6.11.0
 ------
     - ADDED:      Basic TDM I2S functionality added. See I2S_CHANS_PER_FRAME and I2S_MODE_TDM
-    - CHANGE:     Various optimisations in 'mixer' core to improve performance for higher
+    - CHANGED:    Various optimisations in 'mixer' core to improve performance for higher
                   channel counts including the use of XC unsafe pointers instead of inline ASM
-    - CHANGE:     Mixer mapping disabled when MAX_MIX_COUNT is 0 since this is wasted processing.
-    - CHANGE:     Descriptor changes to allow for channel input/output channel count up to 32
+    - CHANGED:    Mixer mapping disabled when MAX_MIX_COUNT is 0 since this is wasted processing.
+    - CHANGED:    Descriptor changes to allow for channel input/output channel count up to 32
                   (previous limit was 18)
 
 6.10.0
 ------
-    - CHANGE:     Endpoint management for iAP EA Native Transport now merged into buffer() core.
+    - CHANGED:    Endpoint management for iAP EA Native Transport now merged into buffer() core.
                   Previously was separate core (as added in 6.8.0).
-    - CHANGE:     Minor optimisation to I2S port code for inputs from ADC
+    - CHANGED:    Minor optimisation to I2S port code for inputs from ADC
 
 6.9.0
 -----
@@ -378,35 +480,35 @@ Legacy release history
                   supported (4 channels at 96kHz).
     - ADDED:      Explicit build warnings if sample rate/depth & channel combination exceeds
                   available USB bus bandwidth.
-    - RESOLVED:   (Major) Reinstated ADAT input functionality, including descriptors and clock
+    - FIXED:   (Major) Reinstated ADAT input functionality, including descriptors and clock
                   generation/control and stream configuration defines/tables.
-    - RESOLVED:   (Major) S/PDIF/ADAT sample transfer code in audio() (from ClockGen()) moved to
+    - FIXED:   (Major) S/PDIF/ADAT sample transfer code in audio() (from ClockGen()) moved to
                   aid timing.
-    - CHANGE:     Modifying mix map now only affects specified mix, previous was applied to all
+    - CHANGED:    Modifying mix map now only affects specified mix, previous was applied to all
                   mixes. CS_XU_MIXSEL control selector now takes values 0 to MAX_MIX_COUNT + 1
                   (with 0 affecting all mixes).
-    - CHANGE:     Channel c_dig_rx is no longer nullable, assists with timing due to removal of
+    - CHANGED:    Channel c_dig_rx is no longer nullable, assists with timing due to removal of
                   null checks inserted by compiler.
-    - CHANGE:     ADAT SMUX selection now based on device sample frequency rather than selected
+    - CHANGED:    ADAT SMUX selection now based on device sample frequency rather than selected
                   stream format - Endpoint 0 now configures clockgen() on a sample-rate change
                   rather than stream start.
 
 6.8.0
 -----
     - ADDED:      Evaluation support for iAP EA Native Transport endpoints
-    - RESOLVED:   (Minor) Reverted change in 6.5.1 release where sample rate listing in Audio Class
+    - FIXED:   (Minor) Reverted change in 6.5.1 release where sample rate listing in Audio Class
                   1.0 descriptors was trimmed (previously 4 rates were always reported). This change
                   appears to highlight a Windows (only) enumeration issue with the Input & Output
                   configs
-    - RESOLVED:   (Major) Mixer functionality re-instated, including descriptors and various required
+    - FIXED:   (Major) Mixer functionality re-instated, including descriptors and various required
                   updates compatibility with 13 tools
-    - RESOLVED:   (Major) Endpoint 0 was requesting an out of bounds channel whilst requesting level data
-    - RESOLVED:   (Major) Fast mix code not operates correctly in 13 tools, assembler inserting long jmp
+    - FIXED:   (Major) Endpoint 0 was requesting an out of bounds channel whilst requesting level data
+    - FIXED:   (Major) Fast mix code not operates correctly in 13 tools, assembler inserting long jmp
                   instructions
-    - RESOLVED:   (Minor) LED level meter code now compatible with 13 tools (shared mem access)
-    - RESOLVED    (Minor) Ordering of level data from the device now matches channel ordering into
+    - FIXED:   (Minor) LED level meter code now compatible with 13 tools (shared mem access)
+    - FIXED:    (Minor) Ordering of level data from the device now matches channel ordering into
                   mixer (previously the device input data and the stream from host were swapped)
-    - CHANGE:     Level meter buffer naming now resemble functionality
+    - CHANGED:    Level meter buffer naming now resemble functionality
 
 
 Legacy release history

Jenkinsfile

@@ -1,4 +1,4 @@
-@Library('xmos_jenkins_shared_library@v0.14.2') _
+@Library('xmos_jenkins_shared_library@v0.18.0') _
 
 getApproval()
 
@@ -14,7 +14,7 @@ pipeline {
   stages {
     stage('Basic tests') {
       agent {
-        label 'x86_64&&brew'
+        label 'x86_64 && linux'
       }
       stages {
         stage('Get view') {
@@ -27,11 +27,70 @@ pipeline {
             xcoreLibraryChecks("${REPO}")
           }
         }
-        stage('Tests') {
-          steps {
-            runXmostest("${REPO}", 'tests')
+        stage('XS2 Tests') {
+          failFast true
+          parallel {
+            stage('Legacy tests') {
+              steps {
+                runXmostest("${REPO}", 'legacy_tests')
+              }
+            }
+            stage('Unit tests') {
+              steps {
+                dir("${REPO}") {
+                  dir('tests') {
+                    dir('xua_unit_tests') {
+                      withVenv {
+                        runWaf('.', "configure clean build --target=xcore200")
+//                        runWaf('.', "configure clean build --target=xcoreai")
+//                        stash name: 'xua_unit_tests', includes: 'bin/*xcoreai.xe, '
+                        viewEnv() {
+                          runPython("TARGET=XCORE200 pytest -s")
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
           }
         }
+//        stage('xcore.ai Verification') {
+//          agent {
+//            label 'xcore.ai-explorer'
+//          }
+//          options {
+//            skipDefaultCheckout()
+//          }
+//          stages{
+//            stage('Get View') {
+//              steps {
+//                xcorePrepareSandbox("${VIEW}", "${REPO}")
+//              }
+//            }
+//            stage('Unit tests') {
+//              steps {
+//                dir("${REPO}") {
+//                  dir('tests') {
+//                    dir('xua_unit_tests') {
+//                      withVenv {
+//                        unstash 'xua_unit_tests'
+//                        viewEnv() {
+//                          runPython("TARGET=XCOREAI pytest -s")
+//                        }
+//                      }
+//                    }
+//                  }
+//                }
+//              }
+//            }
+//          } // stages
+//          post {
+//            cleanup {
+//              cleanWs()
+//            }
+//          }
+//        }
         stage('xCORE builds') {
           steps {
             dir("${REPO}") {
@@ -54,7 +113,7 @@ pipeline {
       parallel {
         stage('Build Linux host app') {
           agent {
-            label 'x86_64&&brew&&linux'
+            label 'x86_64&&linux'
           }
           steps {
             xcorePrepareSandbox("${VIEW}", "${REPO}")
@@ -70,7 +129,7 @@ pipeline {
         }
         stage('Build Mac host app') {
           agent {
-            label 'x86_64&&brew&&macOS'
+            label 'x86_64&&macOS'
           }
           steps {
             xcorePrepareSandbox("${VIEW}", "${REPO}")
@@ -84,11 +143,47 @@ pipeline {
             }
           }
         }
+        stage('Build Pi host app') {
+          agent {
+            label 'pi'
+          }
+          steps {
+            dir("${REPO}") {
+              checkout scm
+              dir("${REPO}/host/xmosdfu") {
+                sh 'make -f Makefile.Pi'
+              }
+            }
+          }
+          post {
+            cleanup {
+              xcoreCleanSandbox()
+            }
+          }
+        }
+        stage('Build Windows host app') {
+          agent {
+            label 'x86_64&&windows'
+          }
+          steps {
+            dir("${REPO}") {
+              checkout scm
+              dir("${REPO}/host/xmosdfu") {
+                runVS('nmake /f Makefile.Win32')
+              }
+            }
+          }
+          post {
+            cleanup {
+              xcoreCleanSandbox()
+            }
+          }
+        }
       }
     }
     stage('Update') {
       agent {
-        label 'x86_64&&brew'
+        label 'x86_64 && linux'
       }
       steps {
         updateViewfiles()

LICENSE.rst

@@ -0,0 +1,84 @@
+*******************************
+XMOS PUBLIC LICENCE: Version 1
+*******************************
+
+Subject to the conditions and limitations below, permission is hereby granted by XMOS LIMITED (“XMOS”), free of charge, to any person or entity obtaining a copy of the XMOS Software.
+
+**1. Definitions**
+
+**“Applicable Patent Rights”** means: (a) where XMOS is the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to XMOS and (ii) that cover subject matter contained in the Software, but only to the extent it is necessary to use, reproduce or distribute the Software without infringement; and (b) where you are the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to you and (ii) that cover the subject matter contained in your Derivatives, taken alone or in combination with the Software.
+
+**“Compiled Code”** means any compiled, binary, machine readable or executable version of the Source Code.
+
+**“Contributor”** means any person or entity that creates or contributes to the creation of Derivatives.
+
+**“Derivatives”** means any addition to, deletion from and/or change to the substance, structure of the Software, any previous Derivatives, the combination of the Derivatives and the Software and/or any respective portions thereof.
+
+**“Source Code”** means the human readable code that is suitable for making modifications but excluding any Compiled Code.
+
+**“Software”** means the software and associated documentation files which XMOS makes available and which contain a notice identifying the software as original XMOS software and referring to the software being subject to the terms of this XMOS Public Licence.
+
+This Licence refers to XMOS Software and does not relate to any XMOS hardware or devices which are protected by intellectual property rights (including patent and trade marks) which may be sold to you under a separate agreement.
+
+
+**2. Licence**
+
+**Permitted Uses, Conditions and Restrictions.**  Subject to the conditions below, XMOS grants you a worldwide, royalty free, non-exclusive licence, to the extent of any Patent Rights to do the following:
+
+2.1 **Unmodified Software.** You may use, copy, display, publish, distribute and make available unmodified copies of the Software:
+
+2.1.1 for personal or academic, non-commercial purposes; or
+
+2.1.2 for commercial purposes provided the Software is at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.1.1 and 2.1.2):
+
+(a) you must retain and reproduce in all copies of the Software the copyright and proprietary notices and disclaimers of XMOS as they appear in the Software, and keep intact all notices and disclaimers in the Software files that refer to this Licence; and
+
+(b) you must include a copy of this Licence with every copy of the Software and documentation you publish, distribute and make available and you may not offer or impose any terms on such Software that alter or restrict this Licence or the intent of such Licence, except as permitted below (Additional Terms).
+
+The licence above does not include any Compiled Code which XMOS may make available under a separate support and licence agreement.
+
+2.2 **Derivatives.** You may create and modify Derivatives and use, copy, display, publish, distribute and make available Derivatives:
+
+2.2.1 for personal or academic, non-commercial purposes; or
+
+2.2.2 for commercial purposes, provided the Derivatives are at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.2.1 and 2.2.2):
+
+(a) you must comply with the terms of clause 2.1 with respect to the Derivatives;
+
+(b) you must copy (to the extent it doesn’t already exist) the notice below in each file of the Derivatives, and ensure all the modified files carry prominent notices stating that you have changed the files and the date of any change; and
+
+(c) if you sublicence, distribute or otherwise make the Software and/or the Derivatives available for commercial purposes, you must provide that the Software and Derivatives are at all times used on a device designed, licensed or developed by XMOS.
+
+Without limitation to these terms and clause 3 below, the Source Code and Compiled Code to your Derivatives may at your discretion (but without obligation) be released, copied, displayed, published, distributed and made available; and if you elect to do so, it must be under the terms of this Licence including the terms of the licence at clauses 2.2.1, 2.2.2 and clause 3 below.
+
+2.3 **Distribution of Executable Versions.**  If you distribute or make available Derivatives, you must include a prominent notice in the code itself as well as in all related documentation, stating that the Source Code of the Software from which the Derivatives are based is available under the terms of this Licence, with information on how and where to obtain such Source Code.
+
+**3. Your Grant of Rights.**  In consideration and as a condition to this Licence, you grant to any person or entity receiving or distributing any Derivatives, a non-exclusive, royalty free, perpetual, irrevocable license under your Applicable Patent Rights and all other intellectual property rights owned or controlled by you, to use, copy, display, publish, distribute and make available your Derivatives of the same scope and extent as XMOS’s licence under clause 2.2 above.
+
+**4. Combined Products.**  You may create a combined product by combining Software, Derivatives and other code not covered by this Licence as a single application or product. In such instance, you must comply with the requirements of this Licence for any portion of the Software and/or Derivatives.
+
+**5. Additional Terms.**  You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations and/or other rights consistent with the term of this Licence (“Additional Terms”) to any legitimate recipients of the Software and/or Derivatives.  The terms on which you provide such Additional Terms are on your sole responsibility and you shall indemnify, defend and hold XMOS harmless against any claims asserted against XMOS.
+
+**6. New Versions.**  XMOS may publish revised and/or new versions of this Licence from time to time to accommodate changes to the Licence terms, new versions, updates and bug fixes of the Software.  Each version will be given a distinguishing version number.  Once Software has been published under a particular version of this Licence, you may continue to use it under the terms of that version.  You may also choose to use the latest version of the Software under any subsequent version published by XMOS.  Only XMOS shall have the right to modify these terms.
+
+**7. IPR and Ownership**
+Any rights, including all intellectual property rights and all trademarks not expressly granted herein are reserved in full by the authors or copyright holders. Any requests for additional permissions by XMOS including any rights to use XMOS trademarks, should be made (without obligation) to XMOS at **support@xmos.com**
+
+Nothing herein shall limit any rights that XMOS is otherwise entitled to under the doctrines of patent exhaustion, implied license, or legal estoppel.  Neither the name of the authors, the copyright holders or any contributors may be used to endorse or promote any Derivatives from this Software without specific written permission.  Any attempt to deal with the Software which does not comply with this Licence shall be void and shall automatically terminate any rights granted under this licence (including any licence of any intellectual property rights granted herein).
+Subject to the licences granted under this Licence any Contributor retains all rights, title and interest in and to any Derivatives made by Contributor subject to the underlying rights of XMOS in the Software.  XMOS shall retain all rights, title and interest in the Software and any Derivatives made by XMOS (“XMOS Derivatives”).  XMOS Derivatives will not automatically be subject to this Licence and XMOS shall be entitled to licence such rights on any terms (without obligation) as it sees fit.
+
+**8. Termination**
+
+8.1 This Licence will automatically terminate immediately, without notice to you, if:
+
+(a) you fail to comply with the terms of this Licence; and/or
+
+(b) you directly or indirectly commence any action for patent or intellectual property right infringement against XMOS, or any parent, group, affiliate or subsidiary of XMOS; provided XMOS did not first commence an action or patent infringement against you in that instance; and/or
+
+(c) the terms of this Licence are held by any court of competent jurisdiction to be unenforceable in whole or in part.
+
+**9. Critical Applications.**  Unless XMOS has agreed in writing with you an agreement specifically governing use of the Goods in military, aerospace, automotive or medically related functions (collectively and individually hereinafter referred to as "Special Use"), any permitted use of the Software excludes Special Use. Notwithstanding any agreement between XMOS and you for Special Use, Special Use shall be at your own risk, and you shall fully indemnify XMOS against any damages, losses, costs and claims (direct and indirect) arising out of any Special Use.
+
+**10. NO WARRANTY OR SUPPORT.**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL XMOS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, WARRANTY, CIVIL TORT (INCLUDING NEGLIGENCE), PRODUCTS LIABILITY OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE INCLUDING GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES EVEN IF SUCH PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES AND NOT WITHSTANDING THE FAILURE OF ESSENTIAL PURPOSE.  IN SOME JURISDICTIONS PARTIES ARE UNABLE TO LIMIT LIABILTY IN THIS WAY, IF THIS APPLIES TO YOUR JURISDICTION THIS LIABILITY CLAUSE ABOVE MAY NOT APPLY.  NOTWITHSTANDING THE ABOVE, IN NO EVENT SHALL XMOS’s TOTAL LIABILITY TO YOU FOR ALL DAMAGES, LOSS OR OTHERWISE EXCEED $50.
+
+**11. Governing Law and Jurisdiction.**  This Licence constitutes the entire agreement between the parties with respect to the subject matter hereof. The Licence shall be governed by the laws of England and the conflict of laws and UN Convention on Contracts for the International Sale of Goods, shall not apply.

LICENSE.txt

@@ -1,135 +0,0 @@
-Software Release License Agreement
-
-Copyright (c) 2011-2020, XMOS, All rights reserved.
-
-BY ACCESSING, USING, INSTALLING OR DOWNLOADING THE XMOS SOFTWARE, YOU AGREE TO BE BOUND BY THE FOLLOWING TERMS. IF YOU DO NOT AGREE TO THESE, DO NOT ATTEMPT TO DOWNLOAD, ACCESS OR USE THE XMOS Software.
-
-Parties:
-
-(1) XMOS Limited, incorporated and registered in England and Wales with company number 5494985 whose registered office is 107 Cheapside, London, EC2V 6DN (XMOS).
-
-(2)  An individual or legal entity exercising permissions granted by this License (Customer).
-
-If you are entering into this Agreement on behalf of another legal entity such as a company, partnership, university, college etc. (for example, as an employee, student or consultant), you warrant that you have authority to bind that entity.
-
-1. Definitions
-
-"License" means this Software License and any schedules or annexes to it.
-
-"License Fee" means the fee for the XMOS Software as detailed in any schedules or annexes to this Software License
-
-"Licensee Modifications" means all developments and modifications of the XMOS Software developed independently by the Customer.
-
-"XMOS Modifications" means all developments and modifications of the XMOS Software developed or co-developed by XMOS.
-
-"XMOS Hardware" means any XMOS hardware devices supplied by XMOS from time to time and/or the particular XMOS devices detailed in any schedules or annexes to this Software License.
-
-"XMOS Software" comprises the XMOS owned circuit designs, schematics, source code, object code, reference designs, (including related programmer comments and documentation, if any), error corrections, improvements, modifications (including XMOS Modifications) and updates.
-
-The headings in this License do not affect its interpretation. Save where the context otherwise requires, references to clauses and schedules are to clauses and schedules of this License.
-
-Unless the context otherwise requires:
-
-- references to XMOS and the Customer include their permitted successors and assigns; 
-- references to statutory provisions include those statutory provisions as amended or re-enacted; and
-- references to any gender include all genders.
-
-Words in the singular include the plural and in the plural include the singular.
-
-2. License
-
-XMOS grants the Customer a non-exclusive license to use, develop, modify and distribute the XMOS Software with, or for the purpose of being used with, XMOS Hardware.
-
-Open Source Software (OSS) must be used and dealt with in accordance with any license terms under which OSS is distributed.
-
-3. Consideration
-
-In consideration of the mutual obligations contained in this License, the parties agree to its terms.
-
-4. Term
-
-Subject to clause 12 below, this License shall be perpetual.
-
-5. Restrictions on Use
-
-The Customer will adhere to all applicable import and export laws and regulations of the country in which it resides and of the United States and United Kingdom, without limitation. The Customer agrees that it is its responsibility to obtain copies of and to familiarise itself fully with these laws and regulations to avoid violation.
-
-6. Modifications
-
-The Customer will own all intellectual property rights in the Licensee Modifications but will undertake to provide XMOS with any fixes made to correct any bugs found in the XMOS Software on a non-exclusive, perpetual and royalty free license basis.
-
-XMOS will own all intellectual property rights in the XMOS Modifications. 
-The Customer may only use the Licensee Modifications and XMOS Modifications on, or in relation to, XMOS Hardware.
-
-7. Support
-
-Support of the XMOS Software may be provided by XMOS pursuant to a separate support agreement. 
-
-8. Warranty and Disclaimer
-
-The XMOS Software is provided "AS IS" without a warranty of any kind. XMOS and its licensors' entire liability and Customer's exclusive remedy under this warranty to be determined in XMOS's sole and absolute discretion, will be either (a) the corrections of defects in media or replacement of the media, or (b) the refund of the license fee paid (if any).
-
-Whilst XMOS gives the Customer the ability to load their own software and applications onto XMOS devices, the security of such software and applications when on the XMOS devices is the Customer's own responsibility and any breach of security shall not be deemed a defect or failure of the hardware. XMOS shall have no liability whatsoever in relation to any costs, damages or other losses Customer may incur as a result of any breaches of security in relation to your software or applications.
-
-XMOS AND ITS LICENSORS DISCLAIM ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY/ SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT EXCEPT TO THE EXTENT THAT THESE DISCLAIMERS ARE HELD TO BE LEGALLY INVALID UNDER APPLICABLE LAW.
-
-9. High Risk Activities
-
-The XMOS Software is not designed or intended for use in conjunction with on-line control equipment in hazardous environments requiring fail-safe performance, including without limitation the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, life support machines, or weapons systems (collectively "High Risk Activities") in which the failure of the XMOS Software could lead directly to death, personal injury, or severe physical or environmental damage. XMOS and its licensors specifically disclaim any express or implied warranties relating to use of the XMOS Software in connection with High Risk Activities.
-
-10. Liability
-
-TO THE EXTENT NOT PROHIBITED BY APPLICABLE LAW, NEITHER XMOS NOR ITS LICENSORS SHALL BE LIABLE FOR ANY LOST REVENUE, BUSINESS, PROFIT, CONTRACTS OR DATA, ADMINISTRATIVE OR OVERHEAD EXPENSES, OR FOR SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES HOWEVER CAUSED AND REGARDLESS OF THEORY OF LIABILITY ARISING OUT OF THIS LICENSE, EVEN IF XMOS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. In no event shall XMOS's liability to the Customer whether in contract, tort (including negligence), or otherwise exceed the License Fee.
-
-Customer agrees to indemnify, hold harmless, and defend XMOS and its licensors from and against any claims or lawsuits, including attorneys' fees and any other liabilities, demands, proceedings, damages, losses, costs, expenses fines and charges which are made or brought against or incurred by XMOS as a result of your use or distribution of the Licensee Modifications or your use or distribution of XMOS Software, or any development of it, other than in accordance with the terms of this License.
-
-11. Ownership
-
-The copyrights and all other intellectual and industrial property rights for the protection of information with respect to the XMOS Software (including the methods and techniques on which they are based) are retained by XMOS and/or its licensors. Nothing in this Agreement serves to transfer such rights. Customer may not sell, mortgage, underlet, sublease, sublicense, lend or transfer possession of the XMOS Software in any way whatsoever to any third party who is not bound by this Agreement.
-
-12. Termination
-
-Either party may terminate this License at any time on written notice to the other if the other:
-
-- is in material or persistent breach of any of the terms of this License and either that breach is incapable of remedy, or the other party fails to remedy that breach within 30 days after receiving written notice requiring it to remedy that breach; or
-
-- is unable to pay its debts (within the meaning of section 123 of the Insolvency Act 1986), or becomes insolvent, or is subject to an order or a resolution for its liquidation, administration, winding-up or dissolution (otherwise than for the purposes of a solvent amalgamation or reconstruction), or has an administrative or other receiver, manager, trustee, liquidator, administrator or similar officer appointed over all or any substantial part of its assets, or enters into or proposes any composition or arrangement with its creditors generally, or is subject to any analogous event or proceeding in any applicable jurisdiction.
-
-Termination by either party in accordance with the rights contained in clause 12 shall be without prejudice to any other rights or remedies of that party accrued prior to termination.
-
-On termination for any reason:
-
-- all rights granted to the Customer under this License shall cease;
-- the Customer shall cease all activities authorised by this License;
-- the Customer shall immediately pay any sums due to XMOS under this License; and
-- the Customer shall immediately destroy or return to the XMOS (at the XMOS's option) all copies of the XMOS Software then in its possession, custody or control and, in the case of destruction, certify to XMOS that it has done so.
-
-Clauses 5, 8, 9, 10 and 11 shall survive any effective termination of this Agreement.
-
-13. Third party rights
-
-No term of this License is intended to confer a benefit on, or to be enforceable by, any person who is not a party to this license.
-
-14. Confidentiality and publicity
-
-Each party shall, during the term of this License and thereafter, keep confidential all, and shall not use for its own purposes nor without the prior written consent of the other disclose to any third party any, information of a confidential nature (including, without limitation, trade secrets and information of commercial value) which may become known to such party from the other party and which relates to the other party, unless such information is public knowledge or already known to such party at the time of disclosure, or subsequently becomes public knowledge other than by breach of this license, or subsequently comes lawfully into the possession of such party from a third party.
-
-The terms of this license are confidential and may not be disclosed by the Customer without the prior written consent of XMOS.
-The provisions of clause 14 shall remain in full force and effect notwithstanding termination of this license for any reason.
-
-15. Entire agreement
-
-This License and the documents annexed as appendices to this License or otherwise referred to herein contain the whole agreement between the parties relating to the subject matter hereof and supersede all prior agreements, arrangements and understandings between the parties relating to that subject matter.
-
-16. Assignment
-
-The Customer shall not assign this License or any of the rights granted under it without XMOS's prior written consent.
-
-17. Governing law and jurisdiction
-
-This License shall be governed by and construed in accordance with English law and each party hereby submits to the non-exclusive jurisdiction of the English courts.
-
-This License has been entered into on the date stated at the beginning of it.
-
-Schedule
-XMOS lib_xua software

README.rst

@@ -1,6 +1,11 @@
 lib_xua
 =======
 
+:Latest release: 3.2.0rc1
+
+
+:Scope: General Use
+
 Summary
 -------
 
@@ -33,6 +38,12 @@ Key features of the various applications in this repository are as follows
 
 - ADAT input
 
+- Synchronisation to external digital streams i.e. S/PDIF or ADAT
+
+- I2S slave & master modes
+
+- TDM slave & master modes
+
 - MIDI input/output (Compliant to USB Class Specification for MIDI devices)
 
 - DSD output (Native and DoP mode) at DSD64 and DSD128 rates
@@ -45,11 +56,11 @@ Key features of the various applications in this repository are as follows
 
 Note, not all features may be supported at all sample frequencies, simultaneously or on all devices.  Some features also require specific host driver support.
 
-
 Software version and dependencies
 .................................
 
-.. libdeps::
+The CHANGELOG contains information about the current and previous versions.
+For a list of direct dependencies, look for DEPENDENT_MODULES in lib_xua/module_build_info.
 
 Related Application Notes
 .........................
@@ -59,3 +70,15 @@ The following application notes use this library:
     * AN000246 - Simple USB Audio Device using lib_xua
     * AN000247 - Using lib_xua with lib_spdif (transmit)
     * AN000248 - Using lib_xua with lib_mic_array
+
+Required software (dependencies)
+================================
+
+  * lib_locks (git@github.com:xmos/lib_locks.git)
+  * lib_logging (git@github.com:xmos/lib_logging)
+  * lib_mic_array (git@github.com:xmos/lib_mic_array.git)
+  * lib_xassert (git@github.com:xmos/lib_xassert)
+  * lib_dsp (git@github.com:xmos/lib_dsp)
+  * lib_spdif (git@github.com:xmos/lib_spdif)
+  * lib_xud (git@github.com:xmos/lib_xud)
+

doc/dfu/rst/building_xmos_dfu.rst

@@ -39,3 +39,18 @@ Raspberry Pi
 A makefile is provided for Raspbian. libusb is required and can be installed using the ``apt-get`` command from previous Linux section.
 
 .. literalinclude:: Makefile.Pi
+
+Windows
+-------
+
+To build on Windows, you must first install Visual Studio 2019 Build Tools with
+C++ support. `This is available from Microsoft's website. <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019>`_
+
+To build, open a Developer Command Prompt via the start menu and navigate to the
+xmosdfu folder.  The command to build is as follows:
+
+  ``nmake /f Makefile.Win32``
+
+This Makefile contains the following:
+
+.. literalinclude:: Makefile.Win32

doc/dfu/rst/xdoc.conf

@@ -0,0 +1,3 @@
+XMOSNEWSTYLE=2
+SOURCE_INCLUDE_DIRS=../../../lib_xua/host/xmosdfu
+SPHINX_MASTER_DOC=dfu

doc/dfu/rst/xmos_dfu.rst

@@ -4,6 +4,9 @@ Using the DFU loader - macOS (via the XMOS DFU loader)
 The XMOS DFU loader is provided as source as part of the XMOS USB Audio software
 framework, see :ref:`usb_audiosec_building_xmos_dfu`.
 
+NOTE: Windows requires the installation of libusbK drivers on the DFU endpoint.
+We recommend using `Zadig <https://zadig.akeo.ie/>`_.
+
 Set up the image loader
 -----------------------
 
@@ -18,7 +21,7 @@ Download new firmware
 
 To program the new firmware run the command:
 
-   ``./xmosdfu XMOS_L2_AUDIO2_PID --download new_firmware.bin``
+   ``./bin/xmosdfu XMOS_L2_AUDIO2_PID --download new_firmware.bin``
 
 Replace ``XMOS_L2_AUDIO2_PID`` with product ID of your target device. Invoke
 ``xmosdfu`` with no arguments to get a list of all supported product IDs.
@@ -35,7 +38,7 @@ present.
 
 Run the command:
 
-  ``./xmosdfu XMOS_L2_AUDIO2_PID --upload currentfirmware.bin``
+  ``./bin/xmosdfu XMOS_L2_AUDIO2_PID --upload currentfirmware.bin``
 
 The file ``currentfirmware.bin`` contains the latest upgrade image. This file is
 an exact copy of the data from the flash and can be downloaded to the device
@@ -47,6 +50,6 @@ Reverting firmware to factory image
 To revert the device back to its factory (i.e XFLASH) installed state from the
 new firmware, run the command:
 
-  ``./xmosdfu XMOS_L2_AUDIO2_PID --revertfactory``
+  ``./bin/xmosdfu XMOS_L2_AUDIO2_PID --revertfactory``
 
 The device will now be running, and only contain the factory firmware.

doc_dfu/.gitignore

@@ -1 +0,0 @@
-_build

doc_dfu/LICENSE.txt

@@ -1,135 +0,0 @@
-Software Release License Agreement
-
-Copyright (c) 2017-2018, XMOS, All rights reserved.
-
-BY ACCESSING, USING, INSTALLING OR DOWNLOADING THE XMOS SOFTWARE, YOU AGREE TO BE BOUND BY THE FOLLOWING TERMS. IF YOU DO NOT AGREE TO THESE, DO NOT ATTEMPT TO DOWNLOAD, ACCESS OR USE THE XMOS Software.
-
-Parties:
-
-(1) XMOS Limited, incorporated and registered in England and Wales with company number 5494985 whose registered office is 107 Cheapside, London, EC2V 6DN (XMOS).
-
-(2)  An individual or legal entity exercising permissions granted by this License (Customer).
-
-If you are entering into this Agreement on behalf of another legal entity such as a company, partnership, university, college etc. (for example, as an employee, student or consultant), you warrant that you have authority to bind that entity.
-
-1. Definitions
-
-"License" means this Software License and any schedules or annexes to it.
-
-"License Fee" means the fee for the XMOS Software as detailed in any schedules or annexes to this Software License
-
-"Licensee Modifications" means all developments and modifications of the XMOS Software developed independently by the Customer.
-
-"XMOS Modifications" means all developments and modifications of the XMOS Software developed or co-developed by XMOS.
-
-"XMOS Hardware" means any XMOS hardware devices supplied by XMOS from time to time and/or the particular XMOS devices detailed in any schedules or annexes to this Software License.
-
-"XMOS Software" comprises the XMOS owned circuit designs, schematics, source code, object code, reference designs, (including related programmer comments and documentation, if any), error corrections, improvements, modifications (including XMOS Modifications) and updates.
-
-The headings in this License do not affect its interpretation. Save where the context otherwise requires, references to clauses and schedules are to clauses and schedules of this License.
-
-Unless the context otherwise requires:
-
-- references to XMOS and the Customer include their permitted successors and assigns; 
-- references to statutory provisions include those statutory provisions as amended or re-enacted; and
-- references to any gender include all genders.
-
-Words in the singular include the plural and in the plural include the singular.
-
-2. License
-
-XMOS grants the Customer a non-exclusive license to use, develop, modify and distribute the XMOS Software with, or for the purpose of being used with, XMOS Hardware.
-
-Open Source Software (OSS) must be used and dealt with in accordance with any license terms under which OSS is distributed.
-
-3. Consideration
-
-In consideration of the mutual obligations contained in this License, the parties agree to its terms.
-
-4. Term
-
-Subject to clause 12 below, this License shall be perpetual.
-
-5. Restrictions on Use
-
-The Customer will adhere to all applicable import and export laws and regulations of the country in which it resides and of the United States and United Kingdom, without limitation. The Customer agrees that it is its responsibility to obtain copies of and to familiarise itself fully with these laws and regulations to avoid violation.
-
-6. Modifications
-
-The Customer will own all intellectual property rights in the Licensee Modifications but will undertake to provide XMOS with any fixes made to correct any bugs found in the XMOS Software on a non-exclusive, perpetual and royalty free license basis.
-
-XMOS will own all intellectual property rights in the XMOS Modifications. 
-The Customer may only use the Licensee Modifications and XMOS Modifications on, or in relation to, XMOS Hardware.
-
-7. Support
-
-Support of the XMOS Software may be provided by XMOS pursuant to a separate support agreement. 
-
-8. Warranty and Disclaimer
-
-The XMOS Software is provided "AS IS" without a warranty of any kind. XMOS and its licensors' entire liability and Customer's exclusive remedy under this warranty to be determined in XMOS's sole and absolute discretion, will be either (a) the corrections of defects in media or replacement of the media, or (b) the refund of the license fee paid (if any).
-
-Whilst XMOS gives the Customer the ability to load their own software and applications onto XMOS devices, the security of such software and applications when on the XMOS devices is the Customer's own responsibility and any breach of security shall not be deemed a defect or failure of the hardware. XMOS shall have no liability whatsoever in relation to any costs, damages or other losses Customer may incur as a result of any breaches of security in relation to your software or applications.
-
-XMOS AND ITS LICENSORS DISCLAIM ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY/ SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT EXCEPT TO THE EXTENT THAT THESE DISCLAIMERS ARE HELD TO BE LEGALLY INVALID UNDER APPLICABLE LAW.
-
-9. High Risk Activities
-
-The XMOS Software is not designed or intended for use in conjunction with on-line control equipment in hazardous environments requiring fail-safe performance, including without limitation the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, life support machines, or weapons systems (collectively "High Risk Activities") in which the failure of the XMOS Software could lead directly to death, personal injury, or severe physical or environmental damage. XMOS and its licensors specifically disclaim any express or implied warranties relating to use of the XMOS Software in connection with High Risk Activities.
-
-10. Liability
-
-TO THE EXTENT NOT PROHIBITED BY APPLICABLE LAW, NEITHER XMOS NOR ITS LICENSORS SHALL BE LIABLE FOR ANY LOST REVENUE, BUSINESS, PROFIT, CONTRACTS OR DATA, ADMINISTRATIVE OR OVERHEAD EXPENSES, OR FOR SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES HOWEVER CAUSED AND REGARDLESS OF THEORY OF LIABILITY ARISING OUT OF THIS LICENSE, EVEN IF XMOS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. In no event shall XMOS's liability to the Customer whether in contract, tort (including negligence), or otherwise exceed the License Fee.
-
-Customer agrees to indemnify, hold harmless, and defend XMOS and its licensors from and against any claims or lawsuits, including attorneys' fees and any other liabilities, demands, proceedings, damages, losses, costs, expenses fines and charges which are made or brought against or incurred by XMOS as a result of your use or distribution of the Licensee Modifications or your use or distribution of XMOS Software, or any development of it, other than in accordance with the terms of this License.
-
-11. Ownership
-
-The copyrights and all other intellectual and industrial property rights for the protection of information with respect to the XMOS Software (including the methods and techniques on which they are based) are retained by XMOS and/or its licensors. Nothing in this Agreement serves to transfer such rights. Customer may not sell, mortgage, underlet, sublease, sublicense, lend or transfer possession of the XMOS Software in any way whatsoever to any third party who is not bound by this Agreement.
-
-12. Termination
-
-Either party may terminate this License at any time on written notice to the other if the other:
-
-- is in material or persistent breach of any of the terms of this License and either that breach is incapable of remedy, or the other party fails to remedy that breach within 30 days after receiving written notice requiring it to remedy that breach; or
-
-- is unable to pay its debts (within the meaning of section 123 of the Insolvency Act 1986), or becomes insolvent, or is subject to an order or a resolution for its liquidation, administration, winding-up or dissolution (otherwise than for the purposes of a solvent amalgamation or reconstruction), or has an administrative or other receiver, manager, trustee, liquidator, administrator or similar officer appointed over all or any substantial part of its assets, or enters into or proposes any composition or arrangement with its creditors generally, or is subject to any analogous event or proceeding in any applicable jurisdiction.
-
-Termination by either party in accordance with the rights contained in clause 12 shall be without prejudice to any other rights or remedies of that party accrued prior to termination.
-
-On termination for any reason:
-
-- all rights granted to the Customer under this License shall cease;
-- the Customer shall cease all activities authorised by this License;
-- the Customer shall immediately pay any sums due to XMOS under this License; and
-- the Customer shall immediately destroy or return to the XMOS (at the XMOS's option) all copies of the XMOS Software then in its possession, custody or control and, in the case of destruction, certify to XMOS that it has done so.
-
-Clauses 5, 8, 9, 10 and 11 shall survive any effective termination of this Agreement.
-
-13. Third party rights
-
-No term of this License is intended to confer a benefit on, or to be enforceable by, any person who is not a party to this license.
-
-14. Confidentiality and publicity
-
-Each party shall, during the term of this License and thereafter, keep confidential all, and shall not use for its own purposes nor without the prior written consent of the other disclose to any third party any, information of a confidential nature (including, without limitation, trade secrets and information of commercial value) which may become known to such party from the other party and which relates to the other party, unless such information is public knowledge or already known to such party at the time of disclosure, or subsequently becomes public knowledge other than by breach of this license, or subsequently comes lawfully into the possession of such party from a third party.
-
-The terms of this license are confidential and may not be disclosed by the Customer without the prior written consent of XMOS.
-The provisions of clause 14 shall remain in full force and effect notwithstanding termination of this license for any reason.
-
-15. Entire agreement
-
-This License and the documents annexed as appendices to this License or otherwise referred to herein contain the whole agreement between the parties relating to the subject matter hereof and supersede all prior agreements, arrangements and understandings between the parties relating to that subject matter.
-
-16. Assignment
-
-The Customer shall not assign this License or any of the rights granted under it without XMOS's prior written consent.
-
-17. Governing law and jurisdiction
-
-This License shall be governed by and construed in accordance with English law and each party hereby submits to the non-exclusive jurisdiction of the English courts.
-
-This License has been entered into on the date stated at the beginning of it.
-
-Schedule
-XMOS lib_xua software

doc_dfu/Makefile

@@ -1 +0,0 @@
-SOURCE_INCLUDE_DIRS=../lib_xua/host/xmosdfu

examples/AN00246_xua_example/LICENSE.rst

@@ -0,0 +1,84 @@
+*******************************
+XMOS PUBLIC LICENCE: Version 1
+*******************************
+
+Subject to the conditions and limitations below, permission is hereby granted by XMOS LIMITED (“XMOS”), free of charge, to any person or entity obtaining a copy of the XMOS Software.
+
+**1. Definitions**
+
+**“Applicable Patent Rights”** means: (a) where XMOS is the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to XMOS and (ii) that cover subject matter contained in the Software, but only to the extent it is necessary to use, reproduce or distribute the Software without infringement; and (b) where you are the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to you and (ii) that cover the subject matter contained in your Derivatives, taken alone or in combination with the Software.
+
+**“Compiled Code”** means any compiled, binary, machine readable or executable version of the Source Code.
+
+**“Contributor”** means any person or entity that creates or contributes to the creation of Derivatives.
+
+**“Derivatives”** means any addition to, deletion from and/or change to the substance, structure of the Software, any previous Derivatives, the combination of the Derivatives and the Software and/or any respective portions thereof.
+
+**“Source Code”** means the human readable code that is suitable for making modifications but excluding any Compiled Code.
+
+**“Software”** means the software and associated documentation files which XMOS makes available and which contain a notice identifying the software as original XMOS software and referring to the software being subject to the terms of this XMOS Public Licence.
+
+This Licence refers to XMOS Software and does not relate to any XMOS hardware or devices which are protected by intellectual property rights (including patent and trade marks) which may be sold to you under a separate agreement.
+
+
+**2. Licence**
+
+**Permitted Uses, Conditions and Restrictions.**  Subject to the conditions below, XMOS grants you a worldwide, royalty free, non-exclusive licence, to the extent of any Patent Rights to do the following:
+
+2.1 **Unmodified Software.** You may use, copy, display, publish, distribute and make available unmodified copies of the Software:
+
+2.1.1 for personal or academic, non-commercial purposes; or
+
+2.1.2 for commercial purposes provided the Software is at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.1.1 and 2.1.2):
+
+(a) you must retain and reproduce in all copies of the Software the copyright and proprietary notices and disclaimers of XMOS as they appear in the Software, and keep intact all notices and disclaimers in the Software files that refer to this Licence; and
+
+(b) you must include a copy of this Licence with every copy of the Software and documentation you publish, distribute and make available and you may not offer or impose any terms on such Software that alter or restrict this Licence or the intent of such Licence, except as permitted below (Additional Terms).
+
+The licence above does not include any Compiled Code which XMOS may make available under a separate support and licence agreement.
+
+2.2 **Derivatives.** You may create and modify Derivatives and use, copy, display, publish, distribute and make available Derivatives:
+
+2.2.1 for personal or academic, non-commercial purposes; or
+
+2.2.2 for commercial purposes, provided the Derivatives are at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.2.1 and 2.2.2):
+
+(a) you must comply with the terms of clause 2.1 with respect to the Derivatives;
+
+(b) you must copy (to the extent it doesn’t already exist) the notice below in each file of the Derivatives, and ensure all the modified files carry prominent notices stating that you have changed the files and the date of any change; and
+
+(c) if you sublicence, distribute or otherwise make the Software and/or the Derivatives available for commercial purposes, you must provide that the Software and Derivatives are at all times used on a device designed, licensed or developed by XMOS.
+
+Without limitation to these terms and clause 3 below, the Source Code and Compiled Code to your Derivatives may at your discretion (but without obligation) be released, copied, displayed, published, distributed and made available; and if you elect to do so, it must be under the terms of this Licence including the terms of the licence at clauses 2.2.1, 2.2.2 and clause 3 below.
+
+2.3 **Distribution of Executable Versions.**  If you distribute or make available Derivatives, you must include a prominent notice in the code itself as well as in all related documentation, stating that the Source Code of the Software from which the Derivatives are based is available under the terms of this Licence, with information on how and where to obtain such Source Code.
+
+**3. Your Grant of Rights.**  In consideration and as a condition to this Licence, you grant to any person or entity receiving or distributing any Derivatives, a non-exclusive, royalty free, perpetual, irrevocable license under your Applicable Patent Rights and all other intellectual property rights owned or controlled by you, to use, copy, display, publish, distribute and make available your Derivatives of the same scope and extent as XMOS’s licence under clause 2.2 above.
+
+**4. Combined Products.**  You may create a combined product by combining Software, Derivatives and other code not covered by this Licence as a single application or product. In such instance, you must comply with the requirements of this Licence for any portion of the Software and/or Derivatives.
+
+**5. Additional Terms.**  You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations and/or other rights consistent with the term of this Licence (“Additional Terms”) to any legitimate recipients of the Software and/or Derivatives.  The terms on which you provide such Additional Terms are on your sole responsibility and you shall indemnify, defend and hold XMOS harmless against any claims asserted against XMOS.
+
+**6. New Versions.**  XMOS may publish revised and/or new versions of this Licence from time to time to accommodate changes to the Licence terms, new versions, updates and bug fixes of the Software.  Each version will be given a distinguishing version number.  Once Software has been published under a particular version of this Licence, you may continue to use it under the terms of that version.  You may also choose to use the latest version of the Software under any subsequent version published by XMOS.  Only XMOS shall have the right to modify these terms.
+
+**7. IPR and Ownership**
+Any rights, including all intellectual property rights and all trademarks not expressly granted herein are reserved in full by the authors or copyright holders. Any requests for additional permissions by XMOS including any rights to use XMOS trademarks, should be made (without obligation) to XMOS at **support@xmos.com**
+
+Nothing herein shall limit any rights that XMOS is otherwise entitled to under the doctrines of patent exhaustion, implied license, or legal estoppel.  Neither the name of the authors, the copyright holders or any contributors may be used to endorse or promote any Derivatives from this Software without specific written permission.  Any attempt to deal with the Software which does not comply with this Licence shall be void and shall automatically terminate any rights granted under this licence (including any licence of any intellectual property rights granted herein).
+Subject to the licences granted under this Licence any Contributor retains all rights, title and interest in and to any Derivatives made by Contributor subject to the underlying rights of XMOS in the Software.  XMOS shall retain all rights, title and interest in the Software and any Derivatives made by XMOS (“XMOS Derivatives”).  XMOS Derivatives will not automatically be subject to this Licence and XMOS shall be entitled to licence such rights on any terms (without obligation) as it sees fit.
+
+**8. Termination**
+
+8.1 This Licence will automatically terminate immediately, without notice to you, if:
+
+(a) you fail to comply with the terms of this Licence; and/or
+
+(b) you directly or indirectly commence any action for patent or intellectual property right infringement against XMOS, or any parent, group, affiliate or subsidiary of XMOS; provided XMOS did not first commence an action or patent infringement against you in that instance; and/or
+
+(c) the terms of this Licence are held by any court of competent jurisdiction to be unenforceable in whole or in part.
+
+**9. Critical Applications.**  Unless XMOS has agreed in writing with you an agreement specifically governing use of the Goods in military, aerospace, automotive or medically related functions (collectively and individually hereinafter referred to as "Special Use"), any permitted use of the Software excludes Special Use. Notwithstanding any agreement between XMOS and you for Special Use, Special Use shall be at your own risk, and you shall fully indemnify XMOS against any damages, losses, costs and claims (direct and indirect) arising out of any Special Use.
+
+**10. NO WARRANTY OR SUPPORT.**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL XMOS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, WARRANTY, CIVIL TORT (INCLUDING NEGLIGENCE), PRODUCTS LIABILITY OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE INCLUDING GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES EVEN IF SUCH PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES AND NOT WITHSTANDING THE FAILURE OF ESSENTIAL PURPOSE.  IN SOME JURISDICTIONS PARTIES ARE UNABLE TO LIMIT LIABILTY IN THIS WAY, IF THIS APPLIES TO YOUR JURISDICTION THIS LIABILITY CLAUSE ABOVE MAY NOT APPLY.  NOTWITHSTANDING THE ABOVE, IN NO EVENT SHALL XMOS’s TOTAL LIABILITY TO YOU FOR ALL DAMAGES, LOSS OR OTHERWISE EXCEED $50.
+
+**11. Governing Law and Jurisdiction.**  This Licence constitutes the entire agreement between the parties with respect to the subject matter hereof. The Licence shall be governed by the laws of England and the conflict of laws and UN Convention on Contracts for the International Sale of Goods, shall not apply.

examples/AN00246_xua_example/LICENSE.txt

@@ -1,135 +0,0 @@
-Software Release License Agreement
-
-Copyright (c) 2018-2019, XMOS, All rights reserved.
-
-BY ACCESSING, USING, INSTALLING OR DOWNLOADING THE XMOS SOFTWARE, YOU AGREE TO BE BOUND BY THE FOLLOWING TERMS. IF YOU DO NOT AGREE TO THESE, DO NOT ATTEMPT TO DOWNLOAD, ACCESS OR USE THE XMOS Software.
-
-Parties:
-
-(1) XMOS Limited, incorporated and registered in England and Wales with company number 5494985 whose registered office is 107 Cheapside, London, EC2V 6DN (XMOS).
-
-(2)  An individual or legal entity exercising permissions granted by this License (Customer).
-
-If you are entering into this Agreement on behalf of another legal entity such as a company, partnership, university, college etc. (for example, as an employee, student or consultant), you warrant that you have authority to bind that entity.
-
-1. Definitions
-
-"License" means this Software License and any schedules or annexes to it.
-
-"License Fee" means the fee for the XMOS Software as detailed in any schedules or annexes to this Software License
-
-"Licensee Modifications" means all developments and modifications of the XMOS Software developed independently by the Customer.
-
-"XMOS Modifications" means all developments and modifications of the XMOS Software developed or co-developed by XMOS.
-
-"XMOS Hardware" means any XMOS hardware devices supplied by XMOS from time to time and/or the particular XMOS devices detailed in any schedules or annexes to this Software License.
-
-"XMOS Software" comprises the XMOS owned circuit designs, schematics, source code, object code, reference designs, (including related programmer comments and documentation, if any), error corrections, improvements, modifications (including XMOS Modifications) and updates.
-
-The headings in this License do not affect its interpretation. Save where the context otherwise requires, references to clauses and schedules are to clauses and schedules of this License.
-
-Unless the context otherwise requires:
-
-- references to XMOS and the Customer include their permitted successors and assigns; 
-- references to statutory provisions include those statutory provisions as amended or re-enacted; and
-- references to any gender include all genders.
-
-Words in the singular include the plural and in the plural include the singular.
-
-2. License
-
-XMOS grants the Customer a non-exclusive license to use, develop, modify and distribute the XMOS Software with, or for the purpose of being used with, XMOS Hardware.
-
-Open Source Software (OSS) must be used and dealt with in accordance with any license terms under which OSS is distributed.
-
-3. Consideration
-
-In consideration of the mutual obligations contained in this License, the parties agree to its terms.
-
-4. Term
-
-Subject to clause 12 below, this License shall be perpetual.
-
-5. Restrictions on Use
-
-The Customer will adhere to all applicable import and export laws and regulations of the country in which it resides and of the United States and United Kingdom, without limitation. The Customer agrees that it is its responsibility to obtain copies of and to familiarise itself fully with these laws and regulations to avoid violation.
-
-6. Modifications
-
-The Customer will own all intellectual property rights in the Licensee Modifications but will undertake to provide XMOS with any fixes made to correct any bugs found in the XMOS Software on a non-exclusive, perpetual and royalty free license basis.
-
-XMOS will own all intellectual property rights in the XMOS Modifications. 
-The Customer may only use the Licensee Modifications and XMOS Modifications on, or in relation to, XMOS Hardware.
-
-7. Support
-
-Support of the XMOS Software may be provided by XMOS pursuant to a separate support agreement. 
-
-8. Warranty and Disclaimer
-
-The XMOS Software is provided "AS IS" without a warranty of any kind. XMOS and its licensors' entire liability and Customer's exclusive remedy under this warranty to be determined in XMOS's sole and absolute discretion, will be either (a) the corrections of defects in media or replacement of the media, or (b) the refund of the license fee paid (if any).
-
-Whilst XMOS gives the Customer the ability to load their own software and applications onto XMOS devices, the security of such software and applications when on the XMOS devices is the Customer's own responsibility and any breach of security shall not be deemed a defect or failure of the hardware. XMOS shall have no liability whatsoever in relation to any costs, damages or other losses Customer may incur as a result of any breaches of security in relation to your software or applications.
-
-XMOS AND ITS LICENSORS DISCLAIM ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY/ SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT EXCEPT TO THE EXTENT THAT THESE DISCLAIMERS ARE HELD TO BE LEGALLY INVALID UNDER APPLICABLE LAW.
-
-9. High Risk Activities
-
-The XMOS Software is not designed or intended for use in conjunction with on-line control equipment in hazardous environments requiring fail-safe performance, including without limitation the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, life support machines, or weapons systems (collectively "High Risk Activities") in which the failure of the XMOS Software could lead directly to death, personal injury, or severe physical or environmental damage. XMOS and its licensors specifically disclaim any express or implied warranties relating to use of the XMOS Software in connection with High Risk Activities.
-
-10. Liability
-
-TO THE EXTENT NOT PROHIBITED BY APPLICABLE LAW, NEITHER XMOS NOR ITS LICENSORS SHALL BE LIABLE FOR ANY LOST REVENUE, BUSINESS, PROFIT, CONTRACTS OR DATA, ADMINISTRATIVE OR OVERHEAD EXPENSES, OR FOR SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES HOWEVER CAUSED AND REGARDLESS OF THEORY OF LIABILITY ARISING OUT OF THIS LICENSE, EVEN IF XMOS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. In no event shall XMOS's liability to the Customer whether in contract, tort (including negligence), or otherwise exceed the License Fee.
-
-Customer agrees to indemnify, hold harmless, and defend XMOS and its licensors from and against any claims or lawsuits, including attorneys' fees and any other liabilities, demands, proceedings, damages, losses, costs, expenses fines and charges which are made or brought against or incurred by XMOS as a result of your use or distribution of the Licensee Modifications or your use or distribution of XMOS Software, or any development of it, other than in accordance with the terms of this License.
-
-11. Ownership
-
-The copyrights and all other intellectual and industrial property rights for the protection of information with respect to the XMOS Software (including the methods and techniques on which they are based) are retained by XMOS and/or its licensors. Nothing in this Agreement serves to transfer such rights. Customer may not sell, mortgage, underlet, sublease, sublicense, lend or transfer possession of the XMOS Software in any way whatsoever to any third party who is not bound by this Agreement.
-
-12. Termination
-
-Either party may terminate this License at any time on written notice to the other if the other:
-
-- is in material or persistent breach of any of the terms of this License and either that breach is incapable of remedy, or the other party fails to remedy that breach within 30 days after receiving written notice requiring it to remedy that breach; or
-
-- is unable to pay its debts (within the meaning of section 123 of the Insolvency Act 1986), or becomes insolvent, or is subject to an order or a resolution for its liquidation, administration, winding-up or dissolution (otherwise than for the purposes of a solvent amalgamation or reconstruction), or has an administrative or other receiver, manager, trustee, liquidator, administrator or similar officer appointed over all or any substantial part of its assets, or enters into or proposes any composition or arrangement with its creditors generally, or is subject to any analogous event or proceeding in any applicable jurisdiction.
-
-Termination by either party in accordance with the rights contained in clause 12 shall be without prejudice to any other rights or remedies of that party accrued prior to termination.
-
-On termination for any reason:
-
-- all rights granted to the Customer under this License shall cease;
-- the Customer shall cease all activities authorised by this License;
-- the Customer shall immediately pay any sums due to XMOS under this License; and
-- the Customer shall immediately destroy or return to the XMOS (at the XMOS's option) all copies of the XMOS Software then in its possession, custody or control and, in the case of destruction, certify to XMOS that it has done so.
-
-Clauses 5, 8, 9, 10 and 11 shall survive any effective termination of this Agreement.
-
-13. Third party rights
-
-No term of this License is intended to confer a benefit on, or to be enforceable by, any person who is not a party to this license.
-
-14. Confidentiality and publicity
-
-Each party shall, during the term of this License and thereafter, keep confidential all, and shall not use for its own purposes nor without the prior written consent of the other disclose to any third party any, information of a confidential nature (including, without limitation, trade secrets and information of commercial value) which may become known to such party from the other party and which relates to the other party, unless such information is public knowledge or already known to such party at the time of disclosure, or subsequently becomes public knowledge other than by breach of this license, or subsequently comes lawfully into the possession of such party from a third party.
-
-The terms of this license are confidential and may not be disclosed by the Customer without the prior written consent of XMOS.
-The provisions of clause 14 shall remain in full force and effect notwithstanding termination of this license for any reason.
-
-15. Entire agreement
-
-This License and the documents annexed as appendices to this License or otherwise referred to herein contain the whole agreement between the parties relating to the subject matter hereof and supersede all prior agreements, arrangements and understandings between the parties relating to that subject matter.
-
-16. Assignment
-
-The Customer shall not assign this License or any of the rights granted under it without XMOS's prior written consent.
-
-17. Governing law and jurisdiction
-
-This License shall be governed by and construed in accordance with English law and each party hereby submits to the non-exclusive jurisdiction of the English courts.
-
-This License has been entered into on the date stated at the beginning of it.
-
-Schedule
-XMOS application note AN00246 software

examples/AN00246_xua_example/Makefile

@@ -3,10 +3,9 @@ APP_NAME = app_xua_simple
 TARGET = xk-audio-216-mc.xn
 
 # The flags passed to xcc when building the application
-XCC_FLAGS	= -fcomment-asm -Xmapper --map -Xmapper MAPFILE -O3 -report -fsubword-select -save-temps \
-			  -g -Wno-unused-function -Wno-timing -DXUD_SERIES_SUPPORT=XUD_X200_SERIES -DUSB_TILE=tile[1] -fxscope
-			  
-#-DSDA_HIGH=2 -DSCL_HIGH=1 -fxscope
+XCC_FLAGS	= -fcomment-asm -Xmapper --map -Xmapper MAPFILE -O3 -report -save-temps \
+			  -g -Wno-unused-function -Wno-timing -DXUD_SERIES_SUPPORT=XUD_X200_SERIES \
+			  -DXUD_CORE_CLOCK=600 -DUSB_TILE=tile[1] -fxscope -DUAC_FORCE_FEEDBACK_EP=0
 			  
 # The USED_MODULES variable lists other module used by the application. These
 # modules will extend the SOURCE_DIRS, INCLUDE_DIRS and LIB_DIRS variables.

examples/AN00246_xua_example/README.rst

@@ -2,15 +2,13 @@
 Simple USB Audio Device using lib_xua
 =====================================
 
-.. version:: 0.1.0
-
 Summary
 -------
 
-Required tools and libraries
-............................
+Software dependencies
+.....................
 
-.. appdeps::
+For a list of direct dependencies, look for USED_MODULES in the Makefile.
 
 Required hardware
 .................

examples/AN00246_xua_example/doc/rst/xdoc.conf

@@ -1,2 +1,3 @@
-XMOSNEWSTYLE=1
+XMOSNEWSTYLE=2
 SOURCE_INCLUDE_DIRS=../../src
+SPHINX_MASTER_DOC=AN00246_xua_example

examples/AN00246_xua_example/src/app_xua_simple.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 /* A very simple *example* of a USB audio application (and as such is un-verified for production)
  *
@@ -59,7 +60,6 @@ int main()
         /* Low level USB device layer core */
         on tile[1]: XUD_Main(c_ep_out, 2, c_ep_in, 2,
                       c_sof, epTypeTableOut, epTypeTableIn,
-                      null, null, -1 , 
                       XUD_SPEED_HS, XUD_PWR_SELF);
 
         /* Endpoint 0 core from lib_xua */

examples/AN00246_xua_example/src/cs4384.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef CS4384_H_
 #define CS4384_H_
 

examples/AN00246_xua_example/src/cs5368.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef _CS5368_H_
 #define _CS5368_H_
 

examples/AN00246_xua_example/src/hid_report_descriptor.h

@@ -0,0 +1,168 @@
+// Copyright 2021-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+#ifndef __hid_report_descriptor_h__
+#define __hid_report_descriptor_h__
+
+#include "xua_hid_report.h"
+
+#if 0
+/* Existing static report descriptor kept for reference */
+unsigned char hidReportDescriptor[] =
+{
+    0x05, 0x0c,     /* Usage Page (Consumer Device) */
+    0x09, 0x01,     /* Usage (Consumer Control) */
+    0xa1, 0x01,     /* Collection (Application) */
+    0x15, 0x00,     /* Logical Minimum (0) */
+    0x25, 0x01,     /* Logical Maximum (1) */
+    0x09, 0xb0,     /* Usage (Play) */
+    0x09, 0xb5,     /* Usage (Scan Next Track) */
+    0x09, 0xb6,     /* Usage (Scan Previous Track) */
+    0x09, 0xe9,     /* Usage (Volume Up) */
+    0x09, 0xea,     /* Usage (Volume Down) */
+    0x09, 0xe2,     /* Usage (Mute) */
+    0x75, 0x01,     /* Report Size (1) */
+    0x95, 0x06,     /* Report Count (6) */
+    0x81, 0x02,     /* Input (Data, Var, Abs) */
+    0x95, 0x02,     /* Report Count (2) */
+    0x81, 0x01,     /* Input (Cnst, Ary, Abs) */
+    0xc0            /* End collection */
+};
+#endif
+
+/*
+ * Define non-configurable items in the HID Report descriptor.
+ */
+static const USB_HID_Short_Item_t hidCollectionApplication  = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_COLLECTION),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidCollectionEnd          = {
+    .header = HID_REPORT_SET_HEADER(0, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_END_COLLECTION),
+    .data = { 0x00, 0x00 } };
+
+static const USB_HID_Short_Item_t hidInputConstArray        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_INPUT),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidInputDataVar           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_INPUT),
+    .data = { 0x02, 0x00 } };
+
+static const USB_HID_Short_Item_t hidLogicalMaximum0        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MAXIMUM),
+    .data = { 0x00, 0x00 } };
+static const USB_HID_Short_Item_t hidLogicalMaximum1        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MAXIMUM),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidLogicalMinimum0        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MINIMUM),
+    .data = { 0x00, 0x00 } };
+
+static const USB_HID_Short_Item_t hidReportCount2           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_COUNT),
+    .data = { 0x02, 0x00 } };
+static const USB_HID_Short_Item_t hidReportCount6           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_COUNT),
+    .data = { 0x06, 0x00 } };
+static const USB_HID_Short_Item_t hidReportSize1            = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_SIZE),
+    .data = { 0x01, 0x00 } };
+
+static const USB_HID_Short_Item_t hidUsageConsumerControl   = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .data = { 0x01, 0x00 } };
+
+/*
+ * Define the HID Report Descriptor Item, Usage Page, Report ID and length for each HID Report
+ * For internal purposes, a report element with ID of 0 must be included if report IDs are not being used.
+ */
+static const USB_HID_Report_Element_t hidReportPageConsumer = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_USAGE_PAGE),
+    .item.data = { USB_HID_USAGE_PAGE_ID_CONSUMER, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 2, 0, 0 )
+};
+
+/*
+ * Define configurable items in the HID Report descriptor.
+ */
+static USB_HID_Report_Element_t hidUsageByte0Bit5   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xE2, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 5)
+}; // Mute
+static USB_HID_Report_Element_t hidUsageByte0Bit4   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xEA, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 4)
+}; // Vol-
+static USB_HID_Report_Element_t hidUsageByte0Bit3   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xE9, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 3)
+}; // Vol+
+static USB_HID_Report_Element_t hidUsageByte0Bit2   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xB6, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 2)
+}; // Scan Prev
+static USB_HID_Report_Element_t hidUsageByte0Bit1   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xB5, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 1)
+}; // Scan Next
+static USB_HID_Report_Element_t hidUsageByte0Bit0   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xB0, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 0)
+}; // Play
+
+/*
+ * List the configurable elements in the HID Report descriptor.
+ */
+static USB_HID_Report_Element_t* const hidConfigurableElements[] = {
+    &hidUsageByte0Bit0,
+    &hidUsageByte0Bit1,
+    &hidUsageByte0Bit2,
+    &hidUsageByte0Bit3,
+    &hidUsageByte0Bit4,
+    &hidUsageByte0Bit5
+};
+
+/*
+ * List HID Reports, one per Report ID. This should be a usage page item with the relevant
+ * If not using report IDs - still have one with report ID 0
+ */
+static const USB_HID_Report_Element_t* const hidReports[] = {
+    &hidReportPageConsumer
+};
+
+/*
+ * List all items in the HID Report descriptor.
+ */
+static const USB_HID_Short_Item_t* const hidReportDescriptorItems[] = {
+    &(hidReportPageConsumer.item),
+    &hidUsageConsumerControl,
+    &hidCollectionApplication,
+        &hidLogicalMinimum0,
+        &hidLogicalMaximum1,
+        &(hidUsageByte0Bit0.item),
+        &(hidUsageByte0Bit1.item),
+        &(hidUsageByte0Bit2.item),
+        &(hidUsageByte0Bit3.item),
+        &(hidUsageByte0Bit4.item),
+        &(hidUsageByte0Bit5.item),
+        &hidReportSize1,
+        &hidReportCount6,
+        &hidInputDataVar,
+        &hidLogicalMaximum0,
+        &hidReportCount2,
+        &hidInputConstArray,
+    &hidCollectionEnd
+};
+
+/*
+ * Define the number of HID Reports
+ * Due to XC not supporting designated initializers, this constant has a hard-coded value.
+ * It must equal ( sizeof hidReports / sizeof ( USB_HID_Report_Element_t* ))
+ */
+#define HID_REPORT_COUNT ( 1 )
+
+#endif // __hid_report_descriptor_h__

examples/AN00246_xua_example/src/hwsupport.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2016-2018, XMOS Ltd, All rights reserved
+// Copyright 2016-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <platform.h>
 #include <timer.h>

examples/AN00246_xua_example/src/xk-audio-216-mc.xn

@@ -75,7 +75,7 @@
     </Link>
   </Links>
   <ExternalDevices>
-    <Device NodeId="0" Tile="0" Class="SQIFlash" Name="bootFlash" Type="S25FL116K">
+    <Device NodeId="0" Tile="0" Class="SQIFlash" Name="bootFlash" Type="S25FL116K" PageSize="256" SectorSize="4096" NumPages="8192">
       <Attribute Name="PORT_SQI_CS" Value="PORT_SQI_CS"/>
       <Attribute Name="PORT_SQI_SCLK"   Value="PORT_SQI_SCLK"/>
       <Attribute Name="PORT_SQI_SIO"  Value="PORT_SQI_SIO"/>

examples/AN00246_xua_example/src/xua_conf.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2019, XMOS Ltd, All rights reserved
+// Copyright 2017-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #ifndef _XUA_CONF_H_
 #define _XUA_CONF_H_

examples/AN00246_xua_example/src/xud_conf.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include "xua_conf.h"
 

examples/AN00247_xua_example_spdif_tx/LICENSE.rst

@@ -0,0 +1,84 @@
+*******************************
+XMOS PUBLIC LICENCE: Version 1
+*******************************
+
+Subject to the conditions and limitations below, permission is hereby granted by XMOS LIMITED (“XMOS”), free of charge, to any person or entity obtaining a copy of the XMOS Software.
+
+**1. Definitions**
+
+**“Applicable Patent Rights”** means: (a) where XMOS is the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to XMOS and (ii) that cover subject matter contained in the Software, but only to the extent it is necessary to use, reproduce or distribute the Software without infringement; and (b) where you are the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to you and (ii) that cover the subject matter contained in your Derivatives, taken alone or in combination with the Software.
+
+**“Compiled Code”** means any compiled, binary, machine readable or executable version of the Source Code.
+
+**“Contributor”** means any person or entity that creates or contributes to the creation of Derivatives.
+
+**“Derivatives”** means any addition to, deletion from and/or change to the substance, structure of the Software, any previous Derivatives, the combination of the Derivatives and the Software and/or any respective portions thereof.
+
+**“Source Code”** means the human readable code that is suitable for making modifications but excluding any Compiled Code.
+
+**“Software”** means the software and associated documentation files which XMOS makes available and which contain a notice identifying the software as original XMOS software and referring to the software being subject to the terms of this XMOS Public Licence.
+
+This Licence refers to XMOS Software and does not relate to any XMOS hardware or devices which are protected by intellectual property rights (including patent and trade marks) which may be sold to you under a separate agreement.
+
+
+**2. Licence**
+
+**Permitted Uses, Conditions and Restrictions.**  Subject to the conditions below, XMOS grants you a worldwide, royalty free, non-exclusive licence, to the extent of any Patent Rights to do the following:
+
+2.1 **Unmodified Software.** You may use, copy, display, publish, distribute and make available unmodified copies of the Software:
+
+2.1.1 for personal or academic, non-commercial purposes; or
+
+2.1.2 for commercial purposes provided the Software is at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.1.1 and 2.1.2):
+
+(a) you must retain and reproduce in all copies of the Software the copyright and proprietary notices and disclaimers of XMOS as they appear in the Software, and keep intact all notices and disclaimers in the Software files that refer to this Licence; and
+
+(b) you must include a copy of this Licence with every copy of the Software and documentation you publish, distribute and make available and you may not offer or impose any terms on such Software that alter or restrict this Licence or the intent of such Licence, except as permitted below (Additional Terms).
+
+The licence above does not include any Compiled Code which XMOS may make available under a separate support and licence agreement.
+
+2.2 **Derivatives.** You may create and modify Derivatives and use, copy, display, publish, distribute and make available Derivatives:
+
+2.2.1 for personal or academic, non-commercial purposes; or
+
+2.2.2 for commercial purposes, provided the Derivatives are at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.2.1 and 2.2.2):
+
+(a) you must comply with the terms of clause 2.1 with respect to the Derivatives;
+
+(b) you must copy (to the extent it doesn’t already exist) the notice below in each file of the Derivatives, and ensure all the modified files carry prominent notices stating that you have changed the files and the date of any change; and
+
+(c) if you sublicence, distribute or otherwise make the Software and/or the Derivatives available for commercial purposes, you must provide that the Software and Derivatives are at all times used on a device designed, licensed or developed by XMOS.
+
+Without limitation to these terms and clause 3 below, the Source Code and Compiled Code to your Derivatives may at your discretion (but without obligation) be released, copied, displayed, published, distributed and made available; and if you elect to do so, it must be under the terms of this Licence including the terms of the licence at clauses 2.2.1, 2.2.2 and clause 3 below.
+
+2.3 **Distribution of Executable Versions.**  If you distribute or make available Derivatives, you must include a prominent notice in the code itself as well as in all related documentation, stating that the Source Code of the Software from which the Derivatives are based is available under the terms of this Licence, with information on how and where to obtain such Source Code.
+
+**3. Your Grant of Rights.**  In consideration and as a condition to this Licence, you grant to any person or entity receiving or distributing any Derivatives, a non-exclusive, royalty free, perpetual, irrevocable license under your Applicable Patent Rights and all other intellectual property rights owned or controlled by you, to use, copy, display, publish, distribute and make available your Derivatives of the same scope and extent as XMOS’s licence under clause 2.2 above.
+
+**4. Combined Products.**  You may create a combined product by combining Software, Derivatives and other code not covered by this Licence as a single application or product. In such instance, you must comply with the requirements of this Licence for any portion of the Software and/or Derivatives.
+
+**5. Additional Terms.**  You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations and/or other rights consistent with the term of this Licence (“Additional Terms”) to any legitimate recipients of the Software and/or Derivatives.  The terms on which you provide such Additional Terms are on your sole responsibility and you shall indemnify, defend and hold XMOS harmless against any claims asserted against XMOS.
+
+**6. New Versions.**  XMOS may publish revised and/or new versions of this Licence from time to time to accommodate changes to the Licence terms, new versions, updates and bug fixes of the Software.  Each version will be given a distinguishing version number.  Once Software has been published under a particular version of this Licence, you may continue to use it under the terms of that version.  You may also choose to use the latest version of the Software under any subsequent version published by XMOS.  Only XMOS shall have the right to modify these terms.
+
+**7. IPR and Ownership**
+Any rights, including all intellectual property rights and all trademarks not expressly granted herein are reserved in full by the authors or copyright holders. Any requests for additional permissions by XMOS including any rights to use XMOS trademarks, should be made (without obligation) to XMOS at **support@xmos.com**
+
+Nothing herein shall limit any rights that XMOS is otherwise entitled to under the doctrines of patent exhaustion, implied license, or legal estoppel.  Neither the name of the authors, the copyright holders or any contributors may be used to endorse or promote any Derivatives from this Software without specific written permission.  Any attempt to deal with the Software which does not comply with this Licence shall be void and shall automatically terminate any rights granted under this licence (including any licence of any intellectual property rights granted herein).
+Subject to the licences granted under this Licence any Contributor retains all rights, title and interest in and to any Derivatives made by Contributor subject to the underlying rights of XMOS in the Software.  XMOS shall retain all rights, title and interest in the Software and any Derivatives made by XMOS (“XMOS Derivatives”).  XMOS Derivatives will not automatically be subject to this Licence and XMOS shall be entitled to licence such rights on any terms (without obligation) as it sees fit.
+
+**8. Termination**
+
+8.1 This Licence will automatically terminate immediately, without notice to you, if:
+
+(a) you fail to comply with the terms of this Licence; and/or
+
+(b) you directly or indirectly commence any action for patent or intellectual property right infringement against XMOS, or any parent, group, affiliate or subsidiary of XMOS; provided XMOS did not first commence an action or patent infringement against you in that instance; and/or
+
+(c) the terms of this Licence are held by any court of competent jurisdiction to be unenforceable in whole or in part.
+
+**9. Critical Applications.**  Unless XMOS has agreed in writing with you an agreement specifically governing use of the Goods in military, aerospace, automotive or medically related functions (collectively and individually hereinafter referred to as "Special Use"), any permitted use of the Software excludes Special Use. Notwithstanding any agreement between XMOS and you for Special Use, Special Use shall be at your own risk, and you shall fully indemnify XMOS against any damages, losses, costs and claims (direct and indirect) arising out of any Special Use.
+
+**10. NO WARRANTY OR SUPPORT.**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL XMOS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, WARRANTY, CIVIL TORT (INCLUDING NEGLIGENCE), PRODUCTS LIABILITY OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE INCLUDING GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES EVEN IF SUCH PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES AND NOT WITHSTANDING THE FAILURE OF ESSENTIAL PURPOSE.  IN SOME JURISDICTIONS PARTIES ARE UNABLE TO LIMIT LIABILTY IN THIS WAY, IF THIS APPLIES TO YOUR JURISDICTION THIS LIABILITY CLAUSE ABOVE MAY NOT APPLY.  NOTWITHSTANDING THE ABOVE, IN NO EVENT SHALL XMOS’s TOTAL LIABILITY TO YOU FOR ALL DAMAGES, LOSS OR OTHERWISE EXCEED $50.
+
+**11. Governing Law and Jurisdiction.**  This Licence constitutes the entire agreement between the parties with respect to the subject matter hereof. The Licence shall be governed by the laws of England and the conflict of laws and UN Convention on Contracts for the International Sale of Goods, shall not apply.

examples/AN00247_xua_example_spdif_tx/LICENSE.txt

@@ -1,135 +0,0 @@
-Software Release License Agreement
-
-Copyright (c) 2018-2019, XMOS, All rights reserved.
-
-BY ACCESSING, USING, INSTALLING OR DOWNLOADING THE XMOS SOFTWARE, YOU AGREE TO BE BOUND BY THE FOLLOWING TERMS. IF YOU DO NOT AGREE TO THESE, DO NOT ATTEMPT TO DOWNLOAD, ACCESS OR USE THE XMOS Software.
-
-Parties:
-
-(1) XMOS Limited, incorporated and registered in England and Wales with company number 5494985 whose registered office is 107 Cheapside, London, EC2V 6DN (XMOS).
-
-(2)  An individual or legal entity exercising permissions granted by this License (Customer).
-
-If you are entering into this Agreement on behalf of another legal entity such as a company, partnership, university, college etc. (for example, as an employee, student or consultant), you warrant that you have authority to bind that entity.
-
-1. Definitions
-
-"License" means this Software License and any schedules or annexes to it.
-
-"License Fee" means the fee for the XMOS Software as detailed in any schedules or annexes to this Software License
-
-"Licensee Modifications" means all developments and modifications of the XMOS Software developed independently by the Customer.
-
-"XMOS Modifications" means all developments and modifications of the XMOS Software developed or co-developed by XMOS.
-
-"XMOS Hardware" means any XMOS hardware devices supplied by XMOS from time to time and/or the particular XMOS devices detailed in any schedules or annexes to this Software License.
-
-"XMOS Software" comprises the XMOS owned circuit designs, schematics, source code, object code, reference designs, (including related programmer comments and documentation, if any), error corrections, improvements, modifications (including XMOS Modifications) and updates.
-
-The headings in this License do not affect its interpretation. Save where the context otherwise requires, references to clauses and schedules are to clauses and schedules of this License.
-
-Unless the context otherwise requires:
-
-- references to XMOS and the Customer include their permitted successors and assigns; 
-- references to statutory provisions include those statutory provisions as amended or re-enacted; and
-- references to any gender include all genders.
-
-Words in the singular include the plural and in the plural include the singular.
-
-2. License
-
-XMOS grants the Customer a non-exclusive license to use, develop, modify and distribute the XMOS Software with, or for the purpose of being used with, XMOS Hardware.
-
-Open Source Software (OSS) must be used and dealt with in accordance with any license terms under which OSS is distributed.
-
-3. Consideration
-
-In consideration of the mutual obligations contained in this License, the parties agree to its terms.
-
-4. Term
-
-Subject to clause 12 below, this License shall be perpetual.
-
-5. Restrictions on Use
-
-The Customer will adhere to all applicable import and export laws and regulations of the country in which it resides and of the United States and United Kingdom, without limitation. The Customer agrees that it is its responsibility to obtain copies of and to familiarise itself fully with these laws and regulations to avoid violation.
-
-6. Modifications
-
-The Customer will own all intellectual property rights in the Licensee Modifications but will undertake to provide XMOS with any fixes made to correct any bugs found in the XMOS Software on a non-exclusive, perpetual and royalty free license basis.
-
-XMOS will own all intellectual property rights in the XMOS Modifications. 
-The Customer may only use the Licensee Modifications and XMOS Modifications on, or in relation to, XMOS Hardware.
-
-7. Support
-
-Support of the XMOS Software may be provided by XMOS pursuant to a separate support agreement. 
-
-8. Warranty and Disclaimer
-
-The XMOS Software is provided "AS IS" without a warranty of any kind. XMOS and its licensors' entire liability and Customer's exclusive remedy under this warranty to be determined in XMOS's sole and absolute discretion, will be either (a) the corrections of defects in media or replacement of the media, or (b) the refund of the license fee paid (if any).
-
-Whilst XMOS gives the Customer the ability to load their own software and applications onto XMOS devices, the security of such software and applications when on the XMOS devices is the Customer's own responsibility and any breach of security shall not be deemed a defect or failure of the hardware. XMOS shall have no liability whatsoever in relation to any costs, damages or other losses Customer may incur as a result of any breaches of security in relation to your software or applications.
-
-XMOS AND ITS LICENSORS DISCLAIM ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY/ SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT EXCEPT TO THE EXTENT THAT THESE DISCLAIMERS ARE HELD TO BE LEGALLY INVALID UNDER APPLICABLE LAW.
-
-9. High Risk Activities
-
-The XMOS Software is not designed or intended for use in conjunction with on-line control equipment in hazardous environments requiring fail-safe performance, including without limitation the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, life support machines, or weapons systems (collectively "High Risk Activities") in which the failure of the XMOS Software could lead directly to death, personal injury, or severe physical or environmental damage. XMOS and its licensors specifically disclaim any express or implied warranties relating to use of the XMOS Software in connection with High Risk Activities.
-
-10. Liability
-
-TO THE EXTENT NOT PROHIBITED BY APPLICABLE LAW, NEITHER XMOS NOR ITS LICENSORS SHALL BE LIABLE FOR ANY LOST REVENUE, BUSINESS, PROFIT, CONTRACTS OR DATA, ADMINISTRATIVE OR OVERHEAD EXPENSES, OR FOR SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES HOWEVER CAUSED AND REGARDLESS OF THEORY OF LIABILITY ARISING OUT OF THIS LICENSE, EVEN IF XMOS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. In no event shall XMOS's liability to the Customer whether in contract, tort (including negligence), or otherwise exceed the License Fee.
-
-Customer agrees to indemnify, hold harmless, and defend XMOS and its licensors from and against any claims or lawsuits, including attorneys' fees and any other liabilities, demands, proceedings, damages, losses, costs, expenses fines and charges which are made or brought against or incurred by XMOS as a result of your use or distribution of the Licensee Modifications or your use or distribution of XMOS Software, or any development of it, other than in accordance with the terms of this License.
-
-11. Ownership
-
-The copyrights and all other intellectual and industrial property rights for the protection of information with respect to the XMOS Software (including the methods and techniques on which they are based) are retained by XMOS and/or its licensors. Nothing in this Agreement serves to transfer such rights. Customer may not sell, mortgage, underlet, sublease, sublicense, lend or transfer possession of the XMOS Software in any way whatsoever to any third party who is not bound by this Agreement.
-
-12. Termination
-
-Either party may terminate this License at any time on written notice to the other if the other:
-
-- is in material or persistent breach of any of the terms of this License and either that breach is incapable of remedy, or the other party fails to remedy that breach within 30 days after receiving written notice requiring it to remedy that breach; or
-
-- is unable to pay its debts (within the meaning of section 123 of the Insolvency Act 1986), or becomes insolvent, or is subject to an order or a resolution for its liquidation, administration, winding-up or dissolution (otherwise than for the purposes of a solvent amalgamation or reconstruction), or has an administrative or other receiver, manager, trustee, liquidator, administrator or similar officer appointed over all or any substantial part of its assets, or enters into or proposes any composition or arrangement with its creditors generally, or is subject to any analogous event or proceeding in any applicable jurisdiction.
-
-Termination by either party in accordance with the rights contained in clause 12 shall be without prejudice to any other rights or remedies of that party accrued prior to termination.
-
-On termination for any reason:
-
-- all rights granted to the Customer under this License shall cease;
-- the Customer shall cease all activities authorised by this License;
-- the Customer shall immediately pay any sums due to XMOS under this License; and
-- the Customer shall immediately destroy or return to the XMOS (at the XMOS's option) all copies of the XMOS Software then in its possession, custody or control and, in the case of destruction, certify to XMOS that it has done so.
-
-Clauses 5, 8, 9, 10 and 11 shall survive any effective termination of this Agreement.
-
-13. Third party rights
-
-No term of this License is intended to confer a benefit on, or to be enforceable by, any person who is not a party to this license.
-
-14. Confidentiality and publicity
-
-Each party shall, during the term of this License and thereafter, keep confidential all, and shall not use for its own purposes nor without the prior written consent of the other disclose to any third party any, information of a confidential nature (including, without limitation, trade secrets and information of commercial value) which may become known to such party from the other party and which relates to the other party, unless such information is public knowledge or already known to such party at the time of disclosure, or subsequently becomes public knowledge other than by breach of this license, or subsequently comes lawfully into the possession of such party from a third party.
-
-The terms of this license are confidential and may not be disclosed by the Customer without the prior written consent of XMOS.
-The provisions of clause 14 shall remain in full force and effect notwithstanding termination of this license for any reason.
-
-15. Entire agreement
-
-This License and the documents annexed as appendices to this License or otherwise referred to herein contain the whole agreement between the parties relating to the subject matter hereof and supersede all prior agreements, arrangements and understandings between the parties relating to that subject matter.
-
-16. Assignment
-
-The Customer shall not assign this License or any of the rights granted under it without XMOS's prior written consent.
-
-17. Governing law and jurisdiction
-
-This License shall be governed by and construed in accordance with English law and each party hereby submits to the non-exclusive jurisdiction of the English courts.
-
-This License has been entered into on the date stated at the beginning of it.
-
-Schedule
-XMOS application note AN00247 software

examples/AN00247_xua_example_spdif_tx/Makefile

@@ -3,9 +3,10 @@ APP_NAME = app_xua_simple
 TARGET = xk-audio-216-mc.xn
 
 # The flags passed to xcc when building the application
-XCC_FLAGS	= -fcomment-asm -Xmapper --map -Xmapper MAPFILE -O3 -report -fsubword-select -save-temps \
-			  -g -Wno-unused-function -Wno-timing -DXUD_SERIES_SUPPORT=XUD_X200_SERIES -DUSB_TILE=tile[1] \
-			  -DSDA_HIGH=2 -DSCL_HIGH=1 -fxscope
+XCC_FLAGS	= -fcomment-asm -Xmapper --map -Xmapper MAPFILE -O3 -report -save-temps \
+			  -g -Wno-unused-function -Wno-timing -DXUD_SERIES_SUPPORT=XUD_X200_SERIES \
+			  -DXUD_CORE_CLOCK=600 -DUSB_TILE=tile[1] -DSDA_HIGH=2 -DSCL_HIGH=1 -fxscope \
+			  -DUAC_FORCE_FEEDBACK_EP=0
 
 # The USED_MODULES variable lists other module used by the application. These
 # modules will extend the SOURCE_DIRS, INCLUDE_DIRS and LIB_DIRS variables.

examples/AN00247_xua_example_spdif_tx/README.rst

@@ -2,15 +2,13 @@
 Using lib_xua with lib_spdif (transmit) 
 =======================================
 
-.. version:: 0.1.0
-
 Summary
 -------
 
-Required tools and libraries
-............................
+Software dependencies
+.....................
 
-.. appdeps::
+For a list of direct dependencies, look for USED_MODULES in the Makefile.
 
 Required hardware
 .................

examples/AN00247_xua_example_spdif_tx/doc/rst/xdoc.conf

@@ -1,2 +1,3 @@
-XMOSNEWSTYLE=1
+XMOSNEWSTYLE=2
 SOURCE_INCLUDE_DIRS=../../src
+SPHINX_MASTER_DOC=AN00247_xua_example_spdif_tx

examples/AN00247_xua_example_spdif_tx/src/app_xua_simple.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 /* A very simple *example* of a USB audio application (and as such is un-verified for production)
  *
@@ -60,7 +61,7 @@ int main()
     par
     {
         /* Low level USB device layer core */
-        on tile[1]: XUD_Main(c_ep_out, 2, c_ep_in, 2, c_sof, epTypeTableOut, epTypeTableIn, null, null, -1, XUD_SPEED_HS, XUD_PWR_SELF);
+        on tile[1]: XUD_Main(c_ep_out, 2, c_ep_in, 2, c_sof, epTypeTableOut, epTypeTableIn, XUD_SPEED_HS, XUD_PWR_SELF);
 
         /* Endpoint 0 core from lib_xua */
         /* Note, since we are not using many features we pass in null for quite a few params.. */

examples/AN00247_xua_example_spdif_tx/src/hid_report_descriptor.h

@@ -0,0 +1,168 @@
+// Copyright 2021-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+#ifndef __hid_report_descriptor_h__
+#define __hid_report_descriptor_h__
+
+#include "xua_hid_report.h"
+
+#if 0
+/* Existing static report descriptor kept for reference */
+unsigned char hidReportDescriptor[] =
+{
+    0x05, 0x0c,     /* Usage Page (Consumer Device) */
+    0x09, 0x01,     /* Usage (Consumer Control) */
+    0xa1, 0x01,     /* Collection (Application) */
+    0x15, 0x00,     /* Logical Minimum (0) */
+    0x25, 0x01,     /* Logical Maximum (1) */
+    0x09, 0xb0,     /* Usage (Play) */
+    0x09, 0xb5,     /* Usage (Scan Next Track) */
+    0x09, 0xb6,     /* Usage (Scan Previous Track) */
+    0x09, 0xe9,     /* Usage (Volume Up) */
+    0x09, 0xea,     /* Usage (Volume Down) */
+    0x09, 0xe2,     /* Usage (Mute) */
+    0x75, 0x01,     /* Report Size (1) */
+    0x95, 0x06,     /* Report Count (6) */
+    0x81, 0x02,     /* Input (Data, Var, Abs) */
+    0x95, 0x02,     /* Report Count (2) */
+    0x81, 0x01,     /* Input (Cnst, Ary, Abs) */
+    0xc0            /* End collection */
+};
+#endif
+
+/*
+ * Define non-configurable items in the HID Report descriptor.
+ */
+static const USB_HID_Short_Item_t hidCollectionApplication  = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_COLLECTION),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidCollectionEnd          = {
+    .header = HID_REPORT_SET_HEADER(0, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_END_COLLECTION),
+    .data = { 0x00, 0x00 } };
+
+static const USB_HID_Short_Item_t hidInputConstArray        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_INPUT),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidInputDataVar           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_INPUT),
+    .data = { 0x02, 0x00 } };
+
+static const USB_HID_Short_Item_t hidLogicalMaximum0        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MAXIMUM),
+    .data = { 0x00, 0x00 } };
+static const USB_HID_Short_Item_t hidLogicalMaximum1        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MAXIMUM),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidLogicalMinimum0        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MINIMUM),
+    .data = { 0x00, 0x00 } };
+
+static const USB_HID_Short_Item_t hidReportCount2           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_COUNT),
+    .data = { 0x02, 0x00 } };
+static const USB_HID_Short_Item_t hidReportCount6           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_COUNT),
+    .data = { 0x06, 0x00 } };
+static const USB_HID_Short_Item_t hidReportSize1            = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_SIZE),
+    .data = { 0x01, 0x00 } };
+
+static const USB_HID_Short_Item_t hidUsageConsumerControl   = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .data = { 0x01, 0x00 } };
+
+/*
+ * Define the HID Report Descriptor Item, Usage Page, Report ID and length for each HID Report
+ * For internal purposes, a report element with ID of 0 must be included if report IDs are not being used.
+ */
+static const USB_HID_Report_Element_t hidReportPageConsumer = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_USAGE_PAGE),
+    .item.data = { USB_HID_USAGE_PAGE_ID_CONSUMER, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 2, 0, 0 )
+};
+
+/*
+ * Define configurable items in the HID Report descriptor.
+ */
+static USB_HID_Report_Element_t hidUsageByte0Bit5   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xE2, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 5)
+}; // Mute
+static USB_HID_Report_Element_t hidUsageByte0Bit4   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xEA, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 4)
+}; // Vol-
+static USB_HID_Report_Element_t hidUsageByte0Bit3   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xE9, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 3)
+}; // Vol+
+static USB_HID_Report_Element_t hidUsageByte0Bit2   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xB6, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 2)
+}; // Scan Prev
+static USB_HID_Report_Element_t hidUsageByte0Bit1   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xB5, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 1)
+}; // Scan Next
+static USB_HID_Report_Element_t hidUsageByte0Bit0   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xB0, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 0)
+}; // Play
+
+/*
+ * List the configurable elements in the HID Report descriptor.
+ */
+static USB_HID_Report_Element_t* const hidConfigurableElements[] = {
+    &hidUsageByte0Bit0,
+    &hidUsageByte0Bit1,
+    &hidUsageByte0Bit2,
+    &hidUsageByte0Bit3,
+    &hidUsageByte0Bit4,
+    &hidUsageByte0Bit5
+};
+
+/*
+ * List HID Reports, one per Report ID. This should be a usage page item with the relevant
+ * If not using report IDs - still have one with report ID 0
+ */
+static const USB_HID_Report_Element_t* const hidReports[] = {
+    &hidReportPageConsumer
+};
+
+/*
+ * List all items in the HID Report descriptor.
+ */
+static const USB_HID_Short_Item_t* const hidReportDescriptorItems[] = {
+    &(hidReportPageConsumer.item),
+    &hidUsageConsumerControl,
+    &hidCollectionApplication,
+        &hidLogicalMinimum0,
+        &hidLogicalMaximum1,
+        &(hidUsageByte0Bit0.item),
+        &(hidUsageByte0Bit1.item),
+        &(hidUsageByte0Bit2.item),
+        &(hidUsageByte0Bit3.item),
+        &(hidUsageByte0Bit4.item),
+        &(hidUsageByte0Bit5.item),
+        &hidReportSize1,
+        &hidReportCount6,
+        &hidInputDataVar,
+        &hidLogicalMaximum0,
+        &hidReportCount2,
+        &hidInputConstArray,
+    &hidCollectionEnd
+};
+
+/*
+ * Define the number of HID Reports
+ * Due to XC not supporting designated initializers, this constant has a hard-coded value.
+ * It must equal ( sizeof hidReports / sizeof ( USB_HID_Report_Element_t* ))
+ */
+#define HID_REPORT_COUNT ( 1 )
+
+#endif // __hid_report_descriptor_h__

examples/AN00247_xua_example_spdif_tx/src/hwsupport.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2016-2018, XMOS Ltd, All rights reserved
+// Copyright 2016-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <platform.h>
 #include <timer.h>
@@ -21,7 +22,6 @@ out port p_gpio = on tile[0]:XS1_PORT_8C;
 void AudioHwConfig(unsigned samFreq, unsigned mClk, unsigned dsdMode,
     unsigned sampRes_DAC, unsigned sampRes_ADC)
 {
-    unsigned char data[1] = {0};
 	unsigned char gpioVal = 0;
 
     /* Set master clock select appropriately and put ADC and DAC into reset */

examples/AN00247_xua_example_spdif_tx/src/xk-audio-216-mc.xn

@@ -75,7 +75,7 @@
     </Link>
   </Links>
   <ExternalDevices>
-    <Device NodeId="0" Tile="0" Class="SQIFlash" Name="bootFlash" Type="S25FL116K">
+    <Device NodeId="0" Tile="0" Class="SQIFlash" Name="bootFlash" Type="S25FL116K" PageSize="256" SectorSize="4096" NumPages="8192">
       <Attribute Name="PORT_SQI_CS" Value="PORT_SQI_CS"/>
       <Attribute Name="PORT_SQI_SCLK"   Value="PORT_SQI_SCLK"/>
       <Attribute Name="PORT_SQI_SIO"  Value="PORT_SQI_SIO"/>

examples/AN00247_xua_example_spdif_tx/src/xua_conf.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2019, XMOS Ltd, All rights reserved
+// Copyright 2017-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #ifndef _XUA_CONF_H_
 #define _XUA_CONF_H_

examples/AN00247_xua_example_spdif_tx/src/xud_conf.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include "xua_conf.h"
 

examples/AN00248_xua_example_pdm_mics/LICENSE.rst

@@ -0,0 +1,84 @@
+*******************************
+XMOS PUBLIC LICENCE: Version 1
+*******************************
+
+Subject to the conditions and limitations below, permission is hereby granted by XMOS LIMITED (“XMOS”), free of charge, to any person or entity obtaining a copy of the XMOS Software.
+
+**1. Definitions**
+
+**“Applicable Patent Rights”** means: (a) where XMOS is the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to XMOS and (ii) that cover subject matter contained in the Software, but only to the extent it is necessary to use, reproduce or distribute the Software without infringement; and (b) where you are the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to you and (ii) that cover the subject matter contained in your Derivatives, taken alone or in combination with the Software.
+
+**“Compiled Code”** means any compiled, binary, machine readable or executable version of the Source Code.
+
+**“Contributor”** means any person or entity that creates or contributes to the creation of Derivatives.
+
+**“Derivatives”** means any addition to, deletion from and/or change to the substance, structure of the Software, any previous Derivatives, the combination of the Derivatives and the Software and/or any respective portions thereof.
+
+**“Source Code”** means the human readable code that is suitable for making modifications but excluding any Compiled Code.
+
+**“Software”** means the software and associated documentation files which XMOS makes available and which contain a notice identifying the software as original XMOS software and referring to the software being subject to the terms of this XMOS Public Licence.
+
+This Licence refers to XMOS Software and does not relate to any XMOS hardware or devices which are protected by intellectual property rights (including patent and trade marks) which may be sold to you under a separate agreement.
+
+
+**2. Licence**
+
+**Permitted Uses, Conditions and Restrictions.**  Subject to the conditions below, XMOS grants you a worldwide, royalty free, non-exclusive licence, to the extent of any Patent Rights to do the following:
+
+2.1 **Unmodified Software.** You may use, copy, display, publish, distribute and make available unmodified copies of the Software:
+
+2.1.1 for personal or academic, non-commercial purposes; or
+
+2.1.2 for commercial purposes provided the Software is at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.1.1 and 2.1.2):
+
+(a) you must retain and reproduce in all copies of the Software the copyright and proprietary notices and disclaimers of XMOS as they appear in the Software, and keep intact all notices and disclaimers in the Software files that refer to this Licence; and
+
+(b) you must include a copy of this Licence with every copy of the Software and documentation you publish, distribute and make available and you may not offer or impose any terms on such Software that alter or restrict this Licence or the intent of such Licence, except as permitted below (Additional Terms).
+
+The licence above does not include any Compiled Code which XMOS may make available under a separate support and licence agreement.
+
+2.2 **Derivatives.** You may create and modify Derivatives and use, copy, display, publish, distribute and make available Derivatives:
+
+2.2.1 for personal or academic, non-commercial purposes; or
+
+2.2.2 for commercial purposes, provided the Derivatives are at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.2.1 and 2.2.2):
+
+(a) you must comply with the terms of clause 2.1 with respect to the Derivatives;
+
+(b) you must copy (to the extent it doesn’t already exist) the notice below in each file of the Derivatives, and ensure all the modified files carry prominent notices stating that you have changed the files and the date of any change; and
+
+(c) if you sublicence, distribute or otherwise make the Software and/or the Derivatives available for commercial purposes, you must provide that the Software and Derivatives are at all times used on a device designed, licensed or developed by XMOS.
+
+Without limitation to these terms and clause 3 below, the Source Code and Compiled Code to your Derivatives may at your discretion (but without obligation) be released, copied, displayed, published, distributed and made available; and if you elect to do so, it must be under the terms of this Licence including the terms of the licence at clauses 2.2.1, 2.2.2 and clause 3 below.
+
+2.3 **Distribution of Executable Versions.**  If you distribute or make available Derivatives, you must include a prominent notice in the code itself as well as in all related documentation, stating that the Source Code of the Software from which the Derivatives are based is available under the terms of this Licence, with information on how and where to obtain such Source Code.
+
+**3. Your Grant of Rights.**  In consideration and as a condition to this Licence, you grant to any person or entity receiving or distributing any Derivatives, a non-exclusive, royalty free, perpetual, irrevocable license under your Applicable Patent Rights and all other intellectual property rights owned or controlled by you, to use, copy, display, publish, distribute and make available your Derivatives of the same scope and extent as XMOS’s licence under clause 2.2 above.
+
+**4. Combined Products.**  You may create a combined product by combining Software, Derivatives and other code not covered by this Licence as a single application or product. In such instance, you must comply with the requirements of this Licence for any portion of the Software and/or Derivatives.
+
+**5. Additional Terms.**  You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations and/or other rights consistent with the term of this Licence (“Additional Terms”) to any legitimate recipients of the Software and/or Derivatives.  The terms on which you provide such Additional Terms are on your sole responsibility and you shall indemnify, defend and hold XMOS harmless against any claims asserted against XMOS.
+
+**6. New Versions.**  XMOS may publish revised and/or new versions of this Licence from time to time to accommodate changes to the Licence terms, new versions, updates and bug fixes of the Software.  Each version will be given a distinguishing version number.  Once Software has been published under a particular version of this Licence, you may continue to use it under the terms of that version.  You may also choose to use the latest version of the Software under any subsequent version published by XMOS.  Only XMOS shall have the right to modify these terms.
+
+**7. IPR and Ownership**
+Any rights, including all intellectual property rights and all trademarks not expressly granted herein are reserved in full by the authors or copyright holders. Any requests for additional permissions by XMOS including any rights to use XMOS trademarks, should be made (without obligation) to XMOS at **support@xmos.com**
+
+Nothing herein shall limit any rights that XMOS is otherwise entitled to under the doctrines of patent exhaustion, implied license, or legal estoppel.  Neither the name of the authors, the copyright holders or any contributors may be used to endorse or promote any Derivatives from this Software without specific written permission.  Any attempt to deal with the Software which does not comply with this Licence shall be void and shall automatically terminate any rights granted under this licence (including any licence of any intellectual property rights granted herein).
+Subject to the licences granted under this Licence any Contributor retains all rights, title and interest in and to any Derivatives made by Contributor subject to the underlying rights of XMOS in the Software.  XMOS shall retain all rights, title and interest in the Software and any Derivatives made by XMOS (“XMOS Derivatives”).  XMOS Derivatives will not automatically be subject to this Licence and XMOS shall be entitled to licence such rights on any terms (without obligation) as it sees fit.
+
+**8. Termination**
+
+8.1 This Licence will automatically terminate immediately, without notice to you, if:
+
+(a) you fail to comply with the terms of this Licence; and/or
+
+(b) you directly or indirectly commence any action for patent or intellectual property right infringement against XMOS, or any parent, group, affiliate or subsidiary of XMOS; provided XMOS did not first commence an action or patent infringement against you in that instance; and/or
+
+(c) the terms of this Licence are held by any court of competent jurisdiction to be unenforceable in whole or in part.
+
+**9. Critical Applications.**  Unless XMOS has agreed in writing with you an agreement specifically governing use of the Goods in military, aerospace, automotive or medically related functions (collectively and individually hereinafter referred to as "Special Use"), any permitted use of the Software excludes Special Use. Notwithstanding any agreement between XMOS and you for Special Use, Special Use shall be at your own risk, and you shall fully indemnify XMOS against any damages, losses, costs and claims (direct and indirect) arising out of any Special Use.
+
+**10. NO WARRANTY OR SUPPORT.**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL XMOS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, WARRANTY, CIVIL TORT (INCLUDING NEGLIGENCE), PRODUCTS LIABILITY OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE INCLUDING GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES EVEN IF SUCH PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES AND NOT WITHSTANDING THE FAILURE OF ESSENTIAL PURPOSE.  IN SOME JURISDICTIONS PARTIES ARE UNABLE TO LIMIT LIABILTY IN THIS WAY, IF THIS APPLIES TO YOUR JURISDICTION THIS LIABILITY CLAUSE ABOVE MAY NOT APPLY.  NOTWITHSTANDING THE ABOVE, IN NO EVENT SHALL XMOS’s TOTAL LIABILITY TO YOU FOR ALL DAMAGES, LOSS OR OTHERWISE EXCEED $50.
+
+**11. Governing Law and Jurisdiction.**  This Licence constitutes the entire agreement between the parties with respect to the subject matter hereof. The Licence shall be governed by the laws of England and the conflict of laws and UN Convention on Contracts for the International Sale of Goods, shall not apply.

examples/AN00248_xua_example_pdm_mics/LICENSE.txt

@@ -1,135 +0,0 @@
-Software Release License Agreement
-
-Copyright (c) 2018-2019, XMOS, All rights reserved.
-
-BY ACCESSING, USING, INSTALLING OR DOWNLOADING THE XMOS SOFTWARE, YOU AGREE TO BE BOUND BY THE FOLLOWING TERMS. IF YOU DO NOT AGREE TO THESE, DO NOT ATTEMPT TO DOWNLOAD, ACCESS OR USE THE XMOS Software.
-
-Parties:
-
-(1) XMOS Limited, incorporated and registered in England and Wales with company number 5494985 whose registered office is 107 Cheapside, London, EC2V 6DN (XMOS).
-
-(2)  An individual or legal entity exercising permissions granted by this License (Customer).
-
-If you are entering into this Agreement on behalf of another legal entity such as a company, partnership, university, college etc. (for example, as an employee, student or consultant), you warrant that you have authority to bind that entity.
-
-1. Definitions
-
-"License" means this Software License and any schedules or annexes to it.
-
-"License Fee" means the fee for the XMOS Software as detailed in any schedules or annexes to this Software License
-
-"Licensee Modifications" means all developments and modifications of the XMOS Software developed independently by the Customer.
-
-"XMOS Modifications" means all developments and modifications of the XMOS Software developed or co-developed by XMOS.
-
-"XMOS Hardware" means any XMOS hardware devices supplied by XMOS from time to time and/or the particular XMOS devices detailed in any schedules or annexes to this Software License.
-
-"XMOS Software" comprises the XMOS owned circuit designs, schematics, source code, object code, reference designs, (including related programmer comments and documentation, if any), error corrections, improvements, modifications (including XMOS Modifications) and updates.
-
-The headings in this License do not affect its interpretation. Save where the context otherwise requires, references to clauses and schedules are to clauses and schedules of this License.
-
-Unless the context otherwise requires:
-
-- references to XMOS and the Customer include their permitted successors and assigns; 
-- references to statutory provisions include those statutory provisions as amended or re-enacted; and
-- references to any gender include all genders.
-
-Words in the singular include the plural and in the plural include the singular.
-
-2. License
-
-XMOS grants the Customer a non-exclusive license to use, develop, modify and distribute the XMOS Software with, or for the purpose of being used with, XMOS Hardware.
-
-Open Source Software (OSS) must be used and dealt with in accordance with any license terms under which OSS is distributed.
-
-3. Consideration
-
-In consideration of the mutual obligations contained in this License, the parties agree to its terms.
-
-4. Term
-
-Subject to clause 12 below, this License shall be perpetual.
-
-5. Restrictions on Use
-
-The Customer will adhere to all applicable import and export laws and regulations of the country in which it resides and of the United States and United Kingdom, without limitation. The Customer agrees that it is its responsibility to obtain copies of and to familiarise itself fully with these laws and regulations to avoid violation.
-
-6. Modifications
-
-The Customer will own all intellectual property rights in the Licensee Modifications but will undertake to provide XMOS with any fixes made to correct any bugs found in the XMOS Software on a non-exclusive, perpetual and royalty free license basis.
-
-XMOS will own all intellectual property rights in the XMOS Modifications. 
-The Customer may only use the Licensee Modifications and XMOS Modifications on, or in relation to, XMOS Hardware.
-
-7. Support
-
-Support of the XMOS Software may be provided by XMOS pursuant to a separate support agreement. 
-
-8. Warranty and Disclaimer
-
-The XMOS Software is provided "AS IS" without a warranty of any kind. XMOS and its licensors' entire liability and Customer's exclusive remedy under this warranty to be determined in XMOS's sole and absolute discretion, will be either (a) the corrections of defects in media or replacement of the media, or (b) the refund of the license fee paid (if any).
-
-Whilst XMOS gives the Customer the ability to load their own software and applications onto XMOS devices, the security of such software and applications when on the XMOS devices is the Customer's own responsibility and any breach of security shall not be deemed a defect or failure of the hardware. XMOS shall have no liability whatsoever in relation to any costs, damages or other losses Customer may incur as a result of any breaches of security in relation to your software or applications.
-
-XMOS AND ITS LICENSORS DISCLAIM ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY/ SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT EXCEPT TO THE EXTENT THAT THESE DISCLAIMERS ARE HELD TO BE LEGALLY INVALID UNDER APPLICABLE LAW.
-
-9. High Risk Activities
-
-The XMOS Software is not designed or intended for use in conjunction with on-line control equipment in hazardous environments requiring fail-safe performance, including without limitation the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, life support machines, or weapons systems (collectively "High Risk Activities") in which the failure of the XMOS Software could lead directly to death, personal injury, or severe physical or environmental damage. XMOS and its licensors specifically disclaim any express or implied warranties relating to use of the XMOS Software in connection with High Risk Activities.
-
-10. Liability
-
-TO THE EXTENT NOT PROHIBITED BY APPLICABLE LAW, NEITHER XMOS NOR ITS LICENSORS SHALL BE LIABLE FOR ANY LOST REVENUE, BUSINESS, PROFIT, CONTRACTS OR DATA, ADMINISTRATIVE OR OVERHEAD EXPENSES, OR FOR SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES HOWEVER CAUSED AND REGARDLESS OF THEORY OF LIABILITY ARISING OUT OF THIS LICENSE, EVEN IF XMOS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. In no event shall XMOS's liability to the Customer whether in contract, tort (including negligence), or otherwise exceed the License Fee.
-
-Customer agrees to indemnify, hold harmless, and defend XMOS and its licensors from and against any claims or lawsuits, including attorneys' fees and any other liabilities, demands, proceedings, damages, losses, costs, expenses fines and charges which are made or brought against or incurred by XMOS as a result of your use or distribution of the Licensee Modifications or your use or distribution of XMOS Software, or any development of it, other than in accordance with the terms of this License.
-
-11. Ownership
-
-The copyrights and all other intellectual and industrial property rights for the protection of information with respect to the XMOS Software (including the methods and techniques on which they are based) are retained by XMOS and/or its licensors. Nothing in this Agreement serves to transfer such rights. Customer may not sell, mortgage, underlet, sublease, sublicense, lend or transfer possession of the XMOS Software in any way whatsoever to any third party who is not bound by this Agreement.
-
-12. Termination
-
-Either party may terminate this License at any time on written notice to the other if the other:
-
-- is in material or persistent breach of any of the terms of this License and either that breach is incapable of remedy, or the other party fails to remedy that breach within 30 days after receiving written notice requiring it to remedy that breach; or
-
-- is unable to pay its debts (within the meaning of section 123 of the Insolvency Act 1986), or becomes insolvent, or is subject to an order or a resolution for its liquidation, administration, winding-up or dissolution (otherwise than for the purposes of a solvent amalgamation or reconstruction), or has an administrative or other receiver, manager, trustee, liquidator, administrator or similar officer appointed over all or any substantial part of its assets, or enters into or proposes any composition or arrangement with its creditors generally, or is subject to any analogous event or proceeding in any applicable jurisdiction.
-
-Termination by either party in accordance with the rights contained in clause 12 shall be without prejudice to any other rights or remedies of that party accrued prior to termination.
-
-On termination for any reason:
-
-- all rights granted to the Customer under this License shall cease;
-- the Customer shall cease all activities authorised by this License;
-- the Customer shall immediately pay any sums due to XMOS under this License; and
-- the Customer shall immediately destroy or return to the XMOS (at the XMOS's option) all copies of the XMOS Software then in its possession, custody or control and, in the case of destruction, certify to XMOS that it has done so.
-
-Clauses 5, 8, 9, 10 and 11 shall survive any effective termination of this Agreement.
-
-13. Third party rights
-
-No term of this License is intended to confer a benefit on, or to be enforceable by, any person who is not a party to this license.
-
-14. Confidentiality and publicity
-
-Each party shall, during the term of this License and thereafter, keep confidential all, and shall not use for its own purposes nor without the prior written consent of the other disclose to any third party any, information of a confidential nature (including, without limitation, trade secrets and information of commercial value) which may become known to such party from the other party and which relates to the other party, unless such information is public knowledge or already known to such party at the time of disclosure, or subsequently becomes public knowledge other than by breach of this license, or subsequently comes lawfully into the possession of such party from a third party.
-
-The terms of this license are confidential and may not be disclosed by the Customer without the prior written consent of XMOS.
-The provisions of clause 14 shall remain in full force and effect notwithstanding termination of this license for any reason.
-
-15. Entire agreement
-
-This License and the documents annexed as appendices to this License or otherwise referred to herein contain the whole agreement between the parties relating to the subject matter hereof and supersede all prior agreements, arrangements and understandings between the parties relating to that subject matter.
-
-16. Assignment
-
-The Customer shall not assign this License or any of the rights granted under it without XMOS's prior written consent.
-
-17. Governing law and jurisdiction
-
-This License shall be governed by and construed in accordance with English law and each party hereby submits to the non-exclusive jurisdiction of the English courts.
-
-This License has been entered into on the date stated at the beginning of it.
-
-Schedule
-XMOS application note AN00248 software

examples/AN00248_xua_example_pdm_mics/Makefile

@@ -3,9 +3,10 @@ APP_NAME = app_xua_simple
 TARGET = mic_array_ref.xn
 
 # The flags passed to xcc when building the application
-XCC_FLAGS	= -fcomment-asm -Xmapper --map -Xmapper MAPFILE -O3 -report -fsubword-select -save-temps \
-			  -g -Wno-unused-function -Wno-timing -DXUD_SERIES_SUPPORT=XUD_X200_SERIES -DUSB_TILE=tile[1] \
-			  -DSDA_HIGH=2 -DSCL_HIGH=1 -fxscope
+XCC_FLAGS	= -fcomment-asm -Xmapper --map -Xmapper MAPFILE -O3 -report -save-temps \
+			  -g -Wno-unused-function -Wno-timing -DXUD_SERIES_SUPPORT=XUD_X200_SERIES \
+			  -DXUD_CORE_CLOCK=600 -DUSB_TILE=tile[1] -DSDA_HIGH=2 -DSCL_HIGH=1 -fxscope \
+			  -DUAC_FORCE_FEEDBACK_EP=0
 
 # The USED_MODULES variable lists other module used by the application. These
 # modules will extend the SOURCE_DIRS, INCLUDE_DIRS and LIB_DIRS variables.

examples/AN00248_xua_example_pdm_mics/README.rst

@@ -2,18 +2,16 @@
 Using lib_xua with lib_mic_array
 ================================
 
-.. version:: 0.1.0
-
 Summary
 -------
 
 This applicaition note describes how to use ``lib_mic_array`` in conjunction with ``lib_xua``
 to implement a USB Audio device with the ability to record from multiple PDM microphones.
 
-Required tools and libraries
-............................
+Software dependencies
+.....................
 
-.. appdeps::
+For a list of direct dependencies, look for USED_MODULES in the Makefile.
 
 Required hardware
 .................

examples/AN00248_xua_example_pdm_mics/doc/rst/xdoc.conf

@@ -1,2 +1,3 @@
-XMOSNEWSTYLE=1
+XMOSNEWSTYLE=2
 SOURCE_INCLUDE_DIRS=../../src
+SPHINX_MASTER_DOC=AN00248_xua_example_pdm_mics

examples/AN00248_xua_example_pdm_mics/src/app_xua_simple.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 /* A very simple *example* of a USB audio application (and as such is un-verified for production)
  *
@@ -64,7 +65,7 @@ int main()
     par
     {
         /* Low level USB device layer core */
-        on tile[1]: XUD_Main(c_ep_out, 2, c_ep_in, 2, c_sof, epTypeTableOut, epTypeTableIn, null, null, -1, XUD_SPEED_HS, XUD_PWR_BUS);
+        on tile[1]: XUD_Main(c_ep_out, 2, c_ep_in, 2, c_sof, epTypeTableOut, epTypeTableIn, XUD_SPEED_HS, XUD_PWR_BUS);
 
         /* Endpoint 0 core from lib_xua */
         /* Note, since we are not using many features we pass in null for quite a few params.. */

examples/AN00248_xua_example_pdm_mics/src/audiohw.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include <xs1.h>
 #include <assert.h>

examples/AN00248_xua_example_pdm_mics/src/hid_report_descriptor.h

@@ -0,0 +1,168 @@
+// Copyright 2021-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+#ifndef __hid_report_descriptor_h__
+#define __hid_report_descriptor_h__
+
+#include "xua_hid_report.h"
+
+#if 0
+/* Existing static report descriptor kept for reference */
+unsigned char hidReportDescriptor[] =
+{
+    0x05, 0x0c,     /* Usage Page (Consumer Device) */
+    0x09, 0x01,     /* Usage (Consumer Control) */
+    0xa1, 0x01,     /* Collection (Application) */
+    0x15, 0x00,     /* Logical Minimum (0) */
+    0x25, 0x01,     /* Logical Maximum (1) */
+    0x09, 0xb0,     /* Usage (Play) */
+    0x09, 0xb5,     /* Usage (Scan Next Track) */
+    0x09, 0xb6,     /* Usage (Scan Previous Track) */
+    0x09, 0xe9,     /* Usage (Volume Up) */
+    0x09, 0xea,     /* Usage (Volume Down) */
+    0x09, 0xe2,     /* Usage (Mute) */
+    0x75, 0x01,     /* Report Size (1) */
+    0x95, 0x06,     /* Report Count (6) */
+    0x81, 0x02,     /* Input (Data, Var, Abs) */
+    0x95, 0x02,     /* Report Count (2) */
+    0x81, 0x01,     /* Input (Cnst, Ary, Abs) */
+    0xc0            /* End collection */
+};
+#endif
+
+/*
+ * Define non-configurable items in the HID Report descriptor.
+ */
+static const USB_HID_Short_Item_t hidCollectionApplication  = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_COLLECTION),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidCollectionEnd          = {
+    .header = HID_REPORT_SET_HEADER(0, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_END_COLLECTION),
+    .data = { 0x00, 0x00 } };
+
+static const USB_HID_Short_Item_t hidInputConstArray        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_INPUT),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidInputDataVar           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_INPUT),
+    .data = { 0x02, 0x00 } };
+
+static const USB_HID_Short_Item_t hidLogicalMaximum0        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MAXIMUM),
+    .data = { 0x00, 0x00 } };
+static const USB_HID_Short_Item_t hidLogicalMaximum1        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MAXIMUM),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidLogicalMinimum0        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MINIMUM),
+    .data = { 0x00, 0x00 } };
+
+static const USB_HID_Short_Item_t hidReportCount2           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_COUNT),
+    .data = { 0x02, 0x00 } };
+static const USB_HID_Short_Item_t hidReportCount6           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_COUNT),
+    .data = { 0x06, 0x00 } };
+static const USB_HID_Short_Item_t hidReportSize1            = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_SIZE),
+    .data = { 0x01, 0x00 } };
+
+static const USB_HID_Short_Item_t hidUsageConsumerControl   = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .data = { 0x01, 0x00 } };
+
+/*
+ * Define the HID Report Descriptor Item, Usage Page, Report ID and length for each HID Report
+ * For internal purposes, a report element with ID of 0 must be included if report IDs are not being used.
+ */
+static const USB_HID_Report_Element_t hidReportPageConsumer = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_USAGE_PAGE),
+    .item.data = { USB_HID_USAGE_PAGE_ID_CONSUMER, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 2, 0, 0 )
+};
+
+/*
+ * Define configurable items in the HID Report descriptor.
+ */
+static USB_HID_Report_Element_t hidUsageByte0Bit5   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xE2, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 5)
+}; // Mute
+static USB_HID_Report_Element_t hidUsageByte0Bit4   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xEA, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 4)
+}; // Vol-
+static USB_HID_Report_Element_t hidUsageByte0Bit3   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xE9, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 3)
+}; // Vol+
+static USB_HID_Report_Element_t hidUsageByte0Bit2   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xB6, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 2)
+}; // Scan Prev
+static USB_HID_Report_Element_t hidUsageByte0Bit1   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xB5, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 1)
+}; // Scan Next
+static USB_HID_Report_Element_t hidUsageByte0Bit0   = {
+     .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+     .item.data = { 0xB0, 0x00 },
+     .location = HID_REPORT_SET_LOC(0, 0, 0, 0)
+}; // Play
+
+/*
+ * List the configurable elements in the HID Report descriptor.
+ */
+static USB_HID_Report_Element_t* const hidConfigurableElements[] = {
+    &hidUsageByte0Bit0,
+    &hidUsageByte0Bit1,
+    &hidUsageByte0Bit2,
+    &hidUsageByte0Bit3,
+    &hidUsageByte0Bit4,
+    &hidUsageByte0Bit5
+};
+
+/*
+ * List HID Reports, one per Report ID. This should be a usage page item with the relevant
+ * If not using report IDs - still have one with report ID 0
+ */
+static const USB_HID_Report_Element_t* const hidReports[] = {
+    &hidReportPageConsumer
+};
+
+/*
+ * List all items in the HID Report descriptor.
+ */
+static const USB_HID_Short_Item_t* const hidReportDescriptorItems[] = {
+    &(hidReportPageConsumer.item),
+    &hidUsageConsumerControl,
+    &hidCollectionApplication,
+        &hidLogicalMinimum0,
+        &hidLogicalMaximum1,
+        &(hidUsageByte0Bit0.item),
+        &(hidUsageByte0Bit1.item),
+        &(hidUsageByte0Bit2.item),
+        &(hidUsageByte0Bit3.item),
+        &(hidUsageByte0Bit4.item),
+        &(hidUsageByte0Bit5.item),
+        &hidReportSize1,
+        &hidReportCount6,
+        &hidInputDataVar,
+        &hidLogicalMaximum0,
+        &hidReportCount2,
+        &hidInputConstArray,
+    &hidCollectionEnd
+};
+
+/*
+ * Define the number of HID Reports
+ * Due to XC not supporting designated initializers, this constant has a hard-coded value.
+ * It must equal ( sizeof hidReports / sizeof ( USB_HID_Report_Element_t* ))
+ */
+#define HID_REPORT_COUNT ( 1 )
+
+#endif // __hid_report_descriptor_h__

examples/AN00248_xua_example_pdm_mics/src/mic_array_ref.xn

@@ -81,7 +81,7 @@
     </Link>
   </Links>
   <ExternalDevices>
-    <Device NodeId="0" Tile="0" Class="SQIFlash" Name="bootFlash" Type="S25FL116K">
+    <Device NodeId="0" Tile="0" Class="SQIFlash" Name="bootFlash" Type="S25FL116K" PageSize="256" SectorSize="4096" NumPages="8192">
       <Attribute Name="PORT_SQI_CS" Value="PORT_SQI_CS"/>
       <Attribute Name="PORT_SQI_SCLK"   Value="PORT_SQI_SCLK"/>
       <Attribute Name="PORT_SQI_SIO"  Value="PORT_SQI_SIO"/>

examples/AN00248_xua_example_pdm_mics/src/xua_conf.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2019, XMOS Ltd, All rights reserved
+// Copyright 2017-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #ifndef _XUA_CONF_H_
 #define _XUA_CONF_H_

examples/AN00248_xua_example_pdm_mics/src/xud_conf.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #include "xua_conf.h"
 

legacy_tests/app_test_i2s_loopback/Makefile

@@ -1,9 +1,7 @@
-# Copyright (c) 2016, XMOS Ltd, All rights reserved
 TARGET = xk-audio-216-mc.xn
-USED_MODULES = lib_xua \
-               module_i2c_shared module_i2c_single_port lib_logging 
+USED_MODULES = lib_xua lib_i2c lib_logging
 
-BUILD_FLAGS = -O0 -g -lflash -DXUD_SERIES_SUPPORT=4 -fxscope -save-temps -march=xs2a -DUSB_TILE=tile[1]
+BUILD_FLAGS = -O0 -g -lflash -DXUD_SERIES_SUPPORT=4 -DXUD_CORE_CLOCK=600 -fxscope -save-temps -march=xs2a -DUSB_TILE=tile[1]
 
 BUILD_FLAGS_i2s_master_2in_2out_48khz = $(BUILD_FLAGS) \
   -D ADAT_RX=0 -D ADAT_TX=0 -D SPDIF_RX=0 -D SPDIF_TX=0 -D MIDI=0 \

legacy_tests/app_test_i2s_loopback/debug_conf.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2016-2018, XMOS Ltd, All rights reserved
+// Copyright 2016-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef __debug_conf_h__
 #define __debug_conf_h__
 

legacy_tests/app_test_i2s_loopback/hid_report_descriptor.h

@@ -0,0 +1,167 @@
+// Copyright 2021-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+#ifndef __hid_report_descriptor_h__
+#define __hid_report_descriptor_h__
+
+#include "xua_hid_report.h"
+
+#if 0
+/* Existing static report descriptor kept for reference */
+unsigned char hidReportDescriptor[] =
+{
+    0x05, 0x0c,     /* Usage Page (Consumer Device) */
+    0x09, 0x01,     /* Usage (Consumer Control) */
+    0xa1, 0x01,     /* Collection (Application) */
+    0x15, 0x00,     /* Logical Minimum (0) */
+    0x25, 0x01,     /* Logical Maximum (1) */
+    0x09, 0xb0,     /* Usage (Play) */
+    0x09, 0xb5,     /* Usage (Scan Next Track) */
+    0x09, 0xb6,     /* Usage (Scan Previous Track) */
+    0x09, 0xe9,     /* Usage (Volume Up) */
+    0x09, 0xea,     /* Usage (Volume Down) */
+    0x09, 0xe2,     /* Usage (Mute) */
+    0x75, 0x01,     /* Report Size (1) */
+    0x95, 0x06,     /* Report Count (6) */
+    0x81, 0x02,     /* Input (Data, Var, Abs) */
+    0x95, 0x02,     /* Report Count (2) */
+    0x81, 0x01,     /* Input (Cnst, Ary, Abs) */
+    0xc0            /* End collection */
+};
+#endif
+
+/*
+ * Define non-configurable items in the HID Report descriptor.
+ */
+static const USB_HID_Short_Item_t hidCollectionApplication  = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_COLLECTION),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidCollectionEnd          = {
+    .header = HID_REPORT_SET_HEADER(0, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_END_COLLECTION),
+    .data = { 0x00, 0x00 } };
+
+static const USB_HID_Short_Item_t hidInputConstArray        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_INPUT),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidInputDataVar           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_MAIN, HID_REPORT_ITEM_TAG_INPUT),
+    .data = { 0x02, 0x00 } };
+
+static const USB_HID_Short_Item_t hidLogicalMaximum0        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MAXIMUM),
+    .data = { 0x00, 0x00 } };
+static const USB_HID_Short_Item_t hidLogicalMaximum1        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MAXIMUM),
+    .data = { 0x01, 0x00 } };
+static const USB_HID_Short_Item_t hidLogicalMinimum0        = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_LOGICAL_MINIMUM),
+    .data = { 0x00, 0x00 } };
+
+static const USB_HID_Short_Item_t hidReportCount2           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_COUNT),
+    .data = { 0x02, 0x00 } };
+static const USB_HID_Short_Item_t hidReportCount6           = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_COUNT),
+    .data = { 0x06, 0x00 } };
+static const USB_HID_Short_Item_t hidReportSize1            = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_REPORT_SIZE),
+    .data = { 0x01, 0x00 } };
+
+static const USB_HID_Short_Item_t hidUsageConsumerControl   = {
+    .header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .data = { 0x01, 0x00 } };
+
+/*
+ * Define the HID Report Descriptor Item, Usage Page, Report ID and length for each HID Report
+ * For internal purposes, a report element with ID of 0 must be included if report IDs are not being used.
+ */
+static const USB_HID_Report_Element_t hidReportPageConsumer     = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_GLOBAL, HID_REPORT_ITEM_TAG_USAGE_PAGE),
+    .item.data = { USB_HID_USAGE_PAGE_ID_CONSUMER, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 1, 0, 0 ) };
+
+/*
+ * Define configurable items in the HID Report descriptor.
+ */
+static USB_HID_Report_Element_t hidUsageByte0Bit5   = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .item.data = { 0xE2, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 0, 0, 5 )
+}; // Mute
+static USB_HID_Report_Element_t hidUsageByte0Bit4   = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .item.data = { 0xEA, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 0, 0, 4 )
+}; // Vol-
+static USB_HID_Report_Element_t hidUsageByte0Bit3   = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .item.data = { 0xE9, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 0, 0, 3 )
+}; // Vol+
+static USB_HID_Report_Element_t hidUsageByte0Bit2   = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .item.data = { 0xB6, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 0, 0, 2 )
+}; // Scan Prev
+static USB_HID_Report_Element_t hidUsageByte0Bit1   = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .item.data = { 0xB5, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 0, 0, 1 )
+}; // Scan Next
+static USB_HID_Report_Element_t hidUsageByte0Bit0   = {
+    .item.header = HID_REPORT_SET_HEADER(1, HID_REPORT_ITEM_TYPE_LOCAL, HID_REPORT_ITEM_TAG_USAGE),
+    .item.data = { 0xB0, 0x00 },
+    .location = HID_REPORT_SET_LOC( 0, 0, 0, 0 )
+}; // Play
+
+/*
+ * List the configurable items in the HID Report descriptor.
+ */
+static USB_HID_Report_Element_t* const hidConfigurableElements[] = {
+    &hidUsageByte0Bit0,
+    &hidUsageByte0Bit1,
+    &hidUsageByte0Bit2,
+    &hidUsageByte0Bit3,
+    &hidUsageByte0Bit4,
+    &hidUsageByte0Bit5
+};
+
+/*
+ * List HID Reports, one per Report ID. This should be a usage page item with the relevant
+ * If not using report IDs - still have one with report ID 0
+ */
+static const USB_HID_Report_Element_t* const hidReports[] = {
+    &hidReportPageConsumer
+};
+
+/*
+ * List all items in the HID Report descriptor.
+ */
+static const USB_HID_Short_Item_t * const hidReportDescriptorItems[] = {
+    &(hidReportPageConsumer.item),
+    &hidUsageConsumerControl,
+    &hidCollectionApplication,
+        &hidLogicalMinimum0,
+        &hidLogicalMaximum1,
+        &(hidUsageByte0Bit0.item),
+        &(hidUsageByte0Bit1.item),
+        &(hidUsageByte0Bit2.item),
+        &(hidUsageByte0Bit3.item),
+        &(hidUsageByte0Bit4.item),
+        &(hidUsageByte0Bit5.item),
+        &hidReportSize1,
+        &hidReportCount6,
+        &hidInputDataVar,
+        &hidLogicalMaximum0,
+        &hidReportCount2,
+        &hidInputConstArray,
+    &hidCollectionEnd
+};
+
+/*
+ * Define the number of HID Reports
+ * Due to XC not supporting designated initializers, this constant has a hard-coded value.
+ * It must equal ( sizeof hidReports / sizeof ( USB_HID_Report_Element_t* ))
+ */
+#define HID_REPORT_COUNT ( 1 )
+
+#endif // __hid_report_descriptor_h__

legacy_tests/app_test_i2s_loopback/main.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2016-2018, XMOS Ltd, All rights reserved
+// Copyright 2016-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #include <platform.h>
 #include <stdlib.h>
 #include <print.h>

legacy_tests/app_test_i2s_loopback/simulation.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2016-2018, XMOS Ltd, All rights reserved
+// Copyright 2016-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifdef SIMULATION
 
 #include <platform.h>

legacy_tests/app_test_i2s_loopback/usb_device.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2016-2018, XMOS Ltd, All rights reserved
+// Copyright 2016-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef __usb_device_h__
 #define __usb_device_h__
 

legacy_tests/app_test_i2s_loopback/usb_device.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2018, XMOS Ltd, All rights reserved
+// Copyright 2018-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #if 0
 #include <xs1.h>
 #include <xccompat.h>

legacy_tests/app_test_i2s_loopback/xk_216_mc/audiohw.xc

@@ -1,4 +1,5 @@
-// Copyright (c) 2016-2018, XMOS Ltd, All rights reserved
+// Copyright 2016-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifdef HARDWARE
 
 #include <xs1.h>
@@ -7,7 +8,7 @@
 #include "devicedefines.h"
 #include <platform.h>
 #include "gpio_access.h"
-#include "i2c_shared.h"
+#include "i2c.h"
 #include "cs4384.h"
 #include "cs5368.h"
 #include "cs2100.h"
@@ -24,16 +25,10 @@
 
 on tile[0] : out port p_gpio = XS1_PORT_8C;
 
-#ifndef IAP
-/* If IAP not enabled, i2c ports not declared - still needs for DAC config */
-on tile [0] : struct r_i2c r_i2c = {XS1_PORT_4A};
-#else
-extern struct r_i2c r_i2c;
-#endif
+port p_i2c = on tile[0]:PORT_I2C;
 
-#define DAC_REGWRITE(reg, val) {data[0] = val; i2c_shared_master_write_reg(r_i2c, CS4384_I2C_ADDR, reg, data, 1);}
-#define DAC_REGREAD(reg, val)  {i2c_shared_master_read_reg(r_i2c, CS4384_I2C_ADDR, reg, val, 1);}
-#define ADC_REGWRITE(reg, val) {data[0] = val; i2c_shared_master_write_reg(r_i2c, CS5368_I2C_ADDR, reg, data, 1);}
+#define DAC_REGWRITE(reg, val) {result = i2c.write_reg(CS4384_I2C_ADDR, reg, val);}
+#define ADC_REGWRITE(reg, val) {result = i2c.write_reg(CS5368_I2C_ADDR, reg, val);}
 
 #ifdef USE_FRACTIONAL_N
 
@@ -44,14 +39,15 @@ extern struct r_i2c r_i2c;
 #define PLL_SYNC_FREQ 300
 #endif
 
-#define CS2100_REGREAD(reg, data)  {data[0] = 0xAA; i2c_master_read_reg(CS2100_I2C_DEVICE_ADDR, reg, data, 1, r_i2c);}
-#define CS2100_REGREAD_ASSERT(reg, data, expected)  {data[0] = 0xAA; i2c_master_read_reg(CS2100_I2C_DEVICE_ADDR, reg, data, 1, r_i2c); assert(data[0] == expected);}
-#define CS2100_REGWRITE(reg, val) {data[0] = val; i2c_master_write_reg(CS2100_I2C_DEVICE_ADDR, reg, data, 1, r_i2c);}
+#define CS2100_REGREAD(reg, data) {data[0] = i2c.read_reg(CS2100_I2C_DEVICE_ADDR, reg, result);}
+#define CS2100_REGREAD_ASSERT(reg, data, expected) {data[0] = i2c.read_reg(CS2100_I2C_DEVICE_ADDR, reg, result); assert(data[0] == expected);}
+#define CS2100_REGWRITE(reg, val) {result = i2c.write_reg(CS2100_I2C_DEVICE_ADDR, reg, val);}
 
 /* Init of CS2100 */
-void PllInit(void)
+void PllInit(client interface i2c_master_if i2c)
 {
     unsigned char data[1] = {0};
+    i2c_regop_res_t result;
 
 #if XCORE_200_MC_AUDIO_HW_VERSION < 2
     /* Enable init */
@@ -72,12 +68,15 @@ void PllInit(void)
     CS2100_REGREAD_ASSERT(CS2100_GLOBAL_CONFIG, data, 0x01);
     CS2100_REGREAD_ASSERT(CS2100_FUNC_CONFIG_1, data, 0x08);
     CS2100_REGREAD_ASSERT(CS2100_FUNC_CONFIG_2, data, 0x00);
+
+    i2c.shutdown();
 }
 
 /* Setup PLL multiplier */
-void PllMult(unsigned output, unsigned ref)
+void PllMult(unsigned output, unsigned ref, client interface i2c_master_if i2c)
 {
     unsigned char data[1] = {0};
+    i2c_regop_res_t result;
 
     /* PLL expects 12:20 format, convert output and ref to 12:20 */
     /* Shift up the dividend by 12 to retain format... */
@@ -119,9 +118,6 @@ void AudioHwInit(chanend ?c_codec)
     start_clock(clk_pll_sync);
 #endif
 
-    /* Init the i2c module */
-    i2c_shared_master_init(r_i2c);
-
     /* Assert reset to ADC and DAC */
     set_gpio(P_GPIO_DAC_RST_N, 0);
     set_gpio(P_GPIO_ADC_RST_N, 0);
@@ -142,7 +138,12 @@ void AudioHwInit(chanend ?c_codec)
     set_gpio(P_GPIO_PLL_SEL, 1);
 
      /* Initialise external PLL */
-    PllInit();
+    i2c_master_if i2c[1];
+    par
+    {
+        i2c_master_single_port(i2c, 1, p_i2c, 10, 0, 1, 0);
+        PllInit(i2c[0]);
+    }
 #endif
 
 #ifdef IAP
@@ -154,10 +155,11 @@ void AudioHwInit(chanend ?c_codec)
 /* Configures the external audio hardware for the required sample frequency.
  * See gpio.h for I2C helper functions and gpio access
  */
-void AudioHwConfig(unsigned samFreq, unsigned mClk, chanend ?c_codec, unsigned dsdMode,
-    unsigned sampRes_DAC, unsigned sampRes_ADC)
+void AudioHwConfig2(unsigned samFreq, unsigned mClk, chanend ?c_codec, unsigned dsdMode,
+    unsigned sampRes_DAC, unsigned sampRes_ADC, client interface i2c_master_if i2c)
 {
-	unsigned char data[1] = {0};
+    unsigned char data[1] = {0};
+    i2c_regop_res_t result;
 
     /* Put ADC and DAC into reset */
 	set_gpio(P_GPIO_ADC_RST_N, 0);
@@ -166,7 +168,7 @@ void AudioHwConfig(unsigned samFreq, unsigned mClk, chanend ?c_codec, unsigned d
     /* Set master clock select appropriately */
 #if defined(USE_FRACTIONAL_N)
     /* Configure external fractional-n clock multiplier for 300Hz -> mClkFreq */
-    PllMult(mClk, PLL_SYNC_FREQ);
+    PllMult(mClk, PLL_SYNC_FREQ, i2c);
 #endif
     /* Allow some time for mclk to lock and MCLK to stabilise - this is important to avoid glitches at start of stream */
     {
@@ -364,8 +366,20 @@ void AudioHwConfig(unsigned samFreq, unsigned mClk, chanend ?c_codec, unsigned d
         DAC_REGWRITE(CS4384_MODE_CTRL, 0b10000000);
     }
 #endif
+
+    i2c.shutdown();
     return;
 }
-//:
+
+void AudioHwConfig(unsigned samFreq, unsigned mClk, chanend ?c_codec, unsigned dsdMode,
+    unsigned sampRes_DAC, unsigned sampRes_ADC)
+{
+    i2c_master_if i2c[1];
+    par
+    {
+        i2c_master_single_port(i2c, 1, p_i2c, 10, 0, 1, 0);
+        AudioHwConfig2(samFreq, mClk, c_codec, dsdMode, sampRes_DAC, sampRes_ADC, i2c[0]);
+    }
+}
 
 #endif

legacy_tests/app_test_i2s_loopback/xk_216_mc/cs2100.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2018, XMOS Ltd, All rights reserved
+// Copyright 2018-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #define CS2100_I2C_DEVICE_ADDR      (0x9c>>1)
 
 #define CS2100_DEVICE_CONTROL       0x02

legacy_tests/app_test_i2s_loopback/xk_216_mc/cs4384.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef CS4384_H_
 #define CS4384_H_
 

legacy_tests/app_test_i2s_loopback/xk_216_mc/cs5368.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef _CS5368_H_
 #define _CS5368_H_
 

legacy_tests/app_test_i2s_loopback/xk_216_mc/gpio_access.c

@@ -1,4 +1,5 @@
-// Copyright (c) 2016-2018, XMOS Ltd, All rights reserved
+// Copyright 2016-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifdef HARDWARE
 #include <xs1.h>
 #include "gpio_access.h"

legacy_tests/app_test_i2s_loopback/xk_216_mc/gpio_access.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2016-2018, XMOS Ltd, All rights reserved
+// Copyright 2016-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef __gpio_access_h__
 #define __gpio_access_h__
 

legacy_tests/app_test_i2s_loopback/xk_216_mc/xk-audio-216-mc.xn

@@ -83,10 +83,12 @@
     </Link>
   </Links>
   <ExternalDevices>
-    <Device NodeId="0" Tile="0" Class="SQIFlash" Name="bootFlash" Type="S25FL116K">
+    <Device NodeId="0" Tile="0" Class="SQIFlash" Name="bootFlash" Type="S25FL116K" PageSize="256" SectorSize="4096" NumPages="8192">
       <Attribute Name="PORT_SQI_CS" Value="PORT_SQI_CS"/>
       <Attribute Name="PORT_SQI_SCLK"   Value="PORT_SQI_SCLK"/>
       <Attribute Name="PORT_SQI_SIO"  Value="PORT_SQI_SIO"/>
+      <Attribute Name="QE_REGISTER" Value="flash_qe_location_status_reg_0"/>
+      <Attribute Name="QE_BIT" Value="flash_qe_bit_6"/>
     </Device>
   </ExternalDevices>
   <JTAGChain>

legacy_tests/app_test_i2s_loopback/xua_conf.h

@@ -1,9 +1,10 @@
-// Copyright (c) 2016-2019, XMOS Ltd, All rights reserved
+// Copyright 2016-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef __custom_defines_h__
 #define __custom_defines_h__
 
 #define EXCLUDE_USB_AUDIO_MAIN
-#define NUM_PDM_MICS 0
+#define XUA_NUM_PDM_MICS 0
 #define XUD_TILE 1
 #define AUDIO_IO_TILE 0
 #define MIXER 0

legacy_tests/runtests.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python2.7
-# Copyright (c) 2018, XMOS Ltd, All rights reserved
+# Copyright 2018-2021 XMOS LIMITED.
+# This Software is subject to the terms of the XMOS Public Licence: Version 1.
 import xmostest
 import os.path
 

legacy_tests/test_i2s_loopback.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
-# Copyright (c) 2018, XMOS Ltd, All rights reserved
+# Copyright 2018-2021 XMOS LIMITED.
+# This Software is subject to the terms of the XMOS Public Licence: Version 1.
 import xmostest
 
 def runtest_one_config(env, format, i2s_role, num_chans_in, num_chans_out, sample_rate):

lib_xua/.cproject

@@ -1,860 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<?fileVersion 4.0.0?><cproject storage_type_id="org.eclipse.cdt.core.XmlProjectDescriptionStorage">
-	<storageModule moduleId="org.eclipse.cdt.core.settings">
-		<cconfiguration id="com.xmos.cdt.toolchain.1285928753">
-			<storageModule buildSystemId="org.eclipse.cdt.managedbuilder.core.configurationDataProvider" id="com.xmos.cdt.toolchain.1285928753" moduleId="org.eclipse.cdt.core.settings" name="Default">
-				<externalSettings/>
-				<extensions>
-					<extension id="com.xmos.cdt.core.XdeErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
-					<extension id="org.eclipse.cdt.core.GCCErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
-					<extension id="org.eclipse.cdt.core.GNU_ELF" point="org.eclipse.cdt.core.BinaryParser"/>
-					<extension id="com.xmos.cdt.core.XEBinaryParser" point="org.eclipse.cdt.core.BinaryParser"/>
-				</extensions>
-			</storageModule>
-			<storageModule moduleId="cdtBuildSystem" version="4.0.0">
-				<configuration buildProperties="" description="" id="com.xmos.cdt.toolchain.1285928753" name="Default" parent="org.eclipse.cdt.build.core.emptycfg">
-					<folderInfo id="com.xmos.cdt.toolchain.1285928753.790908561" name="/" resourcePath="">
-						<toolChain id="com.xmos.cdt.toolchain.1969897956" name="com.xmos.cdt.toolchain" superClass="com.xmos.cdt.toolchain">
-							<targetPlatform archList="all" binaryParser="com.xmos.cdt.core.XEBinaryParser;org.eclipse.cdt.core.GNU_ELF" id="com.xmos.cdt.core.platform.1615568037" isAbstract="false" osList="linux,win32,macosx" superClass="com.xmos.cdt.core.platform"/>
-							<builder arguments="-f .makefile" id="com.xmos.cdt.builder.base.45159417" keepEnvironmentInBuildfile="false" managedBuildOn="false" superClass="com.xmos.cdt.builder.base">
-								<outputEntries>
-									<entry flags="VALUE_WORKSPACE_PATH" kind="outputPath" name="bin"/>
-								</outputEntries>
-							</builder>
-							<tool id="com.xmos.cdt.xc.compiler.404499215" name="com.xmos.cdt.xc.compiler" superClass="com.xmos.cdt.xc.compiler">
-								<option id="com.xmos.xc.compiler.option.defined.symbols.1492092903" name="com.xmos.xc.compiler.option.defined.symbols" superClass="com.xmos.xc.compiler.option.defined.symbols" valueType="definedSymbols">
-									<listOptionValue builtIn="false" value="__XC__=1"/>
-									<listOptionValue builtIn="false" value="__llvm__=1"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_RELAXED=0"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_CONSUME=1"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_ACQUIRE=2"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_RELEASE=3"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_ACQ_REL=4"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_SEQ_CST=5"/>
-									<listOptionValue builtIn="false" value="__PRAGMA_REDEFINE_EXTNAME=1"/>
-									<listOptionValue builtIn="false" value="__VERSION__=&quot;4.2.1"/>
-									<listOptionValue builtIn="false" value="__CONSTANT_CFSTRINGS__=1"/>
-									<listOptionValue builtIn="false" value="__ORDER_LITTLE_ENDIAN__=1234"/>
-									<listOptionValue builtIn="false" value="__ORDER_BIG_ENDIAN__=4321"/>
-									<listOptionValue builtIn="false" value="__ORDER_PDP_ENDIAN__=3412"/>
-									<listOptionValue builtIn="false" value="__BYTE_ORDER__=__ORDER_LITTLE_ENDIAN__"/>
-									<listOptionValue builtIn="false" value="__LITTLE_ENDIAN__=1"/>
-									<listOptionValue builtIn="false" value="_ILP32=1"/>
-									<listOptionValue builtIn="false" value="__ILP32__=1"/>
-									<listOptionValue builtIn="false" value="__CHAR_BIT__=8"/>
-									<listOptionValue builtIn="false" value="__SCHAR_MAX__=127"/>
-									<listOptionValue builtIn="false" value="__SHRT_MAX__=32767"/>
-									<listOptionValue builtIn="false" value="__INT_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__LONG_MAX__=2147483647L"/>
-									<listOptionValue builtIn="false" value="__LONG_LONG_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__WCHAR_MAX__=255"/>
-									<listOptionValue builtIn="false" value="__INTMAX_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__SIZE_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_DOUBLE__=8"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_FLOAT__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_INT__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_LONG__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_LONG_DOUBLE__=8"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_LONG_LONG__=8"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_POINTER__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_SHORT__=2"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_PTRDIFF_T__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_SIZE_T__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_WCHAR_T__=1"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_WINT_T__=4"/>
-									<listOptionValue builtIn="false" value="__INTMAX_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INTMAX_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INTMAX_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__INTMAX_C_SUFFIX__=LL"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTo__=&quot;llo&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTu__=&quot;llu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTx__=&quot;llx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTX__=&quot;llX&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_C_SUFFIX__=ULL"/>
-									<listOptionValue builtIn="false" value="__INTMAX_WIDTH__=64"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__INTPTR_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INTPTR_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INTPTR_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__INTPTR_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__SIZE_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__WCHAR_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__WCHAR_WIDTH__=8"/>
-									<listOptionValue builtIn="false" value="__WINT_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__WINT_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__SIG_ATOMIC_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__SIG_ATOMIC_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__CHAR16_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__CHAR32_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__FLT_DENORM_MIN__=1.40129846e-45F"/>
-									<listOptionValue builtIn="false" value="__FLT_HAS_DENORM__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_DIG__=6"/>
-									<listOptionValue builtIn="false" value="__FLT_EPSILON__=1.19209290e-7F"/>
-									<listOptionValue builtIn="false" value="__FLT_HAS_INFINITY__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_HAS_QUIET_NAN__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_MANT_DIG__=24"/>
-									<listOptionValue builtIn="false" value="__FLT_MAX_10_EXP__=38"/>
-									<listOptionValue builtIn="false" value="__FLT_MAX_EXP__=128"/>
-									<listOptionValue builtIn="false" value="__FLT_MAX__=3.40282347e+38F"/>
-									<listOptionValue builtIn="false" value="__FLT_MIN_10_EXP__=(-37)"/>
-									<listOptionValue builtIn="false" value="__FLT_MIN_EXP__=(-125)"/>
-									<listOptionValue builtIn="false" value="__FLT_MIN__=1.17549435e-38F"/>
-									<listOptionValue builtIn="false" value="__DBL_DENORM_MIN__=4.9406564584124654e-324"/>
-									<listOptionValue builtIn="false" value="__DBL_HAS_DENORM__=1"/>
-									<listOptionValue builtIn="false" value="__DBL_DIG__=15"/>
-									<listOptionValue builtIn="false" value="__DBL_EPSILON__=2.2204460492503131e-16"/>
-									<listOptionValue builtIn="false" value="__DBL_HAS_INFINITY__=1"/>
-									<listOptionValue builtIn="false" value="__DBL_HAS_QUIET_NAN__=1"/>
-									<listOptionValue builtIn="false" value="__DBL_MANT_DIG__=53"/>
-									<listOptionValue builtIn="false" value="__DBL_MAX_10_EXP__=308"/>
-									<listOptionValue builtIn="false" value="__DBL_MAX_EXP__=1024"/>
-									<listOptionValue builtIn="false" value="__DBL_MAX__=1.7976931348623157e+308"/>
-									<listOptionValue builtIn="false" value="__DBL_MIN_10_EXP__=(-307)"/>
-									<listOptionValue builtIn="false" value="__DBL_MIN_EXP__=(-1021)"/>
-									<listOptionValue builtIn="false" value="__DBL_MIN__=2.2250738585072014e-308"/>
-									<listOptionValue builtIn="false" value="__LDBL_DENORM_MIN__=4.9406564584124654e-324L"/>
-									<listOptionValue builtIn="false" value="__LDBL_HAS_DENORM__=1"/>
-									<listOptionValue builtIn="false" value="__LDBL_DIG__=15"/>
-									<listOptionValue builtIn="false" value="__LDBL_EPSILON__=2.2204460492503131e-16L"/>
-									<listOptionValue builtIn="false" value="__LDBL_HAS_INFINITY__=1"/>
-									<listOptionValue builtIn="false" value="__LDBL_HAS_QUIET_NAN__=1"/>
-									<listOptionValue builtIn="false" value="__LDBL_MANT_DIG__=53"/>
-									<listOptionValue builtIn="false" value="__LDBL_MAX_10_EXP__=308"/>
-									<listOptionValue builtIn="false" value="__LDBL_MAX_EXP__=1024"/>
-									<listOptionValue builtIn="false" value="__LDBL_MAX__=1.7976931348623157e+308L"/>
-									<listOptionValue builtIn="false" value="__LDBL_MIN_10_EXP__=(-307)"/>
-									<listOptionValue builtIn="false" value="__LDBL_MIN_EXP__=(-1021)"/>
-									<listOptionValue builtIn="false" value="__LDBL_MIN__=2.2250738585072014e-308L"/>
-									<listOptionValue builtIn="false" value="__POINTER_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__CHAR_UNSIGNED__=1"/>
-									<listOptionValue builtIn="false" value="__WCHAR_UNSIGNED__=1"/>
-									<listOptionValue builtIn="false" value="__WINT_UNSIGNED__=1"/>
-									<listOptionValue builtIn="false" value="__INT8_TYPE__=signed"/>
-									<listOptionValue builtIn="false" value="__INT8_FMTd__=&quot;hhd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT8_FMTi__=&quot;hhi&quot;"/>
-									<listOptionValue builtIn="false" value="__INT8_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__INT16_TYPE__=short"/>
-									<listOptionValue builtIn="false" value="__INT16_FMTd__=&quot;hd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT16_FMTi__=&quot;hi&quot;"/>
-									<listOptionValue builtIn="false" value="__INT16_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__INT32_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INT32_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INT32_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__INT32_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__INT64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INT64_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INT64_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__INT64_C_SUFFIX__=LL"/>
-									<listOptionValue builtIn="false" value="__USER_LABEL_PREFIX__=_"/>
-									<listOptionValue builtIn="false" value="__FINITE_MATH_ONLY__=0"/>
-									<listOptionValue builtIn="false" value="__FLT_EVAL_METHOD__=0"/>
-									<listOptionValue builtIn="false" value="__FLT_RADIX__=2"/>
-									<listOptionValue builtIn="false" value="__DECIMAL_DIG__=17"/>
-									<listOptionValue builtIn="false" value="__xcore__=1"/>
-									<listOptionValue builtIn="false" value="__XS1B__=1"/>
-									<listOptionValue builtIn="false" value="__STDC_HOSTED__=1"/>
-									<listOptionValue builtIn="false" value="__STDC_UTF_16__=1"/>
-									<listOptionValue builtIn="false" value="__STDC_UTF_32__=1"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_YEAR=14"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_MONTH=3"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_MAJOR=1403"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_MINOR=2"/>
-									<listOptionValue builtIn="false" value="__XCC_HAVE_FLOAT__=1"/>
-									<listOptionValue builtIn="false" value="_XSCOPE_PROBES_INCLUDE_FILE=&quot;/var/folders/0l/8jd0xy095ps890m302j532580000h5/T//cc8JvR3b.h&quot;"/>
-								</option>
-								<option id="com.xmos.xc.compiler.option.include.paths.834699451" name="com.xmos.xc.compiler.option.include.paths" superClass="com.xmos.xc.compiler.option.include.paths" valueType="includePath">
-									<listOptionValue builtIn="false" value="&quot;${XMOS_TOOL_PATH}/target/include/xc&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${XMOS_TOOL_PATH}/target/include&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${XMOS_TOOL_PATH}/target/include/clang&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/doc}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/doc/rst/images}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user/client}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user/class}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/core/included}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/core}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/doc/rst}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/src}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user/control}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/api}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/doc/rst}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/api}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/doc}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user}&quot;"/>
-								</option>
-								<inputType id="com.xmos.cdt.xc.compiler.input.2062798368" name="XC" superClass="com.xmos.cdt.xc.compiler.input"/>
-							</tool>
-							<tool id="com.xmos.cdt.c.compiler.1931691289" name="com.xmos.cdt.c.compiler" superClass="com.xmos.cdt.c.compiler">
-								<option id="com.xmos.c.compiler.option.defined.symbols.534062814" name="com.xmos.c.compiler.option.defined.symbols" superClass="com.xmos.c.compiler.option.defined.symbols" valueType="definedSymbols">
-									<listOptionValue builtIn="false" value="__llvm__=1"/>
-									<listOptionValue builtIn="false" value="__clang__=1"/>
-									<listOptionValue builtIn="false" value="__clang_major__=3"/>
-									<listOptionValue builtIn="false" value="__clang_minor__=6"/>
-									<listOptionValue builtIn="false" value="__clang_patchlevel__=0"/>
-									<listOptionValue builtIn="false" value="__clang_version__=&quot;3.6.0"/>
-									<listOptionValue builtIn="false" value="__GNUC_MINOR__=2"/>
-									<listOptionValue builtIn="false" value="__GNUC_PATCHLEVEL__=1"/>
-									<listOptionValue builtIn="false" value="__GNUC__=4"/>
-									<listOptionValue builtIn="false" value="__GXX_ABI_VERSION=1002"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_RELAXED=0"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_CONSUME=1"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_ACQUIRE=2"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_RELEASE=3"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_ACQ_REL=4"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_SEQ_CST=5"/>
-									<listOptionValue builtIn="false" value="__PRAGMA_REDEFINE_EXTNAME=1"/>
-									<listOptionValue builtIn="false" value="__VERSION__=&quot;4.2.1"/>
-									<listOptionValue builtIn="false" value="__CONSTANT_CFSTRINGS__=1"/>
-									<listOptionValue builtIn="false" value="__GXX_RTTI=1"/>
-									<listOptionValue builtIn="false" value="__ORDER_LITTLE_ENDIAN__=1234"/>
-									<listOptionValue builtIn="false" value="__ORDER_BIG_ENDIAN__=4321"/>
-									<listOptionValue builtIn="false" value="__ORDER_PDP_ENDIAN__=3412"/>
-									<listOptionValue builtIn="false" value="__BYTE_ORDER__=__ORDER_LITTLE_ENDIAN__"/>
-									<listOptionValue builtIn="false" value="__LITTLE_ENDIAN__=1"/>
-									<listOptionValue builtIn="false" value="_ILP32=1"/>
-									<listOptionValue builtIn="false" value="__ILP32__=1"/>
-									<listOptionValue builtIn="false" value="__CHAR_BIT__=8"/>
-									<listOptionValue builtIn="false" value="__SCHAR_MAX__=127"/>
-									<listOptionValue builtIn="false" value="__SHRT_MAX__=32767"/>
-									<listOptionValue builtIn="false" value="__INT_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__LONG_MAX__=2147483647L"/>
-									<listOptionValue builtIn="false" value="__LONG_LONG_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__WCHAR_MAX__=255"/>
-									<listOptionValue builtIn="false" value="__INTMAX_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__SIZE_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_MAX__=18446744073709551615ULL"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__INTPTR_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_DOUBLE__=8"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_FLOAT__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_INT__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_LONG__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_LONG_DOUBLE__=8"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_LONG_LONG__=8"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_POINTER__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_SHORT__=2"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_PTRDIFF_T__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_SIZE_T__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_WCHAR_T__=1"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_WINT_T__=4"/>
-									<listOptionValue builtIn="false" value="__INTMAX_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INTMAX_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INTMAX_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__INTMAX_C_SUFFIX__=LL"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTo__=&quot;llo&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTu__=&quot;llu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTx__=&quot;llx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTX__=&quot;llX&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_C_SUFFIX__=ULL"/>
-									<listOptionValue builtIn="false" value="__INTMAX_WIDTH__=64"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__INTPTR_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INTPTR_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INTPTR_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__INTPTR_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__SIZE_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__WCHAR_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__WCHAR_WIDTH__=8"/>
-									<listOptionValue builtIn="false" value="__WINT_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__WINT_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__SIG_ATOMIC_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__SIG_ATOMIC_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__CHAR16_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__CHAR32_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_WIDTH__=64"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__FLT_DENORM_MIN__=1.40129846e-45F"/>
-									<listOptionValue builtIn="false" value="__FLT_HAS_DENORM__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_DIG__=6"/>
-									<listOptionValue builtIn="false" value="__FLT_EPSILON__=1.19209290e-7F"/>
-									<listOptionValue builtIn="false" value="__FLT_HAS_INFINITY__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_HAS_QUIET_NAN__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_MANT_DIG__=24"/>
-									<listOptionValue builtIn="false" value="__FLT_MAX_10_EXP__=38"/>
-									<listOptionValue builtIn="false" value="__FLT_MAX_EXP__=128"/>
-									<listOptionValue builtIn="false" value="__FLT_MAX__=3.40282347e+38F"/>
-									<listOptionValue builtIn="false" value="__FLT_MIN_10_EXP__=(-37)"/>
-									<listOptionValue builtIn="false" value="__FLT_MIN_EXP__=(-125)"/>
-									<listOptionValue builtIn="false" value="__FLT_MIN__=1.17549435e-38F"/>
-									<listOptionValue builtIn="false" value="__DBL_DENORM_MIN__=4.9406564584124654e-324"/>
-									<listOptionValue builtIn="false" value="__DBL_HAS_DENORM__=1"/>
-									<listOptionValue builtIn="false" value="__DBL_DIG__=15"/>
-									<listOptionValue builtIn="false" value="__DBL_EPSILON__=2.2204460492503131e-16"/>
-									<listOptionValue builtIn="false" value="__DBL_HAS_INFINITY__=1"/>
-									<listOptionValue builtIn="false" value="__DBL_HAS_QUIET_NAN__=1"/>
-									<listOptionValue builtIn="false" value="__DBL_MANT_DIG__=53"/>
-									<listOptionValue builtIn="false" value="__DBL_MAX_10_EXP__=308"/>
-									<listOptionValue builtIn="false" value="__DBL_MAX_EXP__=1024"/>
-									<listOptionValue builtIn="false" value="__DBL_MAX__=1.7976931348623157e+308"/>
-									<listOptionValue builtIn="false" value="__DBL_MIN_10_EXP__=(-307)"/>
-									<listOptionValue builtIn="false" value="__DBL_MIN_EXP__=(-1021)"/>
-									<listOptionValue builtIn="false" value="__DBL_MIN__=2.2250738585072014e-308"/>
-									<listOptionValue builtIn="false" value="__LDBL_DENORM_MIN__=4.9406564584124654e-324L"/>
-									<listOptionValue builtIn="false" value="__LDBL_HAS_DENORM__=1"/>
-									<listOptionValue builtIn="false" value="__LDBL_DIG__=15"/>
-									<listOptionValue builtIn="false" value="__LDBL_EPSILON__=2.2204460492503131e-16L"/>
-									<listOptionValue builtIn="false" value="__LDBL_HAS_INFINITY__=1"/>
-									<listOptionValue builtIn="false" value="__LDBL_HAS_QUIET_NAN__=1"/>
-									<listOptionValue builtIn="false" value="__LDBL_MANT_DIG__=53"/>
-									<listOptionValue builtIn="false" value="__LDBL_MAX_10_EXP__=308"/>
-									<listOptionValue builtIn="false" value="__LDBL_MAX_EXP__=1024"/>
-									<listOptionValue builtIn="false" value="__LDBL_MAX__=1.7976931348623157e+308L"/>
-									<listOptionValue builtIn="false" value="__LDBL_MIN_10_EXP__=(-307)"/>
-									<listOptionValue builtIn="false" value="__LDBL_MIN_EXP__=(-1021)"/>
-									<listOptionValue builtIn="false" value="__LDBL_MIN__=2.2250738585072014e-308L"/>
-									<listOptionValue builtIn="false" value="__POINTER_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__CHAR_UNSIGNED__=1"/>
-									<listOptionValue builtIn="false" value="__WCHAR_UNSIGNED__=1"/>
-									<listOptionValue builtIn="false" value="__WINT_UNSIGNED__=1"/>
-									<listOptionValue builtIn="false" value="__INT8_TYPE__=signed"/>
-									<listOptionValue builtIn="false" value="__INT8_FMTd__=&quot;hhd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT8_FMTi__=&quot;hhi&quot;"/>
-									<listOptionValue builtIn="false" value="__INT8_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__INT16_TYPE__=short"/>
-									<listOptionValue builtIn="false" value="__INT16_FMTd__=&quot;hd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT16_FMTi__=&quot;hi&quot;"/>
-									<listOptionValue builtIn="false" value="__INT16_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__INT32_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INT32_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INT32_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__INT32_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__INT64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INT64_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INT64_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__INT64_C_SUFFIX__=LL"/>
-									<listOptionValue builtIn="false" value="__UINT8_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT8_FMTo__=&quot;hho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT8_FMTu__=&quot;hhu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT8_FMTx__=&quot;hhx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT8_FMTX__=&quot;hhX&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT8_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__UINT8_MAX__=255"/>
-									<listOptionValue builtIn="false" value="__INT8_MAX__=127"/>
-									<listOptionValue builtIn="false" value="__UINT16_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT16_FMTo__=&quot;ho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT16_FMTu__=&quot;hu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT16_FMTx__=&quot;hx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT16_FMTX__=&quot;hX&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT16_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__UINT16_MAX__=65535"/>
-									<listOptionValue builtIn="false" value="__INT16_MAX__=32767"/>
-									<listOptionValue builtIn="false" value="__UINT32_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT32_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT32_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT32_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT32_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT32_C_SUFFIX__=U"/>
-									<listOptionValue builtIn="false" value="__UINT32_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__INT32_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__UINT64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__UINT64_FMTo__=&quot;llo&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT64_FMTu__=&quot;llu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT64_FMTx__=&quot;llx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT64_FMTX__=&quot;llX&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT64_C_SUFFIX__=ULL"/>
-									<listOptionValue builtIn="false" value="__UINT64_MAX__=18446744073709551615ULL"/>
-									<listOptionValue builtIn="false" value="__INT64_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST8_TYPE__=signed"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST8_MAX__=127"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST8_FMTd__=&quot;hhd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST8_FMTi__=&quot;hhi&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_MAX__=255"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_FMTo__=&quot;hho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_FMTu__=&quot;hhu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_FMTx__=&quot;hhx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_FMTX__=&quot;hhX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST16_TYPE__=short"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST16_MAX__=32767"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST16_FMTd__=&quot;hd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST16_FMTi__=&quot;hi&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_MAX__=65535"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_FMTo__=&quot;ho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_FMTu__=&quot;hu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_FMTx__=&quot;hx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_FMTX__=&quot;hX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST32_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST32_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST32_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST32_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST64_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST64_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST64_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_MAX__=18446744073709551615ULL"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_FMTo__=&quot;llo&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_FMTu__=&quot;llu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_FMTx__=&quot;llx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_FMTX__=&quot;llX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST8_TYPE__=signed"/>
-									<listOptionValue builtIn="false" value="__INT_FAST8_MAX__=127"/>
-									<listOptionValue builtIn="false" value="__INT_FAST8_FMTd__=&quot;hhd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST8_FMTi__=&quot;hhi&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_MAX__=255"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_FMTo__=&quot;hho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_FMTu__=&quot;hhu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_FMTx__=&quot;hhx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_FMTX__=&quot;hhX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST16_TYPE__=short"/>
-									<listOptionValue builtIn="false" value="__INT_FAST16_MAX__=32767"/>
-									<listOptionValue builtIn="false" value="__INT_FAST16_FMTd__=&quot;hd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST16_FMTi__=&quot;hi&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_MAX__=65535"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_FMTo__=&quot;ho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_FMTu__=&quot;hu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_FMTx__=&quot;hx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_FMTX__=&quot;hX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST32_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INT_FAST32_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__INT_FAST32_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST32_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INT_FAST64_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__INT_FAST64_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST64_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_MAX__=18446744073709551615ULL"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_FMTo__=&quot;llo&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_FMTu__=&quot;llu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_FMTx__=&quot;llx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_FMTX__=&quot;llX&quot;"/>
-									<listOptionValue builtIn="false" value="__USER_LABEL_PREFIX__=_"/>
-									<listOptionValue builtIn="false" value="__FINITE_MATH_ONLY__=0"/>
-									<listOptionValue builtIn="false" value="__GNUC_STDC_INLINE__=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_TEST_AND_SET_TRUEVAL=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_BOOL_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_CHAR_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_CHAR16_T_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_CHAR32_T_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_WCHAR_T_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_SHORT_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_INT_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_LONG_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_LLONG_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_POINTER_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__NO_INLINE__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_EVAL_METHOD__=0"/>
-									<listOptionValue builtIn="false" value="__FLT_RADIX__=2"/>
-									<listOptionValue builtIn="false" value="__DECIMAL_DIG__=17"/>
-									<listOptionValue builtIn="false" value="__xcore__=1"/>
-									<listOptionValue builtIn="false" value="__XS1B__=1"/>
-									<listOptionValue builtIn="false" value="__STDC__=1"/>
-									<listOptionValue builtIn="false" value="__STDC_HOSTED__=1"/>
-									<listOptionValue builtIn="false" value="__STDC_VERSION__=199901L"/>
-									<listOptionValue builtIn="false" value="__STDC_UTF_16__=1"/>
-									<listOptionValue builtIn="false" value="__STDC_UTF_32__=1"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_YEAR=14"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_MONTH=3"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_MAJOR=1403"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_MINOR=2"/>
-									<listOptionValue builtIn="false" value="__XCC_HAVE_FLOAT__=1"/>
-									<listOptionValue builtIn="false" value="_XSCOPE_PROBES_INCLUDE_FILE=&quot;/var/folders/0l/8jd0xy095ps890m302j532580000h5/T//ccVdKn1b.h&quot;"/>
-								</option>
-								<option id="com.xmos.c.compiler.option.include.paths.1661660573" name="com.xmos.c.compiler.option.include.paths" superClass="com.xmos.c.compiler.option.include.paths" valueType="includePath">
-									<listOptionValue builtIn="false" value="&quot;${XMOS_TOOL_PATH}/target/include&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${XMOS_TOOL_PATH}/target/include/clang&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/doc}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/doc/rst/images}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user/client}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user/class}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/core/included}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/core}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/doc/rst}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/src}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user/control}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/api}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/doc/rst}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/api}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/doc}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user}&quot;"/>
-								</option>
-								<inputType id="com.xmos.cdt.c.compiler.input.c.1188610778" name="C" superClass="com.xmos.cdt.c.compiler.input.c"/>
-							</tool>
-							<tool id="com.xmos.cdt.cxx.compiler.1403352573" name="com.xmos.cdt.cxx.compiler" superClass="com.xmos.cdt.cxx.compiler">
-								<option id="com.xmos.cxx.compiler.option.defined.symbols.665306874" name="com.xmos.cxx.compiler.option.defined.symbols" superClass="com.xmos.cxx.compiler.option.defined.symbols" valueType="definedSymbols">
-									<listOptionValue builtIn="false" value="__llvm__=1"/>
-									<listOptionValue builtIn="false" value="__clang__=1"/>
-									<listOptionValue builtIn="false" value="__clang_major__=3"/>
-									<listOptionValue builtIn="false" value="__clang_minor__=6"/>
-									<listOptionValue builtIn="false" value="__clang_patchlevel__=0"/>
-									<listOptionValue builtIn="false" value="__clang_version__=&quot;3.6.0"/>
-									<listOptionValue builtIn="false" value="__GNUC_MINOR__=2"/>
-									<listOptionValue builtIn="false" value="__GNUC_PATCHLEVEL__=1"/>
-									<listOptionValue builtIn="false" value="__GNUC__=4"/>
-									<listOptionValue builtIn="false" value="__GXX_ABI_VERSION=1002"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_RELAXED=0"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_CONSUME=1"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_ACQUIRE=2"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_RELEASE=3"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_ACQ_REL=4"/>
-									<listOptionValue builtIn="false" value="__ATOMIC_SEQ_CST=5"/>
-									<listOptionValue builtIn="false" value="__PRAGMA_REDEFINE_EXTNAME=1"/>
-									<listOptionValue builtIn="false" value="__VERSION__=&quot;4.2.1"/>
-									<listOptionValue builtIn="false" value="__CONSTANT_CFSTRINGS__=1"/>
-									<listOptionValue builtIn="false" value="__GXX_RTTI=1"/>
-									<listOptionValue builtIn="false" value="__DEPRECATED=1"/>
-									<listOptionValue builtIn="false" value="__GNUG__=4"/>
-									<listOptionValue builtIn="false" value="__GXX_WEAK__=1"/>
-									<listOptionValue builtIn="false" value="__private_extern__=extern"/>
-									<listOptionValue builtIn="false" value="__ORDER_LITTLE_ENDIAN__=1234"/>
-									<listOptionValue builtIn="false" value="__ORDER_BIG_ENDIAN__=4321"/>
-									<listOptionValue builtIn="false" value="__ORDER_PDP_ENDIAN__=3412"/>
-									<listOptionValue builtIn="false" value="__BYTE_ORDER__=__ORDER_LITTLE_ENDIAN__"/>
-									<listOptionValue builtIn="false" value="__LITTLE_ENDIAN__=1"/>
-									<listOptionValue builtIn="false" value="_ILP32=1"/>
-									<listOptionValue builtIn="false" value="__ILP32__=1"/>
-									<listOptionValue builtIn="false" value="__CHAR_BIT__=8"/>
-									<listOptionValue builtIn="false" value="__SCHAR_MAX__=127"/>
-									<listOptionValue builtIn="false" value="__SHRT_MAX__=32767"/>
-									<listOptionValue builtIn="false" value="__INT_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__LONG_MAX__=2147483647L"/>
-									<listOptionValue builtIn="false" value="__LONG_LONG_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__WCHAR_MAX__=255"/>
-									<listOptionValue builtIn="false" value="__INTMAX_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__SIZE_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_MAX__=18446744073709551615ULL"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__INTPTR_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_DOUBLE__=8"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_FLOAT__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_INT__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_LONG__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_LONG_DOUBLE__=8"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_LONG_LONG__=8"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_POINTER__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_SHORT__=2"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_PTRDIFF_T__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_SIZE_T__=4"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_WCHAR_T__=1"/>
-									<listOptionValue builtIn="false" value="__SIZEOF_WINT_T__=4"/>
-									<listOptionValue builtIn="false" value="__INTMAX_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INTMAX_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INTMAX_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__INTMAX_C_SUFFIX__=LL"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTo__=&quot;llo&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTu__=&quot;llu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTx__=&quot;llx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_FMTX__=&quot;llX&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_C_SUFFIX__=ULL"/>
-									<listOptionValue builtIn="false" value="__INTMAX_WIDTH__=64"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__PTRDIFF_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__INTPTR_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INTPTR_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INTPTR_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__INTPTR_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__SIZE_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__SIZE_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__WCHAR_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__WCHAR_WIDTH__=8"/>
-									<listOptionValue builtIn="false" value="__WINT_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__WINT_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__SIG_ATOMIC_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__SIG_ATOMIC_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__CHAR16_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__CHAR32_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINTMAX_WIDTH__=64"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__UINTPTR_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__FLT_DENORM_MIN__=1.40129846e-45F"/>
-									<listOptionValue builtIn="false" value="__FLT_HAS_DENORM__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_DIG__=6"/>
-									<listOptionValue builtIn="false" value="__FLT_EPSILON__=1.19209290e-7F"/>
-									<listOptionValue builtIn="false" value="__FLT_HAS_INFINITY__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_HAS_QUIET_NAN__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_MANT_DIG__=24"/>
-									<listOptionValue builtIn="false" value="__FLT_MAX_10_EXP__=38"/>
-									<listOptionValue builtIn="false" value="__FLT_MAX_EXP__=128"/>
-									<listOptionValue builtIn="false" value="__FLT_MAX__=3.40282347e+38F"/>
-									<listOptionValue builtIn="false" value="__FLT_MIN_10_EXP__=(-37)"/>
-									<listOptionValue builtIn="false" value="__FLT_MIN_EXP__=(-125)"/>
-									<listOptionValue builtIn="false" value="__FLT_MIN__=1.17549435e-38F"/>
-									<listOptionValue builtIn="false" value="__DBL_DENORM_MIN__=4.9406564584124654e-324"/>
-									<listOptionValue builtIn="false" value="__DBL_HAS_DENORM__=1"/>
-									<listOptionValue builtIn="false" value="__DBL_DIG__=15"/>
-									<listOptionValue builtIn="false" value="__DBL_EPSILON__=2.2204460492503131e-16"/>
-									<listOptionValue builtIn="false" value="__DBL_HAS_INFINITY__=1"/>
-									<listOptionValue builtIn="false" value="__DBL_HAS_QUIET_NAN__=1"/>
-									<listOptionValue builtIn="false" value="__DBL_MANT_DIG__=53"/>
-									<listOptionValue builtIn="false" value="__DBL_MAX_10_EXP__=308"/>
-									<listOptionValue builtIn="false" value="__DBL_MAX_EXP__=1024"/>
-									<listOptionValue builtIn="false" value="__DBL_MAX__=1.7976931348623157e+308"/>
-									<listOptionValue builtIn="false" value="__DBL_MIN_10_EXP__=(-307)"/>
-									<listOptionValue builtIn="false" value="__DBL_MIN_EXP__=(-1021)"/>
-									<listOptionValue builtIn="false" value="__DBL_MIN__=2.2250738585072014e-308"/>
-									<listOptionValue builtIn="false" value="__LDBL_DENORM_MIN__=4.9406564584124654e-324L"/>
-									<listOptionValue builtIn="false" value="__LDBL_HAS_DENORM__=1"/>
-									<listOptionValue builtIn="false" value="__LDBL_DIG__=15"/>
-									<listOptionValue builtIn="false" value="__LDBL_EPSILON__=2.2204460492503131e-16L"/>
-									<listOptionValue builtIn="false" value="__LDBL_HAS_INFINITY__=1"/>
-									<listOptionValue builtIn="false" value="__LDBL_HAS_QUIET_NAN__=1"/>
-									<listOptionValue builtIn="false" value="__LDBL_MANT_DIG__=53"/>
-									<listOptionValue builtIn="false" value="__LDBL_MAX_10_EXP__=308"/>
-									<listOptionValue builtIn="false" value="__LDBL_MAX_EXP__=1024"/>
-									<listOptionValue builtIn="false" value="__LDBL_MAX__=1.7976931348623157e+308L"/>
-									<listOptionValue builtIn="false" value="__LDBL_MIN_10_EXP__=(-307)"/>
-									<listOptionValue builtIn="false" value="__LDBL_MIN_EXP__=(-1021)"/>
-									<listOptionValue builtIn="false" value="__LDBL_MIN__=2.2250738585072014e-308L"/>
-									<listOptionValue builtIn="false" value="__POINTER_WIDTH__=32"/>
-									<listOptionValue builtIn="false" value="__CHAR_UNSIGNED__=1"/>
-									<listOptionValue builtIn="false" value="__WCHAR_UNSIGNED__=1"/>
-									<listOptionValue builtIn="false" value="__WINT_UNSIGNED__=1"/>
-									<listOptionValue builtIn="false" value="__INT8_TYPE__=signed"/>
-									<listOptionValue builtIn="false" value="__INT8_FMTd__=&quot;hhd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT8_FMTi__=&quot;hhi&quot;"/>
-									<listOptionValue builtIn="false" value="__INT8_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__INT16_TYPE__=short"/>
-									<listOptionValue builtIn="false" value="__INT16_FMTd__=&quot;hd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT16_FMTi__=&quot;hi&quot;"/>
-									<listOptionValue builtIn="false" value="__INT16_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__INT32_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INT32_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INT32_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__INT32_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__INT64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INT64_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INT64_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__INT64_C_SUFFIX__=LL"/>
-									<listOptionValue builtIn="false" value="__UINT8_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT8_FMTo__=&quot;hho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT8_FMTu__=&quot;hhu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT8_FMTx__=&quot;hhx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT8_FMTX__=&quot;hhX&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT8_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__UINT8_MAX__=255"/>
-									<listOptionValue builtIn="false" value="__INT8_MAX__=127"/>
-									<listOptionValue builtIn="false" value="__UINT16_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT16_FMTo__=&quot;ho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT16_FMTu__=&quot;hu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT16_FMTx__=&quot;hx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT16_FMTX__=&quot;hX&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT16_C_SUFFIX__"/>
-									<listOptionValue builtIn="false" value="__UINT16_MAX__=65535"/>
-									<listOptionValue builtIn="false" value="__INT16_MAX__=32767"/>
-									<listOptionValue builtIn="false" value="__UINT32_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT32_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT32_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT32_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT32_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT32_C_SUFFIX__=U"/>
-									<listOptionValue builtIn="false" value="__UINT32_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__INT32_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__UINT64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__UINT64_FMTo__=&quot;llo&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT64_FMTu__=&quot;llu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT64_FMTx__=&quot;llx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT64_FMTX__=&quot;llX&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT64_C_SUFFIX__=ULL"/>
-									<listOptionValue builtIn="false" value="__UINT64_MAX__=18446744073709551615ULL"/>
-									<listOptionValue builtIn="false" value="__INT64_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST8_TYPE__=signed"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST8_MAX__=127"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST8_FMTd__=&quot;hhd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST8_FMTi__=&quot;hhi&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_MAX__=255"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_FMTo__=&quot;hho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_FMTu__=&quot;hhu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_FMTx__=&quot;hhx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST8_FMTX__=&quot;hhX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST16_TYPE__=short"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST16_MAX__=32767"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST16_FMTd__=&quot;hd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST16_FMTi__=&quot;hi&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_MAX__=65535"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_FMTo__=&quot;ho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_FMTu__=&quot;hu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_FMTx__=&quot;hx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST16_FMTX__=&quot;hX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST32_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST32_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST32_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST32_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST32_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST64_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST64_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_LEAST64_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_MAX__=18446744073709551615ULL"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_FMTo__=&quot;llo&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_FMTu__=&quot;llu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_FMTx__=&quot;llx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_LEAST64_FMTX__=&quot;llX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST8_TYPE__=signed"/>
-									<listOptionValue builtIn="false" value="__INT_FAST8_MAX__=127"/>
-									<listOptionValue builtIn="false" value="__INT_FAST8_FMTd__=&quot;hhd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST8_FMTi__=&quot;hhi&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_MAX__=255"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_FMTo__=&quot;hho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_FMTu__=&quot;hhu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_FMTx__=&quot;hhx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST8_FMTX__=&quot;hhX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST16_TYPE__=short"/>
-									<listOptionValue builtIn="false" value="__INT_FAST16_MAX__=32767"/>
-									<listOptionValue builtIn="false" value="__INT_FAST16_FMTd__=&quot;hd&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST16_FMTi__=&quot;hi&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_MAX__=65535"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_FMTo__=&quot;ho&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_FMTu__=&quot;hu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_FMTx__=&quot;hx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST16_FMTX__=&quot;hX&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST32_TYPE__=int"/>
-									<listOptionValue builtIn="false" value="__INT_FAST32_MAX__=2147483647"/>
-									<listOptionValue builtIn="false" value="__INT_FAST32_FMTd__=&quot;d&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST32_FMTi__=&quot;i&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_TYPE__=unsigned"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_MAX__=4294967295U"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_FMTo__=&quot;o&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_FMTu__=&quot;u&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_FMTx__=&quot;x&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST32_FMTX__=&quot;X&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__INT_FAST64_MAX__=9223372036854775807LL"/>
-									<listOptionValue builtIn="false" value="__INT_FAST64_FMTd__=&quot;lld&quot;"/>
-									<listOptionValue builtIn="false" value="__INT_FAST64_FMTi__=&quot;lli&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_TYPE__=long"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_MAX__=18446744073709551615ULL"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_FMTo__=&quot;llo&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_FMTu__=&quot;llu&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_FMTx__=&quot;llx&quot;"/>
-									<listOptionValue builtIn="false" value="__UINT_FAST64_FMTX__=&quot;llX&quot;"/>
-									<listOptionValue builtIn="false" value="__USER_LABEL_PREFIX__=_"/>
-									<listOptionValue builtIn="false" value="__FINITE_MATH_ONLY__=0"/>
-									<listOptionValue builtIn="false" value="__GNUC_GNU_INLINE__=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_TEST_AND_SET_TRUEVAL=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_BOOL_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_CHAR_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_CHAR16_T_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_CHAR32_T_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_WCHAR_T_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_SHORT_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_INT_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_LONG_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_LLONG_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__GCC_ATOMIC_POINTER_LOCK_FREE=1"/>
-									<listOptionValue builtIn="false" value="__NO_INLINE__=1"/>
-									<listOptionValue builtIn="false" value="__FLT_EVAL_METHOD__=0"/>
-									<listOptionValue builtIn="false" value="__FLT_RADIX__=2"/>
-									<listOptionValue builtIn="false" value="__DECIMAL_DIG__=17"/>
-									<listOptionValue builtIn="false" value="__xcore__=1"/>
-									<listOptionValue builtIn="false" value="__XS1B__=1"/>
-									<listOptionValue builtIn="false" value="__STDC__=1"/>
-									<listOptionValue builtIn="false" value="__STDC_HOSTED__=1"/>
-									<listOptionValue builtIn="false" value="__cplusplus=199711L"/>
-									<listOptionValue builtIn="false" value="__STDC_UTF_16__=1"/>
-									<listOptionValue builtIn="false" value="__STDC_UTF_32__=1"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_YEAR=14"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_MONTH=3"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_MAJOR=1403"/>
-									<listOptionValue builtIn="false" value="XCC_VERSION_MINOR=2"/>
-									<listOptionValue builtIn="false" value="__XCC_HAVE_FLOAT__=1"/>
-									<listOptionValue builtIn="false" value="_XSCOPE_PROBES_INCLUDE_FILE=&quot;/var/folders/0l/8jd0xy095ps890m302j532580000h5/T//cc8vh80e.h&quot;"/>
-								</option>
-								<option id="com.xmos.cxx.compiler.option.include.paths.1031009526" name="com.xmos.cxx.compiler.option.include.paths" superClass="com.xmos.cxx.compiler.option.include.paths" valueType="includePath">
-									<listOptionValue builtIn="false" value="&quot;${XMOS_TOOL_PATH}/target/include&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${XMOS_TOOL_PATH}/target/include/clang&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${XMOS_TOOL_PATH}/target/include/c++/v1&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/doc}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/doc/rst/images}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user/client}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user/class}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/core/included}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/core}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/doc/rst}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/src}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user/control}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_logging/api}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/doc/rst}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/api}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/doc}&quot;"/>
-									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/lib_xud/src/user}&quot;"/>
-								</option>
-								<inputType id="com.xmos.cdt.cxx.compiler.input.cpp.223196941" name="C++" superClass="com.xmos.cdt.cxx.compiler.input.cpp"/>
-							</tool>
-						</toolChain>
-					</folderInfo>
-					<sourceEntries>
-						<entry excluding=".build*" flags="VALUE_WORKSPACE_PATH|RESOLVED" kind="sourcePath" name=""/>
-					</sourceEntries>
-				</configuration>
-			</storageModule>
-			<storageModule moduleId="org.eclipse.cdt.core.externalSettings"/>
-		</cconfiguration>
-	</storageModule>
-	<storageModule moduleId="cdtBuildSystem" version="4.0.0">
-		<project id="lib_xua.null.1378855182" name="lib_xua"/>
-	</storageModule>
-	<storageModule moduleId="scannerConfiguration">
-		<autodiscovery enabled="true" problemReportingEnabled="true" selectedProfileId=""/>
-	</storageModule>
-	<storageModule moduleId="org.eclipse.cdt.core.LanguageSettingsProviders"/>
-</cproject>

lib_xua/.project

@@ -1,42 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
-	<name>lib_xua</name>
-	<comment></comment>
-	<projects>
-	</projects>
-	<buildSpec>
-		<buildCommand>
-			<name>com.xmos.cdt.core.ProjectInfoSyncBuilder</name>
-			<arguments>
-			</arguments>
-		</buildCommand>
-		<buildCommand>
-			<name>com.xmos.cdt.core.LegacyProjectCheckerBuilder</name>
-			<arguments>
-			</arguments>
-		</buildCommand>
-		<buildCommand>
-			<name>com.xmos.cdt.core.ModulePathBuilder</name>
-			<arguments>
-			</arguments>
-		</buildCommand>
-		<buildCommand>
-			<name>org.eclipse.cdt.managedbuilder.core.genmakebuilder</name>
-			<triggers>clean,full,incremental,</triggers>
-			<arguments>
-			</arguments>
-		</buildCommand>
-		<buildCommand>
-			<name>org.eclipse.cdt.managedbuilder.core.ScannerConfigBuilder</name>
-			<triggers>full,incremental,</triggers>
-			<arguments>
-			</arguments>
-		</buildCommand>
-	</buildSpec>
-	<natures>
-		<nature>org.eclipse.cdt.core.cnature</nature>
-		<nature>org.eclipse.cdt.managedbuilder.core.managedBuildNature</nature>
-		<nature>org.eclipse.cdt.managedbuilder.core.ScannerConfigNature</nature>
-		<nature>com.xmos.cdt.core.XdeProjectNature</nature>
-	</natures>
-</projectDescription>

lib_xua/.xproject

@@ -1 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?><xproject><repository>lib_xua</repository><partnum>XM-012639-SM</partnum></xproject>

lib_xua/LICENSE.rst

@@ -0,0 +1,84 @@
+*******************************
+XMOS PUBLIC LICENCE: Version 1
+*******************************
+
+Subject to the conditions and limitations below, permission is hereby granted by XMOS LIMITED (“XMOS”), free of charge, to any person or entity obtaining a copy of the XMOS Software.
+
+**1. Definitions**
+
+**“Applicable Patent Rights”** means: (a) where XMOS is the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to XMOS and (ii) that cover subject matter contained in the Software, but only to the extent it is necessary to use, reproduce or distribute the Software without infringement; and (b) where you are the grantor of the rights, (i) claims of patents that are now or in future owned by or assigned to you and (ii) that cover the subject matter contained in your Derivatives, taken alone or in combination with the Software.
+
+**“Compiled Code”** means any compiled, binary, machine readable or executable version of the Source Code.
+
+**“Contributor”** means any person or entity that creates or contributes to the creation of Derivatives.
+
+**“Derivatives”** means any addition to, deletion from and/or change to the substance, structure of the Software, any previous Derivatives, the combination of the Derivatives and the Software and/or any respective portions thereof.
+
+**“Source Code”** means the human readable code that is suitable for making modifications but excluding any Compiled Code.
+
+**“Software”** means the software and associated documentation files which XMOS makes available and which contain a notice identifying the software as original XMOS software and referring to the software being subject to the terms of this XMOS Public Licence.
+
+This Licence refers to XMOS Software and does not relate to any XMOS hardware or devices which are protected by intellectual property rights (including patent and trade marks) which may be sold to you under a separate agreement.
+
+
+**2. Licence**
+
+**Permitted Uses, Conditions and Restrictions.**  Subject to the conditions below, XMOS grants you a worldwide, royalty free, non-exclusive licence, to the extent of any Patent Rights to do the following:
+
+2.1 **Unmodified Software.** You may use, copy, display, publish, distribute and make available unmodified copies of the Software:
+
+2.1.1 for personal or academic, non-commercial purposes; or
+
+2.1.2 for commercial purposes provided the Software is at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.1.1 and 2.1.2):
+
+(a) you must retain and reproduce in all copies of the Software the copyright and proprietary notices and disclaimers of XMOS as they appear in the Software, and keep intact all notices and disclaimers in the Software files that refer to this Licence; and
+
+(b) you must include a copy of this Licence with every copy of the Software and documentation you publish, distribute and make available and you may not offer or impose any terms on such Software that alter or restrict this Licence or the intent of such Licence, except as permitted below (Additional Terms).
+
+The licence above does not include any Compiled Code which XMOS may make available under a separate support and licence agreement.
+
+2.2 **Derivatives.** You may create and modify Derivatives and use, copy, display, publish, distribute and make available Derivatives:
+
+2.2.1 for personal or academic, non-commercial purposes; or
+
+2.2.2 for commercial purposes, provided the Derivatives are at all times used on a device designed, licensed or developed by XMOS and, provided that in each instance (2.2.1 and 2.2.2):
+
+(a) you must comply with the terms of clause 2.1 with respect to the Derivatives;
+
+(b) you must copy (to the extent it doesn’t already exist) the notice below in each file of the Derivatives, and ensure all the modified files carry prominent notices stating that you have changed the files and the date of any change; and
+
+(c) if you sublicence, distribute or otherwise make the Software and/or the Derivatives available for commercial purposes, you must provide that the Software and Derivatives are at all times used on a device designed, licensed or developed by XMOS.
+
+Without limitation to these terms and clause 3 below, the Source Code and Compiled Code to your Derivatives may at your discretion (but without obligation) be released, copied, displayed, published, distributed and made available; and if you elect to do so, it must be under the terms of this Licence including the terms of the licence at clauses 2.2.1, 2.2.2 and clause 3 below.
+
+2.3 **Distribution of Executable Versions.**  If you distribute or make available Derivatives, you must include a prominent notice in the code itself as well as in all related documentation, stating that the Source Code of the Software from which the Derivatives are based is available under the terms of this Licence, with information on how and where to obtain such Source Code.
+
+**3. Your Grant of Rights.**  In consideration and as a condition to this Licence, you grant to any person or entity receiving or distributing any Derivatives, a non-exclusive, royalty free, perpetual, irrevocable license under your Applicable Patent Rights and all other intellectual property rights owned or controlled by you, to use, copy, display, publish, distribute and make available your Derivatives of the same scope and extent as XMOS’s licence under clause 2.2 above.
+
+**4. Combined Products.**  You may create a combined product by combining Software, Derivatives and other code not covered by this Licence as a single application or product. In such instance, you must comply with the requirements of this Licence for any portion of the Software and/or Derivatives.
+
+**5. Additional Terms.**  You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations and/or other rights consistent with the term of this Licence (“Additional Terms”) to any legitimate recipients of the Software and/or Derivatives.  The terms on which you provide such Additional Terms are on your sole responsibility and you shall indemnify, defend and hold XMOS harmless against any claims asserted against XMOS.
+
+**6. New Versions.**  XMOS may publish revised and/or new versions of this Licence from time to time to accommodate changes to the Licence terms, new versions, updates and bug fixes of the Software.  Each version will be given a distinguishing version number.  Once Software has been published under a particular version of this Licence, you may continue to use it under the terms of that version.  You may also choose to use the latest version of the Software under any subsequent version published by XMOS.  Only XMOS shall have the right to modify these terms.
+
+**7. IPR and Ownership**
+Any rights, including all intellectual property rights and all trademarks not expressly granted herein are reserved in full by the authors or copyright holders. Any requests for additional permissions by XMOS including any rights to use XMOS trademarks, should be made (without obligation) to XMOS at **support@xmos.com**
+
+Nothing herein shall limit any rights that XMOS is otherwise entitled to under the doctrines of patent exhaustion, implied license, or legal estoppel.  Neither the name of the authors, the copyright holders or any contributors may be used to endorse or promote any Derivatives from this Software without specific written permission.  Any attempt to deal with the Software which does not comply with this Licence shall be void and shall automatically terminate any rights granted under this licence (including any licence of any intellectual property rights granted herein).
+Subject to the licences granted under this Licence any Contributor retains all rights, title and interest in and to any Derivatives made by Contributor subject to the underlying rights of XMOS in the Software.  XMOS shall retain all rights, title and interest in the Software and any Derivatives made by XMOS (“XMOS Derivatives”).  XMOS Derivatives will not automatically be subject to this Licence and XMOS shall be entitled to licence such rights on any terms (without obligation) as it sees fit.
+
+**8. Termination**
+
+8.1 This Licence will automatically terminate immediately, without notice to you, if:
+
+(a) you fail to comply with the terms of this Licence; and/or
+
+(b) you directly or indirectly commence any action for patent or intellectual property right infringement against XMOS, or any parent, group, affiliate or subsidiary of XMOS; provided XMOS did not first commence an action or patent infringement against you in that instance; and/or
+
+(c) the terms of this Licence are held by any court of competent jurisdiction to be unenforceable in whole or in part.
+
+**9. Critical Applications.**  Unless XMOS has agreed in writing with you an agreement specifically governing use of the Goods in military, aerospace, automotive or medically related functions (collectively and individually hereinafter referred to as "Special Use"), any permitted use of the Software excludes Special Use. Notwithstanding any agreement between XMOS and you for Special Use, Special Use shall be at your own risk, and you shall fully indemnify XMOS against any damages, losses, costs and claims (direct and indirect) arising out of any Special Use.
+
+**10. NO WARRANTY OR SUPPORT.**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL XMOS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, WARRANTY, CIVIL TORT (INCLUDING NEGLIGENCE), PRODUCTS LIABILITY OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE INCLUDING GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES EVEN IF SUCH PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES AND NOT WITHSTANDING THE FAILURE OF ESSENTIAL PURPOSE.  IN SOME JURISDICTIONS PARTIES ARE UNABLE TO LIMIT LIABILTY IN THIS WAY, IF THIS APPLIES TO YOUR JURISDICTION THIS LIABILITY CLAUSE ABOVE MAY NOT APPLY.  NOTWITHSTANDING THE ABOVE, IN NO EVENT SHALL XMOS’s TOTAL LIABILITY TO YOU FOR ALL DAMAGES, LOSS OR OTHERWISE EXCEED $50.
+
+**11. Governing Law and Jurisdiction.**  This Licence constitutes the entire agreement between the parties with respect to the subject matter hereof. The Licence shall be governed by the laws of England and the conflict of laws and UN Convention on Contracts for the International Sale of Goods, shall not apply.

lib_xua/LICENSE.txt

@@ -1,135 +0,0 @@
-Software Release License Agreement
-
-Copyright (c) 2017-2020, XMOS, All rights reserved.
-
-BY ACCESSING, USING, INSTALLING OR DOWNLOADING THE XMOS SOFTWARE, YOU AGREE TO BE BOUND BY THE FOLLOWING TERMS. IF YOU DO NOT AGREE TO THESE, DO NOT ATTEMPT TO DOWNLOAD, ACCESS OR USE THE XMOS Software.
-
-Parties:
-
-(1) XMOS Limited, incorporated and registered in England and Wales with company number 5494985 whose registered office is 107 Cheapside, London, EC2V 6DN (XMOS).
-
-(2)  An individual or legal entity exercising permissions granted by this License (Customer).
-
-If you are entering into this Agreement on behalf of another legal entity such as a company, partnership, university, college etc. (for example, as an employee, student or consultant), you warrant that you have authority to bind that entity.
-
-1. Definitions
-
-"License" means this Software License and any schedules or annexes to it.
-
-"License Fee" means the fee for the XMOS Software as detailed in any schedules or annexes to this Software License
-
-"Licensee Modifications" means all developments and modifications of the XMOS Software developed independently by the Customer.
-
-"XMOS Modifications" means all developments and modifications of the XMOS Software developed or co-developed by XMOS.
-
-"XMOS Hardware" means any XMOS hardware devices supplied by XMOS from time to time and/or the particular XMOS devices detailed in any schedules or annexes to this Software License.
-
-"XMOS Software" comprises the XMOS owned circuit designs, schematics, source code, object code, reference designs, (including related programmer comments and documentation, if any), error corrections, improvements, modifications (including XMOS Modifications) and updates.
-
-The headings in this License do not affect its interpretation. Save where the context otherwise requires, references to clauses and schedules are to clauses and schedules of this License.
-
-Unless the context otherwise requires:
-
-- references to XMOS and the Customer include their permitted successors and assigns; 
-- references to statutory provisions include those statutory provisions as amended or re-enacted; and
-- references to any gender include all genders.
-
-Words in the singular include the plural and in the plural include the singular.
-
-2. License
-
-XMOS grants the Customer a non-exclusive license to use, develop, modify and distribute the XMOS Software with, or for the purpose of being used with, XMOS Hardware.
-
-Open Source Software (OSS) must be used and dealt with in accordance with any license terms under which OSS is distributed.
-
-3. Consideration
-
-In consideration of the mutual obligations contained in this License, the parties agree to its terms.
-
-4. Term
-
-Subject to clause 12 below, this License shall be perpetual.
-
-5. Restrictions on Use
-
-The Customer will adhere to all applicable import and export laws and regulations of the country in which it resides and of the United States and United Kingdom, without limitation. The Customer agrees that it is its responsibility to obtain copies of and to familiarise itself fully with these laws and regulations to avoid violation.
-
-6. Modifications
-
-The Customer will own all intellectual property rights in the Licensee Modifications but will undertake to provide XMOS with any fixes made to correct any bugs found in the XMOS Software on a non-exclusive, perpetual and royalty free license basis.
-
-XMOS will own all intellectual property rights in the XMOS Modifications. 
-The Customer may only use the Licensee Modifications and XMOS Modifications on, or in relation to, XMOS Hardware.
-
-7. Support
-
-Support of the XMOS Software may be provided by XMOS pursuant to a separate support agreement. 
-
-8. Warranty and Disclaimer
-
-The XMOS Software is provided "AS IS" without a warranty of any kind. XMOS and its licensors' entire liability and Customer's exclusive remedy under this warranty to be determined in XMOS's sole and absolute discretion, will be either (a) the corrections of defects in media or replacement of the media, or (b) the refund of the license fee paid (if any).
-
-Whilst XMOS gives the Customer the ability to load their own software and applications onto XMOS devices, the security of such software and applications when on the XMOS devices is the Customer's own responsibility and any breach of security shall not be deemed a defect or failure of the hardware. XMOS shall have no liability whatsoever in relation to any costs, damages or other losses Customer may incur as a result of any breaches of security in relation to your software or applications.
-
-XMOS AND ITS LICENSORS DISCLAIM ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY/ SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT EXCEPT TO THE EXTENT THAT THESE DISCLAIMERS ARE HELD TO BE LEGALLY INVALID UNDER APPLICABLE LAW.
-
-9. High Risk Activities
-
-The XMOS Software is not designed or intended for use in conjunction with on-line control equipment in hazardous environments requiring fail-safe performance, including without limitation the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, life support machines, or weapons systems (collectively "High Risk Activities") in which the failure of the XMOS Software could lead directly to death, personal injury, or severe physical or environmental damage. XMOS and its licensors specifically disclaim any express or implied warranties relating to use of the XMOS Software in connection with High Risk Activities.
-
-10. Liability
-
-TO THE EXTENT NOT PROHIBITED BY APPLICABLE LAW, NEITHER XMOS NOR ITS LICENSORS SHALL BE LIABLE FOR ANY LOST REVENUE, BUSINESS, PROFIT, CONTRACTS OR DATA, ADMINISTRATIVE OR OVERHEAD EXPENSES, OR FOR SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES HOWEVER CAUSED AND REGARDLESS OF THEORY OF LIABILITY ARISING OUT OF THIS LICENSE, EVEN IF XMOS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. In no event shall XMOS's liability to the Customer whether in contract, tort (including negligence), or otherwise exceed the License Fee.
-
-Customer agrees to indemnify, hold harmless, and defend XMOS and its licensors from and against any claims or lawsuits, including attorneys' fees and any other liabilities, demands, proceedings, damages, losses, costs, expenses fines and charges which are made or brought against or incurred by XMOS as a result of your use or distribution of the Licensee Modifications or your use or distribution of XMOS Software, or any development of it, other than in accordance with the terms of this License.
-
-11. Ownership
-
-The copyrights and all other intellectual and industrial property rights for the protection of information with respect to the XMOS Software (including the methods and techniques on which they are based) are retained by XMOS and/or its licensors. Nothing in this Agreement serves to transfer such rights. Customer may not sell, mortgage, underlet, sublease, sublicense, lend or transfer possession of the XMOS Software in any way whatsoever to any third party who is not bound by this Agreement.
-
-12. Termination
-
-Either party may terminate this License at any time on written notice to the other if the other:
-
-- is in material or persistent breach of any of the terms of this License and either that breach is incapable of remedy, or the other party fails to remedy that breach within 30 days after receiving written notice requiring it to remedy that breach; or
-
-- is unable to pay its debts (within the meaning of section 123 of the Insolvency Act 1986), or becomes insolvent, or is subject to an order or a resolution for its liquidation, administration, winding-up or dissolution (otherwise than for the purposes of a solvent amalgamation or reconstruction), or has an administrative or other receiver, manager, trustee, liquidator, administrator or similar officer appointed over all or any substantial part of its assets, or enters into or proposes any composition or arrangement with its creditors generally, or is subject to any analogous event or proceeding in any applicable jurisdiction.
-
-Termination by either party in accordance with the rights contained in clause 12 shall be without prejudice to any other rights or remedies of that party accrued prior to termination.
-
-On termination for any reason:
-
-- all rights granted to the Customer under this License shall cease;
-- the Customer shall cease all activities authorised by this License;
-- the Customer shall immediately pay any sums due to XMOS under this License; and
-- the Customer shall immediately destroy or return to the XMOS (at the XMOS's option) all copies of the XMOS Software then in its possession, custody or control and, in the case of destruction, certify to XMOS that it has done so.
-
-Clauses 5, 8, 9, 10 and 11 shall survive any effective termination of this Agreement.
-
-13. Third party rights
-
-No term of this License is intended to confer a benefit on, or to be enforceable by, any person who is not a party to this license.
-
-14. Confidentiality and publicity
-
-Each party shall, during the term of this License and thereafter, keep confidential all, and shall not use for its own purposes nor without the prior written consent of the other disclose to any third party any, information of a confidential nature (including, without limitation, trade secrets and information of commercial value) which may become known to such party from the other party and which relates to the other party, unless such information is public knowledge or already known to such party at the time of disclosure, or subsequently becomes public knowledge other than by breach of this license, or subsequently comes lawfully into the possession of such party from a third party.
-
-The terms of this license are confidential and may not be disclosed by the Customer without the prior written consent of XMOS.
-The provisions of clause 14 shall remain in full force and effect notwithstanding termination of this license for any reason.
-
-15. Entire agreement
-
-This License and the documents annexed as appendices to this License or otherwise referred to herein contain the whole agreement between the parties relating to the subject matter hereof and supersede all prior agreements, arrangements and understandings between the parties relating to that subject matter.
-
-16. Assignment
-
-The Customer shall not assign this License or any of the rights granted under it without XMOS's prior written consent.
-
-17. Governing law and jurisdiction
-
-This License shall be governed by and construed in accordance with English law and each party hereby submits to the non-exclusive jurisdiction of the English courts.
-
-This License has been entered into on the date stated at the beginning of it.
-
-Schedule
-XMOS lib_xua software

lib_xua/api/xua.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #ifndef __XUA_H__
 #define __XUA_H__

lib_xua/api/xua_audiohub.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2011-2018, XMOS Ltd, All rights reserved
+// Copyright 2011-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef __XUA_AUDIOHUB_H__
 #define __XUA_AUDIOHUB_H__
 

lib_xua/api/xua_buffer.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2011-2019, XMOS Ltd, All rights reserved
+// Copyright 2011-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef __XUA_BUFFER_H__
 #define __XUA_BUFFER_H__
 

lib_xua/api/xua_conf_default.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2011-2020, XMOS Ltd, All rights reserved
+// Copyright 2011-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 /*
  * @brief       Defines relating to device configuration and customisation of lib_xua
  * @author      Ross Owen, XMOS Limited
@@ -82,7 +83,7 @@
 /**
  * @brief Number of DSD output channels. Default: 0 (disabled)
  */
-#if defined(DSD_CHANS_DAC)
+#if defined(DSD_CHANS_DAC) && (DSD_CHANS_DAC != 0)
     #if defined(NATIVE_DSD) && (NATIVE_DSD == 0)
         #undef NATIVE_DSD
     #else
@@ -526,21 +527,21 @@
  * @brief Device firmware version number in Binary Coded Decimal format: 0xJJMN where JJ: major, M: minor, N: sub-minor version number.
  */
 #ifndef BCD_DEVICE_J
-#define BCD_DEVICE_J             (0)
+#define BCD_DEVICE_J             (1)
 #endif
 
 /**
  * @brief Device firmware version number in Binary Coded Decimal format: 0xJJMN where JJ: major, M: minor, N: sub-minor version number.
  */
 #ifndef BCD_DEVICE_M
-#define BCD_DEVICE_M             (1)
+#define BCD_DEVICE_M             (2)
 #endif
 
 /**
  * @brief Device firmware version number in Binary Coded Decimal format: 0xJJMN where JJ: major, M: minor, N: sub-minor version number.
  */
 #ifndef BCD_DEVICE_N
-#define BCD_DEVICE_N             (1)       
+#define BCD_DEVICE_N             (0)
 #endif
 
 /**
@@ -1139,38 +1140,11 @@
 #endif
 #endif
 
-/* IAP */
-#if defined(IAP) && (IAP == 0)
-#undef IAP
+/* Always enable explicit feedback EP, even when input stream is present */
+#ifndef UAC_FORCE_FEEDBACK_EP
+#define UAC_FORCE_FEEDBACK_EP       (1)
 #endif
 
-/* IAP Interrupt endpoint */
-#if defined(IAP_INT_EP) && (IAP_INT_EP == 0)
-#undef IAP_INT_EP
-#endif
-
-/* IAP EA Native Transport */
-#if defined(IAP_EA_NATIVE_TRANS) && (IAP_EA_NATIVE_TRANS == 0)
-#undef IAP_EA_NATIVE_TRANS
-#endif
-
-#if defined(IAP_EA_NATIVE_TRANS) || defined(__DOXYGEN__)
-/**
- * @brief Number of supported EA Native Interface Alternative settings.
- *
- * Only 1 supported
- */
-#ifndef IAP_EA_NATIVE_TRANS_ALT_COUNT
-    #define IAP_EA_NATIVE_TRANS_ALT_COUNT 1
-#endif
-
-#if (IAP_EA_NATIVE_TRANS_ALT_COUNT > 1)
-    /* Only 1 supported */
-    #error
-#endif
-#endif
-
-
 #if (defined(UAC_FORCE_FEEDBACK_EP) && UAC_FORCE_FEEDBACK_EP == 0)
 #undef UAC_FORCE_FEEDBACK_EP
 #endif
@@ -1243,10 +1217,6 @@ enum USBEndpointNumber_Out
 
 #define MAX_VOL                  (0x20000000)
 
-#if defined(SU1_ADC_ENABLE) && (SU1_ADC_ENABLE == 0)
-#undef SU1_ADC_ENABLE
-#endif
-
 #if defined(LEVEL_METER_LEDS) && !defined(LEVEL_UPDATE_RATE)
 #define LEVEL_UPDATE_RATE   400000
 #endif

lib_xua/api/xua_conf_full.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2018, XMOS Ltd, All rights reserved
+// Copyright 2017-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #ifndef __XUA_CONF_FULL_H__
 #define __XUA_CONF_FULL_H__
 
@@ -8,6 +9,4 @@
 
 #include "xua_conf_default.h"
 
-
-
 #endif

lib_xua/api/xua_endpoint0.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2011-2020, XMOS Ltd, All rights reserved
+// Copyright 2011-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #ifndef _XUA_ENDPOINT0_H_
 #define _XUA_ENDPOINT0_H_
@@ -14,7 +15,10 @@
  *  \param c_ep0_out Chanend connected to the XUD_Manager() out endpoint array
  *  \param c_ep0_in Chanend connected to the XUD_Manager() in endpoint array
  *  \param c_audioCtrl Chanend connected to the decouple thread for control
- *                     audio (sample rate changes etc.)
+ *                     audio (sample rate changes etc.). Note when nulled, the
+ *                    audio device only supports single sample rate/format and
+ *                    DFU is not supported either since this channel is used
+ *                    to carry messages about format, rate and DFU state
  *  \param c_mix_ctl Optional chanend to be connected to the mixer thread if
  *                   present
  *  \param c_clk_ctl Optional chanend to be connected to the clockgen thread if
@@ -24,7 +28,7 @@
  *  \param c_EANativeTransport_ctrl Optional chanend to be connected to EA Native
  *                                  endpoint manager if present
  */
-void XUA_Endpoint0(chanend c_ep0_out, chanend c_ep0_in, chanend c_audioCtrl,
+void XUA_Endpoint0(chanend c_ep0_out, chanend c_ep0_in, chanend ?c_audioCtrl,
         chanend ?c_mix_ctl,chanend ?c_clk_ctl, chanend ?c_EANativeTransport_ctr, client interface i_dfu ?dfuInterface
          VENDOR_REQUESTS_PARAMS_DEC_);
 

lib_xua/api/xua_pdm_mic.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2015-2018, XMOS Ltd, All rights reserved
+// Copyright 2015-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #ifndef XUA_PDM_MIC_H
 #define XUA_PDM_MIC_H

lib_xua/api/xua_usb_params_funcs.h

@@ -1,4 +1,5 @@
-// Copyright (c) 2017-2020, XMOS Ltd, All rights reserved
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #ifndef __XUA_API_H__
 #define __XUA_API_H__

lib_xua/doc/rst/lib_xua.rst

@@ -36,4 +36,3 @@ Older versions of Windows are not guaranteed to operate as expected. Devices are
 
 
 
-.. include:: ../../../CHANGELOG.rst

lib_xua/doc/rst/sw_spdif_rx.rst

@@ -55,7 +55,7 @@ audio driver and handles locking to the S/PDIF clock source if required (see Ext
 Ideally the parity of each word/sample received should be checked.  This is done using the built in 
 ``crc32`` function (see ``xs1.h``):
 
-.. literalinclude:: sc_usb_audio/module_usb_audio/clocking/clockgen.xc
+.. literalinclude:: lib_xua/src/core/clocking/clockgen.xc
   :start-after: //:badParity
   :end-before: //:
 

lib_xua/doc/rst/xdoc.conf

@@ -1,2 +1,5 @@
-XMOSNEWSTYLE = 1
+XMOSNEWSTYLE = 2
 DOXYGEN_DIRS=../../api
+SOURCE_INCLUDE_DIRS=../../../lib_xua
+SPHINX_MASTER_DOC=lib_xua
+

lib_xua/host/xmosdfu/Makefile.Linux32

@@ -1,2 +1,3 @@
 all:
-	g++ -m32 -Wall -g -o xmosdfu xmosdfu.cpp -Ilibusb/Linux32 -lusb-1.0
+	mkdir -p bin
+	g++ -m32 -Wall -g -o bin/xmosdfu xmosdfu.cpp -Ilibusb/Linux32 -lusb-1.0

lib_xua/host/xmosdfu/Makefile.Linux64

@@ -1,2 +1,3 @@
 all:
-	g++ -Wall -g -o xmosdfu xmosdfu.cpp -Ilibusb/Linux32 -lusb-1.0
+	mkdir -p bin
+	g++ -Wall -g -o bin/xmosdfu xmosdfu.cpp -Ilibusb/Linux32 -lusb-1.0

lib_xua/host/xmosdfu/Makefile.OSX32

@@ -1,2 +1,3 @@
 all:
-	g++ -g -o xmosdfu xmosdfu.cpp -Ilibusb/OSX32 libusb/OSX32/libusb-1.0.0.dylib -m32 -Wall
+	mkdir -p bin
+	g++ -g -o bin/xmosdfu xmosdfu.cpp -Ilibusb/OSX32 libusb/OSX32/libusb-1.0.0.dylib -m32 -Wall

lib_xua/host/xmosdfu/Makefile.OSX64

@@ -1,2 +1,3 @@
 all:
-	g++ -g -o xmosdfu xmosdfu.cpp -Ilibusb/OSX64 libusb/OSX64/libusb-1.0.0.dylib -Wall
+	mkdir -p bin
+	g++ -g -o bin/xmosdfu xmosdfu.cpp -Ilibusb/OSX64 libusb/OSX64/libusb-1.0.0.dylib -Wall

lib_xua/host/xmosdfu/Makefile.Pi

@@ -5,4 +5,5 @@
 # vendor and product IDs
 
 xmosdfu: xmosdfu.cpp
-	g++ -D_GNU_SOURCE -Wall -g -o xmosdfu -Ilibusb/Rasp -lusb-1.0 -x c xmosdfu.cpp -std=c99
+	mkdir -p bin
+	g++ -D_GNU_SOURCE -Wall -g -o bin/xmosdfu -Ilibusb/Rasp -lusb-1.0 -x c xmosdfu.cpp -std=c99

lib_xua/host/xmosdfu/Makefile.Win32

@@ -0,0 +1,31 @@
+# Build tested with Visual Studio 2017 command prompt
+#
+# Run: nmake /f Makefile.Win32
+#
+# NOTE: To run xmosdfu on Windows, libusbK drivers must be installed on the DFU endpoint
+# We recommend using the third-party Zadig tool for this.
+
+COMMON_FLAGS = \
+	/D BECLEAR_HOST=1 \
+	/I libusb\Win32 \
+	/nologo \
+	/W4 \
+	/WX- \
+	/O2 \
+	/EHa \
+	/D _CRT_SECURE_NO_WARNINGS \
+	xmosdfu.cpp \
+
+all: xmosdfu
+
+xmosdfu:
+	if not exist bin mkdir bin
+	CL.exe \
+	$(COMMON_FLAGS) \
+	/Fe"bin\xmosdfu.exe" \
+	/link "libusb\Win32\libusb-1.0.lib""
+	copy libusb-1.0.dll bin
+	del *.obj
+
+clean:
+	rmdir /s /q bin