Re: [PATCH v3 2/4] Documentation: DT: bindings: input: Add documentation for cyttsp5

From: Rob Herring
Date: Mon Dec 06 2021 - 15:52:40 EST


On Thu, Dec 02, 2021 at 10:20:19PM +1000, Alistair Francis wrote:
> From: Mylène Josserand <mylene.josserand@xxxxxxxxxxxxxxxxxx>

For the subject, use subjects matching other commits for the directory
and 'documentation' (twice) is redundant as that's all bindings:

dt-bindings: input: Add Cypress TT2100 touchscreen controller

>
> Add the Cypress TrueTouch Generation 5 touchscreen device tree bindings
> documentation. It can use I2C or SPI bus.
> This touchscreen can handle some defined zone that are designed and
> sent as button. To be able to customize the keycode sent, the
> "linux,code" property in a "button" sub-node can be used.
>
> Signed-off-by: Mylène Josserand <mylene.josserand@xxxxxxxxxxxxxxxxxx>
> Message-Id: <20170529144538.29187-3-mylene.josserand@xxxxxxxxxxxxxxxxxx>

Not a tag used in the kernel.

> Signed-off-by: Alistair Francis <alistair@xxxxxxxxxxxxx>
> ---
> .../input/touchscreen/cypress,tt21000.yaml | 92 +++++++++++++++++++
> 1 file changed, 92 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/input/touchscreen/cypress,tt21000.yaml
>
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/cypress,tt21000.yaml b/Documentation/devicetree/bindings/input/touchscreen/cypress,tt21000.yaml
> new file mode 100644
> index 000000000000..f3f353192917
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/touchscreen/cypress,tt21000.yaml
> @@ -0,0 +1,92 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/touchscreen/cypress,tt21000.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Cypress TT2100 touchscreen controller
> +
> +description: The Cypress TT2100 series (also known as "CYTTSP5" after
> + the marketing name Cypress TrueTouch Standard Product series 5).
> +
> +maintainers:
> + - Alistair Francis <alistair@xxxxxxxxxxxxx>
> +
> +allOf:
> + - $ref: touchscreen.yaml#
> +
> +properties:
> + compatible:
> + const: cypress,tt21000
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + vdd-supply:
> + description: Regulator for voltage.
> +
> + reset-gpios:
> + maxItems: 1
> +
> + linux,code:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: EV_ABS specific event code generated by the axis.
> +
> +patternProperties:
> + "^button-[0-9]+$":
> + type: object
> + properties:
> + linux,code:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: Keycode to emit
> +
> + required:
> + - linux,code
> +
> + additionalProperties: false
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - vdd-supply
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> + #include <dt-bindings/gpio/gpio.h>
> + #include <dt-bindings/input/linux-event-codes.h>
> +
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + touchscreen@24 {
> + compatible = "cypress,tt2100";
> + reg = <0x24>;
> + pinctrl-names = "default";
> + pinctrl-0 = <&tp_reset_ds203>;
> + interrupt-parent = <&pio>;
> + interrupts = <1 5 IRQ_TYPE_LEVEL_LOW>;
> + reset-gpios = <&pio 7 1 GPIO_ACTIVE_LOW>;
> + vdd-supply = <&reg_touch>;
> +
> + button@0 {
> + linux,code = <KEY_HOMEPAGE>;
> + };
> +
> + button@1 {
> + linux,code = <KEY_MENU>;
> + };
> +
> + button@2 {
> + linux,code = <KEY_BACK>;
> + };
> + };
> + };
> +...
> --
> 2.31.1
>
>