[PATCH v2 0/7] Add generic PHY driver used by MACB/GEM on EyeQ5

Théo Lebrun posted 7 patches 3 months, 1 week ago
There is a newer version of this series
.../bindings/soc/mobileye/mobileye,eyeq5-olb.yaml  |   7 +-
MAINTAINERS                                        |   1 +
arch/mips/boot/dts/mobileye/eyeq5-epm5.dts         |  26 +++
arch/mips/boot/dts/mobileye/eyeq5.dtsi             |  45 ++++
drivers/clk/clk-eyeq.c                             |  60 ++---
drivers/phy/Kconfig                                |  13 ++
drivers/phy/Makefile                               |   1 +
drivers/phy/phy-eyeq5-eth.c                        | 254 +++++++++++++++++++++
drivers/reset/reset-eyeq.c                         |  24 +-
9 files changed, 363 insertions(+), 68 deletions(-)
[PATCH v2 0/7] Add generic PHY driver used by MACB/GEM on EyeQ5
Posted by Théo Lebrun 3 months, 1 week ago
EyeQ5 SoCs integrate two GEM instances. A system-controller register
region named "OLB" has some control over the Ethernet PHY integration.

Past iterations [0] touched those syscon registers directly from MACB.
It was a bad idea. Extend the current OLB ecosystem with a new generic
PHY driver.
 - OLB is carried by one main platform driver: clk-eyeq.
 - It instantiates auxiliary devices: reset-eyeq & pinctrl-eyeq5.
 - We add a new one: phy-eyeq5-eth.

Here is a DT overview:

   olb: system-controller@e00000 {
           compatible = "mobileye,eyeq5-olb", "syscon";
           reg = <0 0xe00000 0x0 0x400>;
           // ...
           #reset-cells = <2>;
           #clock-cells = <1>;
           #phy-cells = <1>; // <= this is new
   };

   macb0: ethernet@2a00000 {
           compatible = "mobileye,eyeq5-gem";
           phys = <&olb 0>; // <= GEM device consumes the PHY
           // ...
   };

   macb1: ethernet@2b00000 {
           compatible = "mobileye,eyeq5-gem";
           phys = <&olb 1>; // <= same thing for the second instance
           // ...
   };

The Linux MACB driver already consumes a generic PHY for some other
compatibles, this is nothing new. The MACB series [1] has been merged
into net-next/main.

--

One topic to talk about: the whole "we must assign child->of_node
manually". Auxiliary driver core does not do it automatically, so
either the parent (clk-eyeq) or the children must do it.

In OLB land, until now, children were doing it with a
device_set_of_node_from_dev(dev, dev->parent) call in probe.

