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

Non-volatile memory data repository pattern #24356

Open
wants to merge 29 commits into
base: develop
Choose a base branch
from

Conversation

tzarc
Copy link
Member

@tzarc tzarc commented Sep 2, 2024

Description

Start of refactoring for non-volatile storage other than EEPROM. Converts eeconfig to be a shim, offloading to an nvm_eeconfig equivalent which in turn does the EEPROM writes as of today. Same transformations done for via/dynamic_keymap.

New storage mechanisms like the incoming filesystem APIs can then implement nvm_eeconfig in its own terms, which may mean one file per concern, as an example. It also paves the way for providing read/write capability for other subsystems, such as combos, key overrides, etc. -- unlikely to be implemented in the EEPROM-backed NVM driver due to a lack of space, but may be available for others.

Tested on Satisfaction75 with VIA and its custom configuration stuff, seems to work fine.

TODO:

  • eeprom debounce helper stuff

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@github-actions github-actions bot added the core label Sep 2, 2024
@tzarc tzarc added the no-ci Signals to the CI runners not to build. label Sep 2, 2024
@tzarc tzarc removed the no-ci Signals to the CI runners not to build. label Sep 3, 2024
@tzarc tzarc changed the title [WIP] Add non-volatile memory system. Non-volatile memory data repository pattern Sep 3, 2024
@github-actions github-actions bot added the keymap label Sep 3, 2024
@tzarc tzarc marked this pull request as ready for review September 3, 2024 11:12
@tzarc tzarc requested a review from a team September 3, 2024 11:12
@tzarc tzarc added the breaking_change_2024q4 Targeting breaking changes Q4 2024 label Nov 2, 2024
@tzarc tzarc added develop-fast-track Intended to be merged early in the next develop cycle. breaking_change_2025q1 Targeting breaking changes Q1 2025 and removed breaking_change_2024q4 Targeting breaking changes Q4 2024 labels Nov 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking_change_2025q1 Targeting breaking changes Q1 2025 core develop-fast-track Intended to be merged early in the next develop cycle. keyboard keymap
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant