diff mbox series

dt-bindings: pps: pps-gpio: Convert to yaml

Message ID 20230809110812.2058428-1-festevam@gmail.com
State Changes Requested, archived
Headers show
Series dt-bindings: pps: pps-gpio: Convert to yaml | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 2 warnings, 46 lines checked
robh/patch-applied success
robh/dtbs-check warning build log
robh/dt-meta-schema success

Commit Message

Fabio Estevam Aug. 9, 2023, 11:08 a.m. UTC
From: Fabio Estevam <festevam@denx.de>

Convert from pps-gpio.txt to pps-gpio.yaml to allow schema validation.

Signed-off-by: Fabio Estevam <festevam@denx.de>
---
 .../devicetree/bindings/pps/pps-gpio.txt      | 30 ------------
 .../devicetree/bindings/pps/pps-gpio.yaml     | 46 +++++++++++++++++++
 2 files changed, 46 insertions(+), 30 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/pps/pps-gpio.txt
 create mode 100644 Documentation/devicetree/bindings/pps/pps-gpio.yaml

Comments

Rodolfo Giometti Aug. 9, 2023, 12:32 p.m. UTC | #1
On 09/08/23 13:08, Fabio Estevam wrote:
> From: Fabio Estevam <festevam@denx.de>
> 
> Convert from pps-gpio.txt to pps-gpio.yaml to allow schema validation.
> 
> Signed-off-by: Fabio Estevam <festevam@denx.de>

Acked-by: Rodolfo Giometti <giometti@enneenne.com>

> ---
>   .../devicetree/bindings/pps/pps-gpio.txt      | 30 ------------
>   .../devicetree/bindings/pps/pps-gpio.yaml     | 46 +++++++++++++++++++
>   2 files changed, 46 insertions(+), 30 deletions(-)
>   delete mode 100644 Documentation/devicetree/bindings/pps/pps-gpio.txt
>   create mode 100644 Documentation/devicetree/bindings/pps/pps-gpio.yaml
> 
> diff --git a/Documentation/devicetree/bindings/pps/pps-gpio.txt b/Documentation/devicetree/bindings/pps/pps-gpio.txt
> deleted file mode 100644
> index 9012a2a02e14..000000000000
> --- a/Documentation/devicetree/bindings/pps/pps-gpio.txt
> +++ /dev/null
> @@ -1,30 +0,0 @@
> -Device-Tree Bindings for a PPS Signal on GPIO
> -
> -These properties describe a PPS (pulse-per-second) signal connected to
> -a GPIO pin.
> -
> -Required properties:
> -- compatible: should be "pps-gpio"
> -- gpios: one PPS GPIO in the format described by ../gpio/gpio.txt
> -
> -Additional required properties for the PPS ECHO functionality:
> -- echo-gpios: one PPS ECHO GPIO in the format described by ../gpio/gpio.txt
> -- echo-active-ms: duration in ms of the active portion of the echo pulse
> -
> -Optional properties:
> -- assert-falling-edge: when present, assert is indicated by a falling edge
> -                       (instead of by a rising edge)
> -
> -Example:
> -	pps {
> -		pinctrl-names = "default";
> -		pinctrl-0 = <&pinctrl_pps>;
> -
> -		gpios = <&gpio1 26 GPIO_ACTIVE_HIGH>;
> -		assert-falling-edge;
> -
> -		echo-gpios = <&gpio1 27 GPIO_ACTIVE_HIGH>;
> -		echo-active-ms = <100>;
> -
> -		compatible = "pps-gpio";
> -	};
> diff --git a/Documentation/devicetree/bindings/pps/pps-gpio.yaml b/Documentation/devicetree/bindings/pps/pps-gpio.yaml
> new file mode 100644
> index 000000000000..801fd2720080
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pps/pps-gpio.yaml
> @@ -0,0 +1,46 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pps/pps-gpio.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: PPS Signal via GPIO
> +
> +maintainers:
> +  - Fabio Estevam <festevam@gmail.com>
> +
> +properties:
> +  compatible:
> +    const: pps-gpio
> +
> +  gpios:
> +    description: The GPIO that provides the PPS signal.
> +
> +  echo-gpios:
> +    description: The GPIO that provides the PPS ECHO signal.
> +
> +  echo-active-ms:
> +    description: Duration in ms of the active portion of the echo pulse.
> +
> +  assert-falling-edge:
> +    description: Indicates a falling edge assert, when present. Rising edge if absent.
> +
> +required:
> +  - compatible
> +  - gpios
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +      #include <dt-bindings/gpio/gpio.h>
> +
> +      pps {
> +          compatible = "pps-gpio";
> +          pinctrl-names = "default";
> +          pinctrl-0 = <&pinctrl_pps>;
> +          gpios = <&gpio1 26 GPIO_ACTIVE_HIGH>;
> +          assert-falling-edge;
> +          echo-gpios = <&gpio1 27 GPIO_ACTIVE_HIGH>;
> +          echo-active-ms = <100>;
> +      };
Rob Herring (Arm) Aug. 18, 2023, 4:24 p.m. UTC | #2
On Wed, Aug 09, 2023 at 08:08:12AM -0300, Fabio Estevam wrote:
> From: Fabio Estevam <festevam@denx.de>
> 
> Convert from pps-gpio.txt to pps-gpio.yaml to allow schema validation.
> 
> Signed-off-by: Fabio Estevam <festevam@denx.de>
> ---
>  .../devicetree/bindings/pps/pps-gpio.txt      | 30 ------------
>  .../devicetree/bindings/pps/pps-gpio.yaml     | 46 +++++++++++++++++++
>  2 files changed, 46 insertions(+), 30 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/pps/pps-gpio.txt
>  create mode 100644 Documentation/devicetree/bindings/pps/pps-gpio.yaml
> 
> diff --git a/Documentation/devicetree/bindings/pps/pps-gpio.txt b/Documentation/devicetree/bindings/pps/pps-gpio.txt
> deleted file mode 100644
> index 9012a2a02e14..000000000000
> --- a/Documentation/devicetree/bindings/pps/pps-gpio.txt
> +++ /dev/null
> @@ -1,30 +0,0 @@
> -Device-Tree Bindings for a PPS Signal on GPIO
> -
> -These properties describe a PPS (pulse-per-second) signal connected to
> -a GPIO pin.
> -
> -Required properties:
> -- compatible: should be "pps-gpio"
> -- gpios: one PPS GPIO in the format described by ../gpio/gpio.txt
> -
> -Additional required properties for the PPS ECHO functionality:
> -- echo-gpios: one PPS ECHO GPIO in the format described by ../gpio/gpio.txt
> -- echo-active-ms: duration in ms of the active portion of the echo pulse
> -
> -Optional properties:
> -- assert-falling-edge: when present, assert is indicated by a falling edge
> -                       (instead of by a rising edge)
> -
> -Example:
> -	pps {
> -		pinctrl-names = "default";
> -		pinctrl-0 = <&pinctrl_pps>;
> -
> -		gpios = <&gpio1 26 GPIO_ACTIVE_HIGH>;
> -		assert-falling-edge;
> -
> -		echo-gpios = <&gpio1 27 GPIO_ACTIVE_HIGH>;
> -		echo-active-ms = <100>;
> -
> -		compatible = "pps-gpio";
> -	};
> diff --git a/Documentation/devicetree/bindings/pps/pps-gpio.yaml b/Documentation/devicetree/bindings/pps/pps-gpio.yaml
> new file mode 100644
> index 000000000000..801fd2720080
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pps/pps-gpio.yaml
> @@ -0,0 +1,46 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pps/pps-gpio.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: PPS Signal via GPIO
> +
> +maintainers:
> +  - Fabio Estevam <festevam@gmail.com>
> +
> +properties:
> +  compatible:
> +    const: pps-gpio
> +
> +  gpios:
> +    description: The GPIO that provides the PPS signal.

