Commit c5d18dd6 authored by Jacek Anaszewski's avatar Jacek Anaszewski
Browse files

dt-bindings: leds: Add properties for LED name construction 



Introduce dedicated properties for conveying information about
LED function and color. Mark old "label" property as deprecated.

Additionally function-enumerator property is being provided
for the cases when neither function nor color can be used
for LED differentiation.

Signed-off-by: default avatarJacek Anaszewski <jacek.anaszewski@gmail.com>
Cc: Baolin Wang <baolin.wang@linaro.org>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Dan Murphy <dmurphy@ti.com>
Cc: Daniel Mack <daniel@zonque.org>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Oleh Kravchenko <oleg@kaa.org.ua>
Cc: Sakari Ailus <sakari.ailus@linux.intel.com>
Cc: Simon Shields <simon@lineageos.org>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
parent 2f430310

Documentation/devicetree/bindings/leds/common.txt

+54 −8
Original line number Diff line number Diff line
@@ -10,14 +10,30 @@ can influence the way of the LED device initialization, the LED components 
have to be tightly coupled with the LED device binding. They are represented

by child nodes of the parent LED device binding.





Optional properties for child nodes:

- led-sources : List of device current outputs the LED is connected to. The

		outputs are identified by the numbers that must be defined

		in the LED device binding documentation.



- function: LED functon. Use one of the LED_FUNCTION_* prefixed definitions

	    from the header include/dt-bindings/leds/common.h.

	    If there is no matching LED_FUNCTION available, add a new one.



- color : Color of the LED. Use one of the LED_COLOR_ID_* prefixed definitions

	  from the header include/dt-bindings/leds/common.h.

	  If there is no matching LED_COLOR_ID available, add a new one.



- function-enumerator: Integer to be used when more than one instance

                       of the same function is needed, differing only with

		       an ordinal number.



- label : The label for this LED. If omitted, the label is taken from the node

	  name (excluding the unit address). It has to uniquely identify

	  a device, i.e. no other LED class device can be assigned the same

	  label.

	  label. This property is deprecated - use 'function' and 'color'

	  properties instead. function-enumerator has no effect when this

	  property is present.



- default-state : The initial state of the LED. Valid values are "on", "off",

  and "keep". If the LED is already on or off and the default-state property is
@@ -99,29 +115,59 @@ Required properties for trigger source: 


* Examples



gpio-leds {

#include <dt-bindings/leds/common.h>



led-controller@0 {

	compatible = "gpio-leds";



	system-status {

		label = "Status";

	led0 {

		function = LED_FUNCTION_STATUS;

		linux,default-trigger = "heartbeat";

		gpios = <&gpio0 0 GPIO_ACTIVE_HIGH>;

	};



	usb {

	led1 {

		function = LED_FUNCTION_USB;

		gpios = <&gpio0 1 GPIO_ACTIVE_HIGH>;

		trigger-sources = <&ohci_port1>, <&ehci_port1>;

	};

};



max77693-led {

led-controller@0 {

	compatible = "maxim,max77693-led";



	camera-flash {

		label = "Flash";

	led {

		function = LED_FUNCTION_FLASH;

		color = <LED_COLOR_ID_WHITE>;

		led-sources = <0>, <1>;

		led-max-microamp = <50000>;

		flash-max-microamp = <320000>;

		flash-max-timeout-us = <500000>;

	};

};



led-controller@30 {

        compatible = "panasonic,an30259a";

        reg = <0x30>;

        #address-cells = <1>;

        #size-cells = <0>;



        led@1 {

		reg = <1>;

		linux,default-trigger = "heartbeat";

		function = LED_FUNCTION_INDICATOR;

		function-enumerator = <1>;

        };



        led@2 {

		reg = <2>;

		function = LED_FUNCTION_INDICATOR;

		function-enumerator = <2>;

        };



        led@3 {

		reg = <3>;

		function = LED_FUNCTION_INDICATOR;

		function-enumerator = <3>;

        };

};

CRA Git | Maintained and supported by SUSTech CRA and CCSE