ubx: Refactor codebase in order to improve usability #89900
Merged
Conversation
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
ubieda
force-pushed
the
gnss/ubx-codebase-refactoring
branch
from
ddfdace to
56c629f
Compare
bjarki-andreasen
previously requested changes
May 13, 2025
There was a problem hiding this comment.
Looks really good, major improvement! I would like to see the processing between UBX frames to publishing through the GNSS API be moved to a "base" context like gnss_nmea0183_match.c which could be used by more if not all UBX based GNSS modems :) This will make the m8 driver waay smaller
ubieda
force-pushed
the
gnss/ubx-codebase-refactoring
branch
2 times, most recently
from
7645795 to
a3d3cbd
Compare
|
Pushed to address CI failures and change-request. Once CI is green I'll mark this PR as ready for final review! |
ubieda
force-pushed
the
gnss/ubx-codebase-refactoring
branch
from
a3d3cbd to
be19fd2
Compare
github-actions
bot
requested review from
fabiobaltieri,
kartben,
nashif and
tomi-font
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
JordanYates
reviewed
May 14, 2025
During testing and code inspection, there were various anti-patterns on this (and U-Blox driver) codebase(s), including obfuscation, and lack of data validation. This made it increasingly difficult to introduce further variants of u-blox GNSS modems. With this patch, both the UBX modem and the M8 driver have been refactored to ease the reliability and maintainability of these codebases. Here are some highlights: WRT UBX modem: - Helper macros to easily create UBX frames, (including checksum calculation), at compile time; thus, making it easier to extend UBX commands. - Logic validation by the inclusion of the modem_ubx testsuite, used to refactor the code through TDD. - Ability to receive unsolicited messages, in order to enable U-Blox drivers to rely on modem_ubx to transceive all commands, and avoid hopping between modem_ubx and modem_chat. WRT M8 driver: - Remove GNSS specific protocol header files. Instead, unify them under modem/ubx/protocol.h. Background: After a survey and looking at ubxlib SDK I conclude the UBX protocol is by definition a GNSS protocol (there are non-GNSS u-blox modems, but they're not interfaced through UBX protocol). - Establish pattern to create and send/receive commands using new foundations on modem ubx. - Remove dependency of Modem chat, and instead use UBX unsolicited messages to get Navigation and Satellites data. - Switch from the auto-baudrate detection pattern to a pattern of transitioning between an initial known baudrate to a desired baudrate, in order to improve initialization time. - Add dts property to configure default fix-rate. Signed-off-by: Luis Ubieda <[email protected]>
ubieda
force-pushed
the
gnss/ubx-codebase-refactoring
branch
from
be19fd2 to
99203b7
Compare
|
bperseghetti
approved these changes
May 27, 2025
PetervdPerk-NXP
approved these changes
May 27, 2025
|
@bjarki-andreasen I saw you dismissed your old review and it shows a "." was that meant to be an approval? If you wouldn't mind reviewing this one again when you get a chance it would be greatly appreciated as we would like to proceed with the follow-up PRs. |
bjarki-andreasen
approved these changes
May 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
During testing and code inspection, there were various anti-patterns on this (and U-Blox driver) codebase(s), including obfuscation, and lack of data validation. This made it increasingly difficult to introduce further variants of u-blox GNSS modems and/or extend the functionality of existing ones (e.g: UBX M8).
With this patch, both the UBX modem and the M8 driver have been refactored to ease the reliability and maintainability of these codebases. Here are some highlights:
WRT UBX modem:
WRT M8 driver:
Testing