[linux-block.git] / Documentation / devicetree / bindings / clock / ti / interface.txt

Binding for Texas Instruments interface clock.

This binding uses the common clock binding[1]. This clock is
quite much similar to the basic gate-clock [2], however,
it supports a number of additional features, including
companion clock finding (match corresponding functional gate
clock) and hardware autoidle enable / disable.

[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml

Required properties:
- compatible : shall be one of:
  "ti,omap3-interface-clock" - basic OMAP3 interface clock
  "ti,omap3-no-wait-interface-clock" - interface clock which has no hardware
				       capability for waiting clock to be ready
  "ti,omap3-hsotgusb-interface-clock" - interface clock with USB specific HW
					handling
  "ti,omap3-dss-interface-clock" - interface clock with DSS specific HW handling
  "ti,omap3-ssi-interface-clock" - interface clock with SSI specific HW handling
  "ti,am35xx-interface-clock" - interface clock with AM35xx specific HW handling
  "ti,omap2430-interface-clock" - interface clock with OMAP2430 specific HW
				  handling
- #clock-cells : from common clock binding; shall be set to 0
- clocks : link to phandle of parent clock
- reg : base address for the control register

Optional properties:
- clock-output-names : from common clock binding.
- ti,bit-shift : bit shift for the bit enabling/disabling the clock (default 0)

Examples:
	aes1_ick: aes1_ick@48004a14 {
		#clock-cells = <0>;
		compatible = "ti,omap3-interface-clock";
		clocks = <&security_l4_ick2>;
		reg = <0x48004a14 0x4>;
		ti,bit-shift = <3>;
	};

	cam_ick: cam_ick@48004f10 {
		#clock-cells = <0>;
		compatible = "ti,omap3-no-wait-interface-clock";
		clocks = <&l4_ick>;
		reg = <0x48004f10 0x4>;
		ti,bit-shift = <0>;
	};

	ssi_ick_3430es2: ssi_ick_3430es2@48004a10 {
		#clock-cells = <0>;
		compatible = "ti,omap3-ssi-interface-clock";
		clocks = <&ssi_l4_ick>;
		reg = <0x48004a10 0x4>;
		ti,bit-shift = <0>;
	};
Commit	Line	Data
24582b34 TK	1	Binding for Texas Instruments interface clock.
24582b34 TK	2
24582b34 TK	3	This binding uses the common clock binding[1]. This clock is
	4	quite much similar to the basic gate-clock [2], however,
	5	it supports a number of additional features, including
	6	companion clock finding (match corresponding functional gate
	7	clock) and hardware autoidle enable / disable.
	8
	9	[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
450c787c	10	[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml
24582b34 TK	11
	12	Required properties:
	13	- compatible : shall be one of:
	14	"ti,omap3-interface-clock" - basic OMAP3 interface clock
	15	"ti,omap3-no-wait-interface-clock" - interface clock which has no hardware
	16	capability for waiting clock to be ready
	17	"ti,omap3-hsotgusb-interface-clock" - interface clock with USB specific HW
	18	handling
	19	"ti,omap3-dss-interface-clock" - interface clock with DSS specific HW handling
	20	"ti,omap3-ssi-interface-clock" - interface clock with SSI specific HW handling
	21	"ti,am35xx-interface-clock" - interface clock with AM35xx specific HW handling
de742570 TK	22	"ti,omap2430-interface-clock" - interface clock with OMAP2430 specific HW
de742570 TK	23	handling
24582b34 TK	24	- #clock-cells : from common clock binding; shall be set to 0
	25	- clocks : link to phandle of parent clock
	26	- reg : base address for the control register
	27
	28	Optional properties:
fc3d39d5	29	- clock-output-names : from common clock binding.
24582b34 TK	30	- ti,bit-shift : bit shift for the bit enabling/disabling the clock (default 0)
	31
	32	Examples:
	33	aes1_ick: aes1_ick@48004a14 {
	34	#clock-cells = <0>;
	35	compatible = "ti,omap3-interface-clock";
	36	clocks = <&security_l4_ick2>;
	37	reg = <0x48004a14 0x4>;
	38	ti,bit-shift = <3>;
	39	};
	40
	41	cam_ick: cam_ick@48004f10 {
	42	#clock-cells = <0>;
	43	compatible = "ti,omap3-no-wait-interface-clock";
	44	clocks = <&l4_ick>;
	45	reg = <0x48004f10 0x4>;
	46	ti,bit-shift = <0>;
	47	};
	48
	49	ssi_ick_3430es2: ssi_ick_3430es2@48004a10 {
	50	#clock-cells = <0>;
	51	compatible = "ti,omap3-ssi-interface-clock";
	52	clocks = <&ssi_l4_ick>;
	53	reg = <0x48004a10 0x4>;
	54	ti,bit-shift = <0>;
	55	};