diff mbox

[1/2] Documentation: devicetree: add epson rx6110 binding

Message ID 1448361533-10728-1-git-send-email-s.trumtrar@pengutronix.de
State Changes Requested, archived
Headers show

Commit Message

Steffen Trumtrar Nov. 24, 2015, 10:38 a.m. UTC
Add the binding documentation for the Epson RX6110 RTC.

Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de>
---
I'm not sure what the current policy for such simple SPI bindings is.
Are they necessary?

 .../devicetree/bindings/rtc/epson,rtc-rx6110.txt   | 25 ++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt

Comments

Philipp Zabel Nov. 24, 2015, 11:12 a.m. UTC | #1
Am Dienstag, den 24.11.2015, 11:38 +0100 schrieb Steffen Trumtrar:
> Add the binding documentation for the Epson RX6110 RTC.
> 
> Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de>
> ---
> I'm not sure what the current policy for such simple SPI bindings is.
> Are they necessary?

Like for i2c there is trivial-devices.txt? Although in this case it's
not just a compatible. Here you have a certain spi configuration that is
necessary for the rtc to work.

>  .../devicetree/bindings/rtc/epson,rtc-rx6110.txt   | 25 ++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> 
> diff --git a/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> new file mode 100644
> index 000000000000..7ce7ae761657
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> @@ -0,0 +1,25 @@
> +Epson RX6110 Real Time Clock
> +============================
> +
> +The Epson RX6110 can be used with SPI or I2C busses. The kind of
> +bus depends on the SPISEL pin and can not be configured via software.
> +
> +SPI mode
> +--------
> +
> +Required properties:
> +- compatible: should be: "epson,rtc-rx6110"

Should this just be "epson,rx6110" ?

> +- reg: chip select number
> +- spi-cs-high: RX6110 needs chipselect high
> +- spi-cpha: RX6110 works with SPI shifted clock phase
> +- spi-cpol: RX6110 works with SPI inverse clock polarity
> +
> +Example:
> +
> +	rtc: rtc@3 {
> +		compatible = "epson,rtc-rx6110"
> +		reg = <3>
> +		spi-cs-high;
> +		spi-cpba;

s/b/h/

> +		spi-cpol;
> +	};

regards
Philipp

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Rob Herring Nov. 24, 2015, 11:54 p.m. UTC | #2
On Tue, Nov 24, 2015 at 11:38:52AM +0100, Steffen Trumtrar wrote:
> Add the binding documentation for the Epson RX6110 RTC.
> 
> Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de>
> ---
> I'm not sure what the current policy for such simple SPI bindings is.
> Are they necessary?

Yes. We do have trivial-devices.txt for i2c. We could do one for spi. 
Although, you need the mode configuration for each device, so spi is not 
so trivial.

> 
>  .../devicetree/bindings/rtc/epson,rtc-rx6110.txt   | 25 ++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> 
> diff --git a/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> new file mode 100644
> index 000000000000..7ce7ae761657
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> @@ -0,0 +1,25 @@
> +Epson RX6110 Real Time Clock
> +============================
> +
> +The Epson RX6110 can be used with SPI or I2C busses. The kind of
> +bus depends on the SPISEL pin and can not be configured via software.

Can you document I2C mode. It should just be the compatible and reg 
properties.

> +
> +SPI mode
> +--------
> +
> +Required properties:
> +- compatible: should be: "epson,rtc-rx6110"
> +- reg: chip select number
> +- spi-cs-high: RX6110 needs chipselect high
> +- spi-cpha: RX6110 works with SPI shifted clock phase
> +- spi-cpol: RX6110 works with SPI inverse clock polarity
> +
> +Example:
> +
> +	rtc: rtc@3 {
> +		compatible = "epson,rtc-rx6110"
> +		reg = <3>
> +		spi-cs-high;
> +		spi-cpba;
> +		spi-cpol;
> +	};
> -- 
> 2.6.2
> 
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Rob Herring Nov. 24, 2015, 11:55 p.m. UTC | #3
On Tue, Nov 24, 2015 at 12:12:41PM +0100, Philipp Zabel wrote:
> Am Dienstag, den 24.11.2015, 11:38 +0100 schrieb Steffen Trumtrar:
> > Add the binding documentation for the Epson RX6110 RTC.
> > 
> > Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de>

[...]

> > +Required properties:
> > +- compatible: should be: "epson,rtc-rx6110"
> 
> Should this just be "epson,rx6110" ?

Yes.

 
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Steffen Trumtrar Nov. 25, 2015, 9 a.m. UTC | #4
On Tue, Nov 24, 2015 at 05:54:00PM -0600, Rob Herring wrote:
> On Tue, Nov 24, 2015 at 11:38:52AM +0100, Steffen Trumtrar wrote:
> > Add the binding documentation for the Epson RX6110 RTC.
> > 
> > Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de>
> > ---
> > I'm not sure what the current policy for such simple SPI bindings is.
> > Are they necessary?
> 
> Yes. We do have trivial-devices.txt for i2c. We could do one for spi. 
> Although, you need the mode configuration for each device, so spi is not 
> so trivial.
> 

Very good. I thought so.

> > 
> >  .../devicetree/bindings/rtc/epson,rtc-rx6110.txt   | 25 ++++++++++++++++++++++
> >  1 file changed, 25 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> > new file mode 100644
> > index 000000000000..7ce7ae761657
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> > @@ -0,0 +1,25 @@
> > +Epson RX6110 Real Time Clock
> > +============================
> > +
> > +The Epson RX6110 can be used with SPI or I2C busses. The kind of
> > +bus depends on the SPISEL pin and can not be configured via software.
> 
> Can you document I2C mode. It should just be the compatible and reg 
> properties.
> 

Okay, will do.

Thanks,
Steffen
Steffen Trumtrar Nov. 25, 2015, 9:02 a.m. UTC | #5
On Tue, Nov 24, 2015 at 12:12:41PM +0100, Philipp Zabel wrote:
> Am Dienstag, den 24.11.2015, 11:38 +0100 schrieb Steffen Trumtrar:
> > Add the binding documentation for the Epson RX6110 RTC.
> > 
> > Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de>
> > ---
> > I'm not sure what the current policy for such simple SPI bindings is.
> > Are they necessary?
> 
> Like for i2c there is trivial-devices.txt? Although in this case it's
> not just a compatible. Here you have a certain spi configuration that is
> necessary for the rtc to work.
> 
> >  .../devicetree/bindings/rtc/epson,rtc-rx6110.txt   | 25 ++++++++++++++++++++++
> >  1 file changed, 25 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> > new file mode 100644
> > index 000000000000..7ce7ae761657
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
> > @@ -0,0 +1,25 @@
> > +Epson RX6110 Real Time Clock
> > +============================
> > +
> > +The Epson RX6110 can be used with SPI or I2C busses. The kind of
> > +bus depends on the SPISEL pin and can not be configured via software.
> > +
> > +SPI mode
> > +--------
> > +
> > +Required properties:
> > +- compatible: should be: "epson,rtc-rx6110"
> 
> Should this just be "epson,rx6110" ?
> 
> > +- reg: chip select number
> > +- spi-cs-high: RX6110 needs chipselect high
> > +- spi-cpha: RX6110 works with SPI shifted clock phase
> > +- spi-cpol: RX6110 works with SPI inverse clock polarity
> > +
> > +Example:
> > +
> > +	rtc: rtc@3 {
> > +		compatible = "epson,rtc-rx6110"
> > +		reg = <3>
> > +		spi-cs-high;
> > +		spi-cpba;
> 
> s/b/h/

I thought I copy-pasted this; seems I didn't =-o

Thanks,
Steffen
Steffen Trumtrar Nov. 25, 2015, 9:02 a.m. UTC | #6
On Tue, Nov 24, 2015 at 05:55:24PM -0600, Rob Herring wrote:
> On Tue, Nov 24, 2015 at 12:12:41PM +0100, Philipp Zabel wrote:
> > Am Dienstag, den 24.11.2015, 11:38 +0100 schrieb Steffen Trumtrar:
> > > Add the binding documentation for the Epson RX6110 RTC.
> > > 
> > > Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de>
> 
> [...]
> 
> > > +Required properties:
> > > +- compatible: should be: "epson,rtc-rx6110"
> > 
> > Should this just be "epson,rx6110" ?
> 
> Yes.
> 

Okay.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
new file mode 100644
index 000000000000..7ce7ae761657
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/epson,rtc-rx6110.txt
@@ -0,0 +1,25 @@ 
+Epson RX6110 Real Time Clock
+============================
+
+The Epson RX6110 can be used with SPI or I2C busses. The kind of
+bus depends on the SPISEL pin and can not be configured via software.
+
+SPI mode
+--------
+
+Required properties:
+- compatible: should be: "epson,rtc-rx6110"
+- reg: chip select number
+- spi-cs-high: RX6110 needs chipselect high
+- spi-cpha: RX6110 works with SPI shifted clock phase
+- spi-cpol: RX6110 works with SPI inverse clock polarity
+
+Example:
+
+	rtc: rtc@3 {
+		compatible = "epson,rtc-rx6110"
+		reg = <3>
+		spi-cs-high;
+		spi-cpba;
+		spi-cpol;
+	};