adding host support for rp2040

Author: hathach

examples/DualRole/device_info_rp2040/.feather_rp2040_tinyusb.test.only

@@ -0,0 +1,88 @@
+/*********************************************************************
+ Adafruit invests time and resources providing this open source code,
+ please support Adafruit and open-source hardware by purchasing
+ products from Adafruit!
+
+ MIT license, check LICENSE for more information
+ Copyright (c) 2019 Ha Thach for Adafruit Industries
+ All text above, and the splash screen below must be included in
+ any redistribution
+*********************************************************************/
+
+// pio-usb is required for rp2040 host
+#include "pio_usb.h"
+#define HOST_PIN_DP   2   // Pin used as D+ for host, D- = D+ + 1
+
+#include "Adafruit_TinyUSB.h"
+
+// USB Host object
+Adafruit_USBH_Host USBHost;
+
+// the setup function runs once when you press reset or power the board
+void setup()
+{
+  Serial1.begin(115200);
+
+  Serial.begin(115200);
+  //while ( !Serial ) delay(10);   // wait for native usb
+
+  Serial.println("TinyUSB Dual Device Info Example");
+
+  // Check for CPU frequency, must be multiple of 120Mhz for bit-banging USB
+  uint32_t cpu_hz = clock_get_hz(clk_sys);
+  if ( cpu_hz != 120000000UL && cpu_hz != 240000000UL ) {
+    while ( !Serial ) delay(10);   // wait for native usb
+    Serial.printf("Error: CPU Clock = %u, PIO USB require CPU clock must be multiple of 120 Mhz\r\n", cpu_hz);
+    Serial.printf("Change your CPU Clock to either 120 or 240 Mhz in Menu->CPU Speed \r\n", cpu_hz);
+    while(1) delay(1);
+  }
+
+  pio_usb_configuration_t pio_cfg = PIO_USB_DEFAULT_CONFIG;
+  pio_cfg.pin_dp = HOST_PIN_DP;
+  USBHost.configure_pio_usb(1, &pio_cfg);
+
+  // run host stack on controller (rhport) 1
+  // Note: For rp2040 pico-pio-usb, calling USBHost.begin() on core1 will have most of the
+  // host bit-banging processing works done in core1 to free up core0 for other works
+  USBHost.begin(1);
+}
+
+void loop()
+{
+  USBHost.task();
+}
+
+#if 0
+
+// core1's setup
+void setup1() {
+  //while ( !Serial ) delay(10);   // wait for native usb
+  Serial.println("Core1 setup to run TinyUSB host with pio-usb");
+
+  // Check for CPU frequency, must be multiple of 120Mhz for bit-banging USB
+  uint32_t cpu_hz = clock_get_hz(clk_sys);
+  if ( cpu_hz != 120000000UL && cpu_hz != 240000000UL ) {
+    while ( !Serial ) delay(10);   // wait for native usb
+    Serial.printf("Error: CPU Clock = %u, PIO USB require CPU clock must be multiple of 120 Mhz\r\n", cpu_hz);
+    Serial.printf("Change your CPU Clock to either 120 or 240 Mhz in Menu->CPU Speed \r\n", cpu_hz);
+    while(1) delay(1);
+  }
+
+  pio_usb_configuration_t pio_cfg = PIO_USB_DEFAULT_CONFIG;
+  pio_cfg.pin_dp = HOST_PIN_DP;
+  USBHost.configure_pio_usb(1, &pio_cfg);
+
+  // run host stack on controller (rhport) 1
+  // Note: For rp2040 pico-pio-usb, calling USBHost.begin() on core1 will have most of the
+  // host bit-banging processing works done in core1 to free up core0 for other works
+  USBHost.begin(1);
+}
+
+// core1's loop
+void loop1()
+{
+  USBHost.task();
+}
+
+#endif
+

examples/DualRole/device_info_rp2040/device_info_rp2040.ino

@@ -33,9 +33,9 @@
 
 #include "tusb_option.h"
 
+// Device
 #if TUSB_OPT_DEVICE_ENABLED
 
-
 #include "arduino/Adafruit_USBD_Device.h"
 #if CFG_TUD_CDC
   #include "arduino/Adafruit_USBD_CDC.h"
