NXP i.MX NETC switch DSA driver #82307

yangbolu1991 · 2024-11-29T02:44:44Z

NXP i.MX NETC is a TSN capable Ethernet IP. It may support
ENETC MACs, or/and multiple ports switch.

The ENETC MAC was handled by eth_nxp_imx_netc driver.
This DSA driver is to support NETC switch device.
Current driver supports DSA with limitation that only switch
function is available without management via DSA master port.
DSA master port support is TODO work.

Take i.MX RT1180 NETC hardware as an example.

The PR also reworked dsa sample for flexibility and extensibility.
Current DSA sample is initially for ip_k66f board with a switch PHY,
while it is expected as a common DSA sample for all DSA devices.
This PR only reworks the sample
with new added CONFIG_NET_SAMPLE_DSA_LLDP for ip_k66f with 3 LAN
ports.
Ideally this should be common for all DSA devices, but for now, ip_k66f
is the only platform supporting it.
As there will be more DSA functions supported, better to allow each
function enablement via option to suit hardware or device driver support
status.

Dependency:

mcux-sdk: drivers: netc: include switch driver in build hal_nxp#480

For dsa sample built for RT1180, the exported 4 switch ports worked as switch with MAC learning.
hotplug cable will have information in the console. Here is the sample log.

00:00:00.052,000] <inf> phy_mii: PHY (3) ID 1CC816
[00:00:00.102,000] <inf> phy_mii: PHY (2) ID 1CC816
[00:00:00.141,000] <inf> dsa_netc: DSA slave port 0 Link down
[00:00:00.141,000] <inf> dsa_netc: DSA slave port 1 Link down
[00:00:00.141,000] <inf> dsa_netc: DSA slave port 2 Link down
[00:00:00.141,000] <inf> dsa_netc: DSA slave port 3 Link down
[00:00:00.141,000] <inf> nxp_imx_eth_psi: ENETC0 MAC: 00:00:00:01:02:00
[00:00:00.141,000] <inf> nxp_imx_eth_psi: ENETC0 Link down
[00:00:00.141,000] <inf> nxp_imx_eth_psi: ENETC1 MAC: 00:00:00:01:03:00
*** Booting Zephyr OS build v4.0.0-1799-gf6f1487ec520 ***
[00:00:00.143,000] <inf> net_dsa_sample: Slave interface 0 found.
[00:00:00.143,000] <inf> net_dsa_sample: Slave interface 1 found.
[00:00:00.143,000] <inf> net_dsa_sample: Slave interface 2 found.
[00:00:00.143,000] <inf> net_dsa_sample: Slave interface 3 found.
[00:00:00.143,000] <inf> net_dsa_sample: Slave interface 4 found.
[00:00:00.143,000] <inf> net_dsa_sample: DSA ports init - OK
[00:00:02.113,000] <inf> phy_rt_rtl8211f: PHY 4 is up
[00:00:02.113,000] <inf> phy_rt_rtl8211f: PHY (4) Link speed 1000 Mb, full duplex
[00:00:02.113,000] <inf> dsa_netc: DSA slave port 2 Link up
[00:00:02.624,000] <inf> phy_rt_rtl8211f: PHY 5 is up
[00:00:02.624,000] <inf> phy_rt_rtl8211f: PHY (5) Link speed 1000 Mb, full duplex
[00:00:02.624,000] <inf> dsa_netc: DSA slave port 1 Link up
uart:~$
uart:~$
uart:~$
uart:~$
uart:~$
[00:00:16.616,000] <inf> phy_rt_rtl8211f: PHY 4 is down
[00:00:16.616,000] <inf> dsa_netc: DSA slave port 2 Link down
uart:~$
uart:~$
[00:00:29.211,000] <inf> phy_mii: PHY (2) Link speed 100 Mb, full duplex
[00:00:29.211,000] <inf> dsa_netc: DSA slave port 0 Link up
uart:~$

Thanks.

zephyrbot · 2024-11-29T02:45:46Z

The following west manifest projects have changed revision in this Pull Request:

Name	Old Revision	New Revision	Diff

✅ All manifest checks OK

Note: This message is automatically posted and updated by the Manifest GitHub Action.

danieldegrasse · 2024-12-03T20:11:28Z

drivers/ethernet/eth_nxp_imx_netc.c

Just making sure I understand this- will all instances of this IP with an internal PHY support DSA? Or are these functions unrelated?

