xref: /linux/Documentation/devicetree/bindings/sound/nvidia,tegra186-dspk.yaml (revision a4eb44a6435d6d8f9e642407a4a06f65eb90ca04) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/sound/nvidia,tegra186-dspk.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Tegra186 DSPK Controller Device Tree Bindings
8
9description: |
10  The Digital Speaker Controller (DSPK) can be viewed as a Pulse
11  Density Modulation (PDM) transmitter that up-samples the input to
12  the desired sampling rate by interpolation and then converts the
13  over sampled Pulse Code Modulation (PCM) input to the desired 1-bit
14  output via Delta Sigma Modulation (DSM).
15
16maintainers:
17  - Jon Hunter <jonathanh@nvidia.com>
18  - Sameer Pujar <spujar@nvidia.com>
19
20allOf:
21  - $ref: name-prefix.yaml#
22
23properties:
24  $nodename:
25    pattern: "^dspk@[0-9a-f]*$"
26
27  compatible:
28    oneOf:
29      - const: nvidia,tegra186-dspk
30      - items:
31          - const: nvidia,tegra194-dspk
32          - const: nvidia,tegra186-dspk
33
34  reg:
35    maxItems: 1
36
37  clocks:
38    maxItems: 1
39
40  clock-names:
41    const: dspk
42
43  assigned-clocks:
44    maxItems: 1
45
46  assigned-clock-parents:
47    maxItems: 1
48
49  assigned-clock-rates:
50    maxItems: 1
51
52  sound-name-prefix:
53    pattern: "^DSPK[1-9]$"
54
55  ports:
56    $ref: /schemas/graph.yaml#/properties/ports
57    properties:
58      port@0:
59        $ref: audio-graph-port.yaml#
60        unevaluatedProperties: false
61        description: |
62          DSPK ACIF (Audio Client Interface) port connected to the
63          corresponding AHUB (Audio Hub) ACIF port.
64
65      port@1:
66        $ref: audio-graph-port.yaml#
67        unevaluatedProperties: false
68        description: |
69          DSPK DAP (Digital Audio Port) interface which can be connected
70          to external audio codec for playback.
71
72required:
73  - compatible
74  - reg
75  - clocks
76  - clock-names
77  - assigned-clocks
78  - assigned-clock-parents
79  - sound-name-prefix
80
81additionalProperties: false
82
83examples:
84  - |
85    #include<dt-bindings/clock/tegra186-clock.h>
86
87    dspk@2905000 {
88        compatible = "nvidia,tegra186-dspk";
89        reg = <0x2905000 0x100>;
90        clocks = <&bpmp TEGRA186_CLK_DSPK1>;
91        clock-names = "dspk";
92        assigned-clocks = <&bpmp TEGRA186_CLK_DSPK1>;
93        assigned-clock-parents = <&bpmp TEGRA186_CLK_PLL_A_OUT0>;
94        assigned-clock-rates = <12288000>;
95        sound-name-prefix = "DSPK1";
96    };
97
98...
99