xref: /openbmc/linux/Documentation/devicetree/bindings/clock/ti/interface.txt (revision 4f2c0a4acffbec01079c28f839422e64ddeff004)
124582b34STero KristoBinding for Texas Instruments interface clock.
224582b34STero Kristo
324582b34STero KristoBinding status: Unstable - ABI compatibility may be broken in the future
424582b34STero Kristo
524582b34STero KristoThis binding uses the common clock binding[1]. This clock is
624582b34STero Kristoquite much similar to the basic gate-clock [2], however,
724582b34STero Kristoit supports a number of additional features, including
824582b34STero Kristocompanion clock finding (match corresponding functional gate
924582b34STero Kristoclock) and hardware autoidle enable / disable.
1024582b34STero Kristo
1124582b34STero Kristo[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
12*450c787cSConor Dooley[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml
1324582b34STero Kristo
1424582b34STero KristoRequired properties:
1524582b34STero Kristo- compatible : shall be one of:
1624582b34STero Kristo  "ti,omap3-interface-clock" - basic OMAP3 interface clock
1724582b34STero Kristo  "ti,omap3-no-wait-interface-clock" - interface clock which has no hardware
1824582b34STero Kristo				       capability for waiting clock to be ready
1924582b34STero Kristo  "ti,omap3-hsotgusb-interface-clock" - interface clock with USB specific HW
2024582b34STero Kristo					handling
2124582b34STero Kristo  "ti,omap3-dss-interface-clock" - interface clock with DSS specific HW handling
2224582b34STero Kristo  "ti,omap3-ssi-interface-clock" - interface clock with SSI specific HW handling
2324582b34STero Kristo  "ti,am35xx-interface-clock" - interface clock with AM35xx specific HW handling
24de742570STero Kristo  "ti,omap2430-interface-clock" - interface clock with OMAP2430 specific HW
25de742570STero Kristo				  handling
2624582b34STero Kristo- #clock-cells : from common clock binding; shall be set to 0
2724582b34STero Kristo- clocks : link to phandle of parent clock
2824582b34STero Kristo- reg : base address for the control register
2924582b34STero Kristo
3024582b34STero KristoOptional properties:
31fc3d39d5STony Lindgren- clock-output-names : from common clock binding.
3224582b34STero Kristo- ti,bit-shift : bit shift for the bit enabling/disabling the clock (default 0)
3324582b34STero Kristo
3424582b34STero KristoExamples:
3524582b34STero Kristo	aes1_ick: aes1_ick@48004a14 {
3624582b34STero Kristo		#clock-cells = <0>;
3724582b34STero Kristo		compatible = "ti,omap3-interface-clock";
3824582b34STero Kristo		clocks = <&security_l4_ick2>;
3924582b34STero Kristo		reg = <0x48004a14 0x4>;
4024582b34STero Kristo		ti,bit-shift = <3>;
4124582b34STero Kristo	};
4224582b34STero Kristo
4324582b34STero Kristo	cam_ick: cam_ick@48004f10 {
4424582b34STero Kristo		#clock-cells = <0>;
4524582b34STero Kristo		compatible = "ti,omap3-no-wait-interface-clock";
4624582b34STero Kristo		clocks = <&l4_ick>;
4724582b34STero Kristo		reg = <0x48004f10 0x4>;
4824582b34STero Kristo		ti,bit-shift = <0>;
4924582b34STero Kristo	};
5024582b34STero Kristo
5124582b34STero Kristo	ssi_ick_3430es2: ssi_ick_3430es2@48004a10 {
5224582b34STero Kristo		#clock-cells = <0>;
5324582b34STero Kristo		compatible = "ti,omap3-ssi-interface-clock";
5424582b34STero Kristo		clocks = <&ssi_l4_ick>;
5524582b34STero Kristo		reg = <0x48004a10 0x4>;
5624582b34STero Kristo		ti,bit-shift = <0>;
5724582b34STero Kristo	};
58