This eth_nxp_imx_netc.c driver is for normal ENETC MAC of NETC. There may be several instances designed for external usage. For example, i.MX95, there are 3 ENETC MACs externally but without switch IP in NETC.

For SoC like i.MX RT1180, there are 5 ports switch IP in NETC together with 2 ENETC MACs. So, it's designed that one ENETC MAC will connect to one switch MAC inside SoC for DSA management. The MACs connected inside SoC is called pseudo MAC in reference manual. Outside the SoC, we could see 4 switch ports and one normal eth port.
Thanks.

danieldegrasse · 2024-12-03T20:13:14Z

drivers/ethernet/Kconfig.nxp_imx_netc

Should this driver Kconfig select DSA support, or should the DSA_NXP_IMX_NETC Kconfig select it?

Good question. I think it makes sense to rework this.

config ETH_DSA_SUPPORT bool help Set by an ethernet driver that supports DSA. menuconfig NET_DSA bool "Distributed Switch Architecture support" depends on ETH_DSA_SUPPORT help Enable Distributed Switch Architecture support. For now it only supports Kinetics and STM32 ENET drivers.

NET_DSA should select ETH_DSA_SUPPORT. Then this is handle in common NET option, and device driver no longer needs to handle. Also it's possible eth device driver supports DSA master mode without any code wrappered with ETH_DSA_SUPPORT.

./drivers/ethernet/Kconfig.sam_gmac: select ETH_DSA_SUPPORT ./drivers/ethernet/nxp_enet/Kconfig: select ETH_DSA_SUPPORT ./drivers/ethernet/nxp_enet/Kconfig: select ETH_DSA_SUPPORT ./drivers/ethernet/Kconfig.stm32_hal: select ETH_DSA_SUPPORT

Thanks.

Yes, it makes sense to set the NET_DSA in config and then let other parts of the system either depend on it (recommended) or select it.

Should this driver Kconfig select DSA support, or should the DSA_NXP_IMX_NETC Kconfig select it?

This driver is supposed to set it, not the DSA driver, it's for indicating the master port driver was implemented to have the DSA wrapper as the send function and registering the master tx function. I think the kconfig is poorly documented and as @yangbolu1991 points out it would be ideal to not need to add DSA support for the cpu side drivers . But I think we should not be removing this config in this PR and definitely without further solution because for now it's true that only some of the drivers have implemented support for the DSA architecture

drivers/ethernet/dsa_nxp_imx_netc.c

danieldegrasse · 2024-12-03T20:17:19Z

samples/net/dsa/src/main.h

Could we instead make this a Kconfig?

Yes. That's better. I will do. Or we define max number with 10 for Kconfig? This may cover most cases in the future.
Thanks.

danieldegrasse · 2024-12-03T20:17:48Z

samples/net/dsa/prj.conf

Maybe these should be set by a board overlay for the RT1180? I doubt many boards are this capable as a switch, right?

Different boards with different ethernet port number. This number here is not just for switch ports. There may be also other normal ethernet ports. For RT1180, there are 4 switch ports + 1 normal eth port.
If max number 10 is accepted here, I think future boards no longer define in board overlay. 10 should be enough for most boards.
Thanks.

This looks like an overkill. The IPv4 and IPv6 structs take up lot of space so we should avoid allocating them just in case. You can add these settings to board overlay if you need more than default.

danieldegrasse · 2024-12-03T20:20:35Z

west.yml

Commit with HAL changes should be first in this PR- also please update the commit message to be more clear- something like:

west.yml: update hal_nxp to include DSA switch driver

Okay. Thanks.

jukkar · 2024-12-09T08:19:23Z

drivers/ethernet/Kconfig.nxp_imx_netc

Yes, it makes sense to set the NET_DSA in config and then let other parts of the system either depend on it (recommended) or select it.

jukkar · 2024-12-09T08:22:44Z

drivers/ethernet/dsa_nxp_imx_netc.h

I recommend putting () around this complex macro in order to avoid possible weird issues when the macro is expanded.

Okay, thanks.

jukkar · 2024-12-09T08:22:52Z

drivers/ethernet/dsa_nxp_imx_netc.h

Okay, thanks.

jukkar · 2024-12-09T08:26:39Z

samples/net/dsa/prj.conf

This looks like an overkill. The IPv4 and IPv6 structs take up lot of space so we should avoid allocating them just in case. You can add these settings to board overlay if you need more than default.

Added NETC switch node. Signed-off-by: Yangbo Lu <[email protected]>

