Re: [PATCH 1/1] dt-bindings: input: touchscreen: convert ads7846.txt to yaml

[Marek Vasut <marex@xxxxxxx>]

On 8/14/24 8:51 PM, Frank Li wrote:

Hi,

> diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti,ads7843.yaml b/Documentation/devicetree/bindings/input/touchscreen/ti,ads7843.yaml
> new file mode 100644
> index 0000000000000..b8239491c747a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/touchscreen/ti,ads7843.yaml
> @@ -0,0 +1,170 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/touchscreen/ti,ads7843.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: TI's SPI driven touch screen controllers.
> +
> +maintainers:
> +  - Dmitry Torokhov <dmitry.torokhov@xxxxxxxxx>
> +  - Marek Vasut <marex@xxxxxxx>
> +  - Alexander Stein <alexander.stein@xxxxxxxxxxxxxxx>

Keep the list sorted alphabetically .

 +description:
> +  Device tree bindings for TI's ADS7843, ADS7845, ADS7846, ADS7873, TSC2046
> +  SPI driven touch screen controllers.
> +
> +  The node for this driver must be a child node of a SPI controller, hence
> +  all mandatory properties described in

... described in ... what/where ? I think part of the sentence is 
missing here.

> +properties:
> +  compatible:
> +    enum:
> +      - ti,tsc2046
> +      - ti,ads7843
> +      - ti,ads7845
> +      - ti,ads7846
> +      - ti,ads7873

Keep the list sorted alphabetically.

> +  interrupts:
> +    maxItems: 1
> +
> +  vcc-supply:
> +    description: A regulator node for the supply voltage.
> +
> +  ti,vref-delay-usecs:
> +    $ref: /schemas/types.yaml#/definitions/uint16
> +    description: vref supply delay in usecs, 0 for external vref (u16).

Maybe the (u16) is duplicate of the $ref'd type ? Drop for all the rest 
below too ?

> +  ti,vref-mv:
> +    $ref: /schemas/types.yaml#/definitions/uint16
> +    description:
> +      The VREF voltage, in millivolts (u16).
> +      Set to 0 to use internal references (ADS7846).
> +
> +  ti,keep-vref-on:
> +    $ref: /schemas/types.yaml#/definitions/flag
> +    description: set to keep vref on for differential measurements as well.

Vref , because V (voltage) is written with capitals ...

> +  ti,settle-delay-usec:
> +    $ref: /schemas/types.yaml#/definitions/uint16
> +    description:
> +      Settling time of the analog signals; a function of Vcc and the

... like Vcc here.

> +      capacitance on the X/Y drivers.  If set to non-zero, two samples are
> +      taken with settle_delay us apart, and the second one is used. ~150
> +      uSec with 0.01uF caps (u16).

[...]

> +  ti,pendown-gpio-debounce:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: Platform specific debounce time for the pendown-gpio (u32).
> +
> +  pendown-gpio:
> +    description:
> +      GPIO handle describing the pin the !PENIRQ line is connected to.

I think the properties have to be sorted alphabetically too.

[...]

> +required:
> +  - compatible
> +  - reg
> +  - vcc-supply

Is vcc-supply really required ?

> +allOf:
> +  - $ref: touchscreen.yaml#
> +  - $ref: /schemas/spi/spi-peripheral-props.yaml#
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    spi{
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        touchscreen@0 {
> +           compatible = "ti,tsc2046";
> +           reg = <0>;	/* CS0 */
> +           interrupt-parent = <&gpio1>;
> +           interrupts = <8 0>;	/* BOOT6 / GPIO 8 */
> +           spi-max-frequency = <1000000>;
> +           pendown-gpio = <&gpio1 8 0>;
> +           vcc-supply = <&reg_vcc3>;

Sort please .

> +           ti,x-min = /bits/ 16 <0>;
> +           ti,x-max = /bits/ 16 <8000>;
> +           ti,y-min = /bits/ 16 <0>;
> +           ti,y-max = /bits/ 16 <4800>;
> +           ti,x-plate-ohms = /bits/ 16 <40>;
> +           ti,pressure-max = /bits/ 16 <255>;
> +
> +           wakeup-source;
> +       };
> +    };
> +

Thanks !