Replace unused TinyUSB with stubs, enable NCM, 512b MSC (#3272)

Replace the specific device callbacks with weak stubs unless the application
actually uses a library which needs it.

MSC_Device saves 2136b flash, 128b RAM
MIDI_Device saves 680b flash, 328b RAM
HID_Device saves 816b flash, 408b RAM

In total 3.6K flash and 850b RAM.

Apps which manually try and build their own usage of the low-level
TinyUSB code need to include the appropriate <tusb-xxx.h> file.

Enable TinyUSB NCM (network) option

Expand MSDCbuffer to a full sector (512b).  Will speed up
FatFSUSB and SingleFileDrive without causing memory
pressure for apps not using MSD.

Update MSD examples with add'l delay:

There is what seems to be a known race condition in TinyUSB on the Pico,
see hathach/tinyusb#1764 .

Delay text output a little bit after the MSD is started to avoid.

Author: earlephilhower

cores/rp2040/sdkoverride/hid_device.c

@@ -0,0 +1,41 @@
+#include <stdint.h>
+#include <tusb.h>
+
+extern void hidd_init() __attribute__((weak));
+void hidd_init() {
+}
+
+extern bool hidd_deinit() __attribute__((weak));
+bool hidd_deinit() {
+    return true;
+}
+
+extern void hidd_reset(uint8_t rhport) __attribute__((weak));
+void hidd_reset(uint8_t rhport) {
+    (void) rhport;
+}
+
+extern uint16_t hidd_open(uint8_t rhport, const tusb_desc_interface_t* desc_itf, uint16_t max_len) __attribute__((weak));
+uint16_t hidd_open(uint8_t rhport, const tusb_desc_interface_t* desc_itf, uint16_t max_len) {
+    (void) rhport;
+    (void) desc_itf;
+    (void) max_len;
+    return 0;
+}
+
+extern bool hidd_control_xfer_cb(uint8_t rhport, uint8_t stage, const tusb_control_request_t* request) __attribute__((weak));
+bool hidd_control_xfer_cb(uint8_t rhport, uint8_t stage, const tusb_control_request_t* request) {
+    (void) rhport;
+    (void) stage;
+    (void) request;
+    return false;
+}
+
+extern bool hidd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) __attribute__((weak));
+bool hidd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) {
+    (void) rhport;
+    (void) ep_addr;
+    (void) result;
+    (void) xferred_bytes;
+    return false;
+}

cores/rp2040/sdkoverride/midi_device.c

@@ -0,0 +1,41 @@
+#include <stdint.h>
+#include <tusb.h>
+
+extern void midid_init() __attribute__((weak));
+void midid_init() {
+}
+
+extern bool midid_deinit() __attribute__((weak));
+bool midid_deinit() {
+    return true;
+}
+
+extern void midid_reset(uint8_t rhport) __attribute__((weak));
+void midid_reset(uint8_t rhport) {
+    (void) rhport;
+}
+
+extern uint16_t midid_open(uint8_t rhport, const tusb_desc_interface_t* desc_itf, uint16_t max_len) __attribute__((weak));
+uint16_t midid_open(uint8_t rhport, const tusb_desc_interface_t* desc_itf, uint16_t max_len) {
+    (void) rhport;
+    (void) desc_itf;
+    (void) max_len;
+    return 0;
+}
+
+extern bool midid_control_xfer_cb(uint8_t rhport, uint8_t stage, const tusb_control_request_t* request) __attribute__((weak));
+bool midid_control_xfer_cb(uint8_t rhport, uint8_t stage, const tusb_control_request_t* request) {
+    (void) rhport;
+    (void) stage;
+    (void) request;
+    return false;
+}
+
+extern bool midid_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) __attribute__((weak));
+bool midid_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) {
+    (void) rhport;
+    (void) ep_addr;
+    (void) result;
+    (void) xferred_bytes;
+    return false;
+}

cores/rp2040/sdkoverride/msc_device.c

@@ -0,0 +1,41 @@
+#include <stdint.h>
+#include <tusb.h>
+
+extern void mscd_init() __attribute__((weak));
+void mscd_init() {
+}
+
+extern bool mscd_deinit() __attribute__((weak));
+bool mscd_deinit() {
+    return true;
+}
+
+extern void mscd_reset(uint8_t rhport) __attribute__((weak));
+void mscd_reset(uint8_t rhport) {
+    (void) rhport;
+}
+
+extern uint16_t mscd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len) __attribute__((weak));
+uint16_t mscd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len) {
+    (void) rhport;
+    (void) itf_desc;
+    (void) max_len;
+    return 0;
+}
+
+extern bool mscd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request) __attribute__((weak));
+bool mscd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request) {
+    (void) rhport;
+    (void) stage;
+    (void) request;
+    return false;
+}
+
+bool mscd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes) __attribute__((weak));
+bool mscd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes) {
+    (void) rhport;
+    (void) ep_addr;
+    (void) event;
+    (void) xferred_bytes;
+    return false;
+}

