Commit b2791545 authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Rob Herring
Browse files

dt-bindings: leds: irled: ir-spi-led: convert to DT schema

parent 0212be85
Loading
Loading
Loading
Loading
+61 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
%YAML 1.2
---
$id: http://devicetree.org/schemas/leds/irled/ir-spi-led.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: IR LED connected through SPI bus

maintainers:
  - Sean Young <sean@mess.org>

description:
  IR LED switch is connected to the MOSI line of the SPI device and the data
  is delivered through that.

allOf:
  - $ref: /schemas/spi/spi-peripheral-props.yaml#

properties:
  compatible:
    const: ir-spi-led

  reg:
    maxItems: 1

  duty-cycle:
    $ref: /schemas/types.yaml#/definitions/uint8
    enum: [50, 60, 70, 75, 80, 90]
    description:
      Percentage of one period in which the signal is active.

  led-active-low:
    type: boolean
    description:
      Output is negated with a NOT gate.

  power-supply: true

required:
  - compatible
  - reg

unevaluatedProperties: false

examples:
  - |
    spi {
        #address-cells = <1>;
        #size-cells = <0>;

        irled@0 {
            compatible = "ir-spi-led";
            reg = <0x0>;

            duty-cycle = /bits/ 8 <60>;
            led-active-low;
            power-supply = <&irda_regulator>;
            spi-max-frequency = <5000000>;
        };
    };
+0 −29
Original line number Diff line number Diff line
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-led".

Optional properties:
	- duty-cycle: 8 bit value that represents the percentage of one period
	  in which the signal is active.  It can be 50, 60, 70, 75, 80 or 90.
	- led-active-low: boolean value that specifies whether the output is
	  negated with a NOT gate.
	- power-supply: specifies the power source. It can either be a regulator
	  or a gpio which enables a regulator, i.e. a regulator-fixed as
	  described in
	  Documentation/devicetree/bindings/regulator/fixed-regulator.yaml

Example:

	irled@0 {
		compatible = "ir-spi-led";
		reg = <0x0>;
		spi-max-frequency = <5000000>;
		power-supply = <&vdd_led>;
		led-active-low;
		duty-cycle = /bits/ 8 <60>;
	};