Re: [PATCH 08/10] leds: Add binding for Juniper's I2CS FPGA

From: Jacek Anaszewski
Date: Mon Oct 10 2016 - 05:42:02 EST


Hi Pantelis,

On 10/07/2016 05:21 PM, Pantelis Antoniou wrote:
From: Georgi Vlaev <gvlaev@xxxxxxxxxxx>

Document bindings for the I2CS FPGA leds.

Signed-off-by: Georgi Vlaev <gvlaev@xxxxxxxxxxx>
[Ported from Juniper kernel]
Signed-off-by: Pantelis Antoniou <pantelis.antoniou@xxxxxxxxxxxx>
---
.../devicetree/bindings/leds/leds-i2cs.txt | 34 ++++++++++++++++++++++
1 file changed, 34 insertions(+)
create mode 100644 Documentation/devicetree/bindings/leds/leds-i2cs.txt

diff --git a/Documentation/devicetree/bindings/leds/leds-i2cs.txt b/Documentation/devicetree/bindings/leds/leds-i2cs.txt
new file mode 100644
index 0000000..100e584
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-i2cs.txt
@@ -0,0 +1,34 @@
+Juniper I2CS LED driver.
+
+This is present in Juniper platforms that use a I2CS Slave FPGA.
+
+Required properties:
+ - compatible: must be "jnx,leds-i2cs"

s/compatible:/compatible :/

Also treat the description as a regular sentence, i.e. begin it
with a capital letter and put a dot at the end.

+ - #address-cells : must be 1.
+ - #size-cells : must be 0.

s/must/Must/

+Each led is represented as a sub-node of the jnx,leds-i2cs device.
+
+LED sub-node properties:
+- label : (optional) see Documentation/devicetree/bindings/leds/common.txt
+- reg : number of LED
+- linux,default-trigger : (optional)
+ see Documentation/devicetree/bindings/leds/common.txt

Driver uses also "hw-blink" property. Please document it here, but
add also a prefix:

jnx,hw-blink

Also "jnx" entry should be added to Documentation/devicetree/bindings/vendor-prefixes.txt.

+Example:
+
+leds_fpc0: leds-jnx-i2cs {
+ compatible = "jnx,leds-i2cs";
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ fpc0-fail {
+ reg = <1>;

It would be good to provide also an example of "label"
property to suggest LED class device name according to
the LED class device naming convention.
See Documentation/leds/leds-class.txt for details.

+ linux,default-trigger = "fpc0-fail";
+ };
+
+ fpc0-ok {
+ reg = <2>;
+ linux,default-trigger = "fpc0-ok";
+ };
+};



--
Best regards,
Jacek Anaszewski