mbox series

[0/6] Binding and driver for "dumb" clock generators

Message ID 20240709123121.1452394-1-heiko@sntech.de (mailing list archive)
Headers show
Series Binding and driver for "dumb" clock generators | expand

Message

Heiko Stuebner July 9, 2024, 12:31 p.m. UTC
Rockchip boards with PCIe3 controllers inside the soc (rk3568, rk3588) have
external clock generators on the board to generate the needed 100MHz
reference clock the PCIe3 controller needs.

Often these clock generators need supplies to be enabled to run.

Modelling this clock has taken a number of shapes:
- The rk3568 Rock-3a modelled the generator-regulator as "phy-supply" [0]
  &pcie30phy {
  	phy-supply = <&vcc3v3_pi6c_03>;
  	status = "okay";
  };
  which is of course not part of the binding

- On the Rock-5-ITX the supply of the clock generator is controlled by
  the same gpio as the regulator supplying the the port connected to the
  pcie30x4 controller, so if this controller probes first, both
  controllers will just run. But if the pcie30x2 controller probes first
  (which has a different supply), the controller will stall at the first
  dbi read.

- Recent Theobroma-Systems boards (Jaguar and Tiger) modelled their
  generator as a combination of fixed clock and gpio-gate, which works
  because the generator's vdd-supply is always on and only the output-
  enable pin needs to be toggled.


So this series attempts to improve the situation by allowing to model
these clock generators as actual entities in the devicetree, to not have
them just accidentially work or break bindings.


[0] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/arch/arm64/boot/dts/rockchip/rk3568-rock-3a.dts#n605

Heiko Stuebner (6):
  dt-bindings: clocks: add binding for generic clock-generators
  clk: add driver for generic clock generators
  arm64: dts: rockchip: fix the pcie clock generator on Rock 5 ITX
  arm64: dts: rockchip: use clock-generator for pcie-refclk on
    rk3588-jaguar
  arm64: dts: rockchip: use clock-generator for pcie-refclk on
    rk3588-tiger
  arm64: dts: rockchip: add pinctrl for clk-generator gpio on
    rk3588-tiger

 .../bindings/clock/clock-generator.yaml       |  62 ++++++++
 .../arm64/boot/dts/rockchip/rk3588-jaguar.dts |  13 +-
 .../boot/dts/rockchip/rk3588-rock-5itx.dts    |  34 ++++-
 .../arm64/boot/dts/rockchip/rk3588-tiger.dtsi |  21 +--
 drivers/clk/Kconfig                           |   7 +
 drivers/clk/Makefile                          |   1 +
 drivers/clk/clk-generator.c                   | 133 ++++++++++++++++++
 7 files changed, 251 insertions(+), 20 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/clock/clock-generator.yaml
 create mode 100644 drivers/clk/clk-generator.c

Comments

Anand Moon July 10, 2024, 3:02 a.m. UTC | #1
Hi Heiko,

On Tue, 9 Jul 2024 at 18:02, Heiko Stuebner <heiko@sntech.de> wrote:
>
> Rockchip boards with PCIe3 controllers inside the soc (rk3568, rk3588) have
> external clock generators on the board to generate the needed 100MHz
> reference clock the PCIe3 controller needs.
>
> Often these clock generators need supplies to be enabled to run.
>
> Modelling this clock has taken a number of shapes:
> - The rk3568 Rock-3a modelled the generator-regulator as "phy-supply" [0]
>   &pcie30phy {
>         phy-supply = <&vcc3v3_pi6c_03>;
>         status = "okay";
>   };
>   which is of course not part of the binding
>
> - On the Rock-5-ITX the supply of the clock generator is controlled by
>   the same gpio as the regulator supplying the the port connected to the
>   pcie30x4 controller, so if this controller probes first, both
>   controllers will just run. But if the pcie30x2 controller probes first
>   (which has a different supply), the controller will stall at the first
>   dbi read.
>
> - Recent Theobroma-Systems boards (Jaguar and Tiger) modelled their
>   generator as a combination of fixed clock and gpio-gate, which works
>   because the generator's vdd-supply is always on and only the output-
>   enable pin needs to be toggled.
>
>
> So this series attempts to improve the situation by allowing to model
> these clock generators as actual entities in the devicetree, to not have
> them just accidentially work or break bindings.
>

I was wondering if these changes apply to Radxa Rock 5b SbC, it does not have
pi6c557 clock generator but the schematic supports GEN_CLK_100MHZ is
input to CLKin0 which is generated via the VCC3V3_PI6C_05 (100MHz,3.3V,3225)
regulator.

[1] https://dl.radxa.com/rock5/5b/docs/hw/radxa_rock5b_v13_sch.pdf

Thanks
-Anand

