diff mbox series

[v2,03/11] dt-bindings: input: Convert da906{1,2,3} onkey to json-schema

Message ID 20231202192536.266885-4-biju.das.jz@bp.renesas.com (mailing list archive)
State New
Headers show
Series Convert DA906{1,2} bindings to json-schema | expand

Commit Message

Biju Das Dec. 2, 2023, 7:25 p.m. UTC
Convert the da906{1,2,3} onkey device tree binding documentation to
json-schema.

Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
---
 .../bindings/input/da9062-onkey.txt           | 47 --------------
 .../bindings/input/dlg,da9062-onkey.yaml      | 61 +++++++++++++++++++
 2 files changed, 61 insertions(+), 47 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/input/da9062-onkey.txt
 create mode 100644 Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml

Comments

Conor Dooley Dec. 3, 2023, 11:36 a.m. UTC | #1
On Sat, Dec 02, 2023 at 07:25:27PM +0000, Biju Das wrote:
> diff --git a/Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml b/Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml
> new file mode 100644
> index 000000000000..34f2e00cf045
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml
> @@ -0,0 +1,61 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/dlg,da9062-onkey.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Dialog DA9061/62/63 OnKey Module
> +
> +maintainers:
> +  - Biju Das <biju.das.jz@bp.renesas.com>
> +
> +description: |
> +  This module is part of the DA9061/DA9062/DA9063. For more details about entire
> +  DA9062 and DA9061 chips see Documentation/devicetree/bindings/mfd/da9062.txt
> +  For DA906{1,2,3} see Documentation/devicetree/bindings/mfd/dlg,da9063.yaml
> +
> +  This module provides the KEY_POWER event.
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +          - enum:
> +              - dlg,da9062-onkey
> +              - dlg,da9063-onkey
> +      - items:
> +          - enum:
> +              - dlg,da9061-onkey
> +          - const: dlg,da9062-onkey # da9062-onkey fallback

Same comments here.

Cheers,
Conor.

> +  dlg,disable-key-power:
> +    type: boolean
> +    description:
> +      Disable power-down using a long key-press. If this entry exists
> +      the OnKey driver will remove support for the KEY_POWER key press
> +      when triggered using a long press of the OnKey.
> +
> +required:
> +  - compatible
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      pmic@58 {
> +        compatible = "dlg,da9063";
> +        reg = <0x58>;
> +        interrupt-parent = <&gpio6>;
> +        interrupts = <11 IRQ_TYPE_LEVEL_LOW>;
> +        interrupt-controller;
> +
> +        onkey {
> +          compatible = "dlg,da9063-onkey";
> +          dlg,disable-key-power;
> +        };
> +      };
> +    };
> -- 
> 2.39.2
>
Biju Das Dec. 4, 2023, 10:58 a.m. UTC | #2
Hi Conor Dooley,

> Subject: Re: [PATCH v2 03/11] dt-bindings: input: Convert da906{1,2,3}
> onkey to json-schema
> 
> On Sat, Dec 02, 2023 at 07:25:27PM +0000, Biju Das wrote:
> > diff --git
> > a/Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml
> > b/Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml
> > new file mode 100644
> > index 000000000000..34f2e00cf045
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml
> > @@ -0,0 +1,61 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/input/dlg,da9062-onkey.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Dialog DA9061/62/63 OnKey Module
> > +
> > +maintainers:
> > +  - Biju Das <biju.das.jz@bp.renesas.com>
> > +
> > +description: |
> > +  This module is part of the DA9061/DA9062/DA9063. For more details
> > +about entire
> > +  DA9062 and DA9061 chips see
> > +Documentation/devicetree/bindings/mfd/da9062.txt
> > +  For DA906{1,2,3} see
> > +Documentation/devicetree/bindings/mfd/dlg,da9063.yaml
> > +
> > +  This module provides the KEY_POWER event.
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - items:
> > +          - enum:
> > +              - dlg,da9062-onkey
> > +              - dlg,da9063-onkey
> > +      - items:
> > +          - enum:
> > +              - dlg,da9061-onkey
> > +          - const: dlg,da9062-onkey # da9062-onkey fallback
> 
> Same comments here.

Agreed, it will be like

    oneOf:
      - items:
          - enum:
              - dlg,da9062-onkey
              - dlg,da9063-onkey
      - items:
          - const: dlg,da9061-onkey
          - const: dlg,da9062-onkey

> 
> Cheers,
> Conor.
> 
> > +  dlg,disable-key-power:
> > +    type: boolean
> > +    description:
> > +      Disable power-down using a long key-press. If this entry exists
> > +      the OnKey driver will remove support for the KEY_POWER key press
> > +      when triggered using a long press of the OnKey.
> > +
> > +required:
> > +  - compatible
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> > +    i2c {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +      pmic@58 {
> > +        compatible = "dlg,da9063";
> > +        reg = <0x58>;
> > +        interrupt-parent = <&gpio6>;
> > +        interrupts = <11 IRQ_TYPE_LEVEL_LOW>;
> > +        interrupt-controller;
> > +
> > +        onkey {
> > +          compatible = "dlg,da9063-onkey";
> > +          dlg,disable-key-power;
> > +        };
> > +      };
> > +    };

For consistency, I have updated the example similar to watchdog. Same case for thermal.

examples:
  - |
    onkey {
      compatible = "dlg,da9063-onkey";
      dlg,disable-key-power;
    };

Cheers,
Biju
kernel test robot Dec. 5, 2023, 8:19 p.m. UTC | #3
Hi Biju,

kernel test robot noticed the following build warnings:

