path: root/Documentation/devicetree/bindings/display/imx/fsl-imx-drm.txt

Freescale i.MX DRM master device
================================

The freescale i.MX DRM master device is a virtual device needed to list all
IPU or other display interface nodes that comprise the graphics subsystem.

Required properties:
- compatible: Should be "fsl,imx-display-subsystem"
- ports: Should contain a list of phandles pointing to display interface ports
  of IPU devices

example:

display-subsystem {
	compatible = "fsl,display-subsystem";
	ports = <&ipu_di0>;
};


Freescale i.MX IPUv3
====================

Required properties:
- compatible: Should be "fsl,<chip>-ipu" where <chip> is one of
  - imx51
  - imx53
  - imx6q
  - imx6qp
- reg: should be register base and length as documented in the
  datasheet
- interrupts: Should contain sync interrupt and error interrupt,
  in this order.
- resets: phandle pointing to the system reset controller and
          reset line index, see reset/fsl,imx-src.txt for details
Additional required properties for fsl,imx6qp-ipu:
- fsl,prg: phandle to prg node associated with this IPU instance
Optional properties:
- port@[0-3]: Port nodes with endpoint definitions as defined in
  Documentation/devicetree/bindings/media/video-interfaces.txt.
  Ports 0 and 1 should correspond to CSI0 and CSI1,
  ports 2 and 3 should correspond to DI0 and DI1, respectively.

example:

ipu: ipu@18000000 {
	#address-cells = <1>;
	#size-cells = <0>;
	compatible = "fsl,imx53-ipu";
	reg = <0x18000000 0x080000000>;
	interrupts = <11 10>;
	resets = <&src 2>;

	ipu_di0: port@2 {
		reg = <2>;

		ipu_di0_disp0: endpoint {
			remote-endpoint = <&display_in>;
		};
	};
};

Freescale i.MX PRE (Prefetch Resolve Engine)
============================================

Required properties:
- compatible: should be "fsl,imx6qp-pre"
- reg: should be register base and length as documented in the
  datasheet
- clocks : phandle to the PRE axi clock input, as described
  in Documentation/devicetree/bindings/clock/clock-bindings.txt and
  Documentation/devicetree/bindings/clock/imx6q-clock.txt.
- clock-names: should be "axi"
- interrupts: should contain the PRE interrupt
- fsl,iram: phandle pointing to the mmio-sram device node, that should be
  used for the PRE SRAM double buffer.

example:

pre@21c8000 {
	compatible = "fsl,imx6qp-pre";
	reg = <0x021c8000 0x1000>;
	interrupts = <GIC_SPI 90 IRQ_TYPE_EDGE_RISING>;
	clocks = <&clks IMX6QDL_CLK_PRE0>;
	clock-names = "axi";
	fsl,iram = <&ocram2>;
};

Freescale i.MX PRG (Prefetch Resolve Gasket)
============================================

Required properties:
- compatible: should be "fsl,imx6qp-prg"
- reg: should be register base and length as documented in the
  datasheet
- clocks : phandles to the PRG ipg and axi clock inputs, as described
  in Documentation/devicetree/bindings/clock/clock-bindings.txt and
  Documentation/devicetree/bindings/clock/imx6q-clock.txt.
- clock-names: should be "ipg" and "axi"
- fsl,pres: phandles to the PRE units attached to this PRG, with the fixed
  PRE as the first entry and the muxable PREs following.

example:

prg@21cc000 {
	compatible = "fsl,imx6qp-prg";
	reg = <0x021cc000 0x1000>;
	clocks = <&clks IMX6QDL_CLK_PRG0_APB>,
		 <&clks IMX6QDL_CLK_PRG0_AXI>;
	clock-names = "ipg", "axi";
	fsl,pres = <&pre1>, <&pre2>, <&pre3>;
};

Freescale i.MX DPU
====================

Required properties:
- compatible: Should be "fsl,<chip>-dpu"
- reg: should be register base and length as documented in the
  datasheet
- interrupt-parent: phandle pointing to the parent interrupt controller.
- interrupts, interrupt-names: Should contain interrupts and names as
  documented in the datasheet.
- clocks, clock-names: phandles to the DPU clocks described in
  Documentation/devicetree/bindings/clock/clock-bindings.txt
  The following clocks are expected on i.MX8qxp:
           "pll0" - PLL clock for display interface 0
           "pll1" - PLL clock for display interface 1
           "disp0" - pixel clock for display interface 0
           "disp1" - pixel clock for display interface 1
  The needed clock numbers for each are documented in
  Documentation/devicetree/bindings/clock/imx8qxp-lpcg.txt.
