Added template app #348
Added template app #348
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a new template USB Audio application (app_usb_aud_template) intended as a starting point for porting the USB Audio framework to custom hardware. The template provides a minimal 2-channel input/2-channel output USB Audio Class 2.0 configuration with empty stub functions for hardware-specific customization, allowing developers to avoid the confusion of hardware-specific code from other reference designs.
Key changes:
- Added minimal template application with 2in/2out I2S audio channels
- Provided empty stub functions for hardware initialization and audio stream callbacks
- Included basic configuration files (xua_conf.h and .xn hardware description)
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| app_usb_aud_template/src/extensions/hostactive.xc | Empty stub for USB host active/inactive callback |
| app_usb_aud_template/src/extensions/audiostream.xc | Empty stub for audio stream state callback |
| app_usb_aud_template/src/extensions/audiohw.xc | Empty stubs for audio hardware initialization and configuration |
| app_usb_aud_template/src/core/xua_conf.h | Configuration header with minimal defaults (2in/2out, no MIDI/SPDIF/ADAT) |
| app_usb_aud_template/src/core/xk-audio-316-mc.xn | Hardware description file as starting point template |
| app_usb_aud_template/README.rst | Documentation describing the template application features |
| app_usb_aud_template/CMakeLists.txt | Build configuration for simple 2in/2out setup |
| README.rst | Updated main README table to include the new template app |
| CMakeLists.txt | Added template app to build system |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
xross
force-pushed
the
feature/app_template
branch
from
2767146 to
6aecd6f
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Support for the following sample frequencies: 44.1, 48, 88.2, 96, 176.4, 192kHz | ||
|
|
||
| ************ | ||
| Known Issues |
There was a problem hiding this comment.
The casing of "Known Issues" should match the consistent pattern used in other README files. Based on app_usb_aud_xk_316_mc/README.rst line 38, this should be "Known issues" (lowercase 'i').
| Known Issues | |
| Known issues |
1 participant
The idea with this is to provide a "blank" app as a good place to start a port to new HW.
Also we have quite a few users trying to run binaries for XMOS boards on custom hardware and getting stuck as these binaries are customised to configure specific external hardware.
TODO