Files
lib_xua/lib_xua/doc/rst/overview.rst
Ross Owen 1ef5129fde Variable i2s bit width (#331)
- Add support for variable width I2S (via XUA_I2S_N_BITS)
- Add support for variable width TDM (again via XUD_I2S_N_BITS when XUA_PCM_FORMAT=XUA_PCM_FORMAT_TDM)
- Includes support for xcore as I2S/TDM master and slave
- Add testing of the the above to test_i2s_loopback
- Rationalised test config building in test_i2s_loopback
- Documentation updated
2023-06-08 15:31:12 +01:00

77 lines
8.9 KiB
ReStructuredText

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 <http://www.usb.org/developers/devclass_docs/audio10.pdf>`_ |
| +---------------------------------------------------------------------------------------------+
| | `USB Audio Class 2.0 <http://www.usb.org/developers/devclass_docs/Audio2.0_final.zip>`_ |
| +---------------------------------------------------------------------------------------------+
| | `USB Firmware Upgrade (DFU) 1.1 <http://www.usb.org/developers/devclass_docs/DFU_1.1.pdf>`_ |
| +---------------------------------------------------------------------------------------------+
| | `USB Midi Device Class 1.0 <http://www.usb.org/developers/devclass_docs/midi10.pdf>`_ |
+---------------------------------+---------------------------------------------------------------------------------------------+
| Audio | I2S/TDM (16/32-bit) |
| +---------------------------------------------------------------------------------------------+
| | S/PDIF |
| +---------------------------------------------------------------------------------------------+
| | ADAT |
| +---------------------------------------------------------------------------------------------+
| | Direct Stream Digital (DSD) |
| +---------------------------------------------------------------------------------------------+
| | PDM Microphones |
| +---------------------------------------------------------------------------------------------+
| | MIDI |
+---------------------------------+---------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| **Supported Sample Frequencies** |
+-------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| 44.1kHz, 48kHz, 88.2kHz, 96kHz, 176.4kHz, 192kHz, 352.8kHz, 384kHz |
+-------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| **Supported Devices** |
+-------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------+---------------------------------------------------------------------------------------------+
| XMOS Devices | xCORE-200 Series |
| +---------------------------------------------------------------------------------------------+
| | xCORE.AI Series |
+---------------------------------+---------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------------------------------+
| **Requirements** |
+-------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------+---------------------------------------------------------------------------------------------+
| Development Tools | xTIMEcomposer Development Tools v15.1 or later |
+---------------------------------+---------------------------------------------------------------------------------------------+
| USB | xCORE device with integrated USB phy (external phy not supported) |
+---------------------------------+---------------------------------------------------------------------------------------------+
| Audio | External audio DAC/ADC/CODECs (and required supporting componentry) supporting I2S/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. |
+-------------------------------------------------------------------------------------------------------------------------------+