extmod/modbluetooth: Refactor stack/hci/driver/port bindings.

Previously the interaction between the different layers of the Bluetooth
stack was different on each port and each stack.  This commit defines
common interfaces between them and implements them for cyw43, btstack,
nimble, stm32, unix.

6 files changed, 230 insertions, 0 deletions

diff --git a/extmod/btstack/btstack.mk b/extmod/btstack/btstack.mk
index dd96e6337..3084601b8 100644
--- a/extmod/btstack/btstack.mk
+++ b/extmod/btstack/btstack.mk
@@ -38,6 +38,17 @@ CFLAGS  += $(shell pkg-config libusb-1.0 --cflags)
 LDFLAGS += $(shell pkg-config libusb-1.0 --libs)
 endif
 
+ifeq ($(MICROPY_BLUETOOTH_BTSTACK_H4),1)
+SRC_BTSTACK += \
+	lib/btstack/src/hci_transport_h4.c \
+	lib/btstack/chipset/zephyr/btstack_chipset_zephyr.c
+
+EXTMOD_SRC_C += \
+	extmod/btstack/btstack_hci_uart.c \
+
+CFLAGS_MOD += -DMICROPY_BLUETOOTH_BTSTACK_H4=1
+endif
+
 ifeq ($(MICROPY_BLUETOOTH_BTSTACK_ENABLE_CLASSIC),1)
 include $(BTSTACK_DIR)/src/classic/Makefile.inc
 SRC_BTSTACK += \
diff --git a/extmod/btstack/btstack_config.h b/extmod/btstack/btstack_config.h
index f420f47a5..e56a84f94 100644
--- a/extmod/btstack/btstack_config.h
+++ b/extmod/btstack/btstack_config.h
@@ -8,6 +8,7 @@
 // #define ENABLE_CLASSIC
 #define ENABLE_LE_DATA_CHANNELS
 // #define ENABLE_LOG_INFO
+// #define ENABLE_LOG_DEBUG
 #define ENABLE_LOG_ERROR
 
 // BTstack configuration. buffers, sizes, ...
