* [PATCH v2] dt-bindings: rtc: isl1208: Convert to json-schema
@ 2023-05-05 8:06 Biju Das
2023-05-05 8:16 ` Geert Uytterhoeven
0 siblings, 1 reply; 3+ messages in thread
From: Biju Das @ 2023-05-05 8:06 UTC (permalink / raw)
To: Alessandro Zummo, Alexandre Belloni, Rob Herring, Krzysztof Kozlowski
Cc: Biju Das, Trent Piepho, linux-rtc, devicetree,
Geert Uytterhoeven, Fabrizio Castro, linux-renesas-soc
Convert the isl1208 RTC device tree binding documentation to json-schema.
Update the example to match reality.
Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
---
RFC->v2:
* Updated maintainers list
* Updated description from original bindings
* removed default from isil,ev-evienb properties to match with the original
bindings.
* Added conditional check for interrupts.
---
.../devicetree/bindings/rtc/isil,isl1208.txt | 38 --------
.../devicetree/bindings/rtc/isil,isl1208.yaml | 86 +++++++++++++++++++
2 files changed, 86 insertions(+), 38 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/rtc/isil,isl1208.txt
create mode 100644 Documentation/devicetree/bindings/rtc/isil,isl1208.yaml
diff --git a/Documentation/devicetree/bindings/rtc/isil,isl1208.txt b/Documentation/devicetree/bindings/rtc/isil,isl1208.txt
deleted file mode 100644
index 51f003006f04..000000000000
--- a/Documentation/devicetree/bindings/rtc/isil,isl1208.txt
+++ /dev/null
@@ -1,38 +0,0 @@
-Intersil ISL1209/19 I2C RTC/Alarm chip with event in
-
-ISL12X9 have additional pins EVIN and #EVDET for tamper detection, while the
-ISL1208 and ISL1218 do not. They are all use the same driver with the bindings
-described here, with chip specific properties as noted.
-
-Required properties supported by the device:
- - "compatible": Should be one of the following:
- - "isil,isl1208"
- - "isil,isl1209"
- - "isil,isl1218"
- - "isil,isl1219"
- - "reg": I2C bus address of the device
-
-Optional properties:
- - "interrupt-names": list which may contains "irq" and "evdet"
- evdet applies to isl1209 and isl1219 only
- - "interrupts": list of interrupts for "irq" and "evdet"
- evdet applies to isl1209 and isl1219 only
- - "isil,ev-evienb": Enable or disable internal pull on EVIN pin
- Applies to isl1209 and isl1219 only
- Possible values are 0 and 1
- Value 0 enables internal pull-up on evin pin, 1 disables it.
- Default will leave the non-volatile configuration of the pullup
- as is.
-
-Example isl1219 node with #IRQ pin connected to SoC gpio1 pin12 and #EVDET pin
-connected to SoC gpio2 pin 24 and internal pull-up enabled in EVIN pin.
-
- isl1219: rtc@68 {
- compatible = "isil,isl1219";
- reg = <0x68>;
- interrupt-names = "irq", "evdet";
- interrupts-extended = <&gpio1 12 IRQ_TYPE_EDGE_FALLING>,
- <&gpio2 24 IRQ_TYPE_EDGE_FALLING>;
- isil,ev-evienb = <1>;
- };
-
diff --git a/Documentation/devicetree/bindings/rtc/isil,isl1208.yaml b/Documentation/devicetree/bindings/rtc/isil,isl1208.yaml
new file mode 100644
index 000000000000..ca72f64a655c
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/isil,isl1208.yaml
@@ -0,0 +1,86 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/isil,isl1208.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Intersil ISL1209/19 I2C RTC/Alarm chip with event in
+
+maintainers:
+ - Trent Piepho <tpiepho@gmail.com>
+
+description: |
+ ISL12X9 have additional pins EVIN and #EVDET for tamper detection, while the
+ ISL1208 and ISL1218 do not.
+
+properties:
+ compatible:
+ oneOf:
+ - enum:
+ - isil,isl1208
+ - isil,isl1209
+ - isil,isl1218
+ - isil,isl1219
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ minItems: 1
+ maxItems: 2
+
+ interrupt-names: true
+
+ isil,ev-evienb:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ enum: [ 0, 1 ]
+ description: |
+ Enable or disable internal pull on EVIN pin
+ Default will leave the non-volatile configuration of the pullup
+ as is.
+ <0> : Enables internal pull-up on evin pin
+ <1> : Disables internal pull-up on evin pin
+
+required:
+ - compatible
+ - reg
+
+allOf:
+ - $ref: rtc.yaml#
+ - if:
+ properties:
+ compatible:
+ contains:
+ enum:
+ - isil,isl1209
+ - isil,isl1219
+ then:
+ properties:
+ interrupts:
+ maxItems: 2
+ interrupt-names:
+ items:
+ - const: irq
+ - const: evdet
+ required:
+ - interrupts
+ - interrupt-names
+ - isil,ev-evienb
+ else:
+ properties:
+ interrupts:
+ maxItems: 1
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ rtc_twi: rtc@6f {
+ compatible = "isil,isl1208";
+ reg = <0x6f>;
+ };
+ };
--
2.25.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2] dt-bindings: rtc: isl1208: Convert to json-schema
2023-05-05 8:06 [PATCH v2] dt-bindings: rtc: isl1208: Convert to json-schema Biju Das
@ 2023-05-05 8:16 ` Geert Uytterhoeven
2023-05-05 8:56 ` Biju Das
0 siblings, 1 reply; 3+ messages in thread
From: Geert Uytterhoeven @ 2023-05-05 8:16 UTC (permalink / raw)
To: Biju Das
Cc: Alessandro Zummo, Alexandre Belloni, Rob Herring,
Krzysztof Kozlowski, Trent Piepho, linux-rtc, devicetree,
Geert Uytterhoeven, Fabrizio Castro, linux-renesas-soc
Hi Biju,
On Fri, May 5, 2023 at 10:06 AM Biju Das <biju.das.jz@bp.renesas.com> wrote:
> Convert the isl1208 RTC device tree binding documentation to json-schema.
>
> Update the example to match reality.
>
> Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> ---
> RFC->v2:
> * Updated maintainers list
> * Updated description from original bindings
> * removed default from isil,ev-evienb properties to match with the original
> bindings.
> * Added conditional check for interrupts.
Thanks for the update!
> --- a/Documentation/devicetree/bindings/rtc/isil,isl1208.txt
> +++ /dev/null
> @@ -1,38 +0,0 @@
> -Intersil ISL1209/19 I2C RTC/Alarm chip with event in
> -
> -ISL12X9 have additional pins EVIN and #EVDET for tamper detection, while the
> -ISL1208 and ISL1218 do not. They are all use the same driver with the bindings
> -described here, with chip specific properties as noted.
> -
> -Required properties supported by the device:
> - - "compatible": Should be one of the following:
> - - "isil,isl1208"
> - - "isil,isl1209"
> - - "isil,isl1218"
> - - "isil,isl1219"
> - - "reg": I2C bus address of the device
> -
> -Optional properties:
> - - "interrupt-names": list which may contains "irq" and "evdet"
> - evdet applies to isl1209 and isl1219 only
> - - "interrupts": list of interrupts for "irq" and "evdet"
> - evdet applies to isl1209 and isl1219 only
> - - "isil,ev-evienb": Enable or disable internal pull on EVIN pin
> - Applies to isl1209 and isl1219 only
> - Possible values are 0 and 1
> - Value 0 enables internal pull-up on evin pin, 1 disables it.
> - Default will leave the non-volatile configuration of the pullup
> - as is.
> -
> -Example isl1219 node with #IRQ pin connected to SoC gpio1 pin12 and #EVDET pin
> -connected to SoC gpio2 pin 24 and internal pull-up enabled in EVIN pin.
> -
> - isl1219: rtc@68 {
> - compatible = "isil,isl1219";
> - reg = <0x68>;
> - interrupt-names = "irq", "evdet";
> - interrupts-extended = <&gpio1 12 IRQ_TYPE_EDGE_FALLING>,
> - <&gpio2 24 IRQ_TYPE_EDGE_FALLING>;
> - isil,ev-evienb = <1>;
> - };
> -
> diff --git a/Documentation/devicetree/bindings/rtc/isil,isl1208.yaml b/Documentation/devicetree/bindings/rtc/isil,isl1208.yaml
> new file mode 100644
> index 000000000000..ca72f64a655c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/isil,isl1208.yaml
> @@ -0,0 +1,86 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/isil,isl1208.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Intersil ISL1209/19 I2C RTC/Alarm chip with event in
> +
> +maintainers:
> + - Trent Piepho <tpiepho@gmail.com>
> +
> +description: |
> + ISL12X9 have additional pins EVIN and #EVDET for tamper detection, while the
> + ISL1208 and ISL1218 do not.
> +
> +properties:
> + compatible:
> + oneOf:
> + - enum:
> + - isil,isl1208
> + - isil,isl1209
> + - isil,isl1218
> + - isil,isl1219
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + minItems: 1
> + maxItems: 2
> +
> + interrupt-names: true
Please keep the list of names here.
> +
> + isil,ev-evienb:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [ 0, 1 ]
> + description: |
> + Enable or disable internal pull on EVIN pin
> + Default will leave the non-volatile configuration of the pullup
> + as is.
> + <0> : Enables internal pull-up on evin pin
> + <1> : Disables internal pull-up on evin pin
> +
> +required:
> + - compatible
> + - reg
> +
> +allOf:
> + - $ref: rtc.yaml#
> + - if:
> + properties:
> + compatible:
> + contains:
> + enum:
> + - isil,isl1209
> + - isil,isl1219
> + then:
> + properties:
> + interrupts:
> + maxItems: 2
> + interrupt-names:
> + items:
> + - const: irq
> + - const: evdet
> + required:
> + - interrupts
> + - interrupt-names
Interrupts are not required (may not be wired), and are considered
optional by the driver, too.
> + - isil,ev-evienb
Also not required, as per the default (leave as-is).
> + else:
> + properties:
> + interrupts:
> + maxItems: 1
Gr{oetje,eeting}s,
Geert
--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org
In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds
^ permalink raw reply [flat|nested] 3+ messages in thread
* RE: [PATCH v2] dt-bindings: rtc: isl1208: Convert to json-schema
2023-05-05 8:16 ` Geert Uytterhoeven
@ 2023-05-05 8:56 ` Biju Das
0 siblings, 0 replies; 3+ messages in thread
From: Biju Das @ 2023-05-05 8:56 UTC (permalink / raw)
To: Geert Uytterhoeven
Cc: Alessandro Zummo, Alexandre Belloni, Rob Herring,
Krzysztof Kozlowski, Trent Piepho, linux-rtc, devicetree,
Geert Uytterhoeven, Fabrizio Castro, linux-renesas-soc
Hi Geert,
Thanks for the feedback.
> Subject: Re: [PATCH v2] dt-bindings: rtc: isl1208: Convert to json-schema
>
> Hi Biju,
>
> On Fri, May 5, 2023 at 10:06 AM Biju Das <biju.das.jz@bp.renesas.com> wrote:
> > Convert the isl1208 RTC device tree binding documentation to json-schema.
> >
> > Update the example to match reality.
> >
> > Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> > ---
> > RFC->v2:
> > * Updated maintainers list
> > * Updated description from original bindings
> > * removed default from isil,ev-evienb properties to match with the
> original
> > bindings.
> > * Added conditional check for interrupts.
>
> Thanks for the update!
>
> > --- a/Documentation/devicetree/bindings/rtc/isil,isl1208.txt
> > +++ /dev/null
> > @@ -1,38 +0,0 @@
> > -Intersil ISL1209/19 I2C RTC/Alarm chip with event in
> > -
> > -ISL12X9 have additional pins EVIN and #EVDET for tamper detection,
> > while the
> > -ISL1208 and ISL1218 do not. They are all use the same driver with
> > the bindings -described here, with chip specific properties as noted.
> > -
> > -Required properties supported by the device:
> > - - "compatible": Should be one of the following:
> > - - "isil,isl1208"
> > - - "isil,isl1209"
> > - - "isil,isl1218"
> > - - "isil,isl1219"
> > - - "reg": I2C bus address of the device
> > -
> > -Optional properties:
> > - - "interrupt-names": list which may contains "irq" and "evdet"
> > - evdet applies to isl1209 and isl1219 only
> > - - "interrupts": list of interrupts for "irq" and "evdet"
> > - evdet applies to isl1209 and isl1219 only
> > - - "isil,ev-evienb": Enable or disable internal pull on EVIN pin
> > - Applies to isl1209 and isl1219 only
> > - Possible values are 0 and 1
> > - Value 0 enables internal pull-up on evin pin, 1 disables it.
> > - Default will leave the non-volatile configuration of the pullup
> > - as is.
> > -
> > -Example isl1219 node with #IRQ pin connected to SoC gpio1 pin12 and
> > #EVDET pin -connected to SoC gpio2 pin 24 and internal pull-up enabled in
> EVIN pin.
> > -
> > - isl1219: rtc@68 {
> > - compatible = "isil,isl1219";
> > - reg = <0x68>;
> > - interrupt-names = "irq", "evdet";
> > - interrupts-extended = <&gpio1 12 IRQ_TYPE_EDGE_FALLING>,
> > - <&gpio2 24 IRQ_TYPE_EDGE_FALLING>;
> > - isil,ev-evienb = <1>;
> > - };
> > -
> > diff --git a/Documentation/devicetree/bindings/rtc/isil,isl1208.yaml
> > b/Documentation/devicetree/bindings/rtc/isil,isl1208.yaml
> > new file mode 100644
> > index 000000000000..ca72f64a655c
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/isil,isl1208.yaml
> > @@ -0,0 +1,86 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> > +
> > +title: Intersil ISL1209/19 I2C RTC/Alarm chip with event in
> > +
> > +maintainers:
> > + - Trent Piepho <tpiepho@gmail.com>
> > +
> > +description: |
> > + ISL12X9 have additional pins EVIN and #EVDET for tamper detection,
> > +while the
> > + ISL1208 and ISL1218 do not.
> > +
> > +properties:
> > + compatible:
> > + oneOf:
> > + - enum:
> > + - isil,isl1208
> > + - isil,isl1209
> > + - isil,isl1218
> > + - isil,isl1219
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + interrupts:
> > + minItems: 1
> > + maxItems: 2
> > +
> > + interrupt-names: true
>
> Please keep the list of names here.
OK.
>
> > +
> > + isil,ev-evienb:
> > + $ref: /schemas/types.yaml#/definitions/uint32
> > + enum: [ 0, 1 ]
> > + description: |
> > + Enable or disable internal pull on EVIN pin
> > + Default will leave the non-volatile configuration of the pullup
> > + as is.
> > + <0> : Enables internal pull-up on evin pin
> > + <1> : Disables internal pull-up on evin pin
> > +
> > +required:
> > + - compatible
> > + - reg
> > +
> > +allOf:
> > + - $ref: rtc.yaml#
> > + - if:
> > + properties:
> > + compatible:
> > + contains:
> > + enum:
> > + - isil,isl1209
> > + - isil,isl1219
> > + then:
> > + properties:
> > + interrupts:
> > + maxItems: 2
> > + interrupt-names:
> > + items:
> > + - const: irq
> > + - const: evdet
> > + required:
> > + - interrupts
> > + - interrupt-names
>
> Interrupts are not required (may not be wired), and are considered optional
> by the driver, too.
OK, will remove.
>
> > + - isil,ev-evienb
>
> Also not required, as per the default (leave as-is).
Agreed.
Cheers,
Biju
>
> > + else:
> > + properties:
> > + interrupts:
> > + maxItems: 1
>
> Gr{oetje,eeting}s,
>
> Geert
>
> --
> Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-
> m68k.org
>
> In personal conversations with technical people, I call myself a hacker. But
> when I'm talking to journalists I just say "programmer" or something like
> that.
> -- Linus Torvalds
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-05-05 8:56 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-05-05 8:06 [PATCH v2] dt-bindings: rtc: isl1208: Convert to json-schema Biju Das
2023-05-05 8:16 ` Geert Uytterhoeven
2023-05-05 8:56 ` Biju Das
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).