Henry-Hiles/qmk_userspace
1
0
Fork 0
forked from mirrors/qmk_userspace
Code Pull requests Activity

Formalise keyboard- and user-specific EEPROM blocks (#18874)

Browse source 
* Formalise keyboard and user eeconfig datablocks.

* Add debounce helper that checks a condition and issues post-write function invocation.

* Naming.
This commit is contained in:
Nick Brassel 2022-11-05 06:20:11 +11:00 • committed by GitHub
commit f82e90bdea
Failed to generate hash of commit
3 changed files with 130 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

4
quantum/dynamic_keymap.c
View file

@ -24,9 +24,7 @@
# include "via.h" // for VIA_EEPROM_CONFIG_END # include "via.h" // for VIA_EEPROM_CONFIG_END
# define DYNAMIC_KEYMAP_EEPROM_START (VIA_EEPROM_CONFIG_END) # define DYNAMIC_KEYMAP_EEPROM_START (VIA_EEPROM_CONFIG_END)
#else #else
# ifndef DYNAMIC_KEYMAP_EEPROM_START # define DYNAMIC_KEYMAP_EEPROM_START (EECONFIG_SIZE)
# define DYNAMIC_KEYMAP_EEPROM_START (EECONFIG_SIZE)
# endif
#endif #endif
#ifdef ENCODER_ENABLE #ifdef ENCODER_ENABLE

66
quantum/eeconfig.c
View file

@ -1,3 +1,4 @@
#include <string.h>
#include <stdint.h> #include <stdint.h>
#include <stdbool.h> #include <stdbool.h>
#include "eeprom.h" #include "eeprom.h"
@ -23,13 +24,17 @@ void eeconfig_init_via(void);
* FIXME: needs doc * FIXME: needs doc
*/ */
__attribute__((weak)) void eeconfig_init_user(void) { __attribute__((weak)) void eeconfig_init_user(void) {
#if (EECONFIG_USER_DATA_SIZE) == 0
// Reset user EEPROM value to blank, rather than to a set value // Reset user EEPROM value to blank, rather than to a set value
eeconfig_update_user(0); eeconfig_update_user(0);
#endif
} }
__attribute__((weak)) void eeconfig_init_kb(void) { __attribute__((weak)) void eeconfig_init_kb(void) {
#if (EECONFIG_KB_DATA_SIZE) == 0
// Reset Keyboard EEPROM value to blank, rather than to a set value // Reset Keyboard EEPROM value to blank, rather than to a set value
eeconfig_update_kb(0); eeconfig_update_kb(0);
#endif
eeconfig_init_user(); eeconfig_init_user();
} }
@ -64,6 +69,19 @@ void eeconfig_init_quantum(void) {
// when a haptic-enabled firmware is loaded onto the keyboard. // when a haptic-enabled firmware is loaded onto the keyboard.
eeprom_update_dword(EECONFIG_HAPTIC, 0); eeprom_update_dword(EECONFIG_HAPTIC, 0);
#endif #endif
#if (EECONFIG_KB_DATA_SIZE) > 0
eeprom_update_dword(EECONFIG_KEYBOARD, (EECONFIG_KB_DATA_VERSION));
uint8_t dummy_kb[(EECONFIG_KB_DATA_SIZE)] = {0};
eeprom_update_block(EECONFIG_KB_DATABLOCK, dummy_kb, (EECONFIG_KB_DATA_SIZE));
#endif
#if (EECONFIG_USER_DATA_SIZE) > 0
eeprom_update_dword(EECONFIG_USER, (EECONFIG_USER_DATA_VERSION));
uint8_t dummy_user[(EECONFIG_USER_DATA_SIZE)] = {0};
eeprom_update_block(EECONFIG_USER_DATABLOCK, dummy_user, (EECONFIG_USER_DATA_SIZE));
#endif
#if defined(VIA_ENABLE) #if defined(VIA_ENABLE)
// Invalidate VIA eeprom config, and then reset. // Invalidate VIA eeprom config, and then reset.
// Just in case if power is lost mid init, this makes sure that it pets // Just in case if power is lost mid init, this makes sure that it pets
@ -190,6 +208,7 @@ void eeconfig_update_audio(uint8_t val) {
eeprom_update_byte(EECONFIG_AUDIO, val); eeprom_update_byte(EECONFIG_AUDIO, val);
} }
#if (EECONFIG_KB_DATA_SIZE) == 0
/** \brief eeconfig read kb /** \brief eeconfig read kb
* *
* FIXME: needs doc * FIXME: needs doc
@ -204,7 +223,9 @@ uint32_t eeconfig_read_kb(void) {
void eeconfig_update_kb(uint32_t val) { void eeconfig_update_kb(uint32_t val) {
eeprom_update_dword(EECONFIG_KEYBOARD, val); eeprom_update_dword(EECONFIG_KEYBOARD, val);
} }
#endif // (EECONFIG_KB_DATA_SIZE) == 0
#if (EECONFIG_USER_DATA_SIZE) == 0
/** \brief eeconfig read user /** \brief eeconfig read user
* *
* FIXME: needs doc * FIXME: needs doc
@ -219,6 +240,7 @@ uint32_t eeconfig_read_user(void) {
void eeconfig_update_user(uint32_t val) { void eeconfig_update_user(uint32_t val) {
eeprom_update_dword(EECONFIG_USER, val); eeprom_update_dword(EECONFIG_USER, val);
} }
#endif // (EECONFIG_USER_DATA_SIZE) == 0
/** \brief eeconfig read haptic /** \brief eeconfig read haptic
* *
@ -249,3 +271,47 @@ bool eeconfig_read_handedness(void) {
void eeconfig_update_handedness(bool val) { void eeconfig_update_handedness(bool val) {
eeprom_update_byte(EECONFIG_HANDEDNESS, !!val); eeprom_update_byte(EECONFIG_HANDEDNESS, !!val);
} }
#if (EECONFIG_KB_DATA_SIZE) > 0
/** \brief eeconfig read keyboard data block
*
* FIXME: needs doc
*/
void eeconfig_read_kb_datablock(void *data) {
if (eeprom_read_dword(EECONFIG_KEYBOARD) == (EECONFIG_KB_DATA_VERSION)) {
eeprom_read_block(data, EECONFIG_KB_DATABLOCK, (EECONFIG_KB_DATA_SIZE));
} else {
memset(data, 0, (EECONFIG_KB_DATA_SIZE));
}
}
/** \brief eeconfig update keyboard data block
*
* FIXME: needs doc
*/
void eeconfig_update_kb_datablock(const void *data) {
eeprom_update_dword(EECONFIG_KEYBOARD, (EECONFIG_KB_DATA_VERSION));
eeprom_update_block(data, EECONFIG_KB_DATABLOCK, (EECONFIG_KB_DATA_SIZE));
}
#endif // (EECONFIG_KB_DATA_SIZE) > 0
#if (EECONFIG_USER_DATA_SIZE) > 0
/** \brief eeconfig read user data block
*
* FIXME: needs doc
*/
void eeconfig_read_user_datablock(void *data) {
if (eeprom_read_dword(EECONFIG_USER) == (EECONFIG_USER_DATA_VERSION)) {
eeprom_read_block(data, EECONFIG_USER_DATABLOCK, (EECONFIG_USER_DATA_SIZE));
} else {
memset(data, 0, (EECONFIG_USER_DATA_SIZE));
}
}
/** \brief eeconfig update user data block
*
* FIXME: needs doc
*/
void eeconfig_update_user_datablock(const void *data) {
eeprom_update_dword(EECONFIG_USER, (EECONFIG_USER_DATA_VERSION));
eeprom_update_block(data, EECONFIG_USER_DATABLOCK, (EECONFIG_USER_DATA_SIZE));
}
#endif // (EECONFIG_USER_DATA_SIZE) > 0

70
quantum/eeconfig.h
View file

@ -50,8 +50,29 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define EECONFIG_LED_MATRIX_EXTENDED (uint16_t *)32 #define EECONFIG_LED_MATRIX_EXTENDED (uint16_t *)32
#define EECONFIG_RGB_MATRIX_EXTENDED (uint16_t *)32 #define EECONFIG_RGB_MATRIX_EXTENDED (uint16_t *)32
// Size of EEPROM being used for core data storage
#define EECONFIG_BASE_SIZE 34
// Size of EEPROM dedicated to keyboard- and user-specific data
#ifndef EECONFIG_KB_DATA_SIZE
# define EECONFIG_KB_DATA_SIZE 0
#endif
#ifndef EECONFIG_KB_DATA_VERSION
# define EECONFIG_KB_DATA_VERSION (EECONFIG_KB_DATA_SIZE)
#endif
#ifndef EECONFIG_USER_DATA_SIZE
# define EECONFIG_USER_DATA_SIZE 0
#endif
#ifndef EECONFIG_USER_DATA_VERSION
# define EECONFIG_USER_DATA_VERSION (EECONFIG_USER_DATA_SIZE)
#endif
#define EECONFIG_KB_DATABLOCK ((uint8_t *)(EECONFIG_BASE_SIZE))
#define EECONFIG_USER_DATABLOCK ((uint8_t *)((EECONFIG_BASE_SIZE) + (EECONFIG_KB_DATA_SIZE)))
// Size of EEPROM being used, other code can refer to this for available EEPROM // Size of EEPROM being used, other code can refer to this for available EEPROM
#define EECONFIG_SIZE 34 #define EECONFIG_SIZE ((EECONFIG_BASE_SIZE) + (EECONFIG_KB_DATA_SIZE) + (EECONFIG_USER_DATA_SIZE))
/* debug bit */ /* debug bit */
#define EECONFIG_DEBUG_ENABLE (1 << 0) #define EECONFIG_DEBUG_ENABLE (1 << 0)
#define EECONFIG_DEBUG_MATRIX (1 << 1) #define EECONFIG_DEBUG_MATRIX (1 << 1)
@ -94,10 +115,15 @@ uint8_t eeconfig_read_audio(void);
void eeconfig_update_audio(uint8_t val); void eeconfig_update_audio(uint8_t val);
#endif #endif
#if (EECONFIG_KB_DATA_SIZE) == 0
uint32_t eeconfig_read_kb(void); uint32_t eeconfig_read_kb(void);
void eeconfig_update_kb(uint32_t val); void eeconfig_update_kb(uint32_t val);
#endif // (EECONFIG_KB_DATA_SIZE) == 0
#if (EECONFIG_USER_DATA_SIZE) == 0
uint32_t eeconfig_read_user(void); uint32_t eeconfig_read_user(void);
void eeconfig_update_user(uint32_t val); void eeconfig_update_user(uint32_t val);
#endif // (EECONFIG_USER_DATA_SIZE) == 0
#ifdef HAPTIC_ENABLE #ifdef HAPTIC_ENABLE
uint32_t eeconfig_read_haptic(void); uint32_t eeconfig_read_haptic(void);
@ -107,16 +133,36 @@ void eeconfig_update_haptic(uint32_t val);
bool eeconfig_read_handedness(void); bool eeconfig_read_handedness(void);
void eeconfig_update_handedness(bool val); void eeconfig_update_handedness(bool val);
#define EECONFIG_DEBOUNCE_HELPER(name, offset, config) \ #if (EECONFIG_KB_DATA_SIZE) > 0
void eeconfig_read_kb_datablock(void *data);
void eeconfig_update_kb_datablock(const void *data);
#endif // (EECONFIG_KB_DATA_SIZE) > 0
#if (EECONFIG_USER_DATA_SIZE) > 0
void eeconfig_read_user_datablock(void *data);
void eeconfig_update_user_datablock(const void *data);
#endif // (EECONFIG_USER_DATA_SIZE) > 0
// Any "checked" debounce variant used requires implementation of:
// -- bool eeconfig_check_valid_##name(void)
// -- void eeconfig_post_flush_##name(void)
#define EECONFIG_DEBOUNCE_HELPER_CHECKED(name, offset, config) \
static uint8_t dirty_##name = false; \ static uint8_t dirty_##name = false; \
\ \
bool eeconfig_check_valid_##name(void); \
void eeconfig_post_flush_##name(void); \
\
static inline void eeconfig_init_##name(void) { \ static inline void eeconfig_init_##name(void) { \
eeprom_read_block(&config, offset, sizeof(config)); \ dirty_##name = true; \
dirty_##name = false; \ if (eeconfig_check_valid_##name()) { \
eeprom_read_block(&config, offset, sizeof(config)); \
dirty_##name = false; \
} \
} \ } \
static inline void eeconfig_flush_##name(bool force) { \ static inline void eeconfig_flush_##name(bool force) { \
if (force || dirty_##name) { \ if (force || dirty_##name) { \
eeprom_update_block(&config, offset, sizeof(config)); \ eeprom_update_block(&config, offset, sizeof(config)); \
eeconfig_post_flush_##name(); \
dirty_##name = false; \ dirty_##name = false; \
} \ } \
} \ } \
@ -130,7 +176,17 @@ void eeconfig_update_handedness(bool val);
static inline void eeconfig_flag_##name(bool v) { \ static inline void eeconfig_flag_##name(bool v) { \
dirty_##name |= v; \ dirty_##name |= v; \
} \ } \
static inline void eeconfig_write_##name(typeof(config) conf) { \ static inline void eeconfig_write_##name(typeof(config) *conf) { \
memcpy(&config, &conf, sizeof(config)); \ if (memcmp(&config, conf, sizeof(config)) != 0) { \
eeconfig_flag_##name(true); \ memcpy(&config, conf, sizeof(config)); \
eeconfig_flag_##name(true); \
} \
} }
#define EECONFIG_DEBOUNCE_HELPER(name, offset, config) \
EECONFIG_DEBOUNCE_HELPER_CHECKED(name, offset, config) \
\
bool eeconfig_check_valid_##name(void) { \
return true; \
} \
void eeconfig_post_flush_##name(void) {}