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