Finished BLE support for arduino-esp32 3.3.0

Author: tttapa

doxygen/pages/MIDI-over-BLE.md

@@ -26,8 +26,8 @@ backend for the particular board.
 | Arduino GIGA R1 WiFi                | @ref ArduinoBLEBackend     |                          |
 | Raspberry Pi Pico W (RP2040)        | @ref BTstackBackgroundBackend |                       |
 | ESP32                               | @ref ESP32BluedroidBackend | @ref ESP32NimBLEBackend  |
-| ESP32-S3                            | @ref ESP32BluedroidBackend | @ref ESP32NimBLEBackend  |
-| ESP32-C3, ESP32-C6, ESP32-H2        | @ref ESP32BluedroidBackend | @ref ESP32NimBLEBackend  |
+| ESP32-S3                            | @ref ESP32NimBLEBackend | @ref ESP32BluedroidBackend  |
+| ESP32-C3, ESP32-C6, ESP32-H2        | @ref ESP32NimBLEBackend | @ref ESP32BluedroidBackend  |
 
 ### ArduinoBLEBackend
 
@@ -56,13 +56,17 @@ buffer from filling up, since there is no BLE flow control.
 ### ESP32NimBLEBackend
 
 This backend uses the newer [Apache MyNewt NimBLE](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/bluetooth/nimble/index.html)
