audio: Add UAC1.0 support #3270

HiFiPhile · 2025-09-30T15:57:43Z

Describe the PR

This PR adds USB Audio Class 1.0 (UAC1) support, now audio device driver supports both UAC1 and UAC2 with dynamic switching possibility based on host capabilities.

For asynchronous OUT with feedback, now it's recommended to use UAC1 for Full-Speed device for better OS compatibility, while UAC2 is recommended only for High-Speed device for better performance.

Let me break down this PR:

USBD

Add UAC1 constants to audio.h with prefix audio10_, UAC2 renamed with prefix audio20_
Add UAC1 descriptor macros to usbd.h, refactor fixed size descriptor macros to use auto size with the help of TU_ARGS_APPLY_EXPAND
Support UAC1 without IAD (Interface Association Descriptor)

Audio device

Add UAC1 descriptor parsing and control request handling
Update IN flow control to support UAC1 (OUT feedback by FIFO counting is auto supported)
Calculate descriptor length by driver, remove CFG_TUD_AUDIO_FUNC_n_DESC_LEN config
Remove CFG_TUD_AUDIO_ENABLE_FEEDBACK_FORMAT_CORRECTION, now UAC1 always use 3-bytes 10.14 format while UAC2 always use 4-bytes 16.16 format

Examples

uac2_speaker_fb: Add UAC1 support with automatic fallback based on host capabilities
- Remove OS guessing quirks
audio_test_multi_rate: Add UAC1 support with automatic fallback based on host capabilities
uac2_headset: Add UAC1 support with automatic fallback based on host capabilities
- UAC1 status interrupt is not supported by most OS, if you need volume control either use UAC2 or old day HID interface

Testing

On STM32F407 & STM32F723:

Example	OS	UAC1 (FS)	UAC2 (HS)
uac2_speaker_fb	Windows 10	✅	✅
uac2_speaker_fb	macOS 13	✅	✅
uac2_speaker_fb	Archlinux	✅	✅
audio_test_multi_rate	Windows 10	✅	✅
audio_test_multi_rate	macOS 13	✅	✅
audio_test_multi_rate	Archlinux	✅	✅
uac2_headset	Windows 10	✅	✅
uac2_headset	macOS 13	Seems OK, can't verify in VM	Seems OK, can't verify in VM
uac2_headset	Archlinux	✅	✅

A side note:

tinyusb/examples/device/uac2_speaker_fb/src/usb_descriptors.h

Line 137 in 6e153a9

//---------------------------------------------------------------------------+

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Signed-off-by: Mengsk <admin@hifiphile.com>

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Signed-off-by: Mengsk <admin@hifiphile.com>

Copilot

Pull Request Overview

This PR adds comprehensive USB Audio Class 1.0 (UAC1) support to TinyUSB's audio device driver, enabling dynamic switching between UAC1 and UAC2 based on host capabilities. The implementation focuses on improving compatibility with Full-Speed devices by recommending UAC1 for better OS compatibility while maintaining UAC2 for High-Speed performance.

Adds complete UAC1 constants, descriptors, and macros with audio10_ prefix
Implements UAC1 descriptor parsing and control request handling in audio device driver
Updates examples to support both UAC1 and UAC2 with automatic fallback capability

Reviewed Changes

