Documentation: dt-bindings: rockchip: introduce dclk_source
[firefly-linux-kernel-4.4.55.git] / Documentation / devicetree / bindings / display / rockchip / rockchip-vop.txt
1 device-tree bindings for rockchip soc display controller (vop)
2
3 VOP (Visual Output Processor) is the Display Controller for the Rockchip
4 series of SoCs which transfers the image data from a video memory
5 buffer to an external LCD interface.
6
7 Required properties:
8 - compatible: value should be one of the following
9                 "rockchip,rk3036-vop";
10                 "rockchip,rk3288-vop";
11                 "rockchip,rk3368-vop";
12                 "rockchip,rk3366-vop";
13                 "rockchip,rk3399-vop-big";
14                 "rockchip,rk3399-vop-lit";
15                 "rockchip,rk322x-vop";
16                 "rockchip,rk3328-vop";
17
18 - reg: there are two register region can configure for the device:
19   - first region: (Required) Base address and size of the controllers
20   - second region: (Optinal) Address and length of the gamma table,
21                    take care of this register's length, driver would use
22                    register's length to decide gamma table size.
23
24 - interrupts: should contain a list of all VOP IP block interrupts in the
25                  order: VSYNC, LCD_SYSTEM. The interrupt specifier
26                  format depends on the interrupt controller used.
27
28 - clocks: must include clock specifiers corresponding to entries in the
29                 clock-names property.
30
31 - clock-names: Must contain
32                 aclk_vop: for ddr buffer transfer.
33                 hclk_vop: for ahb bus to R/W the phy regs.
34                 dclk_vop: pixel clock.
35                 dclk_source: optinal, dclk sources from display plls.
36
37 - resets: Must contain an entry for each entry in reset-names.
38   See ../reset/reset.txt for details.
39 - reset-names: Must include the following entries:
40   - axi
41   - ahb
42   - dclk
43
44 - iommus: required a iommu node
45
46 - port: A port node with endpoint definitions as defined in
47   Documentation/devicetree/bindings/media/video-interfaces.txt.
48
49 Example:
50 SoC specific DT entry:
51         vopb: vopb@ff930000 {
52                 compatible = "rockchip,rk3288-vop";
53                 reg = <0xff930000 0x19c>, <0xff931000 0x1000>;
54                 interrupts = <GIC_SPI 15 IRQ_TYPE_LEVEL_HIGH>;
55                 clocks = <&cru ACLK_VOP0>, <&cru DCLK_VOP0>, <&cru HCLK_VOP0>;
56                 clock-names = "aclk_vop", "dclk_vop", "hclk_vop";
57                 resets = <&cru SRST_LCDC1_AXI>, <&cru SRST_LCDC1_AHB>, <&cru SRST_LCDC1_DCLK>;
58                 reset-names = "axi", "ahb", "dclk";
59                 iommus = <&vopb_mmu>;
60                 vopb_out: port {
61                         #address-cells = <1>;
62                         #size-cells = <0>;
63                         vopb_out_edp: endpoint@0 {
64                                 reg = <0>;
65                                 remote-endpoint=<&edp_in_vopb>;
66                         };
67                         vopb_out_hdmi: endpoint@1 {
68                                 reg = <1>;
69                                 remote-endpoint=<&hdmi_in_vopb>;
70                         };
71                 };
72         };