| Message ID | 6e5fb37472b916cb9d9abfbe3bea702d8d0d9737.1725536870.git.unicorn_wang@outlook.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | pwm: Add pwm driver for Sophgo SG2042 | expand |
On 20:10 Thu 05 Sep , Chen Wang wrote: > From: Chen Wang <unicorn_wang@outlook.com> > > Add binding document for sophgo,sg2042-pwm. > > Signed-off-by: Chen Wang <unicorn_wang@outlook.com> > --- > .../bindings/pwm/sophgo,sg2042-pwm.yaml | 52 +++++++++++++++++++ > 1 file changed, 52 insertions(+) > create mode 100644 Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml > > diff --git a/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml > new file mode 100644 > index 000000000000..10212694dd41 > --- /dev/null > +++ b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml > @@ -0,0 +1,52 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/pwm/sophgo,sg2042-pwm.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Sophgo SG2042 PWM controller > + > +maintainers: > + - Chen Wang <unicorn_wang@outlook.com> > + > +description: | you can drop | here > + This controller contains 4 channels which can generate PWM waveforms. > + > +allOf: > + - $ref: pwm.yaml# > + > +properties: > + compatible: > + const: sophgo,sg2042-pwm > + > + reg: > + maxItems: 1 > + > + clocks: > + maxItems: 1 > + > + clock-names: > + items: > + - const: apb > + > + "#pwm-cells": .. > + # See pwm.yaml in this directory for a description of the cells format. I think you can drop this comment, since no useful information added also it's already refered to standard pwm.yaml > + const: 2 > + > +required: > + - compatible > + - reg > + - clocks > + - clock-names also "#pwm-cells"? > + > +additionalProperties: false > + > +examples: > + - | > + pwm@7f006000 { > + compatible = "sophgo,sg2042-pwm"; > + reg = <0x7f006000 0x1000>; > + #pwm-cells = <2>; > + clocks = <&clock 67>; > + clock-names = "apb"; > + }; > -- > 2.34.1 >
On Thu, Sep 05, 2024 at 08:10:25PM +0800, Chen Wang wrote: > From: Chen Wang <unicorn_wang@outlook.com> > > Add binding document for sophgo,sg2042-pwm. A nit, subject: drop second/last, redundant "bindings for". The "dt-bindings" prefix is already stating that these are bindings. See also: https://elixir.bootlin.com/linux/v6.7-rc8/source/Documentation/devicetree/bindings/submitting-patches.rst#L18 Say something useful about hardware instead. The same in commit msg - you keep saying obvious and duplicated commit subject. > > Signed-off-by: Chen Wang <unicorn_wang@outlook.com> > --- > .../bindings/pwm/sophgo,sg2042-pwm.yaml | 52 +++++++++++++++++++ > 1 file changed, 52 insertions(+) > create mode 100644 Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml > > diff --git a/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml > new file mode 100644 > index 000000000000..10212694dd41 > --- /dev/null > +++ b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml > @@ -0,0 +1,52 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/pwm/sophgo,sg2042-pwm.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Sophgo SG2042 PWM controller > + > +maintainers: > + - Chen Wang <unicorn_wang@outlook.com> > + > +description: | drop | > + This controller contains 4 channels which can generate PWM waveforms. > + > +allOf: > + - $ref: pwm.yaml# > + > +properties: > + compatible: > + const: sophgo,sg2042-pwm > + > + reg: > + maxItems: 1 > + > + clocks: > + maxItems: 1 > + > + clock-names: > + items: > + - const: apb > + > + "#pwm-cells": > + # See pwm.yaml in this directory for a description of the cells format. Drop > + const: 2 > + > +required: > + - compatible > + - reg > + - clocks > + - clock-names > + > +additionalProperties: false unevaluatedProperties instead Best regards, Krzysztof
On 06/09/2024 04:44, Yixun Lan wrote: >> + >> +required: >> + - compatible >> + - reg >> + - clocks >> + - clock-names > also "#pwm-cells"? pwm.yaml has it? Best regards, Krzysztof
On 2024/9/6 10:44, Yixun Lan wrote: > On 20:10 Thu 05 Sep , Chen Wang wrote: >> From: Chen Wang <unicorn_wang@outlook.com> >> >> Add binding document for sophgo,sg2042-pwm. >> >> Signed-off-by: Chen Wang <unicorn_wang@outlook.com> >> --- >> .../bindings/pwm/sophgo,sg2042-pwm.yaml | 52 +++++++++++++++++++ >> 1 file changed, 52 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml >> >> diff --git a/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml >> new file mode 100644 >> index 000000000000..10212694dd41 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml >> @@ -0,0 +1,52 @@ >> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) >> +%YAML 1.2 >> +--- >> +$id: http://devicetree.org/schemas/pwm/sophgo,sg2042-pwm.yaml# >> +$schema: http://devicetree.org/meta-schemas/core.yaml# >> + >> +title: Sophgo SG2042 PWM controller >> + >> +maintainers: >> + - Chen Wang <unicorn_wang@outlook.com> >> + >> +description: | > you can drop | here Ack and thanks. >> + This controller contains 4 channels which can generate PWM waveforms. >> + >> +allOf: >> + - $ref: pwm.yaml# >> + >> +properties: >> + compatible: >> + const: sophgo,sg2042-pwm >> + >> + reg: >> + maxItems: 1 >> + >> + clocks: >> + maxItems: 1 >> + >> + clock-names: >> + items: >> + - const: apb >> + >> + "#pwm-cells": > .. >> + # See pwm.yaml in this directory for a description of the cells format. > I think you can drop this comment, since no useful information added > also it's already refered to standard pwm.yaml I add this comment just want to reminder. Ok, anyway, it can be removed to make doc clear. >> + const: 2 >> + >> +required: >> + - compatible >> + - reg >> + - clocks >> + - clock-names > also "#pwm-cells"? I think it has been required in pwm.yaml, so no need to required it again here. >> + >> +additionalProperties: false >> + >> +examples: >> + - | >> + pwm@7f006000 { >> + compatible = "sophgo,sg2042-pwm"; >> + reg = <0x7f006000 0x1000>; >> + #pwm-cells = <2>; >> + clocks = <&clock 67>; >> + clock-names = "apb"; >> + }; >> -- >> 2.34.1 >>
On 2024/9/6 18:31, Krzysztof Kozlowski wrote: > On Thu, Sep 05, 2024 at 08:10:25PM +0800, Chen Wang wrote: >> From: Chen Wang <unicorn_wang@outlook.com> >> >> Add binding document for sophgo,sg2042-pwm. > A nit, subject: drop second/last, redundant "bindings for". The > "dt-bindings" prefix is already stating that these are bindings. > See also: > https://elixir.bootlin.com/linux/v6.7-rc8/source/Documentation/devicetree/bindings/submitting-patches.rst#L18 > > Say something useful about hardware instead. The same in commit msg - > you keep saying obvious and duplicated commit subject. OK, thanks >> Signed-off-by: Chen Wang <unicorn_wang@outlook.com> >> --- >> .../bindings/pwm/sophgo,sg2042-pwm.yaml | 52 +++++++++++++++++++ >> 1 file changed, 52 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml >> >> diff --git a/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml >> new file mode 100644 >> index 000000000000..10212694dd41 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml >> @@ -0,0 +1,52 @@ >> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) >> +%YAML 1.2 >> +--- >> +$id: http://devicetree.org/schemas/pwm/sophgo,sg2042-pwm.yaml# >> +$schema: http://devicetree.org/meta-schemas/core.yaml# >> + >> +title: Sophgo SG2042 PWM controller >> + >> +maintainers: >> + - Chen Wang <unicorn_wang@outlook.com> >> + >> +description: | > drop | Ack and thansk. >> + This controller contains 4 channels which can generate PWM waveforms. >> + >> +allOf: >> + - $ref: pwm.yaml# >> + >> +properties: >> + compatible: >> + const: sophgo,sg2042-pwm >> + >> + reg: >> + maxItems: 1 >> + >> + clocks: >> + maxItems: 1 >> + >> + clock-names: >> + items: >> + - const: apb >> + >> + "#pwm-cells": >> + # See pwm.yaml in this directory for a description of the cells format. > Drop Ack and thanks. >> + const: 2 >> + >> +required: >> + - compatible >> + - reg >> + - clocks >> + - clock-names >> + >> +additionalProperties: false > unevaluatedProperties instead Yes, my mistake, thanks. > Best regards, > Krzysztof >
diff --git a/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml new file mode 100644 index 000000000000..10212694dd41 --- /dev/null +++ b/Documentation/devicetree/bindings/pwm/sophgo,sg2042-pwm.yaml @@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/pwm/sophgo,sg2042-pwm.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Sophgo SG2042 PWM controller + +maintainers: + - Chen Wang <unicorn_wang@outlook.com> + +description: | + This controller contains 4 channels which can generate PWM waveforms. + +allOf: + - $ref: pwm.yaml# + +properties: + compatible: + const: sophgo,sg2042-pwm + + reg: + maxItems: 1 + + clocks: + maxItems: 1 + + clock-names: + items: + - const: apb + + "#pwm-cells": + # See pwm.yaml in this directory for a description of the cells format. + const: 2 + +required: + - compatible + - reg + - clocks + - clock-names + +additionalProperties: false + +examples: + - | + pwm@7f006000 { + compatible = "sophgo,sg2042-pwm"; + reg = <0x7f006000 0x1000>; + #pwm-cells = <2>; + clocks = <&clock 67>; + clock-names = "apb"; + };