Implement CDC NetworkConnection Notification for subsys/usb/device/class/netusb/function_ecm.c

[donusry-privoro]

Platforms such as macOS, iOS and iPadOS will not perform DHCP negotiation with autoconf fallback without the interface being "connected".

We have a need to implement a link-local connection between a device using autoconf. I have already fixed the driver to report correct status, but I wanted to open this issue to see if you all want me to open a pull request.

This was tested using a b_u585_iot02a discovery board from ST using the echo_server sample located at samples/net/sockets/echo_server. Build with overlay-netusb.conf. On macOS you can see USB-DEV show as "Not connected" when connected to board with example flashed.

west build -b b_u585i_iot02a samples/net/sockets/echo_server -- -DOVERLAY_CONFIG=overlay-netusb.conf

With my fix and implementing a simple DHCP server you will see the following. Without DHCP you should see it fallback to "Self-assigned IP Address".

Per the CDC ECM specification, NetworkConnection management element is required.

[jfischer-no]

NetworkConnection Notification is implemented for the CDC ECM in the new USB support.
I have no plans to implement it for the CDC ECM in the current USB device support. Move it to discussions.

[donusry-privoro]

New USB is still experimental according to docs.

[JayToltTech]

@jfischer-no Is this addressed at this point?

When I run:

west build -p -b nrf52840dk/nrf52840 samples/net/sockets/echo_server -DOVERLAY_CONFIG=overlay-usbd_next.conf

today on my MacOS developer box, I see the same issue of 'Not connected' that was described back in February:

[00:00:00.455,902] \033[1;31m<err> net_if: There is no network interface to work with!\033[0m
*** Booting Zephyr OS build v4.0.0-rc3-12-gd9ef4b7e6990 ***
[00:00:00.456,268] \033[1;33m<wrn> net_config: No auto-started network interface - network-bound app initialization skipped.\033[0m
[00:00:02.082,031] \033[0m<inf> net_echo_server_sample: Run echo server\033[0m
[00:00:02.082,092] \033[0m<inf> net_echo_server_sample: Waiting network to be connected\033[0m
[00:00:02.082,427] \033[1;33m<wrn> net_config: No auto-started network interface - network-bound app initialization skipped.\033[0m
[00:00:02.246,795] \033[1;33m<wrn> udc_nrf: USB Address incorrect 0x01\033[0m

[jukkar]

net_if: There is no network interface to work with!

Indicates that you do not have any network interface in the system, so there is no way to get a network connection to MacOS.

[JayToltTech]

@jukkar, have figured out this part, MacOS is detecting the NCM network device, but still showing a status of disconnected.

The 4.0.0.0-RC3 implementation is properly sending Connection Status to MacOS, but MacOS is still showing the network interface as Disconnected.

[00:00:02.009,826] <dbg> cdc_ncm: cdc_ncm_send: Configuration is not enabled or interface not ready (0 / 1)
--- 44 messages dropped ---
[00:00:02.009,918] <dbg> cdc_ncm: usbd_cdc_ncm_init: CDC NCM class initialized
[00:00:02.010,009] <inf> net_config: Initializing network
[00:00:02.010,101] <dbg> net_if: net_if_ipv4_addr_add: (main): [0] interface 1 (0x20001884) address 192.0.2.1 type MANUAL adde
[00:00:02.010,162] <inf> net_config: IPv4 address: 192.0.2.1
[00:00:02.010,284] <dbg> net_if: net_if_ipv6_addr_add: (main): [1] interface 1 (0x20001884) address 2001:db8::1 type MANUAL ad
[00:00:02.010,375] <dbg> net_if: net_if_ipv6_maddr_add: (main): [2] interface 1 (0x20001884) address ff02::1:ff00:1 added
[00:00:02.010,559] <dbg> net_if: net_if_tx: (tx_q[0]): Processing (pkt 0x20022658, prio 1) network packet iface 1 (0x20001884)
[00:00:02.010,681] <dbg> net_ethernet: ethernet_fill_header: (tx_q[0]): iface 1 (0x20001884) src 02:00:00:DB:A3:65 dst 33:33:0
[00:00:02.109,375] <inf> cdc_ncm: USB configuration is not enabled
[00:00:02.109,405] <dbg> cdc_ncm: cdc_ncm_send_speed_change: Cannot send speed change (-16)
[00:00:02.109,436] <dbg> cdc_ncm: ncm_send_notification: Cannot send speed change (-16)
[00:00:02.111,297] <dbg> net_if: dad_timeout: (sysworkq): DAD succeeded for 2001:db8::1 at interface 1
[00:00:02.111,389] <inf> net_config: IPv6 address: 2001:db8::1
[00:00:02.174,285] <wrn> udc_nrf: USB Address incorrect 0x01
[00:00:02.209,503] <inf> cdc_ncm: USB configuration is not enabled
[00:00:02.209,533] <dbg> cdc_ncm: cdc_ncm_send_speed_change: Cannot send speed change (-16)
[00:00:02.209,533] <dbg> cdc_ncm: ncm_send_notification: Cannot send speed change (-16)
[00:00:02.212,554] <dbg> cdc_ncm: usbd_cdc_ncm_enable: Configuration enabled
[00:00:02.227,111] <dbg> cdc_ncm: usbd_cdc_ncm_cth: 1: 128 28 0 0
[00:00:02.227,142] <dbg> cdc_ncm: usbd_cdc_ncm_cth: GET_NTB_PARAMETERS
[00:00:02.309,661] <dbg> cdc_ncm: ncm_send_notification: Speed change sent
[00:00:02.314,056] <dbg> cdc_ncm: usbd_cdc_ncm_request: finished 81 len 16
[00:00:02.409,759] <dbg> cdc_ncm: ncm_send_notification: Connected status sent
[00:00:02.410,034] <dbg> cdc_ncm: usbd_cdc_ncm_request: finished 81 len 8
[00:00:02.474,578] <inf> cdc_ncm: New configuration, interface 1 alternate 1
[00:00:02.474,609] <dbg> cdc_ncm: cdc_ncm_out_start: enqueue out 2048
[00:00:03.009,704] <dbg> net_if: rs_timeout: (sysworkq): RS no respond iface 0x20001884 count 2
[00:00:03.009,735] <dbg> net_if: net_if_start_rs: (sysworkq): Starting ND/RS for iface 0x20001884
[00:00:03.009,918] <dbg> net_if: net_if_tx: (tx_q[0]): Processing (pkt 0x20022658, prio 1) network packet iface 1 (0x20001884)
[00:00:03.010,040] <dbg> net_ethernet: ethernet_fill_header: (tx_q[0]): iface 1 (0x20001884) src 02:00:00:DB:A3:65 dst 33:33:0
[00:00:03.010,284] <dbg> cdc_ncm: usbd_cdc_ncm_request: finished 82 len 98
[00:00:04.009,979] <dbg> net_if: rs_timeout: (sysworkq): RS no respond iface 0x20001884 count 3

[JayToltTech]

@donusry-privoro Are you able to share your diff with the fix you implemented?

I am working on getting this scenario up and running on USBD-Next / NCM and running into issues, I would like to review your work and see if there is something I can bring to the table to help move things forward if you are open to it.

[donusry-privoro]

ecm_modification.patch
Here is the change I made to the old USB ECM implementation.

[JayToltTech]

Thank you very much @donusry-privoro . Hey, where did you read / figure out that NetworkConnection was required by MacOS/iPadOS? I'm reading through the various apple developer docs and I can't find details/requirements on ECM/NCM devices for Apple interoperability.

I've asked on the Apple Developer forums to see if they have a specifications or requirements doc out there. Best I found wassample code in Driver Kit of how to implement a network device driver, but nothing about the details of their ECM/NCM driver implementation...