rename USBDevice to TinyUSBDevice to avoid name conflict

hathach · hathach · commit 4224cac62189 · 2021-07-16T14:24:48.000+07:00
USBDevice is alias for compatible when USE_TINYUSB is defined
diff --git a/examples/Composite/hid_generic_inout_ramdisk/hid_generic_inout_ramdisk.ino b/examples/Composite/hid_generic_inout_ramdisk/hid_generic_inout_ramdisk.ino
@@ -68,9 +68,9 @@ void setup()
   usb_hid.begin();
 
   Serial.begin(115200);
-  Serial.println("Waiting for USBDevice mount");
+  Serial.println("Waiting for TinyUSBDevice mount");
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 
   Serial.println("Adafruit TinyUSB HID Generic In Out example");
 }
diff --git a/examples/Composite/mouse_external_flash/mouse_external_flash.ino b/examples/Composite/mouse_external_flash/mouse_external_flash.ino
@@ -114,7 +114,7 @@ void loop()
   uint32_t const btn = (digitalRead(pin) == activeState);
 
   // Remote wakeup
-  if ( USBDevice.suspended() && btn )
+  if ( TinyUSBDevice.suspended() && btn )
   {
     // Wake up host if we are in suspend mode
     // and REMOTE_WAKEUP feature is enabled by host
diff --git a/examples/Composite/mouse_ramdisk/mouse_ramdisk.ino b/examples/Composite/mouse_ramdisk/mouse_ramdisk.ino
@@ -66,7 +66,7 @@ void setup()
   usb_hid.begin();
 
   Serial.begin(115200);
-  while( !USBDevice.mounted() ) delay(1);   // wait for native usb
+  while( !TinyUSBDevice.mounted() ) delay(1);   // wait for native usb
 
   Serial.println("Adafruit TinyUSB Mouse + Mass Storage (ramdisk) example");
 }
@@ -80,7 +80,7 @@ void loop()
   uint32_t const btn = (digitalRead(pin) == activeState);
 
   // Remote wakeup
-  if ( USBDevice.suspended() && btn )
+  if ( TinyUSBDevice.suspended() && btn )
   {
     // Wake up host if we are in suspend mode
     // and REMOTE_WAKEUP feature is enabled by host
diff --git a/examples/HID/hid_composite/hid_composite.ino b/examples/HID/hid_composite/hid_composite.ino
@@ -66,7 +66,7 @@ void setup()
   Serial.println("Adafruit TinyUSB HID Composite example");
 
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 }
 
 void loop()
@@ -78,11 +78,11 @@ void loop()
   bool btn_pressed = (digitalRead(pin) == activeState);
 
   // Remote wakeup
-  if ( USBDevice.suspended() && btn_pressed )
+  if ( TinyUSBDevice.suspended() && btn_pressed )
   {
     // Wake up host if we are in suspend mode
     // and REMOTE_WAKEUP feature is enabled by host
-    USBDevice.remoteWakeup();
+    TinyUSBDevice.remoteWakeup();
   }
 
   /*------------- Mouse -------------*/
diff --git a/examples/HID/hid_composite_joy_featherwing/hid_composite_joy_featherwing.ino b/examples/HID/hid_composite_joy_featherwing/hid_composite_joy_featherwing.ino
@@ -77,7 +77,7 @@ void setup()
   last_x = ss.analogRead(3);
 
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 }
 
 void loop()
@@ -145,10 +145,10 @@ void loop()
 
   /*------------- Remote Wakeup -------------*/
   // Remote wakeup if PC is suspended and we has user interaction with joy feather wing
-  if ( has_action && USBDevice.suspended() )
+  if ( has_action && TinyUSBDevice.suspended() )
   {
     // Wake up only works if REMOTE_WAKEUP feature is enable by host
     // Usually this is the case with Mouse/Keyboard device
-    USBDevice.remoteWakeup();
+    TinyUSBDevice.remoteWakeup();
   }
 }
diff --git a/examples/HID/hid_gamepad/hid_gamepad.ino b/examples/HID/hid_gamepad/hid_gamepad.ino
@@ -44,19 +44,19 @@ void setup()
   usb_hid.begin();
 
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
   
   Serial.println("Adafruit TinyUSB HID Gamepad example");
 }
 
 void loop() 
 { 
 //  // Remote wakeup
-//  if ( USBDevice.suspended() && btn )
+//  if ( TinyUSBDevice.suspended() && btn )
 //  {
 //    // Wake up host if we are in suspend mode
 //    // and REMOTE_WAKEUP feature is enabled by host
-//    USBDevice.remoteWakeup();
+//    TinyUSBDevice.remoteWakeup();
 //  }
 
   if ( !usb_hid.ready() ) return;
diff --git a/examples/HID/hid_generic_inout/hid_generic_inout.ino b/examples/HID/hid_generic_inout/hid_generic_inout.ino
@@ -52,7 +52,7 @@ void setup()
   Serial.begin(115200);
 
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 
   Serial.println("Adafruit TinyUSB HID Generic In Out example");
 }
diff --git a/examples/HID/hid_keyboard/hid_keyboard.ino b/examples/HID/hid_keyboard/hid_keyboard.ino
@@ -58,7 +58,7 @@ void setup()
   }
 
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 }
 
 
@@ -68,11 +68,11 @@ void loop()
   delay(2);
 
 //  // Remote wakeup
-//  if ( USBDevice.suspended() && btn )
+//  if ( TinyUSBDevice.suspended() && btn )
 //  {
 //    // Wake up host if we are in suspend mode
 //    // and REMOTE_WAKEUP feature is enabled by host
-//    USBDevice.remoteWakeup();
+//    TinyUSBDevice.remoteWakeup();
 //  }
 
   if ( !usb_hid.ready() ) return;
diff --git a/examples/HID/hid_mouse/hid_mouse.ino b/examples/HID/hid_mouse/hid_mouse.ino
@@ -55,7 +55,7 @@ void setup()
   Serial.begin(115200);
 
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 
   Serial.println("Adafruit TinyUSB HID Mouse example");
 }
@@ -72,11 +72,11 @@ void loop()
   if (!btn_pressed) return;
 
   // Remote wakeup
-  if ( USBDevice.suspended() )
+  if ( TinyUSBDevice.suspended() )
   {
     // Wake up host if we are in suspend mode
     // and REMOTE_WAKEUP feature is enabled by host
-    USBDevice.remoteWakeup();
+    TinyUSBDevice.remoteWakeup();
   }
 
   if ( usb_hid.ready() )
diff --git a/examples/MIDI/midi_pizza_box_dj/midi_pizza_box_dj.ino b/examples/MIDI/midi_pizza_box_dj/midi_pizza_box_dj.ino
@@ -94,7 +94,7 @@ void setup() {
   for(uint8_t i=0; i<FRAMES; i++) lvl[i] = 256;
 
   // Wait until device is enumerated properly before sending MIDI message
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 }
 
 ///////////////////////////////////////////////////////////////////////////////
diff --git a/examples/MIDI/midi_test/midi_test.ino b/examples/MIDI/midi_test/midi_test.ino
@@ -56,7 +56,7 @@ void setup()
   Serial.begin(115200);
 
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 }
 
 void loop()
diff --git a/examples/WebUSB/webusb_rgb/webusb_rgb.ino b/examples/WebUSB/webusb_rgb/webusb_rgb.ino
@@ -68,7 +68,7 @@ void setup()
   pixels.show();
 
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 
   Serial.println("TinyUSB WebUSB RGB example");
 }
diff --git a/examples/WebUSB/webusb_serial/webusb_serial.ino b/examples/WebUSB/webusb_serial/webusb_serial.ino
@@ -49,7 +49,7 @@ void setup()
   Serial.begin(115200);
 
   // wait until device mounted
