devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Alexander Dahl <post@lespocky.de>
To: Pavel Machek <pavel@ucw.cz>, Dan Murphy <dmurphy@ti.com>,
	Rob Herring <robh+dt@kernel.org>
Cc: Alexander Dahl <ada@thorsis.com>,
	Jacek Anaszewski <jacek.anaszewski@gmail.com>,
	Alexander Dahl <post@lespocky.de>,
	linux-leds@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	linux-samsung-soc@vger.kernel.org, linux-omap@vger.kernel.org,
	linux-stm32@st-md-mailman.stormreply.com,
	linux-amlogic@lists.infradead.org, linux-mips@vger.kernel.org,
	Krzysztof Kozlowski <krzk@kernel.org>,
	Rob Herring <robh@kernel.org>,
	Peter Ujfalusi <peter.ujfalusi@ti.com>,
	Russell King <linux@armlinux.org.uk>
Subject: [PATCH v7 02/12] dt-bindings: leds: Convert pwm to yaml
Date: Mon,  5 Oct 2020 22:34:41 +0200	[thread overview]
Message-ID: <20201005203451.9985-3-post@lespocky.de> (raw)
In-Reply-To: <20201005203451.9985-1-post@lespocky.de>

The example was adapted in the following ways:

- make use of the now supported 'function' and 'color' properties
- remove pwm nodes, those are documented elsewhere
- align node names to new dt schema rules and dt recommendations

License was not explicitly set before.  The license set now is
recommended by DT project.

Suggested-by: Jacek Anaszewski <jacek.anaszewski@gmail.com>
Signed-off-by: Alexander Dahl <post@lespocky.de>
Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
Reviewed-by: Rob Herring <robh@kernel.org>
Cc: Peter Ujfalusi <peter.ujfalusi@ti.com>
Cc: Russell King <linux@armlinux.org.uk>
---

Notes:
    NOTE: Due to license set/change this needs Acked-by or Signed-off-by from:
      * Peter Ujfalusi
      * Russell King
    
    That was discussed already with Peter (original author), still waiting
    for Acked-by though …
    
    Changelog
    ---------
    v6 -> v7:
      * added Reviewed-by (Krzysztof Kozlowski)
      * reworded commit message (suggested by Krzysztof)
      * added Reviewed-by (Rob Herring)
    
    v5 -> v6:
      * removed pwm nodes from example (Rob)
      * renamed led-controller node in example (Rob)
    
    v4 -> v5:
      * updated based on feedback by Rob Herring
      * removed Acked-by
    
    v3 -> v4:
      * added Cc to original author of the binding
    
    v2 -> v3:
      * changed license identifier to recommended one
      * added Acked-by
    
    v2:
      * added this patch to series (Suggested-by: Jacek Anaszewski)

 .../devicetree/bindings/leds/leds-pwm.txt     | 50 -------------
 .../devicetree/bindings/leds/leds-pwm.yaml    | 70 +++++++++++++++++++
 2 files changed, 70 insertions(+), 50 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/leds/leds-pwm.txt
 create mode 100644 Documentation/devicetree/bindings/leds/leds-pwm.yaml

