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

Add Tag register to protocol #38

Merged
merged 2 commits into from
Jan 9, 2025
Merged

Add Tag register to protocol #38

merged 2 commits into from
Jan 9, 2025

Conversation

bruno-f-cruz
Copy link
Member

Summary

This PR adds a new register to the protocol called Tag.
This new register should be used to optionally keep information regarding a specific tag of a firmware version. A simple use case would be to keep track of a development version of a given minor release.

Motivation

During development it is often the case that intermediate firmware versions are released. These are impossible to track in the firmware as the protocol only specifies a major and minor version. This new register is added to meet this need. Users can use this register to add a "build" or "preview" tag to the firmware, for instance the git commit that generated the release.

Detailed Design

A new register will be added with the following specs:

Name: Tag
Address: 17
Format: U8[8]
Access: Read-only

Design Meetings

See further discussion in the following issues:

@bruno-f-cruz bruno-f-cruz linked an issue Feb 29, 2024 that may be closed by this pull request
Copy link

@Poofjunior Poofjunior left a comment

Choose a reason for hiding this comment

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

This looks good assuming it can be done without affecting R_DEVICE_NAME.

Copy link

@Poofjunior Poofjunior left a comment

Choose a reason for hiding this comment

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

:shipit:

@Poofjunior
Copy link

This is now implemented on the RP2040 Harp Core:
AllenNeuralDynamics/harp.core.pico#30

@bruno-f-cruz
Copy link
Member Author

bruno-f-cruz commented Dec 19, 2024

@glopesdev glopesdev mentioned this pull request Jan 2, 2025
Device.md Outdated Show resolved Hide resolved
@glopesdev glopesdev force-pushed the 17-firmware-git-hash branch 2 times, most recently from 7ac8e4b to 7098f25 Compare January 9, 2025 21:34
@glopesdev glopesdev force-pushed the 17-firmware-git-hash branch from 7098f25 to 8c05bd4 Compare January 9, 2025 21:37
@glopesdev glopesdev merged commit e131f8a into main Jan 9, 2025
@glopesdev glopesdev deleted the 17-firmware-git-hash branch January 9, 2025 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Firmware Git Hash
3 participants