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

Additional fixes for possibly bad EEPROM data #1402

Merged
merged 6 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ uint8_t DynamicMacros::updateDynamicMacroCache() {

map_[0] = 0;

while (pos < storage_base_ + storage_size_) {
while (pos < storage_base_ + storage_size_ && current_id < MAX_MACRO_COUNT_) {
macro = Runtime.storage().read(pos++);
switch (macro) {
case MACRO_ACTION_STEP_EXPLICIT_REPORT:
Expand Down Expand Up @@ -76,7 +76,7 @@ uint8_t DynamicMacros::updateDynamicMacroCache() {
uint8_t keyCode, flags;
do {
keyCode = Runtime.storage().read(pos++);
} while (keyCode != 0);
} while ((pos < (storage_base_ + storage_size_)) && keyCode != 0);
break;
}

Expand Down Expand Up @@ -170,7 +170,7 @@ void DynamicMacros::play(uint8_t macro_id) {
while (true) {
key.setFlags(isKeycodeSequence ? 0 : storage.read(pos++));
key.setKeyCode(storage.read(pos++));
if (key == Key_NoKey)
if (key == Key_NoKey || pos >= storage_base_ + storage_size_)
break;
tap(key);
delay(interval);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,10 @@ class DynamicMacros : public kaleidoscope::Plugin {
void play(uint8_t seq_id);

private:
static const uint8_t MAX_MACRO_COUNT_ = 32;
uint16_t storage_base_;
uint16_t storage_size_;
uint16_t map_[32];
uint16_t map_[MAX_MACRO_COUNT_];
uint8_t macro_count_;
uint8_t updateDynamicMacroCache();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,13 +188,6 @@ bool EEPROMSettings::isSliceValid(uint16_t start, size_t size) {

/** Focus **/
EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *input) {
enum {
DEFAULT_LAYER,
IS_VALID,
GET_VERSION,
GET_CRC,
} sub_command;

const char *cmd_defaultLayer = PSTR("settings.defaultLayer");
const char *cmd_isValid = PSTR("settings.valid?");
const char *cmd_version = PSTR("settings.version");
Expand All @@ -203,67 +196,36 @@ EventHandlerResult FocusSettingsCommand::onFocusEvent(const char *input) {
if (::Focus.inputMatchesHelp(input))
return ::Focus.printHelp(cmd_defaultLayer, cmd_isValid, cmd_version, cmd_crc);

if (::Focus.inputMatchesCommand(input, cmd_defaultLayer))
sub_command = DEFAULT_LAYER;
else if (::Focus.inputMatchesCommand(input, cmd_isValid))
sub_command = IS_VALID;
else if (::Focus.inputMatchesCommand(input, cmd_version))
sub_command = GET_VERSION;
else if (::Focus.inputMatchesCommand(input, cmd_crc))
sub_command = GET_CRC;
else
return EventHandlerResult::OK;

switch (sub_command) {
case DEFAULT_LAYER: {
if (::Focus.inputMatchesCommand(input, cmd_defaultLayer)) {
if (::Focus.isEOL()) {
::Focus.send(::EEPROMSettings.default_layer());
} else {
uint8_t layer;
::Focus.read(layer);
::EEPROMSettings.default_layer(layer);
}
break;
}
case IS_VALID:
} else if (::Focus.inputMatchesCommand(input, cmd_isValid)) {
::Focus.send(::EEPROMSettings.isValid());
break;
case GET_VERSION:
} else if (::Focus.inputMatchesCommand(input, cmd_version)) {
::Focus.send(::EEPROMSettings.version());
break;
case GET_CRC:
} else if (::Focus.inputMatchesCommand(input, cmd_crc)) {
::Focus.sendRaw(::CRCCalculator.crc, F("/"), ::EEPROMSettings.crc());
break;
} else {
return EventHandlerResult::OK;
}

return EventHandlerResult::EVENT_CONSUMED;
}

EventHandlerResult FocusEEPROMCommand::onFocusEvent(const char *input) {
enum {
CONTENTS,
FREE,
ERASE,
} sub_command;

const char *cmd_contents = PSTR("eeprom.contents");
const char *cmd_free = PSTR("eeprom.free");
const char *cmd_erase = PSTR("eeprom.erase");

if (::Focus.inputMatchesHelp(input))
return ::Focus.printHelp(cmd_contents, cmd_free, cmd_erase);

if (::Focus.inputMatchesCommand(input, cmd_contents))
sub_command = CONTENTS;
else if (::Focus.inputMatchesCommand(input, cmd_free))
sub_command = FREE;
else if (::Focus.inputMatchesCommand(input, cmd_erase))
sub_command = ERASE;
else
return EventHandlerResult::OK;

switch (sub_command) {
case CONTENTS: {
if (::Focus.inputMatchesCommand(input, cmd_contents)) {
if (::Focus.isEOL()) {
for (uint16_t i = 0; i < Runtime.storage().length(); i++) {
uint8_t d = Runtime.storage().read(i);
Expand All @@ -277,21 +239,18 @@ EventHandlerResult FocusEEPROMCommand::onFocusEvent(const char *input) {
}
Runtime.storage().commit();
}

break;
}
case FREE:
} else if (::Focus.inputMatchesCommand(input, cmd_free)) {
::Focus.send(Runtime.storage().length() - ::EEPROMSettings.used());
break;
case ERASE: {
} else if (::Focus.inputMatchesCommand(input, cmd_erase)) {
for (uint16_t i = 0; i < Runtime.storage().length(); i++) {
Runtime.storage().update(i, EEPROMSettings::EEPROM_UNINITIALIZED_BYTE);
}
Runtime.storage().commit();
Runtime.device().rebootBootloader();
break;
}
} else {
return EventHandlerResult::OK;
}

return EventHandlerResult::EVENT_CONSUMED;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ EventHandlerResult EscapeOneShotConfig::onFocusEvent(const char *input) {
Key k;
::Focus.read(k);
::EscapeOneShot.setCancelKey(k);
Runtime.storage().put(settings_base_, ::EscapeOneShot.settings_);
Runtime.storage().commit();
}

Runtime.storage().put(settings_base_, ::EscapeOneShot.settings_);
Runtime.storage().commit();
return EventHandlerResult::EVENT_CONSUMED;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,13 @@ EventHandlerResult MouseKeysConfig::onFocusEvent(const char *input) {
::MouseKeys.setWarpGridSize(arg);
break;
}
// Update settings stored in EEPROM, and indicate that this Focus event has
// been handled successfully.
Runtime.storage().put(settings_base_, ::MouseKeys.settings_);
Runtime.storage().commit();
}

// Update settings stored in EEPROM, and indicate that this Focus event has
// been handled successfully.
Runtime.storage().put(settings_base_, ::MouseKeys.settings_);
Runtime.storage().commit();

return EventHandlerResult::EVENT_CONSUMED;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ EventHandlerResult SpaceCadetConfig::onSetup() {
}

void SpaceCadetConfig::disableSpaceCadetIfUnconfigured() {
if (Runtime.storage().isSliceUninitialized(settings_base_, sizeof(SpaceCadet::settings_)))
if (Runtime.storage().isSliceUninitialized(settings_base_, sizeof(SpaceCadet::settings_)) ||
(::SpaceCadet.settings_.mode != SpaceCadet::Mode::ON && ::SpaceCadet.settings_.mode != SpaceCadet::Mode::NO_DELAY)) {
::SpaceCadet.disable();
}
}

EventHandlerResult SpaceCadetConfig::onFocusEvent(const char *input) {
Expand Down
Loading