usb: device_next: NCM driver for usb-next

USB NCM Ethernet driver implementation.

Signed-off-by: Jukka Rissanen <[email protected]>

Author: jukkar

dts/bindings/ethernet/zephyr,cdc-ncm-ethernet.yaml

@@ -0,0 +1,16 @@
+# Copyright (c) 2024 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+description: USB CDC NCM virtual Ethernet controller
+
+compatible: "zephyr,cdc-ncm-ethernet"
+
+include: ethernet-controller.yaml
+
+properties:
+  remote-mac-address:
+    type: string
+    required: true
+    description: |
+      Remote MAC address of the virtual Ethernet connection.
+      Should not be the same as local-mac-address property.

include/zephyr/usb/class/usb_cdc.h

@@ -28,11 +28,13 @@
 #define ACM_SUBCLASS			0x02
 #define ECM_SUBCLASS			0x06
 #define EEM_SUBCLASS			0x0c
+#define NCM_SUBCLASS			0x0d
 
 /** Communications Class Protocol Codes */
 #define AT_CMD_V250_PROTOCOL		0x01
 #define EEM_PROTOCOL			0x07
 #define ACM_VENDOR_PROTOCOL		0xFF
+#define NCM_DATA_PROTOCOL		0x01
 
 /**
  * @brief Data Class Interface Codes
@@ -50,6 +52,7 @@
 #define ACM_FUNC_DESC			0x02
 #define UNION_FUNC_DESC			0x06
 #define ETHERNET_FUNC_DESC		0x0F
+#define ETHERNET_FUNC_DESC_NCM		0x1a
 
 /**
  * @brief PSTN Subclass Specific Requests
@@ -139,6 +142,22 @@
 #define SET_ETHERNET_PACKET_FILTER	0x43
 #define GET_ETHERNET_STATISTIC		0x44
 
+/**
+ * @brief Class-Specific Request Codes for NCM subclass
+ * @note NCM100.pdf, 6.2, Table 6-2
+ */
+#define GET_NTB_PARAMETERS     0x80
+#define GET_NET_ADDRESS        0x81
+#define SET_NET_ADDRESS        0x82
+#define GET_NTB_FORMAT         0x83
+#define SET_NTB_FORMAT         0x84
+#define GET_NTB_INPUT_SIZE     0x85
+#define SET_NTB_INPUT_SIZE     0x86
+#define GET_MAX_DATAGRAM_SIZE  0x87
+#define SET_MAX_DATAGRAM_SIZE  0x88
+#define GET_CRC_MODE           0x89
+#define SET_CRC_MODE           0x8A
+
 /** Ethernet Packet Filter Bitmap */
 #define PACKET_TYPE_MULTICAST		0x10
 #define PACKET_TYPE_BROADCAST		0x08
@@ -210,4 +229,13 @@ struct cdc_ecm_descriptor {
 	uint8_t bNumberPowerFilters;
 } __packed;
 
+/** Ethernet Network Control Model (NCM) Descriptor */
+struct cdc_ncm_descriptor {
+	uint8_t bFunctionLength;
+	uint8_t bDescriptorType;
+	uint8_t bDescriptorSubtype;
+	uint16_t bcdNcmVersion;
+	uint8_t bmNetworkCapabilities;
+} __packed;
+
 #endif /* ZEPHYR_INCLUDE_USB_CLASS_USB_CDC_H_ */

subsys/net/lib/config/Kconfig

@@ -24,7 +24,7 @@ if NET_CONFIG_SETTINGS
 
 config NET_CONFIG_AUTO_INIT
 	bool "Init networking support automatically during device startup"
-	default n if USB_DEVICE_NETWORK
+	default n if USB_DEVICE_NETWORK || USBD_CDC_ECM_CLASS || USBD_CDC_NCM_CLASS
 	default y
 	help
 	  If this option is set, then the networking system is automatically

subsys/usb/device_next/CMakeLists.txt

@@ -41,6 +41,15 @@ zephyr_library_sources_ifdef(
 	class/usbd_cdc_ecm.c
 )
 
+zephyr_include_directories_ifdef(
+	CONFIG_USBD_CDC_NCM_CLASS
+	${ZEPHYR_BASE}/drivers/ethernet
+)
+zephyr_library_sources_ifdef(
+	CONFIG_USBD_CDC_NCM_CLASS
+	class/usbd_cdc_ncm.c
+)
+
 zephyr_library_sources_ifdef(
 	CONFIG_USBD_BT_HCI
 	class/bt_hci.c

subsys/usb/device_next/class/Kconfig

@@ -5,6 +5,7 @@
 rsource "Kconfig.loopback"
 rsource "Kconfig.cdc_acm"
 rsource "Kconfig.cdc_ecm"
+rsource "Kconfig.cdc_ncm"
 rsource "Kconfig.bt"
 rsource "Kconfig.msc"
 rsource "Kconfig.uac2"

subsys/usb/device_next/class/Kconfig.cdc_ncm

@@ -0,0 +1,35 @@
+# Copyright (c) 2024 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: Apache-2.0
+
+config USBD_CDC_NCM_CLASS
+	bool "USB CDC NCM implementation [EXPERIMENTAL]"
+	default y
+	depends on NET_L2_ETHERNET
+	depends on DT_HAS_ZEPHYR_CDC_NCM_ETHERNET_ENABLED
+	select EXPERIMENTAL
+	help
+	  USB CDC Network Control Model (NCM) implementation
+
+if USBD_CDC_NCM_CLASS
+
+config USBD_CDC_NCM_MAX_DGRAM_PER_NTB
+	int "Max number of received datagrams per NTB"
+	range 0 $(UINT16_MAX)
+	default 2
+	help
+	  How many datagrams we are able to receive per NTB.
+
+config USBD_CDC_NCM_SUPPORT_NTB32
+	bool "Support NTB32 format"
+	help
+	  Enable support for NTB32 format which allows larger
+	  packet sizes.
+
+module = USBD_CDC_NCM
+module-str = usbd cdc_ncm
+default-count = 1
+source "subsys/logging/Kconfig.template.log_config"
+rsource "Kconfig.template.instances_count"
+
+endif