maxItems: 1

> +
> +  echo-gpios:
> +    description: The GPIO that provides the PPS ECHO signal.

maxItems: 1

> +
> +  echo-active-ms:
> +    description: Duration in ms of the active portion of the echo pulse.
> +
> +  assert-falling-edge:
> +    description: Indicates a falling edge assert, when present. Rising edge if absent.

type: boolean

> +
> +required:
> +  - compatible
> +  - gpios
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +      #include <dt-bindings/gpio/gpio.h>
> +
> +      pps {
> +          compatible = "pps-gpio";
> +          pinctrl-names = "default";
> +          pinctrl-0 = <&pinctrl_pps>;
> +          gpios = <&gpio1 26 GPIO_ACTIVE_HIGH>;
> +          assert-falling-edge;
> +          echo-gpios = <&gpio1 27 GPIO_ACTIVE_HIGH>;
> +          echo-active-ms = <100>;
> +      };
> -- 
> 2.34.1
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/pps/pps-gpio.txt b/Documentation/devicetree/bindings/pps/pps-gpio.txt
deleted file mode 100644
index 9012a2a02e14..000000000000
--- a/Documentation/devicetree/bindings/pps/pps-gpio.txt
+++ /dev/null
@@ -1,30 +0,0 @@ 
-Device-Tree Bindings for a PPS Signal on GPIO
-
-These properties describe a PPS (pulse-per-second) signal connected to
-a GPIO pin.
-
-Required properties:
-- compatible: should be "pps-gpio"
-- gpios: one PPS GPIO in the format described by ../gpio/gpio.txt
-
-Additional required properties for the PPS ECHO functionality:
-- echo-gpios: one PPS ECHO GPIO in the format described by ../gpio/gpio.txt
-- echo-active-ms: duration in ms of the active portion of the echo pulse
-
-Optional properties:
-- assert-falling-edge: when present, assert is indicated by a falling edge
-                       (instead of by a rising edge)
-
-Example:
-	pps {
-		pinctrl-names = "default";
-		pinctrl-0 = <&pinctrl_pps>;
-
-		gpios = <&gpio1 26 GPIO_ACTIVE_HIGH>;
-		assert-falling-edge;
-
-		echo-gpios = <&gpio1 27 GPIO_ACTIVE_HIGH>;
-		echo-active-ms = <100>;
-
-		compatible = "pps-gpio";
-	};
diff --git a/Documentation/devicetree/bindings/pps/pps-gpio.yaml b/Documentation/devicetree/bindings/pps/pps-gpio.yaml
new file mode 100644
index 000000000000..801fd2720080
--- /dev/null
+++ b/Documentation/devicetree/bindings/pps/pps-gpio.yaml
@@ -0,0 +1,46 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pps/pps-gpio.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: PPS Signal via GPIO
+
+maintainers:
+  - Fabio Estevam <festevam@gmail.com>
+
+properties:
+  compatible:
+    const: pps-gpio
+
+  gpios:
+    description: The GPIO that provides the PPS signal.
+
+  echo-gpios:
+    description: The GPIO that provides the PPS ECHO signal.
+
+  echo-active-ms:
+    description: Duration in ms of the active portion of the echo pulse.
+
+  assert-falling-edge:
+    description: Indicates a falling edge assert, when present. Rising edge if absent.
+
+required:
+  - compatible
+  - gpios
+
+additionalProperties: false
+
+examples:
+  - |
+      #include <dt-bindings/gpio/gpio.h>
+
+      pps {
+          compatible = "pps-gpio";
+          pinctrl-names = "default";
+          pinctrl-0 = <&pinctrl_pps>;
+          gpios = <&gpio1 26 GPIO_ACTIVE_HIGH>;
+          assert-falling-edge;
+          echo-gpios = <&gpio1 27 GPIO_ACTIVE_HIGH>;
+          echo-active-ms = <100>;
+      };