1# Copyright (c) 2023 Nordic Semiconductor ASA
2# SPDX-License-Identifier: Apache-2.0
3
4description: USB Audio Class 2 Clock Source entity
5
6compatible: "zephyr,uac2-clock-source"
7
8properties:
9  clock-type:
10    type: string
11    required: true
12    description: |
13      Clock Type indicating whether the Clock Source represents an external
14      clock or an internal clock with either fixed frequency, variable
15      frequency, or programmable frequency.
16    enum:
17      - "external"
18      - "internal-fixed"
19      - "internal-variable"
20      - "internal-programmable"
21
22  sof-synchronized:
23    type: boolean
24    description: |
25      True if clock is synchronized to USB Start of Frame. False if clock is
26      free running. External clock must be free running.
27
28  frequency-control:
29    type: string
30    description: Clock Frequency Control capabilities
31    enum:
32      - "read-only"
33      - "host-programmable"
34
35  validity-control:
36    type: string
37    description: Clock Validity Control capabilities
38    enum:
39      - "read-only"
40
41  assoc-terminal:
42    type: phandle
43    description: |
44      Input or Output Terminal associated with this Clock Source. Set if clock
45      is derived from USB OUT data endpoint (point the handle to respective
46      Input Terminal) or from input signal on S/PDIF connector.
47
48  sampling-frequencies:
49    type: array
50    required: true
51    description: |
52      Sampling Frequencies, in Hz, this Clock Source Entity can generate.
53