Non-volatile memory data repository pattern (#24356)
* First batch of eeconfig conversions. * Offset and length for datablocks. * `via`, `dynamic_keymap`. * Fix filename. * Commentary. * wilba leds * satisfaction75 * satisfaction75 * more keyboard whack-a-mole * satisfaction75 * omnikeyish * more whack-a-mole * `generic_features.mk` to automatically pick up nvm repositories * thievery * deferred variable resolve * whitespace * convert api to structs/unions * convert api to structs/unions * convert api to structs/unions * fixups * code-side docs * code size fix * rollback * nvm_xxxxx_erase * Updated location of eeconfig magic numbers so non-EEPROM nvm drivers can use them too. * Fixup build. * Fixup compilation error with encoders. * Build fixes. * Add `via_ci` keymap to onekey to exercise VIA bindings (and thus dynamic keymap et.al.), fixup compilation errors based on preprocessor+sizeof. * Build failure rectification.
This commit is contained in:
parent
c9d62ddc78
commit
2b00b846dc
87 changed files with 1464 additions and 839 deletions
|
@ -32,6 +32,7 @@
|
|||
#include "timer.h"
|
||||
#include "wait.h"
|
||||
#include "version.h" // for QMK_BUILDDATE used in EEPROM magic
|
||||
#include "nvm_via.h"
|
||||
|
||||
#if defined(AUDIO_ENABLE)
|
||||
# include "audio.h"
|
||||
|
@ -65,20 +66,26 @@ bool via_eeprom_is_valid(void) {
|
|||
uint8_t magic1 = ((p[5] & 0x0F) << 4) | (p[6] & 0x0F);
|
||||
uint8_t magic2 = ((p[8] & 0x0F) << 4) | (p[9] & 0x0F);
|
||||
|
||||
return (eeprom_read_byte((void *)VIA_EEPROM_MAGIC_ADDR + 0) == magic0 && eeprom_read_byte((void *)VIA_EEPROM_MAGIC_ADDR + 1) == magic1 && eeprom_read_byte((void *)VIA_EEPROM_MAGIC_ADDR + 2) == magic2);
|
||||
uint8_t ee_magic0;
|
||||
uint8_t ee_magic1;
|
||||
uint8_t ee_magic2;
|
||||
nvm_via_read_magic(&ee_magic0, &ee_magic1, &ee_magic2);
|
||||
|
||||
return ee_magic0 == magic0 && ee_magic1 == magic1 && ee_magic2 == magic2;
|
||||
}
|
||||
|
||||
// Sets VIA/keyboard level usage of EEPROM to valid/invalid
|
||||
// Keyboard level code (eg. via_init_kb()) should not call this
|
||||
void via_eeprom_set_valid(bool valid) {
|
||||
char * p = QMK_BUILDDATE; // e.g. "2019-11-05-11:29:54"
|
||||
uint8_t magic0 = ((p[2] & 0x0F) << 4) | (p[3] & 0x0F);
|
||||
uint8_t magic1 = ((p[5] & 0x0F) << 4) | (p[6] & 0x0F);
|
||||
uint8_t magic2 = ((p[8] & 0x0F) << 4) | (p[9] & 0x0F);
|
||||
|
||||
eeprom_update_byte((void *)VIA_EEPROM_MAGIC_ADDR + 0, valid ? magic0 : 0xFF);
|
||||
eeprom_update_byte((void *)VIA_EEPROM_MAGIC_ADDR + 1, valid ? magic1 : 0xFF);
|
||||
eeprom_update_byte((void *)VIA_EEPROM_MAGIC_ADDR + 2, valid ? magic2 : 0xFF);
|
||||
if (valid) {
|
||||
char * p = QMK_BUILDDATE; // e.g. "2019-11-05-11:29:54"
|
||||
uint8_t magic0 = ((p[2] & 0x0F) << 4) | (p[3] & 0x0F);
|
||||
uint8_t magic1 = ((p[5] & 0x0F) << 4) | (p[6] & 0x0F);
|
||||
uint8_t magic2 = ((p[8] & 0x0F) << 4) | (p[9] & 0x0F);
|
||||
nvm_via_update_magic(magic0, magic1, magic2);
|
||||
} else {
|
||||
nvm_via_update_magic(0xFF, 0xFF, 0xFF);
|
||||
}
|
||||
}
|
||||
|
||||
// Override this at the keyboard code level to check
|
||||
|
@ -104,6 +111,8 @@ void via_init(void) {
|
|||
}
|
||||
|
||||
void eeconfig_init_via(void) {
|
||||
// Erase any NVM storage if necessary
|
||||
nvm_via_erase();
|
||||
// set the magic number to false, in case this gets interrupted
|
||||
via_eeprom_set_valid(false);
|
||||
// This resets the layout options
|
||||
|
@ -119,30 +128,25 @@ void eeconfig_init_via(void) {
|
|||
// This is generalized so the layout options EEPROM usage can be
|
||||
// variable, between 1 and 4 bytes.
|
||||
uint32_t via_get_layout_options(void) {
|
||||
uint32_t value = 0;
|
||||
// Start at the most significant byte
|
||||
void *source = (void *)(VIA_EEPROM_LAYOUT_OPTIONS_ADDR);
|
||||
for (uint8_t i = 0; i < VIA_EEPROM_LAYOUT_OPTIONS_SIZE; i++) {
|
||||
value = value << 8;
|
||||
value |= eeprom_read_byte(source);
|
||||
source++;
|
||||
}
|
||||
return value;
|
||||
return nvm_via_read_layout_options();
|
||||
}
|
||||
|
||||
__attribute__((weak)) void via_set_layout_options_kb(uint32_t value) {}
|
||||
|
||||
void via_set_layout_options(uint32_t value) {
|
||||
via_set_layout_options_kb(value);
|
||||
// Start at the least significant byte
|
||||
void *target = (void *)(VIA_EEPROM_LAYOUT_OPTIONS_ADDR + VIA_EEPROM_LAYOUT_OPTIONS_SIZE - 1);
|
||||
for (uint8_t i = 0; i < VIA_EEPROM_LAYOUT_OPTIONS_SIZE; i++) {
|
||||
eeprom_update_byte(target, value & 0xFF);
|
||||
value = value >> 8;
|
||||
target--;
|
||||
}
|
||||
nvm_via_update_layout_options(value);
|
||||
}
|
||||
|
||||
#if VIA_EEPROM_CUSTOM_CONFIG_SIZE > 0
|
||||
uint32_t via_read_custom_config(void *buf, uint32_t offset, uint32_t length) {
|
||||
return nvm_via_read_custom_config(buf, offset, length);
|
||||
}
|
||||
uint32_t via_update_custom_config(const void *buf, uint32_t offset, uint32_t length) {
|
||||
return nvm_via_update_custom_config(buf, offset, length);
|
||||
}
|
||||
#endif
|
||||
|
||||
#if defined(AUDIO_ENABLE)
|
||||
float via_device_indication_song[][2] = SONG(STARTUP_SOUND);
|
||||
#endif // AUDIO_ENABLE
|
||||
|
@ -715,7 +719,7 @@ void via_qmk_rgb_matrix_set_value(uint8_t *data) {
|
|||
}
|
||||
|
||||
void via_qmk_rgb_matrix_save(void) {
|
||||
eeconfig_update_rgb_matrix();
|
||||
eeconfig_force_flush_rgb_matrix();
|
||||
}
|
||||
|
||||
#endif // RGB_MATRIX_ENABLE
|
||||
|
@ -794,7 +798,7 @@ void via_qmk_led_matrix_set_value(uint8_t *data) {
|
|||
}
|
||||
|
||||
void via_qmk_led_matrix_save(void) {
|
||||
eeconfig_update_led_matrix();
|
||||
eeconfig_force_flush_led_matrix();
|
||||
}
|
||||
|
||||
#endif // LED_MATRIX_ENABLE
|
||||
|
@ -861,7 +865,7 @@ void via_qmk_audio_set_value(uint8_t *data) {
|
|||
}
|
||||
|
||||
void via_qmk_audio_save(void) {
|
||||
eeconfig_update_audio(audio_config.raw);
|
||||
eeconfig_update_audio(&audio_config);
|
||||
}
|
||||
|
||||
#endif // QMK_AUDIO_ENABLE
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue