Skip to contentSkip to conversation

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

PATCH Superseded Fabio Estevam 3 participants 3 messages Aug 9, 2023 – Aug 18, 2023

Subsystems (2)
Device tree bindings PPS support

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Fabio Estevam

author
#0 lore raw

PATCH 1/1 dt-bindings: pps: pps-gpio: Convert to yaml

From: Fabio Estevam <[email protected]>

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

Signed-off-by Fabio Estevam <[email protected]>
---
 .../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
Documentation/devicetree/bindings/pps/pps-gpio.txt deleted +0 -30
deleted file mode 100644
index 9012a2a02e14..000000000000
@@ -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";
-	};
Documentation/devicetree/bindings/pps/pps-gpio.yaml new file +46 -0

46 lines not on this page · raw message

Signature · 1 line
2.34.1
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 5 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>

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

Signed-off-by Fabio Estevam <[email protected]>
Acked-by Rodolfo Giometti <[email protected]>
Quoted 95 lines
---
  .../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

Documentation/devicetree/bindings/pps/pps-gpio.txt deleted +0 -30
deleted file mode 100644
index 9012a2a02e14..000000000000
@@ -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";
-	};
Documentation/devicetree/bindings/pps/pps-gpio.yaml new file +46 -0
new file mode 100644
index 000000000000..801fd2720080
@@ -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 <[email protected]>
+
+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>;
+      };
Signature · 4 lines
GNU/Linux Solutions                  e-mail: [email protected]
Linux Device Driver                          [email protected]
Embedded Systems                     phone:  +39 349 2432127
UNIX programming                     skype:  rodolfo.giometti
maintainer
#2 lore raw
In reply to Fabio Estevam
Quoted 61 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>

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

Signed-off-by Fabio Estevam <[email protected]>
---
 .../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
Documentation/devicetree/bindings/pps/pps-gpio.txt deleted +0 -30
deleted file mode 100644
index 9012a2a02e14..000000000000
@@ -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";
-	};
Documentation/devicetree/bindings/pps/pps-gpio.yaml new file +7 -0
new file mode 100644
index 000000000000..801fd2720080
@@ -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

Documentation/devicetree/bindings/pps/pps-gpio.yaml line 17

Quoted 10 lines
Documentation/devicetree/bindings/pps/pps-gpio.yaml new file +10 -0
+
+maintainers:
+  - Fabio Estevam <[email protected]>
+
+properties:
+  compatible:
+    const: pps-gpio
+
+  gpios:
+    description: The GPIO that provides the PPS signal.

maxItems: 1

Documentation/devicetree/bindings/pps/pps-gpio.yaml line 20

Quoted 3 lines
Documentation/devicetree/bindings/pps/pps-gpio.yaml new file +3 -0
+
+  echo-gpios:
+    description: The GPIO that provides the PPS ECHO signal.

maxItems: 1

Documentation/devicetree/bindings/pps/pps-gpio.yaml line 26

Quoted 6 lines
Documentation/devicetree/bindings/pps/pps-gpio.yaml new file +6 -0
+
+  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

Quoted 23 lines
Documentation/devicetree/bindings/pps/pps-gpio.yaml new file +20 -0
+
+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>;
+      };
Signature · 1 line
2.34.1