Re: [PATCH v2 6/7] Documentation: bindings: add documentation for ir-spi device driver
From: Rob Herring <robh+dt@kernel.org>
Date: 2016-09-01 21:41:23
Also in:
linux-media, lkml
On Thu, Sep 1, 2016 at 12:16 PM, Andi Shyti [off-list ref] wrote:
quoted hunk ↗ jump to hunk
Document the ir-spi driver's binding which is a IR led driven through the SPI line. Signed-off-by: Andi Shyti <redacted> --- Documentation/devicetree/bindings/media/spi-ir.txt | 26 ++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 Documentation/devicetree/bindings/media/spi-ir.txtdiff --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.
quoted hunk ↗ jump to hunk
@@ -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