Commit 1dd89152 authored by Ricardo Cañuelo's avatar Ricardo Cañuelo Committed by Sam Ravnborg
Browse files

dt-bindings: display: ti,tfp410.txt: convert to yaml



Convert the DT binding documentation for the TI TFP410 DPI-to-DVI
encoder to json-schema.

Signed-off-by: default avatarRicardo Cañuelo <ricardo.canuelo@collabora.com>
Reviewed-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: default avatarSam Ravnborg <sam@ravnborg.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20200617094633.19663-2-ricardo.canuelo@collabora.com
parent 94f07917
Loading
Loading
Loading
Loading
+0 −66
Original line number Diff line number Diff line
TFP410 DPI to DVI encoder
=========================

Required properties:
- compatible: "ti,tfp410"

Optional properties:
- powerdown-gpios: power-down gpio
- reg: I2C address. If and only if present the device node should be placed
  into the I2C controller node where the TFP410 I2C is connected to.
- ti,deskew: data de-skew in 350ps increments, from -4 to +3, as configured
  through th DK[3:1] pins. This property shall be present only if the TFP410
  is not connected through I2C.

Required nodes:

This device has two video ports. Their connections are modeled using the OF
graph bindings specified in [1]. Each port node shall have a single endpoint.

- Port 0 is the DPI input port. Its endpoint subnode shall contain a
  pclk-sample and bus-width property and a remote-endpoint property as specified
  in [1].
  - If pclk-sample is not defined, pclk-sample = 0 should be assumed for
    backward compatibility.
  - If bus-width is not defined then bus-width = 24 should be assumed for
    backward compatibility.
    bus-width = 24: 24 data lines are connected and single-edge mode
    bus-width = 12: 12 data lines are connected and dual-edge mode

- Port 1 is the DVI output port. Its endpoint subnode shall contain a
  remote-endpoint property is specified in [1].

[1] Documentation/devicetree/bindings/media/video-interfaces.txt


Example
-------

tfp410: encoder@0 {
	compatible = "ti,tfp410";
	powerdown-gpios = <&twl_gpio 2 GPIO_ACTIVE_LOW>;
	ti,deskew = <4>;

	ports {
		#address-cells = <1>;
		#size-cells = <0>;

		port@0 {
			reg = <0>;

			tfp410_in: endpoint@0 {
				pclk-sample = <1>;
				bus-width = <24>;
				remote-endpoint = <&dpi_out>;
			};
		};

		port@1 {
			reg = <1>;

			tfp410_out: endpoint@0 {
				remote-endpoint = <&dvi_connector_in>;
			};
		};
	};
};
+130 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: GPL-2.0-only
%YAML 1.2
---
$id: http://devicetree.org/schemas/display/bridge/ti,tfp410.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: TFP410 DPI to DVI encoder

maintainers:
  - Tomi Valkeinen <tomi.valkeinen@ti.com>
  - Jyri Sarha <jsarha@ti.com>

properties:
  compatible:
    const: ti,tfp410

  reg:
    description: I2C address of the device.
    maxItems: 1

  powerdown-gpios:
    maxItems: 1

  ti,deskew:
    description:
      Data de-skew in 350ps increments, from -4 to +3, as configured
      through th DK[3:1] pins. This property shall be present only if the TFP410
      is not connected through I2C.
    maxItems: 1
    $ref: /schemas/types.yaml#/definitions/uint32

  ports:
    description:
      A node containing input and output port nodes with endpoint
      definitions as documented in
      Documentation/devicetree/bindings/media/video-interfaces.txt
    type: object

    properties:
      port@0:
        description: DPI input port.
        type: object

        properties:
          reg:
            const: 0

          endpoint:
            type: object

            properties:
              pclk-sample:
                description:
                  Endpoint sampling edge.
                enum:
                  - 0  # Falling edge
                  - 1  # Rising edge
                default: 0

              bus-width:
                description:
                  Endpoint bus width.
                enum:
                  - 12  # 12 data lines connected and dual-edge mode
                  - 24  # 24 data lines connected and single-edge mode
                default: 24

      port@1:
        description: DVI output port.
        type: object

        properties:
          reg:
            const: 1

          endpoint:
            type: object

    required:
      - port@0
      - port@1

required:
  - compatible
  - ports

if:
  required:
    - reg
then:
  properties:
    ti,deskew: false
else:
  required:
    - ti,deskew

additionalProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>

    tfp410: encoder {
        compatible = "ti,tfp410";
        powerdown-gpios = <&twl_gpio 2 GPIO_ACTIVE_LOW>;
        ti,deskew = <3>;

        ports {
            #address-cells = <1>;
            #size-cells = <0>;

            port@0 {
                reg = <0>;
                tfp410_in: endpoint {
                    pclk-sample = <1>;
                    bus-width = <24>;
                    remote-endpoint = <&dpi_out>;
                };
            };

            port@1 {
                reg = <1>;
                tfp410_out: endpoint {
                    remote-endpoint = <&dvi_connector_in>;
                };
            };
        };
    };

...