Subject: [PATCH-v2 3/5] mfd: devicetree: bindings: Add clock subdevice node information

From: [email-masked] (Lee Jones)
Date: Tue, 25 Aug 2015 08:58:58 +0100

On Tue, 25 Aug 2015, Vaibhav Hiremath wrote:

> This patch updates the binding documentation for optional
> clocks node and related information for buffered 32KHz clock.
> 
> Signed-off-by: Vaibhav Hiremath <[email-masked]>
> Reviewed-by: Krzysztof Kozlowski <[email-masked]>
> Acked-by: Rob Herring <[email-masked]>
> ---
>  Documentation/devicetree/bindings/mfd/88pm800.txt | 27 +++++++++++++++++++++++
>  1 file changed, 27 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/mfd/88pm800.txt b/Documentation/devicetree/bindings/mfd/88pm800.txt
> index 2c82fcb..bc6cb02 100644
> --- a/Documentation/devicetree/bindings/mfd/88pm800.txt
> +++ b/Documentation/devicetree/bindings/mfd/88pm800.txt
> @@ -15,6 +15,26 @@ Optional properties :
>    Without this both BUCK1A and BUCK1B operates independently with 3A capacity.
>    (This property is only applicable to 88PM860)
>  
> +Optional nodes:
> +- clocks: 88pm800 family of devices provide multiple buffered 32.768
> +  KHz outputs, so to register these as clocks with common clock framework
> +  instantiate a sub-node named "clocks". It uses the common clock binding
> +  documented in :
> +  [Documentation/devicetree/bindings/clock/clock-bindings.txt]

I tend to prefer relative paths.  Firstly because they're shorter and
more succinct and secondly because if we do eventually move DT out of
the kernel, it will be less hassle to rename each of them.

> +  - #clock-cells: should be 1.
> +
> +  - The following is the list of clocks generated by the controller. Each clock
> +    is assigned an identifier and client nodes use this identifier to specify
> +    the clock which they consume.
> +    Clock		ID           	Devices
> +    ----------------------------------------------------------
> +    pm800_clk32k_1	0		88PM800 and 88PM860
> +    pm800_clk32k_2	1		88PM800 and 88PM860
> +    pm800_clk32k_3	2		88PM800
> +
> +  - compatible: Should be : "marvell,88pm800-clk"
> +
>  88pm80x family of devices consists of varied group of sub-devices:
>  
>  Device		 	Supply Names	 Description
> @@ -22,6 +42,7 @@ Device		 	Supply Names	 Description
>  88pm80x-onkey		:		: On key
>  88pm80x-rtc		:		: RTC
>  88pm80x-regulator	:		: Regulators
> +88pm80x-clk		:		: 32KHz Clk provider

Nit: Alphabetical?

>  Example:
>  
> @@ -33,6 +54,12 @@ Example:
>  		interrupt-controller;
>  		#interrupt-cells = <1>;
>  
> +		pm800clk: clocks {
> +			compatible = "marvell,88pm800-clk";
> +			#clock-cells = <1>;
> +			clock-output-names = "xx", "yy", "zz";
> +		};
> +
>  		regulators {
>  			compatible = "marvell,88pm80x-regulator";
>  

-- 
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org ? Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog