diff mbox

[v2,6/7] Documentation: bindings: add documentation for ir-spi device driver

Message ID 20160901171629.15422-7-andi.shyti@samsung.com
State Changes Requested, archived
Headers show

Commit Message

Andi Shyti Sept. 1, 2016, 5:16 p.m. UTC
Document the ir-spi driver's binding which is a IR led driven
through the SPI line.

Signed-off-by: Andi Shyti <andi.shyti@samsung.com>
---
 Documentation/devicetree/bindings/media/spi-ir.txt | 26 ++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/media/spi-ir.txt

Comments

Rob Herring Sept. 1, 2016, 9:40 p.m. UTC | #1
On Thu, Sep 1, 2016 at 12:16 PM, Andi Shyti <andi.shyti@samsung.com> wrote:
> Document the ir-spi driver's binding which is a IR led driven
> through the SPI line.
>
> Signed-off-by: Andi Shyti <andi.shyti@samsung.com>
> ---
>  Documentation/devicetree/bindings/media/spi-ir.txt | 26 ++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/media/spi-ir.txt
>
> diff --git a/Documentation/devicetree/bindings/media/spi-ir.txt b/Documentation/devicetree/bindings/media/spi-ir.txt
> new file mode 100644
> index 0000000..85cb21b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/spi-ir.txt

Move this to bindings/leds, and CC the leds maintainers.

> @@ -0,0 +1,26 @@
> +Device tree bindings for IR LED connected through SPI bus which is used as
> +remote controller.
> +
> +The IR LED switch is connected to the MOSI line of the SPI device and the data
> +are delivered thourgh that.
> +
> +Required properties:
> +       - compatible: should be "ir-spi".

Really this is just an LED connected to a SPI, so maybe this should
just be "spi-led". If being more specific is helpful, then I'm all for
that, but perhaps spi-ir-led. (Trying to be consistent in naming with
gpio-leds).

> +
> +Optional properties:
> +       - irled,switch: specifies the gpio switch which enables the irled/

As I said previously, "switch-gpios" as gpio lines should have a
'-gpios' suffix. Or better yet, "enable-gpios" as that is a standard
name for an enable line.

> +       - negated: boolean value that specifies whether the output is negated
> +         with a NOT gate.

Negated or inverted assumes I know what normal is. Define this in
terms of what is the on state. If on is normally active low, then this
should be led-active-high. There may already be an LED property for
this.

> +       - duty-cycle: 8 bit value that stores the percentage of the duty cycle.
> +         it can be 50, 60, 70, 75, 80 or 90.

This is percent time on or off?

Rob
--
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
Andi Shyti Sept. 2, 2016, 5:33 a.m. UTC | #2
Hi Rob,

> > Document the ir-spi driver's binding which is a IR led driven
> > through the SPI line.
> >
> > Signed-off-by: Andi Shyti <andi.shyti@samsung.com>
> > ---
> >  Documentation/devicetree/bindings/media/spi-ir.txt | 26 ++++++++++++++++++++++
> >  1 file changed, 26 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/media/spi-ir.txt
> >
> > diff --git a/Documentation/devicetree/bindings/media/spi-ir.txt b/Documentation/devicetree/bindings/media/spi-ir.txt
> > new file mode 100644
> > index 0000000..85cb21b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/media/spi-ir.txt
> 
> Move this to bindings/leds, and CC the leds maintainers.

More than an LED this is the driver of a remote controller, the
driver itself is under drivers/media/rc/.

Besides all the transmitters have an LED but still they are media
devices. This is a bit special because it's so simple that the
only hardware left is the LED itself, but still it's a media remote
controller.

> > @@ -0,0 +1,26 @@
> > +Device tree bindings for IR LED connected through SPI bus which is used as
> > +remote controller.
> > +
> > +The IR LED switch is connected to the MOSI line of the SPI device and the data
> > +are delivered thourgh that.
> > +
> > +Required properties:
> > +       - compatible: should be "ir-spi".
> 
> Really this is just an LED connected to a SPI, so maybe this should
> just be "spi-led". If being more specific is helpful, then I'm all for
> that, but perhaps spi-ir-led. (Trying to be consistent in naming with
> gpio-leds).

As I mentioned above, all transmitters have an LED, but they do
not have the 'led' name. "ir-spi" is coherent with the device
driver name and the driver name is coherent with the media/rc
driver's naming.

