dt-bindings: pwm: Add bindings doc for ZTE ZX PWM controller
authorShawn Guo <shawn.guo@linaro.org>
Thu, 27 Jul 2017 08:23:36 +0000 (16:23 +0800)
committerThierry Reding <thierry.reding@gmail.com>
Mon, 21 Aug 2017 05:34:18 +0000 (07:34 +0200)
It adds bindings document for ZTE ZX PWM controller. The device has two
clocks: PCLK and WCLK. The PCLK is for register access, and WCLK is the
reference clock for calculating period and duty cycles. Also, the device
supports polarity configuration, so #pwm-cells should be 3.

Signed-off-by: Shawn Guo <shawn.guo@linaro.org>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Thierry Reding <thierry.reding@gmail.com>
Documentation/devicetree/bindings/pwm/pwm-zx.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/pwm/pwm-zx.txt b/Documentation/devicetree/bindings/pwm/pwm-zx.txt
new file mode 100644 (file)
index 0000000..a6bcc75
--- /dev/null
@@ -0,0 +1,22 @@
+ZTE ZX PWM controller
+
+Required properties:
+ - compatible: Should be "zte,zx296718-pwm".
+ - reg: Physical base address and length of the controller's registers.
+ - clocks : The phandle and specifier referencing the controller's clocks.
+ - clock-names: "pclk" for PCLK, "wclk" for WCLK to the PWM controller.  The
+   PCLK is for register access, while WCLK is the reference clock for
+   calculating period and duty cycles.
+ - #pwm-cells: Should be 3. See pwm.txt in this directory for a description of
+   the cells format.
+
+Example:
+
+       pwm: pwm@1439000 {
+               compatible = "zte,zx296718-pwm";
+               reg = <0x1439000 0x1000>;
+               clocks = <&lsp1crm LSP1_PWM_PCLK>,
+                        <&lsp1crm LSP1_PWM_WCLK>;
+               clock-names = "pclk", "wclk";
+               #pwm-cells = <3>;
+       };