Added pinctrl for NETC switch ports. Signed-off-by: Yangbo Lu <[email protected]>

Moved netc node from m33 dts to common dtsi. ENETC PSI0 kept disabled for M7 for now. Signed-off-by: Yangbo Lu <[email protected]>

Enabled switch ports in dts. Signed-off-by: Yangbo Lu <[email protected]>

Added board init for switch ports. Signed-off-by: Yangbo Lu <[email protected]>

Documented the NETC DSA support. Signed-off-by: Yangbo Lu <[email protected]>

The multiple ports DSA device may have some ports disabled in dts. This should be handled in the sample. Signed-off-by: Yangbo Lu <[email protected]>

yangbolu1991 · 2025-02-05T08:14:33Z

Updated to v8. Changes include,

Converted to use "nxp,netc-switch" compatible.
Converted to use "ethernet" for switch port to describe connection instead of "dsa-master-port".
included ethernet-controller.yaml in nxp,netc-switch.yaml for reusing.

Thanks a lot.

dts/bindings/dsa/nxp,netc-switch.yaml

netc-switch binding name addressed

decsny · 2025-02-10T23:10:13Z

@jukkar @rlubos please help visit this PR before 4.1 feature freeze

jukkar · 2025-02-11T07:01:11Z

samples/net/dsa/src/dsa_lldp.c

