shared/tinyusb: Add support for USB Network (NCM) interface.

pi-anl · pi-anl · commit 9bba8aa50845 · 2025-03-02T23:04:18.000+11:00
This provides a network interface over the USB connection which
is connected to the existing LWIP network stack.

Signed-off-by: Andrew Leech &lt;andrew.leech@planetinnovation.com.au&gt;
diff --git a/extmod/lwip-include/lwipopts_common.h b/extmod/lwip-include/lwipopts_common.h
@@ -56,6 +56,8 @@
 #define LWIP_DNS_SUPPORT_MDNS_QUERIES   1
 #define LWIP_MDNS_RESPONDER             1
 #define LWIP_IGMP                       1
+#define LWIP_UDP                        1
+#define LWIP_MULTICAST_TX_OPTIONS       1
 
 #if MICROPY_PY_LWIP_PPP
 #define PPP_SUPPORT                     1
@@ -108,4 +110,8 @@
 
 typedef uint32_t sys_prot_t;
 
+// #define LWIP_DEBUG
+// #define LWIP_DBG_MIN_LEVEL              LWIP_DBG_LEVEL_ALL
+// #define LWIP_DBG_TYPES_ON               LWIP_DBG_ON
+
 #endif // MICROPY_INCLUDED_LWIPOPTS_COMMON_H
diff --git a/extmod/network_usbd_ncm.c b/extmod/network_usbd_ncm.c
@@ -46,6 +46,11 @@
 #include "shared/netutils/netutils.h"
 #include "shared/netutils/dhcpserver.h"
 
