dt-bindings: display: bridge: Convert lvds-transmitter binding to json-schema
[platform/kernel/linux-starfive.git] / Documentation / devicetree / bindings / display / bridge / lvds-transmitter.yaml
1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/display/bridge/lvds-transmitter.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Parallel to LVDS Encoder
8
9 maintainers:
10   - Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
11
12 description: |
13   This binding supports the parallel to LVDS encoders that don't require any
14   configuration.
15
16   LVDS is a physical layer specification defined in ANSI/TIA/EIA-644-A. Multiple
17   incompatible data link layers have been used over time to transmit image data
18   to LVDS panels. This binding targets devices compatible with the following
19   specifications only.
20
21   [JEIDA] "Digital Interface Standards for Monitor", JEIDA-59-1999, February
22   1999 (Version 1.0), Japan Electronic Industry Development Association (JEIDA)
23   [LDI] "Open LVDS Display Interface", May 1999 (Version 0.95), National
24   Semiconductor
25   [VESA] "VESA Notebook Panel Standard", October 2007 (Version 1.0), Video
26   Electronics Standards Association (VESA)
27
28   Those devices have been marketed under the FPD-Link and FlatLink brand names
29   among others.
30
31 properties:
32   compatible:
33     description: |
34       Any encoder compatible with this generic binding, but with additional
35       properties not listed here, must define its own binding and list a device
36       specific compatible first followed by the generic compatible.
37     enum:
38       - lvds-encoder
39
40   ports:
41     type: object
42     description: |
43       This device has two video ports. Their connections are modeled using the
44       OF graph bindings specified in Documentation/devicetree/bindings/graph.txt
45     properties:
46       port@0:
47         type: object
48         description: |
49           Port 0 is for parallel input
50
51       port@1:
52         type: object
53         description: |
54           Port 1 is for LVDS output
55
56     required:
57       - port@0
58       - port@1
59
60 required:
61   - compatible
62   - ports
63
64 examples:
65   - |
66     lvds-encoder {
67       compatible = "lvds-encoder";
68
69       ports {
70         #address-cells = <1>;
71         #size-cells = <0>;
72
73         port@0 {
74           reg = <0>;
75
76           lvds_enc_in: endpoint {
77             remote-endpoint = <&display_out_rgb>;
78           };
79         };
80
81         port@1 {
82           reg = <1>;
83
84           lvds_enc_out: endpoint {
85             remote-endpoint = <&lvds_panel_in>;
86           };
87         };
88       };
89     };
90
91 ...