Skip to content

Commit

Permalink
Documentation tidies only
Browse files Browse the repository at this point in the history
  • Loading branch information
@xross
xross committed Dec 10, 2024
1 parent 8c72768 commit 6b0279a
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 78 deletions.
2 changes: 1 addition & 1 deletion doc/rst/app_216_mc.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Validated build options
-----------------------

The reference design can be built in several ways by changing the build options.
These are described in :numref:`sec_xua_conf_api`.
These are described in :ref:`sec_xua_conf_api`.

The design has only been fully validated against the build options as set in the
application as distributed in the CMakeLists.txt. See :ref:`usb_audio_sec_valbuild` for details
Expand Down
16 changes: 9 additions & 7 deletions doc/rst/hw.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
|newpage|

.. _usb_audio_hardware_platforms:

****************************
Expand All @@ -10,7 +8,7 @@ This section describes the hardware development platforms supported by the `XMOS
reference design software.

+--------------------+---------------------+--------------------+---------------------+
| Board | `xcore` device | Analog Channels | Digital Rx/Tx & MIDI|
| Board | `xcore` device | Analog channels | Digital Rx/Tx & MIDI|
+====================+=====================+====================+=====================+
|XK_EVK_XU316 | `xcore.ai` | 2 in + 2 out | N/A |
+--------------------+---------------------+--------------------+---------------------+
Expand All @@ -19,9 +17,13 @@ reference design software.
|XK_AUDIO_216_MC_AB | `xcore-200` | 8 in + 8 out | Supported |
+--------------------+---------------------+--------------------+---------------------+

Each of the platforms supported has a Board Support Package (BSP), the code for which can be be found in `lib_board_support <https://www.xmos.com/file/lib_board_support>`_.
The code in ``lib_board_support`` abstracts away all of the hardware setup including enabling external hardware blocks and DAC and ADC configuration and provides a translation
layer from the common API supported by `lib_xua <https://www.xmos.com/file/lib_xua>`_ for initialising and configuring hardware on a sample rate or stream format change.
Each of the platforms supported has a Board Support Package (BSP), the code for which can be be
found in `lib_board_support <https://www.xmos.com/file/lib_board_support>`_.
The code in ``lib_board_support`` abstracts away all of the hardware setup including enabling
external hardware blocks and DAC and ADC configuration and provides a translation
layer from the common API supported by `lib_xua <https://www.xmos.com/file/lib_xua>`_ for
initialising and configuring hardware on a sample rate or stream format change.

Detailed feature sets for the each of the supported boards can be found in the `documentation for lib_board_support <https://www.xmos.com/file/lib_board_support>`_.
Detailed feature sets for the each of the supported boards can be found in the documentation for
`lib_board_support <https://www.xmos.com/file/lib_board_support>`_.

135 changes: 65 additions & 70 deletions doc/rst/overview.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,79 +4,74 @@
Overview
********


.. table::
:class: vertical-borders

