Documentation/devicetree/bindings/pinctrl/renesas,rzg2l-poeg.yaml

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

title: Renesas RZ/G2L Port Output Enable for GPT (POEG)

maintainers:
  - Biju Das <biju.das.jz@bp.renesas.com>

description: |
  The output pins(GTIOCxA and GTIOCxB) of the general PWM timer (GPT) can be
  disabled by using the port output enabling function for the GPT (POEG).
  Specifically, either of the following ways can be used.
  * Input level detection of the GTETRGA to GTETRGD pins.
  * Output-disable request from the GPT.
  * SSF bit setting(ie, by setting POEGGn.SSF to 1)

  The state of the GTIOCxA and the GTIOCxB pins when the output is disabled,
  are controlled by the GPT module.

properties:
  compatible:
    items:
      - enum:
          - renesas,r9a07g044-poeg  # RZ/G2{L,LC}
          - renesas,r9a07g054-poeg  # RZ/V2L
      - const: renesas,rzg2l-poeg

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    maxItems: 1

  power-domains:
    maxItems: 1

  resets:
    maxItems: 1

  renesas,gpt:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: phandle to gpt instance that serves the pwm operation.

  renesas,poeg-id:
    $ref: /schemas/types.yaml#/definitions/uint32
    enum: [ 0, 1, 2, 3 ]
    description: |
      POEG group index. Valid values are:
        <0> : POEG group A
        <1> : POEG group B
        <2> : POEG group C
        <3> : POEG group D

required:
  - compatible
  - reg
  - interrupts
  - clocks
  - power-domains
  - resets
  - renesas,poeg-id
  - renesas,gpt

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/r9a07g044-cpg.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>

    poeggd: poeg@10049400 {
        compatible = "renesas,r9a07g044-poeg", "renesas,rzg2l-poeg";
        reg = <0x10049400 0x400>;
        interrupts = <GIC_SPI 325 IRQ_TYPE_LEVEL_HIGH>;
        clocks = <&cpg CPG_MOD R9A07G044_POEG_D_CLKP>;
        power-domains = <&cpg>;
        resets = <&cpg R9A07G044_POEG_D_RST>;
        renesas,poeg-id = <3>;
        renesas,gpt = <&gpt>;
    };