@@ -60,4 +60,11 @@ void TinyUSB_Device_Init(uint8_t rhport);
 
 #endif
 
+// Host
+#if CFG_TUH_ENABLED
+
+#include "arduino/Adafruit_USBH_Host.h"
+
+#endif
+
 #endif /* ADAFRUIT_TINYUSB_H_ */

src/Adafruit_TinyUSB.h

@@ -0,0 +1,80 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022, Ha Thach (tinyusb.org) for Adafruit
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "tusb_option.h"
+
+#if CFG_TUH_ENABLED
+
+#include "Adafruit_TinyUSB_API.h"
+#include "Adafruit_USBH_Host.h"
+
+Adafruit_USBH_Host::Adafruit_USBH_Host(void)
+{
+
+}
+
+bool Adafruit_USBH_Host::configure(uint8_t rhport, uint32_t cfg_id, const void* cfg_param)
+{
+  return tuh_configure(rhport, cfg_id, cfg_param);
+}
+
+#ifdef ARDUINO_ARCH_RP2040
+bool Adafruit_USBH_Host::configure_pio_usb(uint8_t rhport, const void* cfg_param)
+{
+  return configure(rhport, TUH_CFGID_RPI_PIO_USB_CONFIGURATION, cfg_param);
+}
+#endif
+
+bool Adafruit_USBH_Host::begin(uint8_t rhport)
+{
+  return tuh_init(rhport);
+}
+
+void Adafruit_USBH_Host::task(void)
+{
+  tuh_task();
+}
+
+// Invoked when device with hid interface is mounted
+// Report descriptor is also available for use. tuh_hid_parse_report_descriptor()
+// can be used to parse common/simple enough descriptor.
+// Note: if report descriptor length > CFG_TUH_ENUMERATION_BUFSIZE, it will be skipped
+// therefore report_desc = NULL, desc_len = 0
+void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* desc_report, uint16_t desc_len)
+{
+  (void)desc_report;
+  (void)desc_len;
+}
+
+// Invoked when device with hid interface is un-mounted
+void tuh_hid_umount_cb(uint8_t dev_addr, uint8_t instance)
+{
+}
+
+// Invoked when received report from device via interrupt endpoint
+void tuh_hid_report_received_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* report, uint16_t len)
+{
+  (void) len;
+}
+#endif

src/arduino/Adafruit_USBH_Host.cpp

@@ -0,0 +1,67 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef ADAFRUIT_USBH_HOST_H_
+#define ADAFRUIT_USBH_HOST_H_
+
+#include "Adafruit_USBD_Interface.h"
+#include "tusb.h"
+
+#ifdef ARDUINO_ARCH_ESP32
+#include "esp32-hal-tinyusb.h"
+#endif
+
+class Adafruit_USBH_Host {
+private:
+
+public:
+  Adafruit_USBH_Host(void);
+
+  bool configure(uint8_t rhport, uint32_t cfg_id, const void* cfg_param);
+
+#ifdef ARDUINO_ARCH_RP2040
+  bool configure_pio_usb(uint8_t rhport, const void* cfg_param);
+#endif
+
+  bool begin(uint8_t rhport);
+  void task(void);
+
+private:
+//  uint16_t const *descrip`tor_string_cb(uint8_t index, uint16_t langid);
+//
+//  friend uint8_t const *tud_descriptor_device_cb(void);
+//  friend uint8_t const *tud_descriptor_configuration_cb(uint8_t index);
+//  friend uint16_t const *tud_descriptor_string_cb(uint8_t index,
+//                                                  uint16_t langid);
+};
+
+//extern Adafruit_USBH_Host TinyUSBHost;
+//
+//// USBHost has a high chance to conflict with other usb stack
+//// only define if supported BSP
+//#ifdef USE_TINYUSB
+//#define USBHost TinyUSBHost
+//#endif
+
+#endif /* ADAFRUIT_USBH_HOST_H_ */

src/arduino/Adafruit_USBH_Host.h

@@ -149,6 +149,21 @@ void TinyUSB_Device_Task(void) {
     mutex_exit(&__usb_mutex);
   }
 }
