diff mbox

[v5,04/14] clk: max77686: Improve Maxim 77686 PMIC clocks binding

Message ID 1403806546-31122-5-git-send-email-javier.martinez@collabora.co.uk (mailing list archive)
State New, archived
Headers show

Commit Message

Javier Martinez Canillas June 26, 2014, 6:15 p.m. UTC
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.

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

Changes since v4: None

Changes since v3:
 - Don't change clock-names property to make clear that it's
   the consumer clock name and should not match the producer clock.
   Suggested by Doug Anderson.

 Documentation/devicetree/bindings/clock/maxim,max77686.txt | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

Comments

Mike Turquette July 1, 2014, 5:29 p.m. UTC | #1
Quoting Javier Martinez Canillas (2014-06-26 11:15:36)
> 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.
> 
> 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>

Looks good to me.

Regards,
Mike

> ---
> 
> Changes since v4: None
> 
> Changes since v3:
>  - Don't change clock-names property to make clear that it's
>    the consumer clock name and should not match the producer clock.
>    Suggested by Doug Anderson.
> 
>  Documentation/devicetree/bindings/clock/maxim,max77686.txt | 13 +++++++++----
>  1 file changed, 9 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/clock/maxim,max77686.txt b/Documentation/devicetree/bindings/clock/maxim,max77686.txt
> index 96ce71b..48e00bb 100644
> --- a/Documentation/devicetree/bindings/clock/maxim,max77686.txt
> +++ b/Documentation/devicetree/bindings/clock/maxim,max77686.txt
> @@ -9,13 +9,18 @@ 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.
> +
> +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 +39,5 @@ Example: Clock consumer node
>                 compatible = "bar,foo";
>                 /* ... */
>                 clock-names = "my-clock";
> -               clocks = <&max77686 2>;
> +               clocks = <&max77686 MAX77686_CLK_PMIC>;
>         };
> -- 
> 2.0.0.rc2
>
Javier Martinez Canillas July 2, 2014, 10:17 a.m. UTC | #2
Hello Mike,

On 07/01/2014 07:29 PM, Mike Turquette wrote:
> Quoting Javier Martinez Canillas (2014-06-26 11:15:36)
>> 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.
>> 
>> 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>
> 
> Looks good to me.
> 
> Regards,
> Mike
> 

Thanks a lot, an Acked-by or Reviewed-by tags for this patch and 03/14 will be
great as well so I can carry those on the next version of the series.

Best regards,
Javier
Mike Turquette July 2, 2014, 3:21 p.m. UTC | #3
Quoting Javier Martinez Canillas (2014-07-02 03:17:54)
> Hello Mike,
> 
> On 07/01/2014 07:29 PM, Mike Turquette wrote:
> > Quoting Javier Martinez Canillas (2014-06-26 11:15:36)
> >> 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.
> >> 
> >> 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>
> > 
> > Looks good to me.
> > 
> > Regards,
> > Mike
> > 
> 
> Thanks a lot, an Acked-by or Reviewed-by tags for this patch and 03/14 will be
> great as well so I can carry those on the next version of the series.

Sure you can interpret my "looks good to me" as either an Ack or a
Reviewed-by, depending on context. In this case feel free to add:

Reviewed-by: Mike Turquette <mturquette@linaro.org>

Regards,
Mike

> 
> Best regards,
> Javier
>
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/clock/maxim,max77686.txt b/Documentation/devicetree/bindings/clock/maxim,max77686.txt
index 96ce71b..48e00bb 100644
--- a/Documentation/devicetree/bindings/clock/maxim,max77686.txt
+++ b/Documentation/devicetree/bindings/clock/maxim,max77686.txt
@@ -9,13 +9,18 @@  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.
+
+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 +39,5 @@  Example: Clock consumer node
 		compatible = "bar,foo";
 		/* ... */
 		clock-names = "my-clock";
-		clocks = <&max77686 2>;
+		clocks = <&max77686 MAX77686_CLK_PMIC>;
 	};