Merge pull request #126 from adafruit/support-esp32-2.0

Add support for ESP32-S2 arduino core version 2.0.0

Author: hathach

.github/workflows/githubci.yml

@@ -9,6 +9,10 @@ jobs:
       fail-fast: false
       matrix:
         arduino-platform:
+           # ESP32S2
+           - 'funhouse'
+           - 'magtag'
+           - 'metroesp32s2'
            # nRF52
            - 'cpb'
            - 'nrf52840'

README.md

@@ -21,11 +21,14 @@ There are 2 type of supported cores: with and without built-in support for TinyU
 
 ### Cores with built-in support
 
-Following core has Tinyusb as either the primary usb stack or selectable via menu `Tools->USB Stack`. You only need to include `<Adafruit_TinyUSB.h>` in your sketch to use.
+Following core has TinyUSB as either the primary usb stack or selectable via menu `Tools->USB Stack`. You only need to include `<Adafruit_TinyUSB.h>` in your sketch to use.
 
-- [Adafruit_nRF52_Arduino](https://github.com/adafruit/Adafruit_nRF52_Arduino)
+- [adafruit/Adafruit_nRF52_Arduino](https://github.com/adafruit/Adafruit_nRF52_Arduino)
 - [adafruit/ArduinoCore-samd](https://github.com/adafruit/ArduinoCore-samd)
 - [earlephilhower/arduino-pico](https://github.com/earlephilhower/arduino-pico)
+- [espressif/arduino-esp32](https://github.com/espressif/arduino-esp32)
+
+  ESP32 port relies on Espressif's [esp32-hal-tinyusb.c](https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/esp32-hal-tinyusb.c) for building usb descriptors which requires all descriptors must be specified in usb objects declaration i.e constructors. Therefore all descriptor-related fields must be part of object declaration and descriptor-related API have no effect afterwards for this port. 
 
 ### Cores without built-in support
 

changelog.md

@@ -1,5 +1,12 @@
 # Adafruit TinyUSB Arduino Library Changelog
 
+## 1.5.0 - 2021.09.29
+
+- Add support for ESP32-S2 core version 2.0.0
+  - ESP32 port relies on Espressif's [esp32-hal-tinyusb.c](https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/esp32-hal-tinyusb.c) for building usb descriptors which requires all descriptors must be specified in usb objects declaration i.e constructors. Therefore all descriptor-related fields must be part of object declaration and descriptor-related API have no effect afterwards for this port.
+
+- Add new constructor for Adafruit_USBD_HID(desc_report, len, protocol, interval_ms, has_out_endpoint)
+
 ## 1.4.4 - 2021.08.18
 
 - Update tinyusb stack

examples/MassStorage/msc_sd/.metroesp32s2_tinyusb.test.skip renamed to examples/CDC/cdc_multi/.funhouse.test.skip

@@ -19,6 +19,10 @@
 #include "Adafruit_SPIFlash.h"
 #include "Adafruit_TinyUSB.h"
 
+//--------------------------------------------------------------------+
+// MSC External Flash Config
+//--------------------------------------------------------------------+
+
 // Uncomment to run example with FRAM
 // #define FRAM_CS   A5
 // #define FRAM_SPI  SPI
@@ -51,26 +55,39 @@ Adafruit_SPIFlash flash(&flashTransport);
 
 Adafruit_USBD_MSC usb_msc;
 
+//--------------------------------------------------------------------+
+// HID Config
+//--------------------------------------------------------------------+
+
 // HID report descriptor using TinyUSB's template
 // Single Report (no ID) descriptor
 uint8_t const desc_hid_report[] =
 {
   TUD_HID_REPORT_DESC_MOUSE()
 };
 
-Adafruit_USBD_HID usb_hid;
+// USB HID object. For ESP32 these values cannot be changed after this declaration
+// desc report, desc len, protocol, interval, use out endpoint
+Adafruit_USBD_HID usb_hid(desc_hid_report, sizeof(desc_hid_report), HID_ITF_PROTOCOL_NONE, 2, false);
 
-#if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS
+#if defined(ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS) || defined(ARDUINO_NRF52840_CIRCUITPLAY)
   const int pin = 4; // Left Button
   bool activeState = true;
-#elif defined ARDUINO_NRF52840_FEATHER
-  const int pin = 7; // UserSw
+
+#elif defined(ARDUINO_FUNHOUSE_ESP32S2)
+  const int pin = BUTTON_DOWN;
+  bool activeState = true;
+
+#elif defined PIN_BUTTON1
+  const int pin = PIN_BUTTON1;
   bool activeState = false;
+
 #else
   const int pin = 12;
   bool activeState = false;
 #endif
 
+
 // the setup function runs once when you press reset or power the board
 void setup()
 {
@@ -92,11 +109,12 @@ void setup()
 
   usb_msc.begin();
 
-
   // Set up button
   pinMode(pin, activeState ? INPUT_PULLDOWN : INPUT_PULLUP);
 
-  usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+  // Notes: following commented-out functions has no affect on ESP32
+  // usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+
   usb_hid.begin();
 
   Serial.begin(115200);

examples/CDC/cdc_multi/.magtag.test.skip

@@ -16,25 +16,40 @@
 
 #include "Adafruit_TinyUSB.h"
 
+//--------------------------------------------------------------------+
+// MSC RAM Disk Config
+//--------------------------------------------------------------------+
+
 // 8KB is the smallest size that windows allow to mount
 #define DISK_BLOCK_NUM  16
 #define DISK_BLOCK_SIZE 512
 #include "ramdisk.h"
 
+Adafruit_USBD_MSC usb_msc;
+
+//--------------------------------------------------------------------+
+// HID Config
+//--------------------------------------------------------------------+
+
 // HID report descriptor using TinyUSB's template
 // Single Report (no ID) descriptor
 uint8_t const desc_hid_report[] =
 {
   TUD_HID_REPORT_DESC_MOUSE()
 };
 
-Adafruit_USBD_HID usb_hid;
-Adafruit_USBD_MSC usb_msc;
+// USB HID object. For ESP32 these values cannot be changed after this declaration
+// desc report, desc len, protocol, interval, use out endpoint
+Adafruit_USBD_HID usb_hid(desc_hid_report, sizeof(desc_hid_report), HID_ITF_PROTOCOL_NONE, 2, false);
 
-#if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS || defined ARDUINO_NRF52840_CIRCUITPLAY
+#if defined(ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS) || defined(ARDUINO_NRF52840_CIRCUITPLAY)
   const int pin = 4; // Left Button
   bool activeState = true;
 
+#elif defined(ARDUINO_FUNHOUSE_ESP32S2)
+  const int pin = BUTTON_DOWN;
+  bool activeState = true;
+
 #elif defined PIN_BUTTON1
   const int pin = PIN_BUTTON1;
   bool activeState = false;
@@ -69,7 +84,9 @@ void setup()
   // Set up button
   pinMode(pin, activeState ? INPUT_PULLDOWN : INPUT_PULLUP);
 
-  usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+  // Notes: following commented-out functions has no affect on ESP32
+  // usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+
   usb_hid.begin();
 
   Serial.begin(115200);

examples/CDC/cdc_multi/.metroesp32s2.test.skip

@@ -10,11 +10,12 @@
 *********************************************************************/
 
 #include "Adafruit_TinyUSB.h"
+#include <Adafruit_NeoPixel.h>
 
 /* This sketch demonstrates USB HID keyboard.
  * - PIN A0-A5 is used to send digit '0' to '5' respectively
  *   (On the RP2040, pins D0-D5 used)
- * - LED will be used as Caplock indicator
+ * - LED and/or Neopixels will be used as Capslock indicator
  */
 
 // HID report descriptor using TinyUSB's template
@@ -24,20 +25,46 @@ uint8_t const desc_hid_report[] =
   TUD_HID_REPORT_DESC_KEYBOARD()
 };
 
-Adafruit_USBD_HID usb_hid;
+// USB HID object. For ESP32 these values cannot be changed after this declaration
+// desc report, desc len, protocol, interval, use out endpoint
+Adafruit_USBD_HID usb_hid(desc_hid_report, sizeof(desc_hid_report), HID_ITF_PROTOCOL_KEYBOARD, 2, false);
 
-// Array of pins and its keycode
-// For keycode definition see BLEHidGeneric.h
+//------------- Input Pins -------------//
+// Array of pins and its keycode.
+// Notes: these pins can be replaced by PIN_BUTTONn if defined in setup()
 #ifdef ARDUINO_ARCH_RP2040
-  uint8_t pins[]    = { D0, D1, D2, D3, D4, D5 };
+  uint8_t pins[] = { D0, D1, D2, D3 };
 #else
-  uint8_t pins[]    = { A0, A1, A2, A3, A4, A5 };
+  uint8_t pins[] = { A0, A1, A2, A3 };
 #endif
 
-uint8_t hidcode[] = { HID_KEY_ARROW_RIGHT, HID_KEY_ARROW_LEFT, HID_KEY_ARROW_DOWN, HID_KEY_ARROW_UP , HID_KEY_4, HID_KEY_5 };
-
+// number of pins
 uint8_t pincount = sizeof(pins)/sizeof(pins[0]);
 
+// For keycode definition check out https://github.com/hathach/tinyusb/blob/master/src/class/hid/hid.h
+uint8_t hidcode[] = { HID_KEY_ARROW_RIGHT, HID_KEY_ARROW_LEFT, HID_KEY_ARROW_DOWN, HID_KEY_ARROW_UP };
+
+#if defined(ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS) || defined(ARDUINO_NRF52840_CIRCUITPLAY) || defined(ARDUINO_FUNHOUSE_ESP32S2)
+  bool activeState = true;
+#else
+  bool activeState = false;
+#endif
+
+//------------- Neopixel -------------//
+// #define PIN_NEOPIXEL  8
+#ifdef PIN_NEOPIXEL
+
+// How many NeoPixels are attached to the Arduino?
+// use on-board defined NEOPIXEL_NUM if existed
+#ifndef NEOPIXEL_NUM
+  #define NEOPIXEL_NUM  10
+#endif
+
+Adafruit_NeoPixel pixels = Adafruit_NeoPixel(NEOPIXEL_NUM, PIN_NEOPIXEL, NEO_GRB + NEO_KHZ800);
+
+#endif
+
+
 // the setup function runs once when you press reset or power the board
 void setup()
 {
@@ -46,22 +73,53 @@ void setup()
   TinyUSB_Device_Init(0);
 #endif
 
-  usb_hid.setBootProtocol(HID_ITF_PROTOCOL_KEYBOARD);
-  usb_hid.setPollInterval(2);
-  usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+  // Notes: following commented-out functions has no affect on ESP32
+  // usb_hid.setBootProtocol(HID_ITF_PROTOCOL_KEYBOARD);
+  // usb_hid.setPollInterval(2);
+  // usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+  // usb_hid.setStringDescriptor("TinyUSB Keyboard");
+
+  // Set up output report (on control endpoint) for Capslock indicator
   usb_hid.setReportCallback(NULL, hid_report_callback);
-  //usb_hid.setStringDescriptor("TinyUSB Keyboard");
 
   usb_hid.begin();
 
   // led pin
   pinMode(LED_BUILTIN, OUTPUT);
   digitalWrite(LED_BUILTIN, LOW);
 
+  // neopixel if existed
+#ifdef PIN_NEOPIXEL
+  pixels.begin();
+  pixels.setBrightness(50);
+
+  #ifdef NEOPIXEL_POWER
+  pinMode(NEOPIXEL_POWER, OUTPUT);
+  digitalWrite(NEOPIXEL_POWER, NEOPIXEL_POWER_ON);
+  #endif
+#endif
+
+  // overwrite input pin with PIN_BUTTONx
+#ifdef PIN_BUTTON1
+  pins[0] = PIN_BUTTON1;
+#endif
+
+#ifdef PIN_BUTTON2
+  pins[1] = PIN_BUTTON2;
+#endif
+
+#ifdef PIN_BUTTON3
+  pins[2] = PIN_BUTTON3;
+#endif
+
+#ifdef PIN_BUTTON4
+  pins[3] = PIN_BUTTON4;
+#endif
+
   // Set up pin as input
   for (uint8_t i=0; i<pincount; i++)
   {
-    pinMode(pins[i], INPUT_PULLUP);
+    pinMode(pins[i], activeState ? INPUT_PULLDOWN : INPUT_PULLUP);
   }
 
   // wait until device mounted
@@ -83,7 +141,7 @@ void loop()
   // scan normal key and send report
   for(uint8_t i=0; i < pincount; i++)
   {
-    if ( 0 == digitalRead(pins[i]) )
+    if ( activeState == digitalRead(pins[i]) )
     {
       // if pin is active (low), add its hid code to key report
       keycode[count++] = hidcode[i];
@@ -129,13 +187,19 @@ void hid_report_callback(uint8_t report_id, hid_report_type_t report_type, uint8
 {
   (void) report_id;
   (void) bufsize;
+
   // LED indicator is output report with only 1 byte length
   if ( report_type != HID_REPORT_TYPE_OUTPUT ) return;
 
   // The LED bit map is as follows: (also defined by KEYBOARD_LED_* )
   // Kana (4) | Compose (3) | ScrollLock (2) | CapsLock (1) | Numlock (0)
   uint8_t ledIndicator = buffer[0];
 
-  // turn on LED if caplock is set
+  // turn on LED if capslock is set
   digitalWrite(LED_BUILTIN, ledIndicator & KEYBOARD_LED_CAPSLOCK);
+
+#ifdef PIN_NEOPIXEL
+  pixels.fill(ledIndicator & KEYBOARD_LED_CAPSLOCK ? 0xff0000 : 0x000000);
+  pixels.show();
+#endif
 }

examples/CDC/no_serial/.funhouse.test.skip

@@ -18,10 +18,14 @@
  * Depending on the board, the button pin
  * and its active state (when pressed) are different
  */
-#if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS || defined ARDUINO_NRF52840_CIRCUITPLAY
+#if defined(ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS) || defined(ARDUINO_NRF52840_CIRCUITPLAY)
   const int pin = 4; // Left Button
   bool activeState = true;
 
+#elif defined(ARDUINO_FUNHOUSE_ESP32S2)
+  const int pin = BUTTON_DOWN;
+  bool activeState = true;
+
 #elif defined PIN_BUTTON1
   const int pin = PIN_BUTTON1;
   bool activeState = false;
@@ -39,8 +43,9 @@ uint8_t const desc_hid_report[] =
   TUD_HID_REPORT_DESC_MOUSE()
 };
 
-// USB HID object
-Adafruit_USBD_HID usb_hid;
+// USB HID object. For ESP32 these values cannot be changed after this declaration
+// desc report, desc len, protocol, interval, use out endpoint
+Adafruit_USBD_HID usb_hid(desc_hid_report, sizeof(desc_hid_report), HID_ITF_PROTOCOL_MOUSE, 2, false);
 
 // the setup function runs once when you press reset or power the board
 void setup()
@@ -53,10 +58,11 @@ void setup()
   // Set up button, pullup opposite to active state
   pinMode(pin, activeState ? INPUT_PULLDOWN : INPUT_PULLUP);
 
-  usb_hid.setBootProtocol(HID_ITF_PROTOCOL_MOUSE);
-  usb_hid.setPollInterval(2);
-  usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
-  //usb_hid.setStringDescriptor("TinyUSB Mouse");
+  // Notes: following commented-out functions has no affect on ESP32
+  // usb_hid.setBootProtocol(HID_ITF_PROTOCOL_MOUSE);
+  // usb_hid.setPollInterval(2);
+  // usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+  // usb_hid.setStringDescriptor("TinyUSB Mouse");
 
   usb_hid.begin();