cores/rp2040/sdkoverride/ncm_device.c

@@ -0,0 +1,41 @@
+#include <stdint.h>
+#include <tusb.h>
+
+extern void netd_init() __attribute__((weak));
+void netd_init() {
+}
+
+extern bool netd_deinit() __attribute__((weak));
+bool netd_deinit() {
+    return true;
+}
+
+extern void netd_reset(uint8_t rhport) __attribute__((weak));
+void netd_reset(uint8_t rhport) {
+    (void) rhport;
+}
+
+extern uint16_t netd_open(uint8_t rhport, const tusb_desc_interface_t* desc_itf, uint16_t max_len) __attribute__((weak));
+uint16_t netd_open(uint8_t rhport, const tusb_desc_interface_t* desc_itf, uint16_t max_len) {
+    (void) rhport;
+    (void) desc_itf;
+    (void) max_len;
+    return 0;
+}
+
+extern bool netd_control_xfer_cb(uint8_t rhport, uint8_t stage, const tusb_control_request_t* request) __attribute__((weak));
+bool netd_control_xfer_cb(uint8_t rhport, uint8_t stage, const tusb_control_request_t* request) {
+    (void) rhport;
+    (void) stage;
+    (void) request;
+    return false;
+}
+
+extern bool netd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) __attribute__((weak));
+bool netd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) {
+    (void) rhport;
+    (void) ep_addr;
+    (void) result;
+    (void) xferred_bytes;
+    return false;
+}

docs/usb.rst

@@ -102,6 +102,20 @@ to the polling period:
         ....
     }
 
+Native TinyUSB Sketches
+-----------------------
+Sketches or libraries which want to implement their own low-level TinyUSB
+callbacks need to include the appropriate header to have real TinyUSB driver
+support for HID, MSC (USB stick), MIDI, and NCM (network).
+
+.. code::  cpp
+
+    // Include one or more headers from the following list
+    #include <tusb-hid.h>
+    #include <tusb-midi.h>
+    #include <tush-msc.h>
+    #include <tusb-ncm.h>
+
 Adafruit TinyUSB Arduino Support
 --------------------------------
 Examples are provided in the Adafruit_TinyUSB_Arduino for the more

include/tusb_config.h

@@ -75,19 +75,42 @@
 #define CFG_TUD_MSC              (1)
 #define CFG_TUD_MIDI             (1)
 #define CFG_TUD_VENDOR           (0)
+#define CFG_TUD_NCM              (1)
 
 #define CFG_TUD_CDC_RX_BUFSIZE  (256)
 #define CFG_TUD_CDC_TX_BUFSIZE  (256)
 
 #define CFG_TUD_MSC_EP_BUFSIZE  (64)
 
 // HID buffer size Should be sufficient to hold ID (if any) + Data
-#define CFG_TUD_HID_EP_BUFSIZE  (64)
+#define CFG_TUD_HID_EP_BUFSIZE  (512)
 
 // MIDI
 #define CFG_TUD_MIDI_RX_BUFSIZE (64)
 #define CFG_TUD_MIDI_TX_BUFSIZE (64)
 
+//--------------------------------------------------------------------
+// NCM CLASS CONFIGURATION, SEE "ncm.h" FOR PERFORMANCE TUNING
+//--------------------------------------------------------------------
+#include "lwipopts.h"
+// Must be >> MTU
+// Can be set to 2048 without impact
+#define CFG_TUD_NCM_IN_NTB_MAX_SIZE (2 * TCP_MSS + 100)
+
+// Must be >> MTU
+// Can be set to smaller values if wNtbOutMaxDatagrams==1
+#define CFG_TUD_NCM_OUT_NTB_MAX_SIZE (2 * TCP_MSS + 100)
+
+// Number of NCM transfer blocks for reception side
+#ifndef CFG_TUD_NCM_OUT_NTB_N
+#define CFG_TUD_NCM_OUT_NTB_N 1
+#endif
+
+// Number of NCM transfer blocks for transmission side
+#ifndef CFG_TUD_NCM_IN_NTB_N
+#define CFG_TUD_NCM_IN_NTB_N 1
+#endif
+
 #ifdef __cplusplus
  }
 #endif

lib/rp2040/libpico.a

@@ -53,6 +53,7 @@ void setup() {
   FatFSUSB.driveReady(mountable);
   // Start FatFS USB drive mode
   FatFSUSB.begin();
+  delay(2000); // TinyUSB seems to have a race condition, see https://github.com/hathach/tinyusb/discussions/1764
   Serial.println("FatFSUSB started.");
   Serial.println("Connect drive via USB to upload/erase files and re-display");
 }