xref: /freebsd/sys/contrib/device-tree/Bindings/pps/pps-gpio.yaml (revision aa1a8ff2)

# 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>;
      };