This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

zephyr,uac2-audio-streaming

Vendor: Zephyr-specific binding

Description

USB Audio Class 2 Audio Streaming interface

Properties

Properties not inherited from the base binding file.

Name

Type

Details

linked-terminal

phandle

Input or Output Terminal to which this interface is connected.

This property is required.

active-alternate-setting-control

string

Active Alternate Setting Control capabilities

Legal values: 'read-only'

valid-alternate-settings-control

string

Valid Alternate Settings Control capabilities

Legal values: 'read-only'

external-interface

boolean

Enable if audio stream is not transmitted over USB (Type IV Audio Stream).

implicit-feedback

boolean

Enable implicit feedback on asynchronous endpoint. For IN endpoints this
sets endpoint behaviour type to implicit feedback data endpoint. For OUT
endpoints setting this property removes explicit feedback endpoint.

pitch-control

string

Pitch Control capabilities

Legal values: 'read-only', 'host-programmable'

data-overrun-control

string

Data Overrun capabilities

Legal values: 'read-only'

data-underrun-control

string

Data Underrun capabilities

Legal values: 'read-only'

lock-delay

int

Time it takes this endpoint to reliably lock its internal clock recovery
circuitry. Units depend on the lock-delay-units field. Relevant only if
linked-terminal's clock is sof-synchronized.

lock-delay-units

string

Units for lock-delay parameter.

Legal values: 'milliseconds', 'decoded-pcm-samples'

subslot-size

int

Number of bytes occupied by one audio subslot. Can be 1, 2, 3 or 4.

bit-resolution

int

Number of effectively used bits in audio subslot.