- power-domains: phandles pointing to power domain.
- power-domain-names: power domain names relevant to power-domains phandles.
- fsl,dpr-channels: phandles to the DPR channels attached to this DPU,
  sorted by memory map addresses.
- fsl,pixel-combiner: phandle to the pixel combiner unit attached to this DPU.
Optional properties:
- port@[0-1]: Port nodes with endpoint definitions as defined in
  Documentation/devicetree/bindings/media/video-interfaces.txt.
  ports 0 and 1 should correspond to display interface 0 and
  display interface 1, respectively.

example:

dpu: dpu@56180000 {
	#address-cells = <1>;
	#size-cells = <0>;
	compatible = "fsl,imx8qxp-dpu";
	reg = <0x56180000 0x40000>;
	interrupt-parent = <&irqsteer_dpu>;
	interrupts = <448>, <449>, <450>,  <64>,
		      <65>,  <66>,  <67>,  <68>,
		      <69>,  <70>, <193>, <194>,
		     <195>, <196>, <197>,  <72>,
		      <73>,  <74>,  <75>,  <76>,
		      <77>,  <78>,  <79>,  <80>,
		      <81>, <199>, <200>, <201>,
		     <202>, <203>, <204>, <205>,
		     <206>, <207>, <208>,   <0>,
		       <1>,   <2>,   <3>,   <4>,
		      <82>,  <83>,  <84>,  <85>,
		     <209>, <210>, <211>, <212>;
	interrupt-names = "store9_shdload",
			  "store9_framecomplete",
			  "store9_seqcomplete",
			  "extdst0_shdload",
			  "extdst0_framecomplete",
			  "extdst0_seqcomplete",
			  "extdst4_shdload",
			  "extdst4_framecomplete",
			  "extdst4_seqcomplete",
			  "extdst1_shdload",
			  "extdst1_framecomplete",
			  "extdst1_seqcomplete",
			  "extdst5_shdload",
			  "extdst5_framecomplete",
			  "extdst5_seqcomplete",
			  "disengcfg_shdload0",
			  "disengcfg_framecomplete0",
			  "disengcfg_seqcomplete0",
			  "framegen0_int0",
			  "framegen0_int1",
			  "framegen0_int2",
			  "framegen0_int3",
			  "sig0_shdload",
			  "sig0_valid",
			  "sig0_error",
			  "disengcfg_shdload1",
			  "disengcfg_framecomplete1",
			  "disengcfg_seqcomplete1",
			  "framegen1_int0",
			  "framegen1_int1",
			  "framegen1_int2",
			  "framegen1_int3",
			  "sig1_shdload",
			  "sig1_valid",
			  "sig1_error",
			  "cmdseq_error",
			  "comctrl_sw0",
			  "comctrl_sw1",
			  "comctrl_sw2",
			  "comctrl_sw3",
			  "framegen0_primsync_on",
			  "framegen0_primsync_off",
			  "framegen0_secsync_on",
			  "framegen0_secsync_off",
			  "framegen1_primsync_on",
			  "framegen1_primsync_off",
			  "framegen1_secsync_on",
			  "framegen1_secsync_off";
	clocks = <&dc_lpcg IMX_DC0_PLL0_CLK>,
		 <&dc_lpcg IMX_DC0_PLL1_CLK>,
		 <&dc_lpcg IMX_DC0_DISP0_CLK>,
		 <&dc_lpcg IMX_DC0_DISP1_CLK>;
	clock-names = "pll0", "pll1", "disp0", "disp1";
	power-domains = <&pd IMX_SC_R_DC_0>,
			<&pd IMX_SC_R_DC_0_PLL_0>,
			<&pd IMX_SC_R_DC_0_PLL_1>;
	power-domain-names = "dc", "pll0", "pll1";
	fsl,dpr-channels = <&dc0_dpr1_channel1>, <&dc0_dpr1_channel2>,
			   <&dc0_dpr1_channel3>, <&dc0_dpr2_channel1>,
			   <&dc0_dpr2_channel2>, <&dc0_dpr2_channel3>;
	fsl,pixel-combiner = <&dc0_pc>;

	dpu_disp0: port@0 {
		reg = <0>;

		dpu_disp0_lvds0_ch0: endpoint@0 {
			remote-endpoint = <&ldb1_ch0>;
		};

		dpu_disp0_lvds0_ch1: endpoint@1 {
			remote-endpoint = <&ldb1_ch1>;
		};

		dpu_disp0_mipi_dsi: endpoint@2 {
		};
	};

	dpu_disp1: port@1 {
		reg = <1>;

		dpu_disp1_lvds1_ch0: endpoint@0 {
			remote-endpoint = <&ldb2_ch0>;
		};

		dpu_disp1_lvds1_ch1: endpoint@1 {
			remote-endpoint = <&ldb2_ch1>;
		};

		dpu_disp1_mipi_dsi: endpoint@2 {
		};
	};
};

