xref: /linux/Documentation/devicetree/bindings/clock/mvebu-gated-clock.txt (revision ae745302c0a3e2b5b768690f631fc14db44467e7)
1* Gated Clock bindings for Marvell EBU SoCs
2
3Marvell Armada 370/375/380/385/39x/XP, Dove and Kirkwood allow some
4peripheral clocks to be gated to save some power. The clock consumer
5should specify the desired clock by having the clock ID in its
6"clocks" phandle cell. The clock ID is directly mapped to the
7corresponding clock gating control bit in HW to ease manual clock
8lookup in datasheet.
9
10The following is a list of provided IDs for Armada 370:
11ID	Clock	Peripheral
12-----------------------------------
130	Audio	AC97 Cntrl
141	pex0_en	PCIe 0 Clock out
152	pex1_en	PCIe 1 Clock out
163	ge1	Gigabit Ethernet 1
174	ge0	Gigabit Ethernet 0
185	pex0	PCIe Cntrl 0
199	pex1	PCIe Cntrl 1
2015	sata0	SATA Host 0
2117	sdio	SDHCI Host
2223	crypto	CESA (crypto engine)
2325	tdm	Time Division Mplx
2428	ddr	DDR Cntrl
2530	sata1	SATA Host 0
26
27The following is a list of provided IDs for Armada 375:
28ID	Clock		Peripheral
29-----------------------------------
302	mu		Management Unit
313	pp		Packet Processor
324	ptp		PTP
335	pex0		PCIe 0 Clock out
346	pex1		PCIe 1 Clock out
358	audio		Audio Cntrl
3611	nd_clk		Nand Flash Cntrl
3714	sata0_link	SATA 0 Link
3815	sata0_core	SATA 0 Core
3916	usb3		USB3 Host
4017	sdio		SDHCI Host
4118	usb		USB Host
4219	gop		Gigabit Ethernet MAC
4320	sata1_link	SATA 1 Link
4421	sata1_core	SATA 1 Core
4522	xor0		XOR DMA 0
4623	xor1		XOR DMA 0
4724	copro		Coprocessor
4825	tdm		Time Division Mplx
4928	crypto0_enc	Cryptographic Unit Port 0 Encryption
5029	crypto0_core	Cryptographic Unit Port 0 Core
5130	crypto1_enc	Cryptographic Unit Port 1 Encryption
5231	crypto1_core	Cryptographic Unit Port 1 Core
53
54The following is a list of provided IDs for Armada 380/385:
55ID	Clock		Peripheral
56-----------------------------------
570	audio		Audio
582	ge2		Gigabit Ethernet 2
593	ge1		Gigabit Ethernet 1
604	ge0		Gigabit Ethernet 0
615	pex1		PCIe 1
626	pex2		PCIe 2
637	pex3		PCIe 3
648	pex0		PCIe 0
659	usb3h0		USB3 Host 0
6610	usb3h1		USB3 Host 1
6711	usb3d		USB3 Device
6813	bm		Buffer Management
6914	crypto0z	Cryptographic 0 Z
7015	sata0		SATA 0
7116	crypto1z	Cryptographic 1 Z
7217	sdio		SDIO
7318	usb2		USB 2
7421	crypto1		Cryptographic 1
7522	xor0		XOR 0
7623	crypto0		Cryptographic 0
7725	tdm		Time Division Multiplexing
7828	xor1		XOR 1
7930	sata1		SATA 1
80
81The following is a list of provided IDs for Armada 39x:
82ID	Clock		Peripheral
83-----------------------------------
845	pex1		PCIe 1
856	pex2		PCIe 2
867	pex3		PCIe 3
878	pex0		PCIe 0
889	usb3h0		USB3 Host 0
8917	sdio		SDIO
9022	xor0		XOR 0
9128	xor1		XOR 1
92
93The following is a list of provided IDs for Armada XP:
94ID	Clock	Peripheral
95-----------------------------------
960	audio	Audio Cntrl
971	ge3	Gigabit Ethernet 3
982	ge2	Gigabit Ethernet 2
993	ge1	Gigabit Ethernet 1
1004	ge0	Gigabit Ethernet 0
1015	pex0	PCIe Cntrl 0
1026	pex1	PCIe Cntrl 1
1037	pex2	PCIe Cntrl 2
1048	pex3	PCIe Cntrl 3
10513	bp
10614	sata0lnk
10715	sata0	SATA Host 0
10816	lcd	LCD Cntrl
10917	sdio	SDHCI Host
11018	usb0	USB Host 0
11119	usb1	USB Host 1
11220	usb2	USB Host 2
11322	xor0	XOR DMA 0
11423	crypto	CESA engine
11525	tdm	Time Division Mplx
11628	xor1	XOR DMA 1
11729	sata1lnk
11830	sata1	SATA Host 0
119
120The following is a list of provided IDs for Dove:
121ID	Clock	Peripheral
122-----------------------------------
1230	usb0	USB Host 0
1241	usb1	USB Host 1
1252	ge	Gigabit Ethernet
1263	sata	SATA Host
1274	pex0	PCIe Cntrl 0
1285	pex1	PCIe Cntrl 1
1298	sdio0	SDHCI Host 0
1309	sdio1	SDHCI Host 1
13110	nand	NAND Cntrl
13211	camera	Camera Cntrl
13312	i2s0	I2S Cntrl 0
13413	i2s1	I2S Cntrl 1
13515	crypto	CESA engine
13621	ac97	AC97 Cntrl
13722	pdma	Peripheral DMA
13823	xor0	XOR DMA 0
13924	xor1	XOR DMA 1
14030	gephy	Gigabit Ethernel PHY
141Note: gephy(30) is implemented as a parent clock of ge(2)
142
143The following is a list of provided IDs for Kirkwood:
144ID	Clock	Peripheral
145-----------------------------------
1460	ge0	Gigabit Ethernet 0
1472	pex0	PCIe Cntrl 0
1483	usb0	USB Host 0
1494	sdio	SDIO Cntrl
1505	tsu	Transp. Stream Unit
1516	dunit	SDRAM Cntrl
1527	runit	Runit
1538	xor0	XOR DMA 0
1549	audio	I2S Cntrl 0
15514	sata0	SATA Host 0
15615	sata1	SATA Host 1
15716	xor1	XOR DMA 1
15817	crypto	CESA engine
15918	pex1	PCIe Cntrl 1
16019	ge1	Gigabit Ethernet 1
16120	tdm	Time Division Mplx
162
163Required properties:
164- compatible : shall be one of the following:
165	"marvell,armada-370-gating-clock" - for Armada 370 SoC clock gating
166	"marvell,armada-375-gating-clock" - for Armada 375 SoC clock gating
167	"marvell,armada-380-gating-clock" - for Armada 380/385 SoC clock gating
168	"marvell,armada-390-gating-clock" - for Armada 39x SoC clock gating
169	"marvell,armada-xp-gating-clock" - for Armada XP SoC clock gating
170	"marvell,dove-gating-clock" - for Dove SoC clock gating
171	"marvell,kirkwood-gating-clock" - for Kirkwood SoC clock gating
172- reg : shall be the register address of the Clock Gating Control register
173- #clock-cells : from common clock binding; shall be set to 1
174
175Optional properties:
176- clocks : default parent clock phandle (e.g. tclk)
177
178Example:
179
180gate_clk: clock-gating-control@d0038 {
181	compatible = "marvell,dove-gating-clock";
182	reg = <0xd0038 0x4>;
183	/* default parent clock is tclk */
184	clocks = <&core_clk 0>;
185	#clock-cells = <1>;
186};
187
188sdio0: sdio@92000 {
189	compatible = "marvell,dove-sdhci";
190	/* get clk gate bit 8 (sdio0) */
191	clocks = <&gate_clk 8>;
192};
193