> > +
> > +Optional properties:
> > +       - irled,switch: specifies the gpio switch which enables the irled/
> 
> As I said previously, "switch-gpios" as gpio lines should have a
> '-gpios' suffix. Or better yet, "enable-gpios" as that is a standard
> name for an enable line.

OK, thanks!

> > +       - negated: boolean value that specifies whether the output is negated
> > +         with a NOT gate.
> 
> Negated or inverted assumes I know what normal is. Define this in
> terms of what is the on state. If on is normally active low, then this
> should be led-active-high. There may already be an LED property for
> this.

Yes, thanks!

> > +       - duty-cycle: 8 bit value that stores the percentage of the duty cycle.
> > +         it can be 50, 60, 70, 75, 80 or 90.
> 
> This is percent time on or off?

Will add more details, thanks.

If it's OK for you, I would keep the name and documentation path
and fix the rest. Please let me know if I'm missing something :)

Thanks,
Andi
--
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 Sept. 12, 2016, 1:27 p.m. UTC | #3
On Fri, Sep 02, 2016 at 02:33:20PM +0900, Andi Shyti wrote:
> Hi Rob,
> 
> > > Document the ir-spi driver's binding which is a IR led driven
> > > through the SPI line.
> > >
> > > Signed-off-by: Andi Shyti <andi.shyti@samsung.com>
> > > ---
> > >  Documentation/devicetree/bindings/media/spi-ir.txt | 26 ++++++++++++++++++++++
> > >  1 file changed, 26 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/media/spi-ir.txt
> > >
> > > diff --git a/Documentation/devicetree/bindings/media/spi-ir.txt b/Documentation/devicetree/bindings/media/spi-ir.txt
> > > new file mode 100644
> > > index 0000000..85cb21b
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/media/spi-ir.txt
> > 
> > Move this to bindings/leds, and CC the leds maintainers.
> 
> More than an LED this is the driver of a remote controller, the
> driver itself is under drivers/media/rc/.

The hardware is just an LED though and bindings describe h/w. What you 
are using it for doesn't really matter. You only need to know it's an IR 
led.
 
> Besides all the transmitters have an LED but still they are media
> devices. This is a bit special because it's so simple that the
> only hardware left is the LED itself, but still it's a media remote
> controller.
> 
> > > @@ -0,0 +1,26 @@
> > > +Device tree bindings for IR LED connected through SPI bus which is used as
> > > +remote controller.
> > > +
> > > +The IR LED switch is connected to the MOSI line of the SPI device and the data
> > > +are delivered thourgh that.
> > > +
> > > +Required properties:
> > > +       - compatible: should be "ir-spi".
> > 
> > Really this is just an LED connected to a SPI, so maybe this should
> > just be "spi-led". If being more specific is helpful, then I'm all for
> > that, but perhaps spi-ir-led. (Trying to be consistent in naming with
> > gpio-leds).
> 
> As I mentioned above, all transmitters have an LED, but they do
> not have the 'led' name. "ir-spi" is coherent with the device
> driver name and the driver name is coherent with the media/rc
> driver's naming.

The driver name is irrelevant to the binding. 

[...]

> If it's OK for you, I would keep the name and documentation path
> and fix the rest. Please let me know if I'm missing something :)

It's not OK for me.

Rob
--
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
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/media/spi-ir.txt b/Documentation/devicetree/bindings/media/spi-ir.txt
new file mode 100644
index 0000000..85cb21b
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/spi-ir.txt
@@ -0,0 +1,26 @@ 
+Device tree bindings for IR LED connected through SPI bus which is used as
+remote controller.
+
+The IR LED switch is connected to the MOSI line of the SPI device and the data
+are delivered thourgh that.
+
+Required properties:
+	- compatible: should be "ir-spi".
+
+Optional properties:
+	- irled,switch: specifies the gpio switch which enables the irled/
+	- negated: boolean value that specifies whether the output is negated
+	  with a NOT gate.
+	- duty-cycle: 8 bit value that stores the percentage of the duty cycle.
+	  it can be 50, 60, 70, 75, 80 or 90.
+
+Example:
+
+        irled@0 {
+                compatible = "ir-spi";
+                reg = <0x0>;
+                spi-max-frequency = <5000000>;
+                irled,switch = <&gpr3 3 0>;
+		negated;
+		duty-cycle = /bits/ 8 <60>;
+        };