drivers/usbhost/usbhost_cdcecm.c: Added support for Host CDC-ECM

Added support for USB host to use an USB CDC-ECM device.
This class is used for usb-ethernet adapters as well as many modems.

Signed-off-by: daniellizewski <daniellizewski@geotab.com>

Documentation/components/drivers/special/usbhost.rst

@@ -103,3 +103,37 @@ USB Host-Side Drivers
       **Examples**: See the call to ``register_blockdriver()`` in
       the function ``usbhost_initvolume()`` in the file
       ``drivers/usbhost/usbhost_storage.c``.
+
+CDC-ECM Host Class Driver
+=========================
+
+The CDC-ECM (Ethernet Control Model) host class driver
+(``drivers/usbhost/usbhost_cdcecm.c``) supports USB devices that expose
+a network interface using the USB Communications Device Class Ethernet
+Control Model. Common device types include:
+
+-  **USB-to-Ethernet adapters** that implement CDC-ECM, providing wired
+   Ethernet connectivity over a USB port.
+
+-  **Cellular modems and similar devices** that expose a CDC-ECM
+   interface for IP connectivity, such as LTE modems operating in USB
+   tethering mode.
+
+When a compatible device is connected and enumerated, the driver
+registers a standard NuttX Ethernet network interface — for example
+``eth0`` — and integrates with the NuttX networking stack in exactly the
+same way as any on-board Ethernet driver. Normal network configuration
+can then be applied to the interface using standard NSH commands::
+
+    ifup eth0
+    ifconfig eth0 192.168.1.10 netmask 255.255.255.0
+
+Or with DHCP via the ``netinit`` daemon when
+``CONFIG_NETINIT_DHCPC=y`` is selected.
+
+The driver is registered by calling ``usbhost_cdcecm_initialize()``
+during board initialization, before the USB host waiter thread begins
+enumerating devices.
+
+**Examples**: ``drivers/usbhost/usbhost_cdcecm.c``,
+``boards/arm/stm32h5/nucleo-h563zi/configs/nshusbnet/defconfig``.

Documentation/platforms/arm/stm32h5/boards/nucleo-h563zi/index.rst

@@ -174,6 +174,75 @@ This configuration configures the digital temperature sensor (DTS)
 at /dev/uorb/sensor_temp0 and provides the test application 
 sensortest. E.g. sensortest -n 10 temp0
 
+usbmsc:
+--------
+
+This configuration enables USB Host support with the Mass Storage Class
+(MSC) driver.  It is intended to test USB Host operation by connecting a
+USB mass-storage device (e.g. a USB flash drive) to the board's USB-C
+connector.  Key options enabled:
+
+- ``CONFIG_STM32H5_USBFS_HOST`` — STM32H5 USB full-speed host controller
+- ``CONFIG_USBHOST_MSC`` — USB Mass Storage Class host driver
+- ``CONFIG_USBHOST_HUB`` — USB hub support
+- ``CONFIG_FS_FAT`` — FAT filesystem for mounting the storage device
+
+The serial console remains on USART3 (ST-Link VCOM).  NSH
+``ifup``/``ifdown`` commands are disabled because no network interface is
+configured in this build.
+
+.. note::
+
+   USB Host requires a stable 48 MHz clock.  HSI48 is not accurate enough
+   for reliable USB operation, so this configuration uses the external
+   high-speed oscillator (HSE) as the USB clock source
+   (``CONFIG_STM32H5_USE_HSE=y``).  On the Nucleo-H563ZI development board
+   HSE is not connected by default; to enable it you must:
+
+   - **Connect** solder bridges **SB3** and **SB4**
+   - **Disconnect** solder bridge **SB49**
+
+   The board also does not support software control of VBUS power.  To
+   supply power to the USB host port, fit a second jumper on the **PWR SEL**
+   header that bridges the **STLK** and **USB USER** pins together.
+
+nshusbnet:
+-----------
+
+This configuration is based on the standard ``nsh`` configuration but adds
+full networking support and the CDC-ECM USB Ethernet host driver.  It is
+intended to test USB Host operation with a USB-to-Ethernet adapter that
+uses the CDC-ECM (Ethernet Control Model) protocol.  Key options enabled:
+
+- ``CONFIG_STM32H5_USBFS_HOST`` — STM32H5 USB full-speed host controller
+- ``CONFIG_USBHOST_CDCECM`` — USB CDC-ECM Ethernet host driver
+- ``CONFIG_USBHOST_COMPOSITE`` — composite USB device support
+- ``CONFIG_USBHOST_HUB`` — USB hub support
+- ``CONFIG_NET``, ``CONFIG_NET_TCP``, ``CONFIG_NET_UDP`` — IPv4 networking stack
+- ``CONFIG_NETINIT_DHCPC`` / ``CONFIG_NETUTILS_DHCPC`` — DHCP client for automatic IP configuration
+- ``CONFIG_NETUTILS_TELNETD`` — Telnet daemon for remote NSH access
+- ``CONFIG_SYSTEM_PING`` — ping utility for connectivity testing
+
+Plug a CDC-ECM USB Ethernet adapter into the board's USB-C host port.
+NuttX will enumerate the device, assign it a network interface, and obtain
+an IP address via DHCP.  The ``ping`` application can then be used to
+verify network connectivity.
+
+.. note::
+
+   USB Host requires a stable 48 MHz clock.  HSI48 is not accurate enough
+   for reliable USB operation, so this configuration uses the external
+   high-speed oscillator (HSE) as the USB clock source
+   (``CONFIG_STM32H5_USE_HSE=y``).  On the Nucleo-H563ZI development board
+   HSE is not connected by default; to enable it you must:
+
+   - **Connect** solder bridges **SB3** and **SB4**
+   - **Disconnect** solder bridge **SB49**
+
+   The board also does not support software control of VBUS power.  To
+   supply power to the USB host port, fit a second jumper on the **PWR SEL**
+   header that bridges the **STLK** and **USB USER** pins together.
+
 References
 ===========
 

