[v4,5/5] rtc: isl1219: add device tree docu

Message ID 20180710090710.9066-6-Denis.Osterland@diehl.com
State Superseded
Headers show
Series
  • rtc: isl1208: fixes, documentation and isl1219 support
Related show

Commit Message

Denis OSTERLAND July 10, 2018, 9:44 a.m.
From: Denis Osterland <Denis.Osterland@diehl.com>

The devicetree documentation for the ISL1219 device tree
binding is added with an short example. It is not a trivial
device, because it supports two interrupt souces.

Signed-off-by: Denis Osterland <Denis.Osterland@diehl.com>
---
 .../devicetree/bindings/rtc/isil,isl1219.txt  | 29 +++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/isil,isl1219.txt

Comments

Rob Herring July 11, 2018, 3:16 p.m. | #1
On Tue, Jul 10, 2018 at 09:44:15AM +0000, Denis OSTERLAND wrote:
> From: Denis Osterland <Denis.Osterland@diehl.com>
> 
> The devicetree documentation for the ISL1219 device tree
> binding is added with an short example. It is not a trivial
> device, because it supports two interrupt souces.

s/souces/sources/

> 
> Signed-off-by: Denis Osterland <Denis.Osterland@diehl.com>
> ---
>  .../devicetree/bindings/rtc/isil,isl1219.txt  | 29 +++++++++++++++++++
>  1 file changed, 29 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/isil,isl1219.txt
> 
> diff --git a/Documentation/devicetree/bindings/rtc/isil,isl1219.txt b/Documentation/devicetree/bindings/rtc/isil,isl1219.txt
> new file mode 100644
> index 000000000000..f26f1e9d4bde
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/isil,isl1219.txt
> @@ -0,0 +1,29 @@
> +Intersil ISL1219 I2C RTC/Alarm chip with event in
> +
> +ISL1219 has additional pins EVIN and #EVDET for tamper detection.
> +
> +Required properties supported by the device:
> +
> + - "compatible": must be "isil,isl1219"
> + - "reg": I2C bus address of the device
> +
> +Optional properties:
> +
> + - "interrupt-names": list which may contains "irq" and "evdet"
> + - "interrupt-parent", "interrupts", "interrupts-extended":
> +   for passing the interrupt line of the SoC connected to #IRQ pin
> +   and #EVDET pin of the RTC chip.

Just list 'interrupts' and how many there are. interrupt-parent is 
implied and may be in a parent node. interrupts-extended is also 
implicitly allowed as needed.

> + - "isil,ev-evienb": if present bit can be set to disable event input pull-up
> +
> +
> +Example isl1219 node with #IRQ pin connected to SoC gpio1 pin12
> + and #EVDET pin connected to SoC gpio2 pin 24:
> +
> +	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>;
> +	};
> +
> --
> 2.18.0
> 
> 
> 
> Diehl Connectivity Solutions GmbH
> Geschäftsführung: Horst Leonberger
> Sitz der Gesellschaft: Nürnberg - Registergericht: Amtsgericht
> Nürnberg: HRB 32315
> ___________________________________________________________________________________________________
> 
> Der Inhalt der vorstehenden E-Mail ist nicht rechtlich bindend. Diese E-Mail enthaelt vertrauliche und/oder rechtlich geschuetzte Informationen.
> Informieren Sie uns bitte, wenn Sie diese E-Mail faelschlicherweise erhalten haben. Bitte loeschen Sie in diesem Fall die Nachricht.
> Jede unerlaubte Form der Reproduktion, Bekanntgabe, Aenderung, Verteilung und/oder Publikation dieser E-Mail ist strengstens untersagt.
> The contents of the above mentioned e-mail is not legally binding. This e-mail contains confidential and/or legally protected information. Please inform us if you have received this e-mail by
> mistake and delete it in such a case. Each unauthorized reproduction, disclosure, alteration, distribution and/or publication of this e-mail is strictly prohibited.
Denis OSTERLAND July 12, 2018, 6:42 a.m. | #2
Am Mittwoch, den 11.07.2018, 09:16 -0600 schrieb Rob Herring:
> On Tue, Jul 10, 2018 at 09:44:15AM +0000, Denis OSTERLAND wrote:
> > 
> > From: Denis Osterland <Denis.Osterland@diehl.com>
> > 
> > The devicetree documentation for the ISL1219 device tree
> > binding is added with an short example. It is not a trivial
> > device, because it supports two interrupt souces.
> s/souces/sources/
OK
> 
> > 
> > 
> > Signed-off-by: Denis Osterland <Denis.Osterland@diehl.com>
> > ---
> >  .../devicetree/bindings/rtc/isil,isl1219.txt  | 29 +++++++++++++++++++
> >  1 file changed, 29 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/rtc/isil,isl1219.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/rtc/isil,isl1219.txt b/Documentation/devicetree/bindings/rtc/isil,isl1219.txt
> > new file mode 100644
> > index 000000000000..f26f1e9d4bde
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/isil,isl1219.txt
> > @@ -0,0 +1,29 @@
> > +Intersil ISL1219 I2C RTC/Alarm chip with event in
> > +
> > +ISL1219 has additional pins EVIN and #EVDET for tamper detection.
> > +
> > +Required properties supported by the device:
> > +
> > + - "compatible": must be "isil,isl1219"
> > + - "reg": I2C bus address of the device
> > +
> > +Optional properties:
> > +
> > + - "interrupt-names": list which may contains "irq" and "evdet"
> > + - "interrupt-parent", "interrupts", "interrupts-extended":
> > +   for passing the interrupt line of the SoC connected to #IRQ pin
> > +   and #EVDET pin of the RTC chip.
> Just list 'interrupts' and how many there are. interrupt-parent is 
> implied and may be in a parent node. interrupts-extended is also 
> implicitly allowed as needed.
Will change to: "interrupts": list of interrupts for "irq" and "evdet"
> 
> > 
> > + - "isil,ev-evienb": if present bit can be set to disable event input pull-up
> > +
> > +
> > +Example isl1219 node with #IRQ pin connected to SoC gpio1 pin12
> > + and #EVDET pin connected to SoC gpio2 pin 24:
> > +
> > +	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>;
> > +	};
> > +
> > --
> > 2.18.0
> > 
> > 
> > 
> > Diehl Connectivity Solutions GmbH
> > Geschäftsführung: Horst Leonberger
> > Sitz der Gesellschaft: Nürnberg - Registergericht: Amtsgericht
> > Nürnberg: HRB 32315
> > ___________________________________________________________________________________________________
> > 
> > Der Inhalt der vorstehenden E-Mail ist nicht rechtlich bindend. Diese E-Mail enthaelt vertrauliche und/oder rechtlich geschuetzte Informationen.
> > Informieren Sie uns bitte, wenn Sie diese E-Mail faelschlicherweise erhalten haben. Bitte loeschen Sie in diesem Fall die Nachricht.
> > Jede unerlaubte Form der Reproduktion, Bekanntgabe, Aenderung, Verteilung und/oder Publikation dieser E-Mail ist strengstens untersagt.
> > The contents of the above mentioned e-mail is not legally binding. This e-mail contains confidential and/or legally protected information. Please inform us if you have received this e-mail by
> > mistake and delete it in such a case. Each unauthorized reproduction, disclosure, alteration, distribution and/or publication of this e-mail is strictly prohibited.

Diehl Connectivity Solutions GmbH
Geschäftsführung: Horst Leonberger
Sitz der Gesellschaft: Nürnberg - Registergericht: Amtsgericht
Nürnberg: HRB 32315
Alexandre Belloni July 18, 2018, 7:38 a.m. | #3
Hi,

