8000 extmod/modbluetooth: Add timeout to deinit. · micropython/micropython@d5f2fc2 · GitHub
[go: up one dir, main page]
Skip to content

Commit d5f2fc2

Browse files
pi-anldpgeorge
pi-anl
authored and
dpgeorge
committed
extmod/modbluetooth: Add timeout to deinit.
If the BLE radio stops responding before deinit is called the function can get stuck waiting for an event that is never received, particularly if the radio is external or on a separate core. This commit adds a timeout, similar to the timeout already used in the init function. Updated for nimble, btstack, esp32 and zephyr bindings. Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
1 parent 17898f8 commit d5f2fc2

File tree

8 files changed

+34
-16
lines changed

8 files changed

+34
-16
lines changed

‎extmod/btstack/modbluetooth_btstack.c‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -705,12 +705,12 @@ int mp_bluetooth_init(void) {
705705
return 0;
706706
}
707707

708-
void mp_bluetooth_deinit(void) {
708+
int mp_bluetooth_deinit(void) {
709709
DEBUG_printf("mp_bluetooth_deinit\n");
710710

711711
// Nothing to do if not initialised.
712712
if (!MP_STATE_PORT(bluetooth_btstack_root_pointers)) {
713-
return;
713+
return 0;
714714
}
715715

716716
mp_bluetooth_gap_advertise_stop();
@@ -737,6 +737,9 @@ void mp_bluetooth_deinit(void) {
737737
deinit_stack();
738738

739739
DEBUG_printf("mp_bluetooth_deinit: complete\n");
740+
741+
bool timeout = mp_bluetooth_btstack_state == MP_BLUETOOTH_BTSTACK_STATE_TIMEOUT;
742+
return timeout ? MP_ETIMEDOUT : 0;
740743
}
741744

742745
bool mp_bluetooth_is_active(void) {

‎extmod/modbluetooth.c‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -290,12 +290,13 @@ static mp_obj_t bluetooth_ble_make_new(const mp_obj_type_t *type, size_t n_args,
290290
static mp_obj_t bluetooth_ble_active(size_t n_args, const mp_obj_t *args) {
291291
if (n_args == 2) {
292292
// Boolean enable/disable argument supplied, set current state.
293+
int err;
293294
if (mp_obj_is_true(args[1])) {
294-
int err = mp_bluetooth_init();
295-
bluetooth_handle_errno(err);
295+
err = mp_bluetooth_init();
296296
} else {
297-
mp_bluetooth_deinit();
297+
err = mp_bluetooth_deinit();
298298
}
299+
bluetooth_handle_errno(err);
299300
}
300301
// Return current state.
301302
return mp_obj_new_bool(mp_bluetooth_is_active());

‎extmod/modbluetooth.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ extern const mp_obj_type_t mp_type_bluetooth_uuid;
295295
int mp_bluetooth_init(void);
296296

297297
// Disables the Bluetooth stack. Is a no-op when not enabled.
298-
void mp_bluetooth_deinit(void);
298+
int mp_bluetooth_deinit(void);
299299

300300
// Returns true when the Bluetooth stack is active.
301301
bool mp_bluetooth_is_active(void);

‎extmod/nimble/modbluetooth_nimble.c‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
static uint8_t nimble_address_mode = BLE_OWN_ADDR_RANDOM;
6161

6262
#define NIMBLE_STARTUP_TIMEOUT 2000
63+
#define NIMBLE_SHUTDOWN_TIMEOUT 500
6364

6465
// Any BLE_HS_xxx code not in this table will default to MP_EIO.
6566
static int8_t ble_hs_err_to_errno_table[] = {
@@ -554,17 +555,25 @@ static void ble_hs_shutdown_stop_cb(int status, void *arg) {
554555

555556
static struct ble_hs_stop_listener ble_hs_shutdown_stop_listener;
556557

557-
void mp_bluetooth_nimble_port_shutdown(void) {
558+
int mp_bluetooth_nimble_port_shutdown(void) {
558559
DEBUG_printf("mp_bluetooth_nimble_port_shutdown (nimble default)\n");
559560
// By default, just call ble_hs_stop directly and wait for the stack to stop.
560561

561562
mp_bluetooth_nimble_ble_state = MP_BLUETOOTH_NIMBLE_BLE_STATE_STOPPING;
562563

563564
ble_hs_stop(&ble_hs_shutdown_stop_listener, ble_hs_shutdown_stop_cb, NULL);
564565

566+
mp_uint_t timeout_start_ticks_ms = mp_hal_ticks_ms();
565567
while (mp_bluetooth_nimble_ble_state != MP_BLUETOOTH_NIMBLE_BLE_STATE_OFF) {
566-
mp_event_wait_indefinite();
568+
mp_uint_t elapsed = mp_hal_ticks_ms() - timeout_start_ticks_ms;
569+
if (elapsed > NIMBLE_SHUTDOWN_TIMEOUT) {
570+
// Stack had not responded (via ble_hs_shutdown_stop_cb)
571+
return MP_ETIMEDOUT;
572+
}
573+
574+
mp_event_wait_ms(NIMBLE_SHUTDOWN_TIMEOUT - elapsed);
567575
}
576+
return 0;
568577
}
569578

570579
#endif // !MICROPY_BLUETOOTH_NIMBLE_BINDINGS_ONLY
@@ -659,10 +668,11 @@ int mp_bluetooth_init(void) {
659668
return 0;
660669
}
661670

662-
void mp_bluetooth_deinit(void) {
671+
int mp_bluetooth_deinit(void) {
663672
DEBUG_printf("mp_bluetooth_deinit %d\n", mp_bluetooth_nimble_ble_state);
673+
int ret = 0;
664674
if (mp_bluetooth_nimble_ble_state == MP_BLUETOOTH_NIMBLE_BLE_STATE_OFF) {
665-
return;
675+
return 0;
666676
}
667677

668678
// Must call ble_hs_stop() in a port-specific way to stop the background
@@ -675,7 +685,7 @@ void mp_bluetooth_deinit(void) {
675685

676686
DEBUG_printf("mp_bluetooth_deinit: starting port shutdown\n");
677687

678-
mp_bluetooth_nimble_port_shutdown();
688+
ret = mp_bluetooth_nimble_port_shutdown();
679689
assert(mp_bluetooth_nimble_ble_state == MP_BLUETOOTH_NIMBLE_BLE_STATE_OFF);
680690
} else {
681691
mp_bluetooth_nimble_ble_state = MP_BLUETOOTH_NIMBLE_BLE_STATE_OFF;
@@ -692,6 +702,7 @@ void mp_bluetooth_deinit(void) {
692702
#endif
693703

694704
DEBUG_printf("mp_bluetooth_deinit: shut down\n");
705+
return ret;
695706
}
696707

697708
bool mp_bluetooth_is_active(void) {

‎extmod/nimble/modbluetooth_nimble.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ void mp_bluetooth_nimble_port_hci_deinit(void);
8484
void mp_bluetooth_nimble_port_start(void);
8585

8686
// Tell the port to stop its background task.
87-
void mp_bluetooth_nimble_port_shutdown(void);
87+
int mp_bluetooth_nimble_port_shutdown(void);
8888

8989
// --- Called by the HCI UART layer to let us know when packets have been sent.
9090
void mp_bluetooth_nimble_sent_hci_packet(void);

‎ports/esp32/mpnimbleport.c‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ void mp_bluetooth_nimble_port_start(void) {
5858
nimble_port_freertos_init(ble_host_task);
5959
}
6060

61-
void mp_bluetooth_nimble_port_shutdown(void) {
61+
int mp_bluetooth_nimble_port_shutdown(void) {
6262
DEBUG_printf("mp_bluetooth_nimble_port_shutdown\n");
6363

6464
#if MICROPY_PY_BLUETOOTH_USE_SYNC_EVENTS_WITH_INTERLOCK
@@ -79,6 +79,8 @@ void mp_bluetooth_nimble_port_shutdown(void) {
7979

8080
// Mark stack as shutdown.
8181
mp_bluetooth_nimble_ble_state = MP_BLUETOOTH_NIMBLE_BLE_STATE_OFF;
82+
83+
return 0;
8284
}
8385

8486
#endif

‎ports/unix/main.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,7 @@ MP_NOINLINE int main_(int argc, char **argv) {
775775
#endif
776776

777777
#if MICROPY_PY_BLUETOOTH
778-
void mp_bluetooth_deinit(void);
778+
int mp_bluetooth_deinit(void);
779779
mp_bluetooth_deinit();
780780
#endif
781781

‎ports/zephyr/modbluetooth_zephyr.c‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,11 +305,11 @@ int mp_bluetooth_init(void) {
305305
return 0;
306306
}
307307

308-
void mp_bluetooth_deinit(void) {
308+
int mp_bluetooth_deinit(void) {
309309
DEBUG_printf("mp_bluetooth_deinit %d\n", mp_bluetooth_zephyr_ble_state);
310310
if (mp_bluetooth_zephyr_ble_state == MP_BLUETOOTH_ZEPHYR_BLE_STATE_OFF
311311
|| mp_bluetooth_zephyr_ble_state == MP_BLUETOOTH_ZEPHYR_BLE_STATE_SUSPENDED) {
312-
return;
312+
return 0;
313313
}
314314

315315
mp_bluetooth_gap_advertise_stop();
@@ -332,6 +332,7 @@ void mp_bluetooth_deinit(void) {
332332

333333
MP_STATE_PORT(bluetoo 530A th_zephyr_root_pointers) = NULL;
334334
mp_bt_zephyr_next_conn = NULL;
335+
return 0;
335336
}
336337

337338
bool mp_bluetooth_is_active(void) {

0 commit comments

Comments
 (0)
0