Documentation/devicetree/bindings/timer/fsl,ftm-timer.yaml

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/timer/fsl,ftm-timer.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Freescale FlexTimer Module (FTM) Timer

maintainers:
  - Animesh Agarwal <animeshagarwal28@gmail.com>

properties:
  compatible:
    const: fsl,ftm-timer

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    description: The clocks provided by the SoC to drive the timer, must
      contain an entry for each entry in clock-names.
    minItems: 4
    maxItems: 4

  clock-names:
    items:
      - const: ftm-evt
      - const: ftm-src
      - const: ftm-evt-counter-en
      - const: ftm-src-counter-en

  big-endian: true

required:
  - compatible
  - reg
  - interrupts
  - clocks
  - clock-names

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/vf610-clock.h>
    #include <dt-bindings/interrupt-controller/irq.h>

    ftm@400b8000 {
        compatible = "fsl,ftm-timer";
        reg = <0x400b8000 0x1000>;
        interrupts = <0 44 IRQ_TYPE_LEVEL_HIGH>;
        clock-names = "ftm-evt", "ftm-src", "ftm-evt-counter-en", "ftm-src-counter-en";
        clocks = <&clks VF610_CLK_FTM2>, <&clks VF610_CLK_FTM3>,
            <&clks VF610_CLK_FTM2_EXT_FIX_EN>, <&clks VF610_CLK_FTM3_EXT_FIX_EN>;
        big-endian;
    };