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.

Author: jimmo

drivers/cyw43/cywbt.c

@@ -31,13 +31,19 @@
 #include "py/mphal.h"
 #include "pin_static_af.h"
 #include "uart.h"
-#include "extmod/modbluetooth_hci.h"
+#include "extmod/mpbthci.h"
 
 #if MICROPY_PY_NETWORK_CYW43
 
 extern const char fw_4343WA1_7_45_98_50_start;
 #define CYWBT_FW_ADDR (&fw_4343WA1_7_45_98_50_start + 749 * 512 + 29 * 256)
 
+// Provided by the port.
+extern pyb_uart_obj_t mp_bluetooth_hci_uart_obj;
+
+// Provided by the port, and also possibly shared with the stack.
+extern uint8_t mp_bluetooth_hci_cmd_buf[4 + 256];
+
 /******************************************************************************/
 // CYW BT HCI low-level driver
 
@@ -168,10 +174,6 @@ int mp_bluetooth_hci_controller_init(void) {
     mp_hal_pin_config(pyb_pin_WL_GPIO_4, MP_HAL_PIN_MODE_OUTPUT, MP_HAL_PIN_PULL_NONE, 0); // RF-switch power
     mp_hal_pin_high(pyb_pin_WL_GPIO_4); // Turn the RF-switch on
 
-    return 0;
-}
-
-int mp_bluetooth_hci_controller_activate(void) {
     uint8_t buf[256];
 
     mp_hal_pin_low(pyb_pin_BT_REG_ON);
@@ -219,7 +221,7 @@ int mp_bluetooth_hci_controller_activate(void) {
     return 0;
 }
 
-int mp_bluetooth_hci_controller_deactivate(void) {
+int mp_bluetooth_hci_controller_deinit(void) {
     mp_hal_pin_low(pyb_pin_BT_REG_ON);
 
     return 0;

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 += \

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, ...

ports/stm32/btstack.c renamed to extmod/btstack/btstack_hci_uart.c

@@ -4,6 +4,7 @@
  * 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
@@ -31,12 +32,14 @@
 #if MICROPY_PY_BLUETOOTH && MICROPY_BLUETOOTH_BTSTACK
 
 #include "lib/btstack/src/btstack.h"
-#include "lib/btstack/platform/embedded/btstack_run_loop_embedded.h"
-#include "lib/btstack/platform/embedded/hal_cpu.h"
-#include "lib/btstack/platform/embedded/hal_time_ms.h"
 
-#include "extmod/modbluetooth_hci.h"
-#include "extmod/btstack/modbluetooth_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;
@@ -48,42 +51,29 @@ STATIC size_t recv_len;
 STATIC size_t recv_idx;
 STATIC void (*recv_handler)(void);
 
-// The IRQ functionality in btstack_run_loop_embedded.c is not used, so the
-// following three functions are empty.
-
-void hal_cpu_disable_irqs(void) {
-}
-
-void hal_cpu_enable_irqs(void) {
-}
-
-void hal_cpu_enable_irqs_and_sleep(void) {
-}
-
-uint32_t hal_time_ms(void) {
-    return mp_hal_ticks_ms();
-}
-
 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 periperhal.
-    mp_bluetooth_hci_uart_init(MICROPY_HW_BLE_UART_ID);
+    // 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) {
-    // Attach IRQ and power up the HCI controller.
-    mp_bluetooth_hci_uart_activate();
     return 0;
 }
 
 STATIC int btstack_uart_close(void) {
+    mp_bluetooth_hci_controller_deinit();
     return 0;
 }
 
@@ -101,10 +91,12 @@ STATIC int btstack_uart_set_baudrate(uint32_t baudrate) {
 }
 
 STATIC int btstack_uart_set_parity(int parity) {
+    (void)parity;
     return 0;
 }
 
 STATIC int btstack_uart_set_flowcontrol(int flowcontrol) {
+    (void)flowcontrol;
     return 0;
 }
 
@@ -123,14 +115,16 @@ STATIC int btstack_uart_get_supported_sleep_modes(void) {
 }
 
 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");
 }
 
-STATIC const btstack_uart_block_t btstack_uart_block = {
+const btstack_uart_block_t mp_bluetooth_btstack_hci_uart_block = {
     &btstack_uart_init,
     &btstack_uart_open,
     &btstack_uart_close,
@@ -146,15 +140,9 @@ STATIC const btstack_uart_block_t btstack_uart_block = {
     &btstack_uart_set_wakeup_handler,
 };
 
-STATIC const hci_transport_config_uart_t hci_transport_config_uart = {
-    HCI_TRANSPORT_CONFIG_UART,
-    MICROPY_HW_BLE_UART_BAUDRATE,
-    3000000,
-    0,
-    NULL,
-};
+void mp_bluetooth_btstack_hci_uart_process(void) {
+    bool host_wake = mp_bluetooth_hci_controller_woken();
 
-STATIC void btstack_uart_process(void) {
     if (send_done) {
         // If we'd done a TX in the last interval, notify btstack that it's complete.
         send_done = false;
@@ -176,48 +164,10 @@ STATIC void btstack_uart_process(void) {
             }
         }
     }
-}
-
-void mp_bluetooth_hci_poll(void) {
-    if (mp_bluetooth_btstack_state == MP_BLUETOOTH_BTSTACK_STATE_OFF) {
-        return;
-    }
 
-    // Process uart data.
-    bool host_wake = mp_bluetooth_hci_controller_woken();
-    btstack_uart_process();
     if (host_wake) {
         mp_bluetooth_hci_controller_sleep_maybe();
     }
-
-    // Call the BTstack run loop.
-    btstack_run_loop_embedded_execute_once();
-}
-
-void mp_bluetooth_btstack_port_init(void) {
-    static bool run_loop_init = false;
-    if (!run_loop_init) {
-        run_loop_init = true;
-        btstack_run_loop_init(btstack_run_loop_embedded_get_instance());
-    } else {
-        btstack_run_loop_embedded_get_instance()->init();
-    }
-
-    // hci_dump_open(NULL, HCI_DUMP_STDOUT);
-    const hci_transport_t *transport = hci_transport_h4_instance(&btstack_uart_block);
-    hci_init(transport, &hci_transport_config_uart);
-
-    // TODO: Probably not necessary for BCM (we have our own firmware loader),
-    // but might be worth investigating for other controllers in the future.
-    // hci_set_chipset(btstack_chipset_bcm_instance());
-}
-
-void mp_bluetooth_btstack_port_deinit(void) {
-    hci_power_control(HCI_POWER_OFF);
-}
-
-void mp_bluetooth_btstack_port_start(void) {
-    hci_power_control(HCI_POWER_ON);
 }
 
 #endif // MICROPY_PY_BLUETOOTH && MICROPY_BLUETOOTH_BTSTACK

extmod/nimble/nimble/nimble_hci_uart.h renamed to extmod/btstack/btstack_hci_uart.h

@@ -3,7 +3,8 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (c) 2019 Damien P. George
+ * 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
@@ -23,18 +24,16 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
-#ifndef MICROPY_INCLUDED_EXTMOD_NIMBLE_NIMBLE_NIMBLE_HCI_UART_H
-#define MICROPY_INCLUDED_EXTMOD_NIMBLE_NIMBLE_NIMBLE_HCI_UART_H
 
-// Extensions to extmod/modbluetooth_hci.h specific to NimBLE.
+#ifndef MICROPY_INCLUDED_EXTMOD_BTSTACK_HCI_UART_H
+#define MICROPY_INCLUDED_EXTMOD_BTSTACK_HCI_UART_H
 
-#include "extmod/nimble/hal/hal_uart.h"
+#include "lib/btstack/src/btstack.h"
 
-// Helpers called from ports.
-void mp_bluetooth_nimble_hci_uart_process(void);
+// --- Used by the port to create the HCI transport ---------------------------
+extern const btstack_uart_block_t mp_bluetooth_btstack_hci_uart_block;
 
-// Must be provided by the port.
-void mp_bluetooth_nimble_hci_uart_rx(hal_uart_rx_cb_t rx_cb, void *rx_arg);
-void mp_bluetooth_nimble_hci_uart_tx_strn(const char *str, uint len);
+// --- Called by the MicroPython port when UART data is available -------------
+void mp_bluetooth_btstack_hci_uart_process(void);
 
-#endif // MICROPY_INCLUDED_EXTMOD_NIMBLE_NIMBLE_NIMBLE_HCI_UART_H
+#endif // MICROPY_INCLUDED_EXTMOD_BTSTACK_MODBLUETOOTH_BTSTACK_H

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;

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,
 };
 

extmod/mpbthci.c

@@ -0,0 +1,38 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * 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.
+ */
+
+// Default definitions in case a controller doesn't implement this.
+
+#include "py/mphal.h"
+
+#if MICROPY_PY_BLUETOOTH
+
+#define DEBUG_printf(...) // printf(__VA_ARGS__)
+
+#include "extmod/mpbthci.h"
+
+
+#endif // MICROPY_PY_BLUETOOTH

extmod/modbluetooth_hci.h renamed to extmod/mpbthci.h

@@ -24,15 +24,15 @@
  * THE SOFTWARE.
  */
 
-#ifndef MICROPY_INCLUDED_EXTMOD_MODBLUETOOTH_HCI_H
-#define MICROPY_INCLUDED_EXTMOD_MODBLUETOOTH_HCI_H
+#ifndef MICROPY_INCLUDED_EXTMOD_MPBTHCI_H
+#define MICROPY_INCLUDED_EXTMOD_MPBTHCI_H
 
-#include "uart.h"
+// --- Optionally can be implemented by the driver. ---------------------------
 
-// Optionally can be implemented by the driver.
+// Start/stop the HCI controller.
+// Requires the UART to this HCI controller is available.
 int mp_bluetooth_hci_controller_init(void);
-int mp_bluetooth_hci_controller_activate(void);
-int mp_bluetooth_hci_controller_deactivate(void);
+int mp_bluetooth_hci_controller_deinit(void);
 
 // Tell the controller to go to sleep (e.g. on RX if we don't think we're expecting anything more).
 int mp_bluetooth_hci_controller_sleep_maybe(void);
@@ -41,16 +41,11 @@ bool mp_bluetooth_hci_controller_woken(void);
 // Wake up the controller (e.g. we're about to TX).
 int mp_bluetooth_hci_controller_wakeup(void);
 
-// Storage and bindings that need to be implemented by the port.
-// These are used by the stack bindings (e.g. nimble/hal_uart.c)
-// as well as potentially the driver (e.g. cywbt.c).
-extern uint8_t mp_bluetooth_hci_cmd_buf[4 + 256];
-extern pyb_uart_obj_t mp_bluetooth_hci_uart_obj;
-
-int mp_bluetooth_hci_uart_init(uint32_t port);
-int mp_bluetooth_hci_uart_activate(void);
+// --- Bindings that need to be implemented by the port. ----------------------
+int mp_bluetooth_hci_uart_init(uint32_t port, uint32_t baudrate);
+int mp_bluetooth_hci_uart_deinit(void);
 int mp_bluetooth_hci_uart_set_baudrate(uint32_t baudrate);
 int mp_bluetooth_hci_uart_readchar(void);
 int mp_bluetooth_hci_uart_write(const uint8_t *buf, size_t len);
 
-#endif // MICROPY_INCLUDED_EXTMOD_MODBLUETOOTH_HCI_H
+#endif // MICROPY_INCLUDED_EXTMOD_MPBTHCI_H