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: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
Reviewed-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
Reviewed-by: Doug Anderson <dianders@chromium.org>
Reviewed-by: Mike Turquette <mturquette@linaro.org>
Signed-off-by: Mike Turquette <mturquette@linaro.org>
This commit is contained in:
Javier Martinez Canillas 2014-08-18 10:33:02 +02:00 committed by Mike Turquette
parent 1887d69308
commit fcd0864cdb
1 changed files with 12 additions and 4 deletions

View File

@ -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. Following properties should be presend in main device node of the MFD chip.
Required properties: 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 - #clock-cells: from common clock binding; shall be set to 1.
indices are allowed:
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, - 0: 32khz_ap clock,
- 1: 32khz_cp clock, - 1: 32khz_cp clock,
- 2: 32khz_pmic 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 Example: Node of the MFD chip
max77686: max77686@09 { max77686: max77686@09 {
@ -34,5 +42,5 @@ Example: Clock consumer node
compatible = "bar,foo"; compatible = "bar,foo";
/* ... */ /* ... */
clock-names = "my-clock"; clock-names = "my-clock";
clocks = <&max77686 2>; clocks = <&max77686 MAX77686_CLK_PMIC>;
}; };