[PATCH] rtc: s3c: Document in binding that only s3c6410 needs a src clk

[PATCH] rtc: s3c: Document in binding that only s3c6410 needs a src clk

[Javier Martinez Canillas]

Commit 43f3408261a2 ("rtc: s3c: Document required clocks in the DT
binding") added to the S3C binding doc the required clocks needed
by the Real Time Clock but the S3C driver supports different HW IP
and only the s3c6410 needs a source clock.

Fix the DT binding explaning that the second clock is only needed
by this IP block and not for the others.

Reported-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
Fixes: 43f3408261a2 ("rtc: s3c: Document required clocks in the DT binding")
Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>

---
Hello,

The mentioned commit was picked by Rob Herring so this one has to go
through his tree again and not through the RTC tree to avoid conflicts.

Best regards,
Javier

 Documentation/devicetree/bindings/rtc/s3c-rtc.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/rtc/s3c-rtc.txt b/Documentation/devicetree/bindings/rtc/s3c-rtc.txt
index 1068ffce9f91..fdde63a5419c 100644
--- a/Documentation/devicetree/bindings/rtc/s3c-rtc.txt
+++ b/Documentation/devicetree/bindings/rtc/s3c-rtc.txt
@@ -15,9 +15,10 @@ Required properties:
   is the rtc tick interrupt. The number of cells representing a interrupt
   depends on the parent interrupt controller.
 - clocks: Must contain a list of phandle and clock specifier for the rtc
-          and source clocks.
-- clock-names: Must contain "rtc" and "rtc_src" entries sorted in the
-               same order as the clocks property.
+          clock and in the case of a s3c6410 compatible controller, also
+          a source clock.
+- clock-names: Must contain "rtc" and for a s3c6410 compatible controller,
+               a "rtc_src" sorted in the same order as the clocks property.
 
 Example:
 
-- 
2.5.0

Re: [PATCH] rtc: s3c: Document in binding that only s3c6410 needs a src clk

[Alexandre Belloni]

On 15/02/2016 at 10:16:42 -0300, Javier Martinez Canillas wrote :
> Commit 43f3408261a2 ("rtc: s3c: Document required clocks in the DT

I'm pretty sure you shouldn't refer to a commit that is in linux-next.

> binding") added to the S3C binding doc the required clocks needed
> by the Real Time Clock but the S3C driver supports different HW IP
> and only the s3c6410 needs a source clock.
> 
> Fix the DT binding explaning that the second clock is only needed
          explaining ^
> by this IP block and not for the others.
> 
> Reported-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
> Fixes: 43f3408261a2 ("rtc: s3c: Document required clocks in the DT binding")
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> 

Anyway, I'm fine with it, feel free to add my ack.

> ---
> Hello,
> 
> The mentioned commit was picked by Rob Herring so this one has to go
> through his tree again and not through the RTC tree to avoid conflicts.
> 
> Best regards,
> Javier
> 
>  Documentation/devicetree/bindings/rtc/s3c-rtc.txt | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/rtc/s3c-rtc.txt b/Documentation/devicetree/bindings/rtc/s3c-rtc.txt
> index 1068ffce9f91..fdde63a5419c 100644
> --- a/Documentation/devicetree/bindings/rtc/s3c-rtc.txt
> +++ b/Documentation/devicetree/bindings/rtc/s3c-rtc.txt
> @@ -15,9 +15,10 @@ Required properties:
>    is the rtc tick interrupt. The number of cells representing a interrupt
>    depends on the parent interrupt controller.
>  - clocks: Must contain a list of phandle and clock specifier for the rtc
> -          and source clocks.
> -- clock-names: Must contain "rtc" and "rtc_src" entries sorted in the
> -               same order as the clocks property.
> +          clock and in the case of a s3c6410 compatible controller, also
> +          a source clock.
> +- clock-names: Must contain "rtc" and for a s3c6410 compatible controller,
> +               a "rtc_src" sorted in the same order as the clocks property.
>  
>  Example:
>  
> -- 
> 2.5.0
> 

-- 
Alexandre Belloni, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

Re: [PATCH] rtc: s3c: Document in binding that only s3c6410 needs a src clk

[Javier Martinez Canillas]

Hello Alexandre,

On 02/15/2016 10:45 AM, Alexandre Belloni wrote:
> On 15/02/2016 at 10:16:42 -0300, Javier Martinez Canillas wrote :
>> Commit 43f3408261a2 ("rtc: s3c: Document required clocks in the DT
>
> I'm pretty sure you shouldn't refer to a commit that is in linux-next.
>

The commit comes from Rob's dt/linus branch that uses Linux 4.5-rc3 as
a base. I'm not a git expert but I thought that if the branch is not
rebased and used for the pull request then the resulting commit in
mainline would end with the same sha-1.

But I can remove the mention to the commit and "Fixes:" tag since the
commit is not yet in mainline, that should be more safe indeed.
  
>> binding") added to the S3C binding doc the required clocks needed
>> by the Real Time Clock but the S3C driver supports different HW IP
>> and only the s3c6410 needs a source clock.
>>
>> Fix the DT binding explaning that the second clock is only needed
>            explaining ^

Ok, I'll fix that typo.

>> by this IP block and not for the others.
>>
>> Reported-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
>> Fixes: 43f3408261a2 ("rtc: s3c: Document required clocks in the DT binding")
>> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
>>
>
> Anyway, I'm fine with it, feel free to add my ack.
>

Thanks, I'll add it in v2.
  
Best regards,
-- 
Javier Martinez Canillas
Open Source Group
Samsung Research America