SPDIF Tx doc updates

This commit is contained in:
xross
2018-03-29 16:40:32 +01:00
parent 5ea3222e90
commit 6e6cb30aca
4 changed files with 13 additions and 20 deletions

Binary file not shown.

View File

@@ -65,12 +65,13 @@ S/PDIF Transmit
``lib_xua`` supports the development of devices with S/PDIF transmit functionality through the use of
``lib_spdif``. The XMOS S/PDIF transmitter runs in a single core and supports rates up to 192kHz.
The S/PDIF transmitter core takes PCM audio samples via a channel and outputs them
in S/PDIF format to a port. The channel should be declared a normal::
The S/PDIF transmitter core takes PCM audio samples via a channel and outputs them in S/PDIF format to a port.
Samples are provided to the S/PDIF transmitter task from the ``XUA_AudioHub()`` task.
The channel should be declared a normal::
chan c_spdif_tx
Samples are provided to the S/PDIF transmitter task from the ``XUA_AudioHub()`` task.
In order to use the S/PDIF transmmiter with ``lib_xua`` hardware resources must be declared e.g::
@@ -81,7 +82,7 @@ This port should be clocked from the master-clock, ``lib_spdif`` provides a help
spdif_tx_port_config(p_spdif_tx2, clk_audio_mclk, p_mclk_in, delay);
.. note:: If sharing the master-clock port and clockblock with ``XUA_AudioHub()`` (or any other task) then this setup
should be done before running the tasks in a par{}
should be done before running the tasks in a ``par`` statement.
Finally the S/PDIF transmitter task must be run - passing in the port and channel for communication with ``XUA_AudioHub``.
For example::

View File

@@ -9,6 +9,7 @@ This section will now examine the operation of these components in further detai
.. toctree::
sw_audio
sw_spdif
..
@@ -16,7 +17,6 @@ This section will now examine the operation of these components in further detai
sw_ep0
sw_audio
sw_mixer
sw_spdif
sw_spdif_rx
sw_adat
sw_clocking

View File

@@ -1,8 +1,8 @@
S/PDIF Transmit
---------------
...............
XMOS devices can support S/PDIF transmit up to 192kHz. The XMOS S/SPDIF transmitter component runs
in a single core and can be found in ``sc_spdif/module_spdif_tx``
``lib_xua`` supports the development of devices with S/PDIF transmit throught the use of ``lib_spdif``.
The XMOS S/SPDIF transmitter component runs in a single core and supports sample-rates upto 192kHz.
The S/PDIF transmitter core takes PCM audio samples via a channel and outputs them
in S/PDIF format to a port. A lookup table is used to encode the audio data into the required format.
@@ -24,8 +24,8 @@ clock generation (e.g. when clock source is already locked to desired audio cloc
- 44.1, 48, 88.2, 96, 176.4, 192 kHz
* - **Master clock ratios**
- 128x, 256x, 512x
* - **Module**
- ``module_spdif_tx``
* - **Library**
- ``lib_spdif``
Clocking
++++++++
@@ -60,6 +60,8 @@ The following protocol is used on the channel:
.. list-table:: S/PDIF Component Protocol
* - ``outct``
- New sample rate command
* - ``outuint``
- Sample frequency (Hz)
* - ``outuint``
@@ -76,8 +78,6 @@ The following protocol is used on the channel:
-
* - ``...``
-
* - ``outct``
- Terminate
@@ -138,11 +138,3 @@ indicates sampling frequency as shown in :ref:`usb_audio_spdif_sample_bits`.
* - 192
- E