Skip to content
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.

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

gnss: rename u-blox M10 driver to M8 #76401

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

JordanYates
Copy link
Collaborator

The driver in tree is for u-blox M8 devices, not M10. The M10 series devices (from Protocol Version 23.01) use a different, non backwards compatible interface for configuring the modem behaviour.

Of the two boards tested in the original PR, the "VMU RT1170" is explicitly listed as having a u-blox NEO-M8N modem, while I have been unable to find any information online about the "FMURT6" board.

Leaving the naming as-is will cause problems when M10 drivers are contributed.

Original PR: #68350

@zephyrbot zephyrbot added area: GNSS Release Notes To be mentioned in the release notes area: Samples Samples area: Devicetree Binding PR modifies or adds a Device Tree binding labels Jul 29, 2024
Copy link
Collaborator

@tomi-font tomi-font left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to provide a migration guide entry for this renaming.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you make it so that this file also shows up as moved instead of added?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure that would involve patching git...
Its not showing up as moved because basically every line has been changed, but I can't do anything about that without leaving the defines with the incorrect names.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, yeah I do bump into this limitation of git when renaming and modifying a file in a same commit. Kinda sucks. I was wondering here cause you managed to have it show up properly for other files.

@JordanYates
Copy link
Collaborator Author

It would be nice to provide a migration guide entry for this renaming.

Can't be done until the templates for 4.0 are added

@tomi-font
Copy link
Collaborator

Can't be done until the templates for 4.0 are added

@kartben maybe?

@bjarki-andreasen
Copy link
Collaborator

Nice catch! I can't find any documentation from NXP actually stating the GNSS modem variant, their schematic just says GPS1 https://github.com/CogniPilot/NXP-VMU_RT117x-HW/blob/main/VMU-RT1170/vmu_rt1170-01_Schem_draft_20230123.PDF but as you mention the protocol matches the M8 :)

@kartben
Copy link
Collaborator

kartben commented Jul 29, 2024

Can't be done until the templates for 4.0 are added

@kartben maybe?

#76344

@fabiobaltieri
Copy link
Member

#76344

Merged, was holding few patches back.

tomi-font
tomi-font previously approved these changes Jul 29, 2024
Copy link
Collaborator

@tomi-font tomi-font left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. Though now, thinking about 3.7, as you fixed the release notes entry, but in 3.7.0 the code is still M10, not M8. Could this PR be a candidate for backporting to 3.7?

@@ -861,7 +861,7 @@ Drivers and Sensors

* Added GNSS device driver API test suite.
* Added support for the u-blox UBX protocol.
* Added device driver for the u-blox M10 GNSS modem (:dtcompatible:`u-blox,m10`).
* Added device driver for the u-blox M8 GNSS modem (:dtcompatible:`u-blox,m8`).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's nice to fix the 3.7 release notes, but there the DT compatible (and driver name) will still be M10. Unless this is backported?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that this is worthy of backporting, it is not a bug or a security vulnerability, just a name correction.
The choice is either leave the old release notes alone, and the link will be dead, or I can update the old notes and have the name be inconsistent.
Neither is ideal.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah...

tomi-font
tomi-font previously approved these changes Jul 31, 2024
fabiobaltieri
fabiobaltieri previously approved these changes Jul 31, 2024
The driver in tree is for u-blox M8 devices, not M10. The M10 series
devices (from Protocol Version 23.01) use a different, non backwards
compatible interface for configuring the modem behaviour.

Of the two boards tested in the original PR, the "VMU RT1170" is
explicitly listed as having a u-blox NEO-M8N modem, while I have
been unable to find any information online about the "FMURT6" board.

Leaving the naming as-is will cause problems when M10 drivers are
contributed.

Signed-off-by: Jordan Yates <jordan@embeint.com>
@nashif nashif merged commit d97cc46 into zephyrproject-rtos:main Aug 26, 2024
23 checks passed
@JordanYates JordanYates deleted the 240729_ublox_m8 branch August 26, 2024 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Devicetree Binding PR modifies or adds a Device Tree binding area: GNSS area: Samples Samples Release Notes To be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants