Documentation/devicetree/bindings/clock/clk-palmas-clk32kg-clocks.txt

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/clock/clk-palmas-clk32kg-clocks.txt

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/clock/clk-palmas-clk32kg-clocks.txt
Extension
.txt
Size
1159 bytes
Lines
36
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: documentation
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

Palmas device has two clock output pins for 32KHz, KG and KG_AUDIO.

This binding uses the common clock binding ./clock-bindings.txt.

Required properties:
- compatible :	"ti,palmas-clk32kg" for clk32kg clock
		"ti,palmas-clk32kgaudio" for clk32kgaudio clock
- #clock-cells : shall be set to 0.

Optional property:
- ti,external-sleep-control: The external enable input pins controlled the
	enable/disable of clocks.  The external enable input pins ENABLE1,
	ENABLE2 and NSLEEP. The valid values for the external pins are:
		PALMAS_EXT_CONTROL_PIN_ENABLE1 for ENABLE1 pin
		PALMAS_EXT_CONTROL_PIN_ENABLE2 for ENABLE2 pin
		PALMAS_EXT_CONTROL_PIN_NSLEEP for NSLEEP pin
	Option 0 or missing this property means the clock is enabled/disabled
	via register access and these pins do not have any control.
	The macros of external control pins for DTS is defined at
	dt-bindings/mfd/palmas.h

Example:
	#include <dt-bindings/mfd/palmas.h>
	...
	palmas: tps65913@58 {
		...
		clk32kg: palmas_clk32k@0 {
			compatible = "ti,palmas-clk32kg";
			#clock-cells = <0>;
			ti,external-sleep-control = <PALMAS_EXT_CONTROL_PIN_NSLEEP>;
		};
		...
	};

Annotation

Implementation Notes