Merge pull request #100 from xmos/develop

Prepare release v3.5.0
xmos · Feb 9, 2024 · 10bb117 · 10bb117
2 parents d1ba6e0 + 0ecba51
commit 10bb117
Show file tree

Hide file tree

Showing 26 changed files with 1,537 additions and 723 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,11 @@
 IO Framework change log
 =======================
 
+3.5.0
+-----
+
+  * ADDED: I2S now supports 16b data widths
+
 3.4.0
 -----
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -24,8 +24,8 @@ if(PROJECT_IS_TOP_LEVEL)
     include(tools/ci/fetch_ci_deps.cmake)
 endif()
 
-add_subdirectory(modules)
-
 if(FWK_IO_TESTS)
     include(test/tests.cmake)
 endif()
+
+add_subdirectory(modules)
diff --git a/doc/programming_guide/reference/i2s/i2s_common.rst b/doc/programming_guide/reference/i2s/i2s_common.rst
@@ -6,6 +6,12 @@
 |I2S| Instances
 ===============
 
+The macro I2S_DATA_WIDTH may be set as a compile flag (e.g. 
+-DI2S_DATA_WIDTH=16) to alter the number of bits per word for both the |I2S| 
+Master and |I2S| Slave components; this defaults to 32 bits per word. This 
+value may be set to any value between 1 and 32. Correct operation of the |I2S| 
+components has only currently been verified at 16 and 32 bits per word.
+
 The following structures and functions are used by an |I2S| master or slave instance.
 
 .. doxygengroup:: hil_i2s_core

diff --git a/modules/i2s/CMakeLists.txt b/modules/i2s/CMakeLists.txt
@@ -27,21 +27,19 @@ if((${CMAKE_SYSTEM_NAME} STREQUAL XCORE_XS3A) OR (${CMAKE_SYSTEM_NAME} STREQUAL
     list(APPEND LIB_PRIVATE_SOURCES ${${CMAKE_SYSTEM_NAME}_SOURCES})
 
     ## Create library target
-    add_library(lib_i2s STATIC)
+    add_library(lib_i2s INTERFACE)
     target_sources(lib_i2s
-        PUBLIC
+        INTERFACE
             ${LIB_PUBLIC_SOURCES}
-        PRIVATE
             ${LIB_PRIVATE_SOURCES}
     )
     target_include_directories(lib_i2s
-        PUBLIC
+        INTERFACE
             ${LIB_PUBLIC_INCLUDES}
-        PRIVATE
             ${LIB_PRIVATE_INCLUDES}
     )
     target_compile_options(lib_i2s
-        PRIVATE
+        INTERFACE
             ${LIB_COMPILE_FLAGS}
     )
 endif()
diff --git a/modules/i2s/api/i2s.h b/modules/i2s/api/i2s.h
@@ -13,6 +13,7 @@
  * \addtogroup hil_i2s_core hil_i2s_core
  *
  * The public API for using the HIL I2S core.
+ * 
  * @{
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,7 @@ @@
      * \addtogroup hil_i2s_core hil_i2s_core
      *
      * The public API for using the HIL I2S core.
+     *
      * @{
      */
@@ Expand Down @@