On Fri, 2015-06-12 at 12:23 +0200, Thierry Reding wrote:
> On Thu, May 21, 2015 at 09:29:23PM +0800, YH Huang wrote:
> > Document the device-tree binding of MediatTek display PWM.
>
> s/MediatTek/MediaTek/
>
> >
> > Signed-off-by: YH Huang <yh.huang@xxxxxxxxxxxx>
>
> This could use a more verbose commit message. You could mention what the
> PWM is typically used for (display I presume). Perhaps mention how many
> channels it exposes and so on.
I will add more information in the commit message.
>
> > ---
> > .../devicetree/bindings/pwm/pwm-mtk-disp.txt | 25 ++++++++++++++++++++++
> > 1 file changed, 25 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/pwm/pwm-mtk-disp.txt
> >
> > diff --git a/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.txt b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.txt
> > new file mode 100644
> > index 0000000..f55bf92
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/pwm/pwm-mtk-disp.txt
> > @@ -0,0 +1,25 @@
> > +MediaTek display PWM controller
> > +
> > +Required properties:
> > + - compatible: should be "mediatek,<name>-disp-pwm"
> > + - "mediatek,mt8173-disp-pwm": found on mt8173 SoC
> > + - "mediatek,mt6595-disp-pwm": found on mt6595 SoC
> > + - reg: physical base address and length of the controller's registers
> > + - #pwm-cells: must be 2. See pwm.txt in this directory
> > + for a description of the cell format
>
> You can use the full line width of 78/80 characters, no need to wrap
> this prematurely.
OK.
>
> > + - clocks: phandle and clock specifier of the PWM reference clock
> > + - clock-names: must contain the following
> > + - "main": clock used to generate PWM signals
> > + - "mm": sync signals from the modules of mmsys
> > +
> > +Example:
> > + pwm0: pwm@1401e000 {
> > + compatible = "mediatek,mt8173-disp-pwm",
> > + "mediatek,mt6595-disp-pwm";
> > + reg = <0 0x1401e000 0 0x1000>;
> > + #pwm-cells = <2>;
> > + clocks = <&mmsys MM_DISP_PWM026M>,
> > + <&mmsys MM_DISP_PWM0MM>;
> > + clock-names = "main",
> > + "mm";
>
> No need to waste a line,
>
> clock-names = "main", "mm";
>
> fits on a single line just fine.
OK.
>
> Thierry
Thank for your suggestion.
Regards,
YH Huang
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
