xref: /linux/Documentation/devicetree/bindings/clock/ti-clkctrl.txt (revision b8d312aa075f33282565467662c4628dae0a2aff)
1Texas Instruments clkctrl clock binding
2
3Texas Instruments SoCs can have a clkctrl clock controller for each
4interconnect target module. The clkctrl clock controller manages functional
5and interface clocks for each module. Each clkctrl controller can also
6gate one or more optional functional clocks for a module, and can have one
7or more clock muxes. There is a clkctrl clock controller typically for each
8interconnect target module on omap4 and later variants.
9
10The clock consumers can specify the index of the clkctrl clock using
11the hardware offset from the clkctrl instance register space. The optional
12clocks can be specified by clkctrl hardware offset and the index of the
13optional clock.
14
15For more information, please see the Linux clock framework binding at
16Documentation/devicetree/bindings/clock/clock-bindings.txt.
17
18Required properties :
19- compatible : shall be "ti,clkctrl"
20- #clock-cells : shall contain 2 with the first entry being the instance
21		 offset from the clock domain base and the second being the
22		 clock index
23
24Example: Clock controller node on omap 4430:
25
26&cm2 {
27	l4per: cm@1400 {
28		cm_l4per@0 {
29			cm_l4per_clkctrl: clk@20 {
30				compatible = "ti,clkctrl";
31				reg = <0x20 0x1b0>;
32				#clock-cells = <2>;
33			};
34		};
35	};
36};
37
38Example: Preprocessor helper macros in dt-bindings/clock/ti-clkctrl.h
39
40#define OMAP4_CLKCTRL_OFFSET		0x20
41#define OMAP4_CLKCTRL_INDEX(offset)	((offset) - OMAP4_CLKCTRL_OFFSET)
42#define MODULEMODE_HWCTRL		1
43#define MODULEMODE_SWCTRL		2
44
45#define OMAP4_GPTIMER10_CLKTRL		OMAP4_CLKCTRL_INDEX(0x28)
46#define OMAP4_GPTIMER11_CLKTRL		OMAP4_CLKCTRL_INDEX(0x30)
47#define OMAP4_GPTIMER2_CLKTRL		OMAP4_CLKCTRL_INDEX(0x38)
48...
49#define OMAP4_GPIO2_CLKCTRL		OMAP_CLKCTRL_INDEX(0x60)
50
51Example: Clock consumer node for GPIO2:
52
53&gpio2 {
54       clocks = <&cm_l4per_clkctrl OMAP4_GPIO2_CLKCTRL 0
55		 &cm_l4per_clkctrl OMAP4_GPIO2_CLKCTRL 8>;
56};
57