[PATCH RFC net-next] net: stmmac: add documentation about clocks

[Andrew Lunn]

On Thu, Feb 05, 2026 at 06:30:37PM +0000, Russell King (Oracle) wrote:
> Add documentation covering stmmac_clk, pclk, clk_ptp_ref and clk_tx_i
> in the hope that this will help understand what each of these clocks
> are for.
> 
> There is confusion around stmmac_clk and pclk which can't be easily
> resolved today as the Imagination Technologies Pistachio board that
> pclk was introduced for has no public documentation and is likely now
> obsolete. So the origins of pclk are lost to the winds of time.
> 
> Signed-off-by: Russell King (Oracle) <rmk+kernel at armlinux.org.uk>
> ---
> 
> Is this worth documenting, despite the vagueness of stmmac_clk vs pclk?
> Too verbose? Or not sufficient information? What do people think?

I think it is worth documenting.

I also wounder how many DT authors will look here, and be able to
translate the named used here to what snps,dwmac.yaml has:

  clock-names:
    minItems: 1
    maxItems: 10
    additionalItems: true
    contains:
      enum:
        - stmmaceth
        - pclk
        - ptp_ref

Maybe it is worth repeating this as comments here?

      Andrew