|
| 1 | +""" |
| 2 | +Bluefruit BLE Patch Script |
| 3 | +
|
| 4 | +Patches Bluefruit library to fix semaphore leak bug that causes device lockup |
| 5 | +when BLE central disconnects unexpectedly (e.g., going out of range, supervision timeout). |
| 6 | +
|
| 7 | +Patches applied: |
| 8 | +1. BLEConnection.h: Add _hvn_qsize member to track semaphore queue size |
| 9 | +2. BLEConnection.cpp: Store hvn_qsize and restore semaphore on disconnect |
| 10 | +
|
| 11 | +Bug description: |
| 12 | +- When a BLE central disconnects unexpectedly (reason=8 supervision timeout), |
| 13 | + the BLE_GATTS_EVT_HVN_TX_COMPLETE event may never fire |
| 14 | +- This leaves the _hvn_sem counting semaphore in a decremented state |
| 15 | +- Since BLEConnection objects are reused (destructor never called), the |
| 16 | + semaphore count is never restored |
| 17 | +- Eventually all semaphore counts are exhausted and notify() blocks/fails |
| 18 | +
|
| 19 | +""" |
| 20 | + |
| 21 | +from pathlib import Path |
| 22 | + |
| 23 | +Import("env") # pylint: disable=undefined-variable |
| 24 | + |
| 25 | + |
| 26 | +def _patch_ble_connection_header(source: Path) -> bool: |
| 27 | + """ |
| 28 | + Add _hvn_qsize member variable to BLEConnection class. |
| 29 | + |
| 30 | + This is needed to restore the semaphore to its correct count on disconnect. |
| 31 | + |
| 32 | + Returns True if patch was applied or already applied, False on error. |
| 33 | + """ |
| 34 | + try: |
| 35 | + content = source.read_text() |
| 36 | + |
| 37 | + # Check if already patched |
| 38 | + if "_hvn_qsize" in content: |
| 39 | + return True # Already patched |
| 40 | + |
| 41 | + # Find the location to insert - after _phy declaration |
| 42 | + original_pattern = ''' uint8_t _phy; |
| 43 | +
|
| 44 | + uint8_t _role;''' |
| 45 | + |
| 46 | + patched_pattern = ''' uint8_t _phy; |
| 47 | + uint8_t _hvn_qsize; |
| 48 | +
|
| 49 | + uint8_t _role;''' |
| 50 | + |
| 51 | + if original_pattern not in content: |
| 52 | + print("Bluefruit patch: WARNING - BLEConnection.h pattern not found") |
| 53 | + return False |
| 54 | + |
| 55 | + content = content.replace(original_pattern, patched_pattern) |
| 56 | + source.write_text(content) |
| 57 | + |
| 58 | + # Verify |
| 59 | + if "_hvn_qsize" not in source.read_text(): |
| 60 | + return False |
| 61 | + |
| 62 | + return True |
| 63 | + except Exception as e: |
| 64 | + print(f"Bluefruit patch: ERROR patching BLEConnection.h: {e}") |
| 65 | + return False |
| 66 | + |
| 67 | + |
| 68 | +def _patch_ble_connection_source(source: Path) -> bool: |
| 69 | + """ |
| 70 | + Patch BLEConnection.cpp to: |
| 71 | + 1. Store hvn_qsize in constructor |
| 72 | + 2. Restore _hvn_sem semaphore to full count on disconnect |
| 73 | + |
| 74 | + Returns True if patch was applied or already applied, False on error. |
| 75 | + """ |
| 76 | + try: |
| 77 | + content = source.read_text() |
| 78 | + |
| 79 | + # Check if already patched (look for the restore loop) |
| 80 | + if "uxSemaphoreGetCount(_hvn_sem)" in content: |
| 81 | + return True # Already patched |
| 82 | + |
| 83 | + # Patch 1: Store queue size in constructor |
| 84 | + constructor_original = ''' _hvn_sem = xSemaphoreCreateCounting(hvn_qsize, hvn_qsize);''' |
| 85 | + |
| 86 | + constructor_patched = ''' _hvn_qsize = hvn_qsize; |
| 87 | + _hvn_sem = xSemaphoreCreateCounting(hvn_qsize, hvn_qsize);''' |
| 88 | + |
| 89 | + if constructor_original not in content: |
| 90 | + print("Bluefruit patch: WARNING - BLEConnection.cpp constructor pattern not found") |
| 91 | + return False |
| 92 | + |
| 93 | + content = content.replace(constructor_original, constructor_patched) |
| 94 | + |
| 95 | + # Patch 2: Restore semaphore on disconnect |
| 96 | + disconnect_original = ''' case BLE_GAP_EVT_DISCONNECTED: |
| 97 | + // mark as disconnected |
| 98 | + _connected = false; |
| 99 | + break;''' |
| 100 | + |
| 101 | + disconnect_patched = ''' case BLE_GAP_EVT_DISCONNECTED: |
| 102 | + // Restore notification semaphore to full count |
| 103 | + // This fixes lockup when disconnect occurs with notifications in flight |
| 104 | + while (uxSemaphoreGetCount(_hvn_sem) < _hvn_qsize) { |
| 105 | + xSemaphoreGive(_hvn_sem); |
| 106 | + } |
| 107 | + // Release indication semaphore if waiting |
| 108 | + if (_hvc_sem) { |
| 109 | + _hvc_received = false; |
| 110 | + xSemaphoreGive(_hvc_sem); |
| 111 | + } |
| 112 | + // mark as disconnected |
| 113 | + _connected = false; |
| 114 | + break;''' |
| 115 | + |
| 116 | + if disconnect_original not in content: |
| 117 | + print("Bluefruit patch: WARNING - BLEConnection.cpp disconnect pattern not found") |
| 118 | + return False |
| 119 | + |
| 120 | + content = content.replace(disconnect_original, disconnect_patched) |
| 121 | + source.write_text(content) |
| 122 | + |
| 123 | + # Verify |
| 124 | + verify_content = source.read_text() |
| 125 | + if "uxSemaphoreGetCount(_hvn_sem)" not in verify_content: |
| 126 | + return False |
| 127 | + if "_hvn_qsize = hvn_qsize" not in verify_content: |
| 128 | + return False |
| 129 | + |
| 130 | + return True |
| 131 | + except Exception as e: |
| 132 | + print(f"Bluefruit patch: ERROR patching BLEConnection.cpp: {e}") |
| 133 | + return False |
| 134 | + |
| 135 | + |
| 136 | +def _apply_bluefruit_patches(target, source, env): # pylint: disable=unused-argument |
| 137 | + framework_path = env.get("PLATFORMFW_DIR") |
| 138 | + if not framework_path: |
| 139 | + framework_path = env.PioPlatform().get_package_dir("framework-arduinoadafruitnrf52") |
| 140 | + |
| 141 | + if not framework_path: |
| 142 | + print("Bluefruit patch: ERROR - framework directory not found") |
| 143 | + env.Exit(1) |
| 144 | + return |
| 145 | + |
| 146 | + framework_dir = Path(framework_path) |
| 147 | + bluefruit_lib = framework_dir / "libraries" / "Bluefruit52Lib" / "src" |
| 148 | + patch_failed = False |
| 149 | + |
| 150 | + # Patch BLEConnection.h |
| 151 | + conn_header = bluefruit_lib / "BLEConnection.h" |
| 152 | + if conn_header.exists(): |
| 153 | + before = conn_header.read_text() |
| 154 | + success = _patch_ble_connection_header(conn_header) |
| 155 | + after = conn_header.read_text() |
| 156 | + |
| 157 | + if success: |
| 158 | + if before != after: |
| 159 | + print("Bluefruit patch: OK - Applied BLEConnection.h fix (added _hvn_qsize member)") |
| 160 | + else: |
| 161 | + print("Bluefruit patch: OK - BLEConnection.h already patched") |
| 162 | + else: |
| 163 | + print("Bluefruit patch: FAILED - BLEConnection.h") |
| 164 | + patch_failed = True |
| 165 | + else: |
| 166 | + print(f"Bluefruit patch: ERROR - BLEConnection.h not found at {conn_header}") |
| 167 | + patch_failed = True |
| 168 | + |
| 169 | + # Patch BLEConnection.cpp |
| 170 | + conn_source = bluefruit_lib / "BLEConnection.cpp" |
| 171 | + if conn_source.exists(): |
| 172 | + before = conn_source.read_text() |
| 173 | + success = _patch_ble_connection_source(conn_source) |
| 174 | + after = conn_source.read_text() |
| 175 | + |
| 176 | + if success: |
| 177 | + if before != after: |
| 178 | + print("Bluefruit patch: OK - Applied BLEConnection.cpp fix (restore semaphore on disconnect)") |
| 179 | + else: |
| 180 | + print("Bluefruit patch: OK - BLEConnection.cpp already patched") |
| 181 | + else: |
| 182 | + print("Bluefruit patch: FAILED - BLEConnection.cpp") |
| 183 | + patch_failed = True |
| 184 | + else: |
| 185 | + print(f"Bluefruit patch: ERROR - BLEConnection.cpp not found at {conn_source}") |
| 186 | + patch_failed = True |
| 187 | + |
| 188 | + if patch_failed: |
| 189 | + print("Bluefruit patch: CRITICAL - Patch failed! Build aborted.") |
| 190 | + env.Exit(1) |
| 191 | + |
| 192 | + |
| 193 | +# Register the patch to run before build |
| 194 | +bluefruit_action = env.VerboseAction(_apply_bluefruit_patches, "Applying Bluefruit BLE patches...") |
| 195 | +env.AddPreAction("$BUILD_DIR/${PROGNAME}.elf", bluefruit_action) |
| 196 | + |
| 197 | +# Also run immediately to patch before any compilation |
| 198 | +_apply_bluefruit_patches(None, None, env) |
0 commit comments