| Message ID | TY0PR06MB56116A355D2A5BF665FA0D899E85A@TY0PR06MB5611.apcprd06.prod.outlook.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Add HX83102j driver for HIMAX HID touchscreen | expand |
| Context | Check | Description |
|---|---|---|
| robh/checkpatch | success | |
| robh/patch-applied | success | |
| robh/dtbs-check | warning | build log |
| robh/dt-meta-schema | success |
On 05/12/2023 11:05, Allen_Lin wrote: > Add the HX83102j touchscreen device tree bindings documents. > > Signed-off-by: Allen_Lin <allencl_lin@hotmail.com> > --- > .../bindings/input/himax,hx8310xx.yaml | 70 +++++++++++++++++++ > MAINTAINERS | 6 ++ > 2 files changed, 76 insertions(+) > create mode 100644 Documentation/devicetree/bindings/input/himax,hx8310xx.yaml > > diff --git a/Documentation/devicetree/bindings/input/himax,hx8310xx.yaml b/Documentation/devicetree/bindings/input/himax,hx8310xx.yaml > new file mode 100644 > index 000000000000..1cc65e9bd267 > --- /dev/null > +++ b/Documentation/devicetree/bindings/input/himax,hx8310xx.yaml Filename like compatible, so himax,hx83102j.yaml > @@ -0,0 +1,70 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/input/himax,hx8310xx.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: himax hx8310xx touchscreen Himax? HiMax? lowercase "himax" seems wrong and your commit msg also suggest different capitalization. The same for "hx8310xx". And it is not "xx" but 2J. > + > +maintainers: > + - Allen Lin <allencl_lin@hotmail.com> > + > +description: > + Supports the himax hx8310xx touchscreen. Drop sentence, instead describe hardware like "Himax HX83102J is a touchscreen connected over SPI ...." > + This touchscreen uses the spi-hid protocol but has some non-standard > + power sequencing required. > + > +allOf: > + - $ref: /schemas/input/touchscreen/touchscreen.yaml# Missing ref to spi-peripheral-props > + > +properties: > + compatible: > + enum: > + - himax,hx83102j > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + reset-gpios: > + maxItems: 1 > + > + spi-cpha: true > + > + spi-cpol: true > + > + spi-max-frequency: true > + > +required: > + - compatible > + - reg > + - interrupts > + - reset-gpios > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/clock/qcom,rpmh.h> Why? Drop > + #include <dt-bindings/gpio/gpio.h> > + #include <dt-bindings/interrupt-controller/irq.h> > + spi { > + #address-cells = <1>; > + #size-cells = <0>; > + > + hid_himax_spi@0 { No underscores in node names. Node names should be generic. See also an explanation and list of examples (not exhaustive) in DT specification: https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation > + pinctrl-names = "default"; > + pinctrl-0 = <&touch_int0 &touch_reset>; > + reg = <0>; Oh damn... ok, so compatible is always the first property. Reg is second. > + spi-max-frequency = <12500000>; > + status = "okay"; Drop > + compatible = "himax,hx83102j"; > + reset-gpios = <&gpio1 8 GPIO_ACTIVE_LOW>; > + spi-cpha; > + spi-cpol; > + interrupt-parent = <&gpio1>; > + interrupts = <7 IRQ_TYPE_LEVEL_LOW>; > + }; > + }; Best regards, Krzysztof
diff --git a/Documentation/devicetree/bindings/input/himax,hx8310xx.yaml b/Documentation/devicetree/bindings/input/himax,hx8310xx.yaml new file mode 100644 index 000000000000..1cc65e9bd267 --- /dev/null +++ b/Documentation/devicetree/bindings/input/himax,hx8310xx.yaml @@ -0,0 +1,70 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/input/himax,hx8310xx.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: himax hx8310xx touchscreen + +maintainers: + - Allen Lin <allencl_lin@hotmail.com> + +description: + Supports the himax hx8310xx touchscreen. + This touchscreen uses the spi-hid protocol but has some non-standard + power sequencing required. + +allOf: + - $ref: /schemas/input/touchscreen/touchscreen.yaml# + +properties: + compatible: + enum: + - himax,hx83102j + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + reset-gpios: + maxItems: 1 + + spi-cpha: true + + spi-cpol: true + + spi-max-frequency: true + +required: + - compatible + - reg + - interrupts + - reset-gpios + +additionalProperties: false + +examples: + - | + #include <dt-bindings/clock/qcom,rpmh.h> + #include <dt-bindings/gpio/gpio.h> + #include <dt-bindings/interrupt-controller/irq.h> + spi { + #address-cells = <1>; + #size-cells = <0>; + + hid_himax_spi@0 { + pinctrl-names = "default"; + pinctrl-0 = <&touch_int0 &touch_reset>; + reg = <0>; + spi-max-frequency = <12500000>; + status = "okay"; + compatible = "himax,hx83102j"; + reset-gpios = <&gpio1 8 GPIO_ACTIVE_LOW>; + spi-cpha; + spi-cpol; + interrupt-parent = <&gpio1>; + interrupts = <7 IRQ_TYPE_LEVEL_LOW>; + }; + }; diff --git a/MAINTAINERS b/MAINTAINERS index 012df8ccf34e..cadcbf7294a6 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -9502,6 +9502,12 @@ L: linux-kernel@vger.kernel.org S: Maintained F: drivers/misc/hisi_hikey_usb.c +HIMAX HID HX83102J TOUCHSCREEN +M: Allen Lin <allencl_lin@hotmail.com> +L: linux-input@vger.kernel.org +S: Maintained +F: Documentation/devicetree/bindings/input/himax,hx8310xx.yaml + HIMAX HX83112B TOUCHSCREEN SUPPORT M: Job Noorman <job@noorman.info> L: linux-input@vger.kernel.org
Add the HX83102j touchscreen device tree bindings documents. Signed-off-by: Allen_Lin <allencl_lin@hotmail.com> --- .../bindings/input/himax,hx8310xx.yaml | 70 +++++++++++++++++++ MAINTAINERS | 6 ++ 2 files changed, 76 insertions(+) create mode 100644 Documentation/devicetree/bindings/input/himax,hx8310xx.yaml