xref: /linux/Documentation/devicetree/bindings/clock/maxim,max77686.txt (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732)
1Binding for Maxim MAX77686 32k clock generator block
2
3This is a part of device tree bindings of MAX77686 multi-function device.
4More information can be found in bindings/mfd/max77686.txt file.
5
6The MAX77686 contains three 32.768khz clock outputs that can be controlled
7(gated/ungated) over I2C.
8
9Following properties should be presend in main device node of the MFD chip.
10
11Required properties:
12
13- #clock-cells: from common clock binding; shall be set to 1.
14
15Optional properties:
16- clock-output-names: From common clock binding.
17
18Each clock is assigned an identifier and client nodes can use this identifier
19to specify the clock which they consume. Following indices are allowed:
20    - 0: 32khz_ap clock,
21    - 1: 32khz_cp clock,
22    - 2: 32khz_pmic clock.
23
24Clocks are defined as preprocessor macros in dt-bindings/clock/maxim,max77686.h
25header and can be used in device tree sources.
26
27Example: Node of the MFD chip
28
29	max77686: max77686@09 {
30		compatible = "maxim,max77686";
31		interrupt-parent = <&wakeup_eint>;
32		interrupts = <26 0>;
33		reg = <0x09>;
34		#clock-cells = <1>;
35
36		/* ... */
37	};
38
39Example: Clock consumer node
40
41	foo@0 {
42		compatible = "bar,foo";
43		/* ... */
44		clock-names = "my-clock";
45		clocks = <&max77686 MAX77686_CLK_PMIC>;
46	};
47