Implemented firmware update via UI

Author: bbogush

qt/cmd.h

@@ -5,15 +5,19 @@
 
 enum
 {
-    CMD_NAND_READ_ID = 0x00,
-    CMD_NAND_ERASE   = 0x01,
-    CMD_NAND_READ    = 0x02,
-    CMD_NAND_WRITE_S = 0x03,
-    CMD_NAND_WRITE_D = 0x04,
-    CMD_NAND_WRITE_E = 0x05,
-    CMD_NAND_CONF    = 0x06,
-    CMD_NAND_READ_BB = 0x07,
-    CMD_VERSION_GET  = 0x08,
+    CMD_NAND_READ_ID     = 0x00,
+    CMD_NAND_ERASE       = 0x01,
+    CMD_NAND_READ        = 0x02,
+    CMD_NAND_WRITE_S     = 0x03,
+    CMD_NAND_WRITE_D     = 0x04,
+    CMD_NAND_WRITE_E     = 0x05,
+    CMD_NAND_CONF        = 0x06,
+    CMD_NAND_READ_BB     = 0x07,
+    CMD_VERSION_GET      = 0x08,
+    CMD_ACTIVE_IMAGE_GET = 0x09,
+    CMD_FW_UPDATE_S      = 0x0a,
+    CMD_FW_UPDATE_D      = 0x0b,
+    CMD_FW_UPDATE_E      = 0x0c
 };
 
 typedef struct __attribute__((__packed__))

qt/main_window.cpp

@@ -87,6 +87,8 @@ MainWindow::MainWindow(QWidget *parent) : QMainWindow(parent),
         SLOT(slotAboutDialog()));
     connect(ui->detectPushButton, SIGNAL(clicked()), this,
         SLOT(slotDetectChip()));
+    connect(ui->actionFirmwareUpdate, SIGNAL(triggered()), this,
+        SLOT(slotFirmwareUpdate()));
 }
 
 MainWindow::~MainWindow()
@@ -185,6 +187,7 @@ void MainWindow::setUiStateConnected(bool isConnected)
 {
     ui->chipSelectComboBox->setEnabled(isConnected);
     ui->detectPushButton->setEnabled(isConnected);
+    ui->actionFirmwareUpdate->setEnabled(isConnected);
     if (!isConnected)
         ui->chipSelectComboBox->setCurrentIndex(CHIP_INDEX_DEFAULT);
 }
@@ -598,3 +601,23 @@ void MainWindow::setProgress(unsigned int progress)
 {
     statusBar()->showMessage(tr("Progress: %1%").arg(progress));
 }
+
+void MainWindow::slotProgFirmwareUpdateCompleted(int status)
+{
+    if (!status)
+        qInfo() << "Firmware update completed. Please restart device.";
+}
+
+void MainWindow::slotFirmwareUpdate()
+{
+    QString fileName = QFileDialog::getOpenFileName(this, tr("Open File"),
+        ".", tr("Binary Files (*.bin)"));
+
+    if (fileName.isNull())
+        return;
+
+    qInfo() << "Firmware update ...";
+    connect(prog, SIGNAL(firmwareUpdateCompleted(int)), this,
+        SLOT(slotProgFirmwareUpdateCompleted(int)));
+    prog->firmwareUpdate(fileName);
+}

qt/main_window.h

@@ -51,6 +51,7 @@ private slots:
     void slotProgSelectCompleted(int status);
     void slotProgDetectChipConfCompleted(int status);
     void slotProgDetectChipReadChipIdCompleted(int status);
+    void slotProgFirmwareUpdateCompleted(int status);
 
 public slots:
     void slotFileOpen();
@@ -66,6 +67,7 @@ public slots:
     void slotSettingsProgrammer();
     void slotSettingsChipDb();
     void slotAboutDialog();
+    void slotFirmwareUpdate();
 };
 
 #endif // MAIN_WINDOW_H

qt/main_window.ui

