xref: /freebsd/sys/contrib/device-tree/Bindings/clock/samsung,s2mps11.txt (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
1Binding for Samsung S2M and S5M family clock generator block
2============================================================
3
4This is a part of device tree bindings for S2M and S5M family multi-function
5devices.
6More information can be found in bindings/mfd/sec-core.txt file.
7
8The S2MPS11/13/15 and S5M8767 provide three(AP/CP/BT) buffered 32.768 kHz
9outputs. The S2MPS14 provides two (AP/BT) buffered 32.768 KHz outputs.
10
11To register these as clocks with common clock framework instantiate under
12main device node a sub-node named "clocks".
13
14It uses the common clock binding documented in:
15 - Documentation/devicetree/bindings/clock/clock-bindings.txt
16
17
18Required properties of the "clocks" sub-node:
19 - #clock-cells: should be 1.
20 - compatible: Should be one of: "samsung,s2mps11-clk", "samsung,s2mps13-clk",
21               "samsung,s2mps14-clk", "samsung,s5m8767-clk"
22   The S2MPS15 uses the same compatible as S2MPS13, as both provides similar
23   clocks.
24
25
26Each clock is assigned an identifier and client nodes use this identifier
27to specify the clock which they consume.
28    Clock               ID           Devices
29    ----------------------------------------------------------
30    32KhzAP		0            S2MPS11/13/14/15, S5M8767
31    32KhzCP		1            S2MPS11/13/15, S5M8767
32    32KhzBT		2            S2MPS11/13/14/15, S5M8767
33
34Include dt-bindings/clock/samsung,s2mps11.h file to use preprocessor defines
35in device tree sources.
36
37
38Example:
39
40	s2mps11_pmic@66 {
41		compatible = "samsung,s2mps11-pmic";
42		reg = <0x66>;
43
44		s2m_osc: clocks {
45			compatible = "samsung,s2mps11-clk";
46			#clock-cells = <1>;
47			clock-output-names = "xx", "yy", "zz";
48		};
49	};
50