Merge tag 'meminit-v5.3-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/kees...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / display / bridge / sii902x.txt
1 sii902x HDMI bridge bindings
2
3 Required properties:
4         - compatible: "sil,sii9022"
5         - reg: i2c address of the bridge
6
7 Optional properties:
8         - interrupts: describe the interrupt line used to inform the host
9           about hotplug events.
10         - reset-gpios: OF device-tree gpio specification for RST_N pin.
11
12         HDMI audio properties:
13         - #sound-dai-cells: <0> or <1>. <0> if only i2s or spdif pin
14            is wired, <1> if the both are wired. HDMI audio is
15            configured only if this property is found.
16         - sil,i2s-data-lanes: Array of up to 4 integers with values of 0-3
17            Each integer indicates which i2s pin is connected to which
18            audio fifo. The first integer selects i2s audio pin for the
19            first audio fifo#0 (HDMI channels 1&2), second for fifo#1
20            (HDMI channels 3&4), and so on. There is 4 fifos and 4 i2s
21            pins (SD0 - SD3). Any i2s pin can be connected to any fifo,
22            but there can be no gaps. E.g. an i2s pin must be mapped to
23            fifo#0 and fifo#1 before mapping a channel to fifo#2. Default
24            value is <0>, describing SD0 pin beiging routed to hdmi audio
25            fifo #0.
26         - clocks: phandle and clock specifier for each clock listed in
27            the clock-names property
28         - clock-names: "mclk"
29            Describes SII902x MCLK input. MCLK is used to produce
30            HDMI audio CTS values. This property is required if
31            "#sound-dai-cells"-property is present. This property follows
32            Documentation/devicetree/bindings/clock/clock-bindings.txt
33            consumer binding.
34
35         If HDMI audio is configured the sii902x device becomes an I2S
36         and/or spdif audio codec component (e.g a digital audio sink),
37         that can be used in configuring a full audio devices with
38         simple-card or audio-graph-card binding. See their binding
39         documents on how to describe the way the sii902x device is
40         connected to the rest of the audio system:
41         Documentation/devicetree/bindings/sound/simple-card.txt
42         Documentation/devicetree/bindings/sound/audio-graph-card.txt
43         Note: In case of the audio-graph-card binding the used port
44         index should be 3.
45
46 Optional subnodes:
47         - video input: this subnode can contain a video input port node
48           to connect the bridge to a display controller output (See this
49           documentation [1]).
50
51 [1]: Documentation/devicetree/bindings/media/video-interfaces.txt
52
53 Example:
54         hdmi-bridge@39 {
55                 compatible = "sil,sii9022";
56                 reg = <0x39>;
57                 reset-gpios = <&pioA 1 0>;
58
59                 #sound-dai-cells = <0>;
60                 sil,i2s-data-lanes = < 0 1 2 >;
61                 clocks = <&mclk>;
62                 clock-names = "mclk";
63
64                 ports {
65                         #address-cells = <1>;
66                         #size-cells = <0>;
67
68                         port@0 {
69                                 reg = <0>;
70                                 bridge_in: endpoint {
71                                         remote-endpoint = <&dc_out>;
72                                 };
73                         };
74                 };
75         };