Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml

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

title: TI fixed factor rate clock sources

maintainers:
  - Tero Kristo <kristo@kernel.org>
  - Sukrut Bellary <sbellary@baylibre.com>

description:
  This consists of a divider and a multiplier used to generate a fixed rate
  clock. This also uses the autoidle support from TI autoidle clock.

allOf:
  - $ref: ti,autoidle.yaml#

properties:
  compatible:
    const: ti,fixed-factor-clock

  "#clock-cells":
    const: 0

  reg:
    maxItems: 1

  ti,clock-div:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Fixed divider
    minimum: 1

  ti,clock-mult:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Fixed multiplier
    minimum: 1

  clocks:
    maxItems: 1

  clock-output-names:
    maxItems: 1

  ti,set-rate-parent:
    description:
      Propagate to parent clock
    type: boolean

required:
  - compatible
  - clocks
  - "#clock-cells"
  - ti,clock-mult
  - ti,clock-div

unevaluatedProperties: false

examples:
  - |
    bus{
        #address-cells = <1>;
        #size-cells = <0>;

        clock@1b4 {
            compatible = "ti,fixed-factor-clock";
            reg = <0x1b4>;
            clocks = <&dpll_usb_ck>;
            #clock-cells = <0>;
            ti,clock-mult = <1>;
            ti,clock-div = <1>;
            ti,autoidle-shift = <8>;
            ti,invert-autoidle-bit;
        };
    };