On 10/07/2018 09:44:15+0000, Denis OSTERLAND wrote:
> From: Denis Osterland <Denis.Osterland@diehl.com>
> 
> The devicetree documentation for the ISL1219 device tree
> binding is added with an short example. It is not a trivial
> device, because it supports two interrupt souces.
> 
> Signed-off-by: Denis Osterland <Denis.Osterland@diehl.com>
> ---
>  .../devicetree/bindings/rtc/isil,isl1219.txt  | 29 +++++++++++++++++++
>  1 file changed, 29 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/isil,isl1219.txt
> 
> diff --git a/Documentation/devicetree/bindings/rtc/isil,isl1219.txt b/Documentation/devicetree/bindings/rtc/isil,isl1219.txt
> new file mode 100644
> index 000000000000..f26f1e9d4bde
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/isil,isl1219.txt
> @@ -0,0 +1,29 @@
> +Intersil ISL1219 I2C RTC/Alarm chip with event in
> +
> +ISL1219 has additional pins EVIN and #EVDET for tamper detection.
> +
> +Required properties supported by the device:
> +
> + - "compatible": must be "isil,isl1219"
> + - "reg": I2C bus address of the device
> +
> +Optional properties:
> +
> + - "interrupt-names": list which may contains "irq" and "evdet"
> + - "interrupt-parent", "interrupts", "interrupts-extended":
> +   for passing the interrupt line of the SoC connected to #IRQ pin
> +   and #EVDET pin of the RTC chip.
> + - "isil,ev-evienb": if present bit can be set to disable event input pull-up

I would use a clearer name for that property like isil,ev-pull-up-enabled.

Also make it an int so 0 is disabling the pull-up (EVIENB set to 1) 1 is
enabling the pull-up (EVIENB set to 0) and do nothing when the property
is not present.
Denis OSTERLAND July 18, 2018, 7:55 a.m. | #4
Hello,

Am Mittwoch, den 18.07.2018, 09:38 +0200 schrieb Alexandre Belloni:
> Hi,
> 
> On 10/07/2018 09:44:15+0000, Denis OSTERLAND wrote:
> > 
> > +
> > +Optional properties:
> > +
> > + - "interrupt-names": list which may contains "irq" and "evdet"
> > + - "interrupt-parent", "interrupts", "interrupts-extended":
> > +   for passing the interrupt line of the SoC connected to #IRQ pin
> > +   and #EVDET pin of the RTC chip.
> > + - "isil,ev-evienb": if present bit can be set to disable event input pull-up
> I would use a clearer name for that property like isil,ev-pull-up-enabled.
> 
> Also make it an int so 0 is disabling the pull-up (EVIENB set to 1) 1 is
> enabling the pull-up (EVIENB set to 0) and do nothing when the property
> is not present.
It is designed like Documentation/devicetree/bindings/rtc/isil,isl12026.txt,
which uses the bit name from Documentation as well.
I will change to integer type.
> 
> 
Regards Denis

Diehl Connectivity Solutions GmbH
Geschäftsführung: Horst Leonberger
Sitz der Gesellschaft: Nürnberg - Registergericht: Amtsgericht
Nürnberg: HRB 32315

Patch

diff --git a/Documentation/devicetree/bindings/rtc/isil,isl1219.txt b/Documentation/devicetree/bindings/rtc/isil,isl1219.txt
new file mode 100644
index 000000000000..f26f1e9d4bde
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/isil,isl1219.txt
@@ -0,0 +1,29 @@ 
+Intersil ISL1219 I2C RTC/Alarm chip with event in
+
+ISL1219 has additional pins EVIN and #EVDET for tamper detection.
+
+Required properties supported by the device:
+
+ - "compatible": must be "isil,isl1219"
+ - "reg": I2C bus address of the device
+
+Optional properties:
+
+ - "interrupt-names": list which may contains "irq" and "evdet"
+ - "interrupt-parent", "interrupts", "interrupts-extended":
+   for passing the interrupt line of the SoC connected to #IRQ pin
+   and #EVDET pin of the RTC chip.
+ - "isil,ev-evienb": if present bit can be set to disable event input pull-up
+
+
+Example isl1219 node with #IRQ pin connected to SoC gpio1 pin12
+ and #EVDET pin connected to SoC gpio2 pin 24:
+
+	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>;
+	};
+