diff --git a/extmod/btstack/btstack_hci_uart.c b/extmod/btstack/btstack_hci_uart.c
new file mode 100644
index 000000000..5c96e02dc
--- /dev/null
+++ b/extmod/btstack/btstack_hci_uart.c
@@ -0,0 +1,173 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Damien P. George
+ * Copyright (c) 2020 Jim Mussared
+ *
+ * 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 "py/runtime.h"
+#include "py/mperrno.h"
+#include "py/mphal.h"
+
+#if MICROPY_PY_BLUETOOTH && MICROPY_BLUETOOTH_BTSTACK
+
+#include "lib/btstack/src/btstack.h"
+
+#include "extmod/mpbthci.h"
+#include "extmod/btstack/btstack_hci_uart.h"
+
+#include "mpbtstackport.h"
+
+// Implements a btstack btstack_uart_block_t on top of the mphciuart.h
+// interface to an HCI UART provided by the port.
+
+// We pass the bytes directly to the UART during a send, but then notify btstack in the next poll.
+STATIC bool send_done;
+STATIC void (*send_handler)(void);
+
+// btstack issues a read of len bytes, and gives us a buffer to asynchronously fill up.
+STATIC uint8_t *recv_buf;
+STATIC size_t recv_len;
+STATIC size_t recv_idx;
+STATIC void (*recv_handler)(void);
+
+STATIC int btstack_uart_init(const btstack_uart_config_t *uart_config) {
+    (void)uart_config;
+
+    send_done = false;
+    recv_len = 0;
+    recv_idx = 0;
+    recv_handler = NULL;
+    send_handler = NULL;
+
+    // Set up the UART peripheral, attach IRQ and power up the HCI controller.
+    // We haven't been told the baud rate yet, so defer that until btstack_uart_set_baudrate.
+    mp_bluetooth_hci_uart_init(MICROPY_HW_BLE_UART_ID, 0);
+    mp_bluetooth_hci_controller_init();
+
+    return 0;
+}
+
+STATIC int btstack_uart_open(void) {
+    return 0;
+}
+
+STATIC int btstack_uart_close(void) {
+    mp_bluetooth_hci_controller_deinit();
+    return 0;
+}
+
+STATIC void btstack_uart_set_block_received(void (*block_handler)(void)) {
+    recv_handler = block_handler;
+}
+
+STATIC void btstack_uart_set_block_sent(void (*block_handler)(void)) {
+    send_handler = block_handler;
+}
+
+STATIC int btstack_uart_set_baudrate(uint32_t baudrate) {
+    mp_bluetooth_hci_uart_set_baudrate(baudrate);
+    return 0;
+}
+
+STATIC int btstack_uart_set_parity(int parity) {
+    (void)parity;
+    return 0;
+}
+
+STATIC int btstack_uart_set_flowcontrol(int flowcontrol) {
+    (void)flowcontrol;
+    return 0;
+}
+
+STATIC void btstack_uart_receive_block(uint8_t *buf, uint16_t len) {
+    recv_buf = buf;
+    recv_len = len;
+}
+
+STATIC void btstack_uart_send_block(const uint8_t *buf, uint16_t len) {
+    mp_bluetooth_hci_uart_write(buf, len);
+    send_done = true;
+}
+
+STATIC int btstack_uart_get_supported_sleep_modes(void) {
+    return 0;
+}
+
+STATIC void btstack_uart_set_sleep(btstack_uart_sleep_mode_t sleep_mode) {
+    (void)sleep_mode;
+    // printf("btstack_uart_set_sleep %u\n", sleep_mode);
+}
+
+STATIC void btstack_uart_set_wakeup_handler(void (*wakeup_handler)(void)) {
+    (void)wakeup_handler;
+    // printf("btstack_uart_set_wakeup_handler\n");
+}
+
+const btstack_uart_block_t mp_bluetooth_btstack_hci_uart_block = {
+    &btstack_uart_init,
+    &btstack_uart_open,
+    &btstack_uart_close,
+    &btstack_uart_set_block_received,
+    &btstack_uart_set_block_sent,
+    &btstack_uart_set_baudrate,
+    &btstack_uart_set_parity,
+    &btstack_uart_set_flowcontrol,
+    &btstack_uart_receive_block,
+    &btstack_uart_send_block,
+    &btstack_uart_get_supported_sleep_modes,
+    &btstack_uart_set_sleep,
+    &btstack_uart_set_wakeup_handler,
+};
+
+void mp_bluetooth_btstack_hci_uart_process(void) {
+    bool host_wake = mp_bluetooth_hci_controller_woken();
+
+    if (send_done) {
+        // If we'd done a TX in the last interval, notify btstack that it's complete.
+        send_done = false;
+        if (send_handler) {
+            send_handler();
+        }
+    }
+
+    // Append any new bytes to the recv buffer, notifying bstack if we've got
+    // the number of bytes it was looking for.
+    int chr;
+    while (recv_idx < recv_len && (chr = mp_bluetooth_hci_uart_readchar()) >= 0) {
+        recv_buf[recv_idx++] = chr;
+        if (recv_idx == recv_len) {
+            recv_idx = 0;
+            recv_len = 0;
+            if (recv_handler) {
+                recv_handler();
+            }
+        }
+    }
+
+    if (host_wake) {
+        mp_bluetooth_hci_controller_sleep_maybe();
+    }
+}
+
+#endif // MICROPY_PY_BLUETOOTH && MICROPY_BLUETOOTH_BTSTACK
diff --git a/extmod/btstack/btstack_hci_uart.h b/extmod/btstack/btstack_hci_uart.h
new file mode 100644
index 000000000..8011e587d
--- /dev/null
+++ b/extmod/btstack/btstack_hci_uart.h
@@ -0,0 +1,39 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Damien P. George
+ * Copyright (c) 2020 Jim Mussared
+ *
+ * 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 MICROPY_INCLUDED_EXTMOD_BTSTACK_HCI_UART_H
+#define MICROPY_INCLUDED_EXTMOD_BTSTACK_HCI_UART_H
+
+#include "lib/btstack/src/btstack.h"
+
+// --- Used by the port to create the HCI transport ---------------------------
+extern const btstack_uart_block_t mp_bluetooth_btstack_hci_uart_block;
+
+// --- Called by the MicroPython port when UART data is available -------------
+void mp_bluetooth_btstack_hci_uart_process(void);
+
+#endif // MICROPY_INCLUDED_EXTMOD_BTSTACK_MODBLUETOOTH_BTSTACK_H
diff --git a/extmod/btstack/modbluetooth_btstack.c b/extmod/btstack/modbluetooth_btstack.c
index 9aef7e687..03ec12b73 100644
--- a/extmod/btstack/modbluetooth_btstack.c
+++ b/extmod/btstack/modbluetooth_btstack.c
@@ -53,6 +53,8 @@ STATIC const uint16_t BTSTACK_GAP_DEVICE_NAME_HANDLE = 3;
 
 volatile int mp_bluetooth_btstack_state = MP_BLUETOOTH_BTSTACK_STATE_OFF;
 
+#define ERRNO_BLUETOOTH_NOT_ACTIVE MP_ENODEV
+
 STATIC int btstack_error_to_errno(int err) {
     DEBUG_printf("  --> btstack error: %d\n", err);
     if (err == ERROR_CODE_SUCCESS) {
@@ -300,6 +302,9 @@ STATIC void btstack_packet_handler(uint8_t packet_type, uint8_t *packet, uint8_t
         if (state == HCI_STATE_WORKING) {
             // Signal that initialisation has completed.
             mp_bluetooth_btstack_state = MP_BLUETOOTH_BTSTACK_STATE_ACTIVE;
+        } else if (state == HCI_STATE_HALTING) {
+            // Signal that de-initialisation has begun.
+            mp_bluetooth_btstack_state = MP_BLUETOOTH_BTSTACK_STATE_HALTING;
         } else if (state == HCI_STATE_OFF) {
             // Signal that de-initialisation has completed.
             mp_bluetooth_btstack_state = MP_BLUETOOTH_BTSTACK_STATE_OFF;
diff --git a/extmod/btstack/modbluetooth_btstack.h b/extmod/btstack/modbluetooth_btstack.h
index 2fad86f22..7890bbfae 100644
--- a/extmod/btstack/modbluetooth_btstack.h
+++ b/extmod/btstack/modbluetooth_btstack.h
@@ -56,6 +56,7 @@ enum {
     MP_BLUETOOTH_BTSTACK_STATE_OFF,
     MP_BLUETOOTH_BTSTACK_STATE_STARTING,
     MP_BLUETOOTH_BTSTACK_STATE_ACTIVE,
+    MP_BLUETOOTH_BTSTACK_STATE_HALTING,
     MP_BLUETOOTH_BTSTACK_STATE_TIMEOUT,
 };