host: document GATT error status encoding#2252
Open
Old-Ding wants to merge 1 commit into
Open
Conversation
sjanc
reviewed
Jul 6, 2026
| * reported as BLE_HS_ATT_ERR(code), so status 0x0181 is ATT error 0x81 | ||
| * (0x100 + 0x81). Application-specific ATT errors must be decoded by | ||
| * subtracting the ATT base and consulting the service or profile | ||
| * specification that defines the ATT error. |
Contributor
There was a problem hiding this comment.
Hi,
This is not valid comment. It just exposes current implementation specific details (mask 0x100).
In Nimble error mask is used for specifying which layer trigger error and application shall not assume
any specific layer when decoding.
So I'd suggest to comment here that status is following NimBLE error codes convention described in
https://mynewt.apache.org/latest/network/ble_hs/ble_hs_return_codes.html
Document that ble_gatt_error.status follows the NimBLE host return-code convention and point readers to the return-code documentation instead of describing implementation-specific ATT encoding details. Signed-off-by: Old-Ding <ai.neo.ae86@gmail.com>
Old-Ding
force-pushed
the
codex/gatt-error-status-doc
branch
from
90fd053 to
687997e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ble_gatt_error.statususes NimBLE host return-code ranges, not raw ATT error values.BLE_HS_ATT_ERR(code), including0x0181 = 0x100 + 0x81.Closes #1827
Testing
git diff --check origin/master...HEADpython .github/check_doxygen.py HEAD origin/master(doxygenis not installed locally)clang-formatis not installed locally)