[linux-2.6-block.git] / Documentation / devicetree / bindings / clock / amlogic,gxbb-clkc.txt

* Amlogic GXBB Clock and Reset Unit

The Amlogic GXBB clock controller generates and supplies clock to various
controllers within the SoC.

Required Properties:

- compatible: should be "amlogic,gxbb-clkc"
- reg: physical base address of the clock controller and length of memory
       mapped region.

- #clock-cells: should be 1.

Each clock is assigned an identifier and client nodes can use this identifier
to specify the clock which they consume. All available clocks are defined as
preprocessor macros in the dt-bindings/clock/gxbb-clkc.h header and can be
used in device tree sources.

Example: Clock controller node:

	clkc: clock-controller@c883c000 {
		#clock-cells = <1>;
		compatible = "amlogic,gxbb-clkc";
		reg = <0x0 0xc883c000 0x0 0x3db>;
	};

Example: UART controller node that consumes the clock generated by the clock
  controller:

	uart_AO: serial@c81004c0 {
		compatible = "amlogic,meson-uart";
		reg = <0xc81004c0 0x14>;
		interrupts = <0 90 1>;
		clocks = <&clkc CLKID_CLK81>;
		status = "disabled";
	};
Commit	Line	Data
2cc9e7ec MT	1	* Amlogic GXBB Clock and Reset Unit
	2
	3	The Amlogic GXBB clock controller generates and supplies clock to various
	4	controllers within the SoC.
	5
	6	Required Properties:
	7
	8	- compatible: should be "amlogic,gxbb-clkc"
	9	- reg: physical base address of the clock controller and length of memory
	10	mapped region.
	11
	12	- #clock-cells: should be 1.
	13
	14	Each clock is assigned an identifier and client nodes can use this identifier
	15	to specify the clock which they consume. All available clocks are defined as
	16	preprocessor macros in the dt-bindings/clock/gxbb-clkc.h header and can be
	17	used in device tree sources.
	18
	19	Example: Clock controller node:
	20
	21	clkc: clock-controller@c883c000 {
	22	#clock-cells = <1>;
	23	compatible = "amlogic,gxbb-clkc";
	24	reg = <0x0 0xc883c000 0x0 0x3db>;
	25	};
	26
	27	Example: UART controller node that consumes the clock generated by the clock
	28	controller:
	29
	30	uart_AO: serial@c81004c0 {
	31	compatible = "amlogic,meson-uart";
	32	reg = <0xc81004c0 0x14>;
	33	interrupts = <0 90 1>;
	34	clocks = <&clkc CLKID_CLK81>;
	35	status = "disabled";
	36	};