Add Device Tree binding documentation for the clocks outputs in the Maxim-8997 Power Management IC. CC: Michael Turquette <mturquette@xxxxxxxxxxxx> CC: Rob Herring <robh+dt@xxxxxxxxxx> CC: devicetree@xxxxxxxxxxxxxxx CC: linux-clk@xxxxxxxxxxxxxxx Signed-off-by: Pankaj Dubey <pankaj.dubey@xxxxxxxxxxx> --- .../devicetree/bindings/clock/maxim,max8997.txt | 44 ++++++++++++++++++++++ .../bindings/regulator/max8997-regulator.txt | 3 ++ 2 files changed, 47 insertions(+) create mode 100644 Documentation/devicetree/bindings/clock/maxim,max8997.txt diff --git a/Documentation/devicetree/bindings/clock/maxim,max8997.txt b/Documentation/devicetree/bindings/clock/maxim,max8997.txt new file mode 100644 index 0000000..d2e2a74 --- /dev/null +++ b/Documentation/devicetree/bindings/clock/maxim,max8997.txt @@ -0,0 +1,44 @@ +Binding for Maxim MAX8997 32k clock generator block + +This is a part of device tree bindings of MAX8997 multi-function device. +More information can be found in bindings/regulator/max8997-regulator.txt file. + +The MAX8997 contains two 32.768khz clock outputs that can be controlled +(gated/ungated) over I2C. + +Following properties should be presend in main device node of the MFD chip. + +Required properties: + +- #clock-cells: from common clock binding; shall be set to 1. + +Optional properties: +- clock-output-names: From common clock binding. + +Each clock is assigned an identifier and client nodes can use this identifier +to specify the clock which they consume. Following indices are allowed: + - 0: 32khz_ap clock, + - 1: 32khz_cp clock, + +Clocks are defined as preprocessor macros in dt-bindings/clock/maxim,max8997.h +header and can be used in device tree sources. + +Example: Node of the MFD chip + + max8997: max8997_pmic@66 { + compatible = "maxim,max8997-pmic"; + reg = <0x66>; + interrupt-parent = <&gpx0>; + interrupts = <4 0>, <3 0>; + #clock-cells = <1>; + /* ... */ + }; + +Example: Clock consumer node + + foo@0 { + compatible = "bar,foo"; + /* ... */ + clocks = <&max8997 MAX8997_CLK_AP>; + clock-names = "my-clock"; + }; diff --git a/Documentation/devicetree/bindings/regulator/max8997-regulator.txt b/Documentation/devicetree/bindings/regulator/max8997-regulator.txt index 5c186a7..af1f9c0 100644 --- a/Documentation/devicetree/bindings/regulator/max8997-regulator.txt +++ b/Documentation/devicetree/bindings/regulator/max8997-regulator.txt @@ -6,6 +6,9 @@ interfaced to the host controller using a i2c interface. Each sub-block is addressed by the host system using different i2c slave address. This document describes the bindings for 'pmic' sub-block of max8997. +Binding for the built-in 32k clock generator block is defined separately +in bindings/clk/maxim,max8997.txt file + Required properties: - compatible: Should be "maxim,max8997-pmic". - reg: Specifies the i2c slave address of the pmic block. It should be 0x66. -- 2.7.4 -- To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html