Merge pull request #271 from xross/release/v2.0.1

Release/v2.0.1

.gitignore

@@ -30,6 +30,8 @@ Installs/
 tests/bin.txt
 tests/log
 tests/test_**/**test_xs2.xn
+tests/test_**/**test_xs3_500.xn
+tests/test_**/**test_xs3_540.xn
 tests/test_**/**test_xs3_600.xn
 tests/test_**/**test_xs3_800.xn
 **/venv/**

CHANGELOG.rst

@@ -1,27 +1,38 @@
 lib_xud Change Log
 ==================
 
+2.0.1
+-----
+
+  * CHANGE:     Shared test code moved to test_support repo
+  * CHANGE:     Clock-blocks 4 & 5 now used (was 2 & 3)
+  * CHANGE:     Most differences required to support different architectures are
+    now handled in a Hardware Abstraction Layer
+  * RESOLVED:   Intermittent enumeration issues at full-speed on XS3A based
+    devices (#259)
+
 2.0.0
 -----
 
   * ADDED:      Initial support for XS3A based devices
-  * ADDED:      Requirement to define XUD_CORE_CLOCK with xcore core clock speed
+  * 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
+  * RESOLVED:   A halted endpoint does not issue a STALL when PINGed (#59)
+  * RESOLVED:   A halted endpoint does not issue a STALL if the endpoint is
+    marked ready (#58)
 
 1.2.0
 -----
 
-  * CHANGED: Use XMOS Public Licence Version 1
+  * CHANGE:     Use XMOS Public Licence Version 1
 
 1.1.2
 -----
 
-  * CHANGED: Pin Python package versions
-  * REMOVED: not necessary cpanfile
+  * CHANGE:     Python package pinned to versions
 
 1.1.1
 -----
@@ -38,7 +49,7 @@ lib_xud Change Log
 1.0.0
 -----
 
-  * CHANGE:     Version for first major release.
+  * CHANGE:     First major release.
 
 0.2.0
 -----

README.rst

@@ -23,8 +23,8 @@ Features
 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)
+  * Documentation not updated for removal of XS1 and addition of XS3 based devices
 
 Software version and dependencies
 .................................

examples/AN00129_hid_class/Makefile

@@ -14,7 +14,7 @@ APP_NAME = app_hid_mouse_demo
 
 # These flags define two build configurations - one for xCORE-200 and one for
 # the xCORE.AI series.
-BUILD_FLAGS = -O3 -report
+BUILD_FLAGS = -O3 -report -fxscope
 
 XCC_FLAGS_200 = $(BUILD_FLAGS) -DXUD_CORE_CLOCK=500
 XCC_FLAGS_AI = $(BUILD_FLAGS) -DXUD_CORE_CLOCK=600

lib_xud/module_build_info

@@ -1,4 +1,4 @@
-VERSION = 2.0.0
+VERSION = 2.0.1
 
 MODULE_XCC_FLAGS = $(XCC_FLAGS) \
                    -O3 \

lib_xud/src/core/XUD_HAL.h

@@ -13,7 +13,7 @@
 
 #ifdef __XS3A__
 #include <xs3a_registers.h>
-// TODO should be properlty in HAL
+// TODO should be properly in HAL
 unsigned XtlSelFromMhz(unsigned m);
 #else
 #include "XUD_USBTile_Support.h"
@@ -23,27 +23,32 @@ unsigned XtlSelFromMhz(unsigned m);
 
 /** 
  * \enum    XUD_LineState_t
- * \brief   USB Line States 
+ * \brief   USB Line States
  */
 typedef enum XUD_LineState_t 
 {
     XUD_LINESTATE_SE0 = 0,      /**< SE0 State */
-    XUD_LINESTATE_J = 1,        /**< J State */
-    XUD_LINESTATE_K = 2,        /**< K State */
-    XUD_LINESTATE_SE1 = 3       /**< Invalid bus state both lines high **/
+    XUD_LINESTATE_HS_J_FS_K = 1,/**< J/K State */
+    XUD_LINESTATE_HS_K_FS_J = 2,/**< K/J State */
+    XUD_LINESTATE_SE1 = 3       /**< Invalid bus state - both lines high **/
 } XUD_LineState_t;
 
 void XUD_HAL_EnterMode_PeripheralChirp();
 void XUD_HAL_EnterMode_PeripheralFullSpeed();
 void XUD_HAL_EnterMode_PeripheralHighSpeed();
+#ifdef __XS2A__
+/* Special case for __XS2A__ where writing to USB register is relatively slow */
+void XUD_HAL_EnterMode_PeripheralHighSpeed_Start();
+void XUD_HAL_EnterMode_PeripheralHighSpeed_Complete();
+#endif
 void XUD_HAL_EnterMode_PeripheralTestJTestK();
 void XUD_HAL_EnterMode_TristateDrivers();
 
 /**
  * \brief   Get current linestate status 
  * \return  XUD_LineState_t representing current line status 
 **/
-XUD_LineState_t XUD_HAL_GetLineState(/*XUD_HAL_t &xudHal*/);
+XUD_LineState_t XUD_HAL_GetLineState();
 
 /**
  * \brief   Wait for a change in linestate and return, or timeout
@@ -58,7 +63,7 @@ unsigned XUD_HAL_WaitForLineStateChange(XUD_LineState_t &currentLs, unsigned tim
  *
  * TODO     Should this be combined with EnterMode_PeripheralChirp()?     
  **/
-void XUD_HAL_Mode_PowerSig();
+void XUD_HAL_Mode_Signalling();
 
 /**
  *  \brief   HAL function to set xCORE into data transfer mode