Recently, Jerome Brunet added devm_auxiliary_device_create():
eaa0d30216c1 ("driver core: auxiliary bus: add device creation
helpers"). Using that cleans up clk-eyeq but means we must remove
device_set_of_node_from_dev() from reset-eyeq in the same patch series,
as the helpers do the dev->of_node assignement from the parent driver.

That explains why the ideal patch:
[PATCH 4/7] clk: eyeq: add EyeQ5 children auxiliary device for generic PHYs
Turned into those three:
[PATCH 3/7] clk: eyeq: use the auxiliary device creation helper
[PATCH 4/7] clk: eyeq: add EyeQ5 children auxiliary device for generic PHYs
[PATCH 5/7] reset: eyeq: drop device_set_of_node_from_dev() done by parent

--

About merging, it'll probably be complex. I see no build dependencies,
but the board will be in an odd state if only some patches are applied.
Some dev_warn() at boot and dev->of_node refcounting issues at unload.

 - [PATCH 1/7] dt-bindings: soc: mobileye: OLB is an Ethernet PHY provider on EyeQ5
   We touch dt-bindings because OLB becomes a PHY provider.
   => linux-mips (?)

 - [PATCH 2/7] phy: Add driver for EyeQ5 Ethernet PHY wrapper
   We add the generic PHY driver in drivers/phy/phy-eyeq5-eth.c with the
   usual Kconfig, Makefile and MAINTAINERS changes.
   => linux-phy (?)

 - [PATCH 6/7] MIPS: mobileye: eyeq5: add two Cadence GEM Ethernet controllers
   [PATCH 7/7] MIPS: mobileye: eyeq5-epm: add two Cadence GEM Ethernet PHYs
   DTS patches to add both the #phy-cells of OLB and the MACB instances.
   => linux-mips

 - [PATCH 4/7] clk: eyeq: add EyeQ5 children auxiliary device for generic PHYs
   We must update clk-eyeq because it instantiates a new auxdev.
   => linux-clk

 - [PATCH 3/7] clk: eyeq: use the auxiliary device creation helper
   [PATCH 5/7] reset: eyeq: drop device_set_of_node_from_dev() done by parent
   With the dev->of_node assignement, we must also correct reset-eyeq.
   => separate them into linux-clk and linux-reset?

Have a nice day,
Thanks,
Théo

[0]: https://lore.kernel.org/lkml/20250627-macb-v2-15-ff8207d0bb77@bootlin.com/
[1]: https://lore.kernel.org/lkml/20251022-macb-eyeq5-v2-0-7c140abb0581@bootlin.com/
[2]: https://lore.kernel.org/all/20251021-macb-eyeq5-v1-0-3b0b5a9d2f85@bootlin.com/

Signed-off-by: Théo Lebrun <theo.lebrun@bootlin.com>
---
Changes in v2:
- Take Acked-by: Conor Dooley on dt-bindings-patch.
- s/%ld/%tu/ for printing ptrdiff_t; warnings on 32-bit archs.
  Reported by NIPA's netdev/build_32bit test.
  https://patchwork.kernel.org/project/netdevbpf/patch/20251021-macb-eyeq5-v1-7-3b0b5a9d2f85@bootlin.com/
  https://netdev.bots.linux.dev/static/nipa/1014126/14277857/build_32bit/stderr
- Link to v1: https://lore.kernel.org/r/20251022-macb-phy-v1-0-f29f28fae721@bootlin.com

Changes since MACB V1:
- Drop the old "mobileye,olb" properties from DT patches; found while
  running dtbs_check and dt_binding_check.
- Drop all patches targeting net-next. That is MACB dt-bindings patch
  and MACB driver code. See there here [1].
- Link to v1: https://lore.kernel.org/lkml/20251021-macb-eyeq5-v1-0-3b0b5a9d2f85@bootlin.com/

Past versions of MACB patches:
 - March 2025: [PATCH net-next 00/13] Support the Cadence MACB/GEM
   instances on Mobileye EyeQ5 SoCs
   https://lore.kernel.org/lkml/20250321-macb-v1-0-537b7e37971d@bootlin.com/
 - June 2025: [PATCH net-next v2 00/18] Support the Cadence MACB/GEM
   instances on Mobileye EyeQ5 SoCs
   https://lore.kernel.org/lkml/20250627-macb-v2-0-ff8207d0bb77@bootlin.com/
 - August 2025: [PATCH net v3 00/16] net: macb: various fixes & cleanup
   https://lore.kernel.org/lkml/20250808-macb-fixes-v3-0-08f1fcb5179f@bootlin.com/

---
Jerome Brunet (1):
      clk: eyeq: use the auxiliary device creation helper

Théo Lebrun (6):
      dt-bindings: soc: mobileye: OLB is an Ethernet PHY provider on EyeQ5
      phy: Add driver for EyeQ5 Ethernet PHY wrapper
      clk: eyeq: add EyeQ5 children auxiliary device for generic PHYs
      reset: eyeq: drop device_set_of_node_from_dev() done by parent
      MIPS: mobileye: eyeq5: add two Cadence GEM Ethernet controllers
      MIPS: mobileye: eyeq5-epm: add two Cadence GEM Ethernet PHYs

 .../bindings/soc/mobileye/mobileye,eyeq5-olb.yaml  |   7 +-
 MAINTAINERS                                        |   1 +
 arch/mips/boot/dts/mobileye/eyeq5-epm5.dts         |  26 +++
 arch/mips/boot/dts/mobileye/eyeq5.dtsi             |  45 ++++
 drivers/clk/clk-eyeq.c                             |  60 ++---
 drivers/phy/Kconfig                                |  13 ++
 drivers/phy/Makefile                               |   1 +
 drivers/phy/phy-eyeq5-eth.c                        | 254 +++++++++++++++++++++
 drivers/reset/reset-eyeq.c                         |  24 +-
 9 files changed, 363 insertions(+), 68 deletions(-)
---
base-commit: 01cc760632b875c4ad0d8fec0b0c01896b8a36d4
change-id: 20251022-macb-phy-21bc4e1dfbb7

Best regards,
-- 
Théo Lebrun <theo.lebrun@bootlin.com>

Re: [PATCH v2 0/7] Add generic PHY driver used by MACB/GEM on EyeQ5
Posted by Philipp Zabel 3 months ago
On Sa, 2025-11-01 at 09:53 +0100, Théo Lebrun wrote:
> EyeQ5 SoCs integrate two GEM instances. A system-controller register
> region named "OLB" has some control over the Ethernet PHY integration.
> 
> Past iterations [0] touched those syscon registers directly from MACB.
> It was a bad idea. Extend the current OLB ecosystem with a new generic
> PHY driver.
>  - OLB is carried by one main platform driver: clk-eyeq.
>  - It instantiates auxiliary devices: reset-eyeq & pinctrl-eyeq5.
>  - We add a new one: phy-eyeq5-eth.
> 
> Here is a DT overview:
> 
>    olb: system-controller@e00000 {
>            compatible = "mobileye,eyeq5-olb", "syscon";
>            reg = <0 0xe00000 0x0 0x400>;
>            // ...
>            #reset-cells = <2>;
>            #clock-cells = <1>;
>            #phy-cells = <1>; // <= this is new
>    };
> 
>    macb0: ethernet@2a00000 {
>            compatible = "mobileye,eyeq5-gem";
>            phys = <&olb 0>; // <= GEM device consumes the PHY
>            // ...
>    };
> 
>    macb1: ethernet@2b00000 {
>            compatible = "mobileye,eyeq5-gem";
>            phys = <&olb 1>; // <= same thing for the second instance
>            // ...
>    };
> 
> The Linux MACB driver already consumes a generic PHY for some other
> compatibles, this is nothing new. The MACB series [1] has been merged
> into net-next/main.
> 
> --
> 
> One topic to talk about: the whole "we must assign child->of_node
> manually". Auxiliary driver core does not do it automatically, so
> either the parent (clk-eyeq) or the children must do it.
> 
> In OLB land, until now, children were doing it with a
> device_set_of_node_from_dev(dev, dev->parent) call in probe.
> 
> Recently, Jerome Brunet added devm_auxiliary_device_create():
> eaa0d30216c1 ("driver core: auxiliary bus: add device creation
> helpers"). Using that cleans up clk-eyeq but means we must remove
> device_set_of_node_from_dev() from reset-eyeq in the same patch series,
> as the helpers do the dev->of_node assignement from the parent driver.
> 
> That explains why the ideal patch:
> [PATCH 4/7] clk: eyeq: add EyeQ5 children auxiliary device for generic PHYs
> Turned into those three:
> [PATCH 3/7] clk: eyeq: use the auxiliary device creation helper
> [PATCH 4/7] clk: eyeq: add EyeQ5 children auxiliary device for generic PHYs
> [PATCH 5/7] reset: eyeq: drop device_set_of_node_from_dev() done by parent
> 
> --
> 
> About merging, it'll probably be complex. I see no build dependencies,
> but the board will be in an odd state if only some patches are applied.
> Some dev_warn() at boot and dev->of_node refcounting issues at unload.
> 
>  - [PATCH 1/7] dt-bindings: soc: mobileye: OLB is an Ethernet PHY provider on EyeQ5
>    We touch dt-bindings because OLB becomes a PHY provider.
>    => linux-mips (?)
> 
>  - [PATCH 2/7] phy: Add driver for EyeQ5 Ethernet PHY wrapper
>    We add the generic PHY driver in drivers/phy/phy-eyeq5-eth.c with the
>    usual Kconfig, Makefile and MAINTAINERS changes.
>    => linux-phy (?)
> 
>  - [PATCH 6/7] MIPS: mobileye: eyeq5: add two Cadence GEM Ethernet controllers
>    [PATCH 7/7] MIPS: mobileye: eyeq5-epm: add two Cadence GEM Ethernet PHYs
>    DTS patches to add both the #phy-cells of OLB and the MACB instances.
>    => linux-mips
> 
>  - [PATCH 4/7] clk: eyeq: add EyeQ5 children auxiliary device for generic PHYs
>    We must update clk-eyeq because it instantiates a new auxdev.
>    => linux-clk
> 
>  - [PATCH 3/7] clk: eyeq: use the auxiliary device creation helper
>    [PATCH 5/7] reset: eyeq: drop device_set_of_node_from_dev() done by parent
>    With the dev->of_node assignement, we must also correct reset-eyeq.
>    => separate them into linux-clk and linux-reset?

Since 3 and 4 should go via clk, and 5 has a dependency on 3, I would
suggest merging them all together.

regards
Philipp
Re: [PATCH v2 0/7] Add generic PHY driver used by MACB/GEM on EyeQ5
Posted by Théo Lebrun 3 months ago
On Thu Nov 6, 2025 at 11:51 AM CET, Philipp Zabel wrote:
> On Sa, 2025-11-01 at 09:53 +0100, Théo Lebrun wrote:
>> About merging, it'll probably be complex. I see no build dependencies,
>> but the board will be in an odd state if only some patches are applied.
>> Some dev_warn() at boot and dev->of_node refcounting issues at unload.
>> 
>>  - [PATCH 1/7] dt-bindings: soc: mobileye: OLB is an Ethernet PHY provider on EyeQ5
>>    We touch dt-bindings because OLB becomes a PHY provider.
>>    => linux-mips (?)
>> 
>>  - [PATCH 2/7] phy: Add driver for EyeQ5 Ethernet PHY wrapper
>>    We add the generic PHY driver in drivers/phy/phy-eyeq5-eth.c with the
>>    usual Kconfig, Makefile and MAINTAINERS changes.
>>    => linux-phy (?)
>> 
>>  - [PATCH 6/7] MIPS: mobileye: eyeq5: add two Cadence GEM Ethernet controllers
>>    [PATCH 7/7] MIPS: mobileye: eyeq5-epm: add two Cadence GEM Ethernet PHYs
>>    DTS patches to add both the #phy-cells of OLB and the MACB instances.
>>    => linux-mips
>> 
>>  - [PATCH 4/7] clk: eyeq: add EyeQ5 children auxiliary device for generic PHYs
>>    We must update clk-eyeq because it instantiates a new auxdev.
>>    => linux-clk
>> 
>>  - [PATCH 3/7] clk: eyeq: use the auxiliary device creation helper
>>    [PATCH 5/7] reset: eyeq: drop device_set_of_node_from_dev() done by parent
>>    With the dev->of_node assignement, we must also correct reset-eyeq.
>>    => separate them into linux-clk and linux-reset?
>
> Since 3 and 4 should go via clk, and 5 has a dependency on 3, I would
> suggest merging them all together.

Thanks for the feedback Philipp, and the review on [5/7]. Getting it
merged in linux-clk will ease the process and avoid breakage. Updated
summary:

 - [PATCH 1/7] dt-bindings: soc: mobileye: OLB is an Ethernet PHY provider on EyeQ5
   [PATCH 6/7] MIPS: mobileye: eyeq5: add two Cadence GEM Ethernet controllers
   [PATCH 7/7] MIPS: mobileye: eyeq5-epm: add two Cadence GEM Ethernet PHYs
   => linux-mips

 - [PATCH 2/7] phy: Add driver for EyeQ5 Ethernet PHY wrapper
   => linux-phy

 - [PATCH 3/7] clk: eyeq: use the auxiliary device creation helper
   [PATCH 4/7] clk: eyeq: add EyeQ5 children auxiliary device for generic PHYs
   [PATCH 5/7] reset: eyeq: drop device_set_of_node_from_dev() done by parent
   => linux-clk

I might send V3 soon, with your trailers appended.

Thanks,

--
Théo Lebrun, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com