[auto build test WARNING on lee-mfd/for-mfd-next]
[also build test WARNING on robh/for-next rafael-pm/thermal groeck-staging/hwmon-next linus/master v6.7-rc4 next-20231205]
[cannot apply to dtor-input/next dtor-input/for-linus lee-mfd/for-mfd-fixes]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Biju-Das/dt-bindings-watchdog-dlg-da9062-watchdog-Document-DA9063-watchdog/20231203-042557
base:   https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git for-mfd-next
patch link:    https://lore.kernel.org/r/20231202192536.266885-4-biju.das.jz%40bp.renesas.com
patch subject: [PATCH v2 03/11] dt-bindings: input: Convert da906{1,2,3} onkey to json-schema
reproduce: (https://download.01.org/0day-ci/archive/20231206/202312060431.fHDo1Yk9-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202312060431.fHDo1Yk9-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/input/da90??-onkey.txt
Biju Das Dec. 6, 2023, 9:39 a.m. UTC | #4
Hi kernel test robot,

> -----Original Message-----
> From: kernel test robot <lkp@intel.com>
> Sent: Tuesday, December 5, 2023 8:19 PM
> Subject: Re: [PATCH v2 03/11] dt-bindings: input: Convert da906{1,2,3}
> onkey to json-schema
> 
> Hi Biju,
> 
> kernel test robot noticed the following build warnings:
> 
> [auto build test WARNING on lee-mfd/for-mfd-next] [also build test WARNING
]
> 
> url:

> base:
> patch link:
> reproduce:
> 
> If you fix the issue in a separate patch/commit (i.e. not just a new
> version of the same patch/commit), kindly add following tags
> | Reported-by: kernel test robot <lkp@intel.com>
> | Closes:
> | 
> 
> All warnings (new ones prefixed by >>):
> 
> >> Warning: MAINTAINERS references a file that doesn't exist:
> >> Documentation/devicetree/bindings/input/da90??-onkey.txt


There is an updated patch series available[1] and Please retest and provide feedback if any?

[1] https://lore.kernel.org/all/20231204172510.35041-1-biju.das.jz@bp.renesas.com/

Cheers,
Biju
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/input/da9062-onkey.txt b/Documentation/devicetree/bindings/input/da9062-onkey.txt
deleted file mode 100644
index e5eef59a93dc..000000000000
--- a/Documentation/devicetree/bindings/input/da9062-onkey.txt
+++ /dev/null
@@ -1,47 +0,0 @@ 
-* Dialog DA9061/62/63 OnKey Module
-
-This module is part of the DA9061/DA9062/DA9063. For more details about entire
-DA9062 and DA9061 chips see Documentation/devicetree/bindings/mfd/da9062.txt
-For DA9063 see Documentation/devicetree/bindings/mfd/dlg,da9063.yaml
-
-This module provides the KEY_POWER event.
-
-Required properties:
-
-- compatible: should be one of the following valid compatible string lines:
-	"dlg,da9061-onkey", "dlg,da9062-onkey"
-	"dlg,da9062-onkey"
-	"dlg,da9063-onkey"
-
-Optional properties:
-
-- dlg,disable-key-power : Disable power-down using a long key-press. If this
-    entry exists the OnKey driver will remove support for the KEY_POWER key
-    press when triggered using a long press of the OnKey.
-
-Example: DA9063
-
-	pmic0: da9063@58 {
-		onkey {
-			compatible = "dlg,da9063-onkey";
-			dlg,disable-key-power;
-		};
-	};
-
-Example: DA9062
-
-	pmic0: da9062@58 {
-		onkey {
-			compatible = "dlg,da9062-onkey";
-			dlg,disable-key-power;
-		};
-	};
-
-Example: DA9061 using a fall-back compatible for the DA9062 onkey driver
-
-	pmic0: da9061@58 {
-		onkey {
-			compatible = "dlg,da9061-onkey", "dlg,da9062-onkey";
-			dlg,disable-key-power;
-		};
-	};
diff --git a/Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml b/Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml
new file mode 100644
index 000000000000..34f2e00cf045
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/dlg,da9062-onkey.yaml
@@ -0,0 +1,61 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/dlg,da9062-onkey.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Dialog DA9061/62/63 OnKey Module
+
+maintainers:
+  - Biju Das <biju.das.jz@bp.renesas.com>
+
+description: |
+  This module is part of the DA9061/DA9062/DA9063. For more details about entire
+  DA9062 and DA9061 chips see Documentation/devicetree/bindings/mfd/da9062.txt
+  For DA906{1,2,3} see Documentation/devicetree/bindings/mfd/dlg,da9063.yaml
+
+  This module provides the KEY_POWER event.
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - enum:
+              - dlg,da9062-onkey
+              - dlg,da9063-onkey
+      - items:
+          - enum:
+              - dlg,da9061-onkey
+          - const: dlg,da9062-onkey # da9062-onkey fallback
+
+  dlg,disable-key-power:
+    type: boolean
+    description:
+      Disable power-down using a long key-press. If this entry exists
+      the OnKey driver will remove support for the KEY_POWER key press
+      when triggered using a long press of the OnKey.
+
+required:
+  - compatible
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      pmic@58 {
+        compatible = "dlg,da9063";
+        reg = <0x58>;
+        interrupt-parent = <&gpio6>;
+        interrupts = <11 IRQ_TYPE_LEVEL_LOW>;
+        interrupt-controller;
+
+        onkey {
+          compatible = "dlg,da9063-onkey";
+          dlg,disable-key-power;
+        };
+      };
+    };