Chip DB moved to external CSV file

bbogush · bbogush · commit e9b429a38679 · 2019-03-17T20:11:15.000+02:00
diff --git a/qt/chip_db.cpp b/qt/chip_db.cpp
@@ -5,43 +5,125 @@
 
 #include "chip_db.h"
 #include <cstring>
+#include <QFile>
+#include <QDebug>
+#include <QStandardPaths>
+#include <QDir>
+#include <QMessageBox>
 
-static ChipInfo chipDB[] =
-{
-    /* id, name, pageSize, blockSize, size, tCS, tCLS, tALS, tCLR, tAR, tWP, tRP, tDS, tCH, tCLH, tALH, tWC, tRC, tREA */
-    { CHIP_ID_NONE, "No Chip", 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
-    { CHIP_ID_K9F2G08U0C, "K9F2G08U0C", 0x800, 0x20000, 0x10000000, 20, 12, 12, 10, 10, 12, 12, 12, 5, 5, 5, 25, 25, 20 },
-};
+#define CHIP_DB_FILE_NAME "nando_chip_db.csv"
 
-uint32_t chipDbGet(ChipInfo *&db)
+QString ChipDb::findFile()
 {
-    db = chipDB;
+    QString fileName = CHIP_DB_FILE_NAME;
+
+    if (!QFileInfo(fileName).exists() &&
+        (fileName = QStandardPaths::locate(QStandardPaths::ConfigLocation,
+        CHIP_DB_FILE_NAME)).isNull())
+    {
+        QMessageBox::critical(nullptr, tr("Error"), tr("Chip DB file %1 was not"
+            " found in %2;%3").arg(CHIP_DB_FILE_NAME).arg(QDir::currentPath()).
+            arg(QStandardPaths::standardLocations(QStandardPaths::
+            ConfigLocation).join(';')));
+        return QString();
+    }
 
-    return CHIP_ID_LAST;
+    return fileName;
 }
 
-ChipInfo *chipInfoGetByName(char *name)
+int ChipDb::stringToChipInfo(const QString &file, const QString &s,
+    ChipInfo &ci)
 {
-    for (int id = 0; id < CHIP_ID_LAST; id++)
+    int paramNum;
+    QStringList paramsList;
+
+    paramsList = s.split(',');
+    paramNum = paramsList.size();
+    if (paramNum != CHIP_PARAM_NUM)
     {
-        if (!strcmp(name, chipDB[id].name))
-            return &chipDB[id];
+        QMessageBox::critical(nullptr, tr("Error"),
+            tr("Failed to read chip DB entry from %1. Expected %2 parameters, "
+            "but read %3").arg(file).arg(CHIP_PARAM_NUM).arg(paramNum));
+        return -1;
+    }
+
+    ci.name = paramsList[CHIP_PARAM_NAME];
+    for (int i = CHIP_PARAM_NAME + 1; i < CHIP_PARAM_NUM; i++)
+    {
+        bool ok;
+
+        ci.params[i] = paramsList[i].toUInt(&ok);
+        if (!ok)
+        {
+            QMessageBox::critical(nullptr, tr("Error"), tr("Failed to parse"
+                " parameter %1 in %2").arg(paramsList[i]).arg(file));
+            return -1;
+        }
     }
 
     return 0;
 }
 
-ChipInfo *chipInfoGetById(uint32_t id)
+void ChipDb::readFromCvs(void)
 {
-    if (id == CHIP_ID_NONE || id >= CHIP_ID_LAST)
-        return NULL;
+    ChipInfo chipInfo;
+    QFile dbFile;
+    QString fileName = findFile();
+
+    if (fileName.isNull())
+        return;
+
+    dbFile.setFileName(fileName);
+    if (!dbFile.open(QIODevice::ReadOnly | QIODevice::Text))
+    {
+        QMessageBox::critical(nullptr, tr("Error"), tr("Failed to open chip DB "
+            "file: %1, error: %2").arg(fileName).arg(dbFile.errorString()));
+        return;
+    }
+
+    QTextStream in(&dbFile);
+    while (!in.atEnd())
+    {
+        QString line = in.readLine();
+        if (line.isEmpty())
+            continue;
+        if (*line.data() == '#')
+            continue;
+        if (stringToChipInfo(fileName, line, chipInfo))
+            return;
+        chipInfoVector.append(chipInfo);
+    }
+}
+
+ChipDb::ChipDb(QObject *parent) : QObject(parent)
+{
+    readFromCvs();
+}
+
+QStringList *ChipDb::getNames()
+{
+    QStringList *namesList = new QStringList;
+
+    for (int i = 0; i < chipInfoVector.size(); i++)
+        namesList->append(chipInfoVector[i].name);
+
+    return namesList;
+}
+
+ChipInfo *ChipDb::chipInfoGetByName(const QString &name)
+{
+    for (int i = 0; i < chipInfoVector.size(); i++)
+    {
+        if (!chipInfoVector[i].name.compare(name))
+            return &chipInfoVector[i];
+    }
 
-    return &chipDB[id];
+    return nullptr;
 }
 
-uint32_t chipPageSizeGet(uint32_t id)
+uint32_t ChipDb::pageSizeGetByName(const QString &name)
 {
-    ChipInfo *info = chipInfoGetById(id);
+    ChipInfo *info = chipInfoGetByName(name);
 
-    return info ? info->pageSize : 0;
+    return info ? info->params[CHIP_PARAM_PAGE_SIZE] : 0;
 }
diff --git a/qt/chip_db.h b/qt/chip_db.h
@@ -7,8 +7,9 @@
 #define CHIP_DB_H
 
 #include <cstdint>
-
-#define MAX_CHIP_NAME_LEN 16
+#include <QString>
+#include <QObject>
+#include <QVector>
 
 enum
 {
@@ -17,33 +18,54 @@ enum
     CHIP_ID_LAST = 2,
 };
 
+enum
+{
+    CHIP_PARAM_NAME,
+    CHIP_PARAM_PAGE_SIZE,
+    CHIP_PARAM_BLOCK_SIZE,
+    CHIP_PARAM_SIZE,
+    CHIP_PARAM_T_CS,
+    CHIP_PARAM_T_CLS,
+    CHIP_PARAM_T_ALS,
+    CHIP_PARAM_T_CLR,
+    CHIP_PARAM_T_AR,
+    CHIP_PARAM_T_WP,
+    CHIP_PARAM_T_RP,
+    CHIP_PARAM_T_DS,
+    CHIP_PARAM_T_CH,
+    CHIP_PARAM_T_CLH,
+    CHIP_PARAM_T_ALH,
+    CHIP_PARAM_T_WC,
+    CHIP_PARAM_T_RC,
+    CHIP_PARAM_T_REA,
+    CHIP_PARAM_NUM,
+};
+
 typedef struct
 {
     uint32_t id;
-    char name[MAX_CHIP_NAME_LEN];
-    uint32_t pageSize;
-    uint32_t blockSize;
-    uint32_t size;
-    uint32_t tCS;
-    uint32_t tCLS;
-    uint32_t tALS;
-    uint32_t tCLR;
-    uint32_t tAR;
-    uint32_t tWP;
-    uint32_t tRP;
-    uint32_t tDS;
-    uint32_t tCH;
-    uint32_t tCLH;
-    uint32_t tALH;
-    uint32_t tWC;
-    uint32_t tRC;
-    uint32_t tREA;
+    QString name;
+    uint32_t params[CHIP_PARAM_NUM];
 } ChipInfo;
 
-uint32_t chipDbGet(ChipInfo *&db);
-ChipInfo *chipInfoGetByName(char *name);
-ChipInfo *chipInfoGetById(uint32_t id);
-uint32_t chipPageSizeGet(uint32_t id);
+class ChipDb : public QObject
+{
+    Q_OBJECT
+
+    QVector<ChipInfo> chipInfoVector;
+
+    QString findFile();
+    int stringToChipInfo(const QString &file, const QString &s, ChipInfo &ci);
+    void readFromCvs(void);
+
+public:
+    explicit ChipDb(QObject *parent = 0);
+    QStringList *getNames();
+    ChipInfo *chipInfoGetByName(const QString &name);
+    uint32_t pageSizeGetByName(const QString &name);
+};
+
+
 
 #endif // CHIP_DB_H
 
diff --git a/qt/main_window.cpp b/qt/main_window.cpp
@@ -21,15 +21,6 @@
 
 #define START_ADDRESS 0x00000000
 
-static void addChipDB(QComboBox *chipSelectComboBox)
-{
-    ChipInfo *db;
-    uint32_t size = chipDbGet(db);
-
-    for (uint32_t i = 0; i < size; i++)
-        chipSelectComboBox->addItem(db[i].name);
-}
-
 void MainWindow::initBufTable()
 {
     buffer = nullptr;
@@ -64,7 +55,10 @@ MainWindow::MainWindow(QWidget *parent) : QMainWindow(parent),
 
     prog = new Programmer(this);
 
-    addChipDB(ui->chipSelectComboBox);
+    QStringList *chipNames = chipDb.getNames();
+    ui->chipSelectComboBox->addItems(*chipNames);
+    free(chipNames);
+
     connect(ui->chipSelectComboBox, SIGNAL(currentIndexChanged(int)),
         this, SLOT(slotSelectChip(int)));
 
@@ -258,19 +252,19 @@ void MainWindow::slotProgEraseCompleted(int status)
 void MainWindow::slotProgErase()
 {
     QByteArray ba = ui->chipSelectComboBox->currentText().toLatin1();
-    ChipInfo *chipInfo = chipInfoGetByName(ba.data());
+    ChipInfo *chipInfo = chipDb.chipInfoGetByName(ba.data());
 
     connect(prog, SIGNAL(eraseChipCompleted(int)), this,
         SLOT(slotProgEraseCompleted(int)));
 
-    prog->eraseChip(START_ADDRESS, chipInfo->size);
+    prog->eraseChip(START_ADDRESS, chipInfo->params[CHIP_PARAM_BLOCK_SIZE]);
 }
 
 void MainWindow::slotProgReadCompleted(int status)
 {
     QByteArray ba = ui->chipSelectComboBox->currentText().toLatin1();
-    ChipInfo *chipInfo = chipInfoGetByName(ba.data());
-    uint32_t readSize = chipInfo->size;
+    ChipInfo *chipInfo = chipDb.chipInfoGetByName(ba.data());
+    uint32_t readSize = chipInfo->params[CHIP_PARAM_BLOCK_SIZE];
 
     disconnect(prog, SIGNAL(readChipCompleted(int)), this,
         SLOT(slotProgReadCompleted(int)));
@@ -288,8 +282,8 @@ void MainWindow::slotProgReadCompleted(int status)
 void MainWindow::slotProgRead()
 {
     QByteArray ba = ui->chipSelectComboBox->currentText().toLatin1();
-    ChipInfo *chipInfo = chipInfoGetByName(ba.data());
-    uint32_t readSize = chipInfo->size;
+    ChipInfo *chipInfo = chipDb.chipInfoGetByName(ba.data());
+    uint32_t readSize = chipInfo->params[CHIP_PARAM_BLOCK_SIZE];
 
     connect(prog, SIGNAL(readChipCompleted(int)), this,
         SLOT(slotProgReadCompleted(int)));
@@ -316,6 +310,7 @@ void MainWindow::slotProgWriteCompleted(int status)
 
 void MainWindow::slotProgWrite()
 {
+    QString name;
     uint32_t pageSize;
 
     if (!bufferSize)
@@ -330,7 +325,8 @@ void MainWindow::slotProgWrite()
         return;
     }
 
-    if (!(pageSize = chipPageSizeGet(selectedChipNum)))
+    name = ui->chipSelectComboBox->currentText();
+    if (!(pageSize = chipDb.pageSizeGetByName(name)))
     {
         qInfo() << "Chip page size is unknown";
         return;
@@ -375,6 +371,9 @@ void MainWindow::slotProgSelectCompleted(int status)
 
 void MainWindow::slotSelectChip(int selectedChipNum)
 {
+    QString name;
+    ChipInfo *chipInfo;
+
     this->selectedChipNum = selectedChipNum;
 
     if (selectedChipNum == CHIP_ID_NONE)
@@ -386,7 +385,9 @@ void MainWindow::slotSelectChip(int selectedChipNum)
     connect(prog, SIGNAL(confChipCompleted(int)), this,
         SLOT(slotProgSelectCompleted(int)));
 
-    prog->confChip(chipInfoGetById(selectedChipNum));
+    name = ui->chipSelectComboBox->currentText();
+    chipInfo = chipDb.chipInfoGetByName(name);
+    prog->confChip(chipInfo);
 }
 
 void MainWindow::slotSettingsProgrammer()
diff --git a/qt/main_window.h b/qt/main_window.h
@@ -30,6 +30,7 @@ class MainWindow : public QMainWindow
     BufferTableModel bufferTableModel;
     uint32_t selectedChipNum;
     ChipId chipId;
+    ChipDb chipDb;
 
     void initBufTable();
     void resetBufTable();
diff --git a/qt/nando_chip_db.csv b/qt/nando_chip_db.csv
@@ -0,0 +1,3 @@
+# name, pageSize, blockSize, size, tCS, tCLS, tALS, tCLR, tAR, tWP, tRP, tDS, tCH, tCLH, tALH, tWC, tRC, tREA
+NONE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
+K9F2G08U0C, 2048, 131072, 268435456, 20, 12, 12, 10, 10, 12, 12, 12, 5, 5, 5, 25, 25, 20
diff --git a/qt/programmer.cpp b/qt/programmer.cpp
@@ -228,9 +228,9 @@ void Programmer::confChip(ChipInfo *chipInfo)
     chipInfoToStmParams(chipInfo, &params);
 
     confCmd.cmd = cmd;
-    confCmd.pageSize = chipInfo->pageSize;
-    confCmd.blockSize = chipInfo->blockSize;
-    confCmd.size = chipInfo->size;
+    confCmd.pageSize = chipInfo->params[CHIP_PARAM_PAGE_SIZE];
+    confCmd.blockSize = chipInfo->params[CHIP_PARAM_BLOCK_SIZE];
+    confCmd.size = chipInfo->params[CHIP_PARAM_SIZE];
     confCmd.setupTime = params.setupTime;
     confCmd.waitSetupTime = params.waitSetupTime;
     confCmd.holdSetupTime = params.holdSetupTime;
diff --git a/qt/qt.pro b/qt/qt.pro
@@ -49,3 +49,11 @@ FORMS    += main_window.ui \
     settings_programmer_dialog.ui
 
 QMAKE_CXXFLAGS += -std=c++11 -Wextra -Werror
+
+DISTFILES += \
+    nando_chip_db.csv
+
+install_conf.path = $$DESTDIR
+install_conf.files += $$PWD/nando_chip_db.csv
+
+INSTALLS += install_conf
diff --git a/qt/stm32.cpp b/qt/stm32.cpp

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# name, pageSize, blockSize, size, tCS, tCLS, tALS, tCLR, tAR, tWP, tRP, tDS, tCH, tCLH, tALH, tWC, tRC, tREA`
	`2`	`+NONE, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0`
	`3`	`+K9F2G08U0C, 2048, 131072, 268435456, 20, 12, 12, 10, 10, 12, 12, 12, 5, 5, 5, 25, 25, 20`