Documentation/devicetree/bindings/clock/rockchip,rk3188-cru.yaml

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

title: Rockchip RK3188/RK3066 Clock and Reset Unit (CRU)

maintainers:
  - Elaine Zhang <zhangqing@rock-chips.com>
  - Heiko Stuebner <heiko@sntech.de>

description: |
  The RK3188/RK3066 clock controller generates and supplies clocks to various
  controllers within the SoC and also implements a reset controller for SoC
  peripherals.
  Each clock is assigned an identifier and client nodes can use this identifier
  to specify the clock which they consume. All available clocks are defined as
  preprocessor macros in the dt-bindings/clock/rk3188-cru.h and
  dt-bindings/clock/rk3066-cru.h headers and can be used in device tree sources.
  Similar macros exist for the reset sources in these files.
  There are several clocks that are generated outside the SoC. It is expected
  that they are defined using standard clock bindings with following
  clock-output-names:
    - "xin24m"    - crystal input                 - required
    - "xin32k"    - RTC clock                     - optional
    - "xin27m"    - 27mhz crystal input on RK3066 - optional
    - "ext_hsadc" - external HSADC clock          - optional
    - "ext_cif0"  - external camera clock         - optional
    - "ext_rmii"  - external RMII clock           - optional
    - "ext_jtag"  - external JTAG clock           - optional

properties:
  compatible:
    enum:
      - rockchip,rk3066a-cru
      - rockchip,rk3188-cru
      - rockchip,rk3188a-cru

  reg:
    maxItems: 1

  "#clock-cells":
    const: 1

  "#reset-cells":
    const: 1

  clocks:
    maxItems: 1

  clock-names:
    const: xin24m

  rockchip,grf:
    $ref: /schemas/types.yaml#/definitions/phandle
    description:
      Phandle to the syscon managing the "general register files" (GRF),
      if missing pll rates are not changeable, due to the missing pll
      lock status.

required:
  - compatible
  - reg
  - "#clock-cells"
  - "#reset-cells"

additionalProperties: false

examples:
  - |
    cru: clock-controller@20000000 {
      compatible = "rockchip,rk3188-cru";
      reg = <0x20000000 0x1000>;
      rockchip,grf = <&grf>;
      #clock-cells = <1>;
      #reset-cells = <1>;
    };