diff --git a/Documentation/devicetree/bindings/leds/leds-pwm.txt b/Documentation/devicetree/bindings/leds/leds-pwm.txt
deleted file mode 100644
index 6c6583c35f2f..000000000000
--- a/Documentation/devicetree/bindings/leds/leds-pwm.txt
+++ /dev/null
@@ -1,50 +0,0 @@
-LED connected to PWM
-
-Required properties:
-- compatible : should be "pwm-leds".
-
-Each LED is represented as a sub-node of the pwm-leds device.  Each
-node's name represents the name of the corresponding LED.
-
-LED sub-node properties:
-- pwms : PWM property to point to the PWM device (phandle)/port (id) and to
-  specify the period time to be used: <&phandle id period_ns>;
-- pwm-names : (optional) Name to be used by the PWM subsystem for the PWM device
-  For the pwms and pwm-names property please refer to:
-  Documentation/devicetree/bindings/pwm/pwm.txt
-- max-brightness : Maximum brightness possible for the LED
-- active-low : (optional) For PWMs where the LED is wired to supply
-  rather than ground.
-- label :  (optional)
-  see Documentation/devicetree/bindings/leds/common.txt
-- linux,default-trigger :  (optional)
-  see Documentation/devicetree/bindings/leds/common.txt
-
-Example:
-
-twl_pwm: pwm {
-	/* provides two PWMs (id 0, 1 for PWM1 and PWM2) */
-	compatible = "ti,twl6030-pwm";
-	#pwm-cells = <2>;
-};
-
-twl_pwmled: pwmled {
-	/* provides one PWM (id 0 for Charing indicator LED) */
-	compatible = "ti,twl6030-pwmled";
-	#pwm-cells = <2>;
-};
-
-pwmleds {
-	compatible = "pwm-leds";
-	kpad {
-		label = "omap4::keypad";
-		pwms = <&twl_pwm 0 7812500>;
-		max-brightness = <127>;
-	};
-
-	charging {
-		label = "omap4:green:chrg";
-		pwms = <&twl_pwmled 0 7812500>;
-		max-brightness = <255>;
-	};
-};
diff --git a/Documentation/devicetree/bindings/leds/leds-pwm.yaml b/Documentation/devicetree/bindings/leds/leds-pwm.yaml
new file mode 100644
index 000000000000..fe4d5fd25913
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-pwm.yaml
@@ -0,0 +1,70 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/leds-pwm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: LEDs connected to PWM
+
+maintainers:
+  - Pavel Machek <pavel@ucw.cz>
+
+description:
+  Each LED is represented as a sub-node of the pwm-leds device.  Each
+  node's name represents the name of the corresponding LED.
+
+properties:
+  compatible:
+    const: pwm-leds
+
+patternProperties:
+  "^led(-[0-9a-f]+)?$":
+    type: object
+
+    $ref: common.yaml#
+
+    properties:
+      pwms:
+        maxItems: 1
+
+      pwm-names: true
+
+      max-brightness:
+        description:
+          Maximum brightness possible for the LED
+        $ref: /schemas/types.yaml#/definitions/uint32
+
+      active-low:
+        description:
+          For PWMs where the LED is wired to supply rather than ground.
+        type: boolean
+
+    required:
+      - pwms
+      - max-brightness
+
+additionalProperties: false
+
+examples:
+  - |
+
+    #include <dt-bindings/leds/common.h>
+
+    led-controller {
+        compatible = "pwm-leds";
+
+        led-1 {
+            label = "omap4::keypad";
+            pwms = <&twl_pwm 0 7812500>;
+            max-brightness = <127>;
+        };
+
+        led-2 {
+            color = <LED_COLOR_ID_GREEN>;
+            function = LED_FUNCTION_CHARGING;
+            pwms = <&twl_pwmled 0 7812500>;
+            max-brightness = <255>;
+        };
+    };
+
+...
-- 
2.20.1


  parent reply	other threads:[~2020-10-05 20:36 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-05 20:34 [PATCH v7 00/12] leds: pwm: Make automatic labels work Alexander Dahl
2020-10-05 20:34 ` [PATCH v7 01/12] leds: pwm: Remove platform_data support Alexander Dahl
2020-10-07 10:03   ` Pavel Machek
2020-10-05 20:34 ` Alexander Dahl [this message]
2020-10-07 10:02   ` [PATCH v7 02/12] dt-bindings: leds: Convert pwm to yaml Pavel Machek
2020-10-07 10:03     ` Krzysztof Kozlowski
2020-10-28 20:39   ` Alexander Dahl
2020-10-29 13:46     ` Russell King - ARM Linux admin
2020-11-25 11:08   ` Pavel Machek
2020-10-05 20:34 ` [PATCH v7 03/12] dt-bindings: mfd: Fix schema warnings for pwm-leds Alexander Dahl
2020-10-06  2:17   ` Jeff LaBundy
2020-10-06  6:34     ` Alexander Dahl
2020-10-06 22:27       ` Rob Herring
2020-10-06 22:28   ` Rob Herring
2020-10-07 10:03   ` Pavel Machek
2020-10-07 10:08     ` Alexander Dahl
2020-10-08  7:33     ` Lee Jones
2020-10-08  7:50       ` Pavel Machek
2020-10-05 20:34 ` [PATCH v7 04/12] ARM: dts: at91: smartkiz: Reference led node directly Alexander Dahl
2020-10-05 20:34 ` [PATCH v7 05/12] ARM: dts: at91: Fix schema warnings for pwm-leds Alexander Dahl
2020-10-05 20:34 ` [PATCH v7 06/12] ARM: dts: berlin: " Alexander Dahl
2020-10-05 20:34 ` [PATCH v7 07/12] ARM: dts: exynos: " Alexander Dahl
2020-10-07  6:25   ` Krzysztof Kozlowski
2020-10-26 18:45   ` Krzysztof Kozlowski
2020-10-05 20:34 ` [PATCH v7 08/12] ARM: dts: imx: " Alexander Dahl
2020-10-30  7:46   ` Shawn Guo
2020-10-05 20:34 ` [PATCH v7 09/12] ARM: dts: omap: " Alexander Dahl
2020-11-10 13:25   ` Tony Lindgren
2020-10-05 20:34 ` [PATCH v7 10/12] ARM: dts: stm32: " Alexander Dahl
2020-10-27  7:03   ` [Linux-stm32] " Ahmad Fatoum
2020-10-27 10:05     ` Alexander Dahl
2020-10-27 10:58       ` Ahmad Fatoum
2020-10-28  7:34         ` Alexander Dahl
2020-11-02 10:47           ` Ahmad Fatoum
2020-10-31 13:54         ` Alexander Dahl
2020-11-02 11:10           ` Ahmad Fatoum
2020-11-09 11:02           ` Alexandre Torgue
2020-11-09 22:21             ` Alexander Dahl
2020-10-05 20:34 ` [PATCH v7 11/12] arm64: dts: meson: " Alexander Dahl
2020-10-05 20:34 ` [PATCH v7 12/12] MIPS: DTS: img: " Alexander Dahl
2020-10-28 18:56 ` [PATCH v7 00/12] leds: pwm: Make automatic labels work Alexandre Belloni
2020-10-28 19:21   ` Alexandre Belloni

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201005203451.9985-3-post@lespocky.de \
    --to=post@lespocky.de \
    --cc=ada@thorsis.com \
    --cc=devicetree@vger.kernel.org \
    --cc=dmurphy@ti.com \
    --cc=jacek.anaszewski@gmail.com \
    --cc=krzk@kernel.org \
    --cc=linux-amlogic@lists.infradead.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-leds@vger.kernel.org \
    --cc=linux-mips@vger.kernel.org \
    --cc=linux-omap@vger.kernel.org \
    --cc=linux-samsung-soc@vger.kernel.org \
    --cc=linux-stm32@st-md-mailman.stormreply.com \
    --cc=linux@armlinux.org.uk \
    --cc=pavel@ucw.cz \
    --cc=peter.ujfalusi@ti.com \
    --cc=robh+dt@kernel.org \
    --cc=robh@kernel.org \
    --subject='Re: [PATCH v7 02/12] dt-bindings: leds: Convert pwm to yaml' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
on how to clone and mirror all data and code used for this inbox