rename CFG_TUD_NET to CFG_TUD_ECM_RNDIS

2025-03-14 04:18:56 +00:00 · 2021-10-05 12:32:07 +07:00 · 2021-10-05 12:32:07 +07:00 · a867d87072
commit a867d87072
parent 31cfd5a684
12 changed files with 63 additions and 49 deletions
--- a/examples/device/cdc_msc_freertos/src/CMakeLists.txt
+++ b/examples/device/cdc_msc_freertos/src/CMakeLists.txt
@ -23,7 +23,7 @@ target_sources(${COMPONENT_TARGET} PUBLIC
  "${TOP}/src/class/hid/hid_device.c"
  "${TOP}/src/class/midi/midi_device.c"
  "${TOP}/src/class/msc/msc_device.c"
-  "${TOP}/src/class/net/ecmrndis_device.c"
+  "${TOP}/src/class/net/ecm_rndis_device.c"
  "${TOP}/src/class/net/ncm_device.c"
  "${TOP}/src/class/usbtmc/usbtmc_device.c"
  "${TOP}/src/class/vendor/vendor_device.c"
--- a/examples/device/hid_composite_freertos/src/CMakeLists.txt
+++ b/examples/device/hid_composite_freertos/src/CMakeLists.txt
@ -23,7 +23,7 @@ target_sources(${COMPONENT_TARGET} PUBLIC
  "${TOP}/src/class/hid/hid_device.c"
  "${TOP}/src/class/midi/midi_device.c"
  "${TOP}/src/class/msc/msc_device.c"
-  "${TOP}/src/class/net/ecmrndis_device.c"
+  "${TOP}/src/class/net/ecm_rndis_device.c"
  "${TOP}/src/class/net/ncm_device.c"
  "${TOP}/src/class/usbtmc/usbtmc_device.c"
  "${TOP}/src/class/vendor/vendor_device.c"
--- a/examples/device/net_lwip_webserver/src/tusb_config.h
+++ b/examples/device/net_lwip_webserver/src/tusb_config.h
@ -95,13 +95,11 @@
 #endif

 //------------- CLASS -------------//
-#define CFG_TUD_CDC               0
-#define CFG_TUD_MSC               0
-#define CFG_TUD_HID               0
-#define CFG_TUD_MIDI              0
-#define CFG_TUD_VENDOR            0
-#define CFG_TUD_NET               1
-#define CFG_TUD_NCM               0
+
+// Network class has 2 drivers: ECM/RNDIS and NCM.
+// Only one of the drivers can be enabled
+#define CFG_TUD_ECM_RNDIS     1
+#define CFG_TUD_NCM           (1-CFG_TUD_ECM_RNDIS)

 #ifdef __cplusplus
 }
--- a/examples/device/net_lwip_webserver/src/usb_descriptors.c
+++ b/examples/device/net_lwip_webserver/src/usb_descriptors.c
@ -33,7 +33,7 @@
 */
 #define _PID_MAP(itf, n)  ( (CFG_TUD_##itf) << (n) )
 #define USB_PID           (0x4000 | _PID_MAP(CDC, 0) | _PID_MAP(MSC, 1) | _PID_MAP(HID, 2) | \
-                           _PID_MAP(MIDI, 3) | _PID_MAP(VENDOR, 4) | _PID_MAP(NET, 5) )
+                           _PID_MAP(MIDI, 3) | _PID_MAP(VENDOR, 4) | _PID_MAP(ECM_RNDIS, 5) | _PID_MAP(NCM, 5) )

 // String Descriptor Index
 enum