Freescale i.MX8 PC (Pixel Combiner)
=============================================
Required properties:
- compatible: should be "fsl,<chip>-pixel-combiner"
- reg: should be register base and length as documented in the
  datasheet
- power-domains: phandle pointing to power domain

example:

pixel-combiner@56020000 {
	compatible = "fsl,imx8qm-pixel-combiner";
	reg = <0x56020000 0x10000>;
	power-domains = <&pd IMX_SC_R_DC_0>;
};

Freescale i.MX8 PRG (Prefetch Resolve Gasket)
=============================================
Required properties:
- compatible: should be "fsl,<chip>-prg"
- reg: should be register base and length as documented in the
  datasheet
- clocks: phandles to the PRG apb and rtram clocks, as described in
  Documentation/devicetree/bindings/clock/clock-bindings.txt and
  Documentation/devicetree/bindings/clock/imx8qxp-lpcg.txt.
- clock-names: should be "apb" and "rtram"
- power-domains: phandle pointing to power domain

example:

prg@56040000 {
	compatible = "fsl,imx8qm-prg";
	reg = <0x56040000 0x10000>;
	clocks = <&dc0_prg0_lpcg 0>, <&dc0_prg0_lpcg 1>;
	clock-names = "apb", "rtram";
	power-domains = <&pd IMX_SC_R_DC_0>;
};

Freescale i.MX8 DPRC (Display Prefetch Resolve Channel)
=======================================================
Required properties:
- compatible: should be "fsl,<chip>-dpr-channel"
- reg: should be register base and length as documented in the
  datasheet
- fsl,sc-resource: SCU resource number as defined in
  include/dt-bindings/firmware/imx/rsrc.h
- fsl,prgs: phandles to the PRG unit(s) attached to this DPRC, the first one
  is the primary PRG and the second one(if available) is the auxiliary PRG
  which is used to fetch luma chunk of a YUV frame with 2 planars.
- clocks: phandles to the DPRC apb, b and rtram clocks, as described in
  Documentation/devicetree/bindings/clock/clock-bindings.txt and
  Documentation/devicetree/bindings/clock/imx8qxp-lpcg.txt.
- clock-names: should be "apb", "b" and "rtram"
- power-domains: phandle pointing to power domain

example:

dpr-channel@560e0000 {
	compatible = "fsl,imx8qm-dpr-channel";
	reg = <0x560e0000 0x10000>;
	fsl,sc-resource = <IMX_SC_R_DC_0_BLIT1>;
	fsl,prgs = <&dc0_prg2>, <&dc0_prg1>;
	clocks = <&dc0_dpr0_lpcg 0>,
		 <&dc0_dpr0_lpcg 1>,
		 <&dc0_rtram0_lpcg 0>;
	clock-names = "apb", "b", "rtram";
	power-domains = <&pd IMX_SC_R_DC_0>;
};

Parallel display support
========================

Required properties:
- compatible: Should be "fsl,imx-parallel-display"
Optional properties:
- interface-pix-fmt: How this display is connected to the
  display interface. Currently supported types: "rgb24", "rgb565", "bgr666"
  and "lvds666".
- edid: verbatim EDID data block describing attached display.
- ddc: phandle describing the i2c bus handling the display data
  channel
- port@[0-1]: Port nodes with endpoint definitions as defined in
  Documentation/devicetree/bindings/media/video-interfaces.txt.
  Port 0 is the input port connected to the IPU display interface,
  port 1 is the output port connected to a panel.

example:

disp0 {
	compatible = "fsl,imx-parallel-display";
	edid = [edid-data];
	interface-pix-fmt = "rgb24";

	port@0 {
		reg = <0>;

		display_in: endpoint {
			remote-endpoint = <&ipu_di0_disp0>;
		};
	};

	port@1 {
		reg = <1>;

		display_out: endpoint {
			remote-endpoint = <&panel_in>;
		};
	};
};

panel {
	...

	port {
		panel_in: endpoint {
			remote-endpoint = <&display_out>;
		};
	};
};