diff mbox

Documentation: clock: address more for clock-cells property

Message ID 1496306801-19239-1-git-send-email-zhang.chunyan@linaro.org (mailing list archive)
State Superseded
Headers show

Commit Message

Chunyan Zhang June 1, 2017, 8:46 a.m. UTC
The value of property 'clock-cells' is not determined only by the number of
clock outputs in one clock node, it is actually determined by whether the
clock output in this node can be referenced directly without index.  If
the output clock has to be referenced by a index, the clock-cell of this
clock node can't be defined 0.

Signed-off-by: Chunyan Zhang <zhang.chunyan@linaro.org>
---
 Documentation/devicetree/bindings/clock/clock-bindings.txt | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

Comments

Stephen Boyd June 2, 2017, 10:56 p.m. UTC | #1
On 06/01, Chunyan Zhang wrote:
> The value of property 'clock-cells' is not determined only by the number of
> clock outputs in one clock node, it is actually determined by whether the
> clock output in this node can be referenced directly without index.  If
> the output clock has to be referenced by a index, the clock-cell of this
> clock node can't be defined 0.
> 
> Signed-off-by: Chunyan Zhang <zhang.chunyan@linaro.org>
> ---
>  Documentation/devicetree/bindings/clock/clock-bindings.txt | 10 ++++++++--
>  1 file changed, 8 insertions(+), 2 deletions(-)

I'm leaving this patch for Rob/DT maintainers to apply.

> 
> diff --git a/Documentation/devicetree/bindings/clock/clock-bindings.txt b/Documentation/devicetree/bindings/clock/clock-bindings.txt
> index 2ec489e..cef3db5 100644
> --- a/Documentation/devicetree/bindings/clock/clock-bindings.txt
> +++ b/Documentation/devicetree/bindings/clock/clock-bindings.txt
> @@ -15,8 +15,14 @@ value of a #clock-cells property in the clock provider node.
>  
>  Required properties:
>  #clock-cells:	   Number of cells in a clock specifier; Typically 0 for nodes
> -		   with a single clock output and 1 for nodes with multiple
> -		   clock outputs.
> +		   with a single clock output and it must be able to be
> +		   referenced without index, and 1 for nodes with single or
> +		   multiple clock outputs which have to be referenced by index.
> +
> +		   Please note that if a node with a single clock output
> +		   but it has "clock-indices" property (see bellow), it has
> +		   to be referenced by index, its "#clock-cells" cannot be
> +		   defined 0.

Maybe this should be added to the clock-indices area of the
document instead of here? It seems to me that you can't have
clock-indices if you have #clock-cells=<0>, and that's sort of
obvious because 0 cells means 1 output and >0 cells means
potentially many outputs.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/clock/clock-bindings.txt b/Documentation/devicetree/bindings/clock/clock-bindings.txt
index 2ec489e..cef3db5 100644
--- a/Documentation/devicetree/bindings/clock/clock-bindings.txt
+++ b/Documentation/devicetree/bindings/clock/clock-bindings.txt
@@ -15,8 +15,14 @@  value of a #clock-cells property in the clock provider node.
 
 Required properties:
 #clock-cells:	   Number of cells in a clock specifier; Typically 0 for nodes
-		   with a single clock output and 1 for nodes with multiple
-		   clock outputs.
+		   with a single clock output and it must be able to be
+		   referenced without index, and 1 for nodes with single or
+		   multiple clock outputs which have to be referenced by index.
+
+		   Please note that if a node with a single clock output
+		   but it has "clock-indices" property (see bellow), it has
+		   to be referenced by index, its "#clock-cells" cannot be
+		   defined 0.
 
 Optional properties:
 clock-output-names: Recommended to be a list of strings of clock output signal