From: Ben Dooks <ben.dooks@sifive.com>
To: linux-pwm@vger.kernel.org
Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
Lee Jones <lee.jones@linaro.org>,
u.kleine-koenig@pengutronix.de,
Thierry Reding <thierry.reding@gmail.com>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
Greentime Hu <greentime.hu@sifive.com>,
jarkko.nikula@linux.intel.com,
William Salmon <william.salmon@sifive.com>,
Jude Onyenegecha <jude.onyenegecha@sifive.com>,
Ben Dooks <ben.dooks@sifive.com>,
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Subject: [PATCH v7 01/10] dt-bindings: pwm: Document Synopsys DesignWare snps,pwm-dw-apb-timers-pwm2
Date: Fri, 23 Dec 2022 15:38:11 +0000 [thread overview]
Message-ID: <20221223153820.404565-2-ben.dooks@sifive.com> (raw)
In-Reply-To: <20221223153820.404565-1-ben.dooks@sifive.com>
Add documentation for the bindings for Synopsys' DesignWare PWM block
as we will be adding DT/platform support to the Linux driver soon.
Signed-off-by: Ben Dooks <ben.dooks@sifive.com>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Acked-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
---
v5:
- fixed order of properties
- corrected clock to two items
v4:
- fixed typos, added reg
v3:
- add description and example
- merge the snps,pwm-number into this patch
- rename snps,pwm to snps,dw-apb-timers-pwm2
v2:
- fix #pwm-cells to be 3
- fix indentation and ordering issues
---
.../bindings/pwm/snps,dw-apb-timers-pwm2.yaml | 68 +++++++++++++++++++
1 file changed, 68 insertions(+)
create mode 100644 Documentation/devicetree/bindings/pwm/snps,dw-apb-timers-pwm2.yaml
diff --git a/Documentation/devicetree/bindings/pwm/snps,dw-apb-timers-pwm2.yaml b/Documentation/devicetree/bindings/pwm/snps,dw-apb-timers-pwm2.yaml
new file mode 100644
index 000000000000..9aabdb373afa
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/snps,dw-apb-timers-pwm2.yaml
@@ -0,0 +1,68 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2022 SiFive, Inc.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pwm/snps,dw-apb-timers-pwm2.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Synopsys DW-APB timers PWM controller
+
+maintainers:
+ - Ben Dooks <ben.dooks@sifive.com>
+
+description:
+ This describes the DesignWare APB timers module when used in the PWM
+ mode. The IP core can be generated with various options which can
+ control the functionality, the number of PWMs available and other
+ internal controls the designer requires.
+
+ The IP block has a version register so this can be used for detection
+ instead of having to encode the IP version number in the device tree
+ comaptible.
+
+allOf:
+ - $ref: pwm.yaml#
+
+properties:
+ compatible:
+ const: snps,dw-apb-timers-pwm2
+
+ reg:
+ maxItems: 1
+
+ "#pwm-cells":
+ const: 3
+
+ clocks:
+ items:
+ - description: Interface bus clock
+ - description: PWM reference clock
+
+ clock-names:
+ items:
+ - const: bus
+ - const: timer
+
+ snps,pwm-number:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: The number of PWM channels configured for this instance
+ enum: [1, 2, 3, 4, 5, 6, 7, 8]
+
+required:
+ - compatible
+ - reg
+ - "#pwm-cells"
+ - clocks
+ - clock-names
+
+additionalProperties: false
+
+examples:
+ - |
+ pwm: pwm@180000 {
+ compatible = "snps,dw-apb-timers-pwm2";
+ reg = <0x180000 0x200>;
+ #pwm-cells = <3>;
+ clocks = <&bus>, <&timer>;
+ clock-names = "bus", "timer";
+ };
--
2.35.1
next prev parent reply other threads:[~2022-12-23 15:38 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-23 15:38 [PATCH v7 00/10] Designware PWM driver updates for OF Ben Dooks
2022-12-23 15:38 ` Ben Dooks [this message]
2022-12-23 15:38 ` [PATCH v7 02/10] pwm: dwc: allow driver to be built with COMPILE_TEST Ben Dooks
2022-12-23 15:38 ` [PATCH v7 03/10] pwm: dwc: change &pci->dev to dev in probe Ben Dooks
2022-12-23 15:38 ` [PATCH v7 04/10] pwm: dwc: move memory alloc to own function Ben Dooks
2023-02-16 21:19 ` Uwe Kleine-König
2022-12-23 15:38 ` [PATCH v7 05/10] pwm: dwc: use devm_pwmchip_add Ben Dooks
2022-12-23 15:38 ` [PATCH v7 06/10] pwm: dwc: split pci out of core driver Ben Dooks
2023-02-16 21:30 ` Uwe Kleine-König
2023-06-13 19:22 ` Ben Dooks
2023-06-14 7:02 ` Uwe Kleine-König
2022-12-23 15:38 ` [PATCH v7 07/10] pwm: dwc: make timer clock configurable Ben Dooks
2023-02-16 21:33 ` Uwe Kleine-König
2022-12-23 15:38 ` [PATCH v7 08/10] pwm: dwc: add of/platform support Ben Dooks
2022-12-23 15:38 ` [PATCH v7 09/10] pwm: dwc: add PWM bit unset in get_state call Ben Dooks
2022-12-23 15:38 ` [PATCH v7 10/10] pwm: dwc: use clock rate in hz to avoid rounding issues Ben Dooks
2023-02-16 21:39 ` Uwe Kleine-König
2023-06-14 11:17 ` Ben Dooks
2023-01-17 16:39 ` [PATCH v7 00/10] Designware PWM driver updates for OF Ben Dooks
2023-01-17 17:07 ` Uwe Kleine-König
2023-02-17 15:08 ` (subset) " Thierry Reding
2023-03-10 18:21 ` Uwe Kleine-König
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=20221223153820.404565-2-ben.dooks@sifive.com \
--to=ben.dooks@sifive.com \
--cc=devicetree@vger.kernel.org \
--cc=greentime.hu@sifive.com \
--cc=jarkko.nikula@linux.intel.com \
--cc=jude.onyenegecha@sifive.com \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=krzysztof.kozlowski@linaro.org \
--cc=lee.jones@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pwm@vger.kernel.org \
--cc=thierry.reding@gmail.com \
--cc=u.kleine-koenig@pengutronix.de \
--cc=william.salmon@sifive.com \
/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;
as well as URLs for NNTP newsgroup(s).