1# Copyright (c) 2020 Nordic Semiconductor ASA
2# SPDX-License-Identifier: Apache-2.0
3
4# Specific fields for USB audio headset.
5
6description: USB Audio headset specific fields.
7
8compatible: "usb-audio-hs"
9
10include: [usb-audio.yaml, usb-audio-feature-volume.yaml]
11
12properties:
13  mic-resolution:
14    type: int
15    default: 16
16    enum:
17      - 8
18      - 16
19      - 24
20      - 32
21  mic-sync-type:
22    default: "Synchronous"
23    type: string
24    description: |
25      Type of endpoint synchronization for IN devices.
26      Default value is Synchronous.
27      Adaptive is not supported.
28    enum:
29      - "No Synchronization"
30      - "Asynchronous"
31      - "Adaptive"
32      - "Synchronous"
33  mic-sample-rate-hz:
34    type: int
35    default: 48000
36  mic-polling-interval:
37    type: int
38    default: 1
39  hp-resolution:
40    type: int
41    default: 16
42    enum:
43      - 8
44      - 16
45      - 24
46      - 32
47  hp-sample-rate-hz:
48    type: int
49    default: 48000
50  hp-polling-interval:
51    type: int
52    default: 1
53  # microphone channel configuration options
54  mic-channel-l:
55    type: boolean
56    description: Enable (l) channel.
57  mic-channel-r:
58    type: boolean
59    description: Enable (r) channel.
60  mic-channel-c:
61    type: boolean
62    description: Enable (c) channel.
63  mic-channel-lfe:
64    type: boolean
65    description: Enable (lfe) channel.
66  mic-channel-ls:
67    type: boolean
68    description: Enable (ls) channel.
69  mic-channel-rs:
70    type: boolean
71    description: Enable (rs) channel.
72  mic-channel-lc:
73    type: boolean
74    description: Enable (lc) channel.
75  mic-channel-rc:
76    type: boolean
77    description: Enable (rc) channel.
78  mic-channel-s:
79    type: boolean
80    description: Enable (s) channel.
81  mic-channel-sl:
82    type: boolean
83    description: Enable (sl) channel.
84  mic-channel-sr:
85    type: boolean
86    description: Enable (sr) channel.
87  mic-channel-t:
88    type: boolean
89    description: Enable (t) channel.
90  mic-channel-cfg:
91    type: boolean
92    description: Enable (cfg) channel.
93  # microphone feature unit configuration options
94  mic-feature-mute:
95    type: boolean
96    required: true
97    description: Enable Mute feature.
98  mic-feature-volume:
99    type: boolean
100    description: |
101      Enable Volume feature.
102      Currently not supported.
103  mic-feature-tone-control:
104    type: boolean
105    description: |
106      Enable Tone Control (Bass, Mid, Treble) feature.
107      Currently not supported.
108  mic-feature-graphic-equalizer:
109    type: boolean
110    description: |
111      Enable  Graphic Equalizer feature.
112      Currently not supported.
113  mic-feature-automatic-gain-control:
114    type: boolean
115    description: |
116      Enable Autoamtic Gain Control feature.
117      Currently not supported.
118  mic-feature-delay:
119    type: boolean
120    description: |
121      Enable Delay feature.
122      Currently not supported.
123  mic-feature-bass-boost:
124    type: boolean
125    description: |
126      Enable Bass Boost feature.
127      Currently not supported.
128  mic-feature-loudness:
129    type: boolean
130    description: |
131      Enable Loudness feature.
132      Currently not supported.
133# headphones channel configuration options
134  hp-channel-l:
135    type: boolean
136    description: Enable (l) channel.
137  hp-channel-r:
138    type: boolean
139    description: Enable (r) channel.
140  hp-channel-c:
141    type: boolean
142    description: Enable (c) channel.
143  hp-channel-lfe:
144    type: boolean
145    description: Enable (lfe) channel.
146  hp-channel-ls:
147    type: boolean
148    description: Enable (ls) channel.
149  hp-channel-rs:
150    type: boolean
151    description: Enable (rs) channel.
152  hp-channel-lc:
153    type: boolean
154    description: Enable (lc) channel.
155  hp-channel-rc:
156    type: boolean
157    description: Enable (rc) channel.
158  hp-channel-s:
159    type: boolean
160    description: Enable (s) channel.
161  hp-channel-sl:
162    type: boolean
163    description: Enable (sl) channel.
164  hp-channel-sr:
165    type: boolean
166    description: Enable (sr) channel.
167  hp-channel-t:
168    type: boolean
169    description: Enable (t) channel.
170  hp-channel-cfg:
171    type: boolean
172    description: Enable (cfg) channel.
173  # headphones feature unit configuration options
174  hp-feature-mute:
175    type: boolean
176    required: true
177    description: Enable Mute feature.
178  hp-feature-volume:
179    type: boolean
180    description: |
181      Enable Volume feature.
182  hp-feature-tone-control:
183    type: boolean
184    description: |
185      Enable Tone Control (Bass, Mid, Treble) feature.
186      Currently not supported.
187  hp-feature-graphic-equalizer:
188    type: boolean
189    description: |
190      Enable  Graphic Equalizer feature.
191      Currently not supported.
192  hp-feature-automatic-gain-control:
193    type: boolean
194    description: |
195      Enable Autoamtic Gain Control feature.
196      Currently not supported.
197  hp-feature-delay:
198    type: boolean
199    description: |
200      Enable Delay feature.
201      Currently not supported.
202  hp-feature-bass-boost:
203    type: boolean
204    description: |
205      Enable Bass Boost feature.
206      Currently not supported.
207  hp-feature-loudness:
208    type: boolean
209    description: |
210      Enable Loudness feature.
211      Currently not supported.
212