+	 * check_ll_ether_addr table
+	 */
+	if (check_ll_ether_addr(lladst.addr, &eth_filter_l2_addr_base[0][0])) {
+		return 1;


Please do not return "plain" values here and in the final return, but either NET_OK, NET_CONTINUE or NET_DROP

jukkar · 2025-02-11T07:03:26Z

samples/net/dsa/src/dsa_lldp.c

 	struct sockaddr_ll dst;
 	struct ethernet_context *ctx = net_if_l2_data(iface);
-	struct net_eth_hdr *eth_hdr = (struct net_eth_hdr *) buffer;
+	struct net_eth_hdr *eth_hdr = (struct net_eth_hdr *)buffer;


Could you place the cosmetic changes in this file to a separate commit?

Sure. Thanks.

jukkar · 2025-02-11T07:07:01Z

samples/net/dsa/boards/ip_k66f.conf

+CONFIG_NET_CONFIG_MY_IPV4_ADDR="192.168.0.2"
+CONFIG_NET_CONFIG_MY_IPV4_GW="192.168.0.1"


Please use the documentation IPv4 address space here so 192.0.2.2 and 192.0.2.1

Fixed style problem for dsa_lldp.c with clang-format. Signed-off-by: Yangbo Lu <[email protected]>

Current DSA sample is initially for ip_k66f board with a switch PHY, while it is expected as a common DSA sample for all DSA devices. This patch does not change any function. It only reworks the sample with new added CONFIG_NET_SAMPLE_DSA_LLDP for ip_k66f with 3 LAN ports. Ideally this should be common for all DSA devices, but for now, ip_k66f is the only platform supporting it. As there will be more DSA functions supported, better to allow each function enablement via option to suit hardware or device driver support status. Also improved dsa_ll_addr_switch_cb return value with enum value instead of plain value. Signed-off-by: Yangbo Lu <[email protected]>

Moved platform specific options to board. Also changed IP/Gateway to align documentation. Signed-off-by: Yangbo Lu <[email protected]>

Added mimxrt1180_evk board support. Signed-off-by: Yangbo Lu <[email protected]>

yangbolu1991 · 2025-02-11T09:33:37Z

Updated to v9 for dsa sample code improvement per @jukkar suggestion . Changes include,

Split dsa_lldp.c code style fix-up into seperate patch.
Improved dsa_ll_addr_switch_cb enum return value.
Aligned dsa sample board config IP/Gateway to document.

Thank you very much.

yangbolu1991 requested review from dleach02 and mmahadevan108 as code owners November 29, 2024 02:44

zephyrbot added area: Samples Samples area: Devicetree area: Ethernet platform: NXP NXP area: Networking platform: NXP Drivers NXP Semiconductors, drivers labels Nov 29, 2024

zephyrbot requested review from MarkWangChinese, danieldegrasse, dbaluta, decsny, jukkar, kartben, lmajewski, manuargue, nashif, pdgendt, rlubos, ssharks and tbursztyka November 29, 2024 02:45

zephyrbot assigned rlubos and jukkar Nov 29, 2024

zephyrbot added manifest manifest-hal_nxp DNM This PR should not be merged (Do Not Merge) labels Nov 29, 2024

danieldegrasse reviewed Dec 3, 2024

View reviewed changes

jukkar reviewed Dec 9, 2024

View reviewed changes

yangbolu1991 force-pushed the netc-switch branch from 56dd439 to ee5dc23 Compare December 10, 2024 06:55

yangbolu1991 added 7 commits February 5, 2025 15:35

dts: arm: nxp: rt118x: add NETC switch node

3c50e8e

Added NETC switch node. Signed-off-by: Yangbo Lu <[email protected]>

boards: nxp: mimxrt1180_evk: add pinctrl for NETC switch ports

9e416e2

Added pinctrl for NETC switch ports. Signed-off-by: Yangbo Lu <[email protected]>

boards: nxp: mimxrt1180_evk: move netc node to common dtsi

2a926db

Moved netc node from m33 dts to common dtsi. ENETC PSI0 kept disabled for M7 for now. Signed-off-by: Yangbo Lu <[email protected]>

boards: nxp: mimxrt1180_evk: enable switch ports

9540602

Enabled switch ports in dts. Signed-off-by: Yangbo Lu <[email protected]>

boards: nxp: mimxrt1180_evk: board init for switch ports

cdcd227

Added board init for switch ports. Signed-off-by: Yangbo Lu <[email protected]>

boards: nxp: mimxrt1180_evk: doc the NETC DSA support

c196e43

Documented the NETC DSA support. Signed-off-by: Yangbo Lu <[email protected]>

samples: net: dsa: handle disabled slave ports

e96d75a

The multiple ports DSA device may have some ports disabled in dts. This should be handled in the sample. Signed-off-by: Yangbo Lu <[email protected]>

yangbolu1991 force-pushed the netc-switch branch from 994de6a to a3d322a Compare February 5, 2025 08:05

decsny reviewed Feb 5, 2025

View reviewed changes

dts/bindings/dsa/nxp,netc-switch.yaml Show resolved Hide resolved

decsny previously approved these changes Feb 10, 2025

View reviewed changes

decsny added this to the v4.1.0 milestone Feb 10, 2025

decsny requested review from DerekSnell, danieldegrasse, decsny and lmajewski February 10, 2025 23:12

jukkar reviewed Feb 11, 2025

View reviewed changes

yangbolu1991 added 4 commits February 11, 2025 16:40

samples: net: dsa: clang-format dsa_lldp.c

2a9139d

Fixed style problem for dsa_lldp.c with clang-format. Signed-off-by: Yangbo Lu <[email protected]>

samples: net: dsa: move platform specific options to board

1b4815e

Moved platform specific options to board. Also changed IP/Gateway to align documentation. Signed-off-by: Yangbo Lu <[email protected]>

samples: net: dsa: add mimxrt1180_evk board support

d982f84

Added mimxrt1180_evk board support. Signed-off-by: Yangbo Lu <[email protected]>

yangbolu1991 dismissed decsny’s stale review via d982f84 February 11, 2025 09:27

yangbolu1991 force-pushed the netc-switch branch from a3d322a to d982f84 Compare February 11, 2025 09:27

yangbolu1991 requested a review from jukkar February 11, 2025 09:35

decsny approved these changes Feb 11, 2025

View reviewed changes

jukkar approved these changes Feb 11, 2025

View reviewed changes

kartben merged commit 7a22dc9 into zephyrproject-rtos:main Feb 11, 2025
26 checks passed

		CONFIG_NET_CONFIG_MY_IPV4_ADDR="192.168.0.2"
		CONFIG_NET_CONFIG_MY_IPV4_GW="192.168.0.1"

NXP i.MX NETC switch DSA driver #82307

NXP i.MX NETC switch DSA driver #82307

Uh oh!

Conversation

yangbolu1991 commented Nov 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zephyrbot commented Nov 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yangbolu1991 Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yangbolu1991 Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yangbolu1991 Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yangbolu1991 commented Feb 5, 2025

Uh oh!

Uh oh!

decsny commented Feb 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yangbolu1991 commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

yangbolu1991 commented Nov 29, 2024 •

edited

Loading

zephyrbot commented Nov 29, 2024 •

edited

Loading

yangbolu1991 Dec 9, 2024 •

edited

Loading

yangbolu1991 Dec 9, 2024 •

edited

Loading

yangbolu1991 Dec 9, 2024 •

edited

Loading

yangbolu1991 commented Feb 11, 2025 •

edited

Loading