@@ -280,6 +280,8 @@
     </property>
     <addaction name="actionProgrammer"/>
     <addaction name="actionChipDb"/>
+    <addaction name="separator"/>
+    <addaction name="actionFirmwareUpdate"/>
    </widget>
    <widget class="QMenu" name="menuHelp">
     <property name="title">
@@ -383,6 +385,14 @@
     <string>About NANDO</string>
    </property>
   </action>
+  <action name="actionFirmwareUpdate">
+   <property name="enabled">
+    <bool>false</bool>
+   </property>
+   <property name="text">
+    <string>Firmware update</string>
+   </property>
+  </action>
  </widget>
  <layoutdefault spacing="6" margin="11"/>
  <resources/>

qt/programmer.cpp

@@ -25,6 +25,7 @@ Programmer::Programmer(QObject *parent) : QObject(parent)
     skipBB = true;
     incSpare = false;
     isConn = false;
+    firmwareBuffer = nullptr;
     QObject::connect(&reader, SIGNAL(log(QtMsgType, QString)), this,
         SLOT(logCb(QtMsgType, QString)));
     QObject::connect(&writer, SIGNAL(log(QtMsgType, QString)), this,
@@ -260,7 +261,7 @@ void Programmer::writeChip(uint8_t *buf, uint32_t addr, uint32_t len,
         SLOT(writeProgressCb(unsigned int)));
 
     writer.init(usbDevName, SERIAL_PORT_SPEED, buf, addr, len, pageSize,
-        skipBB, incSpare);
+        skipBB, incSpare, CMD_NAND_WRITE_S, CMD_NAND_WRITE_D, CMD_NAND_WRITE_E);
     writer.start();
 }
 
@@ -378,4 +379,153 @@ QString Programmer::fwVersionToString(FwVersion fwVersion)
         arg(fwVersion.minor).arg(fwVersion.build);
 }
 
