linux-kernel - Re: [PATCH v2 6/7] Documentation: bindings: add documentation for ir-spi device driver

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAL_JsqL_AG0m_BctOBV+QOGJcUEup_6ovS6shjo+BrJ974jpaA@mail.gmail.com>
Date:   Thu, 1 Sep 2016 16:40:54 -0500
From:   Rob Herring <robh+dt@...nel.org>
To:     Andi Shyti <andi.shyti@...sung.com>
Cc:     Mauro Carvalho Chehab <mchehab@....samsung.com>,
        Sean Young <sean@...s.org>,
        Mark Rutland <mark.rutland@....com>,
        "linux-media@...r.kernel.org" <linux-media@...r.kernel.org>,
        "devicetree@...r.kernel.org" <devicetree@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        Andi Shyti <andi@...zian.org>
Subject: Re: [PATCH v2 6/7] Documentation: bindings: add documentation for
 ir-spi device driver

On Thu, Sep 1, 2016 at 12:16 PM, Andi Shyti <andi.shyti@...sung.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@...sung.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