-stack.
+stack. Starting from version 3.3.0 of the [arduino-esp32](https://github.com/espressif/arduino-esp32) core,
+it is the default for the ESP32-S3 and other ESP32-based boards except the
+original ESP32 (which still uses Bluedroid).
+See https://github.com/espressif/arduino-esp32/discussions/10991 for details.
 
 Like the @ref ESP32BluedroidBackend, the NimBLE backend uses its own threads and
 does not require polling.
 
-The NimBLE ESP-IDF component is disabled by default in the [arduino-esp32](https://github.com/espressif/arduino-esp32)
-core, so you'll need to install the [h2zero/NimBLE-Arduino](https://github.com/h2zero/NimBLE-Arduino)
+If you're using a version of the arduino-esp32 core that's older than 3.3.0,
+or if you're using an original ESP32, the NimBLE ESP-IDF component is disabled,
+and you'll need to install the [h2zero/NimBLE-Arduino](https://github.com/h2zero/NimBLE-Arduino)
 library in order to use this backend.
 
 Defining @ref CS_USE_NIMBLE before including Control Surface changes the default

examples/3. MIDI Interfaces/BLEMIDI-Adapter/BLEMIDI-Adapter.ino

@@ -11,6 +11,9 @@
  * - If you're using an ESP32, you can optionally switch to the NimBLE backend
  *     by installing the [h2zero/NimBLE-Arduino](https://github.com/h2zero/NimBLE-Arduino)
  *     library, and adding `#define CS_USE_NIMBLE` at the top of this sketch.
+ * - If you're using a newer ESP32-based chip like the ESP32-S3, with
+ *     arduino-esp32 version 3.3.0 or later, the NimBLE backend is enabled by
+ *     default, without requiring the h2zero/NimBLE-Arduino library.
  * - If you're not using a Pico or an ESP32, you'll have to install the
  *     [ArduinoBLE](https://github.com/arduino-libraries/ArduinoBLE) library.
  *

src/MIDI_Interfaces/BLEMIDI/ESP32-NimBLE/ble.h

@@ -8,5 +8,7 @@
 #define CS_MIDI_BLE_ESP_IDF_NIMBLE 1
 #else
 #include <nimconfig.h>
+#pragma message(                                                               \
+    "arduino-esp32 installation does not include NimBLE. Using https://github.com/h2zero/NimBLE-Arduino as a fallback")
 #define CS_MIDI_BLE_ESP_IDF_NIMBLE 0
 #endif

src/MIDI_Interfaces/BLEMIDI/ESP32-NimBLE/events.ipp

@@ -24,8 +24,13 @@ namespace {
 [[maybe_unused]] std::string fmt_address(const void *addr) {
     std::string str {"XX:XX:XX:XX:XX:XX"};
     auto *u8p = reinterpret_cast<const uint8_t *>(addr);
-    snprintf(str.data(), str.size() + 1, "%02x:%02x:%02x:%02x:%02x:%02x",
-             u8p[5], u8p[4], u8p[3], u8p[2], u8p[1], u8p[0]);
+#if __cplusplus >= 201703L
+    auto *buf = str.data();
+#else
+    auto *buf = &str[0];
+#endif
+    snprintf(buf, str.size() + 1, "%02x:%02x:%02x:%02x:%02x:%02x", u8p[5],
+             u8p[4], u8p[3], u8p[2], u8p[1], u8p[0]);
     return str;
 }
 
@@ -49,7 +54,7 @@ void print_conn_desc(struct ble_gap_conn_desc *desc) {
         desc->sec_state.bonded);
 }
 
-const char *own_address_type_to_string(uint8_t own_addr_type) {
+[[maybe_unused]] const char *own_address_type_to_string(uint8_t own_addr_type) {
     switch (own_addr_type) {
         case BLE_OWN_ADDR_RANDOM: return "BLE_OWN_ADDR_RANDOM";
         case BLE_OWN_ADDR_RPA_RANDOM_DEFAULT:

src/MIDI_Interfaces/BLEMIDI/ESP32-NimBLE/gatt.c.ipp

@@ -43,7 +43,11 @@ inline const struct ble_gatt_chr_def midi_ble_characteristic[] = {
               BLE_GATT_CHR_F_WRITE_NO_RSP | // BLE_GATT_CHR_F_WRITE_ENC |
               BLE_GATT_CHR_F_NOTIFY,
      .min_key_size = 0,
-     .val_handle = nullptr},
+     .val_handle = nullptr,
+#ifdef BLE_GATT_DSC_CLT_PRE_FMT16 // https://github.com/apache/mynewt-nimble/pull/1667
+     .cpfd = nullptr
+#endif
+    },
     {}, // sentinel
 };
 

src/MIDI_Interfaces/BLEMIDI/ESP32-NimBLE/init.ipp

@@ -11,8 +11,11 @@
 #include <nimble/porting/nimble/include/nimble/nimble_port.h>
 #endif
 #ifdef ESP_PLATFORM
+#ifndef CONFIG_IDF_TARGET_ESP32P4
 #include <esp_bt.h>
+#endif
 #include <nvs_flash.h>
+#include <soc/soc_caps.h>
 #endif
 
 #include "ble-macro-fix.h"
@@ -21,8 +24,11 @@
 namespace cs::midi_ble_nimble {
 
 inline bool init_hardware() {
+#if CS_MIDI_BLE_ESP_IDF_NIMBLE
+    CS_CHECK_ESP(nimble_port_init());
+#else // fall back to the h2zero/NimBLE-Arduino library
 #ifdef ESP_PLATFORM
-#ifdef CONFIG_ENABLE_ARDUINO_DEPENDS
+#if defined(CONFIG_ENABLE_ARDUINO_DEPENDS) && SOC_BT_SUPPORTED
     // make sure the linker includes esp32-hal-bt.c so Arduino init doesn't release BLE memory.
     btStarted();
 #endif
@@ -33,26 +39,27 @@ inline bool init_hardware() {
         nvs_flash_init_rc = nvs_flash_init();
     }
     ESP_ERROR_CHECK(nvs_flash_init_rc);
-
     esp_bt_controller_config_t bt_cfg = BT_CONTROLLER_INIT_CONFIG_DEFAULT();
-#if defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32S3)
-    bt_cfg.bluetooth_mode = ESP_BT_MODE_BLE;
-#else
+#if defined(CONFIG_IDF_TARGET_ESP32)
     bt_cfg.mode = ESP_BT_MODE_BLE;
+    bt_cfg.ble_max_conn = CONFIG_BT_NIMBLE_MAX_CONNECTIONS;
+#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32S3)
+    bt_cfg.ble_max_act = CONFIG_BT_NIMBLE_MAX_CONNECTIONS;
+#else
+    bt_cfg.nimble_max_connections = CONFIG_BT_NIMBLE_MAX_CONNECTIONS;
 #endif
+#if CONFIG_IDF_TARGET_ESP32
     ESP_ERROR_CHECK(esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT));
+#endif
     ESP_ERROR_CHECK(esp_bt_controller_init(&bt_cfg));
     ESP_ERROR_CHECK(esp_bt_controller_enable(ESP_BT_MODE_BLE));
-    #if ESP_ARDUINO_VERSION < ESP_ARDUINO_VERSION_VAL(3, 3, 0)
+#if CONFIG_BT_NIMBLE_LEGACY_VHCI_ENABLE
     ESP_ERROR_CHECK(esp_nimble_hci_init());
-    #endif
 #endif
-
-#if CS_MIDI_BLE_ESP_IDF_NIMBLE
-    CS_CHECK_ESP(nimble_port_init());
-#else
-    nimble_port_init();
 #endif
+    nimble_port_init();
+#endif // #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
+
     return true;
 }