Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit fcd0864c authored by Javier Martinez Canillas's avatar Javier Martinez Canillas Committed by Mike Turquette
Browse files

clk: max77686: Improve Maxim 77686 PMIC clocks binding 



Like most clock drivers, the Maxim 77686 PMIC clock binding
follows the convention that the "#clock-cells" property is
used to specify the number of cells in a clock provider.

But the binding document is not clear enough that it shall
be set to 1 since the PMIC support multiple clocks outputs.

Also, explain that the clocks identifiers are defined in a
header file that can be included by Device Tree source with
client nodes to avoid using magic numbers.

Finally, add "clock-output-names" as an optional property
since now is supported by the clock driver.

Signed-off-by: default avatarJavier Martinez Canillas <javier.martinez@collabora.co.uk>
Reviewed-by: default avatarKrzysztof Kozlowski <k.kozlowski@samsung.com>
Reviewed-by: default avatarDoug Anderson <dianders@chromium.org>
Reviewed-by: default avatarMike Turquette <mturquette@linaro.org>
Signed-off-by: default avatarMike Turquette <mturquette@linaro.org>
parent 1887d693

Documentation/devicetree/bindings/clock/maxim,max77686.txt

+12 −4
Original line number Diff line number Diff line
@@ -9,13 +9,21 @@ The MAX77686 contains three 32.768khz clock outputs that can be controlled 
Following properties should be presend in main device node of the MFD chip.



Required properties:

- #clock-cells: simple one-cell clock specifier format is used, where the

  only cell is used as an index of the clock inside the provider. Following

  indices are allowed:



- #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,

    - 2: 32khz_pmic clock.



Clocks are defined as preprocessor macros in dt-bindings/clock/maxim,max77686.h

header and can be used in device tree sources.



Example: Node of the MFD chip



	max77686: max77686@09 {
@@ -34,5 +42,5 @@ Example: Clock consumer node 
		compatible = "bar,foo";

		/* ... */

		clock-names = "my-clock";

		clocks = <&max77686 2>;

		clocks = <&max77686 MAX77686_CLK_PMIC>;

	};