Copilot reviewed 37 out of 37 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/device/usbd.h	Adds UAC1 descriptor templates and renames UAC2 macros for clarity
src/device/usbd.c	Adds UAC1 device support without IAD descriptor handling
src/common/tusb_compiler.h	Adds TU_ARGS_APPLY_EXPAND macro for variable argument expansion
src/common/tusb_common.h	Adds U24 byte manipulation macros for UAC1 feedback format
src/class/midi/midi_host.c	Updates to use renamed UAC1 constants
src/class/audio/audio_device.h	Removes deprecated config options and adds version detection API
src/class/audio/audio_device.c	Implements UAC1 parsing, control handling, and feedback format logic
src/class/audio/audio.h	Comprehensive UAC1/UAC2 constants reorganization and new descriptors
examples/device/uac2_speaker_fb/*	Removes OS guessing quirks, adds UAC1/UAC2 dual support
examples/device/uac2_headset/*	Updates to use renamed UAC2 constants
examples/device/cdc_uac2/*	Updates to use renamed UAC2 constants

src/device/usbd.c

examples/device/uac2_speaker_fb/src/main.c

examples/device/audio_test_multi_rate/src/main.c

examples/device/uac2_speaker_fb/src/main.c

HiFiPhile · 2025-10-01T00:06:53Z

I've an issue with DWC2 where sometimes it can't send IN ISO packet (a ZLP is sent instead of data) when bInterval > 1

It seems like packet needs to scheduled manually when bInterval > 1, at least even/odd toggling is needed.

Signed-off-by: HiFiPhile <admin@hifiphile.com>

src/class/audio/audio_device.c

Signed-off-by: HiFiPhile <admin@hifiphile.com>

examples/device/uac2_headset/src/main.c

Signed-off-by: Mengsk <admin@hifiphile.com>

hathach · 2025-10-04T03:42:51Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting

@codex fix this CI failure
@codex address that feedback

src/class/audio/audio_device.c

hathach · 2025-10-04T04:14:28Z

@codex merge master branch to this PR

chatgpt-codex-connector · 2025-10-04T04:14:35Z

For now, I can only help with PRs you've created.

hathach · 2025-10-04T04:15:13Z

@copilot merge master branch to this PR

Signed-off-by: HiFiPhile <admin@hifiphile.com>

codescene-delta-analysis

Gates Failed
Prevent hotspot decline (2 hotspots with Complex Method, Complex Conditional, Bumpy Road Ahead, Deep, Nested Complexity)
Enforce critical code health rules (2 files with Bumpy Road Ahead, Deep, Nested Complexity)
Enforce advisory code health rules (5 files with Complex Method, Overall Code Complexity, Code Duplication, Complex Conditional)

Gates Passed
1 Quality Gates Passed

See analysis details in CodeScene

Reason for failure

Prevent hotspot decline	Violations	Code Health Impact
usbd.c	3 rules in this hotspot	5.74 → 5.14	Suppress
audio_device.c	3 rules in this hotspot	3.71 → 3.44	Suppress

Enforce critical code health rules	Violations	Code Health Impact
usbd.c	1 critical rule	5.74 → 5.14	Suppress
audio_device.c	1 critical rule	3.71 → 3.44	Suppress

Enforce advisory code health rules	Violations	Code Health Impact
main.c	2 advisory rules	9.61 → 8.29	Suppress
main.c	2 advisory rules	8.17 → 7.29	Suppress
main.c	2 advisory rules	9.24 → 8.49	Suppress
usbd.c	2 advisory rules	5.74 → 5.14	Suppress
audio_device.c	2 advisory rules	3.71 → 3.44	Suppress

Quality Gate Profile: Clean Code Collective
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

examples/device/audio_test_multi_rate/src/main.c

examples/device/uac2_headset/src/main.c

src/class/audio/audio_device.c

src/device/usbd.c

hathach

perfect !! Thank you very much, I didn't test but go through code changes. It looks great, audio is by far the most complicated driver. I think its descriptor is too complicated to have template descirptor as macro. I will try to improve it later on with typedef struct like video example. Thank you very much for putting lots of effort into the driver.

HiFiPhile added 11 commits September 29, 2025 10:00

Add UAC1.0 defines

24bc2ff

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Update UAC2 naming

78121a8

Signed-off-by: HiFiPhile <admin@hifiphile.com>

More descriptors working

9637a20

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Add basic UAC1 support

289680a

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Implement UAC1 IN flow control

8f9eee6

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Update TUD_AUDIO_EP_SIZE macro

5d179c2

Signed-off-by: Mengsk <admin@hifiphile.com>

Add UAC1 support to speaker example

9afe71c

Signed-off-by: Mengsk <admin@hifiphile.com>

Add UAC1 support to audio_test_multi_rate example

9f75b32

Signed-off-by: HiFiPhile <admin@hifiphile.com>

fix descriptor walking

56b1ce2

Signed-off-by: HiFiPhile <admin@hifiphile.com>

support UAC1 without IAD

e463e87

Signed-off-by: Mengsk <admin@hifiphile.com>

Remove feedback format correction since no longer needed

7867fa6

Signed-off-by: Mengsk <admin@hifiphile.com>

Copilot AI review requested due to automatic review settings September 30, 2025 15:57

github-actions bot added the Prio Higher label Sep 30, 2025

Copilot AI reviewed Sep 30, 2025

View reviewed changes

src/device/usbd.c Outdated Show resolved Hide resolved

examples/device/uac2_speaker_fb/src/main.c Outdated Show resolved Hide resolved

github-advanced-security bot found potential problems Sep 30, 2025

View reviewed changes

HiFiPhile force-pushed the uac1 branch from 5a9dde8 to 7370c03 Compare September 30, 2025 23:58

HiFiPhile force-pushed the uac1 branch from 7370c03 to 7c8047a Compare October 1, 2025 00:07

Minor fixes

d510858

Signed-off-by: HiFiPhile <admin@hifiphile.com>

HiFiPhile force-pushed the uac1 branch 2 times, most recently from 3a9fec6 to a944c0d Compare October 1, 2025 07:46

better EP type detection

1ee113e

Signed-off-by: HiFiPhile <admin@hifiphile.com>

HiFiPhile force-pushed the uac1 branch from a944c0d to 1ee113e Compare October 1, 2025 08:05

Add note about bRefresh value

cd9266b

Signed-off-by: HiFiPhile <admin@hifiphile.com>

HiFiPhile force-pushed the uac1 branch from 6e153a9 to cd9266b Compare October 1, 2025 20:00

This was referenced Oct 1, 2025

Audio class enhancements #3133

Closed

dcd/dwc2: support ISO IN transfer when bInterval > 1 #3275

Merged

HiFiPhile added 2 commits October 2, 2025 15:34

Update feedback params on frequency change

12a2fe3

Signed-off-by: HiFiPhile <admin@hifiphile.com>

cleanup

01477c4

Signed-off-by: HiFiPhile <admin@hifiphile.com>

github-advanced-security bot found potential problems Oct 2, 2025

View reviewed changes

src/class/audio/audio_device.c Fixed Show fixed Hide fixed

HiFiPhile added 2 commits October 2, 2025 20:55

Fix feedback param lag

4ae26db

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Add UAC1 support to uac2_headset example

d322207

Signed-off-by: HiFiPhile <admin@hifiphile.com>

github-advanced-security bot found potential problems Oct 2, 2025

View reviewed changes

HiFiPhile added 2 commits October 3, 2025 09:34

Merge remote-tracking branch 'tinyusb/master' into uac1

05ea8cf

Update headset example

1ded8ac

Signed-off-by: Mengsk <admin@hifiphile.com>

HiFiPhile force-pushed the uac1 branch from 5f7cbe9 to 1ded8ac Compare October 3, 2025 08:15

chatgpt-codex-connector bot reviewed Oct 4, 2025

View reviewed changes

src/class/audio/audio_device.c Show resolved Hide resolved

hathach and others added 3 commits October 4, 2025 15:41

Merge branch 'master' into fork/HiFiPhile/uac1

0b630f0

Fix descriptor looping

e38172f

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Fix jlink device name

3c33aff

Signed-off-by: HiFiPhile <admin@hifiphile.com>

HiFiPhile mentioned this pull request Oct 4, 2025

Audio control transfers misaligned on some platforms #3026

Closed

1 task

Use one control buffer as EP0 has no concurrency

6acf49e

Signed-off-by: HiFiPhile <admin@hifiphile.com>

HiFiPhile force-pushed the uac1 branch from c359e82 to 6acf49e Compare October 4, 2025 23:13

HiFiPhile added 5 commits October 11, 2025 16:49

Move control buffer out of USB section

080ca2e

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Merge branch 'master' into uac1

1902377

Merge remote-tracking branch 'upstream/master' into uac1

4dd9122

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Ensure type promotion

9f1a86c

Signed-off-by: HiFiPhile <admin@hifiphile.com>

Merge branch 'master' into uac1

aa739c9

Signed-off-by: HiFiPhile <admin@hifiphile.com>

codescene-delta-analysis bot reviewed Oct 30, 2025

View reviewed changes

hathach approved these changes Oct 31, 2025

View reviewed changes

hathach merged commit dfcab87 into hathach:master Oct 31, 2025
109 of 114 checks passed

HiFiPhile deleted the uac1 branch November 25, 2025 10:00

freefloris mentioned this pull request Dec 10, 2025

Windows 7 UAC 2 Drivers wasdwasd0105/PicoW-usb2bt-audio#19

Open

audio: Add UAC1.0 support #3270

audio: Add UAC1.0 support #3270

Uh oh!

Conversation

HiFiPhile commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

USBD

Audio device

Examples

Testing

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HiFiPhile commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hathach commented Oct 4, 2025

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

hathach commented Oct 4, 2025

Uh oh!

chatgpt-codex-connector bot commented Oct 4, 2025

Uh oh!

hathach commented Oct 4, 2025

Uh oh!

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hathach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

HiFiPhile commented Sep 30, 2025 •

edited

Loading

HiFiPhile commented Oct 1, 2025 •

edited

Loading