[PATCH v3 2/2] dt-bindings: input: gt7986u-spifw: Remove hid-report-addr property

Charles Wang posted 2 patches 2 weeks, 1 day ago
There is a newer version of this series
[PATCH v3 2/2] dt-bindings: input: gt7986u-spifw: Remove hid-report-addr property
Posted by Charles Wang 2 weeks, 1 day ago
Since all boards use the same address, drop the goodix,hid-report-addr
property and hardcode it in the driver as a default value.

Signed-off-by: Charles Wang <charles.goodix@gmail.com>
---
 .../devicetree/bindings/input/goodix,gt7986u-spifw.yaml    | 7 -------
 1 file changed, 7 deletions(-)

diff --git a/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml b/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml
index 8105b9ce2..c9e346a60 100644
--- a/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml
+++ b/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml
@@ -36,11 +36,6 @@ properties:
   reset-gpios:
     maxItems: 1
 
-  goodix,hid-report-addr:
-    $ref: /schemas/types.yaml#/definitions/uint32
-    description:
-      The register address for retrieving HID report data.
-
   spi-max-frequency: true
 
 required:
@@ -48,7 +43,6 @@ required:
   - reg
   - interrupts
   - reset-gpios
-  - goodix,hid-report-addr
 
 unevaluatedProperties: false
 
@@ -68,7 +62,6 @@ examples:
         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
Re: [PATCH v3 2/2] dt-bindings: input: gt7986u-spifw: Remove hid-report-addr property
Posted by Rob Herring 2 weeks, 1 day ago
On Fri, Nov 08, 2024 at 08:03:11PM +0800, Charles Wang wrote:
> Since all boards use the same address, drop the goodix,hid-report-addr
> property and hardcode it in the driver as a default value.

Where's the driver change?

I don't see the point in defining this and then removing it in the next 
patch.

> 
> Signed-off-by: Charles Wang <charles.goodix@gmail.com>
> ---
>  .../devicetree/bindings/input/goodix,gt7986u-spifw.yaml    | 7 -------
>  1 file changed, 7 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml b/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml
> index 8105b9ce2..c9e346a60 100644
> --- a/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml
> +++ b/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml
> @@ -36,11 +36,6 @@ properties:
>    reset-gpios:
>      maxItems: 1
>  
> -  goodix,hid-report-addr:
> -    $ref: /schemas/types.yaml#/definitions/uint32
> -    description:
> -      The register address for retrieving HID report data.
> -
>    spi-max-frequency: true
>  
>  required:
> @@ -48,7 +43,6 @@ required:
>    - reg
>    - interrupts
>    - reset-gpios
> -  - goodix,hid-report-addr

Dropping a required property is an ABI break.

A devicetree that passes with the schema will not work on current 
kernels that require this property.

>  
>  unevaluatedProperties: false
>  
> @@ -68,7 +62,6 @@ examples:
>          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
>
Re: [PATCH v3 2/2] dt-bindings: input: gt7986u-spifw: Remove hid-report-addr property
Posted by Charles Wang 1 week, 5 days ago
Hi Rob,

On Fri, Nov 08, 2024 at 10:13:50AM -0600, Rob Herring wrote:
> On Fri, Nov 08, 2024 at 08:03:11PM +0800, Charles Wang wrote:
> > Since all boards use the same address, drop the goodix,hid-report-addr
> > property and hardcode it in the driver as a default value.
> 
> Where's the driver change?
> 
> I don't see the point in defining this and then removing it in the next 
> patch.
>

Apologies for the confusion. The driver changes will be included in the next version.

>
> > 
> > Signed-off-by: Charles Wang <charles.goodix@gmail.com>
> > ---
> >  .../devicetree/bindings/input/goodix,gt7986u-spifw.yaml    | 7 -------
> >  1 file changed, 7 deletions(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml b/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml
> > index 8105b9ce2..c9e346a60 100644
> > --- a/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml
> > +++ b/Documentation/devicetree/bindings/input/goodix,gt7986u-spifw.yaml
> > @@ -36,11 +36,6 @@ properties:
> >    reset-gpios:
> >      maxItems: 1
> >  
> > -  goodix,hid-report-addr:
> > -    $ref: /schemas/types.yaml#/definitions/uint32
> > -    description:
> > -      The register address for retrieving HID report data.
> > -
> >    spi-max-frequency: true
> >  
> >  required:
> > @@ -48,7 +43,6 @@ required:
> >    - reg
> >    - interrupts
> >    - reset-gpios
> > -  - goodix,hid-report-addr
> 
> Dropping a required property is an ABI break.
> 
> A devicetree that passes with the schema will not work on current 
> kernels that require this property.
> 

Thank you for pointing this out. The next version will include the
necessary driver modifications.

> >  
> >  unevaluatedProperties: false
> >  
> > @@ -68,7 +62,6 @@ examples:
> >          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
> > 

Best regards,
Charles
Re: [PATCH v3 2/2] dt-bindings: input: gt7986u-spifw: Remove hid-report-addr property
Posted by Rob Herring (Arm) 2 weeks, 1 day ago
On Fri, 08 Nov 2024 20:03:11 +0800, Charles Wang wrote:
> Since all boards use the same address, drop the goodix,hid-report-addr
> property and hardcode it in the driver as a default value.
> 
> Signed-off-by: Charles Wang <charles.goodix@gmail.com>
> ---
>  .../devicetree/bindings/input/goodix,gt7986u-spifw.yaml    | 7 -------
>  1 file changed, 7 deletions(-)
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:


doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20241108120311.87795-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.