Rev 0.9: The user can now delete presets

Author: ScrapComputing

README.md

@@ -52,6 +52,10 @@ It is tailored to the needs of vintage PC enthusiasts, so it drives a 4-digit 7-
 - The devices starts at the "Presets" state (mode).
 - Turn the knob to select a frequency
 - Short push to switch to fine-grain frequency selection
+- Long push to enter configuration of the current preset:
+  - Fine-tune actual frequency, short push to switch to PWM period tuning. Long-push escapes.
+  - Fine-tune PWM period, short push to switch to preset deletion. Long-push escapes.
+  - Select if preset should be deleted, short push to confirm.
 
 <img src='img/rotary_states.png' height=240 width=auto>
 
@@ -95,6 +99,12 @@ It is tailored to the needs of vintage PC enthusiasts, so it drives a 4-digit 7-
 You can connect to the Throttle Blaster via the serial port and set the Frequency and PWM Period.
 This is convenient for launching a game with a `.bat` file that first configures the Throttle Blaster and then launches the game.
 
+## Reset to factory defaults during power on (since rev 0.9)
+
+Press the button (rotary encoder, or any individual button in other modes) and plug in the ThrottleBlaster to power. The led on the Pico will start flashing fast for around 2 seconds and the MHz display will show "RES".
+
+This helps revert the deleted presets or any potential flash-related issue.
+
 ### UART Circuit
 - Connect the Throttle Blaster's Tx pin to the PC's serial port Rx pin (that is pin 2 of the serial connector), the Throttle Blaster's Rx pin to serial Tx (pin 3) and ground to ground (pin 5)
 
@@ -277,6 +287,7 @@ So I don't think there is a way to get the Throttle Blaster to work universally
 
 
 # Change Log
+- Rev 0.9: Allows deletion of presets and adds flash reset when button pressed during boot.
 - Rev 0.8e: Fixes single/two-button configuration bug (introduced in 0.8b). Adds Pico2 support.
 - Rev 0.8d: Fixes reset detection
 - Rev 0.8c: Fixes bugs introduced in Rev 0.8b.

firmware/src/CMakeLists.txt

@@ -11,7 +11,6 @@ cmake_minimum_required(VERSION 3.13)
 # -------
 # o -DDISPLAY_SHIFT_LEFT=<num> If the numbers displayed need shifting
 # o -DDISPLAY_BRIGHTNESS=<num> (0-7) Sets the brightness 7 is max, default: 1.
-# o -DDISABLE_PICO_LED=on to disable the Pico's blinking LED.
 # o -DDBGPRINT=on to enable debug messages
 #
 # This will place the firmware into: build/ThrottleBlaster.uf2
@@ -100,7 +99,6 @@ if (DISABLE_USB_DBG STREQUAL "0")
 endif ()
 message("DISABLE_USB_DBG = ${DISABLE_USB_DBG}")
 
-message("PICO_LED = ${PICO_LED}")
 message("PICO_TM1637_PATH = ${PICO_TM1637_PATH}")
 message("LCD_SHIFT_LEFT = ${LCD_SHIFT_LEFT}")
 message("MHZ = ${MHZ}")

firmware/src/CommonLogic.cpp

@@ -9,6 +9,7 @@ void CommonLogic::setMode(Mode NewMode) {
   BeforeMaxMHz = Presets.getMaxMHz();
   BeforePeriod = Presets.getPeriod();
   BeforeActualKHz = Presets.getActualKHz();
+  BeforeDeleted = Presets.isDeleted();
 
   CurrMode = NewMode;
   DBG_PRINT(std::cout << getModeStr(CurrMode) << "\n";)
@@ -17,7 +18,8 @@ void CommonLogic::setMode(Mode NewMode) {
 void CommonLogic::tryWritePresetsToFlash() {
   if (Presets.getActualKHz() != BeforeActualKHz ||
       Presets.getPeriod() != BeforePeriod ||
-      Presets.getMaxMHz() != BeforeMaxMHz) {
+      Presets.getMaxMHz() != BeforeMaxMHz ||
+      Presets.isDeleted() != BeforeDeleted) {
     DBG_PRINT(std::cout << "WriteToFlash:\n";)
     DBG_PRINT(std::cout << "           Before After\n";)
     DBG_PRINT(std::cout << "ActualKHz: " << BeforeActualKHz << " "
@@ -26,6 +28,8 @@ void CommonLogic::tryWritePresetsToFlash() {
                         << Presets.getPeriod() << "\n";)
     DBG_PRINT(std::cout << "MaxMHz:    " << BeforeMaxMHz << " "
                         << Presets.getMaxMHz() << "\n";)
+    DBG_PRINT(std::cout << "Deleted:    " << BeforeDeleted << " "
+                        << Presets.isDeleted() << "\n";)
     Presets.writeToFlash(Flash);
   } else {
     DBG_PRINT(
@@ -50,6 +54,9 @@ void CommonLogic::updateDisplay() {
   case Mode::ConfigPeriod:
     Disp.printRaw(Presets.getPeriod());
     break;
+  case Mode::DeletePreset:
+    Disp.printTxt(Presets.isDeleted() ? MsgYes : MsgNo);
+    break;
   case Mode::Manual:
   case Mode::Uart:
     Disp.printKHz(DC.getKHz());

firmware/src/CommonLogic.h

@@ -32,6 +32,7 @@ class CommonLogic {
     Presets,
     ConfigMHz,
     ConfigPeriod,
+    DeletePreset,
     Manual,
     ConfigMaxMHz,
     ResetToDefaults,
@@ -46,6 +47,7 @@ class CommonLogic {
     case Mode::Presets: return "Presets";
     case Mode::ConfigMHz: return "ConfigMHz";
     case Mode::ConfigPeriod: return "ConfigPeriod";
+    case Mode::DeletePreset: return "DeletePreset";
     case Mode::Manual: return "Manual";
     case Mode::ConfigMaxMHz: return "ConfigMaxMHz";
     case Mode::ResetToDefaults: return "ResetToDefaults";
@@ -60,6 +62,7 @@ class CommonLogic {
   void tryWritePresetsToFlash();
   Mode getMode() const { return CurrMode; }
 
+public:
   static constexpr const char *MsgActualFreq = "FrE";
   static constexpr const char *MsgPeriod = "PEr";
   static constexpr const char *MsgMaxMHz = "CPUF";
@@ -71,10 +74,15 @@ class CommonLogic {
   static constexpr const char *MsgUartErr = "UErr";
   static constexpr const char *MsgUartMode = "UArt";
   static constexpr const char *MsgResetDetected = "boot";
+  static constexpr const char *MsgDeletePreset = "dEL";
+  static constexpr const char *MsgYes = "yes";
+  static constexpr const char *MsgNo = " no";
 
+protected:
   int BeforeMaxMHz = 0;
   int BeforeActualKHz = 0;
   int BeforePeriod = 0;
+  bool BeforeDeleted = false;
 
   std::vector<Button</*OffVal=*/true, ButtonDebounceSz, ButtonLongPressCnt,
                      ButtonMedReleaseCnt>>

firmware/src/ConfigOpts.h

@@ -99,4 +99,10 @@ static constexpr const int PrintSleep = 1000;
 // No need to update the PWM period on every UI tick. Skip this many.
 static constexpr const int UpdatePWMSamplePeriod = 8;
 
+// Factory defaults press button.
+static constexpr const int ResetBtnPressMs = 2000;
+static constexpr const int ResetBtnCheckMs = 50;
+static constexpr const int ResetDefaultsFlashOnMs = 100;
+static constexpr const uint32_t ResetDefaultFlashCnt = 20;
+
 #endif // __CONFIGOPTS_H__

firmware/src/Flash.h

@@ -15,7 +15,7 @@ class FlashStorage {
   // Use the last sector (4KB) of the 2MB flash.
   static constexpr const int BaseOffset = 2 * (1u << 20) - FLASH_SECTOR_SIZE;
   static constexpr const int BytesToFlash = FLASH_SECTOR_SIZE;
-  std::vector<int> MagicNumber = {11111111, 42, 0, 666, 11111111};
+  std::vector<int> MagicNumber = {11191111, 42 + 1, 0, 666, 11111191};
 
   /// Points to the first usable int ptr, after the magic number and revision.
   const int *FlashArray = nullptr;
@@ -26,9 +26,7 @@ class FlashStorage {
   FlashStorage();
   void write(const std::vector<int> &Values);
   /// \Reads a value at \p ValueIdx offset (after the magic numbers).
-  int read(int ValueIdx) const {
-    return FlashArray[ValueIdx];
-  }
+  int read(int ValueIdx) const { return FlashArray[ValueIdx]; }
   std::pair<int, int> readRevision() const;
   std::vector<int> readMagicNumber() const;
   bool valid() const;

firmware/src/PotentiometerLogic.cpp

@@ -85,11 +85,11 @@ void PotentiometerLogic::configPeriod(int PotVal, ButtonState BtnState) {
     DBG_PRINT(std::cout << "Period=" << Presets.getPeriod() << "\n";)
     return;
   case ButtonState::LongPress:
-    tryWritePresetsToFlash();
     Disp.setFlash(false);
-    printTxtAndSleep(MsgConfirm);
+    printTxtAndSleep(MsgDeletePreset);
     savePotVal(PotVal);
-    setMode(Mode::Presets);
+    setMode(Mode::DeletePreset);
+    Disp.setFlash(true);
     return;
   default:
     break;
@@ -112,6 +112,39 @@ void PotentiometerLogic::configPeriod(int PotVal, ButtonState BtnState) {
   }
 }
 
+void PotentiometerLogic::configDeletePreset(int PotVal, ButtonState BtnState) {
+  switch (BtnState) {
+  case ButtonState::Release:
+  case ButtonState::MedRelease:
+    Presets.toggleDeleted();
+    DBG_PRINT(std::cout << "Deleted=" << Presets.isDeleted() << "\n";)
+    return;
+  case ButtonState::LongPress:
+    tryWritePresetsToFlash();
+    Disp.setFlash(false);
+    printTxtAndSleep(MsgConfirm);
+    savePotVal(PotVal);
+    setMode(Mode::Presets);
+    if (Presets.isDeleted())
+      Presets.prev();
+    return;
+  default:
+    break;
+  }
+
+  // If we moved the potentiometer enough, use it to control the value.
+  if (EnablePot && movedPotComparedToSaved(PotVal)) {
+    switch (getPotDir(PotVal)) {
+    case PotDir::Right:
+    case PotDir::Left:
+      Presets.toggleDeleted();
+      break;
+    default:
+      break;
+    }
+  }
+}
+
 void PotentiometerLogic::configResetToDefaults(int PotVal,
                                                ButtonState BtnState) {
   auto DontReset = [this, PotVal]() {
@@ -249,6 +282,9 @@ void PotentiometerLogic::tick() {
   case Mode::ConfigPeriod:
     configPeriod(PotVal, BtnState);
     break;
+  case Mode::DeletePreset:
+    configDeletePreset(PotVal, BtnState);
+    break;
   case Mode::ConfigMaxMHz:
     configMaxMHz(PotVal, BtnState);
     break;

firmware/src/PotentiometerLogic.h

@@ -43,6 +43,8 @@ class PotentiometerLogic : public CommonLogic {
 
   void configPeriod(int PotVal, ButtonState BtnState);
 
+  void configDeletePreset(int PotVal, ButtonState BtnState);
+
   void configResetToDefaults(int PotVal, ButtonState BtnState);
 
   void configMaxMHz(int PotVal, ButtonState BtnState);
@@ -86,9 +88,12 @@ class PotentiometerLogic : public CommonLogic {
       : CommonLogic(SamplePeriod, Disp, DC, Presets, Flash, Pi),
         Btn(ButtonGPIO, Pi, "Pot.Btn"), Pot(PotGPIO, Pi, ReverseDirection),
         Pi(Pi), EnablePot(EnablePot) {
-    // One of the potentiometer's best features is that it remembers its
-    // positions across rrestarts. So start in manual mode to make use of it.
-    setMode(Mode::Manual);
+    if (EnablePot)
+      // One of the potentiometer's best features is that it remembers its
+      // positions across restarts. So start in manual mode to make use of it.
+      setMode(Mode::Manual);
+    else
+      setMode(Mode::Presets);
   }
   void tick() final;
 };

firmware/src/Presets.cpp

@@ -32,8 +32,17 @@ void PresetsTable::decrPeriod() {
   Val = std::max(PeriodLimitLo, Val - 1);
 }
 
+int PresetsTable::minNonDeleted() const {
+  for (int Idx = 0, E = getMaxIdx(); Idx <= E; ++Idx) {
+    if (!Table[Idx].Deleted)
+      return Idx;
+  }
+  std::cerr << "minNonDeleted() beyond max!\n";
+  return 0;
+}
+
 void PresetsTable::cyclePrev() {
-  if (Idx == 0)
+  if (Idx == minNonDeleted())
     Idx = getMaxIdx();
   else
     prev();

firmware/src/Presets.h

@@ -17,44 +17,45 @@ class PresetsTable {
   struct Entry {
     int PresetKHz;
     int ActualKHz;
-    int Period; ///> PWM Period
+    int Period;                 ///> PWM Period.
+    bool Deleted = false;       ///> If the user has deleted this preset.
     Entry(int PresetKHz, int ActualKHz, int Period)
         : PresetKHz(PresetKHz), ActualKHz(ActualKHz), Period(Period) {}
     Entry(FlashStorage &Flash, int &Offset) {
       PresetKHz = Flash.read(Offset++);
       ActualKHz = Flash.read(Offset++);
       Period = Flash.read(Offset++);
+      Deleted = Flash.read(Offset++);
     }
     void dump() const {
-      std::cout << PresetKHz << ", " << ActualKHz << ", " << Period << "\n";
+      std::cout << PresetKHz << ", " << ActualKHz << ", " << Period << ", "
+                << Deleted << "\n";
     }
     /// Helper for writing to Flash.
     void appendToVec(std::vector<int> &Vec) const {
       Vec.push_back(PresetKHz);
       Vec.push_back(ActualKHz);
       Vec.push_back(Period);
+      Vec.push_back(Deleted);
     }
     unsigned checksum() const {
-      return (unsigned)PresetKHz ^ (unsigned)ActualKHz ^ (unsigned)Period;
+      return (unsigned)PresetKHz ^ (unsigned)ActualKHz ^ (unsigned)Period ^
+             (unsigned)Deleted;
     }
   };
 
   static constexpr const int DefaultPeriod = 8; // ~50us
 
-  // const std::vector<Entry> ImmutableTable = {
-  //     {4770, 4770, DefaultPeriod},     {8000, 8000, DefaultPeriod},
-  //     {10000, 10000, DefaultPeriod},   {25000, 25000, DefaultPeriod},
-  //     {33000, 33000, DefaultPeriod},   {66000, 66000, DefaultPeriod},
-  //     {100000, 100000, DefaultPeriod}, {133000, 133000, DefaultPeriod},
-  //     {266000, 266000, DefaultPeriod}, {450000, 450000, DefaultPeriod},
-  //     {733000, 733000, DefaultPeriod}, {1000000, 1000000, DefaultPeriod},
-  //     {1666000, 1666000, DefaultPeriod}, {3200000, 3200000, DefaultPeriod}};
   const std::vector<Entry> ImmutableTable = {
-      {4770, 4770, DefaultPeriod},     {8000, 8000, DefaultPeriod},
-      {10000, 10000, DefaultPeriod},   {25000, 25000, DefaultPeriod},
-      {33000, 33000, DefaultPeriod},   {66000, 66000, DefaultPeriod},
-      {133000, 133000, DefaultPeriod}, {450000, 450000, DefaultPeriod},
-      {733000, 733000, DefaultPeriod}};
+      Entry(4770, 4770, DefaultPeriod),
+      Entry(8000, 8000, DefaultPeriod),
+      Entry(10000, 10000, DefaultPeriod),
+      Entry(25000, 25000, DefaultPeriod),
+      Entry(33000, 33000, DefaultPeriod),
+      Entry(66000, 66000, DefaultPeriod),
+      Entry(133000, 133000, DefaultPeriod),
+      Entry(450000, 450000, DefaultPeriod),
+      Entry(733000, 733000, DefaultPeriod)};
 
   std::vector<Entry> Table;
 
@@ -77,10 +78,28 @@ class PresetsTable {
   void decrActualKHz();
   int getPeriod() const { return Table[Idx].Period; }
   void incrPeriod();
+  void toggleDeleted() { Table[Idx].Deleted = !Table[Idx].Deleted; }
+  bool isDeleted() const { return Table[Idx].Deleted; }
   void decrPeriod();
-  void prev() { Idx = std::max(0, Idx - 1); }
-  void next() { Idx = std::min(getMaxIdx(), Idx + 1); }
+  void prev() {
+    int FoundIdx = Idx;
+    do {
+      --FoundIdx;
+    } while (FoundIdx >= 0 && Table[FoundIdx].Deleted);
+    if (FoundIdx >= 0)            // if legal
+      Idx = FoundIdx;
+  }
+  void next() {
+    int FoundIdx = Idx;
+    do {
+      ++FoundIdx;
+    } while (FoundIdx < getMaxIdx() && Table[FoundIdx].Deleted);
+    if (FoundIdx <= getMaxIdx()) // if legal
+      Idx = FoundIdx;
+  }
   void setIdx(int NewIdx) { Idx = std::clamp(NewIdx, 0, getMaxIdx()); }
+  /// Returns the minimum Idx that is not deleted.
+  int minNonDeleted() const;
   void cyclePrev();
   void cycleNext();
   void cycleMax();