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