FROMLIST: dt-bindings: add document for analogix display port driver
[firefly-linux-kernel-4.4.55.git] / Documentation / devicetree / bindings / display / exynos / exynos_dp.txt
1 The Exynos display port interface should be configured based on
2 the type of panel connected to it.
3
4 We use two nodes:
5         -dp-controller node
6         -dptx-phy node(defined inside dp-controller node)
7
8 For the DP-PHY initialization, we use the dptx-phy node.
9 Required properties for dptx-phy: deprecated, use phys and phy-names
10         -reg: deprecated
11                 Base address of DP PHY register.
12         -samsung,enable-mask: deprecated
13                 The bit-mask used to enable/disable DP PHY.
14
15 For the Panel initialization, we read data from dp-controller node.
16 Required properties for dp-controller:
17         -compatible:
18                 should be "samsung,exynos5-dp".
19         -reg:
20                 physical base address of the controller and length
21                 of memory mapped region.
22         -interrupts:
23                 interrupt combiner values.
24         -clocks:
25                 from common clock binding: handle to dp clock.
26         -clock-names:
27                 from common clock binding: Shall be "dp".
28         -interrupt-parent:
29                 phandle to Interrupt combiner node.
30         -phys:
31                 from general PHY binding: the phandle for the PHY device.
32         -phy-names:
33                 from general PHY binding: Should be "dp".
34
35 Optional properties for dp-controller:
36         -interlaced:
37                 interlace scan mode.
38                         Progressive if defined, Interlaced if not defined
39         -vsync-active-high:
40                 VSYNC polarity configuration.
41                         High if defined, Low if not defined
42         -hsync-active-high:
43                 HSYNC polarity configuration.
44                         High if defined, Low if not defined
45         -samsung,hpd-gpio:
46                 Hotplug detect GPIO.
47                         Indicates which GPIO should be used for hotplug
48                         detection
49         -video interfaces: Device node can contain video interface port
50                         nodes according to [1].
51         - display-timings: timings for the connected panel as described by
52                 Documentation/devicetree/bindings/display/panel/display-timing.txt
53
54 For the below properties, please refer to Analogix DP binding document:
55  * Documentation/devicetree/bindings/display/bridge/analogix_dp.txt
56         -phys (required)
57         -phy-names (required)
58         -hpd-gpios (optional)
59
60 Deprecated properties for DisplayPort:
61 -interlaced:            deprecated prop that can parsed from drm_display_mode.
62 -vsync-active-high:     deprecated prop that can parsed from drm_display_mode.
63 -hsync-active-high:     deprecated prop that can parsed from drm_display_mode.
64 -samsung,ycbcr-coeff:   deprecated prop that can parsed from drm_display_mode.
65 -samsung,dynamic-range: deprecated prop that can parsed from drm_display_mode.
66 -samsung,color-space:   deprecated prop that can parsed from drm_display_info.
67 -samsung,color-depth:   deprecated prop that can parsed from drm_display_info.
68 -samsung,link-rate:     deprecated prop that can reading from monitor by dpcd method.
69 -samsung,lane-count:    deprecated prop that can reading from monitor by dpcd method.
70 -samsung,hpd-gpio:      deprecated name for hpd-gpios.
71
72 -------------------------------------------------------------------------------
73
74 Example:
75
76 SOC specific portion:
77         dp-controller {
78                 compatible = "samsung,exynos5-dp";
79                 reg = <0x145b0000 0x10000>;
80                 interrupts = <10 3>;
81                 interrupt-parent = <&combiner>;
82                 clocks = <&clock 342>;
83                 clock-names = "dp";
84
85                 phys = <&dp_phy>;
86                 phy-names = "dp";
87         };
88
89 Board Specific portion:
90         dp-controller {
91                 display-timings {
92                         native-mode = <&lcd_timing>;
93                         lcd_timing: 1366x768 {
94                                 clock-frequency = <70589280>;
95                                 hactive = <1366>;
96                                 vactive = <768>;
97                                 hfront-porch = <40>;
98                                 hback-porch = <40>;
99                                 hsync-len = <32>;
100                                 vback-porch = <10>;
101                                 vfront-porch = <12>;
102                                 vsync-len = <6>;
103                         };
104                 };
105
106                 ports {
107                         port@0 {
108                                 dp_out: endpoint {
109                                         remote-endpoint = <&bridge_in>;
110                                 };
111                         };
112                 };
113         };