xref: /freebsd/sys/contrib/device-tree/Bindings/clock/pwm-clock.txt (revision fe75646a0234a261c0013bf1840fdac4acaf0cec)
1Binding for an external clock signal driven by a PWM pin.
2
3This binding uses the common clock binding[1] and the common PWM binding[2].
4
5[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
6[2] Documentation/devicetree/bindings/pwm/pwm.txt
7
8Required properties:
9- compatible : shall be "pwm-clock".
10- #clock-cells : from common clock binding; shall be set to 0.
11- pwms : from common PWM binding; this determines the clock frequency
12  via the period given in the PWM specifier.
13
14Optional properties:
15- clock-output-names : From common clock binding.
16- clock-frequency : Exact output frequency, in case the PWM period
17  is not exact but was rounded to nanoseconds.
18
19Example:
20	clock {
21		compatible = "pwm-clock";
22		#clock-cells = <0>;
23		clock-frequency = <25000000>;
24		clock-output-names = "mipi_mclk";
25		pwms = <&pwm2 0 40>; /* 1 / 40 ns = 25 MHz */
26	};
27