Skip to content

espressif: report GATT ATT errors as specific exceptions #11550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dhalbert wants to merge 2 commits into
base: main
Choose a base branch
from
+45 −18
Open

espressif: report GATT ATT errors as specific exceptions #11550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac8bfd2
espressif: report GATT ATT errors as specific exceptions
dhalbert Oct 11, 2026
ef844f3
Merge branch 'main' into espressif-gatt-att-errors
dhalbert Oct 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions locale/circuitpython.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1414,12 +1414,16 @@ msgstr ""

#: ports/espressif/common-hal/_bleio/__init__.c
#, c-format
msgid "Unknown system firmware error at %s:%d: %d"
msgid "Unknown BLE error at %s:%d: 0x%04x"
msgstr ""

#: ports/espressif/common-hal/_bleio/__init__.c
#, c-format
msgid "Unknown system firmware error: %d"
msgid "Unknown BLE error: 0x%04x"
msgstr ""

#: ports/espressif/common-hal/_bleio/__init__.c
msgid "%q not permitted"
msgstr ""

#: ports/espressif/common-hal/_bleio/__init__.c
Expand All @@ -1428,18 +1432,18 @@ msgid "Insufficient authentication"
msgstr ""

#: ports/espressif/common-hal/_bleio/__init__.c
#: ports/nordic/common-hal/_bleio/__init__.c
msgid "Insufficient encryption"
msgid "Insufficient authorization"
msgstr ""

#: ports/espressif/common-hal/_bleio/__init__.c
#, c-format
msgid "Unknown BLE error at %s:%d: %d"
#: ports/nordic/common-hal/_bleio/__init__.c
msgid "Insufficient encryption"
msgstr ""

#: ports/espressif/common-hal/_bleio/__init__.c
#: ports/nordic/common-hal/_bleio/__init__.c
#, c-format
msgid "Unknown BLE error: %d"
msgid "Unknown gatt error: 0x%04x"
msgstr ""

#: ports/espressif/common-hal/alarm/pin/PinAlarm.c
Expand Down Expand Up @@ -1891,11 +1895,6 @@ msgstr ""
msgid "Unknown system firmware error: %04x"
msgstr ""

#: ports/nordic/common-hal/_bleio/__init__.c
#, c-format
msgid "Unknown gatt error: 0x%04x"
msgstr ""

#: ports/nordic/common-hal/_bleio/__init__.c
#: ports/zephyr-cp/common-hal/_bleio/Connection.c
msgid ""
Expand Down
40 changes: 34 additions & 6 deletions ports/espressif/common-hal/_bleio/__init__.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,12 @@ void check_nimble_error(int rc, const char *file, size_t line) {
default:
#if CIRCUITPY_VERBOSE_BLE || CIRCUITPY_DEBUG
if (file) {
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("Unknown system firmware error at %s:%d: %d"), file, line, rc);
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("Unknown BLE error at %s:%d: 0x%04x"), file, line, rc);
}
#else
(void)file;
(void)line;
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("Unknown system firmware error: %d"), rc);
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("Unknown BLE error: 0x%04x"), rc);
#endif

break;
Expand All @@ -194,21 +194,38 @@ void check_ble_error(int error_code, const char *file, size_t line) {
return;
}
switch (error_code) {
case BLE_HS_ATT_ERR(BLE_ATT_ERR_READ_NOT_PERMITTED):
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("%q not permitted"), MP_QSTR_read);
return;
case BLE_HS_ATT_ERR(BLE_ATT_ERR_WRITE_NOT_PERMITTED):
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("%q not permitted"), MP_QSTR_write);
return;
case BLE_HS_ATT_ERR(BLE_ATT_ERR_INSUFFICIENT_AUTHEN):
mp_raise_bleio_SecurityError(MP_ERROR_TEXT("Insufficient authentication"));
return;
case BLE_HS_ATT_ERR(BLE_ATT_ERR_INSUFFICIENT_AUTHOR):
mp_raise_bleio_SecurityError(MP_ERROR_TEXT("Insufficient authorization"));
return;
case BLE_HS_ATT_ERR(BLE_ATT_ERR_INSUFFICIENT_ENC):
case BLE_HS_ATT_ERR(BLE_ATT_ERR_INSUFFICIENT_KEY_SZ):
mp_raise_bleio_SecurityError(MP_ERROR_TEXT("Insufficient encryption"));
return;
case BLE_HS_ATT_ERR(BLE_ATT_ERR_INVALID_ATTR_VALUE_LEN):
mp_arg_error_invalid(MP_QSTR_length);
return;
default:
if (error_code > BLE_HS_ERR_ATT_BASE && error_code < BLE_HS_ERR_HCI_BASE) {
// Some other ATT error from the peer.
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("Unknown gatt error: 0x%04x"), error_code);
}
#if CIRCUITPY_VERBOSE_BLE || CIRCUITPY_DEBUG
if (file) {
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("Unknown BLE error at %s:%d: %d"), file, line, error_code);
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("Unknown BLE error at %s:%d: 0x%04x"), file, line, error_code);
}
#else
(void)file;
(void)line;
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("Unknown BLE error: %d"), error_code);
mp_raise_bleio_BluetoothError(MP_ERROR_TEXT("Unknown BLE error: 0x%04x"), error_code);
#endif

break;
Expand Down Expand Up @@ -270,6 +287,17 @@ static int _wait_for_completion(uint32_t timeout_msecs) {
return _completion_status;
}

// Raise an exception for a nonzero completion status. Statuses from
// BLE_HS_ERR_ATT_BASE up are ATT errors from the peer, such as insufficient
// encryption, which check_ble_error() maps to SecurityError.
static void _check_completion_status(int status) {
if (status < BLE_HS_ERR_ATT_BASE) {
CHECK_NIMBLE_ERROR(status);
return;
}
CHECK_BLE_ERROR(status);
}

static int _read_cb(uint16_t conn_handle,
const struct ble_gatt_error *error,
struct ble_gatt_attr *attr,
Expand All @@ -294,7 +322,7 @@ static int _read_cb(uint16_t conn_handle,
int bleio_gattc_read(uint16_t conn_handle, uint16_t value_handle, uint8_t *buf, size_t len) {
void *seq = _start_request();
CHECK_NIMBLE_ERROR(ble_gattc_read(conn_handle, value_handle, _read_cb, seq));
CHECK_NIMBLE_ERROR(_wait_for_completion(2000));
_check_completion_status(_wait_for_completion(2000));
if (!_completion_done) {
// Interrupted: nothing was read.
return 0;
Expand All @@ -319,5 +347,5 @@ static int _write_cb(uint16_t conn_handle,
void bleio_gattc_write(uint16_t conn_handle, uint16_t value_handle, uint8_t *buf, size_t len) {
void *seq = _start_request();
CHECK_NIMBLE_ERROR(ble_gattc_write_flat(conn_handle, value_handle, buf, len, _write_cb, seq));
CHECK_NIMBLE_ERROR(_wait_for_completion(2000));
_check_completion_status(_wait_for_completion(2000));
}
Loading