Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mattst88...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / media / rcar_vin.txt
1 Renesas R-Car Video Input driver (rcar_vin)
2 -------------------------------------------
3
4 The rcar_vin device provides video input capabilities for the Renesas R-Car
5 family of devices.
6
7 Each VIN instance has a single parallel input that supports RGB and YUV video,
8 with both external synchronization and BT.656 synchronization for the latter.
9 Depending on the instance the VIN input is connected to external SoC pins, or
10 on Gen3 platforms to a CSI-2 receiver.
11
12  - compatible: Must be one or more of the following
13    - "renesas,vin-r8a7743" for the R8A7743 device
14    - "renesas,vin-r8a7744" for the R8A7744 device
15    - "renesas,vin-r8a7745" for the R8A7745 device
16    - "renesas,vin-r8a7778" for the R8A7778 device
17    - "renesas,vin-r8a7779" for the R8A7779 device
18    - "renesas,vin-r8a7790" for the R8A7790 device
19    - "renesas,vin-r8a7791" for the R8A7791 device
20    - "renesas,vin-r8a7792" for the R8A7792 device
21    - "renesas,vin-r8a7793" for the R8A7793 device
22    - "renesas,vin-r8a7794" for the R8A7794 device
23    - "renesas,vin-r8a7795" for the R8A7795 device
24    - "renesas,vin-r8a7796" for the R8A7796 device
25    - "renesas,vin-r8a77965" for the R8A77965 device
26    - "renesas,vin-r8a77970" for the R8A77970 device
27    - "renesas,vin-r8a77980" for the R8A77980 device
28    - "renesas,vin-r8a77990" for the R8A77990 device
29    - "renesas,vin-r8a77995" for the R8A77995 device
30    - "renesas,rcar-gen2-vin" for a generic R-Car Gen2 or RZ/G1 compatible
31      device.
32
33    When compatible with the generic version nodes must list the
34    SoC-specific version corresponding to the platform first
35    followed by the generic version.
36
37  - reg: the register base and size for the device registers
38  - interrupts: the interrupt for the device
39  - clocks: Reference to the parent clock
40
41 Additionally, an alias named vinX will need to be created to specify
42 which video input device this is.
43
44 The per-board settings Gen2 platforms:
45
46 - port - sub-node describing a single endpoint connected to the VIN
47   from external SoC pins as described in video-interfaces.txt[1].
48   Only the first one will be considered as each vin interface has one
49   input port.
50
51   - Optional properties for endpoint nodes:
52     - hsync-active: see [1] for description. Default is active high.
53     - vsync-active: see [1] for description. Default is active high.
54       If both HSYNC and VSYNC polarities are not specified, embedded
55       synchronization is selected.
56     - field-active-even: see [1] for description. Default is active high.
57     - bus-width: see [1] for description. The selected bus width depends on
58       the SoC type and selected input image format.
59       Valid values are: 8, 10, 12, 16, 24 and 32.
60     - data-shift: see [1] for description. Valid values are 0 and 8.
61     - data-enable-active: polarity of CLKENB signal, see [1] for
62       description. Default is active high.
63
64 The per-board settings Gen3 platforms:
65
66 Gen3 platforms can support both a single connected parallel input source
67 from external SoC pins (port@0) and/or multiple parallel input sources
68 from local SoC CSI-2 receivers (port@1) depending on SoC.
69
70 - renesas,id - ID number of the VIN, VINx in the documentation.
71 - ports
72     - port@0 - sub-node describing a single endpoint connected to the VIN
73       from external SoC pins as described in video-interfaces.txt[1].
74       Describing more than one endpoint in port@0 is invalid. Only VIN
75       instances that are connected to external pins should have port@0.
76
77       Endpoint nodes of port@0 support the optional properties listed in
78       the Gen2 per-board settings description.
79
80     - port@1 - sub-nodes describing one or more endpoints connected to
81       the VIN from local SoC CSI-2 receivers. The endpoint numbers must
82       use the following schema.
83
84         - endpoint@0 - sub-node describing the endpoint connected to CSI20
85         - endpoint@1 - sub-node describing the endpoint connected to CSI21
86         - endpoint@2 - sub-node describing the endpoint connected to CSI40
87         - endpoint@3 - sub-node describing the endpoint connected to CSI41
88
89       Endpoint nodes of port@1 do not support any optional endpoint property.
90
91 Device node example for Gen2 platforms
92 --------------------------------------
93
94         aliases {
95                 vin0 = &vin0;
96         };
97
98         vin0: vin@e6ef0000 {
99                 compatible = "renesas,vin-r8a7790", "renesas,rcar-gen2-vin";
100                 clocks = <&mstp8_clks R8A7790_CLK_VIN0>;
101                 reg = <0 0xe6ef0000 0 0x1000>;
102                 interrupts = <0 188 IRQ_TYPE_LEVEL_HIGH>;
103                 status = "disabled";
104         };
105
106 Board setup example for Gen2 platforms (vin1 composite video input)
107 -------------------------------------------------------------------
108
109 &i2c2   {
110         status = "okay";
111         pinctrl-0 = <&i2c2_pins>;
112         pinctrl-names = "default";
113
114         adv7180@20 {
115                 compatible = "adi,adv7180";
116                 reg = <0x20>;
117                 remote = <&vin1>;
118
119                 port {
120                         adv7180: endpoint {
121                                 bus-width = <8>;
122                                 remote-endpoint = <&vin1ep0>;
123                         };
124                 };
125         };
126 };
127
128 /* composite video input */
129 &vin1 {
130         pinctrl-0 = <&vin1_pins>;
131         pinctrl-names = "default";
132
133         status = "okay";
134
135         port {
136                 vin1ep0: endpoint {
137                         remote-endpoint = <&adv7180>;
138                         bus-width = <8>;
139                 };
140         };
141 };
142
143 Device node example for Gen3 platforms
144 --------------------------------------
145
146         vin0: video@e6ef0000 {
147                 compatible = "renesas,vin-r8a7795";
148                 reg = <0 0xe6ef0000 0 0x1000>;
149                 interrupts = <GIC_SPI 188 IRQ_TYPE_LEVEL_HIGH>;
150                 clocks = <&cpg CPG_MOD 811>;
151                 power-domains = <&sysc R8A7795_PD_ALWAYS_ON>;
152                 resets = <&cpg 811>;
153                 renesas,id = <0>;
154
155                 ports {
156                         #address-cells = <1>;
157                         #size-cells = <0>;
158
159                         port@1 {
160                                 #address-cells = <1>;
161                                 #size-cells = <0>;
162
163                                 reg = <1>;
164
165                                 vin0csi20: endpoint@0 {
166                                         reg = <0>;
167                                         remote-endpoint= <&csi20vin0>;
168                                 };
169                                 vin0csi21: endpoint@1 {
170                                         reg = <1>;
171                                         remote-endpoint= <&csi21vin0>;
172                                 };
173                                 vin0csi40: endpoint@2 {
174                                         reg = <2>;
175                                         remote-endpoint= <&csi40vin0>;
176                                 };
177                         };
178                 };
179         };
180
181         csi20: csi2@fea80000 {
182                 compatible = "renesas,r8a7795-csi2";
183                 reg = <0 0xfea80000 0 0x10000>;
184                 interrupts = <GIC_SPI 184 IRQ_TYPE_LEVEL_HIGH>;
185                 clocks = <&cpg CPG_MOD 714>;
186                 power-domains = <&sysc R8A7795_PD_ALWAYS_ON>;
187                 resets = <&cpg 714>;
188
189                 ports {
190                         #address-cells = <1>;
191                         #size-cells = <0>;
192
193                         port@0 {
194                                 reg = <0>;
195                                 csi20_in: endpoint {
196                                         clock-lanes = <0>;
197                                         data-lanes = <1>;
198                                         remote-endpoint = <&adv7482_txb>;
199                                 };
200                         };
201
202                         port@1 {
203                                 #address-cells = <1>;
204                                 #size-cells = <0>;
205
206                                 reg = <1>;
207
208                                 csi20vin0: endpoint@0 {
209                                         reg = <0>;
210                                         remote-endpoint = <&vin0csi20>;
211                                 };
212                         };
213                 };
214         };
215
216 [1] video-interfaces.txt common video media interface