diff mbox series

[v3,1/2] dt-bindings: counter: add gpio-pulse-counter binding

Message ID 20210122112434.27886-2-o.rempel@pengutronix.de (mailing list archive)
State Superseded, archived
Headers show
Series add support for GPIO based counter | expand

Commit Message

Oleksij Rempel Jan. 22, 2021, 11:24 a.m. UTC
Add binding for GPIO based pulse counter node

Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
 .../bindings/counter/gpio-pulse-counter.yaml  | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/counter/gpio-pulse-counter.yaml

Comments

Jonathan Cameron Jan. 24, 2021, 2:34 p.m. UTC | #1
On Fri, 22 Jan 2021 12:24:33 +0100
Oleksij Rempel <o.rempel@pengutronix.de> wrote:

> Add binding for GPIO based pulse counter node
> 
This does make me wonder a bit on whether we are going to soon need
a  provider / consumer interface for the counter subsystem.

Afterall, this pulse is coming from something and I doubt it will
be long before we want to describe that 'something' plus it may
have additional controls etc.

Anyhow, that's a question for another day.  A few minor things inline.

Jonathan


> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> ---
>  .../bindings/counter/gpio-pulse-counter.yaml  | 39 +++++++++++++++++++
>  1 file changed, 39 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/counter/gpio-pulse-counter.yaml
> 
> diff --git a/Documentation/devicetree/bindings/counter/gpio-pulse-counter.yaml b/Documentation/devicetree/bindings/counter/gpio-pulse-counter.yaml
> new file mode 100644
> index 000000000000..dfa93956f15c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/counter/gpio-pulse-counter.yaml
> @@ -0,0 +1,39 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/counter/gpio-pulse-counter.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: GPIO base pulse counter

Whilst it's moderately obvious I think a short description here
would be useful. 


> +
> +maintainers:
> +  - Oleksij Rempel <o.rempel@pengutronix.de>
> +
> +properties:
> +  compatible:
> +    const: virtual,gpio-pulse-counter
> +
> +  gpios:
> +    maxItems: 1
> +
> +required:
> +  - gpios
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +
> +    #include <dt-bindings/gpio/gpio.h>
> +
> +    counter-0 {
> +        compatible = "virtual,gpio-pulse-counter";
> +        gpios = <&gpio 0 GPIO_ACTIVE_HIGH>;
> +    };
> +
> +    counter-1 {
> +        compatible = "virtual,gpio-pulse-counter";
> +        gpios = <&gpio 1 GPIO_ACTIVE_HIGH>;
> +    };

The second example doesn't tell us anything new, so I'd drop
it and just have counter-0



> +
> +...
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/counter/gpio-pulse-counter.yaml b/Documentation/devicetree/bindings/counter/gpio-pulse-counter.yaml
new file mode 100644
index 000000000000..dfa93956f15c
--- /dev/null
+++ b/Documentation/devicetree/bindings/counter/gpio-pulse-counter.yaml
@@ -0,0 +1,39 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/counter/gpio-pulse-counter.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: GPIO base pulse counter
+
+maintainers:
+  - Oleksij Rempel <o.rempel@pengutronix.de>
+
+properties:
+  compatible:
+    const: virtual,gpio-pulse-counter
+
+  gpios:
+    maxItems: 1
+
+required:
+  - gpios
+
+additionalProperties: false
+
+examples:
+  - |
+
+    #include <dt-bindings/gpio/gpio.h>
+
+    counter-0 {
+        compatible = "virtual,gpio-pulse-counter";
+        gpios = <&gpio 0 GPIO_ACTIVE_HIGH>;
+    };
+
+    counter-1 {
+        compatible = "virtual,gpio-pulse-counter";
+        gpios = <&gpio 1 GPIO_ACTIVE_HIGH>;
+    };
+
+...