+int Programmer::firmwareImageRead()
+{
+    qint64 ret, fileSize;
+    uint32_t updateImageSize, updateImageOffset;
+
+    QFile file(firmwareFileName);
+    if (!file.open(QIODevice::ReadOnly))
+    {
+        qCritical() << "Failed to open file:" << firmwareFileName <<
+            ", error:" << file.errorString();
+        goto Error;
+    }
+
+    fileSize = file.size();
+    if (fileSize != (firmwareImage[FIRMWARE_IMAGE_LAST - 1].offset +
+        firmwareImage[FIRMWARE_IMAGE_LAST - 1].size))
+    {
+        qCritical() << "Firmware image " << firmwareFileName <<
+            " size " << fileSize << "is invalid, expected " << 256 * 1024;
+        goto Error;
+    }
+
+    updateImage = activeImage == FIRMWARE_IMAGE_1 ? FIRMWARE_IMAGE_2 :
+        FIRMWARE_IMAGE_1;
+    updateImageSize = firmwareImage[updateImage].size;
+    updateImageOffset = firmwareImage[updateImage].offset;
+    if (!(firmwareBuffer = new (std::nothrow) char[updateImageSize]))
+    {
+        qCritical() << "Failed to allocate memory for firmware image " <<
+            firmwareFileName;
+        goto Error;
+    }
+
+    if (!file.seek(updateImageOffset))
+    {
+        qCritical() << "Failed to seek firmware image " << firmwareFileName;
+        goto Error;
+    }
+
+    if ((ret = file.read(firmwareBuffer, updateImageSize)) < 0)
+    {
+        qCritical() << "Failed to read firmware image " << firmwareFileName <<
+            ", error:" << file.errorString();
+        goto Error;
+    }
+
+    if (ret != updateImageSize)
+    {
+        qCritical() << "Firmware image " << firmwareFileName <<
+            " was partially read, length" << ret;
+        goto Error;
+    }
+
+    return 0;
+
+Error:
+    if (firmwareBuffer)
+    {
+        delete [] firmwareBuffer;
+        firmwareBuffer = nullptr;
+    }
+    emit firmwareUpdateCompleted(-1);
+    return -1;
+}
+
+void Programmer::firmwareUpdateProgressCb(unsigned int progress)
+{
+    emit firmwareUpdateProgress(progress);
+}
+
+void Programmer::firmwareUpdateCb(int ret)
+{
+    QObject::disconnect(&writer, SIGNAL(progress(unsigned int)), this,
+        SLOT(firmwareUpdateProgressCb(unsigned int)));
+    QObject::disconnect(&writer, SIGNAL(result(int)), this,
+        SLOT(firmwareUpdateCb(int)));
+
+    delete [] firmwareBuffer;
+    firmwareBuffer = nullptr;
+
+    emit firmwareUpdateCompleted(ret);
+}
+
+void Programmer::firmwareUpdateStart()
+{
+    if (firmwareImageRead())
+    {
+        emit firmwareUpdateCompleted(-1);
+        return;
+    }
+
+    QObject::connect(&writer, SIGNAL(result(int)), this,
+        SLOT(firmwareUpdateCb(int)));
+    QObject::connect(&writer, SIGNAL(progress(unsigned int)), this,
+        SLOT(firmwareUpdateProgressCb(unsigned int)));
+
+    writer.init(usbDevName, SERIAL_PORT_SPEED,
+        reinterpret_cast<uint8_t *>(firmwareBuffer),
+        firmwareImage[updateImage].address, firmwareImage[updateImage].size,
+        flashPageSize, 0, 0, CMD_FW_UPDATE_S, CMD_FW_UPDATE_D, CMD_FW_UPDATE_E);
+    writer.start();
+}
+
+void Programmer::getActiveImageCb(int ret)
+{
+    QObject::disconnect(&reader, SIGNAL(result(int)), this,
+        SLOT(getActiveImageCb(int)));
+
+    if (ret < 0)
+    {
+        qCritical() << "Failed to get active firmware image";
+        goto Error;
+    }
+
+    if (activeImage >= FIRMWARE_IMAGE_LAST)
+    {
+        qCritical() << "Wrong active firmware image: " << activeImage;
+        goto Error;
+    }
+
+    qInfo() << "Active firmware image: " << activeImage;
+
+    firmwareUpdateStart();
+    return;
+
+Error:
+    emit firmwareUpdateCompleted(-1);
+}
+
+void Programmer::firmwareUpdate(const QString &fileName)
+{
+    Cmd cmd;
+
+    firmwareFileName = fileName;
+
+    QObject::connect(&reader, SIGNAL(result(int)), this,
+        SLOT(getActiveImageCb(int)));
+
+    cmd.code = CMD_ACTIVE_IMAGE_GET;
+
+    writeData.clear();
+    writeData.append(reinterpret_cast<const char *>(&cmd), sizeof(cmd));
+    reader.init(usbDevName, SERIAL_PORT_SPEED, &activeImage,
+        sizeof(activeImage),
+        reinterpret_cast<const uint8_t *>(writeData.constData()),
+        static_cast<uint32_t>(writeData.size()), false, false);
+    reader.start();
+}
+
 

qt/programmer.h

@@ -21,6 +21,28 @@ class Programmer : public QObject
 {
     Q_OBJECT
 
+    typedef enum
+    {
+        FIRMWARE_IMAGE_1    = 0,
+        FIRMWARE_IMAGE_2    = 1,
+        FIRMWARE_IMAGE_LAST = 2,
+    } FirmwareImageNum;
+
+    typedef struct
+    {
+        FirmwareImageNum num;
+        uint32_t address;
+        uint32_t offset;
+        uint32_t size;
+    } FirmwareImage;
+
+    const FirmwareImage firmwareImage[FIRMWARE_IMAGE_LAST] =
+    {
+        { FIRMWARE_IMAGE_1, 0x08004000, 0x00004000, 0x1e000 },
+        { FIRMWARE_IMAGE_2, 0x08022000, 0x00022000, 0x1e000 },
+    };
+    const uint32_t flashPageSize = 0x800;
+
     QSerialPort serialPort;
     QString usbDevName;
     Writer writer;
@@ -29,9 +51,15 @@ class Programmer : public QObject
     bool skipBB;
     bool incSpare;
     FwVersion fwVersion;
+    uint8_t activeImage;
+    uint8_t updateImage;
+    QString firmwareFileName;
+    char *firmwareBuffer;
 
     int serialPortConnect();
     void serialPortDisconnect();
+    int firmwareImageRead();
+    void firmwareUpdateStart();
 
 public:
     QByteArray writeData;
@@ -56,6 +84,7 @@ class Programmer : public QObject
     void confChip(ChipInfo *chipInfo);
     void detectChip();
     QString fwVersionToString(FwVersion fwVersion);
+    void firmwareUpdate(const QString &fileName);
 
 signals:
     void connectCompleted(int ret);
@@ -68,6 +97,8 @@ class Programmer : public QObject
     void eraseChipProgress(unsigned int progress);
     void readChipBadBlocksCompleted(int ret);
     void confChipCompleted(int ret);
+    void firmwareUpdateCompleted(int ret);
+    void firmwareUpdateProgress(unsigned int progress);
 
 private slots:
     void readChipIdCb(int ret);
@@ -81,6 +112,9 @@ private slots:
     void confChipCb(int ret);
     void logCb(QtMsgType msgType, QString msg);
     void connectCb(int ret);
+    void getActiveImageCb(int ret);
+    void firmwareUpdateCb(int ret);
+    void firmwareUpdateProgressCb(unsigned int progress);
 };
 
 #endif // PROGRAMMER_H

qt/writer.cpp

@@ -15,7 +15,8 @@
 Q_DECLARE_METATYPE(QtMsgType)
 
 void Writer::init(const QString &portName, qint32 baudRate, uint8_t *buf,
-    uint32_t addr, uint32_t len, uint32_t pageSize, bool skipBB, bool incSpare)
+    uint32_t addr, uint32_t len, uint32_t pageSize, bool skipBB, bool incSpare,
+    uint8_t startCmd, uint8_t dataCmd, uint8_t endCmd)
 {
     this->portName = portName;
     this->baudRate = baudRate;
@@ -25,6 +26,9 @@ void Writer::init(const QString &portName, qint32 baudRate, uint8_t *buf,
     this->pageSize = pageSize;
     this->skipBB = skipBB;
     this->incSpare = incSpare;
+    this->startCmd = startCmd;
+    this->dataCmd = dataCmd;
+    this->endCmd = endCmd;
     bytesWritten = 0;
     bytesAcked = 0;
 }
@@ -212,7 +216,7 @@ int Writer::writeStart()
 {
     WriteStartCmd writeStartCmd;
 
-    writeStartCmd.cmd.code = CMD_NAND_WRITE_S;
+    writeStartCmd.cmd.code = startCmd;
     writeStartCmd.addr = addr;
     writeStartCmd.len = len;
     writeStartCmd.flags.skipBB = skipBB;
@@ -236,7 +240,7 @@ int Writer::writeData()
     WriteDataCmd *writeDataCmd = reinterpret_cast<WriteDataCmd *>(pbuf);
     uint32_t dataLen, dataLenMax, headerLen, pageLim;
 
-    writeDataCmd->cmd.code = CMD_NAND_WRITE_D;
+    writeDataCmd->cmd.code = dataCmd;
     headerLen = sizeof(WriteDataCmd);
     dataLenMax = BUF_SIZE - headerLen;
 
@@ -270,7 +274,7 @@ int Writer::writeEnd()
 {
     WriteEndCmd writeEndCmd;
 
-    writeEndCmd.cmd.code = CMD_NAND_WRITE_E;
+    writeEndCmd.cmd.code = endCmd;
 
     if (write(reinterpret_cast<uint8_t *>(&writeEndCmd), sizeof(WriteEndCmd)))
         return -1;