boards/arm/stm32h5/nucleo-h563zi/configs/nshusbnet/defconfig

@@ -0,0 +1,71 @@
+#
+# This file is autogenerated: PLEASE DO NOT EDIT IT.
+#
+# You can use "make menuconfig" to make any modifications to the installed .config file.
+# You can then do "make savedefconfig" to generate a new defconfig file that includes your
+# modifications.
+#
+# CONFIG_NSH_ARGCAT is not set
+# CONFIG_STANDARD_SERIAL is not set
+CONFIG_ARCH="arm"
+CONFIG_ARCH_BOARD="nucleo-h563zi"
+CONFIG_ARCH_BOARD_NUCLEO_H563ZI=y
+CONFIG_ARCH_BUTTONS=y
+CONFIG_ARCH_CHIP="stm32h5"
+CONFIG_ARCH_CHIP_STM32H563ZI=y
+CONFIG_ARCH_CHIP_STM32H5=y
+CONFIG_ARCH_INTERRUPTSTACK=2048
+CONFIG_ARCH_STACKDUMP=y
+CONFIG_ARMV8M_STACKCHECK_NONE=y
+CONFIG_BOARD_LOOPSPERMSEC=9251
+CONFIG_BUILTIN=y
+CONFIG_DEBUG_ASSERTIONS=y
+CONFIG_DEBUG_FEATURES=y
+CONFIG_DEBUG_SYMBOLS=y
+CONFIG_DEBUG_USB=y
+CONFIG_DEBUG_USB_ERROR=y
+CONFIG_DEBUG_USB_WARN=y
+CONFIG_FS_PROCFS=y
+CONFIG_FS_PROCFS_REGISTER=y
+CONFIG_HAVE_CXX=y
+CONFIG_HAVE_CXXINITIALIZE=y
+CONFIG_IDLETHREAD_STACKSIZE=2048
+CONFIG_INIT_ENTRYPOINT="nsh_main"
+CONFIG_LINE_MAX=64
+CONFIG_NET=y
+CONFIG_NETDB_DNSCLIENT=y
+CONFIG_NETDEV_LATEINIT=y
+CONFIG_NETINIT_DHCPC=y
+CONFIG_NETUTILS_DHCPC=y
+CONFIG_NETUTILS_TELNETD=y
+CONFIG_NET_ETH_PKTSIZE=1514
+CONFIG_NET_ICMP_SOCKET=y
+CONFIG_NET_PKT=y
+CONFIG_NET_ROUTE=y
+CONFIG_NET_TCP=y
+CONFIG_NET_UDP=y
+CONFIG_NSH_ARCHINIT=y
+CONFIG_NSH_BUILTIN_APPS=y
+CONFIG_NSH_FILEIOSIZE=512
+CONFIG_NSH_READLINE=y
+CONFIG_PREALLOC_TIMERS=4
+CONFIG_RAM_SIZE=655360
+CONFIG_RAM_START=0x20000000
+CONFIG_RAW_BINARY=y
+CONFIG_READLINE_CMD_HISTORY=y
+CONFIG_READLINE_TABCOMPLETION=y
+CONFIG_RR_INTERVAL=200
+CONFIG_SCHED_LPWORK=y
+CONFIG_SCHED_WAITPID=y
+CONFIG_STACK_COLORATION=y
+CONFIG_STM32H5_USART3=y
+CONFIG_STM32H5_USBFS_HOST=y
+CONFIG_STM32H5_USE_HSE=y
+CONFIG_SYSTEM_NSH=y
+CONFIG_SYSTEM_PING=y
+CONFIG_TASK_NAME_SIZE=0
+CONFIG_USART3_SERIAL_CONSOLE=y
+CONFIG_USBHOST_CDCECM=y
+CONFIG_USBHOST_COMPOSITE=y
+CONFIG_USBHOST_CONFIGURATION_SELECTION=y
+CONFIG_USBHOST_HUB=y

