1 Binding for Maxim MAX77686/MAX77802/MAX77620 3 !! 1 Binding for Maxim MAX77686 32k clock generator block
2 2
3 This is a part of device tree bindings of MAX7 !! 3 This is a part of device tree bindings of MAX77686 multi-function device.
4 multi-function device. More information can be !! 4 More information can be found in bindings/mfd/max77686.txt file.
5 doc as follows: <<
6 bindings/mfd/max77686.txt for MAX77686 <<
7 bindings/mfd/max77802.txt for MAX77802 <<
8 bindings/mfd/max77620.txt for MAX77620 <<
9 5
10 The MAX77686 contains three 32.768khz clock ou 6 The MAX77686 contains three 32.768khz clock outputs that can be controlled
11 (gated/ungated) over I2C. Clocks are defined a !! 7 (gated/ungated) over I2C.
12 dt-bindings/clock/maxim,max77686.h. <<
13 <<
14 <<
15 The MAX77802 contains two 32.768khz clock outp <<
16 (gated/ungated) over I2C. Clocks are defined a <<
17 dt-bindings/clock/maxim,max77802.h. <<
18 <<
19 The MAX77686 contains one 32.768khz clock outp <<
20 (gated/ungated) over I2C. Clocks are defined a <<
21 dt-bindings/clock/maxim,max77620.h. <<
22 8
23 Following properties should be presend in main 9 Following properties should be presend in main device node of the MFD chip.
24 10
25 Required properties: 11 Required properties:
26 12
27 - #clock-cells: from common clock binding; sha 13 - #clock-cells: from common clock binding; shall be set to 1.
28 14
29 Optional properties: 15 Optional properties:
30 - clock-output-names: From common clock bindin 16 - clock-output-names: From common clock binding.
31 17
32 Each clock is assigned an identifier and clien 18 Each clock is assigned an identifier and client nodes can use this identifier
33 to specify the clock which they consume. Follo 19 to specify the clock which they consume. Following indices are allowed:
34 - 0: 32khz_ap clock (max77686, max77802), !! 20 - 0: 32khz_ap clock,
35 - 1: 32khz_cp clock (max77686, max77802), !! 21 - 1: 32khz_cp clock,
36 - 2: 32khz_pmic clock (max77686). !! 22 - 2: 32khz_pmic clock.
37 !! 23
38 Clocks are defined as preprocessor macros in a !! 24 Clocks are defined as preprocessor macros in dt-bindings/clock/maxim,max77686.h
39 respective chips. !! 25 header and can be used in device tree sources.
40 !! 26
41 Example: !! 27 Example: Node of the MFD chip
42 !! 28
43 1. With MAX77686: !! 29 max77686: max77686@09 {
44 !! 30 compatible = "maxim,max77686";
45 #include <dt-bindings/clock/maxim,max77686.h> !! 31 interrupt-parent = <&wakeup_eint>;
46 /* ... */ !! 32 interrupts = <26 0>;
47 !! 33 reg = <0x09>;
48 Node of the MFD chip !! 34 #clock-cells = <1>;
49 max77686: max77686@9 { !! 35
50 compatible = "maxim,ma !! 36 /* ... */
51 interrupt-parent = <&w !! 37 };
52 interrupts = <26 IRQ_T !! 38
53 reg = <0x09>; !! 39 Example: Clock consumer node
54 #clock-cells = <1>; !! 40
55 !! 41 foo@0 {
56 /* ... */ !! 42 compatible = "bar,foo";
57 }; !! 43 /* ... */
58 !! 44 clock-names = "my-clock";
59 Clock consumer node !! 45 clocks = <&max77686 MAX77686_CLK_PMIC>;
60 !! 46 };
61 foo@0 { <<
62 compatible = "bar,foo" <<
63 /* ... */ <<
64 clock-names = "my-cloc <<
65 clocks = <&max77686 MA <<
66 }; <<
67 <<
68 2. With MAX77802: <<
69 <<
70 #include <dt-bindings/clock/maxim,max77802.h> <<
71 /* ... */ <<
72 <<
73 Node of the MFD chip <<
74 max77802: max77802@9 { <<
75 compatible = "maxim,ma <<
76 interrupt-parent = <&w <<
77 interrupts = <26 IRQ_T <<
78 reg = <0x09>; <<
79 #clock-cells = <1>; <<
80 <<
81 /* ... */ <<
82 }; <<
83 <<
84 Clock consumer node <<
85 <<
86 foo@0 { <<
87 compatible = "bar,foo" <<
88 /* ... */ <<
89 clock-names = "my-cloc <<
90 clocks = <&max77802 MA <<
91 }; <<
92 <<
93 <<
94 3. With MAX77620: <<
95 <<
96 #include <dt-bindings/clock/maxim,max77620.h> <<
97 /* ... */ <<
98 <<
99 Node of the MFD chip <<
100 max77620: max77620@3c { <<
101 compatible = "maxim,ma <<
102 reg = <0x3c>; <<
103 #clock-cells = <1>; <<
104 /* ... */ <<
105 }; <<
106 <<
107 Clock consumer node <<
108 <<
109 foo@0 { <<
110 compatible = "bar,foo" <<
111 /* ... */ <<
112 clock-names = "my-cloc <<
113 clocks = <&max77620 MA <<
114 }; <<
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.