xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/clock/clk-palmas-clk32kg-clocks.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun* Palmas 32KHz clocks *
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunPalmas device has two clock output pins for 32KHz, KG and KG_AUDIO.
4*4882a593Smuzhiyun
5*4882a593SmuzhiyunThis binding uses the common clock binding ./clock-bindings.txt.
6*4882a593Smuzhiyun
7*4882a593SmuzhiyunRequired properties:
8*4882a593Smuzhiyun- compatible :	"ti,palmas-clk32kg" for clk32kg clock
9*4882a593Smuzhiyun		"ti,palmas-clk32kgaudio" for clk32kgaudio clock
10*4882a593Smuzhiyun- #clock-cells : shall be set to 0.
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunOptional property:
13*4882a593Smuzhiyun- ti,external-sleep-control: The external enable input pins controlled the
14*4882a593Smuzhiyun	enable/disable of clocks.  The external enable input pins ENABLE1,
15*4882a593Smuzhiyun	ENABLE2 and NSLEEP. The valid values for the external pins are:
16*4882a593Smuzhiyun		PALMAS_EXT_CONTROL_PIN_ENABLE1 for ENABLE1 pin
17*4882a593Smuzhiyun		PALMAS_EXT_CONTROL_PIN_ENABLE2 for ENABLE2 pin
18*4882a593Smuzhiyun		PALMAS_EXT_CONTROL_PIN_NSLEEP for NSLEEP pin
19*4882a593Smuzhiyun	Option 0 or missing this property means the clock is enabled/disabled
20*4882a593Smuzhiyun	via register access and these pins do not have any control.
21*4882a593Smuzhiyun	The macros of external control pins for DTS is defined at
22*4882a593Smuzhiyun	dt-bindings/mfd/palmas.h
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunExample:
25*4882a593Smuzhiyun	#include <dt-bindings/mfd/palmas.h>
26*4882a593Smuzhiyun	...
27*4882a593Smuzhiyun	palmas: tps65913@58 {
28*4882a593Smuzhiyun		...
29*4882a593Smuzhiyun		clk32kg: palmas_clk32k@0 {
30*4882a593Smuzhiyun			compatible = "ti,palmas-clk32kg";
31*4882a593Smuzhiyun			#clock-cells = <0>;
32*4882a593Smuzhiyun			ti,external-sleep-control = <PALMAS_EXT_CONTROL_PIN_NSLEEP>;
33*4882a593Smuzhiyun		};
34*4882a593Smuzhiyun		...
35*4882a593Smuzhiyun	};
36