>
> [0] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/arch/arm64/boot/dts/rockchip/rk3568-rock-3a.dts#n605
>
> Heiko Stuebner (6):
>   dt-bindings: clocks: add binding for generic clock-generators
>   clk: add driver for generic clock generators
>   arm64: dts: rockchip: fix the pcie clock generator on Rock 5 ITX
>   arm64: dts: rockchip: use clock-generator for pcie-refclk on
>     rk3588-jaguar
>   arm64: dts: rockchip: use clock-generator for pcie-refclk on
>     rk3588-tiger
>   arm64: dts: rockchip: add pinctrl for clk-generator gpio on
>     rk3588-tiger
>
>  .../bindings/clock/clock-generator.yaml       |  62 ++++++++
>  .../arm64/boot/dts/rockchip/rk3588-jaguar.dts |  13 +-
>  .../boot/dts/rockchip/rk3588-rock-5itx.dts    |  34 ++++-
>  .../arm64/boot/dts/rockchip/rk3588-tiger.dtsi |  21 +--
>  drivers/clk/Kconfig                           |   7 +
>  drivers/clk/Makefile                          |   1 +
>  drivers/clk/clk-generator.c                   | 133 ++++++++++++++++++
>  7 files changed, 251 insertions(+), 20 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/clock/clock-generator.yaml
>  create mode 100644 drivers/clk/clk-generator.c
>
> --
> 2.39.2
>
>
Heiko Stuebner July 10, 2024, 7:50 a.m. UTC | #2
Hi Anand,

Am Mittwoch, 10. Juli 2024, 05:02:57 CEST schrieb Anand Moon:
> On Tue, 9 Jul 2024 at 18:02, Heiko Stuebner <heiko@sntech.de> wrote:
> >
> > Rockchip boards with PCIe3 controllers inside the soc (rk3568, rk3588) have
> > external clock generators on the board to generate the needed 100MHz
> > reference clock the PCIe3 controller needs.
> >
> > Often these clock generators need supplies to be enabled to run.
> >
> > Modelling this clock has taken a number of shapes:
> > - The rk3568 Rock-3a modelled the generator-regulator as "phy-supply" [0]
> >   &pcie30phy {
> >         phy-supply = <&vcc3v3_pi6c_03>;
> >         status = "okay";
> >   };
> >   which is of course not part of the binding
> >
> > - On the Rock-5-ITX the supply of the clock generator is controlled by
> >   the same gpio as the regulator supplying the the port connected to the
> >   pcie30x4 controller, so if this controller probes first, both
> >   controllers will just run. But if the pcie30x2 controller probes first
> >   (which has a different supply), the controller will stall at the first
> >   dbi read.
> >
> > - Recent Theobroma-Systems boards (Jaguar and Tiger) modelled their
> >   generator as a combination of fixed clock and gpio-gate, which works
> >   because the generator's vdd-supply is always on and only the output-
> >   enable pin needs to be toggled.
> >
> >
> > So this series attempts to improve the situation by allowing to model
> > these clock generators as actual entities in the devicetree, to not have
> > them just accidentially work or break bindings.
> >
> 
> I was wondering if these changes apply to Radxa Rock 5b SbC, it does not have
> pi6c557 clock generator but the schematic supports GEN_CLK_100MHZ is
> input to CLKin0 which is generated via the VCC3V3_PI6C_05 (100MHz,3.3V,3225)
> regulator.

yes, that is the same setup as on the Rock 5 ITX, see it's patch in
this series.

The difference being that for your Rock 5b it already works by accident,
as the pcie30x4 port-supply and the supply for the clock-generator are
controlled by the same gpio.

So it does make sense to model this correctly for correctness sake, but
there is no immediate need for action, as there is no fault happening
like on the Rock 5 ITX with its two separate ports.


Heiko


> > [0] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/arch/arm64/boot/dts/rockchip/rk3568-rock-3a.dts#n605
> >
> > Heiko Stuebner (6):
> >   dt-bindings: clocks: add binding for generic clock-generators
> >   clk: add driver for generic clock generators
> >   arm64: dts: rockchip: fix the pcie clock generator on Rock 5 ITX
> >   arm64: dts: rockchip: use clock-generator for pcie-refclk on
> >     rk3588-jaguar
> >   arm64: dts: rockchip: use clock-generator for pcie-refclk on
> >     rk3588-tiger
> >   arm64: dts: rockchip: add pinctrl for clk-generator gpio on
> >     rk3588-tiger
> >
> >  .../bindings/clock/clock-generator.yaml       |  62 ++++++++
> >  .../arm64/boot/dts/rockchip/rk3588-jaguar.dts |  13 +-
> >  .../boot/dts/rockchip/rk3588-rock-5itx.dts    |  34 ++++-
> >  .../arm64/boot/dts/rockchip/rk3588-tiger.dtsi |  21 +--
> >  drivers/clk/Kconfig                           |   7 +
> >  drivers/clk/Makefile                          |   1 +
> >  drivers/clk/clk-generator.c                   | 133 ++++++++++++++++++
> >  7 files changed, 251 insertions(+), 20 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/clock/clock-generator.yaml
> >  create mode 100644 drivers/clk/clk-generator.c
> >
> > --
> > 2.39.2
> >
> >
>