Skip to content

net: pcs: Introduce support for fwnode PCS

Christian Marangi linux-arm-kernel linux-devicetree linux-doc linux-mediatek lkml llvm netdev 22 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v22 Latest15 patches 1 replyIn review
  2. v2115 patches 1 replySuperseded
  3. v2015 patches 1 replySuperseded
Earlier versions · 19
VersionPostedPatchesRepliesStatus
v1915 patches2 repliesSuperseded
v1812 patches0 repliesSuperseded
v1712 patches0 repliesSuperseded
v1612 patches9 repliesSuperseded
v1512 patches5 repliesSuperseded
v1412 patches3 repliesSuperseded
v1312 patches1 replySuperseded
v1212 patches3 repliesSuperseded
v1112 patches9 repliesSuperseded
v1011 patches3 repliesSuperseded
v912 patches11 repliesSuperseded
v8 RFC12 patches7 repliesSuperseded
v712 patches11 repliesSuperseded
v612 patches4 repliesSuperseded
v5 RFC10 patches2 repliesSuperseded
v411 patches17 repliesSuperseded
v311 patches1 replySuperseded
v2 RFC11 patches1 replySuperseded
v16 patches23 repliesSuperseded

Changes in v22 from the cover letter

- Rebase on top of net-next (no idea why patchwork reported failed to apply...) Changes v21:
- Add fixes tag for the RCU patch
- Preserve user-disabled ethtool advertising during capability updates and SFP interface selection.
- Add additional kconfig select for Airoha PCS and Airoha Ethernet
- Fix wrong rcu_assign_pointer NULL in RCU patch
- Use "pcs-handle-names" as already defined (instead of "pcs-names")
- Skip phylink_pcs_disable if already disabled
- Skip phylink_major_config if phylink disabled
- Better handle capabilites from phylink_parse_mode and phylink_parse_fixedlink
- Set link_failed on late attach so that resolve is triggered 2 times
- Improve description of fwnode_pcs_get_from_provider()
- Improve capabilities tracking for PHY and SFP scenario
- Add variant for __phy_get_rate_matching

Patches in v22 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/15net: phylink: make PCS phylink instance access RCU protecteddrivers/net/phy/phylink.c include/linux/phylink.h+15 -40 replies
2/15net: phylink: keep and use MAC supported_interfaces in phylink structdrivers/net/phy/phylink.c+16 -80 replies
3/15net: phylink: introduce internal phylink PCS handlingdrivers/net/phy/phylink.c include/linux/phylink.h+196 -210 replies
4/15net: pcs: implement Firmware node support for PCS driverdrivers/net/pcs/Kconfig drivers/net/pcs/Makefile drivers/net/pcs/pcs.c +2 more+396 -00 replies
5/15net: phylink: save phylink instance fwnode on phylink_createdrivers/net/phy/phylink.c+5 -00 replies
6/15net: phylink: make phylink_validate state lockeddrivers/net/phy/phy-internal.h drivers/net/phy/phy.c drivers/net/phy/phylink.c+79 -160 replies
7/15net: phylink: add capabilities helpers and track modified advertisingdrivers/net/phy/phylink.c+397 -2100 replies
8/15net: phylink: support PCS provider releasedrivers/net/pcs/pcs.c drivers/net/phy/phylink.c include/linux/pcs/pcs.h+289 -300 replies
9/15net: phylink: support late PCS provider attachdrivers/net/pcs/pcs.c drivers/net/phy/phylink.c include/linux/pcs/pcs.h+141 -220 replies
10/15net: Document PCS subsystemDocumentation/networking/index.rst Documentation/networking/pcs.rst Documentation/networking/sfp-phylink.rst+243 -240 replies
11/15MAINTAINERS: add myself as PCS subsystem maintainerMAINTAINERS+9 -00 replies
12/15net: phylink: add .pcs_link_down PCS OPdrivers/net/phy/phylink.c include/linux/phylink.h+21 -00 replies
13/15dt-bindings: net: pcs: Document support for Airoha Ethernet PCSDocumentation/devicetree/bindings/net/pcs/airoha,pcs.yaml+261 -00 replies
14/15net: pcs: airoha: add PCS driver for Airoha AN7581 SoCdrivers/net/pcs/Kconfig drivers/net/pcs/Makefile drivers/net/pcs/airoha/Kconfig +4 more+4748 -00 replies
15/15net: airoha: add phylink supportdrivers/net/ethernet/airoha/Kconfig drivers/net/ethernet/airoha/airoha_eth.c drivers/net/ethernet/airoha/airoha_eth.h +1 more+213 -30 replies

Reviews trailers per patch

