Merge pull request #11 from xmos/release/v1.1.0

Release/v1.1.0
xmos · Feb 19, 2024 · 76f6cd5 · 76f6cd5
2 parents 05f8c3c + 35e9f44
commit 76f6cd5
Show file tree

Hide file tree

Showing 21 changed files with 45 additions and 95 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,10 +1,10 @@
-lib_adat Change Log
-===================
+ADAT library change log
+=======================
 
-UNRELEASED
-----------
+1.1.0
+-----
 
-  * ADDED:     Support for XCommon CMake build system
+  * ADDED: Support for XCommon CMake build system
 
 1.0.1
 -----

diff --git a/README.rst b/README.rst
@@ -1,7 +1,7 @@
 ADAT Lightpipe Digital Audio Interface
 ######################################
 
-:Latest release: 1.0.1
+:Latest release: 1.1.0
 
 
 :scope: General Use
@@ -32,7 +32,7 @@ Known Issues
 
 * This software relies on the reference clock being 100 MHz, there is no out of the box version for non 100 Mhz reference clocks.
 
-* ADAT Tx for 256x master clock (i.e. 48kHz from 12.288MHz master clock) not yet implemented  
+* ADAT Tx for 256x master clock (i.e. 48kHz from 12.288MHz master clock) not yet implemented
 
 Required software (dependencies)
 ================================

diff --git a/__generator_rx/adat.c b/__generator_rx/adat.c
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #include <stdio.h>
 #include <stdlib.h>
 #include <math.h>

diff --git a/__generator_rx/adatReceiver-100.xc b/__generator_rx/adatReceiver-100.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 // GENERATED CODE - DO NOT EDIT
 // Comments are in the generator
 // Generated for devices with a reference clock of 100.000000 Mhz

diff --git a/__generator_rx/adatReceiver-99.9375.xc b/__generator_rx/adatReceiver-99.9375.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 // GENERATED CODE - DO NOT EDIT
 // Comments are in the generator
 // Generated for devices with a reference clock of  99.937500 Mhz

diff --git a/examples/app_adat_loopback/src/main.xc b/examples/app_adat_loopback/src/main.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 // Example code for ADAT. Note that the adat_tx code can be changed to drive a port
 // directly
 

diff --git a/examples/app_adat_rx_example/src/main.xc b/examples/app_adat_rx_example/src/main.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 //::declaration
 #include <xs1.h>
 #include "adat_rx.h"

diff --git a/examples/app_adat_tx_direct_example/src/main.xc b/examples/app_adat_tx_direct_example/src/main.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #include <xs1.h>
 #include <xclib.h>
 #include <print.h>

diff --git a/examples/app_adat_tx_example/src/main.xc b/examples/app_adat_tx_example/src/main.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #include <xs1.h>
 #include <xclib.h>
 #include <print.h>

diff --git a/lib_adat/api/adat_rx.h b/lib_adat/api/adat_rx.h
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 /** ADAT Receive Thread (48kHz sample rate).
  *

diff --git a/lib_adat/api/adat_tx.h b/lib_adat/api/adat_tx.h
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 /* usage:
         buffered out port:32 adat_port;
         in port mck;

diff --git a/lib_adat/doc/rst/lib_adat.rst b/lib_adat/doc/rst/lib_adat.rst
@@ -1,7 +1,7 @@
 
 .. include:: ../../../README.rst
 
-ADAT software
+ADAT Software
 =============
 
 ADAT is a protocol to transmit audio
@@ -109,7 +109,7 @@ the module itself).
 API
 ---
 
-Compile time defines
+Compile Time Defines
 ~~~~~~~~~~~~~~~~~~~~
 
 *ADAT_REF*
@@ -208,7 +208,7 @@ interface, and a program that uses an intermediate thread to output to the
 port.
 
 
-Example of direct port code
+Example of Direct Port Code
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The output port needs to be declared as a
@@ -244,7 +244,7 @@ should be set up:
 
 
 
-Example of ADAT with an extra thread
+Example of ADAT with an Extra Thread
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The output port needs to be declared as a

diff --git a/lib_adat/lib_build_info.cmake b/lib_adat/lib_build_info.cmake
@@ -1,5 +1,5 @@
 set(LIB_NAME lib_adat)
-set(LIB_VERSION 1.0.1)
+set(LIB_VERSION 1.1.0)
 set(LIB_INCLUDES api)
 set(LIB_DEPENDENT_MODULES "")
 set(LIB_COMPILER_FLAGS -O3)

diff --git a/lib_adat/module_build_info b/lib_adat/module_build_info
@@ -1,4 +1,4 @@
-VERSION = 1.0.1
+VERSION = 1.1.0
 
 # You can set flags specifically for your module by using the MODULE_XCC_FLAGS
 # variable. So the following
@@ -11,5 +11,3 @@ VERSION = 1.0.1
 #
 # You can also set MODULE_XCC_C_FLAGS, MODULE_XCC_XC_FLAGS etc..
 MODULE_XCC_FLAGS = $(XCC_FLAGS) -O3
-
-
diff --git a/lib_adat/src/adatReceiver-100.h b/lib_adat/src/adatReceiver-100.h
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 // GENERATED CODE - DO NOT EDIT
 // Comments are in the generator
 // Generated for devices with a reference clock of 100.000000 Mhz

diff --git a/lib_adat/src/adatReceiver-99-9375.h b/lib_adat/src/adatReceiver-99-9375.h
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 // GENERATED CODE - DO NOT EDIT
 // Comments are in the generator
 // Generated for devices with a reference clock of  99.937500 Mhz

diff --git a/lib_adat/src/adat_lookups.h b/lib_adat/src/adat_lookups.h
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 extern unsigned int  lookup40w[256];
 extern unsigned char lookup40b[256];
 extern unsigned      lookup20[256];
diff --git a/lib_adat/src/adat_lookups.xc b/lib_adat/src/adat_lookups.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #include "adat_lookups.h"
 
 unsigned int lookup40w[256] = {

diff --git a/lib_adat/src/adat_rx.xc b/lib_adat/src/adat_rx.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
 #ifndef ADAT_REF
 #define ADAT_REF 100

diff --git a/lib_adat/src/adat_tx.xc b/lib_adat/src/adat_tx.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 // history:
 // 08 Jun 2010   forked from swc_usb/module_usb_audio_shared/src/adat_tx.xc tag ADAT_FORK
 

diff --git a/lib_adat/src/adat_tx_port.xc b/lib_adat/src/adat_tx_port.xc
@@ -1,8 +1,5 @@
-// Copyright (c) 2011, XMOS Ltd, All rights reserved
-// This software is freely distributable under a derivative of the
-// University of Illinois/NCSA Open Source License posted in
-// LICENSE.txt and at <http://github.xcore.com/>
-
+// Copyright 2011-2024 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 // history:
 // 08 Jun 2010   forked from swc_usb/module_usb_audio_shared/src/adat_tx_port.xc tag ADAT_FORK