1# Copyright (c) 2023 Nordic Semiconductor ASA
2# SPDX-License-Identifier: Apache-2.0
3
4description: USB Audio Class 2 Audio Streaming interface
5
6compatible: "zephyr,uac2-audio-streaming"
7
8properties:
9  linked-terminal:
10    type: phandle
11    required: true
12    description: |
13      Input or Output Terminal to which this interface is connected.
14
15  active-alternate-setting-control:
16    type: string
17    description: Active Alternate Setting Control capabilities
18    enum:
19      - "read-only"
20
21  valid-alternate-settings-control:
22    type: string
23    description: Valid Alternate Settings Control capabilities
24    enum:
25      - "read-only"
26
27  external-interface:
28    type: boolean
29    description: |
30      Enable if audio stream is not transmitted over USB (Type IV Audio Stream).
31
32  implicit-feedback:
33    type: boolean
34    description: |
35      Enable implicit feedback on asynchronous endpoint. For IN endpoints this
36      sets endpoint behaviour type to implicit feedback data endpoint. For OUT
37      endpoints setting this property removes explicit feedback endpoint.
38
39  pitch-control:
40    type: string
41    description: Pitch Control capabilities
42    enum:
43      - "read-only"
44      - "host-programmable"
45
46  data-overrun-control:
47    type: string
48    description: Data Overrun capabilities
49    enum:
50      - "read-only"
51
52  data-underrun-control:
53    type: string
54    description: Data Underrun capabilities
55    enum:
56      - "read-only"
57
58  lock-delay:
59    type: int
60    description: |
61      Time it takes this endpoint to reliably lock its internal clock recovery
62      circuitry. Units depend on the lock-delay-units field. Relevant only if
63      linked-terminal's clock is sof-synchronized.
64
65  lock-delay-units:
66    type: string
67    description: Units for lock-delay parameter.
68    enum:
69      - "milliseconds"
70      - "decoded-pcm-samples"
71
72  subslot-size:
73    type: int
74    description: |
75      Number of bytes occupied by one audio subslot. Can be 1, 2, 3 or 4.
76
77  bit-resolution:
78    type: int
79    description: |
80      Number of effectively used bits in audio subslot.
81