Document the driver for Synaptics TDDI (Touch/Display Integration) panels.
Along with the MIPI-DSI panel, these devices also have an in-built LED
backlight device and a touchscreen, all packed together in a single chip.
Also, add compatibles for supported panels - TD4101 and TD4300.
Signed-off-by: Kaustabh Chakraborty <kauschluss@disroot.org>
---
.../display/panel/synaptics,td4300-panel.yaml | 89 ++++++++++++++++++++++
1 file changed, 89 insertions(+)
diff --git a/Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.yaml b/Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..10ac24afdfbc43ca6913bf8a343413eed81f12ff
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.yaml
@@ -0,0 +1,89 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/panel/synaptics,td4300-panel.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Synaptics TDDI Display Panel Controller
+
+maintainers:
+ - Kaustabh Chakraborty <kauschluss@disroot.org>
+
+allOf:
+ - $ref: panel-common.yaml#
+
+properties:
+ compatible:
+ enum:
+ - syna,td4101-panel
+ - syna,td4300-panel
+
+ reg:
+ maxItems: 1
+
+ vio-supply:
+ description: core I/O voltage supply
+
+ vsn-supply:
+ description: negative voltage supply for analog circuits
+
+ vsp-supply:
+ description: positive voltage supply for analog circuits
+
+ backlight-gpios:
+ maxItems: 1
+ description: backlight enable GPIO
+
+ reset-gpios: true
+ width-mm: true
+ height-mm: true
+ panel-timing: true
+
+required:
+ - compatible
+ - reg
+ - width-mm
+ - height-mm
+ - panel-timing
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+
+ dsi {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ panel@0 {
+ compatible = "synaptics,td4300-panel";
+ reg = <0>;
+
+ vio-supply = <&panel_vio_reg>;
+ vsn-supply = <&panel_vsn_reg>;
+ vsp-supply = <&panel_vsp_reg>;
+
+ backlight-gpios = <&gpd3 5 GPIO_ACTIVE_LOW>;
+ reset-gpios = <&gpd3 4 GPIO_ACTIVE_LOW>;
+
+ width-mm = <68>;
+ height-mm = <121>;
+
+ panel-timing {
+ clock-frequency = <144389520>;
+
+ hactive = <1080>;
+ hsync-len = <4>;
+ hfront-porch = <120>;
+ hback-porch = <32>;
+
+ vactive = <1920>;
+ vsync-len = <2>;
+ vfront-porch = <21>;
+ vback-porch = <4>;
+ };
+ };
+ };
+
+...
--
2.49.0
On Wed, Jun 25, 2025 at 03:38:44PM +0530, Kaustabh Chakraborty wrote:
> Document the driver for Synaptics TDDI (Touch/Display Integration) panels.
We document the h/w, not 'the driver'.
> Along with the MIPI-DSI panel, these devices also have an in-built LED
> backlight device and a touchscreen, all packed together in a single chip.
> Also, add compatibles for supported panels - TD4101 and TD4300.
>
> Signed-off-by: Kaustabh Chakraborty <kauschluss@disroot.org>
> ---
> .../display/panel/synaptics,td4300-panel.yaml | 89 ++++++++++++++++++++++
> 1 file changed, 89 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.yaml b/Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.yaml
> new file mode 100644
> index 0000000000000000000000000000000000000000..10ac24afdfbc43ca6913bf8a343413eed81f12ff
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.yaml
> @@ -0,0 +1,89 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/display/panel/synaptics,td4300-panel.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Synaptics TDDI Display Panel Controller
> +
> +maintainers:
> + - Kaustabh Chakraborty <kauschluss@disroot.org>
> +
> +allOf:
> + - $ref: panel-common.yaml#
> +
> +properties:
> + compatible:
> + enum:
> + - syna,td4101-panel
> + - syna,td4300-panel
Can a TD4101 be anything other than a panel (controller)? If not, then
'-panel' is redundant.
> +
> + reg:
> + maxItems: 1
> +
> + vio-supply:
> + description: core I/O voltage supply
> +
> + vsn-supply:
> + description: negative voltage supply for analog circuits
> +
> + vsp-supply:
> + description: positive voltage supply for analog circuits
> +
> + backlight-gpios:
> + maxItems: 1
> + description: backlight enable GPIO
> +
> + reset-gpios: true
> + width-mm: true
> + height-mm: true
> + panel-timing: true
> +
> +required:
> + - compatible
> + - reg
> + - width-mm
> + - height-mm
> + - panel-timing
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> +
> + dsi {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + panel@0 {
> + compatible = "synaptics,td4300-panel";
> + reg = <0>;
> +
> + vio-supply = <&panel_vio_reg>;
> + vsn-supply = <&panel_vsn_reg>;
> + vsp-supply = <&panel_vsp_reg>;
> +
> + backlight-gpios = <&gpd3 5 GPIO_ACTIVE_LOW>;
> + reset-gpios = <&gpd3 4 GPIO_ACTIVE_LOW>;
> +
> + width-mm = <68>;
> + height-mm = <121>;
> +
> + panel-timing {
> + clock-frequency = <144389520>;
> +
> + hactive = <1080>;
> + hsync-len = <4>;
> + hfront-porch = <120>;
> + hback-porch = <32>;
> +
> + vactive = <1920>;
> + vsync-len = <2>;
> + vfront-porch = <21>;
> + vback-porch = <4>;
> + };
> + };
> + };
> +
> +...
>
> --
> 2.49.0
>
On 2025-06-25 15:08, Rob Herring wrote:
> On Wed, Jun 25, 2025 at 03:38:44PM +0530, Kaustabh Chakraborty wrote:
>> Document the driver for Synaptics TDDI (Touch/Display Integration)
>> panels.
>
> We document the h/w, not 'the driver'.
>
>> Along with the MIPI-DSI panel, these devices also have an in-built LED
>> backlight device and a touchscreen, all packed together in a single
>> chip.
>> Also, add compatibles for supported panels - TD4101 and TD4300.
>>
>> Signed-off-by: Kaustabh Chakraborty <kauschluss@disroot.org>
>> ---
>> .../display/panel/synaptics,td4300-panel.yaml | 89
>> ++++++++++++++++++++++
>> 1 file changed, 89 insertions(+)
>>
>> diff --git
>> a/Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.yaml
>> b/Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.yaml
>> new file mode 100644
>> index
>> 0000000000000000000000000000000000000000..10ac24afdfbc43ca6913bf8a343413eed81f12ff
>> --- /dev/null
>> +++
>> b/Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.yaml
>> @@ -0,0 +1,89 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id:
>> http://devicetree.org/schemas/display/panel/synaptics,td4300-panel.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Synaptics TDDI Display Panel Controller
>> +
>> +maintainers:
>> + - Kaustabh Chakraborty <kauschluss@disroot.org>
>> +
>> +allOf:
>> + - $ref: panel-common.yaml#
>> +
>> +properties:
>> + compatible:
>> + enum:
>> + - syna,td4101-panel
>> + - syna,td4300-panel
>
> Can a TD4101 be anything other than a panel (controller)? If not, then
> '-panel' is redundant.
>
TDDI devices are display panels and touchscreens in one chip. So I guess
it's better to explicitly define that its a panel driver.
(Touchscreens are driven by RMI4)
>> +
>> + reg:
>> + maxItems: 1
>> +
>> + vio-supply:
>> + description: core I/O voltage supply
>> +
>> + vsn-supply:
>> + description: negative voltage supply for analog circuits
>> +
>> + vsp-supply:
>> + description: positive voltage supply for analog circuits
>> +
>> + backlight-gpios:
>> + maxItems: 1
>> + description: backlight enable GPIO
>> +
>> + reset-gpios: true
>> + width-mm: true
>> + height-mm: true
>> + panel-timing: true
>> +
>> +required:
>> + - compatible
>> + - reg
>> + - width-mm
>> + - height-mm
>> + - panel-timing
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> + - |
>> + #include <dt-bindings/gpio/gpio.h>
>> +
>> + dsi {
>> + #address-cells = <1>;
>> + #size-cells = <0>;
>> +
>> + panel@0 {
>> + compatible = "synaptics,td4300-panel";
>> + reg = <0>;
>> +
>> + vio-supply = <&panel_vio_reg>;
>> + vsn-supply = <&panel_vsn_reg>;
>> + vsp-supply = <&panel_vsp_reg>;
>> +
>> + backlight-gpios = <&gpd3 5 GPIO_ACTIVE_LOW>;
>> + reset-gpios = <&gpd3 4 GPIO_ACTIVE_LOW>;
>> +
>> + width-mm = <68>;
>> + height-mm = <121>;
>> +
>> + panel-timing {
>> + clock-frequency = <144389520>;
>> +
>> + hactive = <1080>;
>> + hsync-len = <4>;
>> + hfront-porch = <120>;
>> + hback-porch = <32>;
>> +
>> + vactive = <1920>;
>> + vsync-len = <2>;
>> + vfront-porch = <21>;
>> + vback-porch = <4>;
>> + };
>> + };
>> + };
>> +
>> +...
>>
>> --
>> 2.49.0
>>
On Wed, 25 Jun 2025 15:38:44 +0530, Kaustabh Chakraborty wrote: > Document the driver for Synaptics TDDI (Touch/Display Integration) panels. > Along with the MIPI-DSI panel, these devices also have an in-built LED > backlight device and a touchscreen, all packed together in a single chip. > Also, add compatibles for supported panels - TD4101 and TD4300. > > Signed-off-by: Kaustabh Chakraborty <kauschluss@disroot.org> > --- > .../display/panel/synaptics,td4300-panel.yaml | 89 ++++++++++++++++++++++ > 1 file changed, 89 insertions(+) > My bot found errors running 'make dt_binding_check' on your patch: yamllint warnings/errors: dtschema/dtc warnings/errors: Documentation/devicetree/bindings/display/panel/synaptics,td4300-panel.example.dtb: /example-0/dsi/panel@0: failed to match any schema with compatible: ['synaptics,td4300-panel'] doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20250625-panel-synaptics-tddi-v2-1-7a62ab1d13c7@disroot.org The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch. If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date: pip3 install dtschema --upgrade Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.
© 2016 - 2026 Red Hat, Inc.