Message ID | 20211012123557.3547280-6-alvin@pqrs.dk (mailing list archive) |
---|---|
State | Superseded |
Delegated to: | Netdev Maintainers |
Headers | show |
Series | net: dsa: add support for RTL8365MB-VC | expand |
Context | Check | Description |
---|---|---|
netdev/cover_letter | success | Series has a cover letter |
netdev/fixes_present | success | Fixes tag not required for -next series |
netdev/patch_count | success | Link |
netdev/tree_selection | success | Clearly marked for net-next |
netdev/subject_prefix | success | Link |
netdev/cc_maintainers | success | CCed 9 of 9 maintainers |
netdev/source_inline | success | Was 0 now: 0 |
netdev/verify_signedoff | success | Signed-off-by tag matches author and committer |
netdev/module_param | success | Was 0 now: 0 |
netdev/build_32bit | fail | Errors and warnings before: 0 this patch: 1 |
netdev/kdoc | success | Errors and warnings before: 21 this patch: 21 |
netdev/verify_fixes | success | No Fixes tag |
netdev/checkpatch | warning | CHECK: Lines should not end with a '(' WARNING: added, moved or deleted file(s), does MAINTAINERS need updating? |
netdev/build_allmodconfig_warn | fail | Errors and warnings before: 0 this patch: 1 |
netdev/header_inline | success | No static functions without inline keyword in header files |
On Tue, Oct 12, 2021 at 02:35:54PM +0200, Alvin Šipraga wrote: > From: Alvin Šipraga <alsi@bang-olufsen.dk> > > This patch adds a realtek-smi subdriver for the RTL8365MB-VC 4+1 port > 10/100/1000M switch controller. The driver has been developed based on a > GPL-licensed OS-agnostic Realtek vendor driver known as rtl8367c found > in the OpenWrt source tree. > > Despite the name, the RTL8365MB-VC has an entirely different register > layout to the already-supported RTL8366RB ASIC. Notwithstanding this, > the structure of the rtl8365mb subdriver is based on the rtl8366rb > subdriver and makes use of the rtl8366 helper library for setup of the > SMI interface and handling of MIB counters. Like the 'rb, it establishes > its own irqchip to handle cascaded PHY link status interrupts. > > The RTL8365MB-VC switch is capable of offloading a large number of > features from the software, but this patch introduces only the most > basic DSA driver functionality. The ports always function as standalone > ports, with bridging handled in software. > > One more thing. Realtek's nomenclature for switches makes it hard to > know exactly what other ASICs might be supported by this driver. The > vendor driver goes by the name rtl8367c, but as far as I can tell, no > chip actually exists under this name. As such, the subdriver is named > rtl8365mb to emphasize the potentially limited support. But it is clear > from the vendor sources that a number of other more advanced switches > share a similar register layout, and further support should not be too > hard to add given access to the relevant hardware. With this in mind, > the subdriver has been written with as few assumptions about the > particular chip as is reasonable. But the RTL8365MB-VC is the only > hardware I have available, so some further work is surely needed. > > Co-developed-by: Michael Rasmussen <mir@bang-olufsen.dk> > Signed-off-by: Michael Rasmussen <mir@bang-olufsen.dk> > Signed-off-by: Alvin Šipraga <alsi@bang-olufsen.dk> > --- Reviewed-by: Vladimir Oltean <olteanv@gmail.com> Just one comment below > +static int rtl8365mb_ext_config_rgmii(struct realtek_smi *smi, int port, > + phy_interface_t interface) > +{ > + int tx_delay = 0; > + int rx_delay = 0; > + int ext_port; > + int ret; > + > + if (port == smi->cpu_port) { > + ext_port = PORT_NUM_L2E(port); > + } else { > + dev_err(smi->dev, "only one EXT port is currently supported\n"); > + return -EINVAL; > + } > + > + /* Set the RGMII TX/RX delay > + * > + * The Realtek vendor driver indicates the following possible > + * configuration settings: > + * > + * TX delay: > + * 0 = no delay, 1 = 2 ns delay > + * RX delay: > + * 0 = no delay, 7 = maximum delay > + * No units are specified, but there are a total of 8 steps. > + * > + * The vendor driver also states that this must be configured *before* > + * forcing the external interface into a particular mode, which is done > + * in the rtl8365mb_phylink_mac_link_{up,down} functions. > + * > + * NOTE: For now this is hardcoded to tx_delay = 1, rx_delay = 4. > + */ > + if (interface == PHY_INTERFACE_MODE_RGMII_ID || > + interface == PHY_INTERFACE_MODE_RGMII_TXID) > + tx_delay = 1; /* 2 ns */ > + > + if (interface == PHY_INTERFACE_MODE_RGMII_ID || > + interface == PHY_INTERFACE_MODE_RGMII_RXID) > + rx_delay = 4; There is this ongoing discussion that we have been interpreting the meaning of "phy-mode" incorrectly for RGMII all along. The conclusion seems to be that for a PHY driver, it is okay to configure its internal delay lines based on the value of the phy-mode string, but for a MAC driver it is not. The only viable option for a MAC driver to configure its internal delays is based on parsing some new device tree properties called rx-internal-delay-ps and tx-internal-delay-ps. Since you do not seem to have any baggage to support here (new driver), could you please just accept any PHY_INTERFACE_MODE_RGMII* value and apply delays (or not) based on those other OF properties? https://patchwork.kernel.org/project/netdevbpf/patch/20210723173108.459770-6-prasanna.vengateshan@microchip.com/ > + > + ret = regmap_update_bits( > + smi->map, RTL8365MB_EXT_RGMXF_REG(ext_port), > + RTL8365MB_EXT_RGMXF_TXDELAY_MASK | > + RTL8365MB_EXT_RGMXF_RXDELAY_MASK, > + FIELD_PREP(RTL8365MB_EXT_RGMXF_TXDELAY_MASK, tx_delay) | > + FIELD_PREP(RTL8365MB_EXT_RGMXF_RXDELAY_MASK, rx_delay)); > + if (ret) > + return ret; > + > + ret = regmap_update_bits( > + smi->map, RTL8365MB_DIGITAL_INTERFACE_SELECT_REG(ext_port), > + RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_MASK(ext_port), > + RTL8365MB_EXT_PORT_MODE_RGMII > + << RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_OFFSET( > + ext_port)); > + if (ret) > + return ret; > + > + return 0; > +} > +static void rtl8365mb_phylink_mac_config(struct dsa_switch *ds, int port, > + unsigned int mode, > + const struct phylink_link_state *state) > +{ > + struct realtek_smi *smi = ds->priv; > + int ret; > + > + if (!rtl8365mb_phy_mode_supported(ds, port, state->interface)) { > + dev_err(smi->dev, "phy mode %s is unsupported on port %d\n", > + phy_modes(state->interface), port); > + return; > + } > + > + /* If port MAC is connected to an internal PHY, we have nothing to do */ > + if (dsa_is_user_port(ds, port)) > + return; > + > + if (mode != MLO_AN_PHY && mode != MLO_AN_FIXED) { > + dev_err(smi->dev, > + "port %d supports only conventional PHY or fixed-link\n", > + port); > + return; > + } > + > + if (phy_interface_mode_is_rgmii(state->interface)) { > + ret = rtl8365mb_ext_config_rgmii(smi, port, state->interface); > + if (ret) > + dev_err(smi->dev, > + "failed to configure RGMII mode on port %d: %d\n", > + port, ret); > + return; > + } > + > + /* TODO: Implement MII and RMII modes, which the RTL8365MB-VC also > + * supports > + */ > +} > + > +static void rtl8365mb_phylink_mac_link_down(struct dsa_switch *ds, int port, > + unsigned int mode, > + phy_interface_t interface) > +{ > + struct realtek_smi *smi = ds->priv; > + int ret; > + > + if (dsa_is_cpu_port(ds, port)) { I assume the "dsa_is_cpu_port()" check here can also be replaced with "phy_interface_mode_is_rgmii(interface)"? Can you please do that for consistency? > + ret = rtl8365mb_ext_config_forcemode(smi, port, false, 0, 0, > + false, false); > + if (ret) > + dev_err(smi->dev, > + "failed to reset forced mode on port %d: %d\n", > + port, ret); > + > + return; > + } > +} > + > +static void rtl8365mb_phylink_mac_link_up(struct dsa_switch *ds, int port, > + unsigned int mode, > + phy_interface_t interface, > + struct phy_device *phydev, int speed, > + int duplex, bool tx_pause, > + bool rx_pause) > +{ > + struct realtek_smi *smi = ds->priv; > + int ret; > + > + if (dsa_is_cpu_port(ds, port)) { and here > + ret = rtl8365mb_ext_config_forcemode(smi, port, true, speed, > + duplex, tx_pause, > + rx_pause); > + if (ret) > + dev_err(smi->dev, > + "failed to force mode on port %d: %d\n", port, > + ret); > + > + return; > + } > +}
On 10/12/21 3:04 PM, Vladimir Oltean wrote: > On Tue, Oct 12, 2021 at 02:35:54PM +0200, Alvin Šipraga wrote: >> From: Alvin Šipraga <alsi@bang-olufsen.dk> >> >> This patch adds a realtek-smi subdriver for the RTL8365MB-VC 4+1 port >> 10/100/1000M switch controller. The driver has been developed based on a >> GPL-licensed OS-agnostic Realtek vendor driver known as rtl8367c found >> in the OpenWrt source tree. >> >> Despite the name, the RTL8365MB-VC has an entirely different register >> layout to the already-supported RTL8366RB ASIC. Notwithstanding this, >> the structure of the rtl8365mb subdriver is based on the rtl8366rb >> subdriver and makes use of the rtl8366 helper library for setup of the >> SMI interface and handling of MIB counters. Like the 'rb, it establishes >> its own irqchip to handle cascaded PHY link status interrupts. >> >> The RTL8365MB-VC switch is capable of offloading a large number of >> features from the software, but this patch introduces only the most >> basic DSA driver functionality. The ports always function as standalone >> ports, with bridging handled in software. >> >> One more thing. Realtek's nomenclature for switches makes it hard to >> know exactly what other ASICs might be supported by this driver. The >> vendor driver goes by the name rtl8367c, but as far as I can tell, no >> chip actually exists under this name. As such, the subdriver is named >> rtl8365mb to emphasize the potentially limited support. But it is clear >> from the vendor sources that a number of other more advanced switches >> share a similar register layout, and further support should not be too >> hard to add given access to the relevant hardware. With this in mind, >> the subdriver has been written with as few assumptions about the >> particular chip as is reasonable. But the RTL8365MB-VC is the only >> hardware I have available, so some further work is surely needed. >> >> Co-developed-by: Michael Rasmussen <mir@bang-olufsen.dk> >> Signed-off-by: Michael Rasmussen <mir@bang-olufsen.dk> >> Signed-off-by: Alvin Šipraga <alsi@bang-olufsen.dk> >> --- > > Reviewed-by: Vladimir Oltean <olteanv@gmail.com> > > Just one comment below > >> +static int rtl8365mb_ext_config_rgmii(struct realtek_smi *smi, int port, >> + phy_interface_t interface) >> +{ >> + int tx_delay = 0; >> + int rx_delay = 0; >> + int ext_port; >> + int ret; >> + >> + if (port == smi->cpu_port) { >> + ext_port = PORT_NUM_L2E(port); >> + } else { >> + dev_err(smi->dev, "only one EXT port is currently supported\n"); >> + return -EINVAL; >> + } >> + >> + /* Set the RGMII TX/RX delay >> + * >> + * The Realtek vendor driver indicates the following possible >> + * configuration settings: >> + * >> + * TX delay: >> + * 0 = no delay, 1 = 2 ns delay >> + * RX delay: >> + * 0 = no delay, 7 = maximum delay >> + * No units are specified, but there are a total of 8 steps. >> + * >> + * The vendor driver also states that this must be configured *before* >> + * forcing the external interface into a particular mode, which is done >> + * in the rtl8365mb_phylink_mac_link_{up,down} functions. >> + * >> + * NOTE: For now this is hardcoded to tx_delay = 1, rx_delay = 4. >> + */ >> + if (interface == PHY_INTERFACE_MODE_RGMII_ID || >> + interface == PHY_INTERFACE_MODE_RGMII_TXID) >> + tx_delay = 1; /* 2 ns */ >> + >> + if (interface == PHY_INTERFACE_MODE_RGMII_ID || >> + interface == PHY_INTERFACE_MODE_RGMII_RXID) >> + rx_delay = 4; > > There is this ongoing discussion that we have been interpreting the > meaning of "phy-mode" incorrectly for RGMII all along. The conclusion > seems to be that for a PHY driver, it is okay to configure its internal > delay lines based on the value of the phy-mode string, but for a MAC > driver it is not. The only viable option for a MAC driver to configure > its internal delays is based on parsing some new device tree properties > called rx-internal-delay-ps and tx-internal-delay-ps. > Since you do not seem to have any baggage to support here (new driver), > could you please just accept any PHY_INTERFACE_MODE_RGMII* value and > apply delays (or not) based on those other OF properties? > https://patchwork.kernel.org/project/netdevbpf/patch/20210723173108.459770-6-prasanna.vengateshan@microchip.com/>> Ugh, I remember my head spinning when I first looked into this. But OK, I can do as you suggest. Just to clarify: if the *-internal-delay-ps property is missing, you are saying that I should set the delay to 0 rather than my defaults (tx=1, rx=4), right? >> + >> + ret = regmap_update_bits( >> + smi->map, RTL8365MB_EXT_RGMXF_REG(ext_port), >> + RTL8365MB_EXT_RGMXF_TXDELAY_MASK | >> + RTL8365MB_EXT_RGMXF_RXDELAY_MASK, >> + FIELD_PREP(RTL8365MB_EXT_RGMXF_TXDELAY_MASK, tx_delay) | >> + FIELD_PREP(RTL8365MB_EXT_RGMXF_RXDELAY_MASK, rx_delay)); >> + if (ret) >> + return ret; >> + >> + ret = regmap_update_bits( >> + smi->map, RTL8365MB_DIGITAL_INTERFACE_SELECT_REG(ext_port), >> + RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_MASK(ext_port), >> + RTL8365MB_EXT_PORT_MODE_RGMII >> + << RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_OFFSET( >> + ext_port)); >> + if (ret) >> + return ret; >> + >> + return 0; >> +} > >> +static void rtl8365mb_phylink_mac_config(struct dsa_switch *ds, int port, >> + unsigned int mode, >> + const struct phylink_link_state *state) >> +{ >> + struct realtek_smi *smi = ds->priv; >> + int ret; >> + >> + if (!rtl8365mb_phy_mode_supported(ds, port, state->interface)) { >> + dev_err(smi->dev, "phy mode %s is unsupported on port %d\n", >> + phy_modes(state->interface), port); >> + return; >> + } >> + >> + /* If port MAC is connected to an internal PHY, we have nothing to do */ >> + if (dsa_is_user_port(ds, port)) >> + return; >> + >> + if (mode != MLO_AN_PHY && mode != MLO_AN_FIXED) { >> + dev_err(smi->dev, >> + "port %d supports only conventional PHY or fixed-link\n", >> + port); >> + return; >> + } >> + >> + if (phy_interface_mode_is_rgmii(state->interface)) { >> + ret = rtl8365mb_ext_config_rgmii(smi, port, state->interface); >> + if (ret) >> + dev_err(smi->dev, >> + "failed to configure RGMII mode on port %d: %d\n", >> + port, ret); >> + return; >> + } >> + >> + /* TODO: Implement MII and RMII modes, which the RTL8365MB-VC also >> + * supports >> + */ >> +} >> + >> +static void rtl8365mb_phylink_mac_link_down(struct dsa_switch *ds, int port, >> + unsigned int mode, >> + phy_interface_t interface) >> +{ >> + struct realtek_smi *smi = ds->priv; >> + int ret; >> + >> + if (dsa_is_cpu_port(ds, port)) { > > I assume the "dsa_is_cpu_port()" check here can also be replaced with > "phy_interface_mode_is_rgmii(interface)"? Can you please do that for > consistency? Consistency with what exactly? All I'm saying with this code is that for CPU ports, we have to force some mode on it in response to mac_link_up. This doesn't apply to user ports because the PHY is always internal to the switch (this appears to be the case for all switches in the rtl8365mb-like family). Or are you wondering about a scenario where the port is treated as a DSA port? > >> + ret = rtl8365mb_ext_config_forcemode(smi, port, false, 0, 0, >> + false, false); >> + if (ret) >> + dev_err(smi->dev, >> + "failed to reset forced mode on port %d: %d\n", >> + port, ret); >> + >> + return; >> + } >> +} >> + >> +static void rtl8365mb_phylink_mac_link_up(struct dsa_switch *ds, int port, >> + unsigned int mode, >> + phy_interface_t interface, >> + struct phy_device *phydev, int speed, >> + int duplex, bool tx_pause, >> + bool rx_pause) >> +{ >> + struct realtek_smi *smi = ds->priv; >> + int ret; >> + >> + if (dsa_is_cpu_port(ds, port)) { > > and here > >> + ret = rtl8365mb_ext_config_forcemode(smi, port, true, speed, >> + duplex, tx_pause, >> + rx_pause); >> + if (ret) >> + dev_err(smi->dev, >> + "failed to force mode on port %d: %d\n", port, >> + ret); >> + >> + return; >> + } >> +}
On 10/12/21 3:22 PM, Alvin Šipraga wrote: > On 10/12/21 3:04 PM, Vladimir Oltean wrote: >> On Tue, Oct 12, 2021 at 02:35:54PM +0200, Alvin Šipraga wrote: >>> From: Alvin Šipraga <alsi@bang-olufsen.dk> >>> >>> This patch adds a realtek-smi subdriver for the RTL8365MB-VC 4+1 port >>> 10/100/1000M switch controller. The driver has been developed based on a >>> GPL-licensed OS-agnostic Realtek vendor driver known as rtl8367c found >>> in the OpenWrt source tree. >>> >>> Despite the name, the RTL8365MB-VC has an entirely different register >>> layout to the already-supported RTL8366RB ASIC. Notwithstanding this, >>> the structure of the rtl8365mb subdriver is based on the rtl8366rb >>> subdriver and makes use of the rtl8366 helper library for setup of the >>> SMI interface and handling of MIB counters. Like the 'rb, it establishes >>> its own irqchip to handle cascaded PHY link status interrupts. >>> >>> The RTL8365MB-VC switch is capable of offloading a large number of >>> features from the software, but this patch introduces only the most >>> basic DSA driver functionality. The ports always function as standalone >>> ports, with bridging handled in software. >>> >>> One more thing. Realtek's nomenclature for switches makes it hard to >>> know exactly what other ASICs might be supported by this driver. The >>> vendor driver goes by the name rtl8367c, but as far as I can tell, no >>> chip actually exists under this name. As such, the subdriver is named >>> rtl8365mb to emphasize the potentially limited support. But it is clear >>> from the vendor sources that a number of other more advanced switches >>> share a similar register layout, and further support should not be too >>> hard to add given access to the relevant hardware. With this in mind, >>> the subdriver has been written with as few assumptions about the >>> particular chip as is reasonable. But the RTL8365MB-VC is the only >>> hardware I have available, so some further work is surely needed. >>> >>> Co-developed-by: Michael Rasmussen <mir@bang-olufsen.dk> >>> Signed-off-by: Michael Rasmussen <mir@bang-olufsen.dk> >>> Signed-off-by: Alvin Šipraga <alsi@bang-olufsen.dk> >>> --- >> >> Reviewed-by: Vladimir Oltean <olteanv@gmail.com> >> >> Just one comment below >> >>> +static int rtl8365mb_ext_config_rgmii(struct realtek_smi *smi, int >>> port, >>> + phy_interface_t interface) >>> +{ >>> + int tx_delay = 0; >>> + int rx_delay = 0; >>> + int ext_port; >>> + int ret; >>> + >>> + if (port == smi->cpu_port) { >>> + ext_port = PORT_NUM_L2E(port); >>> + } else { >>> + dev_err(smi->dev, "only one EXT port is currently >>> supported\n"); >>> + return -EINVAL; >>> + } >>> + >>> + /* Set the RGMII TX/RX delay >>> + * >>> + * The Realtek vendor driver indicates the following possible >>> + * configuration settings: >>> + * >>> + * TX delay: >>> + * 0 = no delay, 1 = 2 ns delay >>> + * RX delay: >>> + * 0 = no delay, 7 = maximum delay >>> + * No units are specified, but there are a total of 8 steps. >>> + * >>> + * The vendor driver also states that this must be configured >>> *before* >>> + * forcing the external interface into a particular mode, which >>> is done >>> + * in the rtl8365mb_phylink_mac_link_{up,down} functions. >>> + * >>> + * NOTE: For now this is hardcoded to tx_delay = 1, rx_delay = 4. >>> + */ >>> + if (interface == PHY_INTERFACE_MODE_RGMII_ID || >>> + interface == PHY_INTERFACE_MODE_RGMII_TXID) >>> + tx_delay = 1; /* 2 ns */ >>> + >>> + if (interface == PHY_INTERFACE_MODE_RGMII_ID || >>> + interface == PHY_INTERFACE_MODE_RGMII_RXID) >>> + rx_delay = 4; >> >> There is this ongoing discussion that we have been interpreting the >> meaning of "phy-mode" incorrectly for RGMII all along. The conclusion >> seems to be that for a PHY driver, it is okay to configure its internal >> delay lines based on the value of the phy-mode string, but for a MAC >> driver it is not. The only viable option for a MAC driver to configure >> its internal delays is based on parsing some new device tree properties >> called rx-internal-delay-ps and tx-internal-delay-ps. >> Since you do not seem to have any baggage to support here (new driver), >> could you please just accept any PHY_INTERFACE_MODE_RGMII* value and >> apply delays (or not) based on those other OF properties? >> https://patchwork.kernel.org/project/netdevbpf/patch/20210723173108.459770-6-prasanna.vengateshan@microchip.com/>> > > > Ugh, I remember my head spinning when I first looked into this. But OK, > I can do as you suggest. > > Just to clarify: if the *-internal-delay-ps property is missing, you are > saying that I should set the delay to 0 rather than my defaults (tx=1, > rx=4), right? Another problem is that for the RX delay, I have no idea what the actual unit of measurement is. See the comment I left in rtl8365mb_ext_config_rgmii(). So I guess I could "reinterpret" rx-internal-delay-ps to mean these magic step values, or otherwise I don't know what might be the best practice. > >>> + >>> + ret = regmap_update_bits( >>> + smi->map, RTL8365MB_EXT_RGMXF_REG(ext_port), >>> + RTL8365MB_EXT_RGMXF_TXDELAY_MASK | >>> + RTL8365MB_EXT_RGMXF_RXDELAY_MASK, >>> + FIELD_PREP(RTL8365MB_EXT_RGMXF_TXDELAY_MASK, tx_delay) | >>> + FIELD_PREP(RTL8365MB_EXT_RGMXF_RXDELAY_MASK, rx_delay)); >>> + if (ret) >>> + return ret; >>> + >>> + ret = regmap_update_bits( >>> + smi->map, RTL8365MB_DIGITAL_INTERFACE_SELECT_REG(ext_port), >>> + RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_MASK(ext_port), >>> + RTL8365MB_EXT_PORT_MODE_RGMII >>> + << RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_OFFSET( >>> + ext_port)); >>> + if (ret) >>> + return ret; >>> + >>> + return 0; >>> +} >> >>> +static void rtl8365mb_phylink_mac_config(struct dsa_switch *ds, int >>> port, >>> + unsigned int mode, >>> + const struct phylink_link_state *state) >>> +{ >>> + struct realtek_smi *smi = ds->priv; >>> + int ret; >>> + >>> + if (!rtl8365mb_phy_mode_supported(ds, port, state->interface)) { >>> + dev_err(smi->dev, "phy mode %s is unsupported on port %d\n", >>> + phy_modes(state->interface), port); >>> + return; >>> + } >>> + >>> + /* If port MAC is connected to an internal PHY, we have nothing >>> to do */ >>> + if (dsa_is_user_port(ds, port)) >>> + return; >>> + >>> + if (mode != MLO_AN_PHY && mode != MLO_AN_FIXED) { >>> + dev_err(smi->dev, >>> + "port %d supports only conventional PHY or fixed-link\n", >>> + port); >>> + return; >>> + } >>> + >>> + if (phy_interface_mode_is_rgmii(state->interface)) { >>> + ret = rtl8365mb_ext_config_rgmii(smi, port, state->interface); >>> + if (ret) >>> + dev_err(smi->dev, >>> + "failed to configure RGMII mode on port %d: %d\n", >>> + port, ret); >>> + return; >>> + } >>> + >>> + /* TODO: Implement MII and RMII modes, which the RTL8365MB-VC also >>> + * supports >>> + */ >>> +} >>> + >>> +static void rtl8365mb_phylink_mac_link_down(struct dsa_switch *ds, >>> int port, >>> + unsigned int mode, >>> + phy_interface_t interface) >>> +{ >>> + struct realtek_smi *smi = ds->priv; >>> + int ret; >>> + >>> + if (dsa_is_cpu_port(ds, port)) { >> >> I assume the "dsa_is_cpu_port()" check here can also be replaced with >> "phy_interface_mode_is_rgmii(interface)"? Can you please do that for >> consistency? > > Consistency with what exactly? All I'm saying with this code is that for > CPU ports, we have to force some mode on it in response to mac_link_up. > This doesn't apply to user ports because the PHY is always internal to > the switch (this appears to be the case for all switches in the > rtl8365mb-like family). Or are you wondering about a scenario where the > port is treated as a DSA port? > > >> >>> + ret = rtl8365mb_ext_config_forcemode(smi, port, false, 0, 0, >>> + false, false); >>> + if (ret) >>> + dev_err(smi->dev, >>> + "failed to reset forced mode on port %d: %d\n", >>> + port, ret); >>> + >>> + return; >>> + } >>> +} >>> + >>> +static void rtl8365mb_phylink_mac_link_up(struct dsa_switch *ds, int >>> port, >>> + unsigned int mode, >>> + phy_interface_t interface, >>> + struct phy_device *phydev, int speed, >>> + int duplex, bool tx_pause, >>> + bool rx_pause) >>> +{ >>> + struct realtek_smi *smi = ds->priv; >>> + int ret; >>> + >>> + if (dsa_is_cpu_port(ds, port)) { >> >> and here >> >>> + ret = rtl8365mb_ext_config_forcemode(smi, port, true, speed, >>> + duplex, tx_pause, >>> + rx_pause); >>> + if (ret) >>> + dev_err(smi->dev, >>> + "failed to force mode on port %d: %d\n", port, >>> + ret); >>> + >>> + return; >>> + } >>> +} > >
On Tue, Oct 12, 2021 at 01:50:44PM +0000, Alvin Šipraga wrote: > >>> +static int rtl8365mb_ext_config_rgmii(struct realtek_smi *smi, int > >>> port, > >>> + phy_interface_t interface) > >>> +{ > >>> + int tx_delay = 0; > >>> + int rx_delay = 0; > >>> + int ext_port; > >>> + int ret; > >>> + > >>> + if (port == smi->cpu_port) { > >>> + ext_port = PORT_NUM_L2E(port); > >>> + } else { > >>> + dev_err(smi->dev, "only one EXT port is currently > >>> supported\n"); > >>> + return -EINVAL; > >>> + } > >>> + > >>> + /* Set the RGMII TX/RX delay > >>> + * > >>> + * The Realtek vendor driver indicates the following possible > >>> + * configuration settings: > >>> + * > >>> + * TX delay: > >>> + * 0 = no delay, 1 = 2 ns delay > >>> + * RX delay: > >>> + * 0 = no delay, 7 = maximum delay > >>> + * No units are specified, but there are a total of 8 steps. > >>> + * > >>> + * The vendor driver also states that this must be configured > >>> *before* > >>> + * forcing the external interface into a particular mode, which > >>> is done > >>> + * in the rtl8365mb_phylink_mac_link_{up,down} functions. > >>> + * > >>> + * NOTE: For now this is hardcoded to tx_delay = 1, rx_delay = 4. > >>> + */ > >>> + if (interface == PHY_INTERFACE_MODE_RGMII_ID || > >>> + interface == PHY_INTERFACE_MODE_RGMII_TXID) > >>> + tx_delay = 1; /* 2 ns */ > >>> + > >>> + if (interface == PHY_INTERFACE_MODE_RGMII_ID || > >>> + interface == PHY_INTERFACE_MODE_RGMII_RXID) > >>> + rx_delay = 4; > >> > >> There is this ongoing discussion that we have been interpreting the > >> meaning of "phy-mode" incorrectly for RGMII all along. The conclusion > >> seems to be that for a PHY driver, it is okay to configure its internal > >> delay lines based on the value of the phy-mode string, but for a MAC > >> driver it is not. The only viable option for a MAC driver to configure > >> its internal delays is based on parsing some new device tree properties > >> called rx-internal-delay-ps and tx-internal-delay-ps. > >> Since you do not seem to have any baggage to support here (new driver), > >> could you please just accept any PHY_INTERFACE_MODE_RGMII* value and > >> apply delays (or not) based on those other OF properties? > >> https://patchwork.kernel.org/project/netdevbpf/patch/20210723173108.459770-6-prasanna.vengateshan@microchip.com/>> > > > > > > Ugh, I remember my head spinning when I first looked into this. But OK, > > I can do as you suggest. > > > > Just to clarify: if the *-internal-delay-ps property is missing, you are > > saying that I should set the delay to 0 rather than my defaults (tx=1, > > rx=4), right? Yes, I think so. > Another problem is that for the RX delay, I have no idea what the actual > unit of measurement is. See the comment I left in > rtl8365mb_ext_config_rgmii(). > > So I guess I could "reinterpret" rx-internal-delay-ps to mean these > magic step values, or otherwise I don't know what might be the best > practice. I think what could work is you could accept only the 0 or 2000 ps values. For the TX delay you say it is clear that you should program "1" to hardware. For the RX delay I guess that the value of "4" is simply your best guess of what would correspond to 2 ns. So you could just transform the 2000 ps value into a "4" for the RX delay and make no other guesses otherwise. > >>> + ret = regmap_update_bits( > >>> + smi->map, RTL8365MB_EXT_RGMXF_REG(ext_port), > >>> + RTL8365MB_EXT_RGMXF_TXDELAY_MASK | > >>> + RTL8365MB_EXT_RGMXF_RXDELAY_MASK, > >>> + FIELD_PREP(RTL8365MB_EXT_RGMXF_TXDELAY_MASK, tx_delay) | > >>> + FIELD_PREP(RTL8365MB_EXT_RGMXF_RXDELAY_MASK, rx_delay)); > >>> + if (ret) > >>> + return ret; > >>> + > >>> + ret = regmap_update_bits( > >>> + smi->map, RTL8365MB_DIGITAL_INTERFACE_SELECT_REG(ext_port), > >>> + RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_MASK(ext_port), > >>> + RTL8365MB_EXT_PORT_MODE_RGMII > >>> + << RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_OFFSET( > >>> + ext_port)); > >>> + if (ret) > >>> + return ret; > >>> + > >>> + return 0; > >>> +} > >> > >>> +static void rtl8365mb_phylink_mac_config(struct dsa_switch *ds, int > >>> port, > >>> + unsigned int mode, > >>> + const struct phylink_link_state *state) > >>> +{ > >>> + struct realtek_smi *smi = ds->priv; > >>> + int ret; > >>> + > >>> + if (!rtl8365mb_phy_mode_supported(ds, port, state->interface)) { > >>> + dev_err(smi->dev, "phy mode %s is unsupported on port %d\n", > >>> + phy_modes(state->interface), port); > >>> + return; > >>> + } > >>> + > >>> + /* If port MAC is connected to an internal PHY, we have nothing > >>> to do */ > >>> + if (dsa_is_user_port(ds, port)) > >>> + return; > >>> + > >>> + if (mode != MLO_AN_PHY && mode != MLO_AN_FIXED) { > >>> + dev_err(smi->dev, > >>> + "port %d supports only conventional PHY or fixed-link\n", > >>> + port); > >>> + return; > >>> + } > >>> + > >>> + if (phy_interface_mode_is_rgmii(state->interface)) { > >>> + ret = rtl8365mb_ext_config_rgmii(smi, port, state->interface); > >>> + if (ret) > >>> + dev_err(smi->dev, > >>> + "failed to configure RGMII mode on port %d: %d\n", > >>> + port, ret); > >>> + return; > >>> + } > >>> + > >>> + /* TODO: Implement MII and RMII modes, which the RTL8365MB-VC also > >>> + * supports > >>> + */ > >>> +} > >>> + > >>> +static void rtl8365mb_phylink_mac_link_down(struct dsa_switch *ds, > >>> int port, > >>> + unsigned int mode, > >>> + phy_interface_t interface) > >>> +{ > >>> + struct realtek_smi *smi = ds->priv; > >>> + int ret; > >>> + > >>> + if (dsa_is_cpu_port(ds, port)) { > >> > >> I assume the "dsa_is_cpu_port()" check here can also be replaced with > >> "phy_interface_mode_is_rgmii(interface)"? Can you please do that for > >> consistency? > > > > Consistency with what exactly? I was going to say with rtl8365mb_phylink_mac_config() where you do have a specific check for phy_interface_mode_is_rgmii(), but now I notice that it is further guarded by a "dsa_is_user_port()" check. So, with nothing. > > All I'm saying with this code is that for CPU ports, we have to > > force some mode on it in response to mac_link_up. This doesn't > > apply to user ports because the PHY is always internal to the switch > > (this appears to be the case for all switches in the rtl8365mb-like > > family). Or are you wondering about a scenario where the port is > > treated as a DSA port? Understood that the code is functionally correct, but you're not forcing the link because it's a CPU port, you're forcing the link because it's an RGMII port. Semantically, a CPU port means something entirely different: pass DSA-tagged frames to a host. Nothing at the physical link level. On your switch it is basically a coincidence that all user ports have internal PHYs, and the CPU port is RGMII. All I'm saying is to remove the assumptions based on port roles from your MAC configuration logic. For somebody searching the git tree for .phylink_mac_link_up implementations and sleepwalking into your code, it will be deeply confusing to see such logic, even if there is a drawing at the top of the file. Why do you need these checks anyway and cannot simply distinguish based on PHY_INTERFACE_MODE_INTERNAL vs PHY_INTERFACE_MODE_RGMII*?
On 10/12/21 4:03 PM, Vladimir Oltean wrote: > On Tue, Oct 12, 2021 at 01:50:44PM +0000, Alvin Šipraga wrote: >>>>> +static int rtl8365mb_ext_config_rgmii(struct realtek_smi *smi, int >>>>> port, >>>>> + phy_interface_t interface) >>>>> +{ >>>>> + int tx_delay = 0; >>>>> + int rx_delay = 0; >>>>> + int ext_port; >>>>> + int ret; >>>>> + >>>>> + if (port == smi->cpu_port) { >>>>> + ext_port = PORT_NUM_L2E(port); >>>>> + } else { >>>>> + dev_err(smi->dev, "only one EXT port is currently >>>>> supported\n"); >>>>> + return -EINVAL; >>>>> + } >>>>> + >>>>> + /* Set the RGMII TX/RX delay >>>>> + * >>>>> + * The Realtek vendor driver indicates the following possible >>>>> + * configuration settings: >>>>> + * >>>>> + * TX delay: >>>>> + * 0 = no delay, 1 = 2 ns delay >>>>> + * RX delay: >>>>> + * 0 = no delay, 7 = maximum delay >>>>> + * No units are specified, but there are a total of 8 steps. >>>>> + * >>>>> + * The vendor driver also states that this must be configured >>>>> *before* >>>>> + * forcing the external interface into a particular mode, which >>>>> is done >>>>> + * in the rtl8365mb_phylink_mac_link_{up,down} functions. >>>>> + * >>>>> + * NOTE: For now this is hardcoded to tx_delay = 1, rx_delay = 4. >>>>> + */ >>>>> + if (interface == PHY_INTERFACE_MODE_RGMII_ID || >>>>> + interface == PHY_INTERFACE_MODE_RGMII_TXID) >>>>> + tx_delay = 1; /* 2 ns */ >>>>> + >>>>> + if (interface == PHY_INTERFACE_MODE_RGMII_ID || >>>>> + interface == PHY_INTERFACE_MODE_RGMII_RXID) >>>>> + rx_delay = 4; >>>> >>>> There is this ongoing discussion that we have been interpreting the >>>> meaning of "phy-mode" incorrectly for RGMII all along. The conclusion >>>> seems to be that for a PHY driver, it is okay to configure its internal >>>> delay lines based on the value of the phy-mode string, but for a MAC >>>> driver it is not. The only viable option for a MAC driver to configure >>>> its internal delays is based on parsing some new device tree properties >>>> called rx-internal-delay-ps and tx-internal-delay-ps. >>>> Since you do not seem to have any baggage to support here (new driver), >>>> could you please just accept any PHY_INTERFACE_MODE_RGMII* value and >>>> apply delays (or not) based on those other OF properties? >>>> https://patchwork.kernel.org/project/netdevbpf/patch/20210723173108.459770-6-prasanna.vengateshan@microchip.com/>>>> >>> >>> Ugh, I remember my head spinning when I first looked into this. But OK, >>> I can do as you suggest. >>> >>> Just to clarify: if the *-internal-delay-ps property is missing, you are >>> saying that I should set the delay to 0 rather than my defaults (tx=1, >>> rx=4), right? > > Yes, I think so. > >> Another problem is that for the RX delay, I have no idea what the actual >> unit of measurement is. See the comment I left in >> rtl8365mb_ext_config_rgmii(). >> >> So I guess I could "reinterpret" rx-internal-delay-ps to mean these >> magic step values, or otherwise I don't know what might be the best >> practice. > > I think what could work is you could accept only the 0 or 2000 ps values. > For the TX delay you say it is clear that you should program "1" to hardware. > For the RX delay I guess that the value of "4" is simply your best guess > of what would correspond to 2 ns. So you could just transform the 2000 ps > value into a "4" for the RX delay and make no other guesses otherwise. OK, this is also the most obvious way to deal with it. Will address in v2. > >>>>> + ret = regmap_update_bits( >>>>> + smi->map, RTL8365MB_EXT_RGMXF_REG(ext_port), >>>>> + RTL8365MB_EXT_RGMXF_TXDELAY_MASK | >>>>> + RTL8365MB_EXT_RGMXF_RXDELAY_MASK, >>>>> + FIELD_PREP(RTL8365MB_EXT_RGMXF_TXDELAY_MASK, tx_delay) | >>>>> + FIELD_PREP(RTL8365MB_EXT_RGMXF_RXDELAY_MASK, rx_delay)); >>>>> + if (ret) >>>>> + return ret; >>>>> + >>>>> + ret = regmap_update_bits( >>>>> + smi->map, RTL8365MB_DIGITAL_INTERFACE_SELECT_REG(ext_port), >>>>> + RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_MASK(ext_port), >>>>> + RTL8365MB_EXT_PORT_MODE_RGMII >>>>> + << RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_OFFSET( >>>>> + ext_port)); >>>>> + if (ret) >>>>> + return ret; >>>>> + >>>>> + return 0; >>>>> +} >>>> >>>>> +static void rtl8365mb_phylink_mac_config(struct dsa_switch *ds, int >>>>> port, >>>>> + unsigned int mode, >>>>> + const struct phylink_link_state *state) >>>>> +{ >>>>> + struct realtek_smi *smi = ds->priv; >>>>> + int ret; >>>>> + >>>>> + if (!rtl8365mb_phy_mode_supported(ds, port, state->interface)) { >>>>> + dev_err(smi->dev, "phy mode %s is unsupported on port %d\n", >>>>> + phy_modes(state->interface), port); >>>>> + return; >>>>> + } >>>>> + >>>>> + /* If port MAC is connected to an internal PHY, we have nothing >>>>> to do */ >>>>> + if (dsa_is_user_port(ds, port)) >>>>> + return; >>>>> + >>>>> + if (mode != MLO_AN_PHY && mode != MLO_AN_FIXED) { >>>>> + dev_err(smi->dev, >>>>> + "port %d supports only conventional PHY or fixed-link\n", >>>>> + port); >>>>> + return; >>>>> + } >>>>> + >>>>> + if (phy_interface_mode_is_rgmii(state->interface)) { >>>>> + ret = rtl8365mb_ext_config_rgmii(smi, port, state->interface); >>>>> + if (ret) >>>>> + dev_err(smi->dev, >>>>> + "failed to configure RGMII mode on port %d: %d\n", >>>>> + port, ret); >>>>> + return; >>>>> + } >>>>> + >>>>> + /* TODO: Implement MII and RMII modes, which the RTL8365MB-VC also >>>>> + * supports >>>>> + */ >>>>> +} >>>>> + >>>>> +static void rtl8365mb_phylink_mac_link_down(struct dsa_switch *ds, >>>>> int port, >>>>> + unsigned int mode, >>>>> + phy_interface_t interface) >>>>> +{ >>>>> + struct realtek_smi *smi = ds->priv; >>>>> + int ret; >>>>> + >>>>> + if (dsa_is_cpu_port(ds, port)) { >>>> >>>> I assume the "dsa_is_cpu_port()" check here can also be replaced with >>>> "phy_interface_mode_is_rgmii(interface)"? Can you please do that for >>>> consistency? >>> >>> Consistency with what exactly? > > I was going to say with rtl8365mb_phylink_mac_config() where you do have > a specific check for phy_interface_mode_is_rgmii(), but now I notice > that it is further guarded by a "dsa_is_user_port()" check. So, with nothing. > >>> All I'm saying with this code is that for CPU ports, we have to >>> force some mode on it in response to mac_link_up. This doesn't >>> apply to user ports because the PHY is always internal to the switch >>> (this appears to be the case for all switches in the rtl8365mb-like >>> family). Or are you wondering about a scenario where the port is >>> treated as a DSA port? > > Understood that the code is functionally correct, but you're not forcing > the link because it's a CPU port, you're forcing the link because it's > an RGMII port. Semantically, a CPU port means something entirely > different: pass DSA-tagged frames to a host. Nothing at the physical link level. > On your switch it is basically a coincidence that all user ports have > internal PHYs, and the CPU port is RGMII. All I'm saying is to remove > the assumptions based on port roles from your MAC configuration logic. I see your point. However I would still like to keep the dsa_is_{user,cpu}_port() checks in rtl8365mb_phy_mode_supported(), just so that somebody doesn't unwittingly misconfigure the chip via device tree. But I'll remove the port type checks in .phylink_mac_{config,link_down,link_up}. > > For somebody searching the git tree for .phylink_mac_link_up implementations > and sleepwalking into your code, it will be deeply confusing to see such > logic, even if there is a drawing at the top of the file. > > Why do you need these checks anyway and cannot simply distinguish based > on PHY_INTERFACE_MODE_INTERNAL vs PHY_INTERFACE_MODE_RGMII*? Even this might not be necessary, but I'll check it out for v2.
On Tue, 12 Oct 2021 14:35:54 +0200 Alvin Šipraga wrote: > + { 0, 4, 2, "dot3StatsFCSErrors" }, > + { 0, 6, 2, "dot3StatsSymbolErrors" }, > + { 0, 8, 2, "dot3InPauseFrames" }, > + { 0, 10, 2, "dot3ControlInUnknownOpcodes" }, ... You must expose counters via existing standard APIs. You should implement these ethtool ops: void (*get_eth_phy_stats)(struct net_device *dev, struct ethtool_eth_phy_stats *phy_stats); void (*get_eth_mac_stats)(struct net_device *dev, struct ethtool_eth_mac_stats *mac_stats); void (*get_eth_ctrl_stats)(struct net_device *dev, struct ethtool_eth_ctrl_stats *ctrl_stats); void (*get_rmon_stats)(struct net_device *dev, struct ethtool_rmon_stats *rmon_stats, const struct ethtool_rmon_hist_range **ranges); > +static int rtl8365mb_setup(struct dsa_switch *ds) > +{ > + struct realtek_smi *smi = ds->priv; > + struct rtl8365mb *mb; > + int ret; > + int i; > + > + mb = smi->chip_data; drivers/net/dsa/rtl8365mb.c:1428:20: warning: variable ‘mb’ set but not used [-Wunused-but-set-variable] 1428 | struct rtl8365mb *mb; | ^~
Hi "Alvin, Thank you for the patch! Perhaps something to improve: [auto build test WARNING on net-next/master] url: https://github.com/0day-ci/linux/commits/Alvin-ipraga/net-dsa-add-support-for-RTL8365MB-VC/20211012-204007 base: https://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next.git 177c92353be935db555d0d08729e871145ec698c config: i386-randconfig-a001-20211012 (attached as .config) compiler: gcc-9 (Debian 9.3.0-22) 9.3.0 reproduce (this is a W=1 build): # https://github.com/0day-ci/linux/commit/1f05b453a6d1b64bb7cefff2daa90d9b1e7bce77 git remote add linux-review https://github.com/0day-ci/linux git fetch --no-tags linux-review Alvin-ipraga/net-dsa-add-support-for-RTL8365MB-VC/20211012-204007 git checkout 1f05b453a6d1b64bb7cefff2daa90d9b1e7bce77 # save the attached .config to linux build tree make W=1 ARCH=i386 If you fix the issue, kindly add following tag as appropriate Reported-by: kernel test robot <lkp@intel.com> All warnings (new ones prefixed by >>): drivers/net/dsa/rtl8365mb.c: In function 'rtl8365mb_setup': >> drivers/net/dsa/rtl8365mb.c:1428:20: warning: variable 'mb' set but not used [-Wunused-but-set-variable] 1428 | struct rtl8365mb *mb; | ^~ vim +/mb +1428 drivers/net/dsa/rtl8365mb.c 1424 1425 static int rtl8365mb_setup(struct dsa_switch *ds) 1426 { 1427 struct realtek_smi *smi = ds->priv; > 1428 struct rtl8365mb *mb; 1429 int ret; 1430 int i; 1431 1432 mb = smi->chip_data; 1433 1434 ret = rtl8365mb_reset_chip(smi); 1435 if (ret) { 1436 dev_err(smi->dev, "failed to reset chip: %d\n", ret); 1437 return ret; 1438 } 1439 1440 /* Configure switch to vendor-defined initial state */ 1441 ret = rtl8365mb_switch_init(smi); 1442 if (ret) { 1443 dev_err(smi->dev, "failed to initialize switch: %d\n", ret); 1444 return ret; 1445 } 1446 1447 /* Configure CPU tagging */ 1448 ret = rtl8365mb_cpu_config(smi); 1449 if (ret) 1450 return ret; 1451 1452 /* Configure ports in standalone mode */ 1453 for (i = 0; i < smi->num_ports; i++) { 1454 /* Forward only to the CPU */ 1455 ret = rtl8365mb_port_set_isolation(smi, i, BIT(smi->cpu_port)); 1456 if (ret) 1457 return ret; 1458 1459 /* Disable learning */ 1460 ret = rtl8365mb_port_set_learning(smi, i, false); 1461 if (ret) 1462 return ret; 1463 1464 /* Set the initial STP state of all ports to DISABLED, otherwise 1465 * ports will still forward frames to the CPU despite being 1466 * administratively down by default. 1467 */ 1468 rtl8365mb_port_stp_state_set(smi->ds, i, BR_STATE_DISABLED); 1469 } 1470 1471 /* Set maximum packet length to 1536 bytes */ 1472 ret = regmap_update_bits(smi->map, RTL8365MB_CFG0_MAX_LEN_REG, 1473 RTL8365MB_CFG0_MAX_LEN_MASK, 1474 FIELD_PREP(RTL8365MB_CFG0_MAX_LEN_MASK, 1536)); 1475 if (ret) 1476 return ret; 1477 1478 /* Set up cascading IRQs */ 1479 ret = rtl8365mb_irq_setup(smi); 1480 if (ret == -EPROBE_DEFER) 1481 return ret; 1482 else if (ret) 1483 dev_info(smi->dev, "no interrupt support\n"); 1484 1485 ret = realtek_smi_setup_mdio(smi); 1486 if (ret) { 1487 dev_err(smi->dev, "could not set up MDIO bus\n"); 1488 return -ENODEV; 1489 } 1490 1491 return ret; 1492 } 1493 --- 0-DAY CI Kernel Test Service, Intel Corporation https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org
On 10/12/21 5:27 PM, Jakub Kicinski wrote: > On Tue, 12 Oct 2021 14:35:54 +0200 Alvin Šipraga wrote: >> + { 0, 4, 2, "dot3StatsFCSErrors" }, >> + { 0, 6, 2, "dot3StatsSymbolErrors" }, >> + { 0, 8, 2, "dot3InPauseFrames" }, >> + { 0, 10, 2, "dot3ControlInUnknownOpcodes" }, > ... > > You must expose counters via existing standard APIs. > > You should implement these ethtool ops: I implement the dsa_switch_ops callback .get_ethtool_stats, using an existing function rtl8366_get_ethtool_stats in the switch helper library rtl8366.c. It was my understanding that this is the correct way to expose counters within the DSA framework - please correct me if that is wrong. The structure you highlight is just some internal glue to sort out the internal register mapping. I borrowed the approach from the existing rtl8366rb.c Realtek SMI subdriver. > > void (*get_eth_phy_stats)(struct net_device *dev, > struct ethtool_eth_phy_stats *phy_stats); > void (*get_eth_mac_stats)(struct net_device *dev, > struct ethtool_eth_mac_stats *mac_stats); > void (*get_eth_ctrl_stats)(struct net_device *dev, > struct ethtool_eth_ctrl_stats *ctrl_stats); > void (*get_rmon_stats)(struct net_device *dev, > struct ethtool_rmon_stats *rmon_stats, > const struct ethtool_rmon_hist_range **ranges); > >> +static int rtl8365mb_setup(struct dsa_switch *ds) >> +{ >> + struct realtek_smi *smi = ds->priv; >> + struct rtl8365mb *mb; >> + int ret; >> + int i; >> + >> + mb = smi->chip_data; > > drivers/net/dsa/rtl8365mb.c:1428:20: warning: variable ‘mb’ set but not used [-Wunused-but-set-variable] > 1428 | struct rtl8365mb *mb; > | ^~ > Woops, I will fix this in v2. Thanks.
On Tue, Oct 12, 2021 at 02:35:54PM +0200, Alvin Šipraga wrote: > +/* Port mapping macros > + * > + * PORT_NUM_x2y: map a port number from domain x to domain y > + * PORT_MASK_x2y: map a port mask from domain x to domain y > + * > + * L = logical port domain, i.e. dsa_port.index > + * P = physical port domain, used by the Realtek ASIC for port indexing; > + * for ports with internal PHYs, this is also the PHY index > + * E = extension port domain, used by the Realtek ASIC for managing EXT ports > + * > + * The terminology is borrowed from the vendor driver. The extension port domain > + * is mostly used to navigate the labyrinthine layout of EXT port configuration > + * registers and is not considered intuitive by the author. > + * > + * Unless a function is accessing chip registers, it should be using the logical > + * port domain. Moreover, function arguments for port numbers and port masks > + * must always be in the logical domain. The conversion must be done as close as > + * possible to the register access to avoid chaos. > + * > + * The mappings vary between chips in the family supported by this driver. Here > + * is an example of the mapping for the RTL8365MB-VC: > + * > + * L | P | E | remark > + * ---+---+---+-------- > + * 0 | 0 | | user port > + * 1 | 1 | | user port > + * 2 | 2 | | user port > + * 3 | 3 | | user port > + * 4 | 6 | 1 | extension (CPU) port > + * > + * NOTE: Currently this is hardcoded for the RTL8365MB-VC. This will probably > + * require a rework when adding support for other chips. > + */ > +#define CPU_PORT_LOGICAL_NUM 4 > +#define CPU_PORT_LOGICAL_MASK BIT(CPU_PORT_LOGICAL_NUM) > +#define CPU_PORT_PHYSICAL_NUM 6 > +#define CPU_PORT_PHYSICAL_MASK BIT(CPU_PORT_PHYSICAL_NUM) > +#define CPU_PORT_EXTENSION_NUM 1 > + > +static u32 rtl8365mb_port_num_l2p(u32 port) > +{ > + return port == CPU_PORT_LOGICAL_NUM ? CPU_PORT_PHYSICAL_NUM : port; > +} > + > +static u32 rtl8365mb_port_mask_l2p(u32 mask) > +{ > + u32 phys_mask = mask & ~CPU_PORT_LOGICAL_MASK; > + > + if (mask & CPU_PORT_LOGICAL_MASK) > + phys_mask |= CPU_PORT_PHYSICAL_MASK; > + > + return phys_mask; > +} > + > +static u32 rtl8365mb_port_mask_p2l(u32 phys_mask) > +{ > + u32 mask = phys_mask & ~CPU_PORT_PHYSICAL_MASK; > + > + if (phys_mask & CPU_PORT_PHYSICAL_MASK) > + mask |= CPU_PORT_LOGICAL_MASK; > + > + return mask; > +} > + > +#define PORT_NUM_L2P(_p) (rtl8365mb_port_num_l2p(_p)) > +#define PORT_NUM_L2E(_p) (CPU_PORT_EXTENSION_NUM) > +#define PORT_MASK_L2P(_m) (rtl8365mb_port_mask_l2p(_m)) > +#define PORT_MASK_P2L(_m) (rtl8365mb_port_mask_p2l(_m)) The whole port mapping thing can be avoided if you just use port 6 as the CPU port. > + > +/* Chip-specific data and limits */
On 10/13/21 11:55 AM, DENG Qingfang wrote: > On Tue, Oct 12, 2021 at 02:35:54PM +0200, Alvin Šipraga wrote: >> +/* Port mapping macros >> + * >> + * PORT_NUM_x2y: map a port number from domain x to domain y >> + * PORT_MASK_x2y: map a port mask from domain x to domain y >> + * >> + * L = logical port domain, i.e. dsa_port.index >> + * P = physical port domain, used by the Realtek ASIC for port indexing; >> + * for ports with internal PHYs, this is also the PHY index >> + * E = extension port domain, used by the Realtek ASIC for managing EXT ports >> + * >> + * The terminology is borrowed from the vendor driver. The extension port domain >> + * is mostly used to navigate the labyrinthine layout of EXT port configuration >> + * registers and is not considered intuitive by the author. >> + * >> + * Unless a function is accessing chip registers, it should be using the logical >> + * port domain. Moreover, function arguments for port numbers and port masks >> + * must always be in the logical domain. The conversion must be done as close as >> + * possible to the register access to avoid chaos. >> + * >> + * The mappings vary between chips in the family supported by this driver. Here >> + * is an example of the mapping for the RTL8365MB-VC: >> + * >> + * L | P | E | remark >> + * ---+---+---+-------- >> + * 0 | 0 | | user port >> + * 1 | 1 | | user port >> + * 2 | 2 | | user port >> + * 3 | 3 | | user port >> + * 4 | 6 | 1 | extension (CPU) port >> + * >> + * NOTE: Currently this is hardcoded for the RTL8365MB-VC. This will probably >> + * require a rework when adding support for other chips. >> + */ >> +#define CPU_PORT_LOGICAL_NUM 4 >> +#define CPU_PORT_LOGICAL_MASK BIT(CPU_PORT_LOGICAL_NUM) >> +#define CPU_PORT_PHYSICAL_NUM 6 >> +#define CPU_PORT_PHYSICAL_MASK BIT(CPU_PORT_PHYSICAL_NUM) >> +#define CPU_PORT_EXTENSION_NUM 1 >> + >> +static u32 rtl8365mb_port_num_l2p(u32 port) >> +{ >> + return port == CPU_PORT_LOGICAL_NUM ? CPU_PORT_PHYSICAL_NUM : port; >> +} >> + >> +static u32 rtl8365mb_port_mask_l2p(u32 mask) >> +{ >> + u32 phys_mask = mask & ~CPU_PORT_LOGICAL_MASK; >> + >> + if (mask & CPU_PORT_LOGICAL_MASK) >> + phys_mask |= CPU_PORT_PHYSICAL_MASK; >> + >> + return phys_mask; >> +} >> + >> +static u32 rtl8365mb_port_mask_p2l(u32 phys_mask) >> +{ >> + u32 mask = phys_mask & ~CPU_PORT_PHYSICAL_MASK; >> + >> + if (phys_mask & CPU_PORT_PHYSICAL_MASK) >> + mask |= CPU_PORT_LOGICAL_MASK; >> + >> + return mask; >> +} >> + >> +#define PORT_NUM_L2P(_p) (rtl8365mb_port_num_l2p(_p)) >> +#define PORT_NUM_L2E(_p) (CPU_PORT_EXTENSION_NUM) >> +#define PORT_MASK_L2P(_m) (rtl8365mb_port_mask_l2p(_m)) >> +#define PORT_MASK_P2L(_m) (rtl8365mb_port_mask_p2l(_m)) > > The whole port mapping thing can be avoided if you just use port 6 as the CPU > port. Andrew also suggested this, but the discontinuity in port IDs seems to be an invitation for trouble. Here is an example of a series of functions from dsa.h: static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p) { struct dsa_switch_tree *dst = ds->dst; struct dsa_port *dp; list_for_each_entry(dp, &dst->ports, list) if (dp->ds == ds && dp->index == p) return dp; return NULL; } static inline bool dsa_is_user_port(struct dsa_switch *ds, int p) { return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER; } static inline u32 dsa_user_ports(struct dsa_switch *ds) { u32 mask = 0; int p; for (p = 0; p < ds->num_ports; p++) if (dsa_is_user_port(ds, p)) mask |= BIT(p); return mask; } My reading of dsa_user_ports() is that the port IDs run from 0 to (ds->num_ports - 1). If num_ports is 5 (4 user ports and 1 CPU port, as in my case), but the CPU is port 6, will we not dereference NULL when calling dsa_is_user_port(ds, 4)? > >> + >> +/* Chip-specific data and limits */
On Wed, Oct 13, 2021 at 10:05:21AM +0000, Alvin Šipraga wrote: > On 10/13/21 11:55 AM, DENG Qingfang wrote: > > On Tue, Oct 12, 2021 at 02:35:54PM +0200, Alvin Šipraga wrote: > >> +/* Port mapping macros > >> + * > >> + * PORT_NUM_x2y: map a port number from domain x to domain y > >> + * PORT_MASK_x2y: map a port mask from domain x to domain y > >> + * > >> + * L = logical port domain, i.e. dsa_port.index > >> + * P = physical port domain, used by the Realtek ASIC for port indexing; > >> + * for ports with internal PHYs, this is also the PHY index > >> + * E = extension port domain, used by the Realtek ASIC for managing EXT ports > >> + * > >> + * The terminology is borrowed from the vendor driver. The extension port domain > >> + * is mostly used to navigate the labyrinthine layout of EXT port configuration > >> + * registers and is not considered intuitive by the author. > >> + * > >> + * Unless a function is accessing chip registers, it should be using the logical > >> + * port domain. Moreover, function arguments for port numbers and port masks > >> + * must always be in the logical domain. The conversion must be done as close as > >> + * possible to the register access to avoid chaos. > >> + * > >> + * The mappings vary between chips in the family supported by this driver. Here > >> + * is an example of the mapping for the RTL8365MB-VC: > >> + * > >> + * L | P | E | remark > >> + * ---+---+---+-------- > >> + * 0 | 0 | | user port > >> + * 1 | 1 | | user port > >> + * 2 | 2 | | user port > >> + * 3 | 3 | | user port > >> + * 4 | 6 | 1 | extension (CPU) port > >> + * > >> + * NOTE: Currently this is hardcoded for the RTL8365MB-VC. This will probably > >> + * require a rework when adding support for other chips. > >> + */ > >> +#define CPU_PORT_LOGICAL_NUM 4 > >> +#define CPU_PORT_LOGICAL_MASK BIT(CPU_PORT_LOGICAL_NUM) > >> +#define CPU_PORT_PHYSICAL_NUM 6 > >> +#define CPU_PORT_PHYSICAL_MASK BIT(CPU_PORT_PHYSICAL_NUM) > >> +#define CPU_PORT_EXTENSION_NUM 1 > >> + > >> +static u32 rtl8365mb_port_num_l2p(u32 port) > >> +{ > >> + return port == CPU_PORT_LOGICAL_NUM ? CPU_PORT_PHYSICAL_NUM : port; > >> +} > >> + > >> +static u32 rtl8365mb_port_mask_l2p(u32 mask) > >> +{ > >> + u32 phys_mask = mask & ~CPU_PORT_LOGICAL_MASK; > >> + > >> + if (mask & CPU_PORT_LOGICAL_MASK) > >> + phys_mask |= CPU_PORT_PHYSICAL_MASK; > >> + > >> + return phys_mask; > >> +} > >> + > >> +static u32 rtl8365mb_port_mask_p2l(u32 phys_mask) > >> +{ > >> + u32 mask = phys_mask & ~CPU_PORT_PHYSICAL_MASK; > >> + > >> + if (phys_mask & CPU_PORT_PHYSICAL_MASK) > >> + mask |= CPU_PORT_LOGICAL_MASK; > >> + > >> + return mask; > >> +} > >> + > >> +#define PORT_NUM_L2P(_p) (rtl8365mb_port_num_l2p(_p)) > >> +#define PORT_NUM_L2E(_p) (CPU_PORT_EXTENSION_NUM) > >> +#define PORT_MASK_L2P(_m) (rtl8365mb_port_mask_l2p(_m)) > >> +#define PORT_MASK_P2L(_m) (rtl8365mb_port_mask_p2l(_m)) > > > > The whole port mapping thing can be avoided if you just use port 6 as the CPU > > port. > > Andrew also suggested this, but the discontinuity in port IDs seems to > be an invitation for trouble. Here is an example of a series of > functions from dsa.h: > > static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p) > { > struct dsa_switch_tree *dst = ds->dst; > struct dsa_port *dp; > > list_for_each_entry(dp, &dst->ports, list) > if (dp->ds == ds && dp->index == p) > return dp; > > return NULL; > } > > static inline bool dsa_is_user_port(struct dsa_switch *ds, int p) > { > return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER; > } > > static inline u32 dsa_user_ports(struct dsa_switch *ds) > { > u32 mask = 0; > int p; > > for (p = 0; p < ds->num_ports; p++) > if (dsa_is_user_port(ds, p)) > mask |= BIT(p); > > return mask; > } > > My reading of dsa_user_ports() is that the port IDs run from 0 to > (ds->num_ports - 1). If num_ports is 5 (4 user ports and 1 CPU port, as > in my case), but the CPU is port 6, will we not dereference NULL when > calling dsa_is_user_port(ds, 4)? > > > > >> + > >> +/* Chip-specific data and limits */ > No, have you actually tried it? Discontinuities should be absolutely fine, see dsa_switch_touch_ports(), a struct dsa_port is created for every port number up to ds->num_ports, the ones absent from DT will simply remain as DSA_PORT_TYPE_UNUSED.
On Wed, Oct 13, 2021 at 10:05:21AM +0000, Alvin Šipraga wrote: > Andrew also suggested this, but the discontinuity in port IDs seems to > be an invitation for trouble. Here is an example of a series of > functions from dsa.h: > > static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p) > { > struct dsa_switch_tree *dst = ds->dst; > struct dsa_port *dp; > > list_for_each_entry(dp, &dst->ports, list) > if (dp->ds == ds && dp->index == p) > return dp; > > return NULL; > } > > static inline bool dsa_is_user_port(struct dsa_switch *ds, int p) > { > return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER; > } > > static inline u32 dsa_user_ports(struct dsa_switch *ds) > { > u32 mask = 0; > int p; > > for (p = 0; p < ds->num_ports; p++) > if (dsa_is_user_port(ds, p)) > mask |= BIT(p); > > return mask; > } > > My reading of dsa_user_ports() is that the port IDs run from 0 to > (ds->num_ports - 1). If num_ports is 5 (4 user ports and 1 CPU port, as > in my case), but the CPU is port 6, will we not dereference NULL when > calling dsa_is_user_port(ds, 4)? So set num_ports to 7. > > > > >> + > >> +/* Chip-specific data and limits */ >
On Tue, Oct 12, 2021 at 2:37 PM Alvin Šipraga <alvin@pqrs.dk> wrote: > This patch adds a realtek-smi subdriver for the RTL8365MB-VC 4+1 port > 10/100/1000M switch controller. The driver has been developed based on a > GPL-licensed OS-agnostic Realtek vendor driver known as rtl8367c found > in the OpenWrt source tree. (...) > Co-developed-by: Michael Rasmussen <mir@bang-olufsen.dk> > Signed-off-by: Michael Rasmussen <mir@bang-olufsen.dk> > Signed-off-by: Alvin Šipraga <alsi@bang-olufsen.dk> Overall this driver looks very good :) Some minor nits below: > +static irqreturn_t rtl8365mb_irq(int irq, void *data) > +{ (...) > + if (!line_changes) > + goto out_none; > + > + while (line_changes) { > + int line = __ffs(line_changes); > + int child_irq; > + > + line_changes &= ~BIT(line); > + > + child_irq = irq_find_mapping(smi->irqdomain, line); > + handle_nested_irq(child_irq); > + } What about just: for_each_set_bit(offset, &line_changes, 32) { child_irq = irq_find_mapping(smi->irqdomain, line); handle_nested_irq(child_irq); } ? I don't know how many or which bits are valid IRQs, 16 maybe rather than 32. > +static struct irq_chip rtl8365mb_irq_chip = { > + .name = "rtl8365mb", > + /* The hardware doesn't support masking IRQs on a per-port basis */ > +}; I would rathe make this a dynamically allocated struct inside struct rtl8365mb, so the irqchip lives with the instance of the chip. (Which is nice if there would happen to be two of these chips in a system.) > +static int _rtl8365mb_irq_enable(struct realtek_smi *smi, bool enable) I'm personally a bit allergic to _rand_underscore_naming, as sometimes that means "inner function" and sometimes it means "compiler intrinsic" I would just name it rtl8365mb_irq_config_commit() (no strong opinion) > + /* Configure chip interrupt signal polarity */ > + irq_trig = irqd_get_trigger_type(irq_get_irq_data(irq)); Nice that you preserve this edge trigger config from the machine description (DT)! With this fixed or not (your preference) Reviewed-by: Linus Walleij <linus.walleij@linaro.org> Yours, Linus Walleij
On Wed, 13 Oct 2021 08:33:36 +0000 Alvin Šipraga wrote: > On 10/12/21 5:27 PM, Jakub Kicinski wrote: > > On Tue, 12 Oct 2021 14:35:54 +0200 Alvin Šipraga wrote: > >> + { 0, 4, 2, "dot3StatsFCSErrors" }, > >> + { 0, 6, 2, "dot3StatsSymbolErrors" }, > >> + { 0, 8, 2, "dot3InPauseFrames" }, > >> + { 0, 10, 2, "dot3ControlInUnknownOpcodes" }, > > ... > > > > You must expose counters via existing standard APIs. > > > > You should implement these ethtool ops: > > I implement the dsa_switch_ops callback .get_ethtool_stats, using an > existing function rtl8366_get_ethtool_stats in the switch helper library > rtl8366.c. It was my understanding that this is the correct way to > expose counters within the DSA framework - please correct me if that is > wrong. It's the legacy way, today we have a unified API for reporting those stats so user space SW doesn't have to maintain a myriad string matches to get to basic IEEE stats across vendors. Driver authors have a truly incredible ability to invent their own names for standard stats. It appears that your pick of names is also unique :) It should be trivial to plumb the relevant ethtool_ops thru to dsa_switch_ops if relevant dsa ops don't exist. You should also populate correct stats in dsa_switch_ops::get_stats64 (see the large comment above the definition of struct rtnl_link_stats64 for mapping). A word of warning there, tho, that callback runs in an atomic context so if your driver needs to block it has to read the stats periodically from a async work. > The structure you highlight is just some internal glue to sort out the > internal register mapping. I borrowed the approach from the existing > rtl8366rb.c Realtek SMI subdriver. The callbacks listed below are relatively new, they may have not existed when that driver was written. Also I may have missed it in review. > > void (*get_eth_phy_stats)(struct net_device *dev, > > struct ethtool_eth_phy_stats *phy_stats); > > void (*get_eth_mac_stats)(struct net_device *dev, > > struct ethtool_eth_mac_stats *mac_stats); > > void (*get_eth_ctrl_stats)(struct net_device *dev, > > struct ethtool_eth_ctrl_stats *ctrl_stats); > > void (*get_rmon_stats)(struct net_device *dev, > > struct ethtool_rmon_stats *rmon_stats, > > const struct ethtool_rmon_hist_range **ranges);
On 10/13/21 5:12 PM, Linus Walleij wrote: > On Tue, Oct 12, 2021 at 2:37 PM Alvin Šipraga <alvin@pqrs.dk> wrote: > >> This patch adds a realtek-smi subdriver for the RTL8365MB-VC 4+1 port >> 10/100/1000M switch controller. The driver has been developed based on a >> GPL-licensed OS-agnostic Realtek vendor driver known as rtl8367c found >> in the OpenWrt source tree. > (...) >> Co-developed-by: Michael Rasmussen <mir@bang-olufsen.dk> >> Signed-off-by: Michael Rasmussen <mir@bang-olufsen.dk> >> Signed-off-by: Alvin Šipraga <alsi@bang-olufsen.dk> > > Overall this driver looks very good :) > > Some minor nits below: > >> +static irqreturn_t rtl8365mb_irq(int irq, void *data) >> +{ > (...) >> + if (!line_changes) >> + goto out_none; >> + >> + while (line_changes) { >> + int line = __ffs(line_changes); >> + int child_irq; >> + >> + line_changes &= ~BIT(line); >> + >> + child_irq = irq_find_mapping(smi->irqdomain, line); >> + handle_nested_irq(child_irq); >> + } > > What about just: > > for_each_set_bit(offset, &line_changes, 32) { > child_irq = irq_find_mapping(smi->irqdomain, line); > handle_nested_irq(child_irq); > } > > ? > > I don't know how many or which bits are valid IRQs, 16 maybe rather > than 32. > >> +static struct irq_chip rtl8365mb_irq_chip = { >> + .name = "rtl8365mb", >> + /* The hardware doesn't support masking IRQs on a per-port basis */ >> +}; > > I would rathe make this a dynamically allocated struct inside > struct rtl8365mb, so the irqchip lives with the instance of the > chip. (Which is nice if there would happen to be two of these > chips in a system.) Forgive my ignorance, but is it actually necessary? Can't multiple instances of the switch still use the same irq_chip structure? That seems to be OK for the dummy chip, for example (dummychip.c). I also failed to find a driver which does it the way you suggest. I will incorporate the rest of your feedback into v3. :) > >> +static int _rtl8365mb_irq_enable(struct realtek_smi *smi, bool enable) > > I'm personally a bit allergic to _rand_underscore_naming, as sometimes > that means "inner function" and sometimes it means "compiler intrinsic" > I would just name it rtl8365mb_irq_config_commit() > > (no strong opinion) > >> + /* Configure chip interrupt signal polarity */ >> + irq_trig = irqd_get_trigger_type(irq_get_irq_data(irq)); > > Nice that you preserve this edge trigger config from the machine > description (DT)! > > With this fixed or not (your preference) > Reviewed-by: Linus Walleij <linus.walleij@linaro.org> > > Yours, > Linus Walleij >
On 10/13/21 5:13 PM, Jakub Kicinski wrote: > On Wed, 13 Oct 2021 08:33:36 +0000 Alvin Šipraga wrote: >> On 10/12/21 5:27 PM, Jakub Kicinski wrote: >>> On Tue, 12 Oct 2021 14:35:54 +0200 Alvin Šipraga wrote: >>>> + { 0, 4, 2, "dot3StatsFCSErrors" }, >>>> + { 0, 6, 2, "dot3StatsSymbolErrors" }, >>>> + { 0, 8, 2, "dot3InPauseFrames" }, >>>> + { 0, 10, 2, "dot3ControlInUnknownOpcodes" }, >>> ... >>> >>> You must expose counters via existing standard APIs. >>> >>> You should implement these ethtool ops: >> >> I implement the dsa_switch_ops callback .get_ethtool_stats, using an >> existing function rtl8366_get_ethtool_stats in the switch helper library >> rtl8366.c. It was my understanding that this is the correct way to >> expose counters within the DSA framework - please correct me if that is >> wrong. > > It's the legacy way, today we have a unified API for reporting those > stats so user space SW doesn't have to maintain a myriad string matches > to get to basic IEEE stats across vendors. Driver authors have a truly > incredible ability to invent their own names for standard stats. It > appears that your pick of names is also unique :) > > It should be trivial to plumb the relevant ethtool_ops thru to > dsa_switch_ops if relevant dsa ops don't exist. > > You should also populate correct stats in dsa_switch_ops::get_stats64 > (see the large comment above the definition of struct > rtnl_link_stats64 for mapping). A word of warning there, tho, that > callback runs in an atomic context so if your driver needs to block it > has to read the stats periodically from a async work. OK, so just to clarify: - get_ethtool_stats is deprecated - do not use - get_eth_{phy,mac,ctrl,rmon}_stats is the new API - add DSA plumbing and use this - get_stats64 orthogonal to ethtool stats but still important - use also this For stats64 I will need to poll asynchronously - do you have any suggestion for how frequently I should do that? I see one DSA driver doing it every 3 seconds, for example. Thanks Alvin > >> The structure you highlight is just some internal glue to sort out the >> internal register mapping. I borrowed the approach from the existing >> rtl8366rb.c Realtek SMI subdriver. > > The callbacks listed below are relatively new, they may have not > existed when that driver was written. Also I may have missed it > in review. > >>> void (*get_eth_phy_stats)(struct net_device *dev, >>> struct ethtool_eth_phy_stats *phy_stats); >>> void (*get_eth_mac_stats)(struct net_device *dev, >>> struct ethtool_eth_mac_stats *mac_stats); >>> void (*get_eth_ctrl_stats)(struct net_device *dev, >>> struct ethtool_eth_ctrl_stats *ctrl_stats); >>> void (*get_rmon_stats)(struct net_device *dev, >>> struct ethtool_rmon_stats *rmon_stats, >>> const struct ethtool_rmon_hist_range **ranges);
On Thu, 14 Oct 2021 12:44:37 +0000 Alvin Šipraga wrote: > On 10/13/21 5:13 PM, Jakub Kicinski wrote: > > On Wed, 13 Oct 2021 08:33:36 +0000 Alvin Šipraga wrote: > >> I implement the dsa_switch_ops callback .get_ethtool_stats, using an > >> existing function rtl8366_get_ethtool_stats in the switch helper library > >> rtl8366.c. It was my understanding that this is the correct way to > >> expose counters within the DSA framework - please correct me if that is > >> wrong. > > > > It's the legacy way, today we have a unified API for reporting those > > stats so user space SW doesn't have to maintain a myriad string matches > > to get to basic IEEE stats across vendors. Driver authors have a truly > > incredible ability to invent their own names for standard stats. It > > appears that your pick of names is also unique :) > > > > It should be trivial to plumb the relevant ethtool_ops thru to > > dsa_switch_ops if relevant dsa ops don't exist. > > > > You should also populate correct stats in dsa_switch_ops::get_stats64 > > (see the large comment above the definition of struct > > rtnl_link_stats64 for mapping). A word of warning there, tho, that > > callback runs in an atomic context so if your driver needs to block it > > has to read the stats periodically from a async work. > > OK, so just to clarify: > > - get_ethtool_stats is deprecated - do not use It can still be used, but standardized interfaces should be preferred whenever possible, especially when appropriate uAPI already exists. > - get_eth_{phy,mac,ctrl,rmon}_stats is the new API - add DSA plumbing > and use this Yup. > - get_stats64 orthogonal to ethtool stats but still important - use also > this Yes, users should be able to depend on basic interface stats (packets, bytes, crc errors) to be correct. > For stats64 I will need to poll asynchronously - do you have any > suggestion for how frequently I should do that? I see one DSA driver > doing it every 3 seconds, for example. 3 sec seems fine.
diff --git a/drivers/net/dsa/Kconfig b/drivers/net/dsa/Kconfig index a5f1aa911fe2..7b1457a6e327 100644 --- a/drivers/net/dsa/Kconfig +++ b/drivers/net/dsa/Kconfig @@ -70,6 +70,7 @@ config NET_DSA_QCA8K config NET_DSA_REALTEK_SMI tristate "Realtek SMI Ethernet switch family support" select NET_DSA_TAG_RTL4_A + select NET_DSA_TAG_RTL8_4 select FIXED_PHY select IRQ_DOMAIN select REALTEK_PHY diff --git a/drivers/net/dsa/Makefile b/drivers/net/dsa/Makefile index f3598c040994..8da1569a34e6 100644 --- a/drivers/net/dsa/Makefile +++ b/drivers/net/dsa/Makefile @@ -10,7 +10,7 @@ obj-$(CONFIG_NET_DSA_MT7530) += mt7530.o obj-$(CONFIG_NET_DSA_MV88E6060) += mv88e6060.o obj-$(CONFIG_NET_DSA_QCA8K) += qca8k.o obj-$(CONFIG_NET_DSA_REALTEK_SMI) += realtek-smi.o -realtek-smi-objs := realtek-smi-core.o rtl8366.o rtl8366rb.o +realtek-smi-objs := realtek-smi-core.o rtl8366.o rtl8366rb.o rtl8365mb.o obj-$(CONFIG_NET_DSA_SMSC_LAN9303) += lan9303-core.o obj-$(CONFIG_NET_DSA_SMSC_LAN9303_I2C) += lan9303_i2c.o obj-$(CONFIG_NET_DSA_SMSC_LAN9303_MDIO) += lan9303_mdio.o diff --git a/drivers/net/dsa/realtek-smi-core.c b/drivers/net/dsa/realtek-smi-core.c index 2fcfd917b876..c66ebd0ee217 100644 --- a/drivers/net/dsa/realtek-smi-core.c +++ b/drivers/net/dsa/realtek-smi-core.c @@ -501,6 +501,10 @@ static const struct of_device_id realtek_smi_of_match[] = { .compatible = "realtek,rtl8366s", .data = NULL, }, + { + .compatible = "realtek,rtl8365mb", + .data = &rtl8365mb_variant, + }, { /* sentinel */ }, }; MODULE_DEVICE_TABLE(of, realtek_smi_of_match); diff --git a/drivers/net/dsa/realtek-smi-core.h b/drivers/net/dsa/realtek-smi-core.h index 214f710d7dd5..5bfa53e2480a 100644 --- a/drivers/net/dsa/realtek-smi-core.h +++ b/drivers/net/dsa/realtek-smi-core.h @@ -140,5 +140,6 @@ int rtl8366_get_sset_count(struct dsa_switch *ds, int port, int sset); void rtl8366_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data); extern const struct realtek_smi_variant rtl8366rb_variant; +extern const struct realtek_smi_variant rtl8365mb_variant; #endif /* _REALTEK_SMI_H */ diff --git a/drivers/net/dsa/rtl8365mb.c b/drivers/net/dsa/rtl8365mb.c new file mode 100644 index 000000000000..a3446d9c8bd9 --- /dev/null +++ b/drivers/net/dsa/rtl8365mb.c @@ -0,0 +1,1610 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Realtek SMI subdriver for the Realtek RTL8365MB-VC ethernet switch. + * + * Copyright (C) 2021 Alvin Šipraga <alsi@bang-olufsen.dk> + * Copyright (C) 2021 Michael Rasmussen <mir@bang-olufsen.dk> + * + * The RTL8365MB-VC is a 4+1 port 10/100/1000M switch controller. It includes 4 + * integrated PHYs for the user facing ports, and an extension interface which + * can be connected to the CPU - or another PHY - via either MII, RMII, or + * RGMII. The switch is configured via the Realtek Simple Management Interface + * (SMI), which uses the MDIO/MDC lines. + * + * Below is a simplified block diagram of the chip and its relevant interfaces. + * + * .-----------------------------------. + * | | + * UTP <---------------> Giga PHY <-> PCS <-> P0 GMAC | + * UTP <---------------> Giga PHY <-> PCS <-> P1 GMAC | + * UTP <---------------> Giga PHY <-> PCS <-> P2 GMAC | + * UTP <---------------> Giga PHY <-> PCS <-> P3 GMAC | + * | | + * CPU/PHY <-MII/RMII/RGMII---> Extension <---> Extension | + * | interface 1 GMAC 1 | + * | | + * SMI driver/ <-MDC/SCL---> Management ~~~~~~~~~~~~~~ | + * EEPROM <-MDIO/SDA--> interface ~REALTEK ~~~~~ | + * | ~RTL8365MB ~~~ | + * | ~GXXXC TAIWAN~ | + * GPIO <--------------> Reset ~~~~~~~~~~~~~~ | + * | | + * Interrupt <----------> Link UP/DOWN events | + * controller | | + * '-----------------------------------' + * + * The driver uses DSA to integrate the 4 user and 1 extension ports into the + * kernel. Netdevices are created for the user ports, as are PHY devices for + * their integrated PHYs. The device tree firmware should also specify the link + * partner of the extension port - either via a fixed-link or other phy-handle. + * See the device tree bindings for more detailed information. Note that the + * driver has only been tested with a fixed-link, but in principle it should not + * matter. + * + * NOTE: Currently, only the RGMII interface is implemented in this driver. + * + * The interrupt line is asserted on link UP/DOWN events. The driver creates a + * custom irqchip to handle this interrupt and demultiplex the events by reading + * the status registers via SMI. Interrupts are then propagated to the relevant + * PHY device. + * + * The EEPROM contains initial register values which the chip will read over I2C + * upon hardware reset. It is also possible to omit the EEPROM. In both cases, + * the driver will manually reprogram some registers using jam tables to reach + * an initial state defined by the vendor driver. + * + * This Linux driver is written based on an OS-agnostic vendor driver from + * Realtek. The reference GPL-licensed sources can be found in the OpenWrt + * source tree under the name rtl8367c. The vendor driver claims to support a + * number of similar switch controllers from Realtek, but the only hardware we + * have is the RTL8365MB-VC. Moreover, there does not seem to be any chip under + * the name RTL8367C. Although one wishes that the 'C' stood for some kind of + * common hardware revision, there exist examples of chips with the suffix -VC + * which are explicitly not supported by the rtl8367c driver and which instead + * require the rtl8367d vendor driver. With all this uncertainty, the driver has + * been modestly named rtl8365mb. Future implementors may wish to rename things + * accordingly. + * + * In the same family of chips, some carry up to 8 user ports and up to 2 + * extension ports. Where possible this driver tries to make things generic, but + * more work must be done to support these configurations. According to + * documentation from Realtek, the family should include the following chips: + * + * - RTL8363NB + * - RTL8363NB-VB + * - RTL8363SC + * - RTL8363SC-VB + * - RTL8364NB + * - RTL8364NB-VB + * - RTL8365MB-VC + * - RTL8366SC + * - RTL8367RB-VB + * - RTL8367SB + * - RTL8367S + * - RTL8370MB + * - RTL8310SR + * + * Some of the register logic for these additional chips has been skipped over + * while implementing this driver. It is therefore not possible to assume that + * things will work out-of-the-box for other chips, and a careful review of the + * vendor driver may be needed to expand support. The RTL8365MB-VC seems to be + * one of the simpler chips. + */ + +#include <linux/bitfield.h> +#include <linux/bitops.h> +#include <linux/interrupt.h> +#include <linux/irqdomain.h> +#include <linux/of_irq.h> +#include <linux/regmap.h> +#include <linux/if_bridge.h> + +#include "realtek-smi-core.h" + +/* Port mapping macros + * + * PORT_NUM_x2y: map a port number from domain x to domain y + * PORT_MASK_x2y: map a port mask from domain x to domain y + * + * L = logical port domain, i.e. dsa_port.index + * P = physical port domain, used by the Realtek ASIC for port indexing; + * for ports with internal PHYs, this is also the PHY index + * E = extension port domain, used by the Realtek ASIC for managing EXT ports + * + * The terminology is borrowed from the vendor driver. The extension port domain + * is mostly used to navigate the labyrinthine layout of EXT port configuration + * registers and is not considered intuitive by the author. + * + * Unless a function is accessing chip registers, it should be using the logical + * port domain. Moreover, function arguments for port numbers and port masks + * must always be in the logical domain. The conversion must be done as close as + * possible to the register access to avoid chaos. + * + * The mappings vary between chips in the family supported by this driver. Here + * is an example of the mapping for the RTL8365MB-VC: + * + * L | P | E | remark + * ---+---+---+-------- + * 0 | 0 | | user port + * 1 | 1 | | user port + * 2 | 2 | | user port + * 3 | 3 | | user port + * 4 | 6 | 1 | extension (CPU) port + * + * NOTE: Currently this is hardcoded for the RTL8365MB-VC. This will probably + * require a rework when adding support for other chips. + */ +#define CPU_PORT_LOGICAL_NUM 4 +#define CPU_PORT_LOGICAL_MASK BIT(CPU_PORT_LOGICAL_NUM) +#define CPU_PORT_PHYSICAL_NUM 6 +#define CPU_PORT_PHYSICAL_MASK BIT(CPU_PORT_PHYSICAL_NUM) +#define CPU_PORT_EXTENSION_NUM 1 + +static u32 rtl8365mb_port_num_l2p(u32 port) +{ + return port == CPU_PORT_LOGICAL_NUM ? CPU_PORT_PHYSICAL_NUM : port; +} + +static u32 rtl8365mb_port_mask_l2p(u32 mask) +{ + u32 phys_mask = mask & ~CPU_PORT_LOGICAL_MASK; + + if (mask & CPU_PORT_LOGICAL_MASK) + phys_mask |= CPU_PORT_PHYSICAL_MASK; + + return phys_mask; +} + +static u32 rtl8365mb_port_mask_p2l(u32 phys_mask) +{ + u32 mask = phys_mask & ~CPU_PORT_PHYSICAL_MASK; + + if (phys_mask & CPU_PORT_PHYSICAL_MASK) + mask |= CPU_PORT_LOGICAL_MASK; + + return mask; +} + +#define PORT_NUM_L2P(_p) (rtl8365mb_port_num_l2p(_p)) +#define PORT_NUM_L2E(_p) (CPU_PORT_EXTENSION_NUM) +#define PORT_MASK_L2P(_m) (rtl8365mb_port_mask_l2p(_m)) +#define PORT_MASK_P2L(_m) (rtl8365mb_port_mask_p2l(_m)) + +/* Chip-specific data and limits */ +#define RTL8365MB_CHIP_ID_8365MB_VC 0x6367 +#define RTL8365MB_NUM_PORTS_8365MB_VC 5 +#define RTL8365MB_NUM_PHYS_8365MB_VC 4 +#define RTL8365MB_CPU_PORT_NUM_8365MB_VC 4 +#define RTL8365MB_CPU_PORT_MASK_8365MB_VC BIT(4) +#define RTL8365MB_PHY_PORT_MASK_8365MB_VC GENMASK(3, 0) +#define RTL8365MB_PORT_MASK_8365MB_VC \ + (RTL8365MB_CPU_PORT_MASK_8365MB_VC | \ + RTL8365MB_PHY_PORT_MASK_8365MB_VC) +#define RTL8365MB_LEARN_LIMIT_MAX_8365MB_VC 2112 + +/* Family-specific data and limits */ +#define RTL8365MB_NUM_PHYREGS 32 +#define RTL8365MB_PHYREGMAX (RTL8365MB_NUM_PHYREGS - 1) + +/* Chip identification registers */ +#define RTL8365MB_CHIP_ID_REG 0x1300 + +#define RTL8365MB_CHIP_VER_REG 0x1301 + +#define RTL8365MB_MAGIC_REG 0x13C2 +#define RTL8365MB_MAGIC_VALUE 0x0249 + +/* Chip reset register */ +#define RTL8365MB_CHIP_RESET_REG 0x1322 +#define RTL8365MB_CHIP_RESET_SW_MASK 0x0002 +#define RTL8365MB_CHIP_RESET_HW_MASK 0x0001 + +/* Interrupt polarity register */ +#define RTL8365MB_INTR_POLARITY_REG 0x1100 +#define RTL8365MB_INTR_POLARITY_MASK 0x0001 +#define RTL8365MB_INTR_POLARITY_HIGH 0 +#define RTL8365MB_INTR_POLARITY_LOW 1 + +/* Interrupt control/status register - enable/check specific interrupt types */ +#define RTL8365MB_INTR_CTRL_REG 0x1101 +#define RTL8365MB_INTR_STATUS_REG 0x1102 +#define RTL8365MB_INTR_SLIENT_START_2_MASK 0x1000 +#define RTL8365MB_INTR_SLIENT_START_MASK 0x0800 +#define RTL8365MB_INTR_ACL_ACTION_MASK 0x0200 +#define RTL8365MB_INTR_CABLE_DIAG_FIN_MASK 0x0100 +#define RTL8365MB_INTR_INTERRUPT_8051_MASK 0x0080 +#define RTL8365MB_INTR_LOOP_DETECTION_MASK 0x0040 +#define RTL8365MB_INTR_GREEN_TIMER_MASK 0x0020 +#define RTL8365MB_INTR_SPECIAL_CONGEST_MASK 0x0010 +#define RTL8365MB_INTR_SPEED_CHANGE_MASK 0x0008 +#define RTL8365MB_INTR_LEARN_OVER_MASK 0x0004 +#define RTL8365MB_INTR_METER_EXCEEDED_MASK 0x0002 +#define RTL8365MB_INTR_LINK_CHANGE_MASK 0x0001 +#define RTL8365MB_INTR_ALL_MASK \ + (RTL8365MB_INTR_SLIENT_START_2_MASK | \ + RTL8365MB_INTR_SLIENT_START_MASK | \ + RTL8365MB_INTR_ACL_ACTION_MASK | \ + RTL8365MB_INTR_CABLE_DIAG_FIN_MASK | \ + RTL8365MB_INTR_INTERRUPT_8051_MASK | \ + RTL8365MB_INTR_LOOP_DETECTION_MASK | \ + RTL8365MB_INTR_GREEN_TIMER_MASK | \ + RTL8365MB_INTR_SPECIAL_CONGEST_MASK | \ + RTL8365MB_INTR_SPEED_CHANGE_MASK | \ + RTL8365MB_INTR_LEARN_OVER_MASK | \ + RTL8365MB_INTR_METER_EXCEEDED_MASK | \ + RTL8365MB_INTR_LINK_CHANGE_MASK) + +/* Per-port interrupt type status registers */ +#define RTL8365MB_PORT_LINKDOWN_IND_REG 0x1106 +#define RTL8365MB_PORT_LINKDOWN_IND_MASK 0x07FF + +#define RTL8365MB_PORT_LINKUP_IND_REG 0x1107 +#define RTL8365MB_PORT_LINKUP_IND_MASK 0x07FF + +/* PHY indirect access registers */ +#define RTL8365MB_INDIRECT_ACCESS_CTRL_REG 0x1F00 +#define RTL8365MB_INDIRECT_ACCESS_CTRL_RW_MASK 0x0002 +#define RTL8365MB_INDIRECT_ACCESS_CTRL_RW_READ 0 +#define RTL8365MB_INDIRECT_ACCESS_CTRL_RW_WRITE 1 +#define RTL8365MB_INDIRECT_ACCESS_CTRL_CMD_MASK 0x0001 +#define RTL8365MB_INDIRECT_ACCESS_CTRL_CMD_VALUE 1 +#define RTL8365MB_INDIRECT_ACCESS_STATUS_REG 0x1F01 +#define RTL8365MB_INDIRECT_ACCESS_ADDRESS_REG 0x1F02 +#define RTL8365MB_INDIRECT_ACCESS_ADDRESS_OCPADR_5_1_MASK GENMASK(4, 0) +#define RTL8365MB_INDIRECT_ACCESS_ADDRESS_PHYNUM_MASK GENMASK(6, 5) +#define RTL8365MB_INDIRECT_ACCESS_ADDRESS_OCPADR_9_6_MASK GENMASK(11, 8) +#define RTL8365MB_PHY_BASE 0x2000 +#define RTL8365MB_INDIRECT_ACCESS_WRITE_DATA_REG 0x1F03 +#define RTL8365MB_INDIRECT_ACCESS_READ_DATA_REG 0x1F04 + +/* PHY OCP address prefix register */ +#define RTL8365MB_GPHY_OCP_MSB_0_REG 0x1D15 +#define RTL8365MB_GPHY_OCP_MSB_0_CFG_CPU_OCPADR_MASK 0x0FC0 +#define RTL8365MB_PHY_OCP_ADDR_PREFIX_MASK 0xFC00 + +/* The PHY OCP addresses of PHY registers 0~31 start here */ +#define RTL8365MB_PHY_OCP_ADDR_PHYREG_BASE 0xA400 + +/* EXT port interface mode values - used in DIGITAL_INTERFACE_SELECT */ +#define RTL8365MB_EXT_PORT_MODE_DISABLE 0 +#define RTL8365MB_EXT_PORT_MODE_RGMII 1 +#define RTL8365MB_EXT_PORT_MODE_MII_MAC 2 +#define RTL8365MB_EXT_PORT_MODE_MII_PHY 3 +#define RTL8365MB_EXT_PORT_MODE_TMII_MAC 4 +#define RTL8365MB_EXT_PORT_MODE_TMII_PHY 5 +#define RTL8365MB_EXT_PORT_MODE_GMII 6 +#define RTL8365MB_EXT_PORT_MODE_RMII_MAC 7 +#define RTL8365MB_EXT_PORT_MODE_RMII_PHY 8 +#define RTL8365MB_EXT_PORT_MODE_SGMII 9 +#define RTL8365MB_EXT_PORT_MODE_HSGMII 10 +#define RTL8365MB_EXT_PORT_MODE_1000X_100FX 11 +#define RTL8365MB_EXT_PORT_MODE_1000X 12 +#define RTL8365MB_EXT_PORT_MODE_100FX 13 + +/* EXT port interface mode configuration registers 0~1 */ +#define RTL8365MB_DIGITAL_INTERFACE_SELECT_REG0 0x1305 +#define RTL8365MB_DIGITAL_INTERFACE_SELECT_REG1 0x13C3 +#define RTL8365MB_DIGITAL_INTERFACE_SELECT_REG(_extport) \ + (RTL8365MB_DIGITAL_INTERFACE_SELECT_REG0 + \ + ((_extport) >> 1) * (0x13C3 - 0x1305)) +#define RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_MASK(_extport) \ + (0xF << (((_extport) % 2))) +#define RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_OFFSET(_extport) \ + (((_extport) % 2) * 4) + +/* EXT port RGMII TX/RX delay configuration registers 1~2 */ +#define RTL8365MB_EXT_RGMXF_REG1 0x1307 +#define RTL8365MB_EXT_RGMXF_REG2 0x13C5 +#define RTL8365MB_EXT_RGMXF_REG(_extport) \ + (RTL8365MB_EXT_RGMXF_REG1 + \ + (((_extport) >> 1) * (0x13C5 - 0x1307))) +#define RTL8365MB_EXT_RGMXF_RXDELAY_MASK 0x0007 +#define RTL8365MB_EXT_RGMXF_TXDELAY_MASK 0x0008 + +/* External port speed values - used in DIGITAL_INTERFACE_FORCE */ +#define RTL8365MB_PORT_SPEED_10M 0 +#define RTL8365MB_PORT_SPEED_100M 1 +#define RTL8365MB_PORT_SPEED_1000M 2 + +/* EXT port force configuration registers 0~2 */ +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_REG0 0x1310 +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_REG1 0x1311 +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_REG2 0x13C4 +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_REG(_extport) \ + (RTL8365MB_DIGITAL_INTERFACE_FORCE_REG0 + \ + ((_extport) & 0x1) + \ + ((((_extport) >> 1) & 0x1) * (0x13C4 - 0x1310))) +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_EN_MASK 0x1000 +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_NWAY_MASK 0x0080 +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_TXPAUSE_MASK 0x0040 +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_RXPAUSE_MASK 0x0020 +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_LINK_MASK 0x0010 +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_DUPLEX_MASK 0x0004 +#define RTL8365MB_DIGITAL_INTERFACE_FORCE_SPEED_MASK 0x0003 + +/* CPU port mask register - controls which ports are treated as CPU ports */ +#define RTL8365MB_CPU_PORT_MASK_REG 0x1219 +#define RTL8365MB_CPU_PORT_MASK_MASK 0x07FF + +/* CPU control register */ +#define RTL8365MB_CPU_CTRL_REG 0x121A +#define RTL8365MB_CPU_CTRL_TRAP_PORT_EXT_MASK 0x0400 +#define RTL8365MB_CPU_CTRL_TAG_FORMAT_MASK 0x0200 +#define RTL8365MB_CPU_CTRL_RXBYTECOUNT_MASK 0x0080 +#define RTL8365MB_CPU_CTRL_TAG_POSITION_MASK 0x0040 +#define RTL8365MB_CPU_CTRL_TRAP_PORT_MASK 0x0038 +#define RTL8365MB_CPU_CTRL_INSERTMODE_MASK 0x0006 +#define RTL8365MB_CPU_CTRL_EN_MASK 0x0001 + +/* Maximum packet length register */ +#define RTL8365MB_CFG0_MAX_LEN_REG 0x088C +#define RTL8365MB_CFG0_MAX_LEN_MASK 0x3FFF + +/* Port learning limit registers */ +#define RTL8365MB_LUT_PORT_LEARN_LIMIT_BASE 0x0A20 +#define RTL8365MB_LUT_PORT_LEARN_LIMIT_REG(_physport) \ + (RTL8365MB_LUT_PORT_LEARN_LIMIT_BASE + (_physport)) + +/* Port isolation (forwarding mask) registers */ +#define RTL8365MB_PORT_ISOLATION_REG_BASE 0x08A2 +#define RTL8365MB_PORT_ISOLATION_REG(_physport) \ + (RTL8365MB_PORT_ISOLATION_REG_BASE + (_physport)) +#define RTL8365MB_PORT_ISOLATION_MASK 0x07FF + +/* MSTP port state registers - indexed by tree instancrSTI (tree ine */ +#define RTL8365MB_MSTI_CTRL_BASE 0x0A00 +#define RTL8365MB_MSTI_CTRL_REG(_msti, _physport) \ + (RTL8365MB_MSTI_CTRL_BASE + ((_msti) << 1) + ((_physport) >> 3)) +#define RTL8365MB_MSTI_CTRL_PORT_STATE_OFFSET(_physport) ((_physport) << 1) +#define RTL8365MB_MSTI_CTRL_PORT_STATE_MASK(_physport) \ + (0x3 << RTL8365MB_MSTI_CTRL_PORT_STATE_OFFSET((_physport))) + +/* MIB counter value registers */ +#define RTL8365MB_MIB_COUNTER_BASE 0x1000 +#define RTL8365MB_MIB_COUNTER_REG(_x) (RTL8365MB_MIB_COUNTER_BASE + (_x)) + +/* MIB counter address register */ +#define RTL8365MB_MIB_ADDRESS_REG 0x1004 +#define RTL8365MB_MIB_ADDRESS_PORT_OFFSET 0x007C +#define RTL8365MB_MIB_ADDRESS(_p, _x) \ + (((RTL8365MB_MIB_ADDRESS_PORT_OFFSET) * (_p) + (_x)) >> 2) + +#define RTL8365MB_MIB_CTRL0_REG 0x1005 +#define RTL8365MB_MIB_CTRL0_RESET_MASK 0x0002 +#define RTL8365MB_MIB_CTRL0_BUSY_MASK 0x0001 + +static struct rtl8366_mib_counter rtl8365mb_mib_counters[] = { + { 0, 0, 4, "ifInOctets" }, + { 0, 4, 2, "dot3StatsFCSErrors" }, + { 0, 6, 2, "dot3StatsSymbolErrors" }, + { 0, 8, 2, "dot3InPauseFrames" }, + { 0, 10, 2, "dot3ControlInUnknownOpcodes" }, + { 0, 12, 2, "etherStatsFragments" }, + { 0, 14, 2, "etherStatsJabbers" }, + { 0, 16, 2, "ifInUcastPkts" }, + { 0, 18, 2, "etherStatsDropEvents" }, + { 0, 20, 2, "ifInMulticastPkts" }, + { 0, 22, 2, "ifInBroadcastPkts" }, + { 0, 24, 2, "inMldChecksumError" }, + { 0, 26, 2, "inIgmpChecksumError" }, + { 0, 28, 2, "inMldSpecificQuery" }, + { 0, 30, 2, "inMldGeneralQuery" }, + { 0, 32, 2, "inIgmpSpecificQuery" }, + { 0, 34, 2, "inIgmpGeneralQuery" }, + { 0, 36, 2, "inMldLeaves" }, + { 0, 38, 2, "inIgmpLeaves" }, + { 0, 40, 4, "etherStatsOctets" }, + { 0, 44, 2, "etherStatsUnderSizePkts" }, + { 0, 46, 2, "etherOversizeStats" }, + { 0, 48, 2, "etherStatsPkts64Octets" }, + { 0, 50, 2, "etherStatsPkts65to127Octets" }, + { 0, 52, 2, "etherStatsPkts128to255Octets" }, + { 0, 54, 2, "etherStatsPkts256to511Octets" }, + { 0, 56, 2, "etherStatsPkts512to1023Octets" }, + { 0, 58, 2, "etherStatsPkts1024to1518Octets" }, + { 0, 60, 4, "ifOutOctets" }, + { 0, 64, 2, "dot3StatsSingleCollisionFrames" }, + { 0, 66, 2, "dot3StatMultipleCollisionFrames" }, + { 0, 68, 2, "dot3sDeferredTransmissions" }, + { 0, 70, 2, "dot3StatsLateCollisions" }, + { 0, 72, 2, "etherStatsCollisions" }, + { 0, 74, 2, "dot3StatsExcessiveCollisions" }, + { 0, 76, 2, "dot3OutPauseFrames" }, + { 0, 78, 2, "ifOutDiscards" }, + { 0, 80, 2, "dot1dTpPortInDiscards" }, + { 0, 82, 2, "ifOutUcastPkts" }, + { 0, 84, 2, "ifOutMulticastPkts" }, + { 0, 86, 2, "ifOutBroadcastPkts" }, + { 0, 88, 2, "outOampduPkts" }, + { 0, 90, 2, "inOampduPkts" }, + { 0, 92, 4, "inIgmpJoinsSuccess" }, + { 0, 96, 2, "inIgmpJoinsFail" }, + { 0, 98, 2, "inMldJoinsSuccess" }, + { 0, 100, 2, "inMldJoinsFail" }, + { 0, 102, 2, "inReportSuppressionDrop" }, + { 0, 104, 2, "inLeaveSuppressionDrop" }, + { 0, 106, 2, "outIgmpReports" }, + { 0, 108, 2, "outIgmpLeaves" }, + { 0, 110, 2, "outIgmpGeneralQuery" }, + { 0, 112, 2, "outIgmpSpecificQuery" }, + { 0, 114, 2, "outMldReports" }, + { 0, 116, 2, "outMldLeaves" }, + { 0, 118, 2, "outMldGeneralQuery" }, + { 0, 120, 2, "outMldSpecificQuery" }, + { 0, 122, 2, "inKnownMulticastPkts" }, +}; + +struct rtl8365mb_jam_tbl_entry { + u16 reg; + u16 val; +}; + +/* Lifted from the vendor driver sources */ +static const struct rtl8365mb_jam_tbl_entry rtl8365mb_init_jam_8365mb_vc[] = { + { 0x13EB, 0x15BB }, { 0x1303, 0x06D6 }, { 0x1304, 0x0700 }, + { 0x13E2, 0x003F }, { 0x13F9, 0x0090 }, { 0x121E, 0x03CA }, + { 0x1233, 0x0352 }, { 0x1237, 0x00A0 }, { 0x123A, 0x0030 }, + { 0x1239, 0x0084 }, { 0x0301, 0x1000 }, { 0x1349, 0x001F }, + { 0x18E0, 0x4004 }, { 0x122B, 0x241C }, { 0x1305, 0xC000 }, + { 0x13F0, 0x0000 }, +}; + +static const struct rtl8365mb_jam_tbl_entry rtl8365mb_init_jam_common[] = { + { 0x1200, 0x7FCB }, { 0x0884, 0x0003 }, { 0x06EB, 0x0001 }, + { 0x03Fa, 0x0007 }, { 0x08C8, 0x00C0 }, { 0x0A30, 0x020E }, + { 0x0800, 0x0000 }, { 0x0802, 0x0000 }, { 0x09DA, 0x0013 }, + { 0x1D32, 0x0002 }, +}; + +enum rtl8365mb_stp_state { + RTL8365MB_STP_STATE_DISABLED = 0, + RTL8365MB_STP_STATE_BLOCKING = 1, + RTL8365MB_STP_STATE_LEARNING = 2, + RTL8365MB_STP_STATE_FORWARDING = 3, +}; + +enum rtl8365mb_cpu_insert { + RTL8365MB_CPU_INSERT_TO_ALL = 0, + RTL8365MB_CPU_INSERT_TO_TRAPPING = 1, + RTL8365MB_CPU_INSERT_TO_NONE = 2, +}; + +enum rtl8365mb_cpu_position { + RTL8365MB_CPU_POS_AFTER_SA = 0, + RTL8365MB_CPU_POS_BEFORE_CRC = 1, +}; + +enum rtl8365mb_cpu_format { + RTL8365MB_CPU_FORMAT_8BYTES = 0, + RTL8365MB_CPU_FORMAT_4BYTES = 1, +}; + +enum rtl8365mb_cpu_rxlen { + RTL8365MB_CPU_RXLEN_72BYTES = 0, + RTL8365MB_CPU_RXLEN_64BYTES = 1, +}; + +/** + * struct rtl8365mb_cpu - CPU port configuration + * @enable: enable/disable hardware insertion of CPU tag in switch->CPU frames + * @mask: port mask of ports that parse should parse CPU tags + * @trap_port: forward trapped frames to this port + * @insert: CPU tag insertion mode in switch->CPU frames + * @position: position of CPU tag in frame + * @rx_length: minimum CPU RX length + * @format: CPU tag format + * + * Represents the CPU tagging and CPU port configuration of the switch. These + * settings are configurable at runtime. + */ +struct rtl8365mb_cpu { + bool enable; + u32 mask; + u32 trap_port; + enum rtl8365mb_cpu_insert insert; + enum rtl8365mb_cpu_position position; + enum rtl8365mb_cpu_rxlen rx_length; + enum rtl8365mb_cpu_format format; +}; + +/** + * struct rtl8365mb - private chip-specific driver data + * @irq: registered IRQ or zero + * @chip_id: chip identifier + * @chip_ver: chip silicon revision + * @num_phys: number of integrated PHYs + * @port_mask: mask of all ports + * @phy_port_mask: mask of ports with integrated PHYs + * @learn_limit_max: maximum number of L2 addresses the chip can learn + * @cpu: CPU tagging and CPU port configuration for this chip + * @jam_table: chip-specific initialization jam table + * @jam_size: size of the chip's jam table + * + * Private data for this driver. + */ +struct rtl8365mb { + int irq; + u32 chip_id; + u32 chip_ver; + unsigned int num_phys; + u32 port_mask; + u32 phy_port_mask; + u32 learn_limit_max; + struct rtl8365mb_cpu cpu; + const struct rtl8365mb_jam_tbl_entry *jam_table; + size_t jam_size; +}; + +static int rtl8365mb_phy_poll_busy(struct realtek_smi *smi) +{ + u32 val; + + return regmap_read_poll_timeout(smi->map, + RTL8365MB_INDIRECT_ACCESS_STATUS_REG, + val, !val, 10, 100); +} + +static int rtl8365mb_phy_ocp_prepare(struct realtek_smi *smi, int phy, + u32 ocp_addr) +{ + u32 val; + int ret; + + /* Set OCP prefix */ + val = FIELD_GET(RTL8365MB_PHY_OCP_ADDR_PREFIX_MASK, ocp_addr); + ret = regmap_update_bits( + smi->map, RTL8365MB_GPHY_OCP_MSB_0_REG, + RTL8365MB_GPHY_OCP_MSB_0_CFG_CPU_OCPADR_MASK, + FIELD_PREP(RTL8365MB_GPHY_OCP_MSB_0_CFG_CPU_OCPADR_MASK, val)); + if (ret) + return ret; + + /* Set PHY register address */ + val = RTL8365MB_PHY_BASE; + val |= FIELD_PREP(RTL8365MB_INDIRECT_ACCESS_ADDRESS_PHYNUM_MASK, phy); + val |= FIELD_PREP(RTL8365MB_INDIRECT_ACCESS_ADDRESS_OCPADR_5_1_MASK, + ocp_addr >> 1); + val |= FIELD_PREP(RTL8365MB_INDIRECT_ACCESS_ADDRESS_OCPADR_9_6_MASK, + ocp_addr >> 6); + ret = regmap_write(smi->map, RTL8365MB_INDIRECT_ACCESS_ADDRESS_REG, + val); + if (ret) + return ret; + + return 0; +} + +static int rtl8365mb_phy_ocp_read(struct realtek_smi *smi, int phy, + u32 ocp_addr, u16 *data) +{ + u32 val; + int ret; + + ret = rtl8365mb_phy_poll_busy(smi); + if (ret) + return ret; + + ret = rtl8365mb_phy_ocp_prepare(smi, phy, ocp_addr); + if (ret) + return ret; + + /* Execute read operation */ + val = FIELD_PREP(RTL8365MB_INDIRECT_ACCESS_CTRL_CMD_MASK, + RTL8365MB_INDIRECT_ACCESS_CTRL_CMD_VALUE) | + FIELD_PREP(RTL8365MB_INDIRECT_ACCESS_CTRL_RW_MASK, + RTL8365MB_INDIRECT_ACCESS_CTRL_RW_READ); + ret = regmap_write(smi->map, RTL8365MB_INDIRECT_ACCESS_CTRL_REG, val); + if (ret) + return ret; + + ret = rtl8365mb_phy_poll_busy(smi); + if (ret) + return ret; + + /* Get PHY register data */ + ret = regmap_read(smi->map, RTL8365MB_INDIRECT_ACCESS_READ_DATA_REG, + &val); + if (ret) + return ret; + + *data = val & 0xFFFF; + + return 0; +} + +static int rtl8365mb_phy_ocp_write(struct realtek_smi *smi, int phy, + u32 ocp_addr, u16 data) +{ + u32 val; + int ret; + + ret = rtl8365mb_phy_poll_busy(smi); + if (ret) + return ret; + + ret = rtl8365mb_phy_ocp_prepare(smi, phy, ocp_addr); + if (ret) + return ret; + + /* Set PHY register data */ + ret = regmap_write(smi->map, RTL8365MB_INDIRECT_ACCESS_WRITE_DATA_REG, + data); + if (ret) + return ret; + + /* Execute write operation */ + val = FIELD_PREP(RTL8365MB_INDIRECT_ACCESS_CTRL_CMD_MASK, + RTL8365MB_INDIRECT_ACCESS_CTRL_CMD_VALUE) | + FIELD_PREP(RTL8365MB_INDIRECT_ACCESS_CTRL_RW_MASK, + RTL8365MB_INDIRECT_ACCESS_CTRL_RW_WRITE); + ret = regmap_write(smi->map, RTL8365MB_INDIRECT_ACCESS_CTRL_REG, val); + if (ret) + return ret; + + ret = rtl8365mb_phy_poll_busy(smi); + if (ret) + return ret; + + return 0; +} + +static int rtl8365mb_phy_read(struct realtek_smi *smi, int phy, int regnum) +{ + struct rtl8365mb *mb = smi->chip_data; + u32 ocp_addr; + u16 val; + int ret; + + if (phy >= mb->num_phys || regnum > RTL8365MB_PHYREGMAX) + return -EINVAL; + + ocp_addr = RTL8365MB_PHY_OCP_ADDR_PHYREG_BASE + regnum * 2; + + ret = rtl8365mb_phy_ocp_read(smi, phy, ocp_addr, &val); + if (ret) { + dev_err(smi->dev, + "failed to read PHY%d reg %02x @ %04x, ret %d\n", phy, + regnum, ocp_addr, ret); + return ret; + } + + dev_dbg(smi->dev, "read PHY%d register 0x%02x @ %04x, val <- %04x\n", + phy, regnum, ocp_addr, val); + + return val; +} + +static int rtl8365mb_phy_write(struct realtek_smi *smi, int phy, int regnum, + u16 val) +{ + struct rtl8365mb *mb = smi->chip_data; + u32 ocp_addr; + int ret; + + if (phy >= mb->num_phys || regnum > RTL8365MB_PHYREGMAX) + return -EINVAL; + + ocp_addr = RTL8365MB_PHY_OCP_ADDR_PHYREG_BASE + regnum * 2; + + ret = rtl8365mb_phy_ocp_write(smi, phy, ocp_addr, val); + if (ret) { + dev_err(smi->dev, + "failed to write PHY%d reg %02x @ %04x, ret %d\n", phy, + regnum, ocp_addr, ret); + return ret; + } + + dev_dbg(smi->dev, "write PHY%d register 0x%02x @ %04x, val -> %04x\n", + phy, regnum, ocp_addr, val); + + return 0; +} + +static enum dsa_tag_protocol +rtl8365mb_get_tag_protocol(struct dsa_switch *ds, int port, + enum dsa_tag_protocol mp) +{ + return DSA_TAG_PROTO_RTL8_4; +} + +static int rtl8365mb_ext_config_rgmii(struct realtek_smi *smi, int port, + phy_interface_t interface) +{ + int tx_delay = 0; + int rx_delay = 0; + int ext_port; + int ret; + + if (port == smi->cpu_port) { + ext_port = PORT_NUM_L2E(port); + } else { + dev_err(smi->dev, "only one EXT port is currently supported\n"); + return -EINVAL; + } + + /* Set the RGMII TX/RX delay + * + * The Realtek vendor driver indicates the following possible + * configuration settings: + * + * TX delay: + * 0 = no delay, 1 = 2 ns delay + * RX delay: + * 0 = no delay, 7 = maximum delay + * No units are specified, but there are a total of 8 steps. + * + * The vendor driver also states that this must be configured *before* + * forcing the external interface into a particular mode, which is done + * in the rtl8365mb_phylink_mac_link_{up,down} functions. + * + * NOTE: For now this is hardcoded to tx_delay = 1, rx_delay = 4. + */ + if (interface == PHY_INTERFACE_MODE_RGMII_ID || + interface == PHY_INTERFACE_MODE_RGMII_TXID) + tx_delay = 1; /* 2 ns */ + + if (interface == PHY_INTERFACE_MODE_RGMII_ID || + interface == PHY_INTERFACE_MODE_RGMII_RXID) + rx_delay = 4; + + ret = regmap_update_bits( + smi->map, RTL8365MB_EXT_RGMXF_REG(ext_port), + RTL8365MB_EXT_RGMXF_TXDELAY_MASK | + RTL8365MB_EXT_RGMXF_RXDELAY_MASK, + FIELD_PREP(RTL8365MB_EXT_RGMXF_TXDELAY_MASK, tx_delay) | + FIELD_PREP(RTL8365MB_EXT_RGMXF_RXDELAY_MASK, rx_delay)); + if (ret) + return ret; + + ret = regmap_update_bits( + smi->map, RTL8365MB_DIGITAL_INTERFACE_SELECT_REG(ext_port), + RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_MASK(ext_port), + RTL8365MB_EXT_PORT_MODE_RGMII + << RTL8365MB_DIGITAL_INTERFACE_SELECT_MODE_OFFSET( + ext_port)); + if (ret) + return ret; + + return 0; +} + +static int rtl8365mb_ext_config_forcemode(struct realtek_smi *smi, int port, + bool link, int speed, int duplex, + bool tx_pause, bool rx_pause) +{ + u32 r_tx_pause; + u32 r_rx_pause; + u32 r_duplex; + u32 r_speed; + u32 r_link; + int ext_port; + int val; + int ret; + + if (port == smi->cpu_port) { + ext_port = PORT_NUM_L2E(port); + } else { + dev_err(smi->dev, "only one EXT port is currently supported\n"); + return -EINVAL; + } + + if (link) { + /* Force the link up with the desired configuration */ + r_link = 1; + r_rx_pause = rx_pause ? 1 : 0; + r_tx_pause = tx_pause ? 1 : 0; + + if (speed == SPEED_1000) { + r_speed = RTL8365MB_PORT_SPEED_1000M; + } else if (speed == SPEED_100) { + r_speed = RTL8365MB_PORT_SPEED_100M; + } else if (speed == SPEED_10) { + r_speed = RTL8365MB_PORT_SPEED_10M; + } else { + dev_err(smi->dev, "unsupported port speed %s\n", + phy_speed_to_str(speed)); + return -EINVAL; + } + + if (duplex == DUPLEX_FULL) { + r_duplex = 1; + } else if (duplex == DUPLEX_HALF) { + r_duplex = 0; + } else { + dev_err(smi->dev, "unsupported duplex %s\n", + phy_duplex_to_str(duplex)); + return -EINVAL; + } + } else { + /* Force the link down and reset any programmed configuration */ + r_link = 0; + r_tx_pause = 0; + r_rx_pause = 0; + r_speed = 0; + r_duplex = 0; + } + + val = FIELD_PREP(RTL8365MB_DIGITAL_INTERFACE_FORCE_EN_MASK, 1) | + FIELD_PREP(RTL8365MB_DIGITAL_INTERFACE_FORCE_TXPAUSE_MASK, + r_tx_pause) | + FIELD_PREP(RTL8365MB_DIGITAL_INTERFACE_FORCE_RXPAUSE_MASK, + r_rx_pause) | + FIELD_PREP(RTL8365MB_DIGITAL_INTERFACE_FORCE_LINK_MASK, r_link) | + FIELD_PREP(RTL8365MB_DIGITAL_INTERFACE_FORCE_DUPLEX_MASK, + r_duplex) | + FIELD_PREP(RTL8365MB_DIGITAL_INTERFACE_FORCE_SPEED_MASK, r_speed); + ret = regmap_write(smi->map, + RTL8365MB_DIGITAL_INTERFACE_FORCE_REG(ext_port), + val); + if (ret) + return ret; + + return 0; +} + +static bool rtl8365mb_phy_mode_supported(struct dsa_switch *ds, int port, + phy_interface_t interface) +{ + if (dsa_is_user_port(ds, port) && + (interface == PHY_INTERFACE_MODE_NA || + interface == PHY_INTERFACE_MODE_INTERNAL)) + /* Internal PHY */ + return true; + else if (dsa_is_cpu_port(ds, port) && + phy_interface_mode_is_rgmii(interface)) + /* Extension MAC */ + return true; + + return false; +} + +static void rtl8365mb_phylink_validate(struct dsa_switch *ds, int port, + unsigned long *supported, + struct phylink_link_state *state) +{ + struct realtek_smi *smi = ds->priv; + __ETHTOOL_DECLARE_LINK_MODE_MASK(mask) = { 0 }; + + /* include/linux/phylink.h says: + * When @state->interface is %PHY_INTERFACE_MODE_NA, phylink + * expects the MAC driver to return all supported link modes. + */ + if (state->interface != PHY_INTERFACE_MODE_NA && + !rtl8365mb_phy_mode_supported(ds, port, state->interface)) { + dev_err(smi->dev, "phy mode %s is unsupported on port %d\n", + phy_modes(state->interface), port); + linkmode_zero(supported); + return; + } + + phylink_set_port_modes(mask); + + phylink_set(mask, Autoneg); + phylink_set(mask, Pause); + phylink_set(mask, Asym_Pause); + + phylink_set(mask, 10baseT_Half); + phylink_set(mask, 10baseT_Full); + phylink_set(mask, 100baseT_Half); + phylink_set(mask, 100baseT_Full); + phylink_set(mask, 1000baseT_Full); + + linkmode_and(supported, supported, mask); + linkmode_and(state->advertising, state->advertising, mask); +} + +static void rtl8365mb_phylink_mac_config(struct dsa_switch *ds, int port, + unsigned int mode, + const struct phylink_link_state *state) +{ + struct realtek_smi *smi = ds->priv; + int ret; + + if (!rtl8365mb_phy_mode_supported(ds, port, state->interface)) { + dev_err(smi->dev, "phy mode %s is unsupported on port %d\n", + phy_modes(state->interface), port); + return; + } + + /* If port MAC is connected to an internal PHY, we have nothing to do */ + if (dsa_is_user_port(ds, port)) + return; + + if (mode != MLO_AN_PHY && mode != MLO_AN_FIXED) { + dev_err(smi->dev, + "port %d supports only conventional PHY or fixed-link\n", + port); + return; + } + + if (phy_interface_mode_is_rgmii(state->interface)) { + ret = rtl8365mb_ext_config_rgmii(smi, port, state->interface); + if (ret) + dev_err(smi->dev, + "failed to configure RGMII mode on port %d: %d\n", + port, ret); + return; + } + + /* TODO: Implement MII and RMII modes, which the RTL8365MB-VC also + * supports + */ +} + +static void rtl8365mb_phylink_mac_link_down(struct dsa_switch *ds, int port, + unsigned int mode, + phy_interface_t interface) +{ + struct realtek_smi *smi = ds->priv; + int ret; + + if (dsa_is_cpu_port(ds, port)) { + ret = rtl8365mb_ext_config_forcemode(smi, port, false, 0, 0, + false, false); + if (ret) + dev_err(smi->dev, + "failed to reset forced mode on port %d: %d\n", + port, ret); + + return; + } +} + +static void rtl8365mb_phylink_mac_link_up(struct dsa_switch *ds, int port, + unsigned int mode, + phy_interface_t interface, + struct phy_device *phydev, int speed, + int duplex, bool tx_pause, + bool rx_pause) +{ + struct realtek_smi *smi = ds->priv; + int ret; + + if (dsa_is_cpu_port(ds, port)) { + ret = rtl8365mb_ext_config_forcemode(smi, port, true, speed, + duplex, tx_pause, + rx_pause); + if (ret) + dev_err(smi->dev, + "failed to force mode on port %d: %d\n", port, + ret); + + return; + } +} + +static void rtl8365mb_port_stp_state_set(struct dsa_switch *ds, int port, + u8 state) +{ + struct realtek_smi *smi = ds->priv; + u32 phys_port = PORT_NUM_L2P(port); + enum rtl8365mb_stp_state val; + int msti = 0; + + switch (state) { + case BR_STATE_DISABLED: + val = RTL8365MB_STP_STATE_DISABLED; + break; + case BR_STATE_BLOCKING: + case BR_STATE_LISTENING: + val = RTL8365MB_STP_STATE_BLOCKING; + break; + case BR_STATE_LEARNING: + val = RTL8365MB_STP_STATE_LEARNING; + break; + case BR_STATE_FORWARDING: + val = RTL8365MB_STP_STATE_FORWARDING; + break; + default: + dev_err(smi->dev, "invalid STP state: %u\n", state); + return; + } + + regmap_update_bits(smi->map, RTL8365MB_MSTI_CTRL_REG(msti, phys_port), + RTL8365MB_MSTI_CTRL_PORT_STATE_MASK(phys_port), + val << RTL8365MB_MSTI_CTRL_PORT_STATE_OFFSET( + phys_port)); +} + +static int rtl8365mb_port_set_learning(struct realtek_smi *smi, int port, + bool enable) +{ + struct rtl8365mb *mb = smi->chip_data; + u32 phys_port = PORT_NUM_L2P(port); + + /* Enable/disable learning by limiting the number of L2 addresses the + * port can learn. Realtek documentation states that a limit of zero + * disables learning. When enabling learning, set it to the chip's + * maximum. + */ + return regmap_write(smi->map, + RTL8365MB_LUT_PORT_LEARN_LIMIT_REG(phys_port), + enable ? mb->learn_limit_max : 0); +} + +static int rtl8365mb_port_set_isolation(struct realtek_smi *smi, int port, + u32 mask) +{ + u32 phys_mask = PORT_MASK_L2P(mask); + u32 phys_port = PORT_NUM_L2P(port); + + return regmap_write(smi->map, RTL8365MB_PORT_ISOLATION_REG(phys_port), + phys_mask); +} + +static int rtl8365mb_get_mib_counter(struct realtek_smi *smi, int port, + struct rtl8366_mib_counter *mib, + u64 *mibvalue) +{ + int phys_port = PORT_NUM_L2P(port); + u32 offset; + u32 val; + int ret; + int i; + + /* The MIB address is an SRAM address. We request a particular address + * and then poll the control register before reading the value from some + * counter registers. + */ + ret = regmap_write(smi->map, RTL8365MB_MIB_ADDRESS_REG, + RTL8365MB_MIB_ADDRESS(phys_port, mib->offset)); + if (ret) + return ret; + + /* Poll for completion */ + ret = regmap_read_poll_timeout(smi->map, RTL8365MB_MIB_CTRL0_REG, val, + !(val & RTL8365MB_MIB_CTRL0_BUSY_MASK), + 10, 100); + if (ret) + return ret; + + /* Presumably this indicates a MIB counter read failure */ + if (val & RTL8365MB_MIB_CTRL0_RESET_MASK) + return -EIO; + + /* There are four MIB counter registers each holding a 16 bit word of a + * MIB counter. Depending on the offset, we should read from the upper + * two or lower two registers. In case the MIB counter is 4 words, we + * read from all four registers. + */ + if (mib->length == 4) + offset = 3; + else + offset = (mib->offset + 1) % 4; + + /* Read the MIB counter 16 bits at a time */ + *mibvalue = 0; + for (i = 0; i < mib->length; i++) { + ret = regmap_read(smi->map, + RTL8365MB_MIB_COUNTER_REG(offset - i), &val); + if (ret) + return ret; + + *mibvalue = ((*mibvalue) << 16) | (val & 0xFFFF); + } + + return 0; +} + +static int rtl8365mb_get_and_clear_status_reg(struct realtek_smi *smi, u32 reg, + u32 *val) +{ + int ret; + + ret = regmap_read(smi->map, reg, val); + if (ret) + return ret; + + return regmap_write(smi->map, reg, *val); +} + +static irqreturn_t rtl8365mb_irq(int irq, void *data) +{ + struct realtek_smi *smi = data; + struct rtl8365mb *mb; + u32 line_changes = 0; + u32 linkdown_ind; + u32 linkup_ind; + u32 stat; + u32 val; + int ret; + + mb = smi->chip_data; + + ret = rtl8365mb_get_and_clear_status_reg(smi, RTL8365MB_INTR_STATUS_REG, + &stat); + if (ret) + goto out_error; + + if (stat & RTL8365MB_INTR_LINK_CHANGE_MASK) { + ret = rtl8365mb_get_and_clear_status_reg( + smi, RTL8365MB_PORT_LINKUP_IND_REG, &val); + if (ret) + goto out_error; + + linkup_ind = FIELD_GET(RTL8365MB_PORT_LINKUP_IND_MASK, val); + + ret = rtl8365mb_get_and_clear_status_reg( + smi, RTL8365MB_PORT_LINKDOWN_IND_REG, &val); + if (ret) + goto out_error; + + linkdown_ind = FIELD_GET(RTL8365MB_PORT_LINKDOWN_IND_MASK, val); + + line_changes = PORT_MASK_P2L(linkup_ind | linkdown_ind) & + mb->phy_port_mask; + } + + if (!line_changes) + goto out_none; + + while (line_changes) { + int line = __ffs(line_changes); + int child_irq; + + line_changes &= ~BIT(line); + + child_irq = irq_find_mapping(smi->irqdomain, line); + handle_nested_irq(child_irq); + } + + return IRQ_HANDLED; + +out_error: + dev_err(smi->dev, "failed to read interrupt status: %d\n", ret); + +out_none: + return IRQ_NONE; +} + +static struct irq_chip rtl8365mb_irq_chip = { + .name = "rtl8365mb", + /* The hardware doesn't support masking IRQs on a per-port basis */ +}; + +static int rtl8365mb_irq_map(struct irq_domain *domain, unsigned int irq, + irq_hw_number_t hwirq) +{ + irq_set_chip_data(irq, domain->host_data); + irq_set_chip_and_handler(irq, &rtl8365mb_irq_chip, handle_simple_irq); + irq_set_nested_thread(irq, 1); + irq_set_noprobe(irq); + + return 0; +} + +static void rtl8365mb_irq_unmap(struct irq_domain *d, unsigned int irq) +{ + irq_set_nested_thread(irq, 0); + irq_set_chip_and_handler(irq, NULL, NULL); + irq_set_chip_data(irq, NULL); +} + +static const struct irq_domain_ops rtl8365mb_irqdomain_ops = { + .map = rtl8365mb_irq_map, + .unmap = rtl8365mb_irq_unmap, + .xlate = irq_domain_xlate_onecell, +}; + +static int _rtl8365mb_irq_enable(struct realtek_smi *smi, bool enable) +{ + return regmap_update_bits(smi->map, RTL8365MB_INTR_CTRL_REG, + RTL8365MB_INTR_LINK_CHANGE_MASK, + FIELD_PREP(RTL8365MB_INTR_LINK_CHANGE_MASK, + enable ? 1 : 0)); +} + +static int rtl8365mb_irq_enable(struct realtek_smi *smi) +{ + return _rtl8365mb_irq_enable(smi, true); +} + +static int rtl8365mb_irq_disable(struct realtek_smi *smi) +{ + return _rtl8365mb_irq_enable(smi, false); +} + +static int rtl8365mb_irq_setup(struct realtek_smi *smi) +{ + struct rtl8365mb *mb = smi->chip_data; + struct device_node *intc; + u32 irq_trig; + int virq; + int irq; + u32 val; + int ret; + int i; + + intc = of_get_child_by_name(smi->dev->of_node, "interrupt-controller"); + if (!intc) { + dev_err(smi->dev, "missing child interrupt-controller node\n"); + return -EINVAL; + } + + smi->irqdomain = irq_domain_add_linear(intc, mb->num_phys, + &rtl8365mb_irqdomain_ops, smi); + if (!smi->irqdomain) { + dev_err(smi->dev, "failed to add irq domain\n"); + ret = -ENOMEM; + goto out_put_node; + } + + for (i = 0; i < mb->num_phys; i++) { + virq = irq_create_mapping(smi->irqdomain, i); + if (!virq) { + dev_err(smi->dev, + "failed to create irq domain mapping\n"); + ret = -EINVAL; + goto out_remove_irqdomain; + } + + irq_set_parent(virq, irq); + } + + /* rtl8365mb IRQs cascade off this one */ + irq = of_irq_get(intc, 0); + if (irq <= 0) { + if (irq != -EPROBE_DEFER) + dev_err(smi->dev, "failed to get parent irq: %d\n", + irq); + ret = irq ? irq : -EINVAL; + goto out_remove_irqdomain; + } + + /* Configure chip interrupt signal polarity */ + irq_trig = irqd_get_trigger_type(irq_get_irq_data(irq)); + switch (irq_trig) { + case IRQF_TRIGGER_RISING: + case IRQF_TRIGGER_HIGH: + val = RTL8365MB_INTR_POLARITY_HIGH; + break; + case IRQF_TRIGGER_FALLING: + case IRQF_TRIGGER_LOW: + val = RTL8365MB_INTR_POLARITY_LOW; + break; + default: + dev_err(smi->dev, "unsupported irq trigger type %u\n", + irq_trig); + ret = -EINVAL; + goto out_remove_irqdomain; + } + + ret = regmap_update_bits(smi->map, RTL8365MB_INTR_POLARITY_REG, + RTL8365MB_INTR_POLARITY_MASK, + FIELD_PREP(RTL8365MB_INTR_POLARITY_MASK, val)); + if (ret) + goto out_remove_irqdomain; + + /* Disable the interrupt in case the chip has it enabled on reset */ + ret = rtl8365mb_irq_disable(smi); + if (ret) + goto out_remove_irqdomain; + + /* Clear the interrupt status register */ + ret = regmap_write(smi->map, RTL8365MB_INTR_STATUS_REG, + RTL8365MB_INTR_ALL_MASK); + if (ret) + goto out_remove_irqdomain; + + ret = request_threaded_irq(irq, NULL, rtl8365mb_irq, IRQF_ONESHOT, + "rtl8365mb", smi); + if (ret) { + dev_err(smi->dev, "failed to request irq: %d\n", ret); + goto out_remove_irqdomain; + } + + /* Store the irq so that we know to free it during teardown */ + mb->irq = irq; + + ret = rtl8365mb_irq_enable(smi); + if (ret) + goto out_free_irq; + + of_node_put(intc); + + return 0; + +out_free_irq: + free_irq(mb->irq, smi); + mb->irq = 0; + +out_remove_irqdomain: + for (i = 0; i < mb->num_phys; i++) { + virq = irq_find_mapping(smi->irqdomain, i); + irq_dispose_mapping(virq); + } + + irq_domain_remove(smi->irqdomain); + smi->irqdomain = NULL; + +out_put_node: + of_node_put(intc); + + return ret; +} + +static void rtl8365mb_irq_teardown(struct realtek_smi *smi) +{ + struct rtl8365mb *mb = smi->chip_data; + int virq; + int i; + + if (mb->irq) { + free_irq(mb->irq, smi); + mb->irq = 0; + } + + if (smi->irqdomain) { + for (i = 0; i < mb->num_phys; i++) { + virq = irq_find_mapping(smi->irqdomain, i); + irq_dispose_mapping(virq); + } + + irq_domain_remove(smi->irqdomain); + smi->irqdomain = NULL; + } +} + +static int rtl8365mb_cpu_config(struct realtek_smi *smi) +{ + struct rtl8365mb *mb = smi->chip_data; + struct rtl8365mb_cpu *cpu = &mb->cpu; + u32 phys_mask; + u32 phys_trap_port; + u32 val; + int ret; + + phys_mask = PORT_MASK_L2P(cpu->mask); + phys_trap_port = PORT_NUM_L2P(cpu->trap_port); + + ret = regmap_update_bits(smi->map, RTL8365MB_CPU_PORT_MASK_REG, + RTL8365MB_CPU_PORT_MASK_MASK, + FIELD_PREP(RTL8365MB_CPU_PORT_MASK_MASK, + phys_mask)); + if (ret) + return ret; + + val = FIELD_PREP(RTL8365MB_CPU_CTRL_EN_MASK, cpu->enable ? 1 : 0) | + FIELD_PREP(RTL8365MB_CPU_CTRL_INSERTMODE_MASK, cpu->insert) | + FIELD_PREP(RTL8365MB_CPU_CTRL_TAG_POSITION_MASK, cpu->position) | + FIELD_PREP(RTL8365MB_CPU_CTRL_RXBYTECOUNT_MASK, cpu->rx_length) | + FIELD_PREP(RTL8365MB_CPU_CTRL_TAG_FORMAT_MASK, cpu->format) | + FIELD_PREP(RTL8365MB_CPU_CTRL_TRAP_PORT_MASK, phys_trap_port) | + FIELD_PREP(RTL8365MB_CPU_CTRL_TRAP_PORT_EXT_MASK, + phys_trap_port >> 3); + ret = regmap_write(smi->map, RTL8365MB_CPU_CTRL_REG, val); + if (ret) + return ret; + + return 0; +} + +static int rtl8365mb_switch_init(struct realtek_smi *smi) +{ + struct rtl8365mb *mb = smi->chip_data; + int ret; + int i; + + /* Do any chip-specific init jam before getting to the common stuff */ + if (mb->jam_table) { + for (i = 0; i < mb->jam_size; i++) { + ret = regmap_write(smi->map, mb->jam_table[i].reg, + mb->jam_table[i].val); + if (ret) + return ret; + } + } + + /* Common init jam */ + for (i = 0; i < ARRAY_SIZE(rtl8365mb_init_jam_common); i++) { + ret = regmap_write(smi->map, rtl8365mb_init_jam_common[i].reg, + rtl8365mb_init_jam_common[i].val); + if (ret) + return ret; + } + + return 0; +} + +static int rtl8365mb_reset_chip(struct realtek_smi *smi) +{ + u32 val; + + realtek_smi_write_reg_noack(smi, RTL8365MB_CHIP_RESET_REG, + FIELD_PREP(RTL8365MB_CHIP_RESET_HW_MASK, + 1)); + + /* Realtek documentation says the chip needs 1 second to reset. Sleep + * for 100 ms before accessing any registers to prevent ACK timeouts. + */ + msleep(100); + return regmap_read_poll_timeout(smi->map, RTL8365MB_CHIP_RESET_REG, val, + !(val & RTL8365MB_CHIP_RESET_HW_MASK), + 20000, 1e6); +} + +static int rtl8365mb_setup(struct dsa_switch *ds) +{ + struct realtek_smi *smi = ds->priv; + struct rtl8365mb *mb; + int ret; + int i; + + mb = smi->chip_data; + + ret = rtl8365mb_reset_chip(smi); + if (ret) { + dev_err(smi->dev, "failed to reset chip: %d\n", ret); + return ret; + } + + /* Configure switch to vendor-defined initial state */ + ret = rtl8365mb_switch_init(smi); + if (ret) { + dev_err(smi->dev, "failed to initialize switch: %d\n", ret); + return ret; + } + + /* Configure CPU tagging */ + ret = rtl8365mb_cpu_config(smi); + if (ret) + return ret; + + /* Configure ports in standalone mode */ + for (i = 0; i < smi->num_ports; i++) { + /* Forward only to the CPU */ + ret = rtl8365mb_port_set_isolation(smi, i, BIT(smi->cpu_port)); + if (ret) + return ret; + + /* Disable learning */ + ret = rtl8365mb_port_set_learning(smi, i, false); + if (ret) + return ret; + + /* Set the initial STP state of all ports to DISABLED, otherwise + * ports will still forward frames to the CPU despite being + * administratively down by default. + */ + rtl8365mb_port_stp_state_set(smi->ds, i, BR_STATE_DISABLED); + } + + /* Set maximum packet length to 1536 bytes */ + ret = regmap_update_bits(smi->map, RTL8365MB_CFG0_MAX_LEN_REG, + RTL8365MB_CFG0_MAX_LEN_MASK, + FIELD_PREP(RTL8365MB_CFG0_MAX_LEN_MASK, 1536)); + if (ret) + return ret; + + /* Set up cascading IRQs */ + ret = rtl8365mb_irq_setup(smi); + if (ret == -EPROBE_DEFER) + return ret; + else if (ret) + dev_info(smi->dev, "no interrupt support\n"); + + ret = realtek_smi_setup_mdio(smi); + if (ret) { + dev_err(smi->dev, "could not set up MDIO bus\n"); + return -ENODEV; + } + + return ret; +} + +static void rtl8365mb_teardown(struct dsa_switch *ds) +{ + struct realtek_smi *smi = ds->priv; + + rtl8365mb_irq_teardown(smi); +} + +static int rtl8365mb_get_chip_id_and_ver(struct regmap *map, u32 *id, u32 *ver) +{ + int ret; + + /* For some reason we have to write a magic value to an arbitrary + * register whenever accessing the chip ID/version registers. + */ + ret = regmap_write(map, RTL8365MB_MAGIC_REG, RTL8365MB_MAGIC_VALUE); + if (ret) + return ret; + + ret = regmap_read(map, RTL8365MB_CHIP_ID_REG, id); + if (ret) + return ret; + + ret = regmap_read(map, RTL8365MB_CHIP_VER_REG, ver); + if (ret) + return ret; + + /* Reset magic register */ + ret = regmap_write(map, RTL8365MB_MAGIC_REG, 0); + if (ret) + return ret; + + return 0; +} + +static int rtl8365mb_detect(struct realtek_smi *smi) +{ + struct rtl8365mb *mb = smi->chip_data; + u32 chip_id; + u32 chip_ver; + int ret; + + ret = rtl8365mb_get_chip_id_and_ver(smi->map, &chip_id, &chip_ver); + if (ret) { + dev_err(smi->dev, "failed to read chip id and version: %d\n", + ret); + return ret; + } + + switch (chip_id) { + case RTL8365MB_CHIP_ID_8365MB_VC: + dev_info(smi->dev, + "found an RTL8365MB-VC switch (ver=0x%04x)\n", + chip_ver); + + smi->cpu_port = RTL8365MB_CPU_PORT_NUM_8365MB_VC; + smi->num_ports = RTL8365MB_NUM_PORTS_8365MB_VC; + smi->mib_counters = rtl8365mb_mib_counters; + smi->num_mib_counters = ARRAY_SIZE(rtl8365mb_mib_counters); + + mb->chip_id = chip_id; + mb->chip_ver = chip_ver; + mb->num_phys = RTL8365MB_NUM_PHYS_8365MB_VC; + mb->port_mask = RTL8365MB_PORT_MASK_8365MB_VC; + mb->phy_port_mask = RTL8365MB_PHY_PORT_MASK_8365MB_VC; + mb->learn_limit_max = RTL8365MB_LEARN_LIMIT_MAX_8365MB_VC; + mb->jam_table = rtl8365mb_init_jam_8365mb_vc; + mb->jam_size = ARRAY_SIZE(rtl8365mb_init_jam_8365mb_vc); + + mb->cpu.enable = 1; + mb->cpu.mask = BIT(smi->cpu_port); + mb->cpu.trap_port = smi->cpu_port; + mb->cpu.insert = RTL8365MB_CPU_INSERT_TO_ALL; + mb->cpu.position = RTL8365MB_CPU_POS_AFTER_SA; + mb->cpu.rx_length = RTL8365MB_CPU_RXLEN_64BYTES; + mb->cpu.format = RTL8365MB_CPU_FORMAT_8BYTES; + + break; + default: + dev_err(smi->dev, + "found an unknown Realtek switch (id=0x%04x, ver=0x%04x)\n", + chip_id, chip_ver); + return -ENODEV; + } + + return 0; +} + +static const struct dsa_switch_ops rtl8365mb_switch_ops = { + .get_tag_protocol = rtl8365mb_get_tag_protocol, + .setup = rtl8365mb_setup, + .teardown = rtl8365mb_teardown, + .phylink_validate = rtl8365mb_phylink_validate, + .phylink_mac_config = rtl8365mb_phylink_mac_config, + .phylink_mac_link_down = rtl8365mb_phylink_mac_link_down, + .phylink_mac_link_up = rtl8365mb_phylink_mac_link_up, + .port_stp_state_set = rtl8365mb_port_stp_state_set, + .get_strings = rtl8366_get_strings, + .get_ethtool_stats = rtl8366_get_ethtool_stats, + .get_sset_count = rtl8366_get_sset_count, +}; + +static const struct realtek_smi_ops rtl8365mb_smi_ops = { + .detect = rtl8365mb_detect, + .get_mib_counter = rtl8365mb_get_mib_counter, + .phy_read = rtl8365mb_phy_read, + .phy_write = rtl8365mb_phy_write, +}; + +const struct realtek_smi_variant rtl8365mb_variant = { + .ds_ops = &rtl8365mb_switch_ops, + .ops = &rtl8365mb_smi_ops, + .clk_delay = 10, + .cmd_read = 0xb9, + .cmd_write = 0xb8, + .chip_data_sz = sizeof(struct rtl8365mb), +}; +EXPORT_SYMBOL_GPL(rtl8365mb_variant);