GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / devicetree / bindings / sound / samsung,tm2.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/sound/samsung,tm2.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Samsung Exynos5433 TM2(E) audio complex with WM5110 codec
8
9 maintainers:
10   - Krzysztof Kozlowski <krzk@kernel.org>
11   - Sylwester Nawrocki <s.nawrocki@samsung.com>
12
13 properties:
14   compatible:
15     const: samsung,tm2-audio
16
17   audio-amplifier:
18     description: Phandle to the MAX98504 amplifier.
19     $ref: /schemas/types.yaml#/definitions/phandle
20
21   audio-codec:
22     description: Phandles to the codecs.
23     $ref: /schemas/types.yaml#/definitions/phandle-array
24     items:
25       - description: Phandle to the WM5110 audio codec.
26       - description: Phandle to the HDMI transmitter node.
27
28   samsung,audio-routing:
29     description: |
30       List of the connections between audio components; each entry is
31       a pair of strings, the first being the connection's sink, the second
32       being the connection's source; valid names for sources and sinks are the
33       WM5110's and MAX98504's pins and the jacks on the board: HP, SPK, Main
34       Mic, Sub Mic, Third Mic, Headset Mic.
35     $ref: /schemas/types.yaml#/definitions/non-unique-string-array
36
37   i2s-controller:
38     description: Phandles to the I2S controllers.
39     $ref: /schemas/types.yaml#/definitions/phandle-array
40     items:
41       - description: Phandle to I2S0.
42       - description: Phandle to I2S1.
43
44   mic-bias-gpios:
45     description: GPIO pin that enables the Main Mic bias regulator.
46
47   model:
48     description: The user-visible name of this sound complex.
49     $ref: /schemas/types.yaml#/definitions/string
50
51 required:
52   - compatible
53   - audio-amplifier
54   - audio-codec
55   - samsung,audio-routing
56   - i2s-controller
57   - mic-bias-gpios
58   - model
59
60 additionalProperties: false
61
62 examples:
63   - |
64     #include <dt-bindings/gpio/gpio.h>
65
66     sound {
67         compatible = "samsung,tm2-audio";
68         audio-codec = <&wm5110>, <&hdmi>;
69         i2s-controller = <&i2s0 0>, <&i2s1 0>;
70         audio-amplifier = <&max98504>;
71         mic-bias-gpios = <&gpr3 2 GPIO_ACTIVE_HIGH>;
72         model = "wm5110";
73         samsung,audio-routing = "HP", "HPOUT1L",
74                                 "HP", "HPOUT1R",
75                                 "SPK", "SPKOUT",
76                                 "SPKOUT", "HPOUT2L",
77                                 "SPKOUT", "HPOUT2R",
78                                 "RCV", "HPOUT3L",
79                                 "RCV", "HPOUT3R";
80     };