From 6a879ec52b01e980f23a15a30d66f20f88dbd9ed Mon Sep 17 00:00:00 2001 From: xross Date: Tue, 3 Apr 2018 12:05:35 +0100 Subject: [PATCH] =?UTF-8?q?Added=20=E2=80=9Cconfiguring=20lib=5Fxua?= =?UTF-8?q?=E2=80=9D=20section=20to=20AN00247=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../doc/rst/AN00247.rst | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/examples/AN00247_xua_example_spdif_tx/doc/rst/AN00247.rst b/examples/AN00247_xua_example_spdif_tx/doc/rst/AN00247.rst index e0929818..24c23b14 100644 --- a/examples/AN00247_xua_example_spdif_tx/doc/rst/AN00247.rst +++ b/examples/AN00247_xua_example_spdif_tx/doc/rst/AN00247.rst @@ -135,6 +135,28 @@ These are declared as follows: :start-on: /* Endpoint type tables :end-on: XUD_EpType epTypeTableIn +Configuring lib_xua +------------------- + +S/PDIF Tx functionality must be ``lib_xua`` + +``lib_xua`` has many parameters than can be configured at build time, some examples include: + + - Sample-rates + - Channel counts + - Audio Class version + - Product/Vendor ID's + - Various product strings + - Master clock frequency + +To enable S/PDIF funtionality ``XUA_SPDIF_TX_EN`` must be set to a non-zero value. + +These parameters are set via defines in an optional ``xua_conf.h`` header file. For this simple application the +complete contents of this file are as follows: + +.. literalinclude:: xua_conf.h + :start-on: // Copyright + :end-on: #endif The application main() function -------------------------------