[PATCH v6] DT: leds: Improve description of flash LEDs related properties

[PATCH v6] DT: leds: Improve description of flash LEDs related properties

[Jacek Anaszewski]

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: Bryan Wu <cooloney@gmail.com>
Cc: Richard Purdie <rpurdie@rpsys.net>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Sakari Ailus <sakari.ailus@linux.intel.com>
Cc: Sylwester Nawrocki <s.nawrocki@samsung.com>
Cc: devicetree@vger.kernel.org
---
 Documentation/devicetree/bindings/leds/common.txt |   27 ++++++++++++++-------
 1 file changed, 18 insertions(+), 9 deletions(-)

diff --git a/Documentation/devicetree/bindings/leds/common.txt b/Documentation/devicetree/bindings/leds/common.txt
index 747c538..6841984 100644
--- a/Documentation/devicetree/bindings/leds/common.txt
+++ b/Documentation/devicetree/bindings/leds/common.txt
@@ -29,14 +29,23 @@ Optional properties for child nodes:
      "ide-disk" - LED indicates disk activity
      "timer" - LED flashes at a fixed, configurable rate
 
-- max-microamp : maximum intensity in microamperes of the LED
-		 (torch LED for flash devices)
-- flash-max-microamp : maximum intensity in microamperes of the
-                       flash LED; it is mandatory if the LED should
-		       support the flash mode
-- flash-timeout-us : timeout in microseconds after which the flash
-                     LED is turned off
+- led-max-microamp : Maximum LED supply current in microamperes. This property
+                     can be made mandatory for the board configurations
+                     introducing a risk of hardware damage in case an excessive
+                     current is set.
+                     For flash LED controllers with configurable current this
+                     property is mandatory for the LEDs in the non-flash modes
+                     (e.g. torch or indicator).
 
+Required properties for flash LED child nodes:
+- flash-max-microamp : Maximum flash LED supply current in microamperes.
+- flash-max-timeout-us : Maximum timeout in microseconds after which the flash
+                         LED is turned off.
+
+For controllers that have no configurable current the flash-max-microamp
+property can be omitted.
+For controllers that have no configurable timeout the flash-max-timeout-us
+property can be omitted.
 
 Examples:
 
@@ -49,7 +58,7 @@ system-status {
 camera-flash {
 	label = "Flash";
 	led-sources = <0>, <1>;
-	max-microamp = <50000>;
+	led-max-microamp = <50000>;
 	flash-max-microamp = <320000>;
-	flash-timeout-us = <500000>;
+	flash-max-timeout-us = <500000>;
 };
-- 
1.7.9.5

Re: [PATCH v6] DT: leds: Improve description of flash LEDs related properties

[Sakari Ailus]

Hi Jacek,

Thank you for the quick update!

Jacek Anaszewski wrote:
> 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: Bryan Wu <cooloney@gmail.com>
> Cc: Richard Purdie <rpurdie@rpsys.net>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Sakari Ailus <sakari.ailus@linux.intel.com>
> Cc: Sylwester Nawrocki <s.nawrocki@samsung.com>
> Cc: devicetree@vger.kernel.org

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>

-- 
Kind regards,

Sakari Ailus
sakari.ailus@linux.intel.com

Re: [PATCH v6] DT: leds: Improve description of flash LEDs related properties

[Sylwester Nawrocki]

On 10/04/15 10:36, Jacek Anaszewski wrote:
> 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-Sze3O3UU22JBDgjK7y7TUQ@public.gmane.org>
> Cc: Bryan Wu <cooloney-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
> Cc: Richard Purdie <rpurdie-Fm38FmjxZ/leoWH0uzbU5w@public.gmane.org>
> Cc: Pavel Machek <pavel-+ZI9xUNit7I@public.gmane.org>
> Cc: Sakari Ailus <sakari.ailus-VuQAYsv1563Yd54FQh9/CA@public.gmane.org>
> Cc: Sylwester Nawrocki <s.nawrocki-Sze3O3UU22JBDgjK7y7TUQ@public.gmane.org>
> Cc: devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org

Looks good, thanks.

Acked-by: Sylwester Nawrocki <s.nawrocki-Sze3O3UU22JBDgjK7y7TUQ@public.gmane.org>
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v6] DT: leds: Improve description of flash LEDs related properties

[Jacek Anaszewski]

We're missing only a DT maintainer ack now. Could anyone take
a look at this, please?

On 04/10/2015 10:36 AM, Jacek Anaszewski wrote:
> 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: Bryan Wu <cooloney@gmail.com>
> Cc: Richard Purdie <rpurdie@rpsys.net>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Sakari Ailus <sakari.ailus@linux.intel.com>
> Cc: Sylwester Nawrocki <s.nawrocki@samsung.com>
> Cc: devicetree@vger.kernel.org
> ---
>   Documentation/devicetree/bindings/leds/common.txt |   27 ++++++++++++++-------
>   1 file changed, 18 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/leds/common.txt b/Documentation/devicetree/bindings/leds/common.txt
> index 747c538..6841984 100644
> --- a/Documentation/devicetree/bindings/leds/common.txt
> +++ b/Documentation/devicetree/bindings/leds/common.txt
> @@ -29,14 +29,23 @@ Optional properties for child nodes:
>        "ide-disk" - LED indicates disk activity
>        "timer" - LED flashes at a fixed, configurable rate
>
> -- max-microamp : maximum intensity in microamperes of the LED
> -		 (torch LED for flash devices)
> -- flash-max-microamp : maximum intensity in microamperes of the
> -                       flash LED; it is mandatory if the LED should
> -		       support the flash mode
> -- flash-timeout-us : timeout in microseconds after which the flash
> -                     LED is turned off
> +- led-max-microamp : Maximum LED supply current in microamperes. This property
> +                     can be made mandatory for the board configurations
> +                     introducing a risk of hardware damage in case an excessive
> +                     current is set.
> +                     For flash LED controllers with configurable current this
> +                     property is mandatory for the LEDs in the non-flash modes
> +                     (e.g. torch or indicator).
>
> +Required properties for flash LED child nodes:
> +- flash-max-microamp : Maximum flash LED supply current in microamperes.
> +- flash-max-timeout-us : Maximum timeout in microseconds after which the flash
> +                         LED is turned off.
> +
> +For controllers that have no configurable current the flash-max-microamp
> +property can be omitted.
> +For controllers that have no configurable timeout the flash-max-timeout-us
> +property can be omitted.
>
>   Examples:
>
> @@ -49,7 +58,7 @@ system-status {
>   camera-flash {
>   	label = "Flash";
>   	led-sources = <0>, <1>;
> -	max-microamp = <50000>;
> +	led-max-microamp = <50000>;
>   	flash-max-microamp = <320000>;
> -	flash-timeout-us = <500000>;
> +	flash-max-timeout-us = <500000>;
>   };
>


-- 
Best Regards,
Jacek Anaszewski