[v6,1/8] Documentation: add sbsa-gwdt.txt documentation

Message ID 1435068994-13526-2-git-send-email-fu.wei@linaro.org
State New
Headers show

Commit Message

Fu Wei June 23, 2015, 2:16 p.m.
From: Fu Wei <fu.wei@linaro.org>

The sbsa-gwdt.txt documentation in devicetree/bindings/watchdog is for
introducing SBSA(Server Base System Architecture) Generic Watchdog
device node info into FDT.

Acked-by: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Fu Wei <fu.wei@linaro.org>
---
 .../devicetree/bindings/watchdog/sbsa-gwdt.txt     | 36 ++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt

Comments

Fu Wei July 14, 2015, 3:48 p.m. | #1
Hi Rob,

Great thanks for your review :-)

On 14 July 2015 at 22:49, Rob Herring <robherring2@gmail.com> wrote:
> On Tue, Jun 23, 2015 at 9:16 AM,  <fu.wei@linaro.org> wrote:
>> From: Fu Wei <fu.wei@linaro.org>
>>
>> The sbsa-gwdt.txt documentation in devicetree/bindings/watchdog is for
>> introducing SBSA(Server Base System Architecture) Generic Watchdog
>> device node info into FDT.
>>
>> Acked-by: Arnd Bergmann <arnd@arndb.de>
>> Signed-off-by: Fu Wei <fu.wei@linaro.org>
>> ---
>>  .../devicetree/bindings/watchdog/sbsa-gwdt.txt     | 36 ++++++++++++++++++++++
>>  1 file changed, 36 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
>>
>> diff --git a/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt b/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
>> new file mode 100644
>> index 0000000..010e5c4
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
>> @@ -0,0 +1,36 @@
>> +* SBSA(Server Base System Architecture) Generic Watchdog
>> +
>> +The SBSA Generic Watchdog Timer is used for resetting the system after
>> +two stages of timeout.
>> +More details: ARM-DEN-0029 - Server Base System Architecture (SBSA)
>> +
>> +Required properties:
>> +- compatible : Should at least contain "arm,sbsa-gwdt".
>> +
>> +- reg : base physical address of the frames and length of memory mapped region.
>
> This needs to specify the ordering of refresh and control.

In the FDT binding, Do we have to use ordering? Is the name always optional?
Sorry for questioning this, I just want to confirm that is a rule in
the FDT binding.
If that is a rule, would you let me know : where is it?

In my driver, I get these resource by name, but not ordering, for now

Thanks for your help :-)

>
>> +
>> +- reg-names : Should contain the resource reg names to show the order of
>> +  the values in "reg".
>> +  Must include the following entries : "refresh", "control".
>
> This should be optional.
>
>> +- interrupts : Should at least contain WS0 interrupt,
>> +  the WS1 Signal is optional.
>
> s/Signal/interrupt/ ?

yes, thanks,  will fix it.

>
>> +
>> +- interrupt-names : Should contain the resource interrupt names.
>> +  Must include the following entries : "ws0". "ws1" is optional.
>
> This should be optional.
>
>> +
>> +Optional properties
>> +- timeout-sec : Watchdog pre-timeout and timeout values (in seconds).
>> +       The first is timeout values, then pre-timeout.
>> +
>> +Example for FVP Foundation Model v8:
>> +
>> +watchdog@2a440000 {
>> +       compatible = "arm,sbsa-gwdt";
>> +       reg = <0x0 0x2a440000 0 0x1000>,
>> +             <0x0 0x2a450000 0 0x1000>;
>> +       reg-names = "control", "refresh";
>> +       interrupts = <0 27 4>;
>> +       interrupt-names = "ws0";
>> +       timeout-sec = <10 5>;
>> +};
>> --
>> 1.9.1
>>
>> --
>> To unsubscribe from this list: send the line "unsubscribe devicetree" in
>> the body of a message to majordomo@vger.kernel.org
>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
Fu Wei July 15, 2015, 12:52 p.m. | #2
Hi Rob,

I have got your point by chatting with you though IRC,
I will improve my patch according to your suggestion.

Thanks for your help.

On 14 July 2015 at 23:48, Fu Wei <fu.wei@linaro.org> wrote:
> Hi Rob,
>
> Great thanks for your review :-)
>
> On 14 July 2015 at 22:49, Rob Herring <robherring2@gmail.com> wrote:
>> On Tue, Jun 23, 2015 at 9:16 AM,  <fu.wei@linaro.org> wrote:
>>> From: Fu Wei <fu.wei@linaro.org>
>>>
>>> The sbsa-gwdt.txt documentation in devicetree/bindings/watchdog is for
>>> introducing SBSA(Server Base System Architecture) Generic Watchdog
>>> device node info into FDT.
>>>
>>> Acked-by: Arnd Bergmann <arnd@arndb.de>
>>> Signed-off-by: Fu Wei <fu.wei@linaro.org>
>>> ---
>>>  .../devicetree/bindings/watchdog/sbsa-gwdt.txt     | 36 ++++++++++++++++++++++
>>>  1 file changed, 36 insertions(+)
>>>  create mode 100644 Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
>>>
>>> diff --git a/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt b/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
>>> new file mode 100644
>>> index 0000000..010e5c4
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
>>> @@ -0,0 +1,36 @@
>>> +* SBSA(Server Base System Architecture) Generic Watchdog
>>> +
>>> +The SBSA Generic Watchdog Timer is used for resetting the system after
>>> +two stages of timeout.
>>> +More details: ARM-DEN-0029 - Server Base System Architecture (SBSA)
>>> +
>>> +Required properties:
>>> +- compatible : Should at least contain "arm,sbsa-gwdt".
>>> +
>>> +- reg : base physical address of the frames and length of memory mapped region.
>>
>> This needs to specify the ordering of refresh and control.
>
> In the FDT binding, Do we have to use ordering? Is the name always optional?
> Sorry for questioning this, I just want to confirm that is a rule in
> the FDT binding.
> If that is a rule, would you let me know : where is it?
>
> In my driver, I get these resource by name, but not ordering, for now
>
> Thanks for your help :-)
>
>>
>>> +
>>> +- reg-names : Should contain the resource reg names to show the order of
>>> +  the values in "reg".
>>> +  Must include the following entries : "refresh", "control".
>>
>> This should be optional.
>>
>>> +- interrupts : Should at least contain WS0 interrupt,
>>> +  the WS1 Signal is optional.
>>
>> s/Signal/interrupt/ ?
>
> yes, thanks,  will fix it.
>
>>
>>> +
>>> +- interrupt-names : Should contain the resource interrupt names.
>>> +  Must include the following entries : "ws0". "ws1" is optional.
>>
>> This should be optional.
>>
>>> +
>>> +Optional properties
>>> +- timeout-sec : Watchdog pre-timeout and timeout values (in seconds).
>>> +       The first is timeout values, then pre-timeout.
>>> +
>>> +Example for FVP Foundation Model v8:
>>> +
>>> +watchdog@2a440000 {
>>> +       compatible = "arm,sbsa-gwdt";
>>> +       reg = <0x0 0x2a440000 0 0x1000>,
>>> +             <0x0 0x2a450000 0 0x1000>;
>>> +       reg-names = "control", "refresh";
>>> +       interrupts = <0 27 4>;
>>> +       interrupt-names = "ws0";
>>> +       timeout-sec = <10 5>;
>>> +};
>>> --
>>> 1.9.1
>>>
>>> --
>>> To unsubscribe from this list: send the line "unsubscribe devicetree" in
>>> the body of a message to majordomo@vger.kernel.org
>>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>
>
>
> --
> Best regards,
>
> Fu Wei
> Software Engineer
> Red Hat Software (Beijing) Co.,Ltd.Shanghai Branch
> Ph: +86 21 61221326(direct)
> Ph: +86 186 2020 4684 (mobile)
> Room 1512, Regus One Corporate Avenue,Level 15,
> One Corporate Avenue,222 Hubin Road,Huangpu District,
> Shanghai,China 200021

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt b/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
new file mode 100644
index 0000000..010e5c4
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
@@ -0,0 +1,36 @@ 
+* SBSA(Server Base System Architecture) Generic Watchdog
+
+The SBSA Generic Watchdog Timer is used for resetting the system after
+two stages of timeout.
+More details: ARM-DEN-0029 - Server Base System Architecture (SBSA)
+
+Required properties:
+- compatible : Should at least contain "arm,sbsa-gwdt".
+
+- reg : base physical address of the frames and length of memory mapped region.
+
+- reg-names : Should contain the resource reg names to show the order of
+  the values in "reg".
+  Must include the following entries : "refresh", "control".
+
+- interrupts : Should at least contain WS0 interrupt,
+  the WS1 Signal is optional.
+
+- interrupt-names : Should contain the resource interrupt names.
+  Must include the following entries : "ws0". "ws1" is optional.
+
+Optional properties
+- timeout-sec : Watchdog pre-timeout and timeout values (in seconds).
+	The first is timeout values, then pre-timeout.
+
+Example for FVP Foundation Model v8:
+
+watchdog@2a440000 {
+	compatible = "arm,sbsa-gwdt";
+	reg = <0x0 0x2a440000 0 0x1000>,
+	      <0x0 0x2a450000 0 0x1000>;
+	reg-names = "control", "refresh";
+	interrupts = <0 27 4>;
+	interrupt-names = "ws0";
+	timeout-sec = <10 5>;
+};