@ -55,7 +55,7 @@ enum

 enum
 {
-#if !CFG_TUD_NCM
+#if CFG_TUD_ECM_RNDIS
  CONFIG_ID_RNDIS = 0,
  CONFIG_ID_ECM   = 1,
 #else
@ -125,7 +125,8 @@ uint8_t const * tud_descriptor_device_cb(void)
  #define EPNUM_NET_IN      0x82
 #endif

-#if !CFG_TUD_NCM
+#if CFG_TUD_ECM_RNDIS
+
 static uint8_t const rndis_configuration[] =
 {
  // Config number (index+1), interface count, string index, total length, attribute, power in mA
@ -143,7 +144,9 @@ static uint8_t const ecm_configuration[] =
  // Interface number, description string index, MAC address string index, EP notification address and size, EP data address (out, in), and size, max segment size.
  TUD_CDC_ECM_DESCRIPTOR(ITF_NUM_CDC, STRID_INTERFACE, STRID_MAC, EPNUM_NET_NOTIF, 64, EPNUM_NET_OUT, EPNUM_NET_IN, CFG_TUD_NET_ENDPOINT_SIZE, CFG_TUD_NET_MTU),
 };
+
 #else
+
 static uint8_t const ncm_configuration[] =
 {
  // Config number (index+1), interface count, string index, total length, attribute, power in mA
@ -152,6 +155,7 @@ static uint8_t const ncm_configuration[] =
  // Interface number, description string index, MAC address string index, EP notification address and size, EP data address (out, in), and size, max segment size.
  TUD_CDC_NCM_DESCRIPTOR(ITF_NUM_CDC, STRID_INTERFACE, STRID_MAC, EPNUM_NET_NOTIF, 64, EPNUM_NET_OUT, EPNUM_NET_IN, CFG_TUD_NET_ENDPOINT_SIZE, CFG_TUD_NET_MTU),
 };
+
 #endif

 // Configuration array: RNDIS and CDC-ECM
@ -160,7 +164,7 @@ static uint8_t const ncm_configuration[] =
 // - Linux will work on both
 static uint8_t const * const configuration_arr[2] =
 {
-#if !CFG_TUD_NCM
+#if CFG_TUD_ECM_RNDIS
  [CONFIG_ID_RNDIS] = rndis_configuration,
  [CONFIG_ID_ECM  ] = ecm_configuration
 #else
--- a/examples/rules.mk
+++ b/examples/rules.mk
@ -33,7 +33,7 @@ SRC_C += \
 	src/class/hid/hid_device.c \
 	src/class/midi/midi_device.c \
 	src/class/msc/msc_device.c \
-	src/class/net/ecmrndis_device.c \
+	src/class/net/ecm_rndis_device.c \
 	src/class/net/ncm_device.c \
 	src/class/usbtmc/usbtmc_device.c \
 	src/class/vendor/vendor_device.c
--- a/hw/bsp/rp2040/family.cmake
+++ b/hw/bsp/rp2040/family.cmake
@ -70,7 +70,7 @@ if (NOT TARGET _rp2040_family_inclusion_marker)
 			${TOP}/src/class/hid/hid_device.c
 			${TOP}/src/class/midi/midi_device.c
 			${TOP}/src/class/msc/msc_device.c
-			${TOP}/src/class/net/ecmrndis_device.c
+			${TOP}/src/class/net/ecm_rndis_device.c
 			${TOP}/src/class/net/ncm_device.c
 			${TOP}/src/class/usbtmc/usbtmc_device.c
 			${TOP}/src/class/vendor/vendor_device.c
--- a/src/class/net/ecm_rndis_device.c
+++ b/src/class/net/ecm_rndis_device.c
@ -27,7 +27,7 @@

 #include "tusb_option.h"

-#if ( TUSB_OPT_DEVICE_ENABLED && CFG_TUD_NET && !CFG_TUD_NCM )
+#if ( TUSB_OPT_DEVICE_ENABLED && CFG_TUD_ECM_RNDIS )

 #include "device/usbd.h"
 #include "device/usbd_pvt.h"
--- a/src/class/net/ncm_device.c
+++ b/src/class/net/ncm_device.c
@ -28,7 +28,7 @@

 #include "tusb_option.h"

-#if ( TUSB_OPT_DEVICE_ENABLED && CFG_TUD_NET && CFG_TUD_NCM )
+#if ( TUSB_OPT_DEVICE_ENABLED && CFG_TUD_NCM )

 #include "device/usbd.h"
 #include "device/usbd_pvt.h"
@ -131,18 +131,18 @@ typedef struct
 //--------------------------------------------------------------------+

 CFG_TUSB_MEM_SECTION CFG_TUSB_MEM_ALIGN static const ntb_parameters_t ntb_parameters = {
-    .wLength = sizeof(ntb_parameters_t),
-    .bmNtbFormatsSupported = 0x01,
-    .dwNtbInMaxSize = CFG_TUD_NCM_IN_NTB_MAX_SIZE,
-    .wNdbInDivisor = 4,
-    .wNdbInPayloadRemainder = 0,
-    .wNdbInAlignment = CFG_TUD_NCM_ALIGNMENT,
-    .wReserved = 0,
-    .dwNtbOutMaxSize = CFG_TUD_NCM_OUT_NTB_MAX_SIZE,
-    .wNdbOutDivisor = 4,
+    .wLength                 = sizeof(ntb_parameters_t),
+    .bmNtbFormatsSupported   = 0x01,
+    .dwNtbInMaxSize          = CFG_TUD_NCM_IN_NTB_MAX_SIZE,
+    .wNdbInDivisor           = 4,
+    .wNdbInPayloadRemainder  = 0,
+    .wNdbInAlignment         = CFG_TUD_NCM_ALIGNMENT,
+    .wReserved               = 0,
+    .dwNtbOutMaxSize         = CFG_TUD_NCM_OUT_NTB_MAX_SIZE,
+    .wNdbOutDivisor          = 4,
    .wNdbOutPayloadRemainder = 0,
-    .wNdbOutAlignment = CFG_TUD_NCM_ALIGNMENT,
-    .wNtbOutMaxDatagrams = 0
+    .wNdbOutAlignment        = CFG_TUD_NCM_ALIGNMENT,
+    .wNtbOutMaxDatagrams     = 0
 };

 CFG_TUSB_MEM_SECTION CFG_TUSB_MEM_ALIGN static transmit_ntb_t transmit_ntb[2];
--- a/src/class/net/net_device.h
+++ b/src/class/net/net_device.h
@ -30,10 +30,14 @@

 #include "class/cdc/cdc.h"

+#if CFG_TUD_ECM_RNDIS && CFG_TUD_NCM
+#error "Cannot enable both ECM_RNDIS and NCM network drivers"
+#endif
+
 /* declared here, NOT in usb_descriptors.c, so that the driver can intelligently ZLP as needed */
 #define CFG_TUD_NET_ENDPOINT_SIZE (TUD_OPT_HIGH_SPEED ? 512 : 64)

-/* Maximum Tranmission Unit (in bytes) of the network, including Ethernet header */
+/* Maximum Transmission Unit (in bytes) of the network, including Ethernet header */
 #ifndef CFG_TUD_NET_MTU
 #define CFG_TUD_NET_MTU           1514
 #endif
@ -62,19 +66,6 @@
 // Application API
 //--------------------------------------------------------------------+

-// client must provide this: initialize any network state back to the beginning
-void tud_network_init_cb(void);
-
-// client must provide this: return false if the packet buffer was not accepted
-bool tud_network_recv_cb(const uint8_t *src, uint16_t size);
-
-// client must provide this: copy from network stack packet pointer to dst
-uint16_t tud_network_xmit_cb(uint8_t *dst, void *ref, uint16_t arg);
-
-// client must provide this: 48-bit MAC address
-// TODO removed later since it is not part of tinyusb stack
-extern const uint8_t tud_network_mac_address[6];
-
 // indicate to network driver that client has finished with the packet provided to network_recv_cb()
 void tud_network_recv_renew(void);

@ -84,6 +75,27 @@ bool tud_network_can_xmit(uint16_t size);
 // if network_can_xmit() returns true, network_xmit() can be called once
 void tud_network_xmit(void *ref, uint16_t arg);

+//--------------------------------------------------------------------+
+// Application Callbacks (WEAK is optional)
+//--------------------------------------------------------------------+
+
+// client must provide this: return false if the packet buffer was not accepted
+bool tud_network_recv_cb(const uint8_t *src, uint16_t size);
+
+// client must provide this: copy from network stack packet pointer to dst
+uint16_t tud_network_xmit_cb(uint8_t *dst, void *ref, uint16_t arg);
+
+//------------- ECM/RNDIS -------------//
+
+// client must provide this: initialize any network state back to the beginning
+void tud_network_init_cb(void);
+
+// client must provide this: 48-bit MAC address
+// TODO removed later since it is not part of tinyusb stack
+extern const uint8_t tud_network_mac_address[6];
+
+//------------- NCM -------------//
+
 // callback to client providing optional indication of internal state of network driver
 void tud_network_link_state_cb(bool state);

--- a/src/device/usbd.c
+++ b/src/device/usbd.c
@ -203,7 +203,7 @@ static usbd_class_driver_t const _usbd_driver[] =
  },
  #endif

-  #if CFG_TUD_NET
+  #if CFG_TUD_ECM_RNDIS || CFG_TUD_NCM
  {
    DRIVER_NAME("NET")
    .init             = netd_init,
--- a/src/tusb.h
+++ b/src/tusb.h
@ -100,7 +100,7 @@
    #include "class/dfu/dfu_device.h"
  #endif

-  #if CFG_TUD_NET
+  #if CFG_TUD_ECM_RNDIS || CFG_TUD_NCM
    #include "class/net/net_device.h"
  #endif

--- a/src/tusb_option.h
+++ b/src/tusb_option.h
@ -261,16 +261,16 @@
  #define CFG_TUD_DFU             0
 #endif

-#ifndef CFG_TUD_NET
-  #define CFG_TUD_NET             0
-#endif
-
 #ifndef CFG_TUD_BTH
  #define CFG_TUD_BTH             0
 #endif

+#ifndef CFG_TUD_ECM_RNDIS
+  #define CFG_TUD_ECM_RNDIS   0
+#endif
+
 #ifndef CFG_TUD_NCM
-  #define CFG_TUD_NCM             0
+  #define CFG_TUD_NCM         0
 #endif

 //--------------------------------------------------------------------