diff options
author | Jacek Anaszewski <j.anaszewski@samsung.com> | 2015-04-10 04:36:56 -0400 |
---|---|---|
committer | Jacek Anaszewski <j.anaszewski@samsung.com> | 2015-08-28 08:05:55 -0400 |
commit | aa14318aa02f14044acf81f418e1a1cbda29fcfc (patch) | |
tree | d17ae64ec183141822494449e2b505afa1706b5b | |
parent | c13dcf9f2d6f5f06ef1bf79ec456df614c5e058b (diff) |
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>
-rw-r--r-- | Documentation/devicetree/bindings/leds/common.txt | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/Documentation/devicetree/bindings/leds/common.txt b/Documentation/devicetree/bindings/leds/common.txt index 747c53805eec..68419843e32f 100644 --- a/Documentation/devicetree/bindings/leds/common.txt +++ b/Documentation/devicetree/bindings/leds/common.txt | |||
@@ -29,14 +29,23 @@ Optional properties for child nodes: | |||
29 | "ide-disk" - LED indicates disk activity | 29 | "ide-disk" - LED indicates disk activity |
30 | "timer" - LED flashes at a fixed, configurable rate | 30 | "timer" - LED flashes at a fixed, configurable rate |
31 | 31 | ||
32 | - max-microamp : maximum intensity in microamperes of the LED | 32 | - led-max-microamp : Maximum LED supply current in microamperes. This property |
33 | (torch LED for flash devices) | 33 | can be made mandatory for the board configurations |
34 | - flash-max-microamp : maximum intensity in microamperes of the | 34 | introducing a risk of hardware damage in case an excessive |
35 | flash LED; it is mandatory if the LED should | 35 | current is set. |
36 | support the flash mode | 36 | For flash LED controllers with configurable current this |
37 | - flash-timeout-us : timeout in microseconds after which the flash | 37 | property is mandatory for the LEDs in the non-flash modes |
38 | LED is turned off | 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 | Examples: | 50 | Examples: |
42 | 51 | ||
@@ -49,7 +58,7 @@ system-status { | |||
49 | camera-flash { | 58 | camera-flash { |
50 | label = "Flash"; | 59 | label = "Flash"; |
51 | led-sources = <0>, <1>; | 60 | led-sources = <0>, <1>; |
52 | max-microamp = <50000>; | 61 | led-max-microamp = <50000>; |
53 | flash-max-microamp = <320000>; | 62 | flash-max-microamp = <320000>; |
54 | flash-timeout-us = <500000>; | 63 | flash-max-timeout-us = <500000>; |
55 | }; | 64 | }; |