-  while( !USBDevice.mounted() ) delay(1);
+  while( !TinyUSBDevice.mounted() ) delay(1);
 
   Serial.println("TinyUSB WebUSB Serial example");
 }
diff --git a/src/Adafruit_TinyUSB.h b/src/Adafruit_TinyUSB.h
@@ -45,7 +45,7 @@
 #include "arduino/webusb/Adafruit_USBD_WebUSB.h"
 
 // Initialize device hardware, stack, also Serial as CDC
-// Wrapper for USBDevice.begin(rhport)
+// Wrapper for TinyUSBDevice.begin(rhport)
 void TinyUSB_Device_Init(uint8_t rhport);
 
 #endif
diff --git a/src/arduino/Adafruit_TinyUSB_API.cpp b/src/arduino/Adafruit_TinyUSB_API.cpp
@@ -35,7 +35,7 @@ extern "C" {
 
 void TinyUSB_Device_Init(uint8_t rhport) {
   // Init USB Device controller and stack
-  USBDevice.begin(rhport);
+  TinyUSBDevice.begin(rhport);
 }
 
 // RP2040 has its own implementation since it needs mutex for dual core
diff --git a/src/arduino/Adafruit_USBD_CDC.cpp b/src/arduino/Adafruit_USBD_CDC.cpp
@@ -78,7 +78,7 @@ void Adafruit_USBD_CDC::begin(uint32_t baud) {
 
   _instance = _instance_count++;
   this->setStringDescriptor("TinyUSB Serial");
-  USBDevice.addInterface(*this);
+  TinyUSBDevice.addInterface(*this);
 }
 
 void Adafruit_USBD_CDC::begin(uint32_t baud, uint8_t config) {
@@ -88,7 +88,7 @@ void Adafruit_USBD_CDC::begin(uint32_t baud, uint8_t config) {
 
 void Adafruit_USBD_CDC::end(void) {
   // Reset configuration descriptor without Serial as CDC
-  USBDevice.clearConfiguration();
+  TinyUSBDevice.clearConfiguration();
   _instance_count = 0;
 }
 
diff --git a/src/arduino/Adafruit_USBD_Device.cpp b/src/arduino/Adafruit_USBD_Device.cpp
@@ -60,7 +60,7 @@
 
 enum { STRID_LANGUAGE = 0, STRID_MANUFACTURER, STRID_PRODUCT, STRID_SERIAL };
 
-Adafruit_USBD_Device USBDevice;
+Adafruit_USBD_Device TinyUSBDevice;
 
 Adafruit_USBD_Device::Adafruit_USBD_Device(void) {}
 
@@ -291,15 +291,15 @@ extern "C" {
 // Invoked when received GET DEVICE DESCRIPTOR
 // Application return pointer to descriptor
 uint8_t const *tud_descriptor_device_cb(void) {
-  return (uint8_t const *)&USBDevice._desc_device;
+  return (uint8_t const *)&TinyUSBDevice._desc_device;
 }
 
 // Invoked when received GET CONFIGURATION DESCRIPTOR
 // Application return pointer to descriptor, whose contents must exist long
 // enough for transfer to complete
 uint8_t const *tud_descriptor_configuration_cb(uint8_t index) {
   (void)index;
-  return USBDevice._desc_cfg;
+  return TinyUSBDevice._desc_cfg;
 }
 
 // Invoked when received GET STRING DESCRIPTOR request
@@ -308,7 +308,7 @@ uint8_t const *tud_descriptor_configuration_cb(uint8_t index) {
 // OS 1.0 Descriptors.
 // https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/microsoft-defined-usb-descriptors
 uint16_t const *tud_descriptor_string_cb(uint8_t index, uint16_t langid) {
-  return USBDevice.descriptor_string_cb(index, langid);
+  return TinyUSBDevice.descriptor_string_cb(index, langid);
 }
 
 } // extern C
diff --git a/src/arduino/Adafruit_USBD_Device.h b/src/arduino/Adafruit_USBD_Device.h
@@ -107,6 +107,12 @@ class Adafruit_USBD_Device {
                                                   uint16_t langid);
 };
 
-extern Adafruit_USBD_Device USBDevice;
+extern Adafruit_USBD_Device TinyUSBDevice;
+
+// USBDevice has a high chance to conflict with other usb stack
+// only define if supported BSP
+#ifdef USE_TINYUSB
+#define USBDevice  TinyUSBDevice
+#endif
 
 #endif /* ADAFRUIT_USBD_DEVICE_H_ */
diff --git a/src/arduino/hid/Adafruit_USBD_HID.cpp b/src/arduino/hid/Adafruit_USBD_HID.cpp
@@ -108,7 +108,7 @@ uint16_t Adafruit_USBD_HID::getInterfaceDescriptor(uint8_t itfnum, uint8_t *buf,
 }
 
 bool Adafruit_USBD_HID::begin(void) {
-  if (!USBDevice.addInterface(*this)) {
+  if (!TinyUSBDevice.addInterface(*this)) {
     return false;
   }
 
diff --git a/src/arduino/midi/Adafruit_USBD_MIDI.cpp b/src/arduino/midi/Adafruit_USBD_MIDI.cpp
@@ -40,7 +40,7 @@ Adafruit_USBD_MIDI::Adafruit_USBD_MIDI(void) : _n_cables(1) {}
 void Adafruit_USBD_MIDI::setCables(uint8_t n_cables) { _n_cables = n_cables; }
 
 bool Adafruit_USBD_MIDI::begin(void) {
-  if (!USBDevice.addInterface(*this))
+  if (!TinyUSBDevice.addInterface(*this))
     return false;
 
   return true;
diff --git a/src/arduino/msc/Adafruit_USBD_MSC.cpp b/src/arduino/msc/Adafruit_USBD_MSC.cpp
@@ -87,7 +87,7 @@ void Adafruit_USBD_MSC::setReadyCallback(uint8_t lun, ready_callback_t cb) {
 }
 
 bool Adafruit_USBD_MSC::begin(void) {
-  if (!USBDevice.addInterface(*this)) {
+  if (!TinyUSBDevice.addInterface(*this)) {
     return false;
   }
 
diff --git a/src/arduino/webusb/Adafruit_USBD_WebUSB.cpp b/src/arduino/webusb/Adafruit_USBD_WebUSB.cpp
@@ -127,11 +127,11 @@ Adafruit_USBD_WebUSB::Adafruit_USBD_WebUSB(void) {
 }
 
 bool Adafruit_USBD_WebUSB::begin(void) {
-  if (!USBDevice.addInterface(*this))
+  if (!TinyUSBDevice.addInterface(*this))
     return false;
 
   // WebUSB requires to change USB version from 2.0 to 2.1
-  USBDevice.setVersion(0x0210);
+  TinyUSBDevice.setVersion(0x0210);
 
   _webusb_dev = this;
   return true;

Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ void loop()`
`114`	`114`	`uint32_t const btn = (digitalRead(pin) == activeState);`
`115`	`115`
`116`	`116`	`// Remote wakeup`
`117`		`- if ( USBDevice.suspended() && btn )`
	`117`	`+ if ( TinyUSBDevice.suspended() && btn )`
`118`	`118`	`{`
`119`	`119`	`// Wake up host if we are in suspend mode`
`120`	`120`	`// and REMOTE_WAKEUP feature is enabled by host`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ void setup()`
`66`	`66`	`usb_hid.begin();`
`67`	`67`
`68`	`68`	`Serial.begin(115200);`
`69`		`- while( !USBDevice.mounted() ) delay(1); // wait for native usb`
	`69`	`+ while( !TinyUSBDevice.mounted() ) delay(1); // wait for native usb`
`70`	`70`
`71`	`71`	`Serial.println("Adafruit TinyUSB Mouse + Mass Storage (ramdisk) example");`
`72`	`72`	`}`
`@@ -80,7 +80,7 @@ void loop()`
`80`	`80`	`uint32_t const btn = (digitalRead(pin) == activeState);`
`81`	`81`
`82`	`82`	`// Remote wakeup`
`83`		`- if ( USBDevice.suspended() && btn )`
	`83`	`+ if ( TinyUSBDevice.suspended() && btn )`
`84`	`84`	`{`
`85`	`85`	`// Wake up host if we are in suspend mode`
`86`	`86`	`// and REMOTE_WAKEUP feature is enabled by host`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ void setup()`
`77`	`77`	`last_x = ss.analogRead(3);`
`78`	`78`
`79`	`79`	`// wait until device mounted`
`80`		`- while( !USBDevice.mounted() ) delay(1);`
	`80`	`+ while( !TinyUSBDevice.mounted() ) delay(1);`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`void loop()`
`@@ -145,10 +145,10 @@ void loop()`
`145`	`145`
`146`	`146`	`/------------- Remote Wakeup -------------/`
`147`	`147`	`// Remote wakeup if PC is suspended and we has user interaction with joy feather wing`
`148`		`- if ( has_action && USBDevice.suspended() )`
	`148`	`+ if ( has_action && TinyUSBDevice.suspended() )`
`149`	`149`	`{`
`150`	`150`	`// Wake up only works if REMOTE_WAKEUP feature is enable by host`
`151`	`151`	`// Usually this is the case with Mouse/Keyboard device`
`152`		`- USBDevice.remoteWakeup();`
	`152`	`+ TinyUSBDevice.remoteWakeup();`
`153`	`153`	`}`
`154`	`154`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ void setup()`
`52`	`52`	`Serial.begin(115200);`
`53`	`53`
`54`	`54`	`// wait until device mounted`
`55`		`- while( !USBDevice.mounted() ) delay(1);`
	`55`	`+ while( !TinyUSBDevice.mounted() ) delay(1);`
`56`	`56`
`57`	`57`	`Serial.println("Adafruit TinyUSB HID Generic In Out example");`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ void setup()`
`55`	`55`	`Serial.begin(115200);`
`56`	`56`
`57`	`57`	`// wait until device mounted`
`58`		`- while( !USBDevice.mounted() ) delay(1);`
	`58`	`+ while( !TinyUSBDevice.mounted() ) delay(1);`
`59`	`59`
`60`	`60`	`Serial.println("Adafruit TinyUSB HID Mouse example");`
`61`	`61`	`}`
`@@ -72,11 +72,11 @@ void loop()`
`72`	`72`	`if (!btn_pressed) return;`
`73`	`73`
`74`	`74`	`// Remote wakeup`
`75`		`- if ( USBDevice.suspended() )`
	`75`	`+ if ( TinyUSBDevice.suspended() )`
`76`	`76`	`{`
`77`	`77`	`// Wake up host if we are in suspend mode`
`78`	`78`	`// and REMOTE_WAKEUP feature is enabled by host`
`79`		`- USBDevice.remoteWakeup();`
	`79`	`+ TinyUSBDevice.remoteWakeup();`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`if ( usb_hid.ready() )`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ void setup() {`
`94`	`94`	`for(uint8_t i=0; i<FRAMES; i++) lvl[i] = 256;`
`95`	`95`
`96`	`96`	`// Wait until device is enumerated properly before sending MIDI message`
`97`		`- while( !USBDevice.mounted() ) delay(1);`
	`97`	`+ while( !TinyUSBDevice.mounted() ) delay(1);`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`///////////////////////////////////////////////////////////////////////////////`