net: pcs: Introduce support for fwnode PCS
Subsystems (10)
v9 cover 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_get.
A PCS provider on driver removal should first call fwnode_pcs_del_provider() to delete itself as a provider and then release the PCS from phylink with phylink_release_pcs() under rtnl lock.
---
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.
---
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 (12):
net: phylink: keep and use MAC supported_interfaces in phylink struct
net: phylink: introduce internal phylink PCS handling
net: phylink: add phylink_release_pcs() to externally release a PCS
net: pcs: implement Firmware node support for PCS driver
net: phylink: support late PCS provider attach
net: Document PCS subsystem
MAINTAINERS: add myself as PCS subsystem maintainer
of: property: fw_devlink: Add support for "pcs-handle"
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 | 229 ++ MAINTAINERS | 9 + drivers/net/ethernet/airoha/Kconfig | 1 + drivers/net/ethernet/airoha/airoha_eth.c | 194 +- drivers/net/ethernet/airoha/airoha_eth.h | 7 +- drivers/net/ethernet/airoha/airoha_regs.h | 12 + drivers/net/pcs/Kconfig | 8 + drivers/net/pcs/Makefile | 3 + drivers/net/pcs/airoha/Kconfig | 12 + drivers/net/pcs/airoha/Makefile | 7 + drivers/net/pcs/airoha/pcs-airoha-common.c | 1324 +++++++++++ drivers/net/pcs/airoha/pcs-airoha.h | 1311 +++++++++++ drivers/net/pcs/airoha/pcs-an7581.c | 2093 +++++++++++++++++ drivers/net/pcs/pcs.c | 261 ++ drivers/net/phy/phylink.c | 366 ++- drivers/of/property.c | 2 + include/linux/pcs/pcs-provider.h | 41 + include/linux/pcs/pcs.h | 140 ++ include/linux/phylink.h | 30 + 21 files changed, 6261 insertions(+), 51 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 include/linux/pcs/pcs-provider.h create mode 100644 include/linux/pcs/pcs.h
Signature · 1 line
2.53.0
PATCH v9 1/12 net: phylink: keep and use MAC supported_interfaces in phylink struct
Add in phylink struct a copy of supported_interfaces from phylink_config and make use of that instead of relying on phylink_config value.
This in preparation for support of PCS handling internally to phylink where a PCS can be removed or added after the phylink is created and we need both a reference of the supported_interfaces value from phylink_config and an internal value that can be updated with the new PCS info.
--- drivers/net/phy/phylink.c | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-)
drivers/net/phy/phylink.c +15 -7
@@ -60,6 +60,11 @@ struct phylink {/* The link configuration settings */ struct phylink_link_state link_config; +/* What interface are supported by the current link. +* Can change on removal or addition of new PCS. +*/ +DECLARE_PHY_INTERFACE_MASK (supported_interfaces); +/* The current settings */ phy_interface_t cur_interface;
@@ -628,7 +633,7 @@ static int phylink_validate_mask(struct phylink *pl, struct phy_device *phy,static int phylink_validate (struct phylink *pl,unsigned long *supported,struct phylink_link_state *state) { -const unsigned long *interfaces = pl->config->supported_interfaces; +const unsigned long *interfaces = pl->supported_interfaces;if (state->interface ==PHY_INTERFACE_MODE_NA ) return phylink_validate_mask(pl, NULL, supported, state,
@@ -1867,6 +1872,9 @@ struct phylink *phylink_create(struct phylink_config *config,mutex_init (&pl->state_mutex);INIT_WORK (&pl->resolve, phylink_resolve); +phy_interface_copy (pl->supported_interfaces, + config->supported_interfaces); + pl->config = config;if (config->type ==PHYLINK_NETDEV ) { pl->netdev =to_net_dev (config->dev);
@@ -2025,7 +2033,7 @@ static int phylink_validate_phy(struct phylink *pl, struct phy_device *phy,* those which the host supports. */ phy_interface_and (interfaces, phy->possible_interfaces, - pl->config->supported_interfaces); + pl->supported_interfaces);if (phy_interface_empty (interfaces)) {phylink_err (pl,"PHY has no common interfaces\n" );
@@ -2827,12 +2835,12 @@ static phy_interface_t phylink_sfp_select_interface(struct phylink *pl,return interface; } -if (!test_bit (interface, pl->config->supported_interfaces)) { +if (!test_bit (interface, pl->supported_interfaces)) {phylink_err (pl,"selection of interface failed, SFP selected %s (%u) but MAC supports %*pbl\n" ,phy_modes (interface), interface, (int )PHY_INTERFACE_MODE_MAX , - pl->config->supported_interfaces); + pl->supported_interfaces);return PHY_INTERFACE_MODE_NA ; }
@@ -3760,14 +3768,14 @@ static int phylink_sfp_config_optical(struct phylink *pl)phylink_dbg (pl,"optical SFP: interfaces=[mac=%*pbl, sfp=%*pbl]\n" , (int )PHY_INTERFACE_MODE_MAX , - pl->config->supported_interfaces, + pl->supported_interfaces, (int )PHY_INTERFACE_MODE_MAX , pl->sfp_interfaces);/* Find the union of the supported interfaces by the PCS/MAC and * the SFP module. */ -phy_interface_and (pl->sfp_interfaces, pl->config->supported_interfaces, +phy_interface_and (pl->sfp_interfaces, pl->supported_interfaces, pl->sfp_interfaces);if (phy_interface_empty (pl->sfp_interfaces)) {phylink_err (pl,"unsupported SFP module: no common interface modes\n" );
@@ -3938,7 +3946,7 @@ static int phylink_sfp_connect_phy(void *upstream, struct phy_device *phy)/* Set the PHY's host supported interfaces */ phy_interface_and (phy->host_interfaces, phylink_sfp_interfaces, - pl->config->supported_interfaces); + pl->supported_interfaces);/* Do the initial configuration */ return phylink_sfp_config_phy (pl, phy);
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH net-next v9 01/12] net: phylink: keep and use MAC supported_interfaces in phylink struct
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Pre-existing issues:
- [High] In phylink_create(), if phylink_register_sfp() fails, the function frees pl without releasing the GPIO descriptor pl->link_gpio. --
--- Patch [1]: [PATCH net-next v9 01/12] net: phylink: keep and use MAC supported_interfaces in phylink struct --- commit 34f151721de84035e589a96b730a7b88905f81c9
Author: Christian Marangi <[email protected]>
net: phylink: keep and use MAC supported_interfaces in phylink struct
Adds a copy of supported_interfaces to the phylink struct and makes use of that instead of relying on the phylink_config value. This prepares for internal PCS handling where a PCS can be added or removed after creation.
Quoted 4 lines
drivers/net/phy/phylink.c +0
-0
[ ... ]
drivers/net/phy/phylink.c struct phylink *phylink_create(struct phylink_config *config, · line 1878
Quoted 8 lines
drivers/net/phy/phylink.c +3
-0@@ -1867,6 +1872,9 @@ struct phylink *phylink_create(struct phylink_config *config,mutex_init (&pl->state_mutex);INIT_WORK (&pl->resolve, phylink_resolve); +phy_interface_copy (pl->supported_interfaces, + config->supported_interfaces); + pl->config = config;
[Severity: High]
This isn't a bug introduced by this patch, but while reviewing phylink_create(), I noticed a potential resource leak in its error handling.
If phylink_create() processes a fixed-link configuration that acquires a GPIO descriptor (pl->link_gpio in phylink_parse_fixedlink()), and then the subsequent call to phylink_register_sfp() returns an error like -EPROBE_DEFER, the function frees pl but does not release the pl->link_gpio descriptor:
drivers/net/phy/phylink.c:phylink_create() {
...
ret = phylink_register_sfp(pl, fwnode);
if (ret < 0) {
kfree(pl);
return ERR_PTR(ret);
}...
}
Does this cause the GPIO descriptor to remain held, preventing subsequent probe attempts from succeeding since the GPIO request will fail with -EBUSY?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Re: [PATCH net-next v9 01/12] net: phylink: keep and use MAC supported_interfaces in phylink struct
In reply to Christian MarangiHi,
Quoted 10 lines · Christian Marangi
Add in phylink struct a copy of
supported_interfacesfromphylink_configand make use of that instead of relying onphylink_configvalue.This in preparation for support of PCS handling internally to phylink where a PCS can be removed or added after the phylink is created and we need both a reference of the
supported_interfacesvalue fromphylink_configand an internal value that can be updated with the new PCS info.Signed-off-by Christian Marangi <[email protected]>
Maxime
PATCH v9 2/12 net: phylink: introduce internal phylink PCS handling
In reply to Christian MarangiIntroduce internal handling of PCS for phylink. This is an alternative way to .mac_select_pcs that moves the selection logic of the PCS entirely to phylink with the usage of the supported_interface value in the PCS struct.
MAC should now provide a callback to fill the available PCS in phylink_config in .fill_available_pcs and fill the .num_possible_pcs with the number of elements in the array. MAC should also define a new bitmap, pcs_interfaces, in phylink_config to define for what interface mode a dedicated PCS is required.
On phylink_create(), an array of PCS pointer is allocated of size .num_possible_pcs from phylink_config and .fill_available_pcs from phylink_config is called passing as args the just allocated array and the number of possible element in it.
MAC will fill this passed array with all the available PCS.
This array is then parsed and a linked list of PCS is created based on the allocated PCS array filled by MAC via .fill_available_pcs().
Every PCS in phylink PCS list gets then linked to the phylink instance by setting the phylink value in phylink_pcs struct to the phylink instance. Also the supported_interface value in phylink struct is updated with the new supported_interface from the provided PCS.
On phylink_destroy(), every PCS in phylink PCS list is unlinked from the phylink instance by setting the phylink value in phylink_pcs struct to NULL and removed from the PCS list.
phylink_validate_mac_and_pcs(), phylink_major_config() and phylink_inband_caps() are updated to support this new implementation with the PCS list stored in phylink.
They will make use of phylink_validate_pcs_interface() that will loop for every PCS in the phylink PCS available list and find one that supports the passed interface.
phylink_validate_pcs_interface() applies the same logic of .mac_select_pcs where if a supported_interface value is not set for the PCS struct, then it's assumed every interface is supported.
A MAC is required to implement either a .mac_select_pcs or make use of the PCS list implementation. Implementing both will result in a fail on phylink_create().
A MAC defining .num_possible_pcs in phylink_config MUST also define a .fill_available_pcs or phylink_create() will fail with an negative error.
phylink value in phylink_pcs struct with this implementation is used to track from PCS side when it's attached to a phylink instance. PCS driver will make use of this information to correctly detach from a phylink instance if needed.
phylink_pcs_change() is also changed to verify that the PCS that triggered a link change is the one that is currently used by the phylink instance.
The .mac_select_pcs implementation is not changed but it's expected that every MAC driver migrates to the new implementation to later deprecate and remove .mac_select_pcs.
--- drivers/net/phy/phylink.c | 223 +++++++++++++++++++++++++++++++------- include/linux/phylink.h | 16 +++ 2 files changed, 201 insertions(+), 38 deletions(-)
drivers/net/phy/phylink.c +185 -38
@@ -60,6 +60,9 @@ struct phylink {/* The link configuration settings */ struct phylink_link_state link_config; +/* List of available PCS */ +struct list_head pcs_list; +/* What interface are supported by the current link. * Can change on removal or addition of new PCS. */
@@ -154,6 +157,8 @@ static const phy_interface_t phylink_sfp_interface_preference[] = {static DECLARE_PHY_INTERFACE_MASK (phylink_sfp_interfaces); +static void phylink_run_resolve (struct phylink *pl); +/** * phylink_set_port_modes() - set the port type modes in the ethtool mask * @mask: ethtool link mode mask
@@ -517,12 +522,29 @@ static void phylink_validate_mask_caps(unsigned long *supported,linkmode_and (state->advertising, state->advertising, mask); } +static int phylink_validate_pcs_interface (struct phylink_pcs *pcs, +phy_interface_t interface) +{ +/* If PCS define an empty supported_interfaces value, assume +* all interface are supported. +*/ +if (phy_interface_empty (pcs->supported_interfaces)) +return 0 ; + +/* Ensure that this PCS supports the interface mode */ +if (!test_bit (interface, pcs->supported_interfaces)) +return -EINVAL ; + +return 0 ; +} +static int phylink_validate_mac_and_pcs (struct phylink *pl,unsigned long *supported,struct phylink_link_state *state) { -struct phylink_pcs *pcs =NULL ;unsigned long capabilities; +struct phylink_pcs *pcs; +bool pcs_found = false;int ret;/* Get the PCS for this interface mode */
@@ -530,9 +552,24 @@ static int phylink_validate_mac_and_pcs(struct phylink *pl, pcs = pl->mac_ops->mac_select_pcs (pl->config, state->interface);if (IS_ERR (pcs))return PTR_ERR (pcs); + + pcs_found = !!pcs; +/* +* Find a PCS in available PCS list for the requested interface. +* +* Skip searching if the MAC doesn't require a dedicated PCS for +* the requested interface. +*/ + }else if (test_bit (state->interface, pl->config->pcs_interfaces)) { +list_for_each_entry (pcs, &pl->pcs_list, list) { +if (!phylink_validate_pcs_interface (pcs, state->interface)) { + pcs_found = true; +break ; + } + } } -if (pcs) { +if (pcs_found) {/* The PCS, if present, must be setup before phylink_create() * has been called. If the ops is not initialised, print an * error and backtrace rather than oopsing the kernel.
@@ -544,13 +581,10 @@ static int phylink_validate_mac_and_pcs(struct phylink *pl,return -EINVAL ; } -/* Ensure that this PCS supports the interface which the MAC -* returned it for. It is an error for the MAC to return a PCS -* that does not support the interface mode. -*/ -if (!phy_interface_empty (pcs->supported_interfaces) && - !test_bit (state->interface, pcs->supported_interfaces)) { -phylink_err (pl,"MAC returned PCS which does not support %s\n" , +/* Recheck PCS to handle legacy way for .mac_select_pcs */ + ret =phylink_validate_pcs_interface (pcs, state->interface); +if (ret) { +phylink_err (pl,"selected PCS does not support %s\n" ,phy_modes (state->interface));return -EINVAL ; }
@@ -964,12 +998,22 @@ static unsigned int phylink_inband_caps(struct phylink *pl, phy_interface_t interface) {struct phylink_pcs *pcs; +bool pcs_found = false; -if (!pl->mac_ops->mac_select_pcs) -return 0 ; +if (pl->mac_ops->mac_select_pcs) { + pcs = pl->mac_ops->mac_select_pcs (pl->config, + interface); + pcs_found = !!pcs; + }else if (test_bit (interface, pl->config->pcs_interfaces)) { +list_for_each_entry (pcs, &pl->pcs_list, list) { +if (!phylink_validate_pcs_interface (pcs, interface)) { + pcs_found = true; +break ; + } + } + } - pcs = pl->mac_ops->mac_select_pcs (pl->config, interface); -if (!pcs) +if (!pcs_found)return 0 ;return phylink_pcs_inband_caps (pcs, interface);
@@ -1264,10 +1308,36 @@ static void phylink_major_config(struct phylink *pl, bool restart, pl->major_config_failed = true;return ; } +/* Find a PCS in available PCS list for the requested interface. +* This doesn't overwrite the previous .mac_select_pcs as either +* .mac_select_pcs or PCS list implementation are permitted. +* +* Skip searching if the MAC doesn't require a dedicated PCS for +* the requested interface. +*/ + }else if (test_bit (state->interface, pl->config->pcs_interfaces)) { +bool pcs_found = false; + +list_for_each_entry (pcs, &pl->pcs_list, list) { +if (!phylink_validate_pcs_interface (pcs, + state->interface)) { + pcs_found = true; +break ; + } + } - pcs_changed = pl->pcs != pcs; +if (!pcs_found) { +phylink_err (pl, +"couldn't find a PCS for %s\n" , +phy_modes (state->interface)); + + pl->major_config_failed = true; +return ; + } } + pcs_changed = pl->pcs != pcs; +phylink_pcs_neg_mode (pl, pcs, state->interface, state->advertising); phylink_dbg(pl, "major config, active %s/%s/%s\n",
@@ -1294,13 +1364,15 @@ static void phylink_major_config(struct phylink *pl, bool restart,if (pcs_changed) {phylink_pcs_disable (pl->pcs); -if (pl->pcs) - pl->pcs->phylink =NULL ; +if (pl->mac_ops->mac_select_pcs) { +if (pl->pcs) + pl->pcs->phylink =NULL ; -if (pcs) - pcs->phylink = pl; +if (pcs) + pcs->phylink = pl; + } - pl->pcs = pcs; +WRITE_ONCE (pl->pcs, pcs); }if (pl->pcs)
@@ -1833,6 +1905,44 @@ int phylink_set_fixed_link(struct phylink *pl, }EXPORT_SYMBOL_GPL (phylink_set_fixed_link); +static int phylink_fill_available_pcs (struct phylink *pl, +struct phylink_config *config) +{ +struct phylink_pcs **pcss; +int i, ret; + +if (!config->num_possible_pcs) +return 0 ; + +if (!config->fill_available_pcs) { +dev_err (config->dev, +"phylink: error: num_possible_pcs defined but no fill_available_pcs\n" ); +return -EINVAL ; + } + + pcss =kzalloc_objs (*pcss, config->num_possible_pcs); +if (!pcss) +return -ENOMEM ; + + ret = config->fill_available_pcs (config, pcss, config->num_possible_pcs); +if (ret <0 ) + goto out; + +for (i =0 ; i < config->num_possible_pcs; i++) { +struct phylink_pcs *pcs = pcss[i]; + +if (!pcs) +continue ; + +list_add (&pcs->list, &pl->pcs_list); + } + +out: +kfree (pcss); + +return ret; +} +/** * phylink_create() - create a phylink instance * @config: a pointer to the target &struct phylink_config
@@ -1854,13 +1964,17 @@ struct phylink *phylink_create(struct phylink_config *config,phy_interface_t iface, const struct phylink_mac_ops *mac_ops) { + struct phylink_pcs *pcs;struct phylink *pl;int ret; -/* Validate the supplied configuration */ -if (phy_interface_empty (config->supported_interfaces)) { +/* +* Make sure either PCS internal validation or .mac_select_pcs +* is used. Return error if both are defined. +*/ +if (config->num_possible_pcs && mac_ops->mac_select_pcs) {dev_err (config->dev, -"phylink: error: empty supported_interfaces\n" ); +"phylink: error: either phylink_config .num_possible_pcs or .mac_select_pcs must be used\n" );return ERR_PTR (-EINVAL ); }
@@ -1871,10 +1985,26 @@ struct phylink *phylink_create(struct phylink_config *config,mutex_init (&pl->phydev_mutex);mutex_init (&pl->state_mutex);INIT_WORK (&pl->resolve, phylink_resolve); +INIT_LIST_HEAD (&pl->pcs_list); + +/* Fill the PCS list with available PCS from phylink config */ + ret =phylink_fill_available_pcs (pl, config); +if (ret <0 ) + goto free_pl; + +/* Link available PCS to phylink */ +list_for_each_entry (pcs, &pl->pcs_list, list) + pcs->phylink = pl;phy_interface_copy (pl->supported_interfaces, config->supported_interfaces); +/* Update supported interfaces */ +list_for_each_entry (pcs, &pl->pcs_list, list) +phy_interface_or (pl->supported_interfaces, + pl->supported_interfaces, + pcs->supported_interfaces); + pl->config = config;if (config->type ==PHYLINK_NETDEV ) { pl->netdev =to_net_dev (config->dev);
@@ -1882,8 +2012,7 @@ struct phylink *phylink_create(struct phylink_config *config, }else if (config->type ==PHYLINK_DEV ) { pl->dev = config->dev; }else { -kfree (pl); -return ERR_PTR (-EINVAL ); + goto unlink_pcs_list; } pl->mac_supports_eee_ops =phylink_mac_implements_lpi (mac_ops);
@@ -1916,28 +2045,29 @@ struct phylink *phylink_create(struct phylink_config *config,phylink_validate (pl, pl->supported, &pl->link_config); ret =phylink_parse_mode (pl, fwnode); -if (ret <0 ) { -kfree (pl); -return ERR_PTR (ret); - } +if (ret <0 ) + goto unlink_pcs_list;if (pl->cfg_link_an_mode ==MLO_AN_FIXED ) { ret =phylink_parse_fixedlink (pl, fwnode); -if (ret <0 ) { -kfree (pl); -return ERR_PTR (ret); - } +if (ret <0 ) + goto unlink_pcs_list; } pl->req_link_an_mode = pl->cfg_link_an_mode; ret =phylink_register_sfp (pl, fwnode); -if (ret <0 ) { -kfree (pl); -return ERR_PTR (ret); - } +if (ret <0 ) + goto unlink_pcs_list;return pl; + +unlink_pcs_list: +list_for_each_entry (pcs, &pl->pcs_list, list) + pcs->phylink =NULL ; +free_pl: +kfree (pl); +return ERR_PTR (ret); }EXPORT_SYMBOL_GPL (phylink_create);
@@ -1952,11 +2082,21 @@ EXPORT_SYMBOL_GPL(phylink_create);*/ void phylink_destroy (struct phylink *pl) { +struct phylink_pcs *pcs, *tmp; +sfp_bus_del_upstream (pl->sfp_bus);if (pl->link_gpio)gpiod_put (pl->link_gpio);cancel_work_sync (&pl->resolve); + +/* Drop link between PCS and phylink */ +/* Remove every PCS from phylink PCS list */ +list_for_each_entry_safe (pcs, tmp, &pl->pcs_list, list) { + pcs->phylink =NULL ; +list_del (&pcs->list); + } +kfree (pl); }EXPORT_SYMBOL_GPL (phylink_destroy);
@@ -2412,8 +2552,15 @@ void phylink_pcs_change(struct phylink_pcs *pcs, bool up) {struct phylink *pl = pcs->phylink; -if (pl) -phylink_link_changed (pl, up,"pcs" ); +/* +* Ignore PCS link state change if the PCS is not +* attached to a phylink instance or the phylink +* instance is not currently using this PCS. +*/ +if (!pl ||READ_ONCE (pl->pcs) != pcs) +return ; + +phylink_link_changed (pl, up,"pcs" ); }EXPORT_SYMBOL_GPL (phylink_pcs_change);
include/linux/phylink.h +16 -0
@@ -12,6 +12,7 @@ struct ethtool_cmd;struct fwnode_handle ;struct net_device ;struct phylink ; +struct phylink_pcs ;enum {MLO_PAUSE_NONE ,
@@ -151,6 +152,8 @@ enum phylink_op_type {* if MAC link is at %MLO_AN_FIXED mode. * @supported_interfaces: bitmap describing which PHY_INTERFACE_MODE_xxx * are supported by the MAC/PCS. +* @pcs_interfaces: bitmap describing for which PHY_INTERFACE_MODE_xxx a +* dedicated PCS is required. * @lpi_interfaces: bitmap describing which PHY interface modes can support * LPI signalling. * @mac_capabilities: MAC pause/speed/duplex capabilities.
@@ -160,6 +163,10 @@ enum phylink_op_type {* @wol_phy_legacy: Use Wake-on-Lan with PHY even if phy_can_wakeup() is false * @wol_phy_speed_ctrl: Use phy speed control on suspend/resume * @wol_mac_support: Bitmask of MAC supported %WAKE_* options +* @num_possible_pcs: num of possible phylink_pcs PCS +* @fill_available_pcs: callback to fill the available PCS in the passed +* array struct of phylink_pcs PCS available_pcs up to +* num_possible_pcs. */ struct phylink_config {struct device *dev;
@@ -172,6 +179,7 @@ struct phylink_config {void (*get_fixed_state)(struct phylink_config *config,struct phylink_link_state *state);DECLARE_PHY_INTERFACE_MASK (supported_interfaces); +DECLARE_PHY_INTERFACE_MASK (pcs_interfaces);DECLARE_PHY_INTERFACE_MASK (lpi_interfaces);unsigned long mac_capabilities;unsigned long lpi_capabilities;
@@ -182,6 +190,11 @@ struct phylink_config {bool wol_phy_legacy;bool wol_phy_speed_ctrl;u32 wol_mac_support; + +unsigned int num_possible_pcs; +int (*fill_available_pcs)(struct phylink_config *config, +struct phylink_pcs **available_pcs, +unsigned int num_possible_pcs); };void phylink_limit_mac_speed (struct phylink_config *config,u32 max_speed);
@@ -497,6 +510,9 @@ struct phylink_pcs {struct phylink *phylink;bool poll;bool rxc_always_on; + +/* private: */ +struct list_head list; };/**
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH net-next v9 02/12] net: phylink: introduce internal phylink PCS handling
Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider: - [High] phylink_validate_mac_and_pcs() validates an interface as supported even when its required…
Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:
- [High] phylink_validate_mac_and_pcs() validates an interface as supported even when its required dedicated PCS is missing.
- [High] Missing list_del() in the unlink_pcs_list error path of phylink_create() leaves dangling list pointers in externally-owned PCS structures.
- [Medium] phylink_fill_available_pcs() uses list_add() instead of list_add_tail(), reversing the intended priority order of the provided PCS array. --
--- Patch [2]: [PATCH net-next v9 02/12] net: phylink: introduce internal phylink PCS handling --- commit 867ad4be39467be718a5df59cf2a9739b1c43531
Author: Christian Marangi <[email protected]>
Subject: net: phylink: introduce internal phylink PCS handling
Introduces an alternative to mac_select_pcs by shifting the PCS selection logic entirely to phylink using the supported_interface value in the PCS struct. A new pcs_list tracks available PCS instances.
Quoted 4 lines
drivers/net/phy/phylink.c +0
-0
[ ... ]
Quoted 13 lines
drivers/net/phy/phylink.c +9
-0@@ -530,9 +552,24 @@ static int phylink_validate_mac_and_pcs(struct phylink *pl, pcs = pl->mac_ops->mac_select_pcs (pl->config, state->interface);if (IS_ERR (pcs))return PTR_ERR (pcs); + + pcs_found = !!pcs; +/* +* Find a PCS in available PCS list for the requested interface. +* +* Skip searching if the MAC doesn't require a dedicated PCS for +* the requested interface. +*/ + }else if (test_bit (state->interface, pl->config->pcs_interfaces)) {
drivers/net/phy/phylink.c static int phylink_validate_mac_and_pcs(struct phylink *pl, · line 572
Quoted 10 lines
drivers/net/phy/phylink.c +7
-1+list_for_each_entry (pcs, &pl->pcs_list, list) { +if (!phylink_validate_pcs_interface (pcs, state->interface)) { + pcs_found = true; +break ; + } + } } -if (pcs) { +if (pcs_found) {
[Severity: High]
If the MAC requires a dedicated PCS (test_bit returns true) but no available PCS supports the requested interface, pcs_found remains false. Does this wrongly skip the PCS validation block and proceed to MAC capabilities validation without returning an error?
If so, it seems like phylink_major_config() will later fail when it performs this same lookup, resulting in a delayed setup failure. Should we return -EINVAL here if pcs_found is false but a dedicated PCS is required?
[ ... ]
Quoted 3 lines
drivers/net/phy/phylink.c +3
-0+static int phylink_fill_available_pcs (struct phylink *pl, +struct phylink_config *config) +{
[ ... ]
drivers/net/phy/phylink.c int phylink_set_fixed_link(struct phylink *pl, · line 1938
Quoted 8 lines
drivers/net/phy/phylink.c +8
-0+for (i =0 ; i < config->num_possible_pcs; i++) { +struct phylink_pcs *pcs = pcss[i]; + +if (!pcs) +continue ; + +list_add (&pcs->list, &pl->pcs_list); + }
[Severity: Medium]
Since list_add() inserts elements at the head of the list, does this reverse the priority order of the pcss array provided by the MAC driver?
Because lookups return the first matching PCS in the list, would using list_add_tail() be needed to ensure the highest-priority PCS from the array is correctly chosen?
[ ... ]
Quoted 1 line
drivers/net/phy/phylink.c +0
-0@@ -1854,13 +1964,17 @@ struct phylink *phylink_create(struct phylink_config *config,
[ ... ]
drivers/net/phy/phylink.c struct phylink *phylink_create(struct phylink_config *config, · line 2072
Quoted 10 lines
drivers/net/phy/phylink.c +7
-0return pl; + +unlink_pcs_list: +list_for_each_entry (pcs, &pl->pcs_list, list) + pcs->phylink =NULL ; +free_pl: +kfree (pl); +return ERR_PTR (ret); }EXPORT_SYMBOL_GPL (phylink_create);
[Severity: High]
If phylink_create() encounters an error and takes the unlink_pcs_list path, does omitting list_del(&pcs->list) leave dangling pointers in the externally-owned phylink_pcs structures once the phylink instance is freed?
If a MAC driver defers probe or retries initialization, passing these same structures back to phylink_create() could trigger list corruption or a use-after-free since their list nodes would still point to the freed pl->pcs_list.
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
Re: [PATCH net-next v9 02/12] net: phylink: introduce internal phylink PCS handling
In reply to Christian MarangiHi,
Quoted 54 lines · Christian Marangi
Introduce internal handling of PCS for phylink. This is an alternative way to .mac_select_pcs that moves the selection logic of the PCS entirely to phylink with the usage of the
supported_interfacevalue in the PCS struct.MAC should now provide a callback to fill the available PCS in
phylink_configin .fill_available_pcs and fill the .num_possible_pcs with the number of elements in the array. MAC should also define a new bitmap,pcs_interfaces, inphylink_configto define for what interface mode a dedicated PCS is required.On
phylink_create(), an array of PCS pointer is allocated of size .num_possible_pcs fromphylink_configand .fill_available_pcs fromphylink_configis called passing as args the just allocated array and the number of possible element in it.MAC will fill this passed array with all the available PCS.
This array is then parsed and a linked list of PCS is created based on the allocated PCS array filled by MAC via .fill_available_pcs().
Every PCS in phylink PCS list gets then linked to the phylink instance by setting the phylink value in
phylink_pcsstruct to the phylink instance. Also thesupported_interfacevalue in phylink struct is updated with the newsupported_interfacefrom the provided PCS.On
phylink_destroy(), every PCS in phylink PCS list is unlinked from the phylink instance by setting the phylink value inphylink_pcsstruct to NULL and removed from the PCS list.
phylink_validate_mac_and_pcs(),phylink_major_config()andphylink_inband_caps()are updated to support this new implementation with the PCS list stored in phylink.They will make use of
phylink_validate_pcs_interface()that will loop for every PCS in the phylink PCS available list and find one that supports the passed interface.
phylink_validate_pcs_interface()applies the same logic of .mac_select_pcs where if asupported_interfacevalue is not set for the PCS struct, then it's assumed every interface is supported.A MAC is required to implement either a .mac_select_pcs or make use of the PCS list implementation. Implementing both will result in a fail on
phylink_create().A MAC defining .num_possible_pcs in
phylink_configMUST also define a .fill_available_pcs orphylink_create()will fail with an negative error.phylink value in
phylink_pcsstruct with this implementation is used to track from PCS side when it's attached to a phylink instance. PCS driver will make use of this information to correctly detach from a phylink instance if needed.
Quoted 8 lines
phylink_pcs_change()is also changed to verify that the PCS that triggered a link change is the one that is currently used by the phylink instance.The .mac_select_pcs implementation is not changed but it's expected that every MAC driver migrates to the new implementation to later deprecate and remove .mac_select_pcs.
Signed-off-by Christian Marangi <[email protected]>
Maxime
PATCH v9 3/12 net: phylink: add phylink_release_pcs() to externally release a PCS
In reply to Christian MarangiAdd phylink_release_pcs() to externally release a PCS from a phylink instance. This can be used to handle case when a single PCS needs to be removed and the phylink instance needs to be refreshed.
On calling phylink_release_pcs(), the PCS will be removed from the phylink internal PCS list and the phylink supported_interfaces value is reparsed with the remaining PCS interfaces.
Also a phylink resolve is triggered to handle the PCS removal.
The flag force_major_config is set to make phylink resolve reconfigure the interface (even if it didn't change).
This is needed to handle the special case when the current PCS used by phylink is removed and a major_config is needed to propagae the configuration change. With this option enabled we also force mac_config even if the PHY link is not up for the in-band case.
--- drivers/net/phy/phylink.c | 56 +++++++++++++++++++++++++++++++++++++++ include/linux/phylink.h | 2 ++ 2 files changed, 58 insertions(+)
drivers/net/phy/phylink.c +56 -0
@@ -158,6 +158,8 @@ static const phy_interface_t phylink_sfp_interface_preference[] = {static DECLARE_PHY_INTERFACE_MASK (phylink_sfp_interfaces);static void phylink_run_resolve (struct phylink *pl); +static void phylink_link_down (struct phylink *pl); +static void phylink_pcs_disable (struct phylink_pcs *pcs);/** * phylink_set_port_modes() - set the port type modes in the ethtool mask
@@ -917,6 +919,60 @@ static void phylink_resolve_an_pause(struct phylink_link_state *state) } } +/** +* phylink_release_pcs - Removes a PCS from the phylink PCS available list +* @pcs: a pointer to the phylink_pcs struct to be released +* +* This function release a PCS from the phylink PCS available list if +* actually in use. It also refreshes the supported interfaces of the +* phylink instance by copying the supported interfaces from the phylink +* conf and merging the supported interfaces of the remaining available PCS +* in the list and trigger a resolve. +*/ +void phylink_release_pcs (struct phylink_pcs *pcs) +{ +struct phylink *pl; + +ASSERT_RTNL (); + + pl = pcs->phylink; +if (!pl) +return ; + +mutex_lock (&pl->state_mutex); + +list_del (&pcs->list); + pcs->phylink =NULL ; + +/* +* Check if we are removing the PCS currently +* in use by phylink. If this is the case, tear down +* the link, force phylink resolve to reconfigure the +* interface mode, disable the current PCS and set the +* phylink PCS to NULL. +*/ +if (pl->pcs == pcs) { +phylink_link_down (pl); +phylink_pcs_disable (pl->pcs); + + pl->force_major_config = true; + pl->pcs =NULL ; + } + +mutex_unlock (&pl->state_mutex); + +/* Refresh supported interfaces */ +phy_interface_copy (pl->supported_interfaces, + pl->config->supported_interfaces); +list_for_each_entry (pcs, &pl->pcs_list, list) +phy_interface_or (pl->supported_interfaces, + pl->supported_interfaces, + pcs->supported_interfaces); + +phylink_run_resolve (pl); +} +EXPORT_SYMBOL_GPL (phylink_release_pcs); +static unsigned int phylink_pcs_inband_caps (struct phylink_pcs *pcs,phy_interface_t interface) {
include/linux/phylink.h +2 -0
@@ -751,6 +751,8 @@ void phylink_disconnect_phy(struct phylink *);int phylink_set_fixed_link (struct phylink *,const struct phylink_link_state *); +void phylink_release_pcs (struct phylink_pcs *pcs); +void phylink_mac_change (struct phylink *,bool up);void phylink_pcs_change (struct phylink_pcs *,bool up);
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH net-next v9 03/12] net: phylink: add phylink_release_pcs() to externally release a PCS
Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider: - [High] Unconditional call to phylink_link_down() without updating old_link_state leads to multiple…
Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider:
- [High] Unconditional call to phylink_link_down() without updating old_link_state leads to multiple mac_link_down() calls and state machine desynchronization.
- [Medium] The phylink instance's supported ethtool link modes and advertising mask are not updated after a PCS is removed.
- [Medium] Polling timer is not stopped when the active polling PCS is released, causing a runaway timer.
- [Low] Reusing the function parameter 'pcs' as a loop iterator variable violates C scoping best practices and kernel coding standards. --
--- Patch [3]: [PATCH net-next v9 03/12] net: phylink: add phylink_release_pcs() to externally release a PCS --- commit 3d6c63e283b60421054ef189e8d1a2deb1f29536
Author: Christian Marangi <[email protected]>
net: phylink: add phylink_release_pcs() to externally release a PCS
Add phylink_release_pcs() to externally release a PCS from a phylink instance. This can be used to handle case when a single PCS needs to be removed and the phylink instance needs to be refreshed.
Quoted 4 lines
drivers/net/phy/phylink.c +0
-0
[ ... ]
Quoted 1 line
drivers/net/phy/phylink.c +0
-0@@ -917,6 +919,60 @@ static void phylink_resolve_an_pause(struct phylink_link_state *state)
[ ... ]
Quoted 19 lines
drivers/net/phy/phylink.c +19
-0+void phylink_release_pcs (struct phylink_pcs *pcs) +{ +struct phylink *pl; + +ASSERT_RTNL (); + + pl = pcs->phylink; +if (!pl) +return ; + +mutex_lock (&pl->state_mutex); + +list_del (&pcs->list); + pcs->phylink =NULL ; + +/* +* Check if we are removing the PCS currently +* in use by phylink. If this is the case, tear down +* the link, force phylink resolve to reconfigure the
drivers/net/phy/phylink.c static void phylink_resolve_an_pause(struct phylink_link_state *state) · line 960
Quoted 10 lines
drivers/net/phy/phylink.c +10
-0+* interface mode, disable the current PCS and set the +* phylink PCS to NULL. +*/ +if (pl->pcs == pcs) { +phylink_link_down (pl); +phylink_pcs_disable (pl->pcs); + + pl->force_major_config = true; + pl->pcs =NULL ; + }
[Severity: High]
Does calling phylink_link_down() here without also updating pl->old_link_state cause state machine desynchronization?
If pl->old_link_state is true when the PCS is removed (such as for DSA switch ports where there is no netdev), the link is logically brought down, but pl->old_link_state remains true. This could cause subsequent link-up events to be ignored because phylink thinks the link is already up, leaving the interface permanently dead.
[Severity: Medium]
When the active PCS has polling enabled (pcs->poll is true), does clearing pl->pcs and triggering a resolve leave a runaway timer?
If phylink_major_config() is called by the resolve task and no replacement PCS is found, it may return early on error and bypass the phylink_pcs_poll_stop() call. Could this cause the original timer to continue firing and re-arming itself indefinitely?
drivers/net/phy/phylink.c static void phylink_resolve_an_pause(struct phylink_link_state *state) · line 970
Quoted 10 lines
drivers/net/phy/phylink.c +10
-0+ +mutex_unlock (&pl->state_mutex); + +/* Refresh supported interfaces */ +phy_interface_copy (pl->supported_interfaces, + pl->config->supported_interfaces); +list_for_each_entry (pcs, &pl->pcs_list, list) +phy_interface_or (pl->supported_interfaces, + pl->supported_interfaces, + pcs->supported_interfaces);
[Severity: Low]
This isn't a bug, but does reusing the function parameter pcs as the list iterator variable overwrite its pointer value?
When the loop terminates, pcs will point to an invalid structure offset derived from the list head. Using a separate iterator variable would avoid corrupting the parameter.
[Severity: Medium]
While pl->supported_interfaces is updated here, is it also necessary to update the phylink instance's supported ethtool link modes and advertising mask?
Without calling phylink_validate() or similar to update pl->supported and pl->link_config.advertising, these masks might continue to advertise the capabilities of the removed PCS. Could this lead to runtime connection failures if userspace or the PHY attempts to negotiate these now-unsupported modes?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=3
Re: [PATCH net-next v9 03/12] net: phylink: add phylink_release_pcs() to externally release a PCS
In reply to Christian MarangiHi,
Quoted 10 lines · Christian Marangi
Add
phylink_release_pcs()to externally release a PCS from a phylink instance. This can be used to handle case when a single PCS needs to be removed and the phylink instance needs to be refreshed.On calling
phylink_release_pcs(), the PCS will be removed from the phylink internal PCS list and the phylinksupported_interfacesvalue is reparsed with the remaining PCS interfaces.Also a phylink resolve is triggered to handle the PCS removal.
Quoted 8 lines
The flag
force_major_configis set to make phylink resolve reconfigure the interface (even if it didn't change).
This is needed to handle the special case when the current PCS used by phylink is removed and amajor_configis needed to propagae the configuration change. With this option enabled we also forcemac_configeven if the PHY link is not up for the in-band case.Signed-off-by Christian Marangi <[email protected]>
Maxime
PATCH v9 4/12 net: pcs: implement Firmware node support for PCS driver
In reply to Christian MarangiImplement the foundation of Firmware node support for PCS driver.
To support this, implement a simple Provider API where a PCS driver can expose multiple PCS with an xlate .get function.
PCS driver will have to call fwnode_pcs_add_provider() and pass the firmware node pointer and a xlate function to return the correct PCS for the passed #pcs-cells.
This will register the PCS in a global list of providers so that consumer can access it.
The consumer will then use fwnode_pcs_get() to get the actual PCS by passing the firmware node pointer and the index for #pcs-cells.
For a simple implementation where #pcs-cells is 0 and the PCS driver expose a single PCS, the xlate function fwnode_pcs_simple_get() is provided.
For an advanced implementation a custom xlate function is required.
On removal the PCS driver should first delete itself from the provider list using fwnode_pcs_del_provider() and then call phylink_release_pcs() on every PCS the driver provides.
Generic functions fwnode_phylink_pcs_count() and fwnode_phylink_pcs_parse() are provided for MAC driver that will declare PCS in DT (or ACPI).
Function fwnode_phylink_pcs_count() will parse "pcs-handle" property and will return the number of PCS entries described in the passed firmware node.
Function fwnode_phylink_pcs_parse() will parse "pcs-handle" property and fill the passed available_pcs array with the available PCS found up to passed num_pcs value. It's worth to mention that this function will ignore PCS that still needs to be probed (returning -ENODEV) and such PCS won't be added to the available_pcs array.
--- drivers/net/pcs/Kconfig | 6 + drivers/net/pcs/Makefile | 1 + drivers/net/pcs/pcs.c | 212 +++++++++++++++++++++++++++++++ include/linux/pcs/pcs-provider.h | 41 ++++++ include/linux/pcs/pcs.h | 75 +++++++++++ 5 files changed, 335 insertions(+) create mode 100644 drivers/net/pcs/pcs.c create mode 100644 include/linux/pcs/pcs-provider.h create mode 100644 include/linux/pcs/pcs.h
drivers/net/pcs/Kconfig +6 -0
@@ -5,6 +5,12 @@ menu "PCS device drivers" +config FWNODE_PCS + bool "PCS Firmware Node" + depends on (ACPI || OF) + help + Firmware node PCS accessors + config PCS_XPCS tristate "Synopsys DesignWare Ethernet XPCS" select PHYLINK
drivers/net/pcs/Makefile +1 -0
@@ -1,6 +1,7 @@ # SPDX-License-Identifier: GPL-2.0 # Makefile for Linux PCS drivers +obj-$(CONFIG_FWNODE_PCS) += pcs.o pcs_xpcs-$(CONFIG_PCS_XPCS) := pcs-xpcs.o pcs-xpcs-plat.o \ pcs-xpcs-nxp.o pcs-xpcs-wx.o
drivers/net/pcs/pcs.c new file +212 -0
212 lines not on this page · raw message
include/linux/pcs/pcs-provider.h new file +41 -0
41 lines not on this page · raw message
include/linux/pcs/pcs.h new file +75 -0
75 lines not on this page · raw message
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH net-next v9 04/12] net: pcs: implement Firmware node support for PCS driver
Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider: - [High] The PCS provider API lacks module reference counting or device linking, creating a use-after-free…
Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider:
- [High] The PCS provider API lacks module reference counting or device linking, creating a use-after-free vulnerability.
- [High] Ignoring missing PCS providers breaks probe deferral and corrupts the mapping of the retrieved PCS array via unintended array squashing.
- [High] Potential AB-BA deadlock due to calling provider callback while holding global fwnode_pcs_mutex.
- [Low] API Misuse: Passing -1 to the unsigned int nargs parameter.
--
--- Patch [4]: [PATCH net-next v9 04/12] net: pcs: implement Firmware node support for PCS driver --- commit 9d0c6df31924499c98bee1b3b6194d084ae4c002
Author: Christian Marangi <[email protected]>
net: pcs: implement Firmware node support for PCS driver
Implement the foundation of Firmware node support for PCS driver. To support this, implement a simple Provider API where a PCS driver can expose multiple PCS with an xlate .get function.
Quoted 6 lines
drivers/net/pcs/pcs.c new file +0
-0@@ -0,0 +1,212 @@
[ ... ]
drivers/net/pcs/pcs.c line 37
Quoted 5 lines
drivers/net/pcs/pcs.c new file +5
-0+int fwnode_pcs_add_provider (struct fwnode_handle *fwnode, +struct phylink_pcs *(*get)(struct fwnode_reference_args *pcsspec, +void *data), +void *data) +{
[Severity: High]
Does this API need a way to track module ownership or establish device links? Since providers don't pass their module owner (e.g., THIS_MODULE) or a device pointer during registration, consumers can't hold a reference to the provider module. If a provider module is unloaded, could it leave consumers with dangling phylink_pcs pointers resulting in a use-after-free?
Quoted 1 line
drivers/net/pcs/pcs.c new file +1
-0+struct fwnode_pcs_provider *pp;
[ ... ]
Quoted 4 lines
drivers/net/pcs/pcs.c new file +4
-0+static int fwnode_parse_pcsspec (const struct fwnode_handle *fwnode, +int index,const char *name, +struct fwnode_reference_args *out_args) +{
[ ... ]
drivers/net/pcs/pcs.c line 101
Quoted 3 lines
drivers/net/pcs/pcs.c new file +3
-0+ ret =fwnode_property_get_reference_args (fwnode,"pcs-handle" , +"#pcs-cells" , +-1 , index, out_args);
[Severity: Low]
Is it intentional to pass -1 to the nargs parameter of fwnode_property_get_reference_args()? Since nargs is an unsigned int, this will be implicitly cast to UINT_MAX.
drivers/net/pcs/pcs.c line 112
Quoted 11 lines
drivers/net/pcs/pcs.c new file +11
-0+if (ret || (name && index <0 )) +return ret; + +return 0 ; +} + +static struct phylink_pcs * +fwnode_pcs_get_from_pcsspec (struct fwnode_reference_args *pcsspec) +{ +struct fwnode_pcs_provider *provider; +struct phylink_pcs *pcs =ERR_PTR (-ENODEV );
[Severity: High]
Should this default to -EPROBE_DEFER instead of -ENODEV? If a provider hasn't probed yet, returning -ENODEV will prevent the consumer from correctly deferring its probe.
drivers/net/pcs/pcs.c line 120
Quoted 8 lines
drivers/net/pcs/pcs.c new file +8
-0+ +if (!pcsspec) +return ERR_PTR (-EINVAL ); + +mutex_lock (&fwnode_pcs_mutex); +list_for_each_entry (provider, &fwnode_pcs_providers, link) { +if (provider->fwnode == pcsspec->fwnode) { + pcs = provider->get (pcsspec, provider->data);
[Severity: High]
Can calling the provider's get() callback while holding the global fwnode_pcs_mutex cause an AB-BA deadlock?
If an advanced provider needs to acquire a driver-local lock in its get() callback, it creates a lock order of fwnode_pcs_mutex -> local_lock.
During provider removal, the driver might acquire local_lock before calling fwnode_pcs_del_provider(), which then tries to acquire fwnode_pcs_mutex.
Quoted 14 lines
drivers/net/pcs/pcs.c new file +14
-0+if (!IS_ERR (pcs)) +break ; + } + } +mutex_unlock (&fwnode_pcs_mutex); + +return pcs; +} + +static struct phylink_pcs *__fwnode_pcs_get (struct fwnode_handle *fwnode, +unsigned int index,const char *con_id) +{ +struct fwnode_reference_args pcsspec; +struct phylink_pcs *pcs;
drivers/net/pcs/pcs.c line 144
Quoted 10 lines
drivers/net/pcs/pcs.c new file +10
-0+int ret; + + ret =fwnode_parse_pcsspec (fwnode, index, con_id, &pcsspec); +if (ret) +return ERR_PTR (ret); + + pcs =fwnode_pcs_get_from_pcsspec (&pcsspec); +fwnode_handle_put (pcsspec.fwnode); + +return pcs;
[Severity: High]
Since this returns a bare pointer to the consumer without taking a reference on the provider module, and there is no corresponding put() API, what prevents the provider from freeing the PCS memory while the consumer is still using it?
Quoted 1 line
+}
[ ... ]
drivers/net/pcs/pcs.c line 162
Quoted 10 lines
drivers/net/pcs/pcs.c new file +10
-0+unsigned int fwnode_phylink_pcs_count (struct fwnode_handle *fwnode) +{ +struct fwnode_reference_args out_args; +int index =0 ; +int ret; + +while (true) { + ret =fwnode_property_get_reference_args (fwnode,"pcs-handle" , +"#pcs-cells" , +-1 , index, &out_args);
[Severity: Low]
Is this another location where we are passing -1 to an unsigned int parameter?
Quoted 3 lines
drivers/net/pcs/pcs.c new file +3
-0+/* We expect to reach an -ENOENT error while counting */ +if (ret) +break ;
[ ... ]
Quoted 5 lines
drivers/net/pcs/pcs.c new file +5
-0+int fwnode_phylink_pcs_parse (struct fwnode_handle *fwnode, +struct phylink_pcs **available_pcs, +unsigned int num_pcs) +{ +unsigned int i, found =0 ;
[ ... ]
Quoted 5 lines
drivers/net/pcs/pcs.c new file +5
-0+for (i =0 ; i < num_pcs; i++) { +struct phylink_pcs *pcs; + + pcs =fwnode_pcs_get (fwnode, i); +if (IS_ERR (pcs)) {
drivers/net/pcs/pcs.c line 201
Quoted 10 lines
drivers/net/pcs/pcs.c new file +10
-0+/* Exit early if no PCS remain.*/ +if (PTR_ERR (pcs) == -ENOENT ) +break ; + +/* +* Ignore -ENODEV error for PCS that still +* needs to probe. +*/ +if (PTR_ERR (pcs) == -ENODEV ) +continue ;
[Severity: High]
Does ignoring -ENODEV and continuing without incrementing the "found" index corrupt the hardware mapping for the MAC driver?
By not storing a placeholder or deferring probe, any subsequently probed PCS will be shifted into the wrong index in the available_pcs array. If the MAC driver expects index i to map to physical lane i, won't this result in incorrect routing?
Quoted 10 lines
drivers/net/pcs/pcs.c new file +10
-0+ +return PTR_ERR (pcs); + } + + available_pcs[found] = pcs; + found++; + } + +return found; +}
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=4
PATCH v9 5/12 net: phylink: support late PCS provider attach
In reply to Christian MarangiAdd support for late PCS provider attachment to a phylink instance. This works by creating a global notifier for the PCS provider and making each phylink instance that makes use of fwnode subscribe to this notifier.
The PCS notifier will emit the event FWNODE_PCS_PROVIDER_ADD every time a new PCS provider is added.
phylink will then react to this event and will call the new function fwnode_phylink_pcs_get_from_fwnode() that will check if the PCS fwnode provided by the event is present in the pcs-handle property of the phylink instance.
If a related PCS is found, then such PCS is added to the phylink instance PCS list.
Then we link the PCS to the phylink instance and we refresh the supported interfaces of the phylink instance.
Finally we check if we are in a major_config_failed scenario and trigger an interface reconfiguration in the next phylink resolve.
In the example scenario where the link was previously torn down due to removal of PCS, the link will be established again as the PCS came back and is now available to phylink.
--- drivers/net/pcs/pcs.c | 49 +++++++++++++++++++++++++++++ drivers/net/phy/phylink.c | 60 +++++++++++++++++++++++++++++++++++- include/linux/pcs/pcs.h | 65 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 173 insertions(+), 1 deletion(-)
drivers/net/pcs/pcs.c +49 -0
@@ -22,6 +22,19 @@ struct fwnode_pcs_provider {static LIST_HEAD (fwnode_pcs_providers);static DEFINE_MUTEX (fwnode_pcs_mutex); +static BLOCKING_NOTIFIER_HEAD (fwnode_pcs_notify_list); + +int register_fwnode_pcs_notifier (struct notifier_block *nb) +{ +return blocking_notifier_chain_register (&fwnode_pcs_notify_list, nb); +} +EXPORT_SYMBOL_GPL (register_fwnode_pcs_notifier); + +int unregister_fwnode_pcs_notifier (struct notifier_block *nb) +{ +return blocking_notifier_chain_unregister (&fwnode_pcs_notify_list, nb); +} +EXPORT_SYMBOL_GPL (unregister_fwnode_pcs_notifier);struct phylink_pcs *fwnode_pcs_simple_get (struct fwnode_reference_args *pcsspec,void *data)
@@ -55,6 +68,10 @@ int fwnode_pcs_add_provider(struct fwnode_handle *fwnode,fwnode_dev_initialized (fwnode, true); +blocking_notifier_call_chain (&fwnode_pcs_notify_list, +FWNODE_PCS_PROVIDER_ADD , + fwnode); +return 0 ; }EXPORT_SYMBOL_GPL (fwnode_pcs_add_provider);
@@ -150,6 +167,38 @@ struct phylink_pcs *fwnode_pcs_get(struct fwnode_handle *fwnode, unsigned int in }EXPORT_SYMBOL_GPL (fwnode_pcs_get); +struct phylink_pcs * +fwnode_phylink_pcs_get_from_fwnode (struct fwnode_handle *fwnode, +struct fwnode_handle *pcs_fwnode) +{ +struct fwnode_reference_args pcsspec; +int index =0 ; +int ret; + +/* Loop until we find a matching PCS node or +* fwnode_parse_pcsspec() returns error +* if we don't have any other PCS reference to check. +*/ +while (true) { + ret =fwnode_parse_pcsspec (fwnode, index,NULL , &pcsspec); +if (ret) +return ERR_PTR (ret); + +/* Exit loop if we found the matching PCS node */ +if (pcsspec.fwnode == pcs_fwnode) { +fwnode_handle_put (pcsspec.fwnode); +break ; + } + +/* Check the next PCS reference */ +fwnode_handle_put (pcsspec.fwnode); + index++; + } + +return fwnode_pcs_get (fwnode, index); +} +EXPORT_SYMBOL_GPL (fwnode_phylink_pcs_get_from_fwnode); +unsigned int fwnode_phylink_pcs_count (struct fwnode_handle *fwnode) {struct fwnode_reference_args out_args;
drivers/net/phy/phylink.c +59 -1
93 lines not on this page · raw message
include/linux/pcs/pcs.h +65 -0
90 lines not on this page · raw message
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH net-next v9 05/12] net: phylink: support late PCS provider attach
Thank you for your contribution! Sashiko AI review found 5 potential issue(s) to consider: - [Critical] Missing PCS removal notification leads to Use-After-Free when a PCS module is unloaded.…
Thank you for your contribution! Sashiko AI review found 5 potential issue(s) to consider:
- [Critical] Missing PCS removal notification leads to Use-After-Free when a PCS module is unloaded.
- [High] A TOCTOU race condition in phylink_create() can cause a newly added PCS provider to be permanently missed.
- [High] Unconditional list_add() in pcs_provider_notify() causes doubly-linked list corruption during concurrent additions.
- [High] Late PCS attachment fails for multi-port devices (e.g., DSA switches) due to incorrect fwnode lookup.
- [Medium] Synchronous acquisition of rtnl_lock() in the blocking notifier chain introduces a fragile self-deadlock risk. --
--- Patch [5]: [PATCH net-next v9 05/12] net: phylink: support late PCS provider attach --- commit 0738f7b893f648f2683558ff4efb6327359c5920
Author: Christian Marangi <[email protected]>
net: phylink: support late PCS provider attach
Add support for late PCS provider attachment to a phylink instance. This works by creating a global notifier for the PCS provider and making each phylink instance that makes use of fwnode subscribe to this notifier.
[ ... ]
Quoted 4 lines
drivers/net/phy/phylink.c +0
-0
[ ... ]
drivers/net/phy/phylink.c static int phylink_fill_available_pcs(struct phylink *pl, · line 2011
Quoted 12 lines
drivers/net/phy/phylink.c +8
-0@@ -1999,6 +2001,53 @@ static int phylink_fill_available_pcs(struct phylink *pl,return ret; } +static int pcs_provider_notify (struct notifier_block *self, +unsigned long val,void *data) +{ + struct phylink *pl = container_of(self, struct phylink, fwnode_pcs_nb); +struct fwnode_handle *pcs_fwnode = data; +struct phylink_pcs *pcs; + +rtnl_lock ();
[Severity: Medium]
Does unconditional acquisition of rtnl_lock() here risk a deadlock?
If a network driver registers a PCS provider from a context that already holds rtnl_lock() (which is common in network driver probe or open paths), wouldn't the synchronous notifier callback attempt to recursively acquire the lock and hang the system?
drivers/net/phy/phylink.c static int phylink_fill_available_pcs(struct phylink *pl, · line 2017
Quoted 6 lines
drivers/net/phy/phylink.c +6
-0+ +/* Check if the just added PCS provider is +* in the phylink instance pcs-handle property. +*/ + pcs =fwnode_phylink_pcs_get_from_fwnode (dev_fwnode (pl->config->dev), + pcs_fwnode);
[Severity: High]
Will this lookup fail for multi-port devices like DSA switches?
It seems to fetch the fwnode from the parent device (pl->config->dev) rather than the port-specific fwnode passed during phylink creation. If the pcs-handle property is in the port's subnode, will this return an error and silently abort the late attachment?
drivers/net/phy/phylink.c static int phylink_fill_available_pcs(struct phylink *pl, · line 2027
Quoted 10 lines
drivers/net/phy/phylink.c +10
-0+if (IS_ERR (pcs)) { +rtnl_unlock (); +return NOTIFY_DONE ; + } + +/* Add the PCS */ +mutex_lock (&pl->state_mutex); + +/* Link PCS with phylink */ +list_add (&pcs->list, &pl->pcs_list);
[Severity: High]
Could this corrupt the doubly-linked list if the PCS is already present?
If a PCS provider is added concurrently, it might already be picked up by phylink_fill_available_pcs() and then passed to this notifier. Calling list_add() unconditionally on a node already in the list overwrites its pointers and causes list corruption.
Quoted 2 lines
drivers/net/phy/phylink.c +2
-0+ pcs->phylink = pl; +
[ ... ]
drivers/net/phy/phylink.c struct phylink *phylink_create(struct phylink_config *config, · line 2172
Quoted 9 lines
drivers/net/phy/phylink.c +5
-0@@ -2116,6 +2165,12 @@ struct phylink *phylink_create(struct phylink_config *config,if (ret <0 ) goto unlink_pcs_list; +/* Register notifier for late PCS attach */ +if (!phy_interface_empty (config->pcs_interfaces)) { + pl->fwnode_pcs_nb.notifier_call = pcs_provider_notify; +register_fwnode_pcs_notifier (&pl->fwnode_pcs_nb); + }
[Severity: High]
Is there a race condition between fetching available PCS providers and registering this notifier?
In phylink_create(), the list of available PCS providers is fetched earlier via phylink_fill_available_pcs(). If a PCS provider calls fwnode_pcs_add_provider() exactly after the list is fetched but before register_fwnode_pcs_notifier() is called here, wouldn't the provider be permanently missed since it wasn't in the global list initially and the notification was missed?
Quoted 3 lines
drivers/net/phy/phylink.c +0
-0return pl; unlink_pcs_list:
[ ... ]
include/linux/pcs/pcs.h line 9
Quoted 11 lines
include/linux/pcs/pcs.h +3
-0@@ -4,7 +4,36 @@#include <linux/phylink.h> +enum fwnode_pcs_notify_event { +FWNODE_PCS_PROVIDER_ADD , +};
[Severity: Critical]
Does the lack of a removal notification event create a use-after-free risk?
If a PCS provider module is unloaded, fwnode_pcs_del_provider() is called to free internal state, but phylink is never notified because there is no FWNODE_PCS_PROVIDER_DEL event.
Won't the freed pointer remain linked in pl->pcs_list and be dereferenced during the next phylink_resolve() run triggered by a timer or link state change?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=5
PATCH v9 6/12 net: Document PCS subsystem
In reply to Christian MarangiAdd extensive documentation of the new PCS subsystem and the fwnode implementation with producer/consumer API.
--- Documentation/networking/index.rst | 1 + Documentation/networking/pcs.rst | 229 +++++++++++++++++++++++++++++ 2 files changed, 230 insertions(+) create mode 100644 Documentation/networking/pcs.rst
Documentation/networking/index.rst +1 -0
@@ -28,6 +28,7 @@ Contents: net_failover page_pool phy + pcs sfp-phylink alias bridge
Documentation/networking/pcs.rst new file +229 -0
229 lines not on this page · raw message
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH net-next v9 06/12] net: Document PCS subsystem
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [High] phylink_create() returns an invalid non-error pointer (or NULL) on invalid config->type. --
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [High] phylink_create() returns an invalid non-error pointer (or NULL) on invalid config->type. --
--- Patch [6]: [PATCH net-next v9 06/12] net: Document PCS subsystem --- commit 867ad4be39467be718a5df59cf2a9739b1c43531
Author: Christian Marangi <[email protected]>
net: phylink: introduce internal phylink PCS handling
This commit introduces internal handling of PCS for phylink, moving the selection logic to phylink using the supported_interface value. It updates phylink_create() to allocate and populate an array of PCS pointers from the MAC, creating a linked list of available PCS devices. The changes also include new validation to ensure a selected PCS supports the requested interfaces.
Quoted 4 lines
drivers/net/phy/phylink.c +0
-0
[ ... ]
Quoted 1 line
drivers/net/phy/phylink.c +0
-0@@ -1854,13 +1964,17 @@ struct phylink *phylink_create(struct phylink_config *config,
[ ... ]
Quoted 4 lines
drivers/net/phy/phylink.c +4
-0+/* Fill the PCS list with available PCS from phylink config */ + ret =phylink_fill_available_pcs (pl, config); +if (ret <0 ) + goto free_pl;
[ ... ]
drivers/net/phy/phylink.c struct phylink *phylink_create(struct phylink_config *config, · line 2015
Quoted 10 lines
drivers/net/phy/phylink.c +1
-2pl->config = config;if (config->type ==PHYLINK_NETDEV ) { pl->netdev =to_net_dev (config->dev);@@ -1882,8 +2012,7 @@ struct phylink *phylink_create(struct phylink_config *config, }else if (config->type ==PHYLINK_DEV ) { pl->dev = config->dev; }else { -kfree (pl); -return ERR_PTR (-EINVAL ); + goto unlink_pcs_list;
[Severity: High]
Can this jump to unlink_pcs_list return an invalid pointer instead of an error?
If config->type is invalid, the code jumps to unlink_pcs_list without setting 'ret = -EINVAL'. Because 'ret' still holds the non-negative result from phylink_fill_available_pcs(), ERR_PTR(ret) will return a valid-looking pointer (or NULL) instead of an error pointer.
This would bypass the caller's IS_ERR() check and could lead to a crash when they attempt to use the returned phylink pointer.
Quoted 2 lines
drivers/net/phy/phylink.c +0
-0}
[ ... ]
Quoted 8 lines
drivers/net/phy/phylink.c +6
-0+unlink_pcs_list: +list_for_each_entry (pcs, &pl->pcs_list, list) + pcs->phylink =NULL ; +free_pl: +kfree (pl); +return ERR_PTR (ret); }EXPORT_SYMBOL_GPL (phylink_create);
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=6
Re: [PATCH net-next v9 06/12] net: Document PCS subsystem
In reply to Christian MarangiQuoted 50 lines · Christian Marangi
Add extensive documentation of the new PCS subsystem and the fwnode implementation with producer/consumer API.
Signed-off-by Christian Marangi <[email protected]>--- Documentation/networking/index.rst | 1 + Documentation/networking/pcs.rst | 229 +++++++++++++++++++++++++++++ 2 files changed, 230 insertions(+) create mode 100644 Documentation/networking/pcs.rstDocumentation/networking/index.rst +1
-0@@ -28,6 +28,7 @@ Contents: net_failover page_pool phy + pcs sfp-phylink alias bridgeDocumentation/networking/pcs.rst new file +22
-0@@ -0,0 +1,229 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============= +PCS Subsystem +============= + +The PCS (Physical Coding Sublayer) subsystem handles the registration and lookup +of PCS devices. These devices contain the upper sublayers of the Ethernet +physical layer, generally handling framing, scrambling, and encoding tasks. PCS +devices may also include PMA (Physical Medium Attachment) components. PCS +devices transfer data between the Link-layer MAC device, and the rest of the +physical layer, typically via a serdes. The output of the serdes may be +connected more-or-less directly to the medium when using fiber-optic or +backplane connections (1000BASE-SX, 1000BASE-KX, etc). It may also communicate +with a separate PHY (such as over SGMII) which handles the connection to the +medium (such as 1000BASE-T). + +Remark on usage of .mac_select_pcs and fw_node PCS +-------------------------------------------------- + +There are generally two ways to look up a PCS device. +
Documentation/networking/pcs.rst line 32
Quoted 10 lines
Documentation/networking/pcs.rst new file +10
-0+1. MAC OP struct .mac_select_pcs (considered legacy) +2. firmware node (fwnode) PCS entirely handled by phylink + +Implementation 1 leaves the entire handling of the PCS to the MAC +driver with the selection of the PCS driven by .mac_select_pcs. +Custom implementations are required if the PCS is external to the MAC +and needs to be handled by a separate driver. + +This implementation is considered legacy and it's suggested to +switch to the new fwnode PCS.
The .mac_select_pcs can be deprecated, with the .fill_available_pcs() mecanism available, we can keep PCS implems inside the MAC driver when it makes sense, no ?
If PCSs aren't described in firmware (i.e. DT), we have to use .fill_available_pcs() without using the fwnode API if I get your code right.
The 'legacy' part is the only remark I have, the rest is all good :)
Maxime
Quoted 197 lines
Documentation/networking/pcs.rst new file +197
-0+ +Looking up PCS Devices (fwnode implementation) +----------------------------------------------- + +The lookup of a PCS device follows the common producer/consumer implementation +used by similar subsystems with a ``#pcs-cells`` on the producer and a +``pcs-handle`` property on the consumer:: + + pcs: pcs { + // ... + #pcs-cells = <0>; + }; + + ethernet-controller { + // ... + pcs-handle = <&pcs>; + }; + +On :c:func:`phylink_create`, phylink will use the ``num_possible_pcs`` +value and ``fill_available_pcs`` helper function in +:c:struct:`phylink_config` to compose the list of available PCS that can be +used for the phylink instance. + +Phylink will then internally handle the selection of the correct PCS for +the requested interface mode based on the interface modes configured in +``pcs_interfaces`` in :c:struct:`phylink_config` struct and +``supported_interfaces`` in :c:struct:`phylink_pcs` struct. + +A PCS is considered eligible when the requested interface mode is present +in both ``pcs_interfaces`` in :c:struct:`phylink_config` struct and +``supported_interfaces`` in :c:struct:`phylink_pcs` struct. + +``supported_interfaces`` describes all interface modes supported by the MAC, +whereas ``pcs_interfaces`` identifies the subset that require PCS selection. + +For the special implementation where the PCS is internal or part of the MAC +and a dedicated driver is not needed, it's possible to leave the implementation +of the PCS to the MAC driver and just implement the ``num_possible_pcs`` +value and ``fill_available_pcs`` helper function in +:c:struct:`phylink_config` referencing the local :c:struct:`phylink_pcs` +struct allocated from the MAC driver. + +Using PCS Devices +----------------- + +It's mandatory to either implement the ``mac_select_pcs`` callback +of :c:struct:`phylink_mac_ops` or ``num_possible_pcs`` and ``fill_available_pcs`` +of :c:struct:`phylink_config` to use a PCS for a MAC. + +The fwnode implementation exposes simple helpers to parse the PCS from +the fwnode :c:func:`fwnode_phylink_pcs_count` and +:c:func:`fwnode_phylink_pcs_parse`. The :c:func:`fwnode_phylink_pcs_count` helper +takes the fwnode where the ``pcs-handle`` should be parsed and return the +number of PCS entries described in the fwnode. +The :c:func:`fwnode_phylink_pcs_parse` helper takes three arguments, +the fwnode where the ``pcs-handle`` should be parsed, an allocated array +of :c:struct:`phylink_pcs` pointer where to put the parsed PCS from the fwnode +and the maximum number of PCS to parse. +Contrary to :c:func:`fwnode_phylink_pcs_count`, :c:func:`fwnode_phylink_pcs_parse` +helper fills the allocated array with ONLY the available PCS and return the +number of available PCS found. PCS that returns -ENODEV will be skipped and +won't be inserted in the allocated array. + +A phylink instance may use multiple PCS devices. The maximum number is reported +through ``num_possible_pcs``. + +It's mandatory to specify for what interface a PCS is needed. This can be done +by filling the ``pcs_interfaces`` in :c:struct:`phylink_config` struct. +If the requested interface mode is not present in this bitmask, phylink does +not search for a PCS for that specific mode. (example MAC doesn't need a PCS +for SGMII but require one for USXGMII) + +With the use of the :c:func:`fwnode_phylink_pcs_parse` a common implementation +is the following:: + + static int mac_fill_available_pcs(struct phylink_config *config, + struct phylink_pcs **available_pcs, + unsigned int num_possible_pcs) + { + struct device *dev = config->dev; + + return fwnode_phylink_pcs_parse(dev_fwnode(dev), available_pcs, + num_possible_pcs); + } + + static int mac_setup_phylink(struct net_device *netdev) + { + struct phylink_config *config; + + // ... + + config->dev = &netdev->dev; + + // ... + + // Parse possible PCS and fill num_possible_pcs. + config->num_possible_pcs = fwnode_phylink_pcs_count(dev_fwnode(&netdev->dev)); + config->fill_available_pcs = mac_fill_available_pcs; + + __set_bit(PHY_INTERFACE_MODE_INTERNAL, config->supported_interfaces); + __set_bit(PHY_INTERFACE_MODE_SGMII, config->supported_interfaces); + __set_bit(PHY_INTERFACE_MODE_1000BASEX, config->supported_interfaces); + __set_bit(PHY_INTERFACE_MODE_USXGMII, config->supported_interfaces); + + // PCS required only for USXGMII + __set_bit(PHY_INTERFACE_MODE_USXGMII, config->pcs_interfaces); + + phylink = phylink_create(config, //... + +It's worth to mention that it's phylink code that takes care of allocating +the array of :c:struct:`phylink_pcs` pointer for ``fill_available_pcs`` +callback based on the value set in ``num_possible_pcs`` for +:c:struct:`phylink_config` struct. + +The ``fill_available_pcs`` callback must not write more than +``num_possible_pcs`` entries. The third argument may be used to validate +that there is enough space to fill all the available PCS in the passed array +of :c:struct:`phylink_pcs` pointer. + +The ``fill_available_pcs`` callback is called only on :c:func:`phylink_create` +and is used only to compose the initial available PCS list. Ownership of PCS +is held by phylink and :c:func:`phylink_release_pcs` should be used to release +them. + +Writing PCS Drivers +------------------- + +To write a PCS driver, first implement :c:struct:`phylink_pcs_ops`. Then, +register your PCS in your probe function using :c:func:`fwnode_pcs_add_provider`. +The :c:func:`fwnode_pcs_add_provider` takes three arguments, the fwnode where +the PCS provider should be registered to, a get function to return the requested +PCS based on ``#pcs-cells`` and a pointer to reference private data for the get +function. + +The PCS will then be registered to a global list of PCS provider that the +PCS fwnode implementation will use to parse it. + +For the simple case where the PCS driver expose a single PCS, +:c:func:`fwnode_pcs_simple_get` can be used as the get function. + +You must call :c:func:`fwnode_pcs_del_provider` from your remove function and +release the PCS from any phylink instance under RTNL lock with +:c:func:`phylink_release_pcs`:: + + fwnode_pcs_del_provider(dev_fwnode(&pdev->dev)); + + rtnl_lock(); + + for (i = 0; i < data->num_port; i++) { + struct pcs_port *port = &priv->ports[i]; + + phylink_release_pcs(&port->pcs); + } + + rtnl_unlock(); + +Late PCS registration handling +------------------------------ + +It's possible that a PCS becomes available after the MAC finished probing. +Contrary to the usual producer/consumer implementation, when a PCS is not +registered and can't be found, the fwnode parser helper returns ``-ENODEV`` +instead of ``-EPROBE_DEFER``. + +This is to prevent race condition with particular devices that register +MAC and PCS with USB or PCIe and require the MAC to be registered before +the PCS. + +The phylink logic correctly handle this special case and keep the phylink +instance in a fail condition. + +The PCS fwnode implementation provides a notifier to which each phylink +instance with a non-empty ``pcs_interfaces`` in :c:type:`phylink_config` +registers. When a new PCS provider is registered, the notifier is called +triggering the :c:func:`pcs_provider_notify` function. + +Function :c:func:`pcs_provider_notify` will check if the just added PCS +should be used by the phylink instance. If it should be used then, +it's added to the internal list of available PCS and a phylink major +config is forced. + +If a phylink instance was in a failure state, with the just added PCS +now part of the available PCS internal phylink list, provided all other +conditions are satisfied, the configuration is retried and the failure +condition is cleared. + +API Reference +------------- + +.. kernel-doc:: include/linux/phylink.h + :identifiers: phylink_pcs + +.. kernel-doc:: include/linux/pcs/pcs.h + :internal: + +.. kernel-doc:: include/linux/pcs/pcs-provider.h + :internal:
Re: [PATCH net-next v9 06/12] net: Document PCS subsystem
Quoted 59 lines · Maxime Chevallier
Quoted 56 lines · Christian Marangi
Add extensive documentation of the new PCS subsystem and the fwnode implementation with producer/consumer API.
Signed-off-by Christian Marangi <[email protected]>--- Documentation/networking/index.rst | 1 + Documentation/networking/pcs.rst | 229 +++++++++++++++++++++++++++++ 2 files changed, 230 insertions(+) create mode 100644 Documentation/networking/pcs.rstDocumentation/networking/index.rst +1
-0@@ -28,6 +28,7 @@ Contents: net_failover page_pool phy + pcs sfp-phylink alias bridgeDocumentation/networking/pcs.rst new file +28
-0@@ -0,0 +1,229 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============= +PCS Subsystem +============= + +The PCS (Physical Coding Sublayer) subsystem handles the registration and lookup +of PCS devices. These devices contain the upper sublayers of the Ethernet +physical layer, generally handling framing, scrambling, and encoding tasks. PCS +devices may also include PMA (Physical Medium Attachment) components. PCS +devices transfer data between the Link-layer MAC device, and the rest of the +physical layer, typically via a serdes. The output of the serdes may be +connected more-or-less directly to the medium when using fiber-optic or +backplane connections (1000BASE-SX, 1000BASE-KX, etc). It may also communicate +with a separate PHY (such as over SGMII) which handles the connection to the +medium (such as 1000BASE-T). + +Remark on usage of .mac_select_pcs and fw_node PCS +-------------------------------------------------- + +There are generally two ways to look up a PCS device. + +1. MAC OP struct .mac_select_pcs (considered legacy) +2. firmware node (fwnode) PCS entirely handled by phylink + +Implementation 1 leaves the entire handling of the PCS to the MAC +driver with the selection of the PCS driven by .mac_select_pcs. +Custom implementations are required if the PCS is external to the MAC
Quoted 8 lines
Documentation/networking/pcs.rst line 32
Quoted 4 lines
Documentation/networking/pcs.rst new file +4
-0+and needs to be handled by a separate driver. + +This implementation is considered legacy and it's suggested to +switch to the new fwnode PCS.The .mac_select_pcs can be deprecated, with the .fill_available_pcs() mecanism available, we can keep PCS implems inside the MAC driver when it makes sense, no ?
Yes that is the idea but it might take a while to deprecate it.
Quoted 3 lines
If PCSs aren't described in firmware (i.e. DT), we have to use .fill_available_pcs() without using the fwnode API if I get your code right.
Yes everything should be described that way.
Quoted 3 lines
The 'legacy' part is the only remark I have, the rest is all good :)
Any hint on the wording? I remember you already said something about this. I will check previous review.
Quoted 198 lines
Quoted 197 lines
Documentation/networking/pcs.rst new file +197
-0+ +Looking up PCS Devices (fwnode implementation) +----------------------------------------------- + +The lookup of a PCS device follows the common producer/consumer implementation +used by similar subsystems with a ``#pcs-cells`` on the producer and a +``pcs-handle`` property on the consumer:: + + pcs: pcs { + // ... + #pcs-cells = <0>; + }; + + ethernet-controller { + // ... + pcs-handle = <&pcs>; + }; + +On :c:func:`phylink_create`, phylink will use the ``num_possible_pcs`` +value and ``fill_available_pcs`` helper function in +:c:struct:`phylink_config` to compose the list of available PCS that can be +used for the phylink instance. + +Phylink will then internally handle the selection of the correct PCS for +the requested interface mode based on the interface modes configured in +``pcs_interfaces`` in :c:struct:`phylink_config` struct and +``supported_interfaces`` in :c:struct:`phylink_pcs` struct. + +A PCS is considered eligible when the requested interface mode is present +in both ``pcs_interfaces`` in :c:struct:`phylink_config` struct and +``supported_interfaces`` in :c:struct:`phylink_pcs` struct. + +``supported_interfaces`` describes all interface modes supported by the MAC, +whereas ``pcs_interfaces`` identifies the subset that require PCS selection. + +For the special implementation where the PCS is internal or part of the MAC +and a dedicated driver is not needed, it's possible to leave the implementation +of the PCS to the MAC driver and just implement the ``num_possible_pcs`` +value and ``fill_available_pcs`` helper function in +:c:struct:`phylink_config` referencing the local :c:struct:`phylink_pcs` +struct allocated from the MAC driver. + +Using PCS Devices +----------------- + +It's mandatory to either implement the ``mac_select_pcs`` callback +of :c:struct:`phylink_mac_ops` or ``num_possible_pcs`` and ``fill_available_pcs`` +of :c:struct:`phylink_config` to use a PCS for a MAC. + +The fwnode implementation exposes simple helpers to parse the PCS from +the fwnode :c:func:`fwnode_phylink_pcs_count` and +:c:func:`fwnode_phylink_pcs_parse`. The :c:func:`fwnode_phylink_pcs_count` helper +takes the fwnode where the ``pcs-handle`` should be parsed and return the +number of PCS entries described in the fwnode. +The :c:func:`fwnode_phylink_pcs_parse` helper takes three arguments, +the fwnode where the ``pcs-handle`` should be parsed, an allocated array +of :c:struct:`phylink_pcs` pointer where to put the parsed PCS from the fwnode +and the maximum number of PCS to parse. +Contrary to :c:func:`fwnode_phylink_pcs_count`, :c:func:`fwnode_phylink_pcs_parse` +helper fills the allocated array with ONLY the available PCS and return the +number of available PCS found. PCS that returns -ENODEV will be skipped and +won't be inserted in the allocated array. + +A phylink instance may use multiple PCS devices. The maximum number is reported +through ``num_possible_pcs``. + +It's mandatory to specify for what interface a PCS is needed. This can be done +by filling the ``pcs_interfaces`` in :c:struct:`phylink_config` struct. +If the requested interface mode is not present in this bitmask, phylink does +not search for a PCS for that specific mode. (example MAC doesn't need a PCS +for SGMII but require one for USXGMII) + +With the use of the :c:func:`fwnode_phylink_pcs_parse` a common implementation +is the following:: + + static int mac_fill_available_pcs(struct phylink_config *config, + struct phylink_pcs **available_pcs, + unsigned int num_possible_pcs) + { + struct device *dev = config->dev; + + return fwnode_phylink_pcs_parse(dev_fwnode(dev), available_pcs, + num_possible_pcs); + } + + static int mac_setup_phylink(struct net_device *netdev) + { + struct phylink_config *config; + + // ... + + config->dev = &netdev->dev; + + // ... + + // Parse possible PCS and fill num_possible_pcs. + config->num_possible_pcs = fwnode_phylink_pcs_count(dev_fwnode(&netdev->dev)); + config->fill_available_pcs = mac_fill_available_pcs; + + __set_bit(PHY_INTERFACE_MODE_INTERNAL, config->supported_interfaces); + __set_bit(PHY_INTERFACE_MODE_SGMII, config->supported_interfaces); + __set_bit(PHY_INTERFACE_MODE_1000BASEX, config->supported_interfaces); + __set_bit(PHY_INTERFACE_MODE_USXGMII, config->supported_interfaces); + + // PCS required only for USXGMII + __set_bit(PHY_INTERFACE_MODE_USXGMII, config->pcs_interfaces); + + phylink = phylink_create(config, //... + +It's worth to mention that it's phylink code that takes care of allocating +the array of :c:struct:`phylink_pcs` pointer for ``fill_available_pcs`` +callback based on the value set in ``num_possible_pcs`` for +:c:struct:`phylink_config` struct. + +The ``fill_available_pcs`` callback must not write more than +``num_possible_pcs`` entries. The third argument may be used to validate +that there is enough space to fill all the available PCS in the passed array +of :c:struct:`phylink_pcs` pointer. + +The ``fill_available_pcs`` callback is called only on :c:func:`phylink_create` +and is used only to compose the initial available PCS list. Ownership of PCS +is held by phylink and :c:func:`phylink_release_pcs` should be used to release +them. + +Writing PCS Drivers +------------------- + +To write a PCS driver, first implement :c:struct:`phylink_pcs_ops`. Then, +register your PCS in your probe function using :c:func:`fwnode_pcs_add_provider`. +The :c:func:`fwnode_pcs_add_provider` takes three arguments, the fwnode where +the PCS provider should be registered to, a get function to return the requested +PCS based on ``#pcs-cells`` and a pointer to reference private data for the get +function. + +The PCS will then be registered to a global list of PCS provider that the +PCS fwnode implementation will use to parse it. + +For the simple case where the PCS driver expose a single PCS, +:c:func:`fwnode_pcs_simple_get` can be used as the get function. + +You must call :c:func:`fwnode_pcs_del_provider` from your remove function and +release the PCS from any phylink instance under RTNL lock with +:c:func:`phylink_release_pcs`:: + + fwnode_pcs_del_provider(dev_fwnode(&pdev->dev)); + + rtnl_lock(); + + for (i = 0; i < data->num_port; i++) { + struct pcs_port *port = &priv->ports[i]; + + phylink_release_pcs(&port->pcs); + } + + rtnl_unlock(); + +Late PCS registration handling +------------------------------ + +It's possible that a PCS becomes available after the MAC finished probing. +Contrary to the usual producer/consumer implementation, when a PCS is not +registered and can't be found, the fwnode parser helper returns ``-ENODEV`` +instead of ``-EPROBE_DEFER``. + +This is to prevent race condition with particular devices that register +MAC and PCS with USB or PCIe and require the MAC to be registered before +the PCS. + +The phylink logic correctly handle this special case and keep the phylink +instance in a fail condition. + +The PCS fwnode implementation provides a notifier to which each phylink +instance with a non-empty ``pcs_interfaces`` in :c:type:`phylink_config` +registers. When a new PCS provider is registered, the notifier is called +triggering the :c:func:`pcs_provider_notify` function. + +Function :c:func:`pcs_provider_notify` will check if the just added PCS +should be used by the phylink instance. If it should be used then, +it's added to the internal list of available PCS and a phylink major +config is forced. + +If a phylink instance was in a failure state, with the just added PCS +now part of the available PCS internal phylink list, provided all other +conditions are satisfied, the configuration is retried and the failure +condition is cleared. + +API Reference +------------- + +.. kernel-doc:: include/linux/phylink.h + :identifiers: phylink_pcs + +.. kernel-doc:: include/linux/pcs/pcs.h + :internal: + +.. kernel-doc:: include/linux/pcs/pcs-provider.h + :internal:
Signature · 1 line
Ansuel
PATCH v9 7/12 MAINTAINERS: add myself as PCS subsystem maintainer
In reply to Christian MarangiList all the files of the Ethernet PCS subsystem and add myself as maintainer.
--- MAINTAINERS | 9 +++++++++ 1 file changed, 9 insertions(+)
MAINTAINERS +9 -0
@@ -9682,6 +9682,15 @@ F: include/uapi/linux/if_bridge.h F: include/linux/netfilter_bridge/ F: net/bridge/ +ETHERNET PCS SUBSYSTEM +M: Christian Marangi <[email protected]> +L: [email protected] +S: Maintained +F: Documentation/networking/pcs.rst +F: drivers/net/pcs/pcs.c +F: include/linux/pcs/pcs-provider.h +F: include/linux/pcs/pcs.h + ETHERNET PHY LIBRARY M: Andrew Lunn <[email protected]> M: Heiner Kallweit <[email protected]>
Signature · 1 line
2.53.0
PATCH v9 8/12 of: property: fw_devlink: Add support for "pcs-handle"
In reply to Christian MarangiAdd support for parsing PCS binding so that fw_devlink can enforce the dependency with Ethernet port.
--- drivers/of/property.c | 2 ++ 1 file changed, 2 insertions(+)
drivers/of/property.c +2 -0
@@ -1415,6 +1415,7 @@ DEFINE_SIMPLE_PROP(access_controllers, "access-controllers", "#access-controller DEFINE_SIMPLE_PROP(pses, "pses", "#pse-cells") DEFINE_SIMPLE_PROP(power_supplies, "power-supplies", NULL) DEFINE_SIMPLE_PROP(mmc_pwrseq, "mmc-pwrseq", NULL) +DEFINE_SIMPLE_PROP(pcs_handle, "pcs-handle", "#pcs-cells") DEFINE_SUFFIX_PROP(regulators, "-supply", NULL)DEFINE_SUFFIX_PROP (gpio,"-gpio" ,"#gpio-cells" )
@@ -1571,6 +1572,7 @@ static const struct supplier_bindings of_supplier_bindings[] = { { .parse_prop = parse_interrupts, }, { .parse_prop = parse_interrupt_map, }, { .parse_prop = parse_access_controllers, }, + { .parse_prop = parse_pcs_handle, }, { .parse_prop = parse_regulators, }, { .parse_prop = parse_gpio, }, { .parse_prop = parse_gpios, },
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH net-next v9 08/12] of: property: fw_devlink: Add support for "pcs-handle"
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [High] Adding `pcs-handle` to `fw_devlink` supplier bindings defeats the dynamic 'late PCS provider…
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [High] Adding pcs-handle to fw_devlink supplier bindings defeats the dynamic 'late PCS provider attach' and hotplug logic in phylink. --
--- Patch [8]: [PATCH net-next v9 08/12] of: property: fw_devlink: Add support for "pcs-handle" --- commit f6fc253d355d434feccac1a9dee68ebce25d5fe8
Author: Christian Marangi <[email protected]>
of: property: fw_devlink: Add support for "pcs-handle"
This commit adds support for parsing the "pcs-handle" binding, allowing fw_devlink to enforce device dependencies with Ethernet ports.
Quoted 4 lines
drivers/of/property.c +0
-0
[ ... ]
drivers/of/property.c static const struct supplier_bindings of_supplier_bindings[] = { · line 1575
Quoted 5 lines
drivers/of/property.c +1
-0@@ -1571,6 +1572,7 @@ static const struct supplier_bindings of_supplier_bindings[] = { { .parse_prop = parse_interrupts, }, { .parse_prop = parse_interrupt_map, }, { .parse_prop = parse_access_controllers, }, + { .parse_prop = parse_pcs_handle, },
[Severity: High]
Does enforcing a strict supplier-consumer dependency here conflict with the dynamic hotplug and late-attach logic in phylink?
If fw_devlink creates a managed device link for pcs-handle, it enforces strict boot ordering. This prevents the MAC from probing before the PCS, which blocks phylink's late-attach feature.
Additionally, because fw_devlink applies DL_FLAG_AUTOREMOVE_CONSUMER, unloading the PCS module would cause the driver core to unceremoniously unbind the MAC driver and remove the network interface. This circumvents phylink's graceful link down handling via phylink_release_pcs().
Since similar properties like phy-handle are intentionally omitted from of_supplier_bindings to allow for dynamic PHY/PCS presence, should pcs-handle also be excluded to preserve these phylink features?
Quoted 3 lines
drivers/of/property.c +0
-0{ .parse_prop = parse_regulators, }, { .parse_prop = parse_gpio, }, { .parse_prop = parse_gpios, },
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=8
PATCH v9 9/12 net: phylink: add .pcs_link_down PCS OP
In reply to Christian MarangiPermit for PCS driver to define specific operation to tear down the link between the MAC and the PCS.
This might be needed for some PCS that reset counter or require special reset to correctly work if the link needs to be restored later.
On phylink_link_down() call, the additional phylink_pcs_link_down() will be called after .mac_link_down to tear down the link.
PCS driver will need to define .pcs_link_down to make use of this.
--- drivers/net/phy/phylink.c | 9 +++++++++ include/linux/phylink.h | 12 ++++++++++++ 2 files changed, 21 insertions(+)
drivers/net/phy/phylink.c +9 -0
@@ -1037,6 +1037,12 @@ static void phylink_pcs_link_up(struct phylink_pcs *pcs, unsigned int neg_mode, pcs->ops->pcs_link_up (pcs, neg_mode, interface, speed, duplex); } +static void phylink_pcs_link_down (struct phylink_pcs *pcs) +{ +if (pcs && pcs->ops->pcs_link_down) + pcs->ops->pcs_link_down (pcs); +} +static void phylink_pcs_disable_eee (struct phylink_pcs *pcs) {if (pcs && pcs->ops->pcs_disable_eee)
@@ -1738,6 +1744,9 @@ static void phylink_link_down(struct phylink *pl) pl->mac_ops->mac_link_down (pl->config, pl->act_link_an_mode, pl->cur_interface); + +phylink_pcs_link_down (pl->pcs); +phylink_info (pl,"Link is Down\n" ); }
include/linux/phylink.h +12 -0
@@ -528,6 +528,7 @@ struct phylink_pcs {* @pcs_an_restart: restart 802.3z BaseX autonegotiation. * @pcs_link_up: program the PCS for the resolved link configuration * (where necessary). +* @pcs_link_down: tear down link between MAC and PCS. * @pcs_disable_eee: optional notification to PCS that EEE has been disabled * at the MAC. * @pcs_enable_eee: optional notification to PCS that EEE will be enabled at
@@ -555,6 +556,7 @@ struct phylink_pcs_ops {void (*pcs_an_restart)(struct phylink_pcs *pcs);void (*pcs_link_up)(struct phylink_pcs *pcs,unsigned int neg_mode,phy_interface_t interface,int speed,int duplex); +void (*pcs_link_down)(struct phylink_pcs *pcs);void (*pcs_disable_eee)(struct phylink_pcs *pcs);void (*pcs_enable_eee)(struct phylink_pcs *pcs);int (*pcs_pre_init)(struct phylink_pcs *pcs);
@@ -690,6 +692,16 @@ void pcs_an_restart(struct phylink_pcs *pcs);void pcs_link_up (struct phylink_pcs *pcs,unsigned int neg_mode,phy_interface_t interface,int speed,int duplex); +/** +* pcs_link_up() - tear down link between MAC and PCS +* @pcs: a pointer to a &struct phylink_pcs. +* +* This call will be made just after mac_link_down() to inform the PCS the +* link has gone down. PCS should be configured to stop processing packets +* for transmission and reception. +*/ +void pcs_link_down (struct phylink_pcs *pcs); +/** * pcs_disable_eee() - Disable EEE at the PCS * @pcs: a pointer to a &struct phylink_pcs
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH net-next v9 09/12] net: phylink: add .pcs_link_down PCS OP
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Low] The kernel-doc comment for `pcs_link_down()` incorrectly names the function as `pcs_link_up()`, due…
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] The kernel-doc comment for pcs_link_down() incorrectly names the function as pcs_link_up(), due to a copy-paste error. --
--- Patch [9]: [PATCH net-next v9 09/12] net: phylink: add .pcs_link_down PCS OP --- commit 44243b57b5aa440d9df2c5da5110db53f51717a0
Author: Christian Marangi <[email protected]>
net: phylink: add .pcs_link_down PCS OP
This commit adds a .pcs_link_down operation to the phylink_pcs_ops structure, allowing PCS drivers to define specific link teardown behavior. The new callback is invoked during phylink_link_down() immediately after the MAC link is brought down.
[ ... ]
include/linux/phylink.h void pcs_an_restart(struct phylink_pcs *pcs); · line 696
Quoted 10 lines
include/linux/phylink.h +2
-0@@ -690,6 +692,16 @@ void pcs_an_restart(struct phylink_pcs *pcs);void pcs_link_up (struct phylink_pcs *pcs,unsigned int neg_mode,phy_interface_t interface,int speed,int duplex); +/** +* pcs_link_up() - tear down link between MAC and PCS
[Severity: Low]
This isn't a bug, but should this kernel-doc name be pcs_link_down() to match the function prototype below it? This copy-paste typo will likely cause a kernel-doc documentation build warning.
Quoted 7 lines
include/linux/phylink.h +7
-0+* @pcs: a pointer to a &struct phylink_pcs. +* +* This call will be made just after mac_link_down() to inform the PCS the +* link has gone down. PCS should be configured to stop processing packets +* for transmission and reception. +*/ +void pcs_link_down (struct phylink_pcs *pcs);
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=9
Re: [PATCH net-next v9 09/12] net: phylink: add .pcs_link_down PCS OP
In reply to Christian MarangiHi,
Quoted 12 lines · Christian Marangi
Permit for PCS driver to define specific operation to tear down the link between the MAC and the PCS.
This might be needed for some PCS that reset counter or require special reset to correctly work if the link needs to be restored later.
On
phylink_link_down()call, the additionalphylink_pcs_link_down()will be called after .mac_link_down to tear down the link.PCS driver will need to define .pcs_link_down to make use of this.
Signed-off-by Christian Marangi <[email protected]>
[...]
Quoted 3 lines
+/**
+ *pcs_link_up()- tear down link between MAC and PCS
^^^^^^^^^^^
should be pcs_link_down() :)
With this fixed,
Maxime
PATCH v9 10/12 dt-bindings: net: pcs: Document support for Airoha Ethernet PCS
In reply to Christian MarangiDocument support for Airoha Ethernet PCS for AN7581 SoC.
Airoha AN7581 SoC expose multiple Physical Coding Sublayer (PCS) for the various Serdes port supporting different Media Independent Interface (10BASE-R, USXGMII, 2500BASE-X, 1000BASE-X, SGMII).
This follow the new PCS provider with the use of #pcs-cells property.
--- .../bindings/net/pcs/airoha,pcs.yaml | 261 ++++++++++++++++++ 1 file changed, 261 insertions(+) create mode 100644 Documentation/devicetree/bindings/net/pcs/airoha,pcs.yaml
Documentation/devicetree/bindings/net/pcs/airoha,pcs.yaml new file +261 -0
@@ -0,0 +1,261 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/net/pcs/airoha,pcs.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Airoha Ethernet PCS and Serdes + +maintainers: + - Christian Marangi <[email protected]> + +description: + Airoha AN7581 SoC expose multiple Physical Coding Sublayer (PCS) for + the various Serdes port supporting different Media Independent Interface + (10BASE-R, USXGMII, 2500BASE-X, 1000BASE-X, SGMII). + +properties: + compatible: + enum: + - airoha,an7581-pcs-eth + - airoha,an7581-pcs-pon + - airoha,an7581-pcs-pcie + - airoha,an7581-pcs-usb + + reg: + minItems: 6 + maxItems: 15 + + reg-names: + minItems: 6 + maxItems: 15 + + airoha,scu: + $ref: /schemas/types.yaml#/definitions/phandle + description: phandle to the SCU node required to configure + the serdes line to the correct interface mode. + + phys: + maxItems: 1 + + "#pcs-cells": true + +required: + - compatible + - reg + - reg-names + - "#pcs-cells" + +allOf: + - if: + properties: + compatible: + contains: + enum: + - airoha,an7581-pcs-eth + - airoha,an7581-pcs-pon + + then: + properties: + reg: + items: + - description: PCS MAC reg + - description: HSGMII AN reg + - description: HSGMII PCS reg + - description: MULTI SGMII reg + - description: USXGMII reg + - description: HSGMII rate adaption reg + - description: PCS Analog register + - description: PCS PMA (Physical Medium Attachment) register + + reg-names: + items: + - const: pcs_mac + - const: hsgmii_an + - const: hsgmii_pcs + - const: multi_sgmii + - const: usxgmii + - const: hsgmii_rate_adp + - const: pcs_ana + - const: pcs_pma + + phys: false + + "#pcs-cells": + const: 0 + + required: + - airoha,scu + + - if: + properties: + compatible: + contains: + const: airoha,an7581-pcs-pcie + + then: + properties: + reg: + items: + - description: PCS MAC 0 reg + - description: HSGMII AN 0 reg + - description: HSGMII PCS 0 reg + - description: MULTI SGMII 0 reg + - description: USXGMII 0 reg + - description: HSGMII rate adaption 0 reg + - description: PCS MAC 1 reg + - description: HSGMII AN 1 reg + - description: HSGMII PCS 1 reg + - description: MULTI SGMII 1 reg + - description: USXGMII 1 reg + - description: HSGMII rate adaption 1 reg + - description: PCS Analog register + - description: PCS PMA (Physical Medium Attachment) 0 register + - description: PCS PMA (Physical Medium Attachment) 1 register + + reg-names: + items: + - const: pcs_mac0 + - const: hsgmii_an0 + - const: hsgmii_pcs0 + - const: multi_sgmii0 + - const: usxgmii0 + - const: hsgmii_rate_adp0 + - const: pcs_mac1 + - const: hsgmii_an1 + - const: hsgmii_pcs1 + - const: multi_sgmii1 + - const: usxgmii1 + - const: hsgmii_rate_adp1 + - const: pcs_ana + - const: pcs_pma0 + - const: pcs_pma1 + + phys: false + + "#pcs-cells": + const: 1 + + required: + - airoha,scu + + - if: + properties: + compatible: + contains: + const: airoha,an7581-pcs-usb + + then: + properties: + reg: + items: + - description: PCS MAC reg + - description: HSGMII AN reg + - description: HSGMII PCS reg + - description: MULTI SGMII reg + - description: HSGMII rate adaption reg + - description: PCS Analog register + + reg-names: + items: + - const: pcs_mac + - const: hsgmii_an + - const: hsgmii_pcs + - const: multi_sgmii + - const: hsgmii_rate_adp + - const: pcs_ana + + airoha,scu: false + + "#pcs-cells": + const: 0 + + required: + - phys + +additionalProperties: false + +examples: + - | + #include <dt-bindings/phy/phy.h> + + pcs@1fa08000 { + compatible = "airoha,an7581-pcs-pon"; + reg = <0x1fa08000 0x1000>, + <0x1fa80000 0x60>, + <0x1fa80a00 0x164>, + <0x1fa84000 0x450>, + <0x1fa85900 0x338>, + <0x1fa86000 0x300>, + <0x1fa8a000 0x1000>, + <0x1fa8b000 0x1000>; + reg-names = "pcs_mac", "hsgmii_an", "hsgmii_pcs", + "multi_sgmii", "usxgmii", + "hsgmii_rate_adp", "pcs_ana", "pcs_pma"; + + airoha,scu = <&scuclk>; + #pcs-cells = <0>; + }; + + pcs@1fa09000 { + compatible = "airoha,an7581-pcs-eth"; + reg = <0x1fa09000 0x1000>, + <0x1fa70000 0x60>, + <0x1fa70a00 0x164>, + <0x1fa74000 0x450>, + <0x1fa75900 0x338>, + <0x1fa76000 0x300>, + <0x1fa7a000 0x1000>, + <0x1fa7b000 0x1000>; + reg-names = "pcs_mac", "hsgmii_an", "hsgmii_pcs", + "multi_sgmii", "usxgmii", + "hsgmii_rate_adp", "pcs_ana", "pcs_pma"; + + airoha,scu = <&scuclk>; + #pcs-cells = <0>; + }; + + pcs@1fa04000 { + compatible = "airoha,an7581-pcs-pcie"; + reg = <0x1fa04000 0x1000>, + <0x1fa50000 0x60>, + <0x1fa50a00 0x164>, + <0x1fa54000 0x450>, + <0x1fa55900 0x338>, + <0x1fa56000 0x300>, + <0x1fa05000 0x1000>, + <0x1fa60000 0x60>, + <0x1fa60a00 0x164>, + <0x1fa64000 0x450>, + <0x1fa65900 0x338>, + <0x1fa66000 0x300>, + <0x1fa5a000 0x1000>, + <0x1fa5b000 0x1000>, + <0x1fa5c000 0x1000>; + reg-names = "pcs_mac0", "hsgmii_an0", "hsgmii_pcs0", + "multi_sgmii0", "usxgmii0", + "hsgmii_rate_adp0", + "pcs_mac1", "hsgmii_an1", "hsgmii_pcs1", + "multi_sgmii1", "usxgmii1", + "hsgmii_rate_adp1", + "pcs_ana", "pcs_pma0", "pcs_pma1"; + + airoha,scu = <&scuclk>; + #pcs-cells = <1>; + }; + + pcs@1fa07000 { + compatible = "airoha,an7581-pcs-usb"; + reg = <0x1fa07000 0x1000>, + <0x1fa90000 0x60>, + <0x1fa90a00 0x164>, + <0x1fa94000 0x450>, + <0x1fa96000 0x300>, + <0x1fa9a000 0x600>; + reg-names = "pcs_mac", "hsgmii_an", "hsgmii_pcs", + "multi_sgmii", "hsgmii_rate_adp","pcs_ana"; + + phys = <&usb0_phy PHY_TYPE_USB3>; + + #pcs-cells = <0>; + };
Signature · 1 line
2.53.0
PATCH v9 11/12 net: pcs: airoha: add PCS driver for Airoha AN7581 SoC
In reply to Christian MarangiAdd PCS driver for Airoha AN7581 SoC for Ethernet/PON/PCIe/USB SERDES and permit usage of external PHY or connected SFP cage. Supported modes are USXGMII, 10G-BASER, 2500BASE-X, 1000BASE-X and SGMII.
The driver probe and register the various needed registers and register as a PCS provider for fwnode usage.
--- drivers/net/pcs/Kconfig | 2 + drivers/net/pcs/Makefile | 2 + drivers/net/pcs/airoha/Kconfig | 12 + drivers/net/pcs/airoha/Makefile | 7 + drivers/net/pcs/airoha/pcs-airoha-common.c | 1324 +++++++++++++ drivers/net/pcs/airoha/pcs-airoha.h | 1311 ++++++++++++ drivers/net/pcs/airoha/pcs-an7581.c | 2093 ++++++++++++++++++++ 7 files changed, 4751 insertions(+) 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
drivers/net/pcs/Kconfig +2 -0
@@ -41,4 +41,6 @@ config PCS_RZN1_MIIC Renesas RZ/N1, RZ/N2H, and RZ/T2H SoCs. This PCS converts MII to RMII/RGMII, or can be set in pass-through mode for MII. +source "drivers/net/pcs/airoha/Kconfig" + endmenu
drivers/net/pcs/Makefile +2 -0
@@ -9,3 +9,5 @@ obj-$(CONFIG_PCS_XPCS) += pcs_xpcs.o obj-$(CONFIG_PCS_LYNX) += pcs-lynx.o obj-$(CONFIG_PCS_MTK_LYNXI) += pcs-mtk-lynxi.o obj-$(CONFIG_PCS_RZN1_MIIC) += pcs-rzn1-miic.o + +obj-$(CONFIG_PCS_AIROHA) += airoha/
drivers/net/pcs/airoha/Kconfig new file +12 -0
@@ -0,0 +1,12 @@ +# SPDX-License-Identifier: GPL-2.0-only + +config PCS_AIROHA + tristate + select FWNODE_PCS + +config PCS_AIROHA_AN7581 + tristate "Airoha AN7581 PCS driver" + select PCS_AIROHA + help + This module provides helper to phylink for managing the Airoha + AN7581 PCS for SoC Ethernet and PON SERDES.
drivers/net/pcs/airoha/Makefile new file +7 -0
@@ -0,0 +1,7 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-$(CONFIG_PCS_AIROHA) := pcs-airoha.o +pcs-airoha-objs := pcs-airoha-common.o +ifdef CONFIG_PCS_AIROHA_AN7581 +pcs-airoha-objs += pcs-an7581.o +endif
drivers/net/pcs/airoha/pcs-airoha-common.c new file +1324 -0
1,324 lines not on this page · raw message
drivers/net/pcs/airoha/pcs-airoha.h new file +1311 -0
1,311 lines not on this page · raw message
drivers/net/pcs/airoha/pcs-an7581.c new file +2093 -0
335 lines not on this page · raw message
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.53.0
Part of the diff is not shown here. View the raw message.
[email protected]
AI reviewRe: [PATCH net-next v9 11/12] net: pcs: airoha: add PCS driver for Airoha AN7581 SoC
Thank you for your contribution! Sashiko AI review found 7 potential issue(s) to consider: - [High] SPEED_10 configuration incorrectly sets MAC link mode to 100M instead of 10M. - [High]…
Thank you for your contribution! Sashiko AI review found 7 potential issue(s) to consider:
- [High] SPEED_10 configuration incorrectly sets MAC link mode to 100M instead of 10M.
- [High] AN_FORCE_CL37 auto-negotiation register is mistakenly written to the hsgmii_pcs regmap instead of hsgmii_an.
- [High] Generic PHY is acquired for USB port types but never initialized or powered on.
- [High] Stack variables are used uninitialized due to unchecked regmap_read() return values.
- [High] Initialization of a single port incorrectly resets and modifies shared hardware state (reset lines and PLLs) used by other active ports.
- [High] Zero-delay MMIO polling loop immediately after a hardware trigger causes unreliable signal detection.
- [Medium] Read-modify-write operation on W1C (write-1-to-clear) interrupt status registers accidentally clears unmasked interrupts. --
--- Patch [11]: [PATCH net-next v9 11/12] net: pcs: airoha: add PCS driver for Airoha AN7581 SoC --- commit 87ad2d5e05008754a1a8736668451b5aa64ba606
Author: Christian Marangi <[email protected]> Date: Fri Jul 17 06:54:11 2026 +0000
net: pcs: airoha: add PCS driver for Airoha AN7581 SoC
This commit adds a new PCS driver for the Airoha AN7581 SoC, supporting Ethernet, PON, PCIe, and USB SERDES. The driver provides support for various operating modes including USXGMII, 10G-BASER, 2500BASE-X, 1000BASE-X, and SGMII.
Quoted 6 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +0
-0@@ -0,0 +1,1324 @@
[ ... ]
Quoted 13 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +13
-0+static int airoha_pcs_setup_scu (struct airoha_pcs_priv *priv, +int index,phy_interface_t interface) +{ +const struct airoha_pcs_match_data *data = priv->data; +int ret; + +switch (data->port_type) { +case AIROHA_PCS_ETH : +airoha_pcs_setup_scu_eth (priv, interface); +break ; +case AIROHA_PCS_PON : +airoha_pcs_setup_scu_pon (priv, interface); +break ;
drivers/net/pcs/airoha/pcs-airoha-common.c line 136
Quoted 10 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +10
-0+case AIROHA_PCS_PCIE : +airoha_pcs_setup_scu_pcie (priv, index, interface); +break ; +case AIROHA_PCS_USB : +break ; + } + +/* TODO better handle reset from MAC */ + ret =reset_control_bulk_assert (ARRAY_SIZE (priv->rsts), + priv->rsts);
[Severity: High]
Does this assert shared device-level reset lines that might affect other active ports on the MAC? If so, this could interrupt connections on those ports during initialization.
Quoted 10 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +10
-0+if (ret) +return ret; + + ret =reset_control_bulk_deassert (ARRAY_SIZE (priv->rsts), + priv->rsts); +if (ret) +return ret; + +return 0 ; +}
[ ... ]
Quoted 29 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +29
-0+static void airoha_pcs_interrupt_init_usxgmii (struct airoha_pcs_priv *priv, +int index) +{ +struct airoha_pcs_maps *maps = &priv->maps[index]; + +/* Disable every Interrupt */ +regmap_clear_bits (maps->usxgmii_pcs,AIROHA_PCS_USXGMII_PCS_CTRL_0 , +AIROHA_PCS_USXGMII_T_TYPE_T_INT_EN | +AIROHA_PCS_USXGMII_T_TYPE_D_INT_EN | +AIROHA_PCS_USXGMII_T_TYPE_C_INT_EN | +AIROHA_PCS_USXGMII_T_TYPE_S_INT_EN ); + +regmap_clear_bits (maps->usxgmii_pcs,AIROHA_PCS_USXGMII_PCS_CTRL_1 , +AIROHA_PCS_USXGMII_R_TYPE_C_INT_EN | +AIROHA_PCS_USXGMII_R_TYPE_S_INT_EN | +AIROHA_PCS_USXGMII_TXPCS_FSM_ENC_ERR_INT_EN | +AIROHA_PCS_USXGMII_T_TYPE_E_INT_EN ); + +regmap_clear_bits (maps->usxgmii_pcs,AIROHA_PCS_USXGMII_PCS_CTRL_2 , +AIROHA_PCS_USXGMII_RPCS_FSM_DEC_ERR_INT_EN | +AIROHA_PCS_USXGMII_R_TYPE_E_INT_EN | +AIROHA_PCS_USXGMII_R_TYPE_T_INT_EN | +AIROHA_PCS_USXGMII_R_TYPE_D_INT_EN ); + +regmap_clear_bits (maps->usxgmii_pcs,AIROHA_PCS_USXGMII_PCS_CTRL_3 , +AIROHA_PCS_USXGMII_FAIL_SYNC_XOR_ST_INT_EN | +AIROHA_PCS_USXGMII_RX_BLOCK_LOCK_ST_INT_EN | +AIROHA_PCS_USXGMII_LINK_UP_ST_INT_EN | +AIROHA_PCS_USXGMII_HI_BER_ST_INT_EN );
drivers/net/pcs/airoha/pcs-airoha-common.c line 282
Quoted 10 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +10
-0+ +regmap_clear_bits (maps->usxgmii_pcs,AIROHA_PCS_USXGMII_PCS_CTRL_4 , +AIROHA_PCS_USXGMII_LINK_DOWN_ST_INT_EN ); + +/* Clear any pending interrupt */ +regmap_set_bits (maps->usxgmii_pcs,AIROHA_PCS_USXGMII_PCS_INT_STA_2 , +AIROHA_PCS_USXGMII_RPCS_FSM_DEC_ERR_INT | +AIROHA_PCS_USXGMII_R_TYPE_E_INT | +AIROHA_PCS_USXGMII_R_TYPE_T_INT | +AIROHA_PCS_USXGMII_R_TYPE_D_INT );
[Severity: Medium]
Will using a read-modify-write operation like regmap_set_bits on a write-1-to-clear interrupt status register inadvertently read all pending interrupts as 1s and write them back, thereby clearing all pending interrupts and not just the masked ones?
Quoted 6 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +6
-0+ +regmap_set_bits (maps->usxgmii_pcs,AIROHA_PCS_USXGMII_PCS_INT_STA_3 , +AIROHA_PCS_USXGMII_FAIL_SYNC_XOR_ST_INT | +AIROHA_PCS_USXGMII_RX_BLOCK_LOCK_ST_INT | +AIROHA_PCS_USXGMII_LINK_UP_ST_INT | +AIROHA_PCS_USXGMII_HI_BER_ST_INT );
[ ... ]
drivers/net/pcs/airoha/pcs-airoha-common.c line 328
Quoted 13 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +13
-0+static void airoha_pcs_get_state_sgmii (struct airoha_pcs_priv *priv, +unsigned int neg_mode,int index, +struct phylink_link_state *state) +{ +struct airoha_pcs_maps *maps = &priv->maps[index]; +u32 bmsr, lpa; + +regmap_read (maps->hsgmii_an,AIROHA_PCS_HSGMII_AN_SGMII_REG_AN_1 , + &bmsr); +regmap_read (maps->hsgmii_an,AIROHA_PCS_HSGMII_AN_SGMII_REG_AN_5 , + &lpa); + + bmsr = (AIROHA_PCS_HSGMII_AN_SGMII_AN_COMPLETE |
[Severity: High]
If regmap_read() fails here, wouldn't bmsr and lpa be left uninitialized? Evaluating uninitialized stack variables might lead to random state machine behavior. Can we add return value checks here?
Quoted 7 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +7
-0+AIROHA_PCS_HSGMII_AN_SGMII_REMOTE_FAULT | +AIROHA_PCS_HSGMII_AN_SGMII_AN_ABILITY | + AIROHA_PCS_HSGMII_AN_SGMII_LINK_STATUS) & bmsr; + lpa =AIROHA_PCS_HSGMII_AN_SGMII_PARTNER_ABILITY & lpa; + +phylink_mii_c22_pcs_decode_state (state, neg_mode, bmsr, lpa); +}
[ ... ]
Quoted 5 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +5
-0+static int airoha_pcs_config (struct phylink_pcs *pcs,unsigned int neg_mode, +phy_interface_t interface, +const unsigned long *advertising, +bool permit_pause_to_mac) +{
[ ... ]
drivers/net/pcs/airoha/pcs-airoha-common.c line 640
Quoted 7 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +7
-0+if (interface ==PHY_INTERFACE_MODE_1000BASEX && + neg_mode !=PHYLINK_PCS_NEG_INBAND_ENABLED ) { +regmap_set_bits (maps->hsgmii_pcs,AIROHA_PCS_HSGMII_PCS_CTROL_1 , +AIROHA_PCS_SGMII_SEND_AN_ERR_EN ); + +regmap_set_bits (maps->hsgmii_pcs,AIROHA_PCS_HSGMII_AN_SGMII_REG_AN_FORCE_CL37 , +AIROHA_PCS_HSGMII_AN_FORCE_AN_DONE );
[Severity: High]
Is AIROHA_PCS_HSGMII_AN_SGMII_REG_AN_FORCE_CL37 being written to the wrong regmap here? It appears to be an auto-negotiation register that should be written to the hsgmii_an block, rather than hsgmii_pcs.
Quoted 6 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +6
-0+ } + +if (interface ==PHY_INTERFACE_MODE_2500BASEX ) { +regmap_set_bits (maps->hsgmii_an,AIROHA_PCS_HSGMII_AN_SGMII_REG_AN_0 , +AIROHA_PCS_HSGMII_AN_SGMII_RESET_PHY ); + }
[ ... ]
Quoted 3 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +3
-0+static void airoha_pcs_link_up (struct phylink_pcs *pcs,unsigned int neg_mode, +phy_interface_t interface,int speed,int duplex) +{
[ ... ]
Quoted 14 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +14
-0+if (interface ==PHY_INTERFACE_MODE_SGMII || + interface ==PHY_INTERFACE_MODE_2500BASEX ) { +u32 ck_gen_mode; +u32 speed_reg; +u32 if_mode; + +switch (speed) { +case SPEED_2500 : + speed_reg =AIROHA_PCS_LINK_MODE_P0_2_5G ; +break ; +case SPEED_1000 : + speed_reg =AIROHA_PCS_LINK_MODE_P0_1G ; + if_mode =AIROHA_PCS_HSGMII_AN_SPEED_FORCE_MODE_1000 ; + ck_gen_mode =AIROHA_PCS_HSGMII_PCS_FORCE_CUR_SGMII_MODE_1000 ;
drivers/net/pcs/airoha/pcs-airoha-common.c line 813
Quoted 10 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +10
-0+break ; +case SPEED_100 : + speed_reg =AIROHA_PCS_LINK_MODE_P0_100M ; + if_mode =AIROHA_PCS_HSGMII_AN_SPEED_FORCE_MODE_100 ; + ck_gen_mode =AIROHA_PCS_HSGMII_PCS_FORCE_CUR_SGMII_MODE_100 ; +break ; +case SPEED_10 : + speed_reg =AIROHA_PCS_LINK_MODE_P0_100M ; + if_mode =AIROHA_PCS_HSGMII_AN_SPEED_FORCE_MODE_10 ; + ck_gen_mode =AIROHA_PCS_HSGMII_PCS_FORCE_CUR_SGMII_MODE_10 ;
[Severity: High]
Does SPEED_10 mistakenly assign the 100M constant to speed_reg instead of AIROHA_PCS_LINK_MODE_P0_10M? This looks like it might incorrectly program the hardware to 100Mbps.
Quoted 7 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +7
-0+break ; + } + +if (interface ==PHY_INTERFACE_MODE_SGMII ) { +regmap_update_bits (maps->hsgmii_an,AIROHA_PCS_HSGMII_AN_SGMII_REG_AN_13 , +AIROHA_PCS_HSGMII_AN_SPEED_FORCE_MODE , + if_mode);
[ ... ]
Quoted 19 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +19
-0+static int airoha_pcs_probe (struct platform_device *pdev) +{ +const struct airoha_pcs_match_data *data; +struct device *dev = &pdev->dev; +struct airoha_pcs_priv *priv; +int index, ret; + + data =of_device_get_match_data (dev); + + priv =devm_kzalloc (dev,sizeof (*priv),GFP_KERNEL ); +if (!priv) +return -ENOMEM ; + + priv->ports =devm_kcalloc (dev, data->num_port, +sizeof (*priv->ports),GFP_KERNEL ); +if (!priv->ports) +return -ENOMEM ; + + priv->dev = dev;
drivers/net/pcs/airoha/pcs-airoha-common.c line 1160
Quoted 10 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +10
-0+ priv->data = data; + +if (data->port_type ==AIROHA_PCS_USB ) { +struct phy *phy; + + phy =devm_phy_get (dev,NULL ); +if (IS_ERR (phy)) +return dev_err_probe (dev,PTR_ERR (phy),"failed to get phy\n" ); + + priv->phy = phy;
[Severity: High]
The generic PHY is acquired for USB port types, but does it ever get initialized or powered on anywhere else in the driver? It appears the hardware might remain powered down without a call to phy_init() and phy_power_on().
Quoted 3 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +3
-0+ } + +switch (data->port_type) {
[ ... ]
Quoted 6 lines
drivers/net/pcs/airoha/pcs-an7581.c new file +0
-0@@ -0,0 +1,2093 @@
[ ... ]
Quoted 30 lines
drivers/net/pcs/airoha/pcs-an7581.c new file +30
-0+static void an7581_pcs_jcpll_bringup (struct airoha_pcs_priv *priv, +int index,phy_interface_t interface) +{ +struct regmap_field **pcs_ana_fields = priv->pcs_ana_fields[index]; +struct regmap *pcs_pma; +u32 kband_vref; + +switch (interface) { +case PHY_INTERFACE_MODE_SGMII : +case PHY_INTERFACE_MODE_1000BASEX : +case PHY_INTERFACE_MODE_2500BASEX : + kband_vref =0x10 ; +break ; +case PHY_INTERFACE_MODE_USXGMII : +case PHY_INTERFACE_MODE_10GBASER : + kband_vref =0xf ; +break ; +default : +return ; + } + +/* This comment only apply to Serdes PCIe that expose +* 2 PCS. +* +* The Serdes PCIe expose 2 PCS but always require +* the PMA for the first PCS to be configured +* for correct functionality for JCPLL. +*/ + pcs_pma = priv->pcs_pma[0 ]; +
drivers/net/pcs/airoha/pcs-an7581.c line 713
Quoted 10 lines
drivers/net/pcs/airoha/pcs-an7581.c new file +10
-0+/* Setup LDO */ +usleep_range (200 ,300 ); + +regmap_field_set_bits (pcs_ana_fields[AN7581_PCS_JCPLL_SPARE_L ], +AIROHA_PCS_ANA_JCPLL_SPARE_L_LDO ); + +/* Setup RSTB */ +regmap_field_write (pcs_ana_fields[AN7581_PCS_JCPLL_RST_DLY ], +AIROHA_PCS_ANA_JCPLL_RST_DLY_150_200 ); +regmap_field_write (pcs_ana_fields[AN7581_PCS_JCPLL_PLL_RSTB ],0x1 );
[Severity: High]
Does this code unconditionally modify port 0's JCPLL state and reset it, even when port 1 is being configured? If so, this could potentially destroy the active hardware state of the other port.
Quoted 6 lines
drivers/net/pcs/airoha/pcs-an7581.c new file +6
-0+ +/* Enable PLL force selection and Force Disable */ +regmap_update_bits (pcs_pma,AIROHA_PCS_PMA_PXP_JCPLL_CKOUT_EN , +AIROHA_PCS_PMA_FORCE_SEL_DA_JCPLL_EN | +AIROHA_PCS_PMA_FORCE_DA_JCPLL_EN , +AIROHA_PCS_PMA_FORCE_SEL_DA_JCPLL_EN );
[ ... ]
Quoted 4 lines
drivers/net/pcs/airoha/pcs-an7581.c new file +4
-0+static bool an7581_pcs_have_rx_signal (struct airoha_pcs_priv *priv,int index) +{ +struct regmap *pcs_pma = priv->pcs_pma[index]; +unsigned int count =0 ;
drivers/net/pcs/airoha/pcs-an7581.c line 2061
Quoted 10 lines
drivers/net/pcs/airoha/pcs-an7581.c new file +10
-0+u32 val; +int i; + +regmap_write (pcs_pma,AIROHA_PCS_PMA_DIG_RESERVE_0 , +AIROHA_PCS_TRIGGER_RX_SIDGET_SCAN ); + +/* Scan 6 times for RX sigdet module to detect RX signal */ +for (i =0 ; i <AIROHA_PCS_MAX_RX_SIGDET_TRY ; i++) { +regmap_read (pcs_pma,AIROHA_PCS_PMA_DIG_RO_RESERVE_2 , + &val);
[Severity: High]
Are these back-to-back regmap reads executed immediately after the hardware trigger without any delay? Since analog signal scans usually require some settling time, could the loop finish before the hardware completes the scan, resulting in unreliable signal detection?
Quoted 7 lines
drivers/net/pcs/airoha/pcs-an7581.c new file +7
-0+if (val &AIROHA_PCS_RX_SIGDET ) + count++; + } + +/* Consider signal presence if we detect signal at least 4 times */ +return count >=AIROHA_PCS_MAX_RX_SIGDET_PRESENCE_CNT ; +}
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=11
Re: [PATCH net-next v9 11/12] net: pcs: airoha: add PCS driver for Airoha AN7581 SoC
In reply to Christian MarangiQuoted 23 lines · Christian Marangi
Add PCS driver for Airoha AN7581 SoC for Ethernet/PON/PCIe/USB SERDES and permit usage of external PHY or connected SFP cage. Supported modes are USXGMII, 10G-BASER, 2500BASE-X, 1000BASE-X and SGMII.
The driver probe and register the various needed registers and register as a PCS provider for fwnode usage.
Signed-off-by Christian Marangi <[email protected]>--- drivers/net/pcs/Kconfig | 2 + drivers/net/pcs/Makefile | 2 + drivers/net/pcs/airoha/Kconfig | 12 + drivers/net/pcs/airoha/Makefile | 7 + drivers/net/pcs/airoha/pcs-airoha-common.c | 1324 +++++++++++++ drivers/net/pcs/airoha/pcs-airoha.h | 1311 ++++++++++++ drivers/net/pcs/airoha/pcs-an7581.c | 2093 ++++++++++++++++++++ 7 files changed, 4751 insertions(+) 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
[...]
Quoted 6 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +0
-0@@ -0,0 +1,1324 @@
[...]
Quoted 11 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +11
-0+static int airoha_pcs_setup_scu (struct airoha_pcs_priv *priv, +int index,phy_interface_t interface) +{ +const struct airoha_pcs_match_data *data = priv->data; +int ret; + +switch (data->port_type) { +case AIROHA_PCS_ETH : +airoha_pcs_setup_scu_eth (priv, interface); +break ; +case AIROHA_PCS_PON :
drivers/net/pcs/airoha/pcs-airoha-common.c line 134
Quoted 10 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +10
-0+airoha_pcs_setup_scu_pon (priv, interface); +break ; +case AIROHA_PCS_PCIE : +airoha_pcs_setup_scu_pcie (priv, index, interface); +break ; +case AIROHA_PCS_USB : +break ; + } + +/* TODO better handle reset from MAC */
What does this mean? There's a "mac" and a "phy" control in rsts. Should the "mac" reset be handled differently? Or is there a separate reset line that is controlled by the MAC itself?
drivers/net/pcs/airoha/pcs-airoha-common.c line 146
Quoted 12 lines
drivers/net/pcs/airoha/pcs-airoha-common.c new file +12
-0+ ret =reset_control_bulk_assert (ARRAY_SIZE (priv->rsts), + priv->rsts); +if (ret) +return ret; + + ret =reset_control_bulk_deassert (ARRAY_SIZE (priv->rsts), + priv->rsts); +if (ret) +return ret; + +return 0 ; +}
regards
Philipp
PATCH v9 12/12 net: airoha: add phylink support
In reply to Christian MarangiAdd phylink support for each GDM port. For GDM1 add the internal interface mode as the only supported mode. For GDM2/3/4 add the required configuration of the PCS to make the external PHY or attached SFP cage work.
These needs to be defined in the GDM port node using the pcs-handle property.
Update and provide a .get/set_link_ksettings function that use phylink for ethtool OPs now that we fully support phylink.
--- drivers/net/ethernet/airoha/Kconfig | 1 + drivers/net/ethernet/airoha/airoha_eth.c | 194 +++++++++++++++++++++- drivers/net/ethernet/airoha/airoha_eth.h | 7 +- drivers/net/ethernet/airoha/airoha_regs.h | 12 ++ 4 files changed, 207 insertions(+), 7 deletions(-)
drivers/net/ethernet/airoha/Kconfig +1 -0
@@ -20,6 +20,7 @@ config NET_AIROHA depends on NET_DSA || !NET_DSA select NET_AIROHA_NPU select PAGE_POOL + select PHYLINK help This driver supports the gigabit ethernet MACs in the Airoha SoC family.
drivers/net/ethernet/airoha/airoha_eth.c +189 -5
266 lines not on this page · raw message
drivers/net/ethernet/airoha/airoha_eth.h +5 -2
@@ -561,6 +561,9 @@ struct airoha_gdm_dev {int nbq;struct airoha_hw_stats stats; + +struct phylink *phylink; +struct phylink_config phylink_config; };struct airoha_gdm_port {
@@ -568,8 +571,8 @@ struct airoha_gdm_port {int id;int users; -/* protect concurrent hw_stats accesses */ -spinlock_t stats_lock; +/* protect concurrent hw_stats and frag register accesses */ +spinlock_t lock;struct metadata_dst *dsa_meta[AIROHA_MAX_DSA_PORTS ]; };
drivers/net/ethernet/airoha/airoha_regs.h +12 -0
@@ -357,6 +357,18 @@#define IP_FRAGMENT_PORT_MASK GENMASK(8, 5)#define IP_FRAGMENT_NBQ_MASK GENMASK(4, 0) +#define REG_FE_GDM4_TMBI_FRAG 0x2028 +#define GDM4_SGMII1_TX_WEIGHT_MASK GENMASK(31, 26) +#define GDM4_SGMII1_TX_FRAG_SIZE_MASK GENMASK(25, 16) +#define GDM4_SGMII0_TX_WEIGHT_MASK GENMASK(15, 10) +#define GDM4_SGMII0_TX_FRAG_SIZE_MASK GENMASK(9, 0) + +#define REG_FE_GDM4_RMBI_FRAG 0x202c +#define GDM4_SGMII1_RX_WEIGHT_MASK GENMASK(31, 26) +#define GDM4_SGMII1_RX_FRAG_SIZE_MASK GENMASK(25, 16) +#define GDM4_SGMII0_RX_WEIGHT_MASK GENMASK(15, 10) +#define GDM4_SGMII0_RX_FRAG_SIZE_MASK GENMASK(9, 0) +#define REG_MC_VLAN_EN 0x2100#define MC_VLAN_EN_MASK BIT(0)
Signature · 1 line
2.53.0
[email protected]
AI reviewRe: [PATCH net-next v9 12/12] net: airoha: add phylink support
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
New issues:
- [Medium] Missing phy-mode property now unconditionally causes probe failure, breaking old device trees.
Pre-existing issues:
- [High] The spinlock port->lock is acquired using spin_lock() in process contexts without disabling softirqs, creating a deadlock risk if interrupted by a softirq calling ndo_get_stats64. --
--- Patch [12]: [PATCH net-next v9 12/12] net: airoha: add phylink support --- commit bb8a7d4b36e6cc8dd02385bcf6f62f3da412aa5a
Author: Christian Marangi <[email protected]>
net: airoha: add phylink support
Add phylink support for each GDM port. For GDM1 add the internal interface mode as the only supported mode. For GDM2/3/4 add the required configuration of the PCS to make the external PHY or attached SFP cage work.
Quoted 4 lines
drivers/net/ethernet/airoha/airoha_eth.c +0
-0
[ ... ]
drivers/net/ethernet/airoha/airoha_eth.c static void airoha_update_hw_stats(struct airoha_gdm_dev *dev) · line 1841
Quoted 6 lines
drivers/net/ethernet/airoha/airoha_eth.c +1
-1@@ -1837,7 +1838,7 @@ static void airoha_update_hw_stats(struct airoha_gdm_dev *dev)struct airoha_gdm_port *port = dev->port;int i; -spin_lock (&port->stats_lock); +spin_lock (&port->lock);
[Severity: High]
This is a pre-existing issue, but using spin_lock() here without disabling softirqs creates a deadlock risk.
This function is called from process context (like ethtool callbacks), but it is also called by airoha_dev_get_stats64() which can run in softirq context. If a softirq interrupts the process-context caller while it holds port->lock, the softirq handler will attempt to acquire the same lock and spin forever.
Should all process-context acquisitions of this lock be updated to use spin_lock_bh() instead?
[ ... ]
Quoted 14 lines
drivers/net/ethernet/airoha/airoha_eth.c +14
-0+static void airoha_mac_link_up (struct phylink_config *config,struct phy_device *phy, +unsigned int mode,phy_interface_t interface, +int speed,int duplex,bool tx_pause,bool rx_pause) +{ + struct airoha_gdm_dev *dev = container_of(config, struct airoha_gdm_dev, + phylink_config); +struct airoha_gdm_port *port = dev->port; +struct airoha_eth *eth = dev->eth; +u32 frag_size_tx, frag_size_rx; +u32 mask, val; + +/* TX/RX frag is configured only for GDM4 */ +if (port->id !=AIROHA_GDM4_IDX ) +return ;
[ ... ]
drivers/net/ethernet/airoha/airoha_eth.c bool airoha_is_valid_gdm_dev(struct airoha_eth *eth, · line 3249
Quoted 3 lines
drivers/net/ethernet/airoha/airoha_eth.c +3
-0+spin_lock (&port->lock); + +/* Configure TX/RX frag based on speed */
[Severity: High]
This is a pre-existing issue with the locking design, but since airoha_mac_link_up() is a new process-context caller, using spin_lock() here introduces a new instance of the deadlock surface mentioned above against softirq callers like airoha_dev_get_stats64().
Should this be changed to spin_lock_bh() as well?
[ ... ]
Quoted 5 lines
drivers/net/ethernet/airoha/airoha_eth.c +5
-0+static int airoha_setup_phylink (struct net_device *netdev) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); +struct device_node *np = netdev->dev.of_node; +struct airoha_gdm_port *port = dev->port;
drivers/net/ethernet/airoha/airoha_eth.c bool airoha_is_valid_gdm_dev(struct airoha_eth *eth, · line 3311
Quoted 10 lines
drivers/net/ethernet/airoha/airoha_eth.c +10
-0+struct phylink_config *config; +phy_interface_t phy_mode; +struct phylink *phylink; +int err; + + err =of_get_phy_mode (np, &phy_mode); +if (err) { +dev_err (&netdev->dev,"incorrect phy-mode\n" ); +return err; + }
[Severity: Medium]
Does this mandatory check break backwards compatibility with older device trees?
If a device tree is missing the phy-mode property, this will now unconditionally fail the driver probe, whereas the previous driver version allowed successful probe without it.
Is there a fallback mode we should apply here instead of returning the error?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=12
Lorenzo Bianconi
maintainerRe: [PATCH net-next v9 12/12] net: airoha: add phylink support
In reply to Christian MarangiQuoted 44 lines
Add phylink support for each GDM port. For GDM1 add the internal interface mode as the only supported mode. For GDM2/3/4 add the required configuration of the PCS to make the external PHY or attached SFP cage work.
These needs to be defined in the GDM port node using the pcs-handle property.
Update and provide a .get/set_link_ksettings function that use phylink for ethtool OPs now that we fully support phylink.
Signed-off-by Christian Marangi <[email protected]>--- drivers/net/ethernet/airoha/Kconfig | 1 + drivers/net/ethernet/airoha/airoha_eth.c | 194 +++++++++++++++++++++- drivers/net/ethernet/airoha/airoha_eth.h | 7 +- drivers/net/ethernet/airoha/airoha_regs.h | 12 ++ 4 files changed, 207 insertions(+), 7 deletions(-)drivers/net/ethernet/airoha/Kconfig +1
-0@@ -20,6 +20,7 @@ config NET_AIROHA depends on NET_DSA || !NET_DSA select NET_AIROHA_NPU select PAGE_POOL + select PHYLINK help This driver supports the gigabit ethernet MACs in the Airoha SoC family.drivers/net/ethernet/airoha/airoha_eth.c +1
-0@@ -8,6 +8,7 @@#include <linux/of_reserved_mem.h> #include <linux/platform_device.h> #include <linux/tcp.h> +#include <linux/pcs/pcs.h> #include <linux/u64_stats_sync.h> #include <net/dst_metadata.h> #include <net/page_pool/helpers.h>
drivers/net/ethernet/airoha/airoha_eth.c static void airoha_update_hw_stats(struct airoha_gdm_dev *dev) · line 1841
Quoted 5 lines
drivers/net/ethernet/airoha/airoha_eth.c +1
-1@@ -1837,7 +1838,7 @@ static void airoha_update_hw_stats(struct airoha_gdm_dev *dev)struct airoha_gdm_port *port = dev->port;int i; -spin_lock (&port->stats_lock); +spin_lock (&port->lock);
Hi Christian,
as pointed out in a previous email, I do not like the approach of reusing this spin_lock for airoha_mac_link_up(). Can we use rtl_lock() (when necessary) as pointed out before?
Regards,
Lorenzo
Quoted 315 lines
drivers/net/ethernet/airoha/airoha_eth.c +187
-4for (i =0 ; i <ARRAY_SIZE (port->devs); i++) {if (port->devs[i])@@ -1848,7 +1849,7 @@ static void airoha_update_hw_stats(struct airoha_gdm_dev *dev)airoha_fe_set (dev->eth,REG_FE_GDM_MIB_CLEAR (port->id),FE_GDM_MIB_RX_CLEAR_MASK |FE_GDM_MIB_TX_CLEAR_MASK ); -spin_unlock (&port->stats_lock); +spin_unlock (&port->lock); }static void airoha_dev_set_xmit_frame_size (struct net_device *netdev)@@ -1870,6 +1871,14 @@ static int airoha_dev_open(struct net_device *netdev)u32 pse_port =FE_PSE_PORT_PPE1 ;int err; + err =phylink_of_phy_connect (dev->phylink, netdev->dev.of_node,0 ); +if (err) { +netdev_err (netdev,"could not attach PHY: %d\n" , err); +return err; + } + +phylink_start (dev->phylink); +netif_tx_start_all_queues (netdev); err =airoha_set_vip_for_gdm_port (dev, true);if (err)@@ -1909,6 +1918,10 @@ static int airoha_dev_stop(struct net_device *netdev)airoha_set_gdm_port_fwd_cfg (qdma->eth,REG_GDM_FWD_CFG (port->id),FE_PSE_PORT_DROP ); + +phylink_stop (dev->phylink); +phylink_disconnect_phy (dev->phylink); +return 0 ; }@@ -2389,6 +2402,24 @@ airoha_ethtool_get_rmon_stats(struct net_device *netdev, }while (u64_stats_fetch_retry (&dev->stats.syncp, start)); } +static int +airoha_ethtool_get_link_ksettings (struct net_device *netdev, +struct ethtool_link_ksettings *cmd) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); + +return phylink_ethtool_ksettings_get (dev->phylink, cmd); +} + +static int +airoha_ethtool_set_link_ksettings (struct net_device *netdev, +const struct ethtool_link_ksettings *cmd) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); + +return phylink_ethtool_ksettings_set (dev->phylink, cmd); +} +static int airoha_qdma_set_chan_tx_sched (struct net_device *netdev,int channel,enum tx_sched_mode mode,const u16 *weights,u8 n_weights)@@ -3120,7 +3151,8 @@ static const struct ethtool_ops airoha_ethtool_ops = { .get_drvinfo = airoha_ethtool_get_drvinfo, .get_eth_mac_stats = airoha_ethtool_get_mac_stats, .get_rmon_stats = airoha_ethtool_get_rmon_stats, - .get_link_ksettings = phy_ethtool_get_link_ksettings, + .get_link_ksettings = airoha_ethtool_get_link_ksettings, + .set_link_ksettings = airoha_ethtool_set_link_ksettings, .get_link = ethtool_op_get_link, };@@ -3176,6 +3208,155 @@ bool airoha_is_valid_gdm_dev(struct airoha_eth *eth,return false; } +/* Nothing to do in MAC, everything is handled in PCS */ +static void airoha_mac_config (struct phylink_config *config,unsigned int mode, +const struct phylink_link_state *state) +{ +} + +static void airoha_mac_link_up (struct phylink_config *config,struct phy_device *phy, +unsigned int mode,phy_interface_t interface, +int speed,int duplex,bool tx_pause,bool rx_pause) +{ + struct airoha_gdm_dev *dev = container_of(config, struct airoha_gdm_dev, + phylink_config); +struct airoha_gdm_port *port = dev->port; +struct airoha_eth *eth = dev->eth; +u32 frag_size_tx, frag_size_rx; +u32 mask, val; + +/* TX/RX frag is configured only for GDM4 */ +if (port->id !=AIROHA_GDM4_IDX ) +return ; + +switch (speed) { +case SPEED_10000 : +case SPEED_5000 : + frag_size_tx =8 ; + frag_size_rx =8 ; +break ; +case SPEED_2500 : + frag_size_tx =2 ; + frag_size_rx =1 ; +break ; +default : + frag_size_tx =1 ; + frag_size_rx =0 ; + } + +spin_lock (&port->lock); + +/* Configure TX/RX frag based on speed */ +if (dev->nbq ==1 ) { + mask =GDM4_SGMII1_TX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII1_TX_FRAG_SIZE_MASK , + frag_size_tx); + }else { + mask =GDM4_SGMII0_TX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII0_TX_FRAG_SIZE_MASK , + frag_size_tx); + } +airoha_fe_rmw (eth,REG_FE_GDM4_TMBI_FRAG , mask, val); + +if (dev->nbq ==1 ) { + mask =GDM4_SGMII1_RX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII1_RX_FRAG_SIZE_MASK , + frag_size_rx); + }else { + mask =GDM4_SGMII0_RX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII0_RX_FRAG_SIZE_MASK , + frag_size_rx); + } +airoha_fe_rmw (eth,REG_FE_GDM4_RMBI_FRAG , mask, val); + +spin_unlock (&port->lock); +} + +/* Nothing to do in MAC, everything is handled in PCS */ +static void airoha_mac_link_down (struct phylink_config *config,unsigned int mode, +phy_interface_t interface) +{ +} + +static const struct phylink_mac_ops airoha_phylink_ops = { + .mac_config = airoha_mac_config, + .mac_link_up = airoha_mac_link_up, + .mac_link_down = airoha_mac_link_down, +}; + +static int airoha_fill_available_pcs (struct phylink_config *config, +struct phylink_pcs **available_pcs, +unsigned int num_possible_pcs) +{ +struct device *dev = config->dev; + +return fwnode_phylink_pcs_parse (dev_fwnode (dev), available_pcs, + num_possible_pcs); +} + +static int airoha_setup_phylink (struct net_device *netdev) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); +struct device_node *np = netdev->dev.of_node; +struct airoha_gdm_port *port = dev->port; +struct phylink_config *config; +phy_interface_t phy_mode; +struct phylink *phylink; +int err; + + err =of_get_phy_mode (np, &phy_mode); +if (err) { +dev_err (&netdev->dev,"incorrect phy-mode\n" ); +return err; + } + + config = &dev->phylink_config; + config->dev = &netdev->dev; + config->type =PHYLINK_NETDEV ; + +/* +* GDM1 only supports internal for Embedded Switch +* and doesn't require a PCS. +*/ +if (port->id ==AIROHA_GDM1_IDX ) { + config->mac_capabilities =MAC_ASYM_PAUSE |MAC_SYM_PAUSE | +MAC_10000FD ; + +__set_bit (PHY_INTERFACE_MODE_INTERNAL , + config->supported_interfaces); + }else { + config->mac_capabilities =MAC_ASYM_PAUSE |MAC_SYM_PAUSE | +MAC_10 |MAC_100 |MAC_1000 | +MAC_2500FD |MAC_5000FD |MAC_10000FD ; + + config->num_possible_pcs =fwnode_phylink_pcs_count (dev_fwnode (config->dev)); + config->fill_available_pcs = airoha_fill_available_pcs; + +__set_bit (PHY_INTERFACE_MODE_SGMII , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_1000BASEX , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_2500BASEX , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_10GBASER , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_USXGMII , + config->supported_interfaces); + +phy_interface_copy (config->pcs_interfaces, + config->supported_interfaces); + } + + phylink =phylink_create (config,of_fwnode_handle (np), + phy_mode, &airoha_phylink_ops); +if (IS_ERR (phylink)) +return PTR_ERR (phylink); + + dev->phylink = phylink; + +return 0 ; +} +static int airoha_alloc_gdm_device (struct airoha_eth *eth,struct airoha_gdm_port *port,int nbq,struct device_node *np)@@ -3239,7 +3420,7 @@ static int airoha_alloc_gdm_device(struct airoha_eth *eth, dev->nbq = nbq; port->devs[index] = dev; -return 0 ; +return airoha_setup_phylink (netdev); } static int airoha_alloc_gdm_port(struct airoha_eth *eth,@@ -3274,7 +3455,7 @@ static int airoha_alloc_gdm_port(struct airoha_eth *eth,return -ENOMEM ; port->id = id; -spin_lock_init (&port->stats_lock); +spin_lock_init (&port->lock); eth->ports[p] = port; err =airoha_metadata_dst_alloc (port);@@ -3471,6 +3652,8 @@ static int airoha_probe(struct platform_device *pdev) netdev =netdev_from_priv (dev);if (netdev->reg_state ==NETREG_REGISTERED )unregister_netdev (netdev); +if (dev->phylink) +phylink_destroy (dev->phylink);of_node_put (netdev->dev.of_node); }airoha_metadata_dst_free (port);@@ -3509,6 +3692,7 @@ static void airoha_remove(struct platform_device *pdev) netdev =netdev_from_priv (dev);unregister_netdev (netdev); +phylink_destroy (dev->phylink);of_node_put (netdev->dev.of_node); }airoha_metadata_dst_free (port);drivers/net/ethernet/airoha/airoha_eth.h +5
-2@@ -561,6 +561,9 @@ struct airoha_gdm_dev {int nbq;struct airoha_hw_stats stats; + +struct phylink *phylink; +struct phylink_config phylink_config; };struct airoha_gdm_port {@@ -568,8 +571,8 @@ struct airoha_gdm_port {int id;int users; -/* protect concurrent hw_stats accesses */ -spinlock_t stats_lock; +/* protect concurrent hw_stats and frag register accesses */ +spinlock_t lock;struct metadata_dst *dsa_meta[AIROHA_MAX_DSA_PORTS ]; };drivers/net/ethernet/airoha/airoha_regs.h +12
-0@@ -357,6 +357,18 @@#define IP_FRAGMENT_PORT_MASK GENMASK(8, 5)#define IP_FRAGMENT_NBQ_MASK GENMASK(4, 0) +#define REG_FE_GDM4_TMBI_FRAG 0x2028 +#define GDM4_SGMII1_TX_WEIGHT_MASK GENMASK(31, 26) +#define GDM4_SGMII1_TX_FRAG_SIZE_MASK GENMASK(25, 16) +#define GDM4_SGMII0_TX_WEIGHT_MASK GENMASK(15, 10) +#define GDM4_SGMII0_TX_FRAG_SIZE_MASK GENMASK(9, 0) + +#define REG_FE_GDM4_RMBI_FRAG 0x202c +#define GDM4_SGMII1_RX_WEIGHT_MASK GENMASK(31, 26) +#define GDM4_SGMII1_RX_FRAG_SIZE_MASK GENMASK(25, 16) +#define GDM4_SGMII0_RX_WEIGHT_MASK GENMASK(15, 10) +#define GDM4_SGMII0_RX_FRAG_SIZE_MASK GENMASK(9, 0) +#define REG_MC_VLAN_EN 0x2100#define MC_VLAN_EN_MASK BIT(0)Signature · 1 line
2.53.0
Re: [PATCH net-next v9 12/12] net: airoha: add phylink support
Quoted 47 lines · Lorenzo Bianconi
Quoted 47 lines
Add phylink support for each GDM port. For GDM1 add the internal interface mode as the only supported mode. For GDM2/3/4 add the required configuration of the PCS to make the external PHY or attached SFP cage work.
These needs to be defined in the GDM port node using the pcs-handle property.
Update and provide a .get/set_link_ksettings function that use phylink for ethtool OPs now that we fully support phylink.
Signed-off-by Christian Marangi <[email protected]>--- drivers/net/ethernet/airoha/Kconfig | 1 + drivers/net/ethernet/airoha/airoha_eth.c | 194 +++++++++++++++++++++- drivers/net/ethernet/airoha/airoha_eth.h | 7 +- drivers/net/ethernet/airoha/airoha_regs.h | 12 ++ 4 files changed, 207 insertions(+), 7 deletions(-)drivers/net/ethernet/airoha/Kconfig +1
-0@@ -20,6 +20,7 @@ config NET_AIROHA depends on NET_DSA || !NET_DSA select NET_AIROHA_NPU select PAGE_POOL + select PHYLINK help This driver supports the gigabit ethernet MACs in the Airoha SoC family.drivers/net/ethernet/airoha/airoha_eth.c +1
-0@@ -8,6 +8,7 @@#include <linux/of_reserved_mem.h> #include <linux/platform_device.h> #include <linux/tcp.h> +#include <linux/pcs/pcs.h> #include <linux/u64_stats_sync.h> #include <net/dst_metadata.h> #include <net/page_pool/helpers.h> @@ -1837,7 +1838,7 @@ static void airoha_update_hw_stats(struct airoha_gdm_dev *dev)struct airoha_gdm_port *port = dev->port;int i;
Quoted 9 lines
drivers/net/ethernet/airoha/airoha_eth.c static void airoha_update_hw_stats(struct airoha_gdm_dev *dev) · line 1841
Quoted 2 lines
drivers/net/ethernet/airoha/airoha_eth.c +1
-1-spin_lock (&port->stats_lock); +spin_lock (&port->lock);Hi Christian,
as pointed out in a previous email, I do not like the approach of reusing this
spin_lockforairoha_mac_link_up(). Can we usertl_lock()(when necessary) as pointed out before?
For context, quoting from the previous series, the suggestion is to use rtnl_is_locked() and then lock accordingly but I didn't find other usage of that in other driver (aside from core net) and I don't like the use of is_locked. I can already see the BOT saying that in the timeframe of is_locked and writing the register another interface goes up causing a race.
Guess I will add a simple mutex for this case and the other.
Quoted 315 lines
Quoted 315 lines
drivers/net/ethernet/airoha/airoha_eth.c +187
-4for (i =0 ; i <ARRAY_SIZE (port->devs); i++) {if (port->devs[i])@@ -1848,7 +1849,7 @@ static void airoha_update_hw_stats(struct airoha_gdm_dev *dev)airoha_fe_set (dev->eth,REG_FE_GDM_MIB_CLEAR (port->id),FE_GDM_MIB_RX_CLEAR_MASK |FE_GDM_MIB_TX_CLEAR_MASK ); -spin_unlock (&port->stats_lock); +spin_unlock (&port->lock); }static void airoha_dev_set_xmit_frame_size (struct net_device *netdev)@@ -1870,6 +1871,14 @@ static int airoha_dev_open(struct net_device *netdev)u32 pse_port =FE_PSE_PORT_PPE1 ;int err; + err =phylink_of_phy_connect (dev->phylink, netdev->dev.of_node,0 ); +if (err) { +netdev_err (netdev,"could not attach PHY: %d\n" , err); +return err; + } + +phylink_start (dev->phylink); +netif_tx_start_all_queues (netdev); err =airoha_set_vip_for_gdm_port (dev, true);if (err)@@ -1909,6 +1918,10 @@ static int airoha_dev_stop(struct net_device *netdev)airoha_set_gdm_port_fwd_cfg (qdma->eth,REG_GDM_FWD_CFG (port->id),FE_PSE_PORT_DROP ); + +phylink_stop (dev->phylink); +phylink_disconnect_phy (dev->phylink); +return 0 ; }@@ -2389,6 +2402,24 @@ airoha_ethtool_get_rmon_stats(struct net_device *netdev, }while (u64_stats_fetch_retry (&dev->stats.syncp, start)); } +static int +airoha_ethtool_get_link_ksettings (struct net_device *netdev, +struct ethtool_link_ksettings *cmd) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); + +return phylink_ethtool_ksettings_get (dev->phylink, cmd); +} + +static int +airoha_ethtool_set_link_ksettings (struct net_device *netdev, +const struct ethtool_link_ksettings *cmd) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); + +return phylink_ethtool_ksettings_set (dev->phylink, cmd); +} +static int airoha_qdma_set_chan_tx_sched (struct net_device *netdev,int channel,enum tx_sched_mode mode,const u16 *weights,u8 n_weights)@@ -3120,7 +3151,8 @@ static const struct ethtool_ops airoha_ethtool_ops = { .get_drvinfo = airoha_ethtool_get_drvinfo, .get_eth_mac_stats = airoha_ethtool_get_mac_stats, .get_rmon_stats = airoha_ethtool_get_rmon_stats, - .get_link_ksettings = phy_ethtool_get_link_ksettings, + .get_link_ksettings = airoha_ethtool_get_link_ksettings, + .set_link_ksettings = airoha_ethtool_set_link_ksettings, .get_link = ethtool_op_get_link, };@@ -3176,6 +3208,155 @@ bool airoha_is_valid_gdm_dev(struct airoha_eth *eth,return false; } +/* Nothing to do in MAC, everything is handled in PCS */ +static void airoha_mac_config (struct phylink_config *config,unsigned int mode, +const struct phylink_link_state *state) +{ +} + +static void airoha_mac_link_up (struct phylink_config *config,struct phy_device *phy, +unsigned int mode,phy_interface_t interface, +int speed,int duplex,bool tx_pause,bool rx_pause) +{ + struct airoha_gdm_dev *dev = container_of(config, struct airoha_gdm_dev, + phylink_config); +struct airoha_gdm_port *port = dev->port; +struct airoha_eth *eth = dev->eth; +u32 frag_size_tx, frag_size_rx; +u32 mask, val; + +/* TX/RX frag is configured only for GDM4 */ +if (port->id !=AIROHA_GDM4_IDX ) +return ; + +switch (speed) { +case SPEED_10000 : +case SPEED_5000 : + frag_size_tx =8 ; + frag_size_rx =8 ; +break ; +case SPEED_2500 : + frag_size_tx =2 ; + frag_size_rx =1 ; +break ; +default : + frag_size_tx =1 ; + frag_size_rx =0 ; + } + +spin_lock (&port->lock); + +/* Configure TX/RX frag based on speed */ +if (dev->nbq ==1 ) { + mask =GDM4_SGMII1_TX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII1_TX_FRAG_SIZE_MASK , + frag_size_tx); + }else { + mask =GDM4_SGMII0_TX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII0_TX_FRAG_SIZE_MASK , + frag_size_tx); + } +airoha_fe_rmw (eth,REG_FE_GDM4_TMBI_FRAG , mask, val); + +if (dev->nbq ==1 ) { + mask =GDM4_SGMII1_RX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII1_RX_FRAG_SIZE_MASK , + frag_size_rx); + }else { + mask =GDM4_SGMII0_RX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII0_RX_FRAG_SIZE_MASK , + frag_size_rx); + } +airoha_fe_rmw (eth,REG_FE_GDM4_RMBI_FRAG , mask, val); + +spin_unlock (&port->lock); +} + +/* Nothing to do in MAC, everything is handled in PCS */ +static void airoha_mac_link_down (struct phylink_config *config,unsigned int mode, +phy_interface_t interface) +{ +} + +static const struct phylink_mac_ops airoha_phylink_ops = { + .mac_config = airoha_mac_config, + .mac_link_up = airoha_mac_link_up, + .mac_link_down = airoha_mac_link_down, +}; + +static int airoha_fill_available_pcs (struct phylink_config *config, +struct phylink_pcs **available_pcs, +unsigned int num_possible_pcs) +{ +struct device *dev = config->dev; + +return fwnode_phylink_pcs_parse (dev_fwnode (dev), available_pcs, + num_possible_pcs); +} + +static int airoha_setup_phylink (struct net_device *netdev) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); +struct device_node *np = netdev->dev.of_node; +struct airoha_gdm_port *port = dev->port; +struct phylink_config *config; +phy_interface_t phy_mode; +struct phylink *phylink; +int err; + + err =of_get_phy_mode (np, &phy_mode); +if (err) { +dev_err (&netdev->dev,"incorrect phy-mode\n" ); +return err; + } + + config = &dev->phylink_config; + config->dev = &netdev->dev; + config->type =PHYLINK_NETDEV ; + +/* +* GDM1 only supports internal for Embedded Switch +* and doesn't require a PCS. +*/ +if (port->id ==AIROHA_GDM1_IDX ) { + config->mac_capabilities =MAC_ASYM_PAUSE |MAC_SYM_PAUSE | +MAC_10000FD ; + +__set_bit (PHY_INTERFACE_MODE_INTERNAL , + config->supported_interfaces); + }else { + config->mac_capabilities =MAC_ASYM_PAUSE |MAC_SYM_PAUSE | +MAC_10 |MAC_100 |MAC_1000 | +MAC_2500FD |MAC_5000FD |MAC_10000FD ; + + config->num_possible_pcs =fwnode_phylink_pcs_count (dev_fwnode (config->dev)); + config->fill_available_pcs = airoha_fill_available_pcs; + +__set_bit (PHY_INTERFACE_MODE_SGMII , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_1000BASEX , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_2500BASEX , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_10GBASER , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_USXGMII , + config->supported_interfaces); + +phy_interface_copy (config->pcs_interfaces, + config->supported_interfaces); + } + + phylink =phylink_create (config,of_fwnode_handle (np), + phy_mode, &airoha_phylink_ops); +if (IS_ERR (phylink)) +return PTR_ERR (phylink); + + dev->phylink = phylink; + +return 0 ; +} +static int airoha_alloc_gdm_device (struct airoha_eth *eth,struct airoha_gdm_port *port,int nbq,struct device_node *np)@@ -3239,7 +3420,7 @@ static int airoha_alloc_gdm_device(struct airoha_eth *eth, dev->nbq = nbq; port->devs[index] = dev; -return 0 ; +return airoha_setup_phylink (netdev); } static int airoha_alloc_gdm_port(struct airoha_eth *eth,@@ -3274,7 +3455,7 @@ static int airoha_alloc_gdm_port(struct airoha_eth *eth,return -ENOMEM ; port->id = id; -spin_lock_init (&port->stats_lock); +spin_lock_init (&port->lock); eth->ports[p] = port; err =airoha_metadata_dst_alloc (port);@@ -3471,6 +3652,8 @@ static int airoha_probe(struct platform_device *pdev) netdev =netdev_from_priv (dev);if (netdev->reg_state ==NETREG_REGISTERED )unregister_netdev (netdev); +if (dev->phylink) +phylink_destroy (dev->phylink);of_node_put (netdev->dev.of_node); }airoha_metadata_dst_free (port);@@ -3509,6 +3692,7 @@ static void airoha_remove(struct platform_device *pdev) netdev =netdev_from_priv (dev);unregister_netdev (netdev); +phylink_destroy (dev->phylink);of_node_put (netdev->dev.of_node); }airoha_metadata_dst_free (port);drivers/net/ethernet/airoha/airoha_eth.h +5
-2@@ -561,6 +561,9 @@ struct airoha_gdm_dev {int nbq;struct airoha_hw_stats stats; + +struct phylink *phylink; +struct phylink_config phylink_config; };struct airoha_gdm_port {@@ -568,8 +571,8 @@ struct airoha_gdm_port {int id;int users; -/* protect concurrent hw_stats accesses */ -spinlock_t stats_lock; +/* protect concurrent hw_stats and frag register accesses */ +spinlock_t lock;struct metadata_dst *dsa_meta[AIROHA_MAX_DSA_PORTS ]; };drivers/net/ethernet/airoha/airoha_regs.h +12
-0@@ -357,6 +357,18 @@#define IP_FRAGMENT_PORT_MASK GENMASK(8, 5)#define IP_FRAGMENT_NBQ_MASK GENMASK(4, 0) +#define REG_FE_GDM4_TMBI_FRAG 0x2028 +#define GDM4_SGMII1_TX_WEIGHT_MASK GENMASK(31, 26) +#define GDM4_SGMII1_TX_FRAG_SIZE_MASK GENMASK(25, 16) +#define GDM4_SGMII0_TX_WEIGHT_MASK GENMASK(15, 10) +#define GDM4_SGMII0_TX_FRAG_SIZE_MASK GENMASK(9, 0) + +#define REG_FE_GDM4_RMBI_FRAG 0x202c +#define GDM4_SGMII1_RX_WEIGHT_MASK GENMASK(31, 26) +#define GDM4_SGMII1_RX_FRAG_SIZE_MASK GENMASK(25, 16) +#define GDM4_SGMII0_RX_WEIGHT_MASK GENMASK(15, 10) +#define GDM4_SGMII0_RX_FRAG_SIZE_MASK GENMASK(9, 0) +#define REG_MC_VLAN_EN 0x2100#define MC_VLAN_EN_MASK BIT(0)Signature · 1 line
2.53.0
Signature · 1 line
Ansuel
Lorenzo Bianconi
maintainerRe: [PATCH net-next v9 12/12] net: airoha: add phylink support
Quoted 58 lines · Lorenzo Bianconi
Quoted 47 lines
Quoted 47 lines
Add phylink support for each GDM port. For GDM1 add the internal interface mode as the only supported mode. For GDM2/3/4 add the required configuration of the PCS to make the external PHY or attached SFP cage work.
These needs to be defined in the GDM port node using the pcs-handle property.
Update and provide a .get/set_link_ksettings function that use phylink for ethtool OPs now that we fully support phylink.
Signed-off-by Christian Marangi <[email protected]>--- drivers/net/ethernet/airoha/Kconfig | 1 + drivers/net/ethernet/airoha/airoha_eth.c | 194 +++++++++++++++++++++- drivers/net/ethernet/airoha/airoha_eth.h | 7 +- drivers/net/ethernet/airoha/airoha_regs.h | 12 ++ 4 files changed, 207 insertions(+), 7 deletions(-)drivers/net/ethernet/airoha/Kconfig +1
-0@@ -20,6 +20,7 @@ config NET_AIROHA depends on NET_DSA || !NET_DSA select NET_AIROHA_NPU select PAGE_POOL + select PHYLINK help This driver supports the gigabit ethernet MACs in the Airoha SoC family.drivers/net/ethernet/airoha/airoha_eth.c +1
-0@@ -8,6 +8,7 @@#include <linux/of_reserved_mem.h> #include <linux/platform_device.h> #include <linux/tcp.h> +#include <linux/pcs/pcs.h> #include <linux/u64_stats_sync.h> #include <net/dst_metadata.h> #include <net/page_pool/helpers.h> @@ -1837,7 +1838,7 @@ static void airoha_update_hw_stats(struct airoha_gdm_dev *dev)struct airoha_gdm_port *port = dev->port;int i;Quoted 9 lines
drivers/net/ethernet/airoha/airoha_eth.c static void airoha_update_hw_stats(struct airoha_gdm_dev *dev) · line 1841
Quoted 2 lines
drivers/net/ethernet/airoha/airoha_eth.c +1
-1-spin_lock (&port->stats_lock); +spin_lock (&port->lock);Hi Christian,
as pointed out in a previous email, I do not like the approach of reusing this
spin_lockforairoha_mac_link_up(). Can we usertl_lock()(when necessary) as pointed out before?
Quoted 6 lines
For context, quoting from the previous series, the suggestion is to use
rtnl_is_locked()and then lock accordingly but I didn't find other usage of that in other driver (aside from core net) and I don't like the use ofis_locked. I can already see the BOT saying that in the timeframe ofis_lockedand writing the register another interface goes up causing a race.
Can you please explain what is the problem of using rtnl_is_locked()?
Quoted 2 lines
Guess I will add a simple mutex for this case and the other.
I do not have a strong opinion on it. I guess it is ok if you are planning to use it for future usage, otherwise I guess it is fine to rely on rtnl lock.
Regards,
Lorenzo
Quoted 321 lines
Quoted 316 lines
Quoted 316 lines
drivers/net/ethernet/airoha/airoha_eth.c +187
-4for (i =0 ; i <ARRAY_SIZE (port->devs); i++) {if (port->devs[i])@@ -1848,7 +1849,7 @@ static void airoha_update_hw_stats(struct airoha_gdm_dev *dev)airoha_fe_set (dev->eth,REG_FE_GDM_MIB_CLEAR (port->id),FE_GDM_MIB_RX_CLEAR_MASK |FE_GDM_MIB_TX_CLEAR_MASK ); -spin_unlock (&port->stats_lock); +spin_unlock (&port->lock); }static void airoha_dev_set_xmit_frame_size (struct net_device *netdev)@@ -1870,6 +1871,14 @@ static int airoha_dev_open(struct net_device *netdev)u32 pse_port =FE_PSE_PORT_PPE1 ;int err; + err =phylink_of_phy_connect (dev->phylink, netdev->dev.of_node,0 ); +if (err) { +netdev_err (netdev,"could not attach PHY: %d\n" , err); +return err; + } + +phylink_start (dev->phylink); +netif_tx_start_all_queues (netdev); err =airoha_set_vip_for_gdm_port (dev, true);if (err)@@ -1909,6 +1918,10 @@ static int airoha_dev_stop(struct net_device *netdev)airoha_set_gdm_port_fwd_cfg (qdma->eth,REG_GDM_FWD_CFG (port->id),FE_PSE_PORT_DROP ); + +phylink_stop (dev->phylink); +phylink_disconnect_phy (dev->phylink); +return 0 ; }@@ -2389,6 +2402,24 @@ airoha_ethtool_get_rmon_stats(struct net_device *netdev, }while (u64_stats_fetch_retry (&dev->stats.syncp, start)); } +static int +airoha_ethtool_get_link_ksettings (struct net_device *netdev, +struct ethtool_link_ksettings *cmd) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); + +return phylink_ethtool_ksettings_get (dev->phylink, cmd); +} + +static int +airoha_ethtool_set_link_ksettings (struct net_device *netdev, +const struct ethtool_link_ksettings *cmd) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); + +return phylink_ethtool_ksettings_set (dev->phylink, cmd); +} +static int airoha_qdma_set_chan_tx_sched (struct net_device *netdev,int channel,enum tx_sched_mode mode,const u16 *weights,u8 n_weights)@@ -3120,7 +3151,8 @@ static const struct ethtool_ops airoha_ethtool_ops = { .get_drvinfo = airoha_ethtool_get_drvinfo, .get_eth_mac_stats = airoha_ethtool_get_mac_stats, .get_rmon_stats = airoha_ethtool_get_rmon_stats, - .get_link_ksettings = phy_ethtool_get_link_ksettings, + .get_link_ksettings = airoha_ethtool_get_link_ksettings, + .set_link_ksettings = airoha_ethtool_set_link_ksettings, .get_link = ethtool_op_get_link, };@@ -3176,6 +3208,155 @@ bool airoha_is_valid_gdm_dev(struct airoha_eth *eth,return false; } +/* Nothing to do in MAC, everything is handled in PCS */ +static void airoha_mac_config (struct phylink_config *config,unsigned int mode, +const struct phylink_link_state *state) +{ +} + +static void airoha_mac_link_up (struct phylink_config *config,struct phy_device *phy, +unsigned int mode,phy_interface_t interface, +int speed,int duplex,bool tx_pause,bool rx_pause) +{ + struct airoha_gdm_dev *dev = container_of(config, struct airoha_gdm_dev, + phylink_config); +struct airoha_gdm_port *port = dev->port; +struct airoha_eth *eth = dev->eth; +u32 frag_size_tx, frag_size_rx; +u32 mask, val; + +/* TX/RX frag is configured only for GDM4 */ +if (port->id !=AIROHA_GDM4_IDX ) +return ; + +switch (speed) { +case SPEED_10000 : +case SPEED_5000 : + frag_size_tx =8 ; + frag_size_rx =8 ; +break ; +case SPEED_2500 : + frag_size_tx =2 ; + frag_size_rx =1 ; +break ; +default : + frag_size_tx =1 ; + frag_size_rx =0 ; + } + +spin_lock (&port->lock); + +/* Configure TX/RX frag based on speed */ +if (dev->nbq ==1 ) { + mask =GDM4_SGMII1_TX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII1_TX_FRAG_SIZE_MASK , + frag_size_tx); + }else { + mask =GDM4_SGMII0_TX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII0_TX_FRAG_SIZE_MASK , + frag_size_tx); + } +airoha_fe_rmw (eth,REG_FE_GDM4_TMBI_FRAG , mask, val); + +if (dev->nbq ==1 ) { + mask =GDM4_SGMII1_RX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII1_RX_FRAG_SIZE_MASK , + frag_size_rx); + }else { + mask =GDM4_SGMII0_RX_FRAG_SIZE_MASK ; + val =FIELD_PREP (GDM4_SGMII0_RX_FRAG_SIZE_MASK , + frag_size_rx); + } +airoha_fe_rmw (eth,REG_FE_GDM4_RMBI_FRAG , mask, val); + +spin_unlock (&port->lock); +} + +/* Nothing to do in MAC, everything is handled in PCS */ +static void airoha_mac_link_down (struct phylink_config *config,unsigned int mode, +phy_interface_t interface) +{ +} + +static const struct phylink_mac_ops airoha_phylink_ops = { + .mac_config = airoha_mac_config, + .mac_link_up = airoha_mac_link_up, + .mac_link_down = airoha_mac_link_down, +}; + +static int airoha_fill_available_pcs (struct phylink_config *config, +struct phylink_pcs **available_pcs, +unsigned int num_possible_pcs) +{ +struct device *dev = config->dev; + +return fwnode_phylink_pcs_parse (dev_fwnode (dev), available_pcs, + num_possible_pcs); +} + +static int airoha_setup_phylink (struct net_device *netdev) +{ +struct airoha_gdm_dev *dev =netdev_priv (netdev); +struct device_node *np = netdev->dev.of_node; +struct airoha_gdm_port *port = dev->port; +struct phylink_config *config; +phy_interface_t phy_mode; +struct phylink *phylink; +int err; + + err =of_get_phy_mode (np, &phy_mode); +if (err) { +dev_err (&netdev->dev,"incorrect phy-mode\n" ); +return err; + } + + config = &dev->phylink_config; + config->dev = &netdev->dev; + config->type =PHYLINK_NETDEV ; + +/* +* GDM1 only supports internal for Embedded Switch +* and doesn't require a PCS. +*/ +if (port->id ==AIROHA_GDM1_IDX ) { + config->mac_capabilities =MAC_ASYM_PAUSE |MAC_SYM_PAUSE | +MAC_10000FD ; + +__set_bit (PHY_INTERFACE_MODE_INTERNAL , + config->supported_interfaces); + }else { + config->mac_capabilities =MAC_ASYM_PAUSE |MAC_SYM_PAUSE | +MAC_10 |MAC_100 |MAC_1000 | +MAC_2500FD |MAC_5000FD |MAC_10000FD ; + + config->num_possible_pcs =fwnode_phylink_pcs_count (dev_fwnode (config->dev)); + config->fill_available_pcs = airoha_fill_available_pcs; + +__set_bit (PHY_INTERFACE_MODE_SGMII , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_1000BASEX , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_2500BASEX , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_10GBASER , + config->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_USXGMII , + config->supported_interfaces); + +phy_interface_copy (config->pcs_interfaces, + config->supported_interfaces); + } + + phylink =phylink_create (config,of_fwnode_handle (np), + phy_mode, &airoha_phylink_ops); +if (IS_ERR (phylink)) +return PTR_ERR (phylink); + + dev->phylink = phylink; + +return 0 ; +} +static int airoha_alloc_gdm_device (struct airoha_eth *eth,struct airoha_gdm_port *port,int nbq,struct device_node *np)@@ -3239,7 +3420,7 @@ static int airoha_alloc_gdm_device(struct airoha_eth *eth, dev->nbq = nbq; port->devs[index] = dev; -return 0 ; +return airoha_setup_phylink (netdev); } static int airoha_alloc_gdm_port(struct airoha_eth *eth,@@ -3274,7 +3455,7 @@ static int airoha_alloc_gdm_port(struct airoha_eth *eth,return -ENOMEM ; port->id = id; -spin_lock_init (&port->stats_lock); +spin_lock_init (&port->lock); eth->ports[p] = port; err =airoha_metadata_dst_alloc (port);@@ -3471,6 +3652,8 @@ static int airoha_probe(struct platform_device *pdev) netdev =netdev_from_priv (dev);if (netdev->reg_state ==NETREG_REGISTERED )unregister_netdev (netdev); +if (dev->phylink) +phylink_destroy (dev->phylink);of_node_put (netdev->dev.of_node); }airoha_metadata_dst_free (port);@@ -3509,6 +3692,7 @@ static void airoha_remove(struct platform_device *pdev) netdev =netdev_from_priv (dev);unregister_netdev (netdev); +phylink_destroy (dev->phylink);of_node_put (netdev->dev.of_node); }airoha_metadata_dst_free (port);drivers/net/ethernet/airoha/airoha_eth.h +5
-2@@ -561,6 +561,9 @@ struct airoha_gdm_dev {int nbq;struct airoha_hw_stats stats; + +struct phylink *phylink; +struct phylink_config phylink_config; };struct airoha_gdm_port {@@ -568,8 +571,8 @@ struct airoha_gdm_port {int id;int users; -/* protect concurrent hw_stats accesses */ -spinlock_t stats_lock; +/* protect concurrent hw_stats and frag register accesses */ +spinlock_t lock;struct metadata_dst *dsa_meta[AIROHA_MAX_DSA_PORTS ]; };drivers/net/ethernet/airoha/airoha_regs.h +12
-0@@ -357,6 +357,18 @@#define IP_FRAGMENT_PORT_MASK GENMASK(8, 5)#define IP_FRAGMENT_NBQ_MASK GENMASK(4, 0) +#define REG_FE_GDM4_TMBI_FRAG 0x2028 +#define GDM4_SGMII1_TX_WEIGHT_MASK GENMASK(31, 26) +#define GDM4_SGMII1_TX_FRAG_SIZE_MASK GENMASK(25, 16) +#define GDM4_SGMII0_TX_WEIGHT_MASK GENMASK(15, 10) +#define GDM4_SGMII0_TX_FRAG_SIZE_MASK GENMASK(9, 0) + +#define REG_FE_GDM4_RMBI_FRAG 0x202c +#define GDM4_SGMII1_RX_WEIGHT_MASK GENMASK(31, 26) +#define GDM4_SGMII1_RX_FRAG_SIZE_MASK GENMASK(25, 16) +#define GDM4_SGMII0_RX_WEIGHT_MASK GENMASK(15, 10) +#define GDM4_SGMII0_RX_FRAG_SIZE_MASK GENMASK(9, 0) +#define REG_MC_VLAN_EN 0x2100#define MC_VLAN_EN_MASK BIT(0)Signature · 1 line
2.53.0Signature · 1 line
Ansuel
Hi Christian,
Quoted 3 lines · Christian Marangi
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.
I was finally able to spend a bit of time digging deeper, I ported the mvpp2 driver to your new API to test that dynamic PCS selection for internal PCSs still works, and it's all good :)
Congrats on that work !
This didn't exercise all code paths, especially with the fwnode API but you've tested that enough on your side :)
Maxime
The patch I used for testing if you're curious :
(I'll send that once this series land, or you can include it but I don't want to delay your work in case the patch goes through rounds of reviews...)
--- 8>< -----------------------------------------------------------------
From 38ad94b1e62bf3523097983dfb515f59b1634477 Mon Sep 17 00:00:00 2001
From: Maxime Chevallier <[email protected]>
Date: Tue, 21 Jul 2026 13:52:57 +0200
Subject: [PATCH] net: marvell: mvpp2: Convert to the new PCS API
Following the introduction of the PCS framework, port mvpp2 to the new PCS API.
--- .../net/ethernet/marvell/mvpp2/mvpp2_main.c | 161 +++++++++++------- 1 file changed, 95 insertions(+), 66 deletions(-)
drivers/net/ethernet/marvell/mvpp2/mvpp2_main.c +95 -66
@@ -6499,21 +6499,6 @@ static void mvpp2_gmac_config(struct mvpp2_port *port, unsigned int mode,writel (ctrl4, port->base +MVPP22_GMAC_CTRL_4_REG ); } -static struct phylink_pcs *mvpp2_select_pcs (struct phylink_config *config, -phy_interface_t interface) -{ -struct mvpp2_port *port =mvpp2_phylink_to_port (config); - -/* Select the appropriate PCS operations depending on the -* configured interface mode. We will only switch to a mode -* that the validate() checks have already passed. -*/ -if (mvpp2_is_xlg (interface)) -return &port->pcs_xlg; -else -return &port->pcs_gmac; -} -static int mvpp2_mac_prepare (struct phylink_config *config,unsigned int mode,phy_interface_t interface) {
@@ -6786,7 +6771,6 @@ static int mvpp2_mac_enable_tx_lpi(struct phylink_config *config, u32 timer, }static const struct phylink_mac_ops mvpp2_phylink_ops = { - .mac_select_pcs = mvpp2_select_pcs, .mac_prepare = mvpp2_mac_prepare, .mac_config = mvpp2_mac_config, .mac_finish = mvpp2_mac_finish,
@@ -6808,7 +6792,10 @@ static void mvpp2_acpi_start(struct mvpp2_port *port) };struct phylink_pcs *pcs; - pcs =mvpp2_select_pcs (&port->phylink_config, port->phy_interface); +if (mvpp2_is_xlg (port->phy_interface)) + pcs = &port->pcs_xlg; +else + pcs = &port->pcs_gmac;mvpp2_mac_prepare (&port->phylink_config,MLO_AN_INBAND , port->phy_interface);
@@ -6823,6 +6810,78 @@ static void mvpp2_acpi_start(struct mvpp2_port *port) SPEED_UNKNOWN, DUPLEX_UNKNOWN, false, false); } +static int mvpp2_port_fill_pcs (struct phylink_config *config, +struct phylink_pcs **available_pcs, +unsigned int num_possible_pcs) +{ +struct mvpp2_port *port =mvpp2_phylink_to_port (config); + + available_pcs[0 ] = &port->pcs_gmac; + +if (mvpp2_port_supports_xlg (port)) { +if (num_possible_pcs <2 ) +return -EINVAL ; + + available_pcs[1 ] = &port->pcs_xlg; + } + +return 0 ; +} + +static void mvpp2_port_init_pcs_xlg (struct phylink_pcs *pcs,bool has_comphy, +phy_interface_t phy_mode) +{ +if (has_comphy) { +__set_bit (PHY_INTERFACE_MODE_5GBASER , + pcs->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_10GBASER , + pcs->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_XAUI , + pcs->supported_interfaces); + }else if (phy_mode ==PHY_INTERFACE_MODE_5GBASER ) { +__set_bit (PHY_INTERFACE_MODE_5GBASER , + pcs->supported_interfaces); + }else if (phy_mode ==PHY_INTERFACE_MODE_10GBASER ) { +__set_bit (PHY_INTERFACE_MODE_10GBASER , + pcs->supported_interfaces); + }else if (phy_mode ==PHY_INTERFACE_MODE_XAUI ) { +__set_bit (PHY_INTERFACE_MODE_XAUI , + pcs->supported_interfaces); + } +} + +static void mvpp2_port_init_pcs_gmac (struct phylink_pcs *pcs,bool has_comphy, +phy_interface_t phy_mode) +{ +if (has_comphy) { +/* If a COMPHY is present, we can support any of the +* serdes modes and switch between them. +*/ +__set_bit (PHY_INTERFACE_MODE_SGMII , + pcs->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_1000BASEX , + pcs->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_2500BASEX , + pcs->supported_interfaces); + }else if (phy_mode ==PHY_INTERFACE_MODE_2500BASEX ) { +/* No COMPHY, with only 2500BASE-X mode supported */ +__set_bit (PHY_INTERFACE_MODE_2500BASEX , + pcs->supported_interfaces); + }else if (phy_mode ==PHY_INTERFACE_MODE_1000BASEX || + phy_mode ==PHY_INTERFACE_MODE_SGMII ) { +/* No COMPHY, we can switch between 1000BASE-X and SGMII +*/ +__set_bit (PHY_INTERFACE_MODE_1000BASEX , + pcs->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_SGMII , + pcs->supported_interfaces); + } + +/* RGMII and MII are still routed through the gmac PCS */ +phy_interface_set_rgmii (pcs->supported_interfaces); +__set_bit (PHY_INTERFACE_MODE_MII , pcs->supported_interfaces); +} +/* In order to ensure backward compatibility for ACPI, check if the port * firmware node comprises the necessary description allowing to use phylink. */
@@ -7082,28 +7141,17 @@ static int mvpp2_port_probe(struct platform_device *pdev, port->phylink_config.mac_capabilities |=MAC_SYM_PAUSE |MAC_ASYM_PAUSE ; -if (mvpp2_port_supports_xlg (port)) { -/* If a COMPHY is present, we can support any of -* the serdes modes and switch between them. -*/ -if (comphy) { -__set_bit (PHY_INTERFACE_MODE_5GBASER , - port->phylink_config.supported_interfaces); -__set_bit (PHY_INTERFACE_MODE_10GBASER , - port->phylink_config.supported_interfaces); -__set_bit (PHY_INTERFACE_MODE_XAUI , - port->phylink_config.supported_interfaces); - }else if (phy_mode ==PHY_INTERFACE_MODE_5GBASER ) { -__set_bit (PHY_INTERFACE_MODE_5GBASER , - port->phylink_config.supported_interfaces); - }else if (phy_mode ==PHY_INTERFACE_MODE_10GBASER ) { -__set_bit (PHY_INTERFACE_MODE_10GBASER , - port->phylink_config.supported_interfaces); - }else if (phy_mode ==PHY_INTERFACE_MODE_XAUI ) { -__set_bit (PHY_INTERFACE_MODE_XAUI , - port->phylink_config.supported_interfaces); - } +if (!mvpp2_port_supports_xlg (port)) + port->phylink_config.num_possible_pcs =1 ; +else + port->phylink_config.num_possible_pcs =2 ; + + port->phylink_config.fill_available_pcs = mvpp2_port_fill_pcs; +mvpp2_port_init_pcs_xlg (&port->pcs_xlg, comphy, phy_mode); +mvpp2_port_init_pcs_gmac (&port->pcs_gmac, comphy, phy_mode); + +if (mvpp2_port_supports_xlg (port)) {if (comphy) port->phylink_config.mac_capabilities |=MAC_10000FD |MAC_5000FD ;
@@ -7115,35 +7163,16 @@ static int mvpp2_port_probe(struct platform_device *pdev,MAC_10000FD ; } -if (mvpp2_port_supports_rgmii (port)) { -phy_interface_set_rgmii (port->phylink_config.supported_interfaces); -__set_bit (PHY_INTERFACE_MODE_MII , - port->phylink_config.supported_interfaces); - } +phy_interface_copy (port->phylink_config.pcs_interfaces, + port->pcs_gmac.supported_interfaces); -if (comphy) { -/* If a COMPHY is present, we can support any of the -* serdes modes and switch between them. -*/ -__set_bit (PHY_INTERFACE_MODE_SGMII , - port->phylink_config.supported_interfaces); -__set_bit (PHY_INTERFACE_MODE_1000BASEX , - port->phylink_config.supported_interfaces); -__set_bit (PHY_INTERFACE_MODE_2500BASEX , - port->phylink_config.supported_interfaces); - }else if (phy_mode ==PHY_INTERFACE_MODE_2500BASEX ) { -/* No COMPHY, with only 2500BASE-X mode supported */ -__set_bit (PHY_INTERFACE_MODE_2500BASEX , - port->phylink_config.supported_interfaces); - }else if (phy_mode ==PHY_INTERFACE_MODE_1000BASEX || - phy_mode ==PHY_INTERFACE_MODE_SGMII ) { -/* No COMPHY, we can switch between 1000BASE-X and SGMII -*/ -__set_bit (PHY_INTERFACE_MODE_1000BASEX , - port->phylink_config.supported_interfaces); -__set_bit (PHY_INTERFACE_MODE_SGMII , - port->phylink_config.supported_interfaces); - } +if (mvpp2_port_supports_xlg (port)) +phy_interface_or (port->phylink_config.pcs_interfaces, + port->phylink_config.pcs_interfaces, + port->pcs_xlg.supported_interfaces); + +phy_interface_copy (port->phylink_config.supported_interfaces, + port->phylink_config.pcs_interfaces); phylink =phylink_create (&port->phylink_config, port_fwnode, phy_mode, &mvpp2_phylink_ops);
Signature · 1 line
2.55.0