+-------------------------------------------------------------------------------------------------------------------------------+
| **Functionality** |
+-------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| Provides USB interface to audio I/O. |
| |
+-------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| **Supported Standards** |
+-------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------+---------------------------------------------------------------------------------------------+
| USB | USB 2.0 (Full-speed and High-speed) |
| +---------------------------------------------------------------------------------------------+
| | `USB Audio Class 1.0 <https://www.usb.org/sites/default/files/audio10.pdf>`_ |
| +---------------------------------------------------------------------------------------------+
| | `USB Audio Class 2.0 <https://www.usb.org/sites/default/files/Audio2.0_final.zip>`_ |
| +---------------------------------------------------------------------------------------------+
| | `USB Firmware Upgrade (DFU) 1.1 <https://www.usb.org/sites/default/files/DFU_1.1.pdf>`_ |
| +---------------------------------------------------------------------------------------------+
| | `USB MIDI Device Class 1.0 <https://www.usb.org/sites/default/files/midi10.pdf>`_ |
+---------------------------------+---------------------------------------------------------------------------------------------+
| Audio | I²S/TDM |
| +---------------------------------------------------------------------------------------------+
| | S/PDIF (receive may be limited to 96kHz depending on external hardware) |
| +---------------------------------------------------------------------------------------------+
| | ADAT |
| +---------------------------------------------------------------------------------------------+
| | Direct Stream Digital (DSD) |
| +---------------------------------------------------------------------------------------------+
| | PDM Microphones |
| +---------------------------------------------------------------------------------------------+
| | MIDI |
+---------------------------------+---------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| **Supported Sample Frequencies** |
+-------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| 16kHz to 384kHz [#f1]_ |
+-------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| **Supported Devices** |
+-------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------+---------------------------------------------------------------------------------------------+
| XMOS Devices | `xcore-200` Series |
| +---------------------------------------------------------------------------------------------+
| | `xcore.ai` Series |
+---------------------------------+---------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| **Requirements** |
+-------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------+---------------------------------------------------------------------------------------------+
| Development Tools | XTC Development Tools (see readme for required version) |
+---------------------------------+---------------------------------------------------------------------------------------------+
| USB | `xcore` device with integrated USB phy |
+---------------------------------+---------------------------------------------------------------------------------------------+
| Audio | External audio DAC/ADC/CODECs (and required supporting componentry) supporting I²S/TDM |
+---------------------------------+---------------------------------------------------------------------------------------------+
| Boot/Storage | Compatible SPI/QSPI Flash device (or `xcore` device with internal flash) |
+---------------------------------+---------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| **Licensing and Support** |
+-------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| Reference code provided without charge under license from `XMOS`. |
+-------------------------------------------------------------------------------------------------------------------------------+
| Please visit http://www.xmos.com/support/contact for support. |
+-------------------------------------------------------------------------------------------------------------------------------+
| Reference code is maintained by `XMOS` Limited. |
+-------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------+
| **Functionality** |
+----------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------+
| Provides USB interface to audio I/O. |
| |
+----------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------+
| **Supported Standards** |
+----------------------------------------------------------------------------------------------------------------------+
+------------------------+---------------------------------------------------------------------------------------------+
| USB | USB 2.0 (Full-speed and High-speed) |
| +---------------------------------------------------------------------------------------------+
| | `USB Audio Class 1.0 <https://www.usb.org/sites/default/files/audio10.pdf>`_ |
| +---------------------------------------------------------------------------------------------+
| | `USB Audio Class 2.0 <https://www.usb.org/sites/default/files/Audio2.0_final.zip>`_ |
| +---------------------------------------------------------------------------------------------+
| | `USB Firmware Upgrade (DFU) 1.1 <https://www.usb.org/sites/default/files/DFU_1.1.pdf>`_ |
| +---------------------------------------------------------------------------------------------+
| | `USB MIDI Device Class 1.0 <https://www.usb.org/sites/default/files/midi10.pdf>`_ |
+------------------------+---------------------------------------------------------------------------------------------+
| Audio | I²S/TDM |
| +---------------------------------------------------------------------------------------------+
| | S/PDIF (receive may be limited to 96kHz depending on external hardware) |
| +---------------------------------------------------------------------------------------------+
| | ADAT |
| +---------------------------------------------------------------------------------------------+
| | Direct Stream Digital (DSD) |
| +---------------------------------------------------------------------------------------------+
| | PDM Microphones |
| +---------------------------------------------------------------------------------------------+
| | MIDI |
+------------------------+---------------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------+
| **Supported sample frequencies** |
+----------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------+
| 16kHz to 384kHz [#f1]_ |
+----------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------+
| **Supported devices** |
+----------------------------------------------------------------------------------------------------------------------+
+------------------------+---------------------------------------------------------------------------------------------+
| XMOS Devices | `xcore-200` Series |
| +---------------------------------------------------------------------------------------------+
| | `xcore.ai` Series |
+------------------------+---------------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------+
| **Requirements** |
+----------------------------------------------------------------------------------------------------------------------+
+------------------------+---------------------------------------------------------------------------------------------+
| Development Tools | XTC Development Tools (see readme for required version) |
+------------------------+---------------------------------------------------------------------------------------------+
| USB | `xcore` device with integrated USB phy |
+------------------------+---------------------------------------------------------------------------------------------+
| Audio | External audio DAC/ADC/CODECs (and required supporting componentry) supporting I²S/TDM |
+------------------------+---------------------------------------------------------------------------------------------+
| Boot/Storage | Compatible SPI/QSPI Flash device (or `xcore` device with internal flash) |
+------------------------+---------------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------+
| **Licensing** |
+----------------------------------------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------+
| Reference code provided without charge under license from `XMOS`. |
+----------------------------------------------------------------------------------------------------------------------+

.. rubric:: Footnotes

Expand Down

0 comments on commit 6b0279a

Please sign in to comment.