Documentation/devicetree/bindings/clock/canaan,k210-clk.yaml

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

title: Canaan Kendryte K210 Clock

maintainers:
  - Damien Le Moal <dlemoal@kernel.org>

description: |
  Canaan Kendryte K210 SoC clocks driver bindings. The clock
  controller node must be defined as a child node of the K210
  system controller node.

  See also:
  - dt-bindings/clock/k210-clk.h

properties:
  compatible:
    const: canaan,k210-clk

  clocks:
    maxItems: 1
    description:
      Phandle of the SoC 26MHz fixed-rate oscillator clock.

  '#clock-cells':
    const: 1

required:
  - compatible
  - '#clock-cells'
  - clocks

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/k210-clk.h>
    clocks {
      in0: oscillator {
        compatible = "fixed-clock";
        #clock-cells = <0>;
        clock-frequency = <26000000>;
      };
    };

    /* ... */
    sysclk: clock-controller {
      #clock-cells = <1>;
      compatible = "canaan,k210-clk";
      clocks = <&in0>;
    };