diff mbox series

[v2,2/5] dt-bindings: counter: new bindings for TI eQEP

Message ID 20190807194023.15318-3-david@lechnology.com (mailing list archive)
State New, archived
Headers show
Series counter: new TI eQEP driver | expand

Commit Message

David Lechner Aug. 7, 2019, 7:40 p.m. UTC
This documents device tree binding for the Texas Instruments Enhanced
Quadrature Encoder Pulse (eQEP) Module found in various TI SoCs.

Signed-off-by: David Lechner <david@lechnology.com>
---

v2 changes:
- convert to .yaml format
- rename clock to "sysclkout"

 .../devicetree/bindings/counter/ti-eqep.yaml  | 50 +++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/counter/ti-eqep.yaml

Comments

Rob Herring (Arm) Aug. 21, 2019, 8:31 p.m. UTC | #1
On Wed, Aug 07, 2019 at 02:40:20PM -0500, David Lechner wrote:
> This documents device tree binding for the Texas Instruments Enhanced
> Quadrature Encoder Pulse (eQEP) Module found in various TI SoCs.
> 
> Signed-off-by: David Lechner <david@lechnology.com>
> ---
> 
> v2 changes:
> - convert to .yaml format
> - rename clock to "sysclkout"
> 
>  .../devicetree/bindings/counter/ti-eqep.yaml  | 50 +++++++++++++++++++
>  1 file changed, 50 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/counter/ti-eqep.yaml
> 
> diff --git a/Documentation/devicetree/bindings/counter/ti-eqep.yaml b/Documentation/devicetree/bindings/counter/ti-eqep.yaml
> new file mode 100644
> index 000000000000..8f8b2e87e5c3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/counter/ti-eqep.yaml
> @@ -0,0 +1,50 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/counter/ti-eqep.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments Enhanced Quadrature Encoder Pulse (eQEP) Module
> +
> +maintainers:
> +  - David Lechner <david@lechnology.com>
> +
> +properties:
> +  compatible:
> +    const: "ti,am3352-eqep"

No need for quotes

> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    description: The eQEP event interrupt

Don't really have to have a description when there is only 1 entry.

> +    maxItems: 1
> +
> +  clocks:
> +    description: The clock that determines the SYSCLKOUT rate for the eQEP
> +                 peripheral.

Same here. 2 spaces in from description is the normal indentation.

> +    maxItems: 1
> +
> +  clock-names:
> +    const: sysclkout
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    eqep0: eqep@180 {

counter@...

> +        compatible = "ti,am3352-eqep";
> +        reg = <0x180 0x80>;
> +        clocks = <&l4ls_gclk>;
> +        clock-names = "sysclkout";
> +        interrupts = <79>;
> +    };
> +
> +...
> -- 
> 2.17.1
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/counter/ti-eqep.yaml b/Documentation/devicetree/bindings/counter/ti-eqep.yaml
new file mode 100644
index 000000000000..8f8b2e87e5c3
--- /dev/null
+++ b/Documentation/devicetree/bindings/counter/ti-eqep.yaml
@@ -0,0 +1,50 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/counter/ti-eqep.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments Enhanced Quadrature Encoder Pulse (eQEP) Module
+
+maintainers:
+  - David Lechner <david@lechnology.com>
+
+properties:
+  compatible:
+    const: "ti,am3352-eqep"
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    description: The eQEP event interrupt
+    maxItems: 1
+
+  clocks:
+    description: The clock that determines the SYSCLKOUT rate for the eQEP
+                 peripheral.
+    maxItems: 1
+
+  clock-names:
+    const: sysclkout
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - clock-names
+
+additionalProperties: false
+
+examples:
+  - |
+    eqep0: eqep@180 {
+        compatible = "ti,am3352-eqep";
+        reg = <0x180 0x80>;
+        clocks = <&l4ls_gclk>;
+        clock-names = "sysclkout";
+        interrupts = <79>;
+    };
+
+...