Merge pull request #249 from xmos/release/v2.0.0

Merge release/v2.0.0 into master
xmos · Jul 22, 2021 · d93f900 · d93f900
2 parents 1312e5c + 08cf1f2
commit d93f900
Show file tree

Hide file tree

Showing 292 changed files with 11,903 additions and 14,291 deletions.
diff --git a/.gitignore b/.gitignore
@@ -22,8 +22,15 @@ test_results.csv
 .DS_Store
 _README/**
 **/pdf/**
+**/.venv/**
 *.doctree
 sphinx.output
 Installs/
 .settings
-**/.venv/**
+tests/bin.txt
+tests/log
+tests/test_**/**test_xs2.xn
+tests/test_**/**test_xs3_600.xn
+tests/test_**/**test_xs3_800.xn
+**/venv/**
+*.gtkw
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,17 @@
 lib_xud Change Log
 ==================
 
+2.0.0
+-----
+
+  * ADDED:      Initial support for XS3A based devices
+  * ADDED:      Requirement to define XUD_CORE_CLOCK with xcore core clock speed
+    in MHz
+  * CHANGE:     Removed support for XS1-G, and XS1-L (including U series) based
+    devices
+  * RESOLVED:   Exception when Endpoint marked as disabled
+  * CHANGE:     Use common XN files for tests
+
 1.2.0
 -----
 

diff --git a/Jenkinsfile b/Jenkinsfile
@@ -4,11 +4,11 @@ getApproval()
 
 pipeline {
   agent {
-    label 'x86_64&&brew&&macOS'
+    label 'x86_64 && brew && macOS'
   }
   environment {
     REPO = 'lib_xud'
-    VIEW = "${env.JOB_NAME.contains('PR-') ? REPO+'_'+env.CHANGE_TARGET : REPO+'_'+env.BRANCH_NAME}"
+    VIEW = getViewName(REPO)
   }
   options {
     skipDefaultCheckout()

diff --git a/README.rst b/README.rst
@@ -11,7 +11,7 @@ that allows you to control an USB bus via xCORE ports.
 
 The library provides functionality to act as a USB *device* only.
 
-This library is aimed primarily for use with xCORE-200 Series or xCORE U-Series devices but it does also support xCORE L-Series devices with the addition of an external USB PHY device.
+This library is for use with xCORE-200 Series or xCORE-AI series devices only, previous generations of xCORE devices are no longer supported.
 
 Features
 ........
@@ -20,6 +20,12 @@ Features
  * Device mode
  * Bulk, control, interrupt and isochronous endpoint types supported
 
+Known Issues
+............
+
+  * Operation on XS3 based devices only supported at 700MHz
+  * SOF tokens are not CRC checked on XS3 based devices (see tests/test_sof_badcrc)
+
 Software version and dependencies
 .................................
 

diff --git a/__app_test/.cproject b/__app_test/.cproject
diff --git a/__app_test/.project b/__app_test/.project
diff --git a/__app_test/.xproject b/__app_test/.xproject
diff --git a/__app_test/Makefile b/__app_test/Makefile
diff --git a/__app_test/README b/__app_test/README
diff --git a/__app_test/README.rst b/__app_test/README.rst