2022-03-04 07:54:19

by hammer hsieh

[permalink] [raw]
Subject: [PATCH v2 1/2] dt-bindings:pwm:Add bindings doc for Sunplus SoC PWM Driver

Add bindings doc for Sunplus SoC PWM Driver

Signed-off-by: Hammer Hsieh <[email protected]>
---
Changes in v2:
- Addressed all comments from Rob Herring.
modify author's mail match Signed-off-by.
- rebase kernel to 5.17 rc5

.../devicetree/bindings/pwm/pwm-sunplus.yaml | 40 ++++++++++++++++++++++
MAINTAINERS | 5 +++
2 files changed, 45 insertions(+)
create mode 100644 Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml

diff --git a/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml b/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
new file mode 100644
index 0000000..19fe5d5
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
@@ -0,0 +1,40 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) Sunplus Co., Ltd. 2021
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pwm/pwm-sunplus.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Sunplus SoC PWM Controller
+
+maintainers:
+ - Hammer Hsieh <[email protected]>
+
+properties:
+ '#pwm-cells':
+ const: 2
+
+ compatible:
+ items:
+ - const: sunplus,sp7021-pwm
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ maxItems: 1
+
+required:
+ - reg
+ - clocks
+
+additionalProperties: false
+
+examples:
+ - |
+ pwm: pwm@9c007a00 {
+ #pwm-cells = <2>;
+ compatible = "sunplus,sp7021-pwm";
+ reg = <0x9c007a00 0x80>;
+ clocks = <&clkc 0xa2>;
+ };
diff --git a/MAINTAINERS b/MAINTAINERS
index 2524b75..825b714 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -18531,6 +18531,11 @@ L: [email protected]
S: Maintained
F: drivers/net/ethernet/dlink/sundance.c

+SUNPLUS PWM DRIVER
+M: Hammer Hsieh <[email protected]>
+S: Maintained
+F: Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
+
SUNPLUS RTC DRIVER
M: Vincent Shih <[email protected]>
L: [email protected]
--
2.7.4


2022-03-04 17:43:24

by Krzysztof Kozlowski

[permalink] [raw]
Subject: Re: [PATCH v2 1/2] dt-bindings:pwm:Add bindings doc for Sunplus SoC PWM Driver

On 04/03/2022 07:20, Hammer Hsieh wrote:
> Add bindings doc for Sunplus SoC PWM Driver

You miss spaces in the subject.

>
> Signed-off-by: Hammer Hsieh <[email protected]>
> ---
> Changes in v2:
> - Addressed all comments from Rob Herring.
> modify author's mail match Signed-off-by.
> - rebase kernel to 5.17 rc5
>
> .../devicetree/bindings/pwm/pwm-sunplus.yaml | 40 ++++++++++++++++++++++
> MAINTAINERS | 5 +++
> 2 files changed, 45 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
>
> diff --git a/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml b/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
> new file mode 100644
> index 0000000..19fe5d5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
> @@ -0,0 +1,40 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (C) Sunplus Co., Ltd. 2021
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pwm/pwm-sunplus.yaml#

Is it going to be one binding for all Sunplus SoCs? Existing and future?

> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Sunplus SoC PWM Controller
> +
> +maintainers:
> + - Hammer Hsieh <[email protected]>
> +

allOf with pwm.yaml
Then unevaluatedProperties instead of additionalProperties.


> +properties:
> + '#pwm-cells':
> + const: 2
> +
> + compatible:

Commpatible goes first. Rest of properties you could order
alphabetically. Similar approach in required.


> + items:
> + - const: sunplus,sp7021-pwm
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
> +
> +required:

compatible

> + - reg
> + - clocks


> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + pwm: pwm@9c007a00 {
> + #pwm-cells = <2>;
> + compatible = "sunplus,sp7021-pwm";

compatible goes first, then reg.


Best regards,
Krzysztof

2022-03-07 06:38:36

by hammer hsieh

[permalink] [raw]
Subject: Re: [PATCH v2 1/2] dt-bindings:pwm:Add bindings doc for Sunplus SoC PWM Driver

Krzysztof Kozlowski <[email protected]> 於 2022年3月4日 週五
下午11:01寫道:
>
> On 04/03/2022 07:20, Hammer Hsieh wrote:
> > Add bindings doc for Sunplus SoC PWM Driver
>
> You miss spaces in the subject.
>

ok, will modify it.

> >
> > Signed-off-by: Hammer Hsieh <[email protected]>
> > ---
> > Changes in v2:
> > - Addressed all comments from Rob Herring.
> > modify author's mail match Signed-off-by.
> > - rebase kernel to 5.17 rc5
> >
> > .../devicetree/bindings/pwm/pwm-sunplus.yaml | 40 ++++++++++++++++++++++
> > MAINTAINERS | 5 +++
> > 2 files changed, 45 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml b/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
> > new file mode 100644
> > index 0000000..19fe5d5
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
> > @@ -0,0 +1,40 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +# Copyright (C) Sunplus Co., Ltd. 2021
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/pwm/pwm-sunplus.yaml#
>
> Is it going to be one binding for all Sunplus SoCs? Existing and future?
>

yes, that was my first plan.
but not all sunplus SoCs use the same IP-based,
so I will change file name form 'pwm-sunplus.yaml' to
'sunplus,sp7021-pwm.yaml' in next patch.

> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Sunplus SoC PWM Controller
> > +
> > +maintainers:
> > + - Hammer Hsieh <[email protected]>
> > +
>
> allOf with pwm.yaml
> Then unevaluatedProperties instead of additionalProperties.
>

ok , will add it.

>
> > +properties:
> > + '#pwm-cells':
> > + const: 2
> > +
> > + compatible:
>
> Commpatible goes first. Rest of properties you could order
> alphabetically. Similar approach in required.
>
>

ok, will modify it.

> > + items:
> > + - const: sunplus,sp7021-pwm
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + clocks:
> > + maxItems: 1
> > +
> > +required:
>
> compatible
>
> > + - reg
> > + - clocks
>
>
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > + - |
> > + pwm: pwm@9c007a00 {
> > + #pwm-cells = <2>;
> > + compatible = "sunplus,sp7021-pwm";
>
> compatible goes first, then reg.
>

ok, will modify it.

>
> Best regards,
> Krzysztof

2022-03-07 09:30:30

by Krzysztof Kozlowski

[permalink] [raw]
Subject: Re: [PATCH v2 1/2] dt-bindings:pwm:Add bindings doc for Sunplus SoC PWM Driver

On 07/03/2022 05:18, hammer hsieh wrote:
> Krzysztof Kozlowski <[email protected]> 於 2022年3月4日 週五
> 下午11:01寫道:
>>
>> On 04/03/2022 07:20, Hammer Hsieh wrote:
>>> Add bindings doc for Sunplus SoC PWM Driver
>>
>> You miss spaces in the subject.
>>
>
> ok, will modify it.
>
>>>
>>> Signed-off-by: Hammer Hsieh <[email protected]>
>>> ---
>>> Changes in v2:
>>> - Addressed all comments from Rob Herring.
>>> modify author's mail match Signed-off-by.
>>> - rebase kernel to 5.17 rc5
>>>
>>> .../devicetree/bindings/pwm/pwm-sunplus.yaml | 40 ++++++++++++++++++++++
>>> MAINTAINERS | 5 +++
>>> 2 files changed, 45 insertions(+)
>>> create mode 100644 Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
>>>
>>> diff --git a/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml b/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
>>> new file mode 100644
>>> index 0000000..19fe5d5
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/pwm/pwm-sunplus.yaml
>>> @@ -0,0 +1,40 @@
>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>>> +# Copyright (C) Sunplus Co., Ltd. 2021
>>> +%YAML 1.2
>>> +---
>>> +$id: http://devicetree.org/schemas/pwm/pwm-sunplus.yaml#
>>
>> Is it going to be one binding for all Sunplus SoCs? Existing and future?
>>
>
> yes, that was my first plan.
> but not all sunplus SoCs use the same IP-based,
> so I will change file name form 'pwm-sunplus.yaml' to
> 'sunplus,sp7021-pwm.yaml' in next patch.

Yes, that might be better approach,



Best regards,
Krzysztof