Re: [PATCH 1/1] docs: dt: writing-bindings: Add exception for clock-names

[Frank Li <Frank.li@nxp.com>]

On Tue, Aug 26, 2025 at 06:55:19PM -0500, Rob Herring wrote:
> On Tue, Aug 26, 2025 at 11:16:49AM -0400, Frank Li wrote:
> > Allow pattern like "pclk" and "hclk" as clock-names.
> >
> > Signed-off-by: Frank Li <Frank.Li@nxp.com>
> > ---
> > https://lore.kernel.org/linux-i3c/20250625200451.GA2117971-robh@kernel.org/
> > ---
> >  Documentation/devicetree/bindings/writing-bindings.rst | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/devicetree/bindings/writing-bindings.rst b/Documentation/devicetree/bindings/writing-bindings.rst
> > index 667816dd7d504..81f76ca57a394 100644
> > --- a/Documentation/devicetree/bindings/writing-bindings.rst
> > +++ b/Documentation/devicetree/bindings/writing-bindings.rst
> > @@ -97,7 +97,8 @@ Typical cases and caveats
> >    constraints (e.g. list of items).
> >
> >  - For names used in {clock,dma,interrupt,reset}-names, do not add any suffix,
> > -  e.g.: "tx" instead of "txirq" (for interrupt).
> > +  e.g.: "tx" instead of "txirq" (for interrupt). Except when only single letter
> > +  remains after removing the suffix, e.g., 'pclk', 'hclk'.
>
> It's more that the examples are the hardware names for the clocks than
> a single letter is too terse.

Yes, some hardware signal use name pclk, look like [X]clk name also from
hardware. How to document it here? It breaks "do not add any suffix" and
this name is allowed.

Some hardware use quite long name like ipg-clk. just need ipg in binding.

Frank
>
> Rob