boards/arm/stm32h5/nucleo-h563zi/src/stm32_usb.c

@@ -171,6 +171,17 @@ int stm32_usbhost_initialize(void)
     }
 #endif
 
+#ifdef CONFIG_USBHOST_CDCECM
+  /* Register the CDC-ECM class driver */
+
+  ret = usbhost_cdcecm_initialize();
+  if (ret < 0)
+    {
+      uerr("ERROR: Failed to register CDC-ACM class: %d\n", ret);
+      return ret;
+    }
+#endif
+
   /* Then get an instance of the USB host interface */
 
   uinfo("Initialize USB host\n");

drivers/usbhost/CMakeLists.txt

@@ -47,6 +47,10 @@ if(CONFIG_USBHOST)
     list(APPEND SRCS usbhost_cdcacm.c)
   endif()
 
+  if(CONFIG_USBHOST_CDCECM)
+    list(APPEND SRCS usbhost_cdcecm.c)
+  endif()
+
   if(CONFIG_USBHOST_CDCMBIM)
     list(APPEND SRCS usbhost_cdcmbim.c)
   endif()

drivers/usbhost/Kconfig

@@ -304,6 +304,25 @@ config USBHOST_CDCACM_TXBUFSIZE
 
 endif # USBHOST_CDCACM
 
+config USBHOST_CDCECM
+	bool "CDC/ECM support"
+	default n
+	depends on USBHOST_HAVE_ASYNCH && !USBHOST_BULK_DISABLE && !USBHOST_INT_DISABLE
+	select USBHOST_ASYNCH
+	select NET_ETHERNET
+	---help---
+		Select this option to build in host support for CDC/ECM serial
+		devices.
+
+config USBHOST_CDCECM_PACKET_PRINT
+	bool "Print raw CDC/ECM packets"
+	default n
+	depends on DEBUG_USB_INFO
+	---help---
+		Print all raw RX and TX packets send and received in the CDC/ECM driver.
+		This can be useful for analysing with programs such as wireshark.
+
+
 config USBHOST_CDCMBIM
 	bool "CDC/MBIM support"
 	default n

drivers/usbhost/Make.defs

@@ -48,6 +48,10 @@ ifeq ($(CONFIG_USBHOST_CDCACM),y)
 CSRCS += usbhost_cdcacm.c
 endif
 
+ifeq ($(CONFIG_USBHOST_CDCECM),y)
+CSRCS += usbhost_cdcecm.c
+endif
+
 ifeq ($(CONFIG_USBHOST_CDCMBIM),y)
 CSRCS += usbhost_cdcmbim.c
 endif

include/nuttx/usb/usbhost.h

@@ -1141,6 +1141,27 @@ void usbhost_msc_notifier_signal(uint8_t event, char sdchar);
 int usbhost_cdcacm_initialize(void);
 #endif
 
+#ifdef CONFIG_USBHOST_CDCECM
+/****************************************************************************
+ * Name: usbhost_cdcacm_initialize
+ *
+ * Description:
+ *   Initialize the USB host CDC/ECM class.  This function should be called
+ *   by platform-specific code in order to initialize and register support
+ *   for the USB host CDC/ECM class.
+ *
+ * Input Parameters:
+ *   None
+ *
+ * Returned Value:
+ *   On success this function will return zero (OK);  A negated errno value
+ *   will be returned on failure.
+ *
+ ****************************************************************************/
+
+int usbhost_cdcecm_initialize(void);
+#endif
+
 #ifdef CONFIG_USBHOST_FT232R
 /****************************************************************************
  * Name: usbhost_ft232r_initialize