+#if LWIP_IPV6
+#define IP(x) ((x).u_addr.ip4)
+#else
+#define IP(x) (x)
+#endif
 
 typedef struct _usbnet_obj_t {
     mp_obj_base_t base;
@@ -62,6 +67,7 @@ typedef struct _usbnet_obj_t {
     ip_addr_t ipaddr;
     ip_addr_t netmask;
     ip_addr_t gateway;
+    ip_addr_t dns;
 
 } usbnet_obj_t;
 
@@ -115,7 +121,7 @@ static err_t ip6_output_fn(struct netif *netif, struct pbuf *p, const ip6_addr_t
 static err_t netif_init_cb(struct netif *netif) {
     LWIP_ASSERT("netif != NULL", (netif != NULL));
     netif->mtu = CFG_TUD_NET_MTU;
-    netif->flags = NETIF_FLAG_BROADCAST | NETIF_FLAG_ETHARP | NETIF_FLAG_LINK_UP | NETIF_FLAG_UP;
+    netif->flags = NETIF_FLAG_BROADCAST | NETIF_FLAG_ETHARP | NETIF_FLAG_ETHERNET | NETIF_FLAG_IGMP;
     netif->state = NULL;
     netif->name[0] = 'E';
     netif->name[1] = 'X';
@@ -124,29 +130,78 @@ static err_t netif_init_cb(struct netif *netif) {
     #if LWIP_IPV6
     netif->output_ip6 = ip6_output_fn;
     #endif
+    #if LWIP_IGMP
+    // netif_set_igmp_mac_filter(netif, cyw43_netif_update_igmp_mac_filter);
+    #endif
     return ERR_OK;
 }
 
+#if MICROPY_HW_NETWORK_USBNET_DHCP_SERVER
+void dhcp_client_connected(uint8_t ciaddr[4], uint8_t chaddr[16]) {
+    // When a host pc connects and is assigned an ip address, use that host
+    // as the default gateway. This means the host could optionally be configured
+    // to forward internet to the usb network adaptor and this device will be able to use it.
+    ip4_addr_t gw4;
+    IP4_ADDR(&gw4, ciaddr[0], ciaddr[1], ciaddr[2], ciaddr[3]);
+    netif_set_gw(&(usbnet_obj.netif), &gw4);
+}
+#endif
+
+// #if LWIP_IGMP
+// static err_t cyw43_netif_update_igmp_mac_filter(struct netif *netif, const ip4_addr_t *group, enum netif_mac_filter_action action) {
+//     cyw43_t *self = netif->state;
+//     uint8_t mac[] = { 0x01, 0x00, 0x5e, ip4_addr2(group) & 0x7F, ip4_addr3(group), ip4_addr4(group) };
+
+//     if (action != IGMP_ADD_MAC_FILTER && action != IGMP_DEL_MAC_FILTER) {
+//         return ERR_VAL;
+//     }
+
+//     // if (cyw43_wifi_update_multicast_filter(self, mac, action == IGMP_ADD_MAC_FILTER)) {
+//     //     return ERR_IF;
+//     // }
+
+//     return ERR_OK;
+// }
+// #endif
+
+// #if LWIP_IPV6
+// static err_t cyw43_macfilter(struct netif *netif, const ip6_addr_t *group, enum netif_mac_filter_action action) {
+//     uint8_t address[6] = { 0x33, 0x33 };
+//     memcpy(address + 2, group->addr + 3, 4);
+//     if (action != NETIF_ADD_MAC_FILTER && action != NETIF_DEL_MAC_FILTER) {
+//         return ERR_VAL;
+//     }
+//     if (cyw43_wifi_update_multicast_filter(netif->state, address, action == NETIF_ADD_MAC_FILTER)) {
+//         return ERR_IF;
+//     }
+//     return ERR_OK;
+// }
+// #endif
+
 void usbnet_init(void) {
     struct netif *netif = &(usbnet_obj.netif);
 
     MICROPY_PY_LWIP_ENTER
 
     mp_hal_get_mac(MP_HAL_MAC_ETH0, tud_network_mac_address);
+    tud_network_mac_address[0] = 0x02;
+    // tud_network_mac_address[1] = 0x00;
+    // tud_network_mac_address[2] = 0x5E;
+    // tud_network_mac_address[5] ^= 0x1;
 
     netif->hwaddr_len = sizeof(tud_network_mac_address);
     memcpy(netif->hwaddr, tud_network_mac_address, sizeof(tud_network_mac_address));
-    netif->hwaddr[5] ^= 0x01;
 
-    #if LWIP_IPV6
-    #define IP(x) ((x).u_addr.ip4)
-    #else
-    #define IP(x) (x)
-    #endif
+    // This USB Network essentially creates a link with two interfaces, one for the
+    // host and another for the micropython/lwip end of the connection.
+    // The MAC configured above is use for one end of the link, flip a bit for the
+    // MAC on the other end of the link.
+    netif->hwaddr[5] ^= 0x01;
 
     IP(usbnet_obj.ipaddr).addr = PP_HTONL(MICROPY_HW_NETWORK_USBNET_IPADDRESS);
     IP(usbnet_obj.netmask).addr = PP_HTONL(MICROPY_HW_NETWORK_USBNET_SUBNET);
     IP(usbnet_obj.gateway).addr = PP_HTONL(MICROPY_HW_NETWORK_USBNET_GATEWAY);
+    IP(usbnet_obj.dns).addr = PP_HTONL(MICROPY_HW_NETWORK_USBNET_DNS);
 
     netif = netif_add(
         netif,
@@ -160,15 +215,28 @@ void usbnet_init(void) {
     #if LWIP_IPV6
     netif_create_ip6_linklocal_address(netif, 1);
     #endif
+    #if LWIP_NETIF_HOSTNAME
+    netif_set_hostname(netif, mod_network_hostname_data);
+    #endif
     netif_set_default(netif);
+    netif_set_up(netif);
+    netif_set_link_up(netif);
+
+    #if LWIP_MDNS_RESPONDER
+    mdns_resp_add_netif(netif, mod_network_hostname_data);
+    #endif
+
+    #if LWIP_DNS
+    dns_setserver(0, &usbnet_obj.dns);
+    #endif
 
     #if MICROPY_HW_NETWORK_USBNET_DHCP_SERVER
     dhcp_server_init(&usbnet_obj.dhcp_server, &usbnet_obj.ipaddr, &usbnet_obj.netmask);
+    dhcp_server_register_connect_cb(&usbnet_obj.dhcp_server, &dhcp_client_connected);
     #endif
 
-    #if LWIP_MDNS_RESPONDER
-    mdns_resp_add_netif(netif, mod_network_hostname_data);
-    #endif
+    // register with network module
+    mod_network_register_nic(&usbnet_obj);
 
     MICROPY_PY_LWIP_EXIT
 }
diff --git a/extmod/network_usbd_ncm.h b/extmod/network_usbd_ncm.h
@@ -38,6 +38,12 @@
 #define MICROPY_HW_NETWORK_USBNET_IPADDRESS  LWIP_MAKEU32(192, 168, 7, 1)
 #define MICROPY_HW_NETWORK_USBNET_SUBNET     LWIP_MAKEU32(255, 255, 255, 0)
 #define MICROPY_HW_NETWORK_USBNET_GATEWAY    LWIP_MAKEU32(0, 0, 0, 0)
+#define MICROPY_HW_NETWORK_USBNET_DNS        LWIP_MAKEU32(192, 168, 7, 1)
+
+// #define MICROPY_HW_NETWORK_USBNET_IPADDRESS  LWIP_MAKEU32(169, 254, 128, 1)
+// #define MICROPY_HW_NETWORK_USBNET_SUBNET     LWIP_MAKEU32(255, 255, 0, 0)
+// #define MICROPY_HW_NETWORK_USBNET_GATEWAY    LWIP_MAKEU32(0, 0, 0, 0)
+
 #endif
 
 // Start dhcp server on this interface by default as this allows the host computer
diff --git a/ports/rp2/lwip_inc/arch/cc.h b/ports/rp2/lwip_inc/arch/cc.h
@@ -2,7 +2,15 @@
 #define MICROPY_INCLUDED_RP2_LWIP_ARCH_CC_H
 
 #include <assert.h>
-#define LWIP_PLATFORM_DIAG(x)
+// #define UDP_DEBUG                       LWIP_DBG_ON
+#define MDNS_DEBUG                       LWIP_DBG_ON
+#include "py/runtime.h"
+
+#define printf_wrap(...) {mp_printf(&mp_plat_print, __VA_ARGS__);}
+
+// #define LWIP_PLATFORM_DIAG(x) mp_printf(&mp_plat_print, x)
+#define LWIP_PLATFORM_DIAG(x) do {printf_wrap x;} while (0)
+
 #define LWIP_PLATFORM_ASSERT(x)  { assert(1); }
 
 #define LWIP_NO_CTYPE_H 1
diff --git a/shared/netutils/dhcpserver.c b/shared/netutils/dhcpserver.c
@@ -65,7 +65,7 @@
 #define PORT_DHCP_SERVER (67)
 #define PORT_DHCP_CLIENT (68)
 
-#define DEFAULT_DNS MAKE_IP4(192, 168, 4, 1)
+#define DEFAULT_DNS MAKE_IP4(192, 168, 7, 1)
 #define DEFAULT_LEASE_TIME_S (24 * 60 * 60) // in seconds
 
 #define MAC_LEN (6)
@@ -273,6 +273,9 @@ static void dhcp_server_process(void *arg, struct udp_pcb *upcb, struct pbuf *p,
             printf("DHCPS: client connected: MAC=%02x:%02x:%02x:%02x:%02x:%02x IP=%u.%u.%u.%u\n",
                 dhcp_msg.chaddr[0], dhcp_msg.chaddr[1], dhcp_msg.chaddr[2], dhcp_msg.chaddr[3], dhcp_msg.chaddr[4], dhcp_msg.chaddr[5],
                 dhcp_msg.yiaddr[0], dhcp_msg.yiaddr[1], dhcp_msg.yiaddr[2], dhcp_msg.yiaddr[3]);
+            if (d->on_client_connect != NULL) {
+                d->on_client_connect(dhcp_msg.yiaddr, dhcp_msg.chaddr);
+            }
             break;
         }
 
@@ -297,6 +300,7 @@ void dhcp_server_init(dhcp_server_t *d, ip_addr_t *ip, ip_addr_t *nm) {
     ip_addr_copy(d->ip, *ip);
     ip_addr_copy(d->nm, *nm);
     memset(d->lease, 0, sizeof(d->lease));
+    d->on_client_connect = NULL;
     if (dhcp_socket_new_dgram(&d->udp, d, dhcp_server_process) != 0) {
         return;
     }
@@ -307,4 +311,8 @@ void dhcp_server_deinit(dhcp_server_t *d) {
     dhcp_socket_free(&d->udp);
 }
 
+void dhcp_server_register_connect_cb(dhcp_server_t *d, dhcp_client_callback_t on_client_connect) {
+    d->on_client_connect = on_client_connect;
+}
+
 #endif // MICROPY_PY_LWIP
diff --git a/shared/netutils/dhcpserver.h b/shared/netutils/dhcpserver.h
@@ -36,14 +36,18 @@ typedef struct _dhcp_server_lease_t {
     uint16_t expiry;
 } dhcp_server_lease_t;
 
+typedef void (*dhcp_client_callback_t)(uint8_t[4], uint8_t[16]);
+
 typedef struct _dhcp_server_t {
     ip_addr_t ip;
     ip_addr_t nm;
     dhcp_server_lease_t lease[DHCPS_MAX_IP];
     struct udp_pcb *udp;
+    dhcp_client_callback_t on_client_connect;
 } dhcp_server_t;
 
 void dhcp_server_init(dhcp_server_t *d, ip_addr_t *ip, ip_addr_t *nm);
 void dhcp_server_deinit(dhcp_server_t *d);
+void dhcp_server_register_connect_cb(dhcp_server_t *d, dhcp_client_callback_t on_client_connect);
 
 #endif // MICROPY_INCLUDED_LIB_NETUTILS_DHCPSERVER_H
