Merge pull request #6 from higaski/erase_flash

feat: add `erase_flash` option

Author: higaski

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
-##
+## 1.10.0
+- Adopt esp-serial-flasher version number
+- Add `erase_flash` command ([#6](https://github.com/higaski/QtESPFlasher/pull/6))
 - Update to esp-serial-flasher 1.10.0
 - Update to esptool-legacy-flasher-stub 1.9.0
 

README.md

@@ -44,7 +44,7 @@ It currently supports the following ESP microcontrollers:
   - a [flasher_args.json](https://github.com/espressif/esp-idf/blob/master/components/esptool_py/flasher_args.json.in) file
   - a .zip archive
   - single/multiple loose binaries
-- CLI is a drop-in replace for [esptools write-flash](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/basic-commands.html#write-binary-data-to-flash-write-flash) command
+- CLI is a drop-in replacement for the [write-flash](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/basic-commands.html#write-binary-data-to-flash-write-flash) and [erase-flash](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/basic-commands.html#erase-flash-erase-flash-erase-region) commands of [esptool](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/index.html)
 - `ESPFlasher` [Qt widget library](/libs/esp_flasher) for reuse
 - Pre-built Windows and Linux executables
 
@@ -94,7 +94,7 @@ The default QtESPFlasher baud rate is 115200. Slower rates may be set using `-b`
 
 ## Usage
 ### CLI
-When used as a command line tool QtESPFlasher can be a drop-in replace for the [esptools write-flash](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/basic-commands.html#write-binary-data-to-flash-write-flash) command.
+When used as a command line tool QtESPFlasher can be a drop-in replacement for [write-flash](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/basic-commands.html#write-binary-data-to-flash-write-flash) and [erase-flash](https://docs.espressif.com/projects/esptool/en/latest/esp32/esptool/basic-commands.html#erase-flash-erase-flash-erase-region).
 
 ```sh
 ./QtESPFlasher -p ttyUSB0 write_flash 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin

libs/esp_flasher/include/esp_flasher/esp_flasher.hpp

@@ -35,11 +35,12 @@ class EspFlasher : public QObject {
              QString after,
              QString no_stub,
              QString trace,
-             QVector<Bin> bins);
+             QVector<Bin> bins = {});
   ~EspFlasher();
 
 public slots:
   esp_loader_error_t flash();
+  esp_loader_error_t erase();
 
 signals:
   void finished();
@@ -97,4 +98,4 @@ public slots:
   static_assert(SERIAL_FLASHER_BOOT_HOLD_TIME_MS == 50);
   static inline uint32_t _reset_hold_time_ms{SERIAL_FLASHER_RESET_HOLD_TIME_MS};
   static inline uint32_t _boot_hold_time_ms{SERIAL_FLASHER_BOOT_HOLD_TIME_MS};
-};
+};

libs/esp_flasher/src/esp_flasher.cpp

@@ -111,7 +111,7 @@ EspFlasher::~EspFlasher() {
 ///
 /// \retval ESP_LOADER_SUCCESS              Success
 /// \retval ESP_LOADER_ERROR_FAIL           Unspecified error
-/// \retval ESP_LOADER_ERROR_TIMEOUT        Timeout elapsed
+/// \retval ESP_LOADER_ERROR_TIMEOUT        Timeout
 /// \retval ESP_LOADER_ERROR_INVALID_PARAM  Invalid parameter
 /// \retval ESP_LOADER_ERROR_INVALID_TARGET Connected target is invalid
 esp_loader_error_t EspFlasher::flash() {
@@ -150,6 +150,38 @@ esp_loader_error_t EspFlasher::flash() {
   return ESP_LOADER_SUCCESS;
 }
 
+/// Erase
+///
+/// \retval ESP_LOADER_SUCCESS                Success
+/// \retval ESP_LOADER_ERROR_TIMEOUT          Timeout
+/// \retval ESP_LOADER_ERROR_INVALID_RESPONSE Internal error
+esp_loader_error_t EspFlasher::erase() {
+  gsl::final_action emit_finished{[this] { emit finished(); }};
+
+  // Try to connect
+  if (auto const err{connect()}; err != ESP_LOADER_SUCCESS) {
+    qCritical().noquote().nospace()
+      << "Cannot connect to target (" << qstrerr(err) << ")";
+    return err;
+  }
+
+  // Erase
+  qInfo().nospace() << "Erasing flash (this may take a while)...";
+  if (auto const err{esp_loader_flash_erase()}; err != ESP_LOADER_SUCCESS) {
+    qCritical().noquote().nospace() << "Erase failed (" << qstrerr(err) << ")";
+    return err;
+  }
+
+  if (_after == "hard_reset") {
+    qInfo().noquote() << "Hard resetting via RTS pin...";
+    loader_port_reset_target();
+  }
+
+  qInfo().noquote() << "Done";
+
+  return ESP_LOADER_SUCCESS;
+}
+
 /// Change to higher baud rate
 ///
 /// \retval ESP_LOADER_SUCCESS                Success
@@ -219,7 +251,7 @@ QSerialPort::SerialPortError EspFlasher::open(QString port, QString baud) {
 /// \param  connect_config                  Timing parameters
 /// \retval ESP_LOADER_SUCCESS              Success
 /// \retval ESP_LOADER_ERROR_FAIL           Unspecified error
-/// \retval ESP_LOADER_ERROR_TIMEOUT        Timeout elapsed
+/// \retval ESP_LOADER_ERROR_TIMEOUT        Timeout
 /// \retval ESP_LOADER_ERROR_INVALID_PARAM  Invalid parameter
 /// \retval ESP_LOADER_ERROR_INVALID_TARGET Connected target is invalid
 esp_loader_error_t
@@ -290,7 +322,7 @@ EspFlasher::connect(esp_loader_connect_args_t connect_config) {
 /// \param  bin                             Binary
 /// \retval ESP_LOADER_SUCCESS              Success
 /// \retval ESP_LOADER_ERROR_FAIL           Unspecified error
-/// \retval ESP_LOADER_ERROR_TIMEOUT        Timeout elapsed
+/// \retval ESP_LOADER_ERROR_TIMEOUT        Timeout
 /// \retval ESP_LOADER_ERROR_INVALID_PARAM  Invalid parameter
 esp_loader_error_t EspFlasher::flash(Bin const& bin) {
   constexpr uint32_t block_size{1024u};
@@ -358,7 +390,7 @@ esp_loader_error_t EspFlasher::flash(Bin const& bin) {
 /// \param  size                      Number of bytes to read
 /// \param  timeout                   Timeout in milliseconds
 /// \retval ESP_LOADER_SUCCESS        Success
-/// \retval ESP_LOADER_ERROR_TIMEOUT  Timeout elapsed
+/// \retval ESP_LOADER_ERROR_TIMEOUT  Timeout
 esp_loader_error_t
 EspFlasher::loader_port_read(uint8_t* data, uint16_t size, uint32_t timeout) {
   assert(_serial && _serial->isOpen());
@@ -381,7 +413,7 @@ EspFlasher::loader_port_read(uint8_t* data, uint16_t size, uint32_t timeout) {
 /// \param  size                      Size of data in bytes
 /// \param  timeout                   Timeout in milliseconds
 /// \retval ESP_LOADER_SUCCESS        Success
-/// \retval ESP_LOADER_ERROR_TIMEOUT  Timeout elapsed
+/// \retval ESP_LOADER_ERROR_TIMEOUT  Timeout
 esp_loader_error_t EspFlasher::loader_port_write(uint8_t const* data,
                                                  uint16_t size,
                                                  uint32_t timeout) {

src/cli.cpp

@@ -59,15 +59,16 @@ int print_available_ports() {
 
 /// Execute write_flash command
 ///
-/// \retval 0   Success
-/// \retval -1  Error
+/// \param  parser  Command line parser
+/// \retval 0       Success
+/// \retval -1      Error
 int write_flash(QCommandLineParser const& parser) {
   auto pos_args{parser.positionalArguments()};
   pos_args.pop_front();
 
   if (pos_args.size() % 2) {
-    qCritical() << "write_flash: error: argument <offset> <filename>: Must be "
-                   "pairs of an offset and the binary filename to write there";
+    qCritical() << "write_flash: error: argument <address> <filename>: Must be "
+                   "pairs of an address and the binary filename to write there";
     return -1;
   }
 
@@ -88,14 +89,15 @@ int write_flash(QCommandLineParser const& parser) {
     bool ok{};
     auto const offset{pos_args[i].toUInt(&ok, 0)};
     if (!ok) {
-      qCritical() << "write_flash: error: argument <offset> <filename>: Offset"
-                  << pos_args[i] << "must be a number";
+      qCritical()
+        << "write_flash: error: argument <address> <filename>: Address"
+        << pos_args[i] << "must be a number";
       return -1;
     }
 
     QFile file{pos_args[i + 1]};
     if (!file.open(QIODeviceBase::ReadOnly)) {
-      qCritical() << "write_flash: error: argument <offset> <filename>: No "
+      qCritical() << "write_flash: error: argument <address> <filename>: No "
                      "such file or directory:"
                   << pos_args[i + 1];
       return -1;
@@ -107,6 +109,27 @@ int write_flash(QCommandLineParser const& parser) {
   return esp_flasher.flash();
 }
 
+/// Execute erase_flash command
+///
+/// \param  parser  Command line parser
+/// \retval 0       Success
+/// \retval -1      Error
+int erase_flash(QCommandLineParser const& parser) {
+  // Defaults
+  QString const chip{parser.isSet("chip") ? parser.value("chip") : "auto"};
+  QString const port{parser.isSet("port") ? parser.value("port") : "auto"};
+  QString const baud{parser.isSet("baud") ? parser.value("baud") : "auto"};
+  QString const before{parser.isSet("before") ? parser.value("before")
+                                              : "default_reset"};
+  QString const after{parser.isSet("after") ? parser.value("after")
+                                            : "hard_reset"};
+  QString const no_stub{parser.isSet("no-stub") ? "no-stub" : ""};
+  QString const trace{parser.isSet("trace") ? "trace" : ""};
+
+  EspFlasher esp_flasher{chip, port, baud, before, after, no_stub, trace};
+  return esp_flasher.erase();
+}
+
 } // namespace
 
 /// Run CLI
@@ -137,9 +160,12 @@ int cli(QApplication const& app) {
   });
 
   // Add commands
-  parser.addPositionalArgument("write_flash",
-                               "Write a binary blob to flash\nwrite_flash "
-                               "<offset> <filename> [<offset> <filename> ...]");
+  parser.addPositionalArgument(
+    "write_flash",
+    "Write a binary blob to flash\nwrite_flash "
+    "<address> <filename> [<address> <filename> ...]");
+  parser.addPositionalArgument("erase_flash",
+                               "Perform Chip Erase on SPI flash");
 
   // Parse arguments
   parser.process(app);
@@ -150,5 +176,6 @@ int cli(QApplication const& app) {
   // Execute commands
   if (auto pos_args{parser.positionalArguments()}; !pos_args.size()) return 0;
   else if (pos_args.first() == "write_flash") return write_flash(parser);
+  else if (pos_args.first() == "erase_flash") return erase_flash(parser);
   else return -1;
 }

src/com_box.cpp

@@ -17,15 +17,20 @@
 
 /// Create layout of various dropdown menus and a start/stop button
 ComBox::ComBox(QWidget* parent) : QGroupBox{parent} {
-  // Start/stop button
+  // Flash button
   QPixmap pixmap_off{":/dark/play.svg"};
   QPixmap pixmap_on{":/dark/stop.svg"};
   QIcon ico;
   ico.addPixmap(pixmap_off, QIcon::Normal, QIcon::Off);
   ico.addPixmap(pixmap_on, QIcon::Normal, QIcon::On);
-  _start_stop_button->setIcon(ico);
-  _start_stop_button->setText("Start");
-  _start_stop_button->setCheckable(true);
+  _flash_button->setIcon(ico);
+  _flash_button->setText("Flash");
+  _flash_button->setCheckable(true);
+
+  // Erase button
+  _erase_button->setIcon(ico);
+  _erase_button->setText("Erase");
+  _erase_button->setCheckable(true);
 
   // Add before/after options
   for (auto const& before : befores) _before_combobox->addItem(before);
@@ -69,7 +74,8 @@ ComBox::ComBox(QWidget* parent) : QGroupBox{parent} {
   // Workaround: top margin must be zero for the layout to be vertically
   // centered
   layout->setContentsMargins(11, 0, 11, 11);
-  layout->addWidget(_start_stop_button, 0, 0);
+  layout->addWidget(_flash_button, 0, 0);
+  layout->addWidget(_erase_button, 1, 0);
   layout->addWidget(new QLabel{"Before"}, 0, 1, Qt::AlignRight);
   layout->addWidget(new QLabel{"After"}, 1, 1, Qt::AlignRight);
   layout->addWidget(_before_combobox, 0, 2);
@@ -84,24 +90,43 @@ ComBox::ComBox(QWidget* parent) : QGroupBox{parent} {
   layout->addWidget(_baud_combobox, 2, 4);
   setLayout(layout);
 
-  connect(_start_stop_button,
-          &QPushButton::clicked,
-          this,
-          &ComBox::startStopButtonClicked);
+  connect(
+    _flash_button, &QPushButton::clicked, this, &ComBox::flashButtonClicked);
+  connect(
+    _erase_button, &QPushButton::clicked, this, &ComBox::eraseButtonClicked);
 }
 
 /// Set binaries slot
 ///
 /// \param  bins  Binaries
 void ComBox::binaries(QVector<Bin> bins) { _bins = bins; }
 
-/// Start/stop button slot
+/// Flash slot
+///
+/// \param  start Start or stop flashing
+void ComBox::flashButtonClicked(bool start) {
+  buttonClicked(start, _flash_button, &EspFlasher::flash);
+}
+
+/// Erase slot
 ///
-/// \param  start
-void ComBox::startStopButtonClicked(bool start) {
+/// \param  start Start or stop erasing
+void ComBox::eraseButtonClicked(bool start) {
+  buttonClicked(start, _erase_button, &EspFlasher::erase);
+}
+
+/// Flash or erase slot
+///
+/// \param  start   Start or stop action
+/// \param  button  Button used
+/// \param  action  Action to start or stop
+void ComBox::buttonClicked(bool start,
+                           QPushButton* button,
+                           esp_loader_error_t (EspFlasher::*action)()) {
   // Start thread
   if (start) {
-    _start_stop_button->setText("Stop");
+    auto text{button->text()};
+    button->setText("Stop");
 
     QString const chip{_chip_combobox->currentText()};
     QString const port{_port_combobox->currentText()};
@@ -119,10 +144,7 @@ void ComBox::startStopButtonClicked(bool start) {
     _esp_flasher->moveToThread(_thread);
 
     // Thread starts loader
-    connect(_thread,
-            &QThread::started,
-            _esp_flasher,
-            qOverload<>(&EspFlasher::flash));
+    connect(_thread, &QThread::started, _esp_flasher, action);
 
     // When loader finishes, quit thread and delete loader
     connect(_esp_flasher, &EspFlasher::finished, _thread, &QThread::quit);
@@ -135,9 +157,9 @@ void ComBox::startStopButtonClicked(bool start) {
     connect(_thread, &QThread::finished, _thread, &QThread::deleteLater);
 
     // Once thread is destroyed, reset button
-    connect(_thread, &QThread::destroyed, [this] {
-      _start_stop_button->setChecked(false);
-      _start_stop_button->setText("Start");
+    connect(_thread, &QThread::destroyed, [this, button, text] {
+      button->setChecked(false);
+      button->setText(text);
     });
 
     _thread->start();

src/com_box.hpp

@@ -32,17 +32,23 @@ public slots:
   void binaries(QVector<Bin> bins);
 
 private slots:
-  void startStopButtonClicked(bool start);
+  void flashButtonClicked(bool start);
+  void eraseButtonClicked(bool start);
 
 private:
+  void buttonClicked(bool start,
+                     QPushButton* button,
+                     esp_loader_error_t (EspFlasher::*action)());
+
   QComboBox* _chip_combobox{new QComboBox};
   QComboBox* _port_combobox{new QComboBox};
   QComboBox* _baud_combobox{new QComboBox};
   QComboBox* _before_combobox{new QComboBox};
   QComboBox* _after_combobox{new QComboBox};
   QCheckBox* _no_stub_checkbox{new QCheckBox};
   QCheckBox* _trace_checkbox{new QCheckBox};
-  QPushButton* _start_stop_button{new QPushButton};
+  QPushButton* _flash_button{new QPushButton};
+  QPushButton* _erase_button{new QPushButton};
   QVector<Bin> _bins{};
   QThread* _thread{};
   EspFlasher* _esp_flasher{};