+
+// Debug log with Serial1
+#if CFG_TUSB_DEBUG
+int serial1_printf(const char *__restrict format, ...) {
+  char buf[256];
+  int len;
+  va_list ap;
+  va_start(ap, format);
+  len = vsnprintf(buf, sizeof(buf), format, ap);
+  Serial1.write(buf);
+  va_end(ap);
+  return len;
+}
+#endif
+
 }
 
 #endif

src/arduino/ports/rp2040/Adafruit_TinyUSB_rp2040.cpp

@@ -34,32 +34,40 @@ extern "C" {
 //--------------------------------------------------------------------
 #define CFG_TUSB_RHPORT0_MODE OPT_MODE_DEVICE
 
+// Enable device stack
+#define CFG_TUD_ENABLED     1
+
+// Enable host stack with pio-usb if Pico-PIO-USB library is available
+#if __has_include("pio_usb.h")
+#define CFG_TUH_ENABLED     1
+#define CFG_TUH_RPI_PIO_USB 1
+#endif
+
 #ifndef CFG_TUSB_MCU
 #define CFG_TUSB_MCU OPT_MCU_RP2040
 #endif
 #define CFG_TUSB_OS OPT_OS_PICO
 
-#define CFG_TUSB_DEBUG 0
-//#if CFG_TUSB_DEBUG
-//  #define tu_printf                 serial1_printf
-//  extern int serial1_printf(const char *__restrict __format, ...);
-//#endif
+#define CFG_TUSB_DEBUG 2
+#if CFG_TUSB_DEBUG
+  #define CFG_TUSB_DEBUG_PRINTF    serial1_printf
+  extern int serial1_printf(const char *__restrict __format, ...);
+#endif
 
 #define CFG_TUSB_MEM_SECTION
-#define CFG_TUSB_MEM_ALIGN TU_ATTR_ALIGNED(4)
+#define CFG_TUSB_MEM_ALIGN    TU_ATTR_ALIGNED(4)
 
 //--------------------------------------------------------------------
-// DEVICE CONFIGURATION
+// Device Configuration
 //--------------------------------------------------------------------
 
 #define CFG_TUD_ENDOINT0_SIZE 64
 
-//------------- CLASS -------------//
-#define CFG_TUD_CDC 1
-#define CFG_TUD_MSC 1
-#define CFG_TUD_HID 1
-#define CFG_TUD_MIDI 1
-#define CFG_TUD_VENDOR 1
+#define CFG_TUD_CDC     1
+#define CFG_TUD_MSC     1
+#define CFG_TUD_HID     1
+#define CFG_TUD_MIDI    1
+#define CFG_TUD_VENDOR  1
 
 // CDC FIFO size of TX and RX
 #define CFG_TUD_CDC_RX_BUFSIZE 256
@@ -79,6 +87,19 @@ extern "C" {
 #define CFG_TUD_VENDOR_RX_BUFSIZE 64
 #define CFG_TUD_VENDOR_TX_BUFSIZE 64
 
+//--------------------------------------------------------------------
+// Host Configuration
+//--------------------------------------------------------------------
+
+// Size of buffer to hold descriptors and other data used for enumeration
+#define CFG_TUH_ENUMERATION_BUFSIZE 256
+
+#define CFG_TUH_HUB                 1
+// max device support (excluding hub device)
+#define CFG_TUH_DEVICE_MAX          (CFG_TUH_HUB ? 4 : 1) // hub typically has 4 ports
+
+#define CFG_TUH_HID                  4
+
 #ifdef __cplusplus
 }
 #endif

src/arduino/ports/rp2040/tusb_config_rp2040.h

@@ -52,11 +52,9 @@ void USB_Handler(void) { tud_int_handler(0); }
 
 #endif
 
-} // extern C
-
 // Debug log with Serial1
 #if CFG_TUSB_DEBUG
-extern "C" int serial1_printf(const char *__restrict format, ...) {
+int serial1_printf(const char *__restrict format, ...) {
   char buf[256];
   int len;
   va_list ap;
@@ -68,6 +66,8 @@ extern "C" int serial1_printf(const char *__restrict format, ...) {
 }
 #endif
 
+} // extern C
+
 //--------------------------------------------------------------------+
 // Porting API
 //--------------------------------------------------------------------+