Documentation/devicetree/bindings/pwm/pwm-rockchip.yaml

# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/pwm/pwm-rockchip.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Rockchip PWM controller

maintainers:
  - Heiko Stuebner <heiko@sntech.de>

properties:
  compatible:
    oneOf:
      - const: rockchip,rk2928-pwm
      - const: rockchip,rk3288-pwm
      - const: rockchip,rk3328-pwm
      - const: rockchip,vop-pwm
      - items:
          - const: rockchip,rk3036-pwm
          - const: rockchip,rk2928-pwm
      - items:
          - enum:
              - rockchip,rk3128-pwm
              - rockchip,rk3368-pwm
              - rockchip,rk3399-pwm
              - rockchip,rv1108-pwm
          - const: rockchip,rk3288-pwm
      - items:
          - enum:
              - rockchip,px30-pwm
              - rockchip,rk3308-pwm
              - rockchip,rk3568-pwm
              - rockchip,rk3588-pwm
          - const: rockchip,rk3328-pwm

  reg:
    maxItems: 1

  clocks:
    minItems: 1
    maxItems: 2

  clock-names:
    maxItems: 2

  "#pwm-cells":
    enum: [2, 3]
    description:
      Must be 2 (rk2928) or 3 (rk3288 and later).
      See pwm.yaml for a description of the cell format.

required:
  - compatible
  - reg

allOf:
  - $ref: pwm.yaml#

  - if:
      properties:
        compatible:
          contains:
            enum:
              - rockchip,rk3328-pwm
              - rockchip,rv1108-pwm

    then:
      properties:
        clocks:
          items:
            - description: Used to derive the functional clock for the device.
            - description: Used as the APB bus clock.

        clock-names:
          items:
            - const: pwm
            - const: pclk

      required:
        - clocks
        - clock-names

    else:
      properties:
        clocks:
          maxItems: 1
          description:
            Used both to derive the functional clock
            for the device and as the bus clock.

      required:
        - clocks

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/rk3188-cru-common.h>
    pwm0: pwm@20030000 {
      compatible = "rockchip,rk2928-pwm";
      reg = <0x20030000 0x10>;
      clocks = <&cru PCLK_PWM01>;
      #pwm-cells = <2>;
    };