Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

DT: leds: Improve description of flash LEDs related properties

1. Since max-microamp property has had no users so far, then rename
it to more descriptive led-max-microamp.
2. Since flash-timeout-us property has had no users so far, then rename
it to more accurate flash-max-timeout-us.
3. Describe led-max-microamp property as mandatory for specific board
configurations.
4. Make flash-max-microamp and flash-max-timeout-us properties mandatory
for devices with configurable flash current and flash timeout settings
respectively.

Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>
Cc: Richard Purdie <rpurdie@rpsys.net>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: devicetree@vger.kernel.org
Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Acked-by: Sylwester Nawrocki <s.nawrocki@samsung.com>

+18 -9
+18 -9
Documentation/devicetree/bindings/leds/common.txt
··· 29 29 "ide-disk" - LED indicates disk activity 30 30 "timer" - LED flashes at a fixed, configurable rate 31 31 32 - - max-microamp : maximum intensity in microamperes of the LED 33 - (torch LED for flash devices) 34 - - flash-max-microamp : maximum intensity in microamperes of the 35 - flash LED; it is mandatory if the LED should 36 - support the flash mode 37 - - flash-timeout-us : timeout in microseconds after which the flash 38 - LED is turned off 32 + - led-max-microamp : Maximum LED supply current in microamperes. This property 33 + can be made mandatory for the board configurations 34 + introducing a risk of hardware damage in case an excessive 35 + current is set. 36 + For flash LED controllers with configurable current this 37 + property is mandatory for the LEDs in the non-flash modes 38 + (e.g. torch or indicator). 39 39 40 + Required properties for flash LED child nodes: 41 + - flash-max-microamp : Maximum flash LED supply current in microamperes. 42 + - flash-max-timeout-us : Maximum timeout in microseconds after which the flash 43 + LED is turned off. 44 + 45 + For controllers that have no configurable current the flash-max-microamp 46 + property can be omitted. 47 + For controllers that have no configurable timeout the flash-max-timeout-us 48 + property can be omitted. 40 49 41 50 Examples: 42 51 ··· 58 49 camera-flash { 59 50 label = "Flash"; 60 51 led-sources = <0>, <1>; 61 - max-microamp = <50000>; 52 + led-max-microamp = <50000>; 62 53 flash-max-microamp = <320000>; 63 - flash-timeout-us = <500000>; 54 + flash-max-timeout-us = <500000>; 64 55 };