2012-11-15 21:52:05

by Marek Belisko

Subject: [PATCH] Documentation: Move common leds properties description to separate file.

Signed-off-by: Marek Belisko <[email protected]>
---
Documentation/devicetree/bindings/gpio/led.txt | 14 ++++--------
Documentation/devicetree/bindings/leds/common.txt | 24 +++++++++++++++++++++
2 files changed, 28 insertions(+), 10 deletions(-)
create mode 100644 Documentation/devicetree/bindings/leds/common.txt

diff --git a/Documentation/devicetree/bindings/gpio/led.txt b/Documentation/devicetree/bindings/gpio/led.txt
index edc83c1..df1b308 100644
--- a/Documentation/devicetree/bindings/gpio/led.txt
+++ b/Documentation/devicetree/bindings/gpio/led.txt
@@ -10,16 +10,10 @@ LED sub-node properties:
- gpios : Should specify the LED's GPIO, see "gpios property" in
Documentation/devicetree/bindings/gpio/gpio.txt. Active low LEDs should be
indicated using flags in the GPIO specifier.
-- label : (optional) The label for this LED. If omitted, the label is
- taken from the node name (excluding the unit address).
-- linux,default-trigger : (optional) This parameter, if present, is a
- string defining the trigger assigned to the LED. Current triggers are:
- "backlight" - LED will act as a back-light, controlled by the framebuffer
- system
- "default-on" - LED will turn on, but see "default-state" below
- "heartbeat" - LED "double" flashes at a load average based rate
- "ide-disk" - LED indicates disk activity
- "timer" - LED flashes at a fixed, configurable rate
+- label : (optional)
+ see Documentation/devicetree/bindings/leds/common.txt
+- linux,default-trigger : (optional)
+ see Documentation/devicetree/bindings/leds/common.txt
- default-state: (optional) 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 set the to same value, then no
diff --git a/Documentation/devicetree/bindings/leds/common.txt b/Documentation/devicetree/bindings/leds/common.txt
new file mode 100644
index 0000000..0654693
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/common.txt
@@ -0,0 +1,24 @@
+Common leds properties.
+
+Optional properties for child nodes:
+- label : The label for this LED. If omitted, the label is
+ taken from the node name (excluding the unit address).
+
+- linux,default-trigger : This parameter, if present, is a
+ string defining the trigger assigned to the LED. Current triggers are:
+ "backlight" - LED will act as a back-light, controlled by the framebuffer
+ system
+ "default-on" - LED will turn on (but for leds-gpio see "default-state"
+ property in Documentation/devicetree/bindings/gpio/led.txt)
+ "heartbeat" - LED "double" flashes at a load average based rate
+ "ide-disk" - LED indicates disk activity
+ "timer" - LED flashes at a fixed, configurable rate
+
+Examples:
+
+system-status {
+ label = "Status";
+ linux,default-trigger = "heartbeat";
+ ...
+};
+
--
1.7.10.4

2012-11-15 22:36:38

by Stephen Warren

Subject: Re: [PATCH] Documentation: Move common leds properties description to separate file.

On 11/15/2012 02:51 PM, Marek Belisko wrote:

A commit description might be nice. Aside from that,
Reviewed-by: Stephen Warren <[email protected]>

2012-11-21 15:21:23

by Grant Likely

Subject: Re: [PATCH] Documentation: Move common leds properties description to separate file.

On Thu, 15 Nov 2012 15:36:34 -0700, Stephen Warren <[email protected]> wrote:
> On 11/15/2012 02:51 PM, Marek Belisko wrote:
>
> A commit description might be nice. Aside from that,

Indeed. I've applied the patch and written a commit description, but please take pity on a poor maintainer and write propper commit messages in future patches.

Thanks,
g.