The source code is split into several top-level directories (which are presented as separate projects in Eclipse). These are split into modules and applications. The applications build into a single executable using the source code from the modules. The modules used by an application are specified using the USED_MODULES variable in the application Makefile. For more details on this module structure please see the documentation in the module_xmos_common directory.
The source package contains demonstration applications for different hardware:
| Directory | Platform |
|---|---|
| app_xr_avb_lc_demo | XR-AVB-LC-BRD reference design kit |
| app_xdk_avb_demo | XDK development kit |
| app_xdk_xai_avb_demo | XDK development kit with XAI audio interface board |
| app_xc2_avb_demo | XC-2 development kit |
| app_1722_1_listner | An LC board listener that uses the 1722.1 protocol for control |
| app_1722_1_talker | An LC board talker that uses the 1722.1 protocol for control |
| app_two_channel_listener | An LC board test application with a listener that combines two single channel streams |
| app_two_channel_talker | An LC board test application with a talker that produces two single channel streams |
| test_api_listener | A simple LC board stereo channel listener |
| test_api_talker | A simple LC board stereo channel talker |
Each of these applications uses different modules.
Some support modules originate in other repositories:
| Directory | Description | Repository |
|---|---|---|
| module_ethernet | Ethernet MAC | sc_ethernet |
| module_xtcp | XTCP TCP/IP stack | sc_xtcp |
| module_zeroconf | Zeroconf/Multicast=DNS stack. | sc_xtcp |
| module_i2c | Two wire configuration protocol code. | sc_i2c |
| module_xlog | A logging server for redirecting prints over UART or an XC channel. | sc_xlog |
| module_xmos_common | Common build infrastructure. | xcommon |
The following modules contain the core AVB code and are needed by every application:
| Directory | Description |
|---|---|
| module_avb | Main AVB code for control and configuration. |
| module_avb_1722 | IEEE P1722 transport (listener and talker functionality). |
| module_avb_1722_maap | IEEE P1722 MAAP - Multicast address allocation code. |
| module_avb_1722_1 | IEEE P1722.1 AVB control protocol. |
| module_avb_srp | 802.1Qat stream reservation code. |
| module_osc | A module providing an Open Sound Control style tree hierarchy for settings. Note that no OSC protocol is currently implemented. |
| module_gptp | 802.1as code. |
| module_avb_audio | Code for media FIFOs and audio hardware interfaces (I2S/TDM etc). |
| module_avb_media_clock | Media clock server code. |
| module_avb_util | General utility functions used by all modules. |
| module_locks | A generic module for concurrency locking. |
| module_avb_attero_cfg | Module containing UDP configuration code for communicating with the example Atterotech control application. |
In addition to the core AVB code the following modules are used by the demos for other functionality:
| Directory | Description |
|---|---|
| module_xdk_avb_common | A selection of code used in XDK AVB demos. |
| File | Description |
|---|---|
| avb.h | Header file containing declarations for all AVB component functions and the AVB control API. |
| xtcp_client.h | Header file for clients of the TCP/IP stack. |
| ethernet_rx_client.h | Header file for clients that require direct access to the ethernet MAC (RX). |
| ethernet_tx_client.h | Header file for clients that require direct access to the ethernet MAC (TX). |
| gptp.h | Header file for access to the PTP server. |
| mdns.h | Header file for clients wishing to register Zeroconf names/services. |
| audio_i2s.h | Header file containing the I2S audio component. |
| audio_tdm.h | Header file containing the TDM audio component. |