public inbox for devicetree@vger.kernel.org
 help / color / mirror / Atom feed
From: Manuel Traut <manuel.traut@mt.com>
To: linux-kernel@vger.kernel.org
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Frieder Schrempf <frieder.schrempf@kontron.de>,
	linux-input@vger.kernel.org, devicetree@vger.kernel.org
Subject: [PATCH 1/5 v7] dt-bindings: input: pwm-beeper: Convert txt bindings to yaml
Date: Tue, 24 Jan 2023 17:39:47 +0100	[thread overview]
Message-ID: <Y9AJ07zT1lpBLhPk@mt.com> (raw)

Converts txt binding to new YAML format.

Signed-off-by: Manuel Traut <manuel.traut@mt.com>
---
 .../devicetree/bindings/input/pwm-beeper.txt  | 24 ----------
 .../devicetree/bindings/input/pwm-beeper.yaml | 48 +++++++++++++++++++
 2 files changed, 48 insertions(+), 24 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/input/pwm-beeper.txt
 create mode 100644 Documentation/devicetree/bindings/input/pwm-beeper.yaml

diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.txt b/Documentation/devicetree/bindings/input/pwm-beeper.txt
deleted file mode 100644
index 8fc0e48c20db..000000000000
--- a/Documentation/devicetree/bindings/input/pwm-beeper.txt
+++ /dev/null
@@ -1,24 +0,0 @@
-* PWM beeper device tree bindings
-
-Registers a PWM device as beeper.
-
-Required properties:
-- compatible: should be "pwm-beeper"
-- pwms: phandle to the physical PWM device
-
-Optional properties:
-- amp-supply: phandle to a regulator that acts as an amplifier for the beeper
-- beeper-hz:  bell frequency in Hz
-
-Example:
-
-beeper_amp: amplifier {
-	compatible = "fixed-regulator";
-	gpios = <&gpio0 1 GPIO_ACTIVE_HIGH>;
-};
-
-beeper {
-	compatible = "pwm-beeper";
-	pwms = <&pwm0>;
-	amp-supply = <&beeper_amp>;
-};
diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.yaml b/Documentation/devicetree/bindings/input/pwm-beeper.yaml
new file mode 100644
index 000000000000..24a40f0f77c1
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/pwm-beeper.yaml
@@ -0,0 +1,48 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/input/pwm-beeper.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: PWM beeper device tree bindings
+
+maintainers:
+	- Dmitry Torokhov <dmitry.torokhov@gmail.com>
+
+description: Registers a PWM device as beeper.
+
+properties:
+	compatible:
+	const: pwm-beeper
+
+	pwms:
+		description: phandle to the physical PWM device
+		minItems: 1
+		maxItems: 1
+
+	amp-supply:
+		description: >
+			phandle to a regulator that acts as an amplifier for
+			the beeper
+
+	beeper-hz:
+		description: bell frequency in Hz
+
+required:
+	- compatible
+	- pwms
+
+additionalProperties: false
+
+examples:
+	- |
+		beeper_amp: amplifier {
+			compatible = "fixed-regulator";
+			gpios = <&gpio0 1 GPIO_ACTIVE_HIGH>;
+		};
+
+		beeper {
+			compatible = "pwm-beeper";
+			pwms = <&pwm0>;
+			amp-supply = <&beeper_amp>;
+		};
-- 
2.39.0

             reply	other threads:[~2023-01-24 16:40 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-24 16:39 Manuel Traut [this message]
2023-01-24 16:58 ` [PATCH 1/5 v7] dt-bindings: input: pwm-beeper: Convert txt bindings to yaml Krzysztof Kozlowski
2023-01-24 19:06 ` Rob Herring

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=Y9AJ07zT1lpBLhPk@mt.com \
    --to=manuel.traut@mt.com \
    --cc=devicetree@vger.kernel.org \
    --cc=dmitry.torokhov@gmail.com \
    --cc=frieder.schrempf@kontron.de \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robh+dt@kernel.org \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox