| Message ID | 20240614121538.236727-3-charles.goodix@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | HID: add initial support for Goodix HID-over-SPI touchscreen | expand |
On Fri, 14 Jun 2024 20:15:38 +0800, Charles Wang wrote: > The Goodix GT7986U touch controller report touch data according to the > HID protocol through the SPI bus. However, it is incompatible with > Microsoft's HID-over-SPI protocol. > > Signed-off-by: Charles Wang <charles.goodix@gmail.com> > --- > .../bindings/input/goodix,gt7986u.yaml | 65 +++++++++++++++++++ > 1 file changed, 65 insertions(+) > create mode 100644 Documentation/devicetree/bindings/input/goodix,gt7986u.yaml > My bot found errors running 'make dt_binding_check' on your patch: yamllint warnings/errors: dtschema/dtc warnings/errors: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/input/goodix,gt7986u.example.dtb: touchscreen@0: 'spi-max-frequency' does not match any of the regexes: 'pinctrl-[0-9]+' from schema $id: http://devicetree.org/schemas/input/goodix,gt7986u.yaml# doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20240614121538.236727-3-charles.goodix@gmail.com 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.
On Fri, Jun 14, 2024 at 08:15:38PM +0800, Charles Wang wrote: > The Goodix GT7986U touch controller report touch data according to the > HID protocol through the SPI bus. However, it is incompatible with > Microsoft's HID-over-SPI protocol. > > Signed-off-by: Charles Wang <charles.goodix@gmail.com> > --- > .../bindings/input/goodix,gt7986u.yaml | 65 +++++++++++++++++++ > 1 file changed, 65 insertions(+) > create mode 100644 Documentation/devicetree/bindings/input/goodix,gt7986u.yaml > > diff --git a/Documentation/devicetree/bindings/input/goodix,gt7986u.yaml b/Documentation/devicetree/bindings/input/goodix,gt7986u.yaml > new file mode 100644 > index 000000000..1c518d03b > --- /dev/null > +++ b/Documentation/devicetree/bindings/input/goodix,gt7986u.yaml > @@ -0,0 +1,65 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/input/goodix,gt7986u.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: GOODIX GT7986U SPI HID Touchscreen > + > +maintainers: > + - Charles Wang <charles.goodix@gmail.com> > + > +description: > + Supports the Goodix GT7986U touchscreen. > + This touch controller reports data packaged according to the HID protocol, > + but is incompatible with Microsoft's HID-over-SPI protocol. > + > +allOf: > + - $ref: /schemas/spi/spi-peripheral-props.yaml# > + > +properties: > + compatible: > + enum: > + - goodix,gt7986u > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + reset-gpios: > + maxItems: 1 > + description: reset gpio the chip is connected to. > + > + goodix,hid-report-addr: > + description: the register address for retrieving HID report data. > + $ref: /schemas/types.yaml#/definitions/uint32 > + > +additionalProperties: false unevaluatedProperties: false. Please test your binding w/ dt_binding_check. > + > +required: > + - compatible > + - reg > + - interrupts > + - goodix,hid-report-addr > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + #include <dt-bindings/gpio/gpio.h> > + spi { > + #address-cells = <1>; > + #size-cells = <0>; > + num-cs = <1>; > + cs-gpios = <&gpio 2 GPIO_ACTIVE_HIGH>; cs-gpios shouldn't be needed for a basic example. Blank line here before the child node please. Thanks, Conor. > + touchscreen@0 { > + compatible = "goodix,gt7986u"; > + reg = <0>; > + interrupt-parent = <&gpio>; > + interrupts = <25 IRQ_TYPE_LEVEL_LOW>; > + reset-gpios = <&gpio1 1 GPIO_ACTIVE_LOW>; > + spi-max-frequency = <10000000>; > + goodix,hid-report-addr = <0x22c8c>; > + }; > + }; > -- > 2.43.0 > >
On Fri, Jun 14, 2024 at 08:15:38PM +0800, Charles Wang wrote: > The Goodix GT7986U touch controller report touch data according to the > HID protocol through the SPI bus. However, it is incompatible with > Microsoft's HID-over-SPI protocol. > +properties: > + compatible: > + enum: > + - goodix,gt7986u > + goodix,hid-report-addr: > + description: the register address for retrieving HID report data. > + $ref: /schemas/types.yaml#/definitions/uint32 You're also missing an explanation anywhere in the patch for why this address varies between gt7986u devices.
On Fri, Jun 14, 2024 at 04:26:22PM +0100, Conor Dooley wrote: > On Fri, Jun 14, 2024 at 08:15:38PM +0800, Charles Wang wrote: > > The Goodix GT7986U touch controller report touch data according to the > > HID protocol through the SPI bus. However, it is incompatible with > > Microsoft's HID-over-SPI protocol. > > > > Signed-off-by: Charles Wang <charles.goodix@gmail.com> > > --- > > .../bindings/input/goodix,gt7986u.yaml | 65 +++++++++++++++++++ > > 1 file changed, 65 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/input/goodix,gt7986u.yaml > > > > diff --git a/Documentation/devicetree/bindings/input/goodix,gt7986u.yaml b/Documentation/devicetree/bindings/input/goodix,gt7986u.yaml > > new file mode 100644 > > index 000000000..1c518d03b > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/input/goodix,gt7986u.yaml > > @@ -0,0 +1,65 @@ > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/input/goodix,gt7986u.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: GOODIX GT7986U SPI HID Touchscreen > > + > > +maintainers: > > + - Charles Wang <charles.goodix@gmail.com> > > + > > +description: > > + Supports the Goodix GT7986U touchscreen. > > + This touch controller reports data packaged according to the HID protocol, > > + but is incompatible with Microsoft's HID-over-SPI protocol. > > + > > +allOf: > > + - $ref: /schemas/spi/spi-peripheral-props.yaml# > > + > > +properties: > > + compatible: > > + enum: > > + - goodix,gt7986u > > + > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + maxItems: 1 > > + > > + reset-gpios: > > + maxItems: 1 > > + description: reset gpio the chip is connected to. > > + > > + goodix,hid-report-addr: > > + description: the register address for retrieving HID report data. > > + $ref: /schemas/types.yaml#/definitions/uint32 > > + > > +additionalProperties: false > > unevaluatedProperties: false. > > Please test your binding w/ dt_binding_check. > Ack. I have tested it using "make dt_binding_check" and there were no errors or warnings output. :( Additionally, I have already run "pip3 install dtschema --upgrade". > > + > > +required: > > + - compatible > > + - reg > > + - interrupts > > + - goodix,hid-report-addr > > + > > +examples: > > + - | > > + #include <dt-bindings/interrupt-controller/irq.h> > > + #include <dt-bindings/gpio/gpio.h> > > + spi { > > + #address-cells = <1>; > > + #size-cells = <0>; > > + num-cs = <1>; > > + cs-gpios = <&gpio 2 GPIO_ACTIVE_HIGH>; > > cs-gpios shouldn't be needed for a basic example. > > Blank line here before the child node please. > Ack Charles Thanks
On Fri, Jun 14, 2024 at 04:27:52PM +0100, Conor Dooley wrote: > On Fri, Jun 14, 2024 at 08:15:38PM +0800, Charles Wang wrote: > > The Goodix GT7986U touch controller report touch data according to the > > HID protocol through the SPI bus. However, it is incompatible with > > Microsoft's HID-over-SPI protocol. > > > +properties: > > + compatible: > > + enum: > > + - goodix,gt7986u > > > + goodix,hid-report-addr: > > + description: the register address for retrieving HID report data. > > + $ref: /schemas/types.yaml#/definitions/uint32 > > You're also missing an explanation anywhere in the patch for why this > address varies between gt7986u devices. Ack, I will add an explanation in the next commit. The address variation between GT7986U devices is related to their firmware versions. While we strive to maintain consistency, significant firmware upgrades might necessitate changes to this address. Charles Thanks
diff --git a/Documentation/devicetree/bindings/input/goodix,gt7986u.yaml b/Documentation/devicetree/bindings/input/goodix,gt7986u.yaml new file mode 100644 index 000000000..1c518d03b --- /dev/null +++ b/Documentation/devicetree/bindings/input/goodix,gt7986u.yaml @@ -0,0 +1,65 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/input/goodix,gt7986u.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: GOODIX GT7986U SPI HID Touchscreen + +maintainers: + - Charles Wang <charles.goodix@gmail.com> + +description: + Supports the Goodix GT7986U touchscreen. + This touch controller reports data packaged according to the HID protocol, + but is incompatible with Microsoft's HID-over-SPI protocol. + +allOf: + - $ref: /schemas/spi/spi-peripheral-props.yaml# + +properties: + compatible: + enum: + - goodix,gt7986u + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + reset-gpios: + maxItems: 1 + description: reset gpio the chip is connected to. + + goodix,hid-report-addr: + description: the register address for retrieving HID report data. + $ref: /schemas/types.yaml#/definitions/uint32 + +additionalProperties: false + +required: + - compatible + - reg + - interrupts + - goodix,hid-report-addr + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + #include <dt-bindings/gpio/gpio.h> + spi { + #address-cells = <1>; + #size-cells = <0>; + num-cs = <1>; + cs-gpios = <&gpio 2 GPIO_ACTIVE_HIGH>; + touchscreen@0 { + compatible = "goodix,gt7986u"; + reg = <0>; + interrupt-parent = <&gpio>; + interrupts = <25 IRQ_TYPE_LEVEL_LOW>; + reset-gpios = <&gpio1 1 GPIO_ACTIVE_LOW>; + spi-max-frequency = <10000000>; + goodix,hid-report-addr = <0x22c8c>; + }; + };
The Goodix GT7986U touch controller report touch data according to the HID protocol through the SPI bus. However, it is incompatible with Microsoft's HID-over-SPI protocol. Signed-off-by: Charles Wang <charles.goodix@gmail.com> --- .../bindings/input/goodix,gt7986u.yaml | 65 +++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 Documentation/devicetree/bindings/input/goodix,gt7986u.yaml