[Bug] Realign and size check EECONFIG structures (#20541)

Co-authored-by: Nick Brassel <nick@tzarc.org>
This commit is contained in:
Drashna Jaelre 2023-05-08 10:56:03 -07:00 committed by GitHub
parent 01be981843
commit 5c4b53a143
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 59 additions and 58 deletions

View file

@ -378,13 +378,7 @@ For inspiration and examples, check out the built-in effects under `quantum/led_
## EEPROM storage :id=eeprom-storage ## EEPROM storage :id=eeprom-storage
The EEPROM for it is currently shared with the RGB Matrix system (it's generally assumed only one feature would be used at a time), but could be configured to use its own 32bit address with: The EEPROM for it is currently shared with the RGB Matrix system (it's generally assumed only one feature would be used at a time).
```c
#define EECONFIG_LED_MATRIX (uint32_t *)28
```
Where `28` is an unused index from `eeconfig.h`.
### Direct Operation :id=direct-operation ### Direct Operation :id=direct-operation
|Function |Description | |Function |Description |

View file

@ -893,13 +893,7 @@ These are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master
## EEPROM storage :id=eeprom-storage ## EEPROM storage :id=eeprom-storage
The EEPROM for it is currently shared with the LED Matrix system (it's generally assumed only one feature would be used at a time), but could be configured to use its own 32bit address with: The EEPROM for it is currently shared with the LED Matrix system (it's generally assumed only one feature would be used at a time).
```c
#define EECONFIG_RGB_MATRIX (uint32_t *)28
```
Where `28` is an unused index from `eeconfig.h`.
## Functions :id=functions ## Functions :id=functions

View file

@ -43,6 +43,8 @@ typedef union {
}; };
} audio_config_t; } audio_config_t;
_Static_assert(sizeof(audio_config_t) == sizeof(uint8_t), "Audio EECONFIG out of spec.");
/* /*
* a 'musical note' is represented by pitch and duration; a 'musical tone' adds intensity and timbre * a 'musical note' is represented by pitch and duration; a 'musical tone' adds intensity and timbre
* https://en.wikipedia.org/wiki/Musical_tone * https://en.wikipedia.org/wiki/Musical_tone

View file

@ -44,6 +44,8 @@ typedef union {
}; };
} backlight_config_t; } backlight_config_t;
_Static_assert(sizeof(backlight_config_t) == sizeof(uint8_t), "Backlight EECONFIG out of spec.");
void backlight_init(void); void backlight_init(void);
void backlight_toggle(void); void backlight_toggle(void);
void backlight_enable(void); void backlight_enable(void);

View file

@ -46,6 +46,7 @@ void eeconfig_init_quantum(void) {
#if defined(EEPROM_DRIVER) #if defined(EEPROM_DRIVER)
eeprom_driver_erase(); eeprom_driver_erase();
#endif #endif
eeprom_update_word(EECONFIG_MAGIC, EECONFIG_MAGIC_NUMBER); eeprom_update_word(EECONFIG_MAGIC, EECONFIG_MAGIC_NUMBER);
eeprom_update_byte(EECONFIG_DEBUG, 0); eeprom_update_byte(EECONFIG_DEBUG, 0);
eeprom_update_byte(EECONFIG_DEFAULT_LAYER, 0); eeprom_update_byte(EECONFIG_DEFAULT_LAYER, 0);
@ -55,19 +56,15 @@ void eeconfig_init_quantum(void) {
eeprom_update_byte(EECONFIG_BACKLIGHT, 0); eeprom_update_byte(EECONFIG_BACKLIGHT, 0);
eeprom_update_byte(EECONFIG_AUDIO, 0xFF); // On by default eeprom_update_byte(EECONFIG_AUDIO, 0xFF); // On by default
eeprom_update_dword(EECONFIG_RGBLIGHT, 0); eeprom_update_dword(EECONFIG_RGBLIGHT, 0);
eeprom_update_byte(EECONFIG_STENOMODE, 0); eeprom_update_byte(EECONFIG_RGBLIGHT_EXTENDED, 0);
eeprom_update_dword(EECONFIG_HAPTIC, 0);
eeprom_update_byte(EECONFIG_VELOCIKEY, 0); eeprom_update_byte(EECONFIG_VELOCIKEY, 0);
eeprom_update_dword(EECONFIG_RGB_MATRIX, 0); eeprom_update_byte(EECONFIG_UNICODEMODE, 0);
eeprom_update_word(EECONFIG_RGB_MATRIX_EXTENDED, 0); eeprom_update_byte(EECONFIG_STENOMODE, 0);
uint64_t dummy = 0;
eeprom_update_block(&dummy, EECONFIG_RGB_MATRIX, sizeof(uint64_t));
eeprom_update_dword(EECONFIG_HAPTIC, 0);
#if defined(HAPTIC_ENABLE) #if defined(HAPTIC_ENABLE)
haptic_reset(); haptic_reset();
#else
// this is used in case haptic is disabled, but we still want sane defaults
// in the haptic configuration eeprom. All zero will trigger a haptic_reset
// when a haptic-enabled firmware is loaded onto the keyboard.
eeprom_update_dword(EECONFIG_HAPTIC, 0);
#endif #endif
#if (EECONFIG_KB_DATA_SIZE) > 0 #if (EECONFIG_KB_DATA_SIZE) > 0

View file

@ -21,7 +21,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <stdbool.h> #include <stdbool.h>
#ifndef EECONFIG_MAGIC_NUMBER #ifndef EECONFIG_MAGIC_NUMBER
# define EECONFIG_MAGIC_NUMBER (uint16_t)0xFEE7 // When changing, decrement this value to avoid future re-init issues # define EECONFIG_MAGIC_NUMBER (uint16_t)0xFEE6 // When changing, decrement this value to avoid future re-init issues
#endif #endif
#define EECONFIG_MAGIC_NUMBER_OFF (uint16_t)0xFFFF #define EECONFIG_MAGIC_NUMBER_OFF (uint16_t)0xFFFF
@ -40,18 +40,15 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define EECONFIG_KEYBOARD (uint32_t *)15 #define EECONFIG_KEYBOARD (uint32_t *)15
#define EECONFIG_USER (uint32_t *)19 #define EECONFIG_USER (uint32_t *)19
#define EECONFIG_VELOCIKEY (uint8_t *)23 #define EECONFIG_VELOCIKEY (uint8_t *)23
#define EECONFIG_HAPTIC (uint32_t *)24
// Mutually exclusive // Mutually exclusive
#define EECONFIG_LED_MATRIX (uint32_t *)28 #define EECONFIG_LED_MATRIX (uint32_t *)24
#define EECONFIG_RGB_MATRIX (uint32_t *)28 #define EECONFIG_RGB_MATRIX (uint64_t *)24
// Speed & Flags
#define EECONFIG_LED_MATRIX_EXTENDED (uint16_t *)32 #define EECONFIG_HAPTIC (uint32_t *)32
#define EECONFIG_RGB_MATRIX_EXTENDED (uint16_t *)32 #define EECONFIG_RGBLIGHT_EXTENDED (uint8_t *)36
// Size of EEPROM being used for core data storage // Size of EEPROM being used for core data storage
#define EECONFIG_BASE_SIZE 34 #define EECONFIG_BASE_SIZE 37
// Size of EEPROM dedicated to keyboard- and user-specific data // Size of EEPROM dedicated to keyboard- and user-specific data
#ifndef EECONFIG_KB_DATA_SIZE #ifndef EECONFIG_KB_DATA_SIZE

View file

@ -31,16 +31,18 @@ typedef union {
uint32_t raw; uint32_t raw;
struct { struct {
bool enable : 1; bool enable : 1;
uint8_t feedback : 2;
uint8_t mode : 7; uint8_t mode : 7;
bool buzz : 1; bool buzz : 1;
uint8_t dwell : 7; uint8_t dwell : 7;
bool cont : 1;
uint8_t amplitude : 8; uint8_t amplitude : 8;
uint8_t feedback : 2;
bool cont : 1;
uint8_t reserved : 5; uint8_t reserved : 5;
}; };
} haptic_config_t; } haptic_config_t;
_Static_assert(sizeof(haptic_config_t) == sizeof(uint32_t), "Haptic EECONFIG out of spec.");
typedef enum HAPTIC_FEEDBACK { typedef enum HAPTIC_FEEDBACK {
KEY_PRESS, KEY_PRESS,
KEY_PRESS_RELEASE, KEY_PRESS_RELEASE,

View file

@ -16,6 +16,10 @@
#pragma once #pragma once
#ifdef __cplusplus
# define _Static_assert static_assert
#endif
#include "eeconfig.h" #include "eeconfig.h"
#include "keycode.h" #include "keycode.h"
#include "action_code.h" #include "action_code.h"
@ -43,4 +47,6 @@ typedef union {
}; };
} keymap_config_t; } keymap_config_t;
_Static_assert(sizeof(keymap_config_t) == sizeof(uint16_t), "Keycode (magic) EECONFIG out of spec.");
extern keymap_config_t keymap_config; extern keymap_config_t keymap_config;

View file

@ -85,13 +85,14 @@ typedef union {
struct PACKED { struct PACKED {
uint8_t enable : 2; uint8_t enable : 2;
uint8_t mode : 6; uint8_t mode : 6;
uint16_t reserved;
uint8_t val; uint8_t val;
uint8_t speed; // EECONFIG needs to be increased to support this uint8_t speed;
led_flags_t flags; led_flags_t flags;
}; };
} led_eeconfig_t; } led_eeconfig_t;
_Static_assert(sizeof(led_eeconfig_t) == sizeof(uint32_t), "LED Matrix EECONFIG out of spec.");
#if defined(_MSC_VER) #if defined(_MSC_VER)
# pragma pack(pop) # pragma pack(pop)
#endif #endif

View file

@ -83,16 +83,18 @@ typedef struct PACKED {
} led_config_t; } led_config_t;
typedef union { typedef union {
uint32_t raw; uint64_t raw;
struct PACKED { struct PACKED {
uint8_t enable : 2; uint8_t enable : 2;
uint8_t mode : 6; uint8_t mode : 6;
HSV hsv; HSV hsv;
uint8_t speed; // EECONFIG needs to be increased to support this uint8_t speed;
led_flags_t flags; led_flags_t flags;
}; };
} rgb_config_t; } rgb_config_t;
_Static_assert(sizeof(rgb_config_t) == sizeof(uint64_t), "RGB Matrix EECONFIG out of spec.");
#if defined(_MSC_VER) #if defined(_MSC_VER)
# pragma pack(pop) # pragma pack(pop)
#endif #endif

View file

@ -177,18 +177,19 @@ void rgblight_check_config(void) {
} }
} }
uint32_t eeconfig_read_rgblight(void) { uint64_t eeconfig_read_rgblight(void) {
#ifdef EEPROM_ENABLE #ifdef EEPROM_ENABLE
return eeprom_read_dword(EECONFIG_RGBLIGHT); return (uint64_t)((eeprom_read_dword(EECONFIG_RGBLIGHT)) | ((uint64_t)eeprom_read_byte(EECONFIG_RGBLIGHT_EXTENDED) << 32));
#else #else
return 0; return 0;
#endif #endif
} }
void eeconfig_update_rgblight(uint32_t val) { void eeconfig_update_rgblight(uint64_t val) {
#ifdef EEPROM_ENABLE #ifdef EEPROM_ENABLE
rgblight_check_config(); rgblight_check_config();
eeprom_update_dword(EECONFIG_RGBLIGHT, val); eeprom_update_dword(EECONFIG_RGBLIGHT, val & 0xFFFFFFFF);
eeprom_update_byte(EECONFIG_RGBLIGHT_EXTENDED, (val >> 32) & 0xFF);
#endif #endif
} }
@ -263,13 +264,13 @@ void rgblight_reload_from_eeprom(void) {
} }
} }
uint32_t rgblight_read_dword(void) { uint64_t rgblight_read_qword(void) {
return rgblight_config.raw; return rgblight_config.raw;
} }
void rgblight_update_dword(uint32_t dword) { void rgblight_update_qword(uint64_t qword) {
RGBLIGHT_SPLIT_SET_CHANGE_MODEHSVS; RGBLIGHT_SPLIT_SET_CHANGE_MODEHSVS;
rgblight_config.raw = dword; rgblight_config.raw = qword;
if (rgblight_config.enable) if (rgblight_config.enable)
rgblight_mode_noeeprom(rgblight_config.mode); rgblight_mode_noeeprom(rgblight_config.mode);
else { else {
@ -489,7 +490,7 @@ void rgblight_increase_speed_helper(bool write_to_eeprom) {
if (rgblight_config.speed < 3) rgblight_config.speed++; if (rgblight_config.speed < 3) rgblight_config.speed++;
// RGBLIGHT_SPLIT_SET_CHANGE_HSVS; // NEED? // RGBLIGHT_SPLIT_SET_CHANGE_HSVS; // NEED?
if (write_to_eeprom) { if (write_to_eeprom) {
eeconfig_update_rgblight(rgblight_config.raw); // EECONFIG needs to be increased to support this eeconfig_update_rgblight(rgblight_config.raw);
} }
} }
void rgblight_increase_speed(void) { void rgblight_increase_speed(void) {
@ -503,7 +504,7 @@ void rgblight_decrease_speed_helper(bool write_to_eeprom) {
if (rgblight_config.speed > 0) rgblight_config.speed--; if (rgblight_config.speed > 0) rgblight_config.speed--;
// RGBLIGHT_SPLIT_SET_CHANGE_HSVS; // NEED?? // RGBLIGHT_SPLIT_SET_CHANGE_HSVS; // NEED??
if (write_to_eeprom) { if (write_to_eeprom) {
eeconfig_update_rgblight(rgblight_config.raw); // EECONFIG needs to be increased to support this eeconfig_update_rgblight(rgblight_config.raw);
} }
} }
void rgblight_decrease_speed(void) { void rgblight_decrease_speed(void) {
@ -612,7 +613,7 @@ uint8_t rgblight_get_speed(void) {
void rgblight_set_speed_eeprom_helper(uint8_t speed, bool write_to_eeprom) { void rgblight_set_speed_eeprom_helper(uint8_t speed, bool write_to_eeprom) {
rgblight_config.speed = speed; rgblight_config.speed = speed;
if (write_to_eeprom) { if (write_to_eeprom) {
eeconfig_update_rgblight(rgblight_config.raw); // EECONFIG needs to be increased to support this eeconfig_update_rgblight(rgblight_config.raw);
dprintf("rgblight set speed [EEPROM]: %u\n", rgblight_config.speed); dprintf("rgblight set speed [EEPROM]: %u\n", rgblight_config.speed);
} else { } else {
dprintf("rgblight set speed [NOEEPROM]: %u\n", rgblight_config.speed); dprintf("rgblight set speed [NOEEPROM]: %u\n", rgblight_config.speed);

View file

@ -244,19 +244,20 @@ extern const uint16_t RGBLED_RGBTEST_INTERVALS[1] PROGMEM;
extern const uint8_t RGBLED_TWINKLE_INTERVALS[3] PROGMEM; extern const uint8_t RGBLED_TWINKLE_INTERVALS[3] PROGMEM;
extern bool is_rgblight_initialized; extern bool is_rgblight_initialized;
// Should stay in sycn with rgb matrix config as we reuse eeprom storage for both (for now)
typedef union { typedef union {
uint32_t raw; uint64_t raw;
struct { struct {
bool enable : 1; bool enable : 1;
uint8_t mode : 7; uint8_t mode : 7;
uint8_t hue : 8; uint8_t hue : 8;
uint8_t sat : 8; uint8_t sat : 8;
uint8_t val : 8; uint8_t val : 8;
uint8_t speed : 8; // EECONFIG needs to be increased to support this uint8_t speed : 8;
}; };
} rgblight_config_t; } rgblight_config_t;
_Static_assert(sizeof(rgblight_config_t) == sizeof(uint64_t), "RGB Light EECONFIG out of spec.");
typedef struct _rgblight_status_t { typedef struct _rgblight_status_t {
uint8_t base_mode; uint8_t base_mode;
bool timer_enabled; bool timer_enabled;
@ -367,10 +368,10 @@ HSV rgblight_get_hsv(void);
void rgblight_init(void); void rgblight_init(void);
void rgblight_suspend(void); void rgblight_suspend(void);
void rgblight_wakeup(void); void rgblight_wakeup(void);
uint32_t rgblight_read_dword(void); uint64_t rgblight_read_qword(void);
void rgblight_update_dword(uint32_t dword); void rgblight_update_qword(uint64_t qword);
uint32_t eeconfig_read_rgblight(void); uint64_t eeconfig_read_rgblight(void);
void eeconfig_update_rgblight(uint32_t val); void eeconfig_update_rgblight(uint64_t val);
void eeconfig_update_rgblight_current(void); void eeconfig_update_rgblight_current(void);
void eeconfig_update_rgblight_default(void); void eeconfig_update_rgblight_default(void);
void eeconfig_debug_rgblight(void); void eeconfig_debug_rgblight(void);

View file

@ -21,12 +21,14 @@
#include "quantum.h" #include "quantum.h"
typedef union { typedef union {
uint32_t raw; uint8_t raw;
struct { struct {
uint8_t input_mode : 8; uint8_t input_mode : 8;
}; };
} unicode_config_t; } unicode_config_t;
_Static_assert(sizeof(unicode_config_t) == sizeof(uint8_t), "Unicode EECONFIG out of spec.");
extern unicode_config_t unicode_config; extern unicode_config_t unicode_config;
enum unicode_input_modes { enum unicode_input_modes {