| Message ID | 20180110224838.16711-4-paul@crapouillou.net |
|---|---|
| State | Changes Requested, archived |
| Headers | show |
| Series | None | expand |
On Wed, Jan 10, 2018 at 11:48:33PM +0100, Paul Cercueil wrote: > Add documentation about how to properly use the Ingenic TCU > (Timer/Counter Unit) clocks driver from devicetree. > > Signed-off-by: Paul Cercueil <paul@crapouillou.net> > --- > .../bindings/clock/ingenic,tcu-clocks.txt | 36 ++++++++++++++++++++++ > 1 file changed, 36 insertions(+) > create mode 100644 Documentation/devicetree/bindings/clock/ingenic,tcu-clocks.txt > > v3: New patch in this series > > diff --git a/Documentation/devicetree/bindings/clock/ingenic,tcu-clocks.txt b/Documentation/devicetree/bindings/clock/ingenic,tcu-clocks.txt > new file mode 100644 > index 000000000000..90bb30e07b86 > --- /dev/null > +++ b/Documentation/devicetree/bindings/clock/ingenic,tcu-clocks.txt > @@ -0,0 +1,36 @@ > +Ingenic SoC TCU binding > + > +The TCU is the Timer/Counter Unit present in all Ingenic SoCs. It features 8 > +channels, each one having its own clock, that can be started and stopped, > +reparented, and reclocked. > + > +Required properties: > +- compatible : One of: > + * ingenic,jz4740-tcu-clocks, > + * ingenic,jz4770-tcu-clocks, > + * ingenic,jz4780-tcu-clocks. > +- clocks : List of phandle & clock specifiers for clocks external to the TCU. > + The "pclk", "rtc" and "ext" clocks should be provided. > +- clock-names : List of name strings for the external clocks. > +- #clock-cells: Should be 1. > + Clock consumers specify this argument to identify a clock. The valid values > + may be found in <dt-bindings/clock/ingenic,tcu.h>. Need to say this is a child of "ingenic,tcu" and reference it's binding doc. > + > +Example: > + > +/ { > + mfd@10002000 { > + compatible = "ingenic,tcu", "simple-mfd", "syscon"; > + reg = <0x10002000 0x1000>; > + > + tcu_clk: clocks { clocks@10002010 And ranges needed. > + compatible = "ingenic,jz4740-tcu-clocks"; > + reg = <0x10002010 0xFF0>; 0xff0 > + > + clocks = <&ext>, <&rtc>, <&pclk>; > + clock-names = "ext", "rtc", "pclk"; > + > + #clock-cells = <1>; > + }; > + }; > +}; > -- > 2.11.0 > -- To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
diff --git a/Documentation/devicetree/bindings/clock/ingenic,tcu-clocks.txt b/Documentation/devicetree/bindings/clock/ingenic,tcu-clocks.txt new file mode 100644 index 000000000000..90bb30e07b86 --- /dev/null +++ b/Documentation/devicetree/bindings/clock/ingenic,tcu-clocks.txt @@ -0,0 +1,36 @@ +Ingenic SoC TCU binding + +The TCU is the Timer/Counter Unit present in all Ingenic SoCs. It features 8 +channels, each one having its own clock, that can be started and stopped, +reparented, and reclocked. + +Required properties: +- compatible : One of: + * ingenic,jz4740-tcu-clocks, + * ingenic,jz4770-tcu-clocks, + * ingenic,jz4780-tcu-clocks. +- clocks : List of phandle & clock specifiers for clocks external to the TCU. + The "pclk", "rtc" and "ext" clocks should be provided. +- clock-names : List of name strings for the external clocks. +- #clock-cells: Should be 1. + Clock consumers specify this argument to identify a clock. The valid values + may be found in <dt-bindings/clock/ingenic,tcu.h>. + +Example: + +/ { + mfd@10002000 { + compatible = "ingenic,tcu", "simple-mfd", "syscon"; + reg = <0x10002000 0x1000>; + + tcu_clk: clocks { + compatible = "ingenic,jz4740-tcu-clocks"; + reg = <0x10002010 0xFF0>; + + clocks = <&ext>, <&rtc>, <&pclk>; + clock-names = "ext", "rtc", "pclk"; + + #clock-cells = <1>; + }; + }; +};
Add documentation about how to properly use the Ingenic TCU (Timer/Counter Unit) clocks driver from devicetree. Signed-off-by: Paul Cercueil <paul@crapouillou.net> --- .../bindings/clock/ingenic,tcu-clocks.txt | 36 ++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 Documentation/devicetree/bindings/clock/ingenic,tcu-clocks.txt v3: New patch in this series