4 of 15 patches have a Reviewed-by or Acked-by.

PatchMaxime ChevallierRob Herring (Arm)Zhengping ZhangLorenzo Bianconi
1/15
2/15T-b R-b
3/15
4/15
5/15
6/15
7/15
8/15
9/15
10/15
11/15
12/15R-b
13/15R-b
14/15
15/15T-b A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 4 reviewers.

Read the v22 thread

Cover letter [PATCH net-next v22 00/15] net: pcs: Introduce support for fwnode PCS

This series introduce a most awaited feature that is correctly provide PCS with fwnode without having to use specific export symbol and additional handling of PCS in phylink.

At times there were 2 different implementation (this and the one from Sean) but Sean agreed that this can be picked and used in favor of his implementation as long as his case with race condition is correctly handled.

---
First the PCS fwnode:

The concept is to implement a producer-consumer API similar to other subsystem like clock or PHY.

That seems to be the best solution to the problem as PCS driver needs to be detached from phylink and implement a simple way to provide a PCS while maintaining support for probe defer or driver removal.

To keep the implementation simple, the PCS driver devs needs some collaboration to correctly implement this. This is O.K. as helper to correctly implement this are provided hence it's really a matter of following a pattern to correct follow removal of a PCS driver.

A PCS provider have to implement and call fwnode_pcs_add_provider() in probe function and define an xlate function to define how the PCS should be provided based on the requested interface and phandle spec defined in fwnode (based on the #pcs-cells)

fwnode_pcs_get() is provided to provide a specific PCS declared in fwnode at index.

A simple xlate function is provided for simple single PCS implementation, fwnode_pcs_simple_xlate.

A PCS provider on driver removal must call fwnode_pcs_del_provider() to delete itself as a provider.

---
Second PCS handling in phylink:

We have the PCS problem for the only reason that in initial implementation, we permitted way too much flexibility to MAC driver and things started to deviate. At times we couldn't think SoC would start to put PCS outside the MAC hence it was OK to assume they would live in the same driver. With the introduction of 10g in more consumer devices, we are observing a rapid growth of this pattern with multiple PCS external to MAC.

To put a stop on this, the only solution is to give back to phylink control on PCS handling and enforce more robust supported interface definition from both MAC and PCS side.

It's suggested to read patch 0003 of this series for more info, here a brief explaination of the idea:

This series introduce handling of PCS in phylink and try to deprecate .mac_select_pcs.

Phylink now might contain a linked list of available PCS and those will be used for PCS selection on phylink_major_config.

MAC driver needs to define pcs_interfaces mask in phylink_config for every interface that needs a dedicated PCS.

These PCS needs to be provided to phylink at phylink_create time by setting the .fill_available_pcs and .num_possible_pcs in phylink_config. Helpers to parse PCS from fwnode are provided fwnode_phylink_pcs_count() that will return the count of PCS entries described in the firmware node and fwnode_phylink_pcs_parse() that will fill a preallocated array of PCS pointer with the actual available PCS (ignoring the one that still needs to be probed).

phylink_create() will fill the internal PCS list with the passed array of PCS. phylink_major_config and other user of .mac_select_pcs are adapted to make use of this new PCS list.

The supported interface value is also moved internally to phylink struct. This is to handle late removal and addition of PCS. (the bonus effect to this is giving phylink a clear idea of what is actually supported by the MAC and his constraint with PCS)

The supported interface mask in phylink is done by OR the supported_interfaces in phylink_config with every PCS in PCS list.

PCS removal is supported by forcing a mac_config, refresh the supported interfaces and run a phy_resolve().

PCS late addition is supported by introducing a global notifier for PCS provider. If a phylink have the pcs_interfaces mask not zero, it's registered to this notifier.

PCS provider will emit a global PCS add event to signal any interface that a new PCS might be available.

The function will then check if the PCS is related to the MAC fwnode and add it accordingly.

A user for this new implementation is provided as an Airoha PCS driver. This was also tested downstream with the IPQ95xx QCOM SoC and with the help of Daniel also on the various Mediatek MT7988 SoC with both SFP cage implementation and DSA attached.

Lots of tests were done with driver unbind/bind and with interface up/down also by adding print to make sure major_config_fail gets correctly triggered and reset once the PCS comes back.

The dedicated commits have longer description on the implementation so it's suggested to also check there for additional info.

It's worth to mention that OpenWrt is currently using this on Mediatek SoC and QCOM ipq807x/ipq60xx/ipq50xx and Airoha are already ported in staging tree for testing.

Also realtek is using this and proved to correctly work.

---
Due to the introduction of Sashiko and the introduction of the notifier, a major reorg of the different scenario and capabilities parsing was needed. This is to make the bot happy (in theory, but it never is) and try to improve the state of the code by moving the capabilitis parsing to a centralized place trying to address all the scenario in one place.

---

Changes v22:
- Rebase on top of net-next (no idea why patchwork reported failed to apply...) Changes v21:
- Add fixes tag for the RCU patch
- Preserve user-disabled ethtool advertising during capability updates and SFP interface selection.
- Add additional kconfig select for Airoha PCS and Airoha Ethernet
- Fix wrong rcu_assign_pointer NULL in RCU patch
- Use "pcs-handle-names" as already defined (instead of "pcs-names")
- Skip phylink_pcs_disable if already disabled
- Skip phylink_major_config if phylink disabled
- Better handle capabilites from phylink_parse_mode and phylink_parse_fixedlink
- Set link_failed on late attach so that resolve is triggered 2 times
- Improve description of fwnode_pcs_get_from_provider()
- Improve capabilities tracking for PHY and SFP scenario
- Add variant for __phy_get_rate_matching
Changes v20:
- Fix double declaration error in Documentation
- Drop mutex from patch 8 for validate_mac_and_pcs
- Correctly use non lock version in __phylink_validate
Changes v19:
- Rebase on top of net-next
- RCU protect phylink from pcs struct
- Fix dead-lock on phylink_validate
- Handle possible PCS provider returning NULL (protective coding)
- Improve capabilities handling refresh
Changes v18:
- Improve handling on late PCS addition
- Fix wrong comment on airoha PCS driver
- Rebase on top of net-next
Changes v17:
- Rebase on top of net-next
- Add Review tag for DT patch
- Recalculate capabilities on late removal/attach
Changes v16:
- Rebase on top of net-next
- Add Tested-by tag
- Add ACK for airoha ethernet patch + nit fix
Changes v15:
- Rebase on top of net-next
- Fix Coccicheck warning
Changes v14:
- Fix deadlock when fill_available_pcs fails
- Move notifier and fill down after resolve disable bit is set
- Fix kconfig description
Changes v13:
- Fix regression in fwnode_pcs_get_from_pcsspec from v12
- Fix reverse lock for phy_lock and state_mutex
- Better handle lock in phylink_validate_mac_and_pcs and inband
- Fix wrong pointer to fwnode_pcs_add_provider notifier
- Fix compilation error for new C type in pcs_provider_notify Changes v12:
- Fix kdoc for function
- Rework PCS provider add and delete to be provider driven (instead of relaying on scan of fwnode every time) (this also handle
multi PCS scenario)
- Even further rework state mutex locking for concurrent pcs list
- Restore MAC supported_interfaces validation in phylink_create() wrongly dropped.
- Use get/put for fwnode reference
- Fix possible unment depndency for FWNODE_PCS
- Fix almost impossible problem for PCS calibration
- Hold rtnl with PCS deletion
Changes v11:
- Rework PCS release to notifier way (fix race as pointed out by bot)
- Add Ack from Lorenzo for Airoha Ethernet driver
- Introduce devm variant for pcs_provider_add
- Better support firmware node reference for PCS late attach
- Better protect list iteration with state mutex
- Minor fixup to airoha pcs driver (flow control fixup)
- Rebase on top of net-next
Changes v10:
- Minor code cleanup and fixes as suggested by bot
- Drop devlink patch
- Add reviewed by tag
- Configure old_link_state on PCS release
- Unlink PCS on error in phylink_create()
- Use list_add_tail
- Fix typo in Airoha PCS driver
- Update phylink migration guide
- Better handle late PCS attach (idempotent function and
add unser state_mutex)
- Use dedicated lock in Airoha ethernet driver
Changes v9:
- Rebase on top of net-next/main
- Drop early verification of supported_interface
(it can also be provided by get_capabilites MAC OP)
Changes v8:
- Back to RFC (net-next closed)
- Address additional bug reported by Sashiko bot
- Better handle priv interface for Airoha PCS driver
- Better handle locking for modifying the PCS list in
phylink code
- Improve fwnode_phylink_pcs_parse() parsing on -ENOENT
- Better handle error condition in phylink_create()
- Turn down the link when current PCS is released
- Fix compilation warning caused by copy paste error
Changes v7:
- Address all the bug from the Sashiko bot
- Rename .num_available_pcs to .num_possible_pcs
- Link PCS in phylink_create()
- Correctly unregister the notifier on phylink_destroy()
- Introduce fwnode_phylink_pcs_count()
- Better handle locking in phylink for PCS handling
- Better handle unavailable PCS at phylink_create() time
- Improve Documentation file
- Other minor fixes to address suggestion from bot
- Rebase on top of net-next
Changes v6:
- Rebase on top of net-next
- Add Documentation files
- Add fw_devlink patch
- Fix some comments typo
- Rework the airoha_eth.c implementation with new multi serdes code
- Extend PCS code with PCIe and USB support
- Align schema to new property
Changes v5:
- Rebase on top of net-next
- Use the new force_major_config
- Reword some comments and commit description
- Return -ENODEV instead of -EPROBE_DEFER to perevent race condition
- Drop phy_interface_copy patch (Russell pushed an equivalent version) Changes v4:
- Move patch 0002 phy_interface_copy to 0002 (fix bisectability problem)
- Address review from Lorenzo for Airoha ethernet driver
- Fix kdoc error with missing Return (actually missing : before Return)
- Fix UNMET dependency reported error for CONFIG_FWNODE_PCS
- Revert to pcs.c instead of core.c (due to name conflict with other kmod)
- Fix clang compilation error for Airoha PCS driver
- Add missing inline function to pcs.h function
Changes v3:
- Out of RFC
- Fix various spelling mistake
- Drop circular dependency patch
- Complete Airoha Ethernet phylink integration
- Introduce .pcs_link_down PCS OP
Changes v2:
- Switch to fwnode
- Implement PCS provider notifier
- Better split changes
- Move supported_interfaces to phylink
- Add circular dependency patch
- Rework handling with indirect addition/removal and
trigger of phylink_resolve()

Christian Marangi (15):
net: phylink: make PCS phylink instance access RCU protected
net: phylink: keep and use MAC supported_interfaces in phylink struct
net: phylink: introduce internal phylink PCS handling
net: pcs: implement Firmware node support for PCS driver
net: phylink: save phylink instance fwnode on phylink_create
net: phylink: make phylink_validate state locked
net: phylink: add capabilities helpers and track modified advertising
net: phylink: support PCS provider release
net: phylink: support late PCS provider attach
net: Document PCS subsystem
MAINTAINERS: add myself as PCS subsystem maintainer
net: phylink: add .pcs_link_down PCS OP
dt-bindings: net: pcs: Document support for Airoha Ethernet PCS
net: pcs: airoha: add PCS driver for Airoha AN7581 SoC
net: airoha: add phylink support

 .../bindings/net/pcs/airoha,pcs.yaml          |  261 ++
 Documentation/networking/index.rst            |    1 +
 Documentation/networking/pcs.rst              |  231 ++
 Documentation/networking/sfp-phylink.rst      |   35 +-
 MAINTAINERS                                   |    9 +
 drivers/net/ethernet/airoha/Kconfig           |    2 +
 drivers/net/ethernet/airoha/airoha_eth.c      |  197 +-
 drivers/net/ethernet/airoha/airoha_eth.h      |    5 +
 drivers/net/ethernet/airoha/airoha_regs.h     |   12 +
 drivers/net/pcs/Kconfig                       |    8 +
 drivers/net/pcs/Makefile                      |    3 +
 drivers/net/pcs/airoha/Kconfig                |   17 +
 drivers/net/pcs/airoha/Makefile               |    7 +
 drivers/net/pcs/airoha/pcs-airoha-common.c    | 1309 ++++++++++
 drivers/net/pcs/airoha/pcs-airoha.h           | 1311 ++++++++++
 drivers/net/pcs/airoha/pcs-an7581.c           | 2100 +++++++++++++++++
 drivers/net/pcs/pcs.c                         |  314 +++
 drivers/net/phy/phy-internal.h                |   22 +
 drivers/net/phy/phy.c                         |   11 +-
 drivers/net/phy/phylink.c                     | 1168 ++++++---
 include/linux/pcs/pcs-provider.h              |   70 +
 include/linux/pcs/pcs.h                       |  174 ++
 include/linux/phylink.h                       |   30 +-
 23 files changed, 6994 insertions(+), 303 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/net/pcs/airoha,pcs.yaml
 create mode 100644 Documentation/networking/pcs.rst
 create mode 100644 drivers/net/pcs/airoha/Kconfig
 create mode 100644 drivers/net/pcs/airoha/Makefile
 create mode 100644 drivers/net/pcs/airoha/pcs-airoha-common.c
 create mode 100644 drivers/net/pcs/airoha/pcs-airoha.h
 create mode 100644 drivers/net/pcs/airoha/pcs-an7581.c
 create mode 100644 drivers/net/pcs/pcs.c
 create mode 100644 drivers/net/phy/phy-internal.h
 create mode 100644 include/linux/pcs/pcs-provider.h
 create mode 100644 include/linux/pcs/pcs.h
Signature · 1 line
2.55.0