Added KDE3 version of PikLab

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/piklab@1095639 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 327 insertions, 0 deletions

diff --git a/src/progs/tbl_bootloader/base/tbl_bootloader.cpp b/src/progs/tbl_bootloader/base/tbl_bootloader.cpp
new file mode 100644
index 0000000..419ad86
--- /dev/null
+++ b/src/progs/tbl_bootloader/base/tbl_bootloader.cpp
@@ -0,0 +1,327 @@
+/***************************************************************************
+ *   Copyright (C) 2007 Nicolas Hadacek <hadacek@kde.org>                  *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ ***************************************************************************/
+#include "tbl_bootloader.h"
+
+#include "tbl_bootloader_data.h"
+#include "progs/base/prog_config.h"
+
+//-----------------------------------------------------------------------------
+Port::Serial::Speed TinyBootloader::Config::readSpeed()
+{
+  uint speed = readUIntEntry("port_speed", 19200);
+  for (uint i=0; i<Port::Serial::Nb_Speeds; i++)
+    if ( speed==Port::Serial::SPEED_VALUES[i] ) return Port::Serial::Speed(i);
+  return Port::Serial::S19200;
+}
+void TinyBootloader::Config::writeSpeed(Port::Serial::Speed speed)
+{
+  writeEntry("port_speed", Port::Serial::SPEED_VALUES[speed]);
+}
+
+uint TinyBootloader::Config::readTimeout()
+{
+  return readUIntEntry("timeout", 300);
+}
+void TinyBootloader::Config::writeTimeout(uint timeout)
+{
+  writeEntry("timeout", timeout);
+}
+
+uint TinyBootloader::Config::readRetries()
+{
+  return readUIntEntry("nb_retries", 5);
+}
+void TinyBootloader::Config::writeRetries(uint nb)
+{
+  writeEntry("nb_retries", nb);
+}
+
+//-----------------------------------------------------------------------------
+TinyBootloader::Hardware::Hardware(::Programmer::Base &base, const QString &portDevice)
+  : ::Bootloader::Hardware(base, new Port::Serial(portDevice, Port::Serial::NoProperty, base))
+{
+  Config config;
+  _timeout = config.readTimeout();
+  _retries = config.readRetries();
+}
+
+bool TinyBootloader::Hardware::openPort()
+{
+  if ( !port()->open() ) return false;
+  Config config;
+  if ( !port()->setMode(Port::Serial::IgnoreBreak | Port::Serial::IgnoreParity,
+                        Port::Serial::ByteSize8 | Port::Serial::IgnoreControlLines,
+                        config.readSpeed(), _timeout) )
+    return false;
+  return true;
+}
+
+bool TinyBootloader::Hardware::internalConnectHardware()
+{
+  if ( !openPort() ) return false;
+  // #### possibly do hard (RTS) or soft reset (codes)
+  uchar uc = 0xC1;
+  if ( !port()->sendChar(uc, _timeout) ) return false;
+  if ( !port()->receiveChar((char &)_id, _timeout) ) return false;
+  if ( !waitReady(0) ) return false;
+  return true;
+}
+
+bool TinyBootloader::Hardware::verifyDeviceId()
+{
+  uchar id = data(device().name()).id;
+  QValueVector<QString> list = _base.group().supportedDevices();
+  QStringList devices;
+  for (uint i=0; i<uint(list.count()); i++)
+    if ( _id==data(list[i]).id ) devices.append(list[i]);
+  if ( _id!=id ) {
+    if ( devices.count()==0 ) log(Log::LineType::Error, i18n("Unknown id returned by bootloader (%1 read and %2 expected).").arg(toHexLabel(_id, 2)).arg(toHexLabel(id, 2)));
+    else log(Log::LineType::Error, i18n("Id returned by bootloader corresponds to other devices: %1 (%2 read and %3 expected).").arg(devices.join(" ")).arg(toHexLabel(_id, 2)).arg(toHexLabel(id, 2)));
+    // we can't ask for "continue anyway?" because bootloader can timeout...
+    return false;
+  }
+  log(Log::LineType::Information, "  " + i18n("Bootloader identified device as: %1").arg(devices.join(" ")));
+  return true;
+}
+
+bool TinyBootloader::Hardware::waitReady(bool *checkCRC)
+{
+  char c;
+  if ( !port()->receiveChar(c, _timeout) ) return false;
+  if ( c=='K' ) {
+    if (checkCRC) *checkCRC = true;
+    return true;
+  }
+  if (checkCRC) {
+    *checkCRC = false;
+    if ( c=='N' ) return true;
+    log(Log::LineType::Error, i18n("Received unexpected character ('%1' received; 'K' or 'N' expected).").arg(toPrintable(c, PrintAlphaNum)));
+    return true;
+  }
+  log(Log::LineType::Error, i18n("Received unexpected character ('%1' received; 'K' expected).").arg(toPrintable(c, PrintAlphaNum)));
+  return false;
+}
+
+bool TinyBootloader::Hardware::sendChar(char c, uchar *crc)
+{
+  if (crc) *crc += c;
+  return port()->sendChar(c, 10*_timeout);
+}
+
+bool TinyBootloader::Hardware::sendCodeAddress(uint address, uchar &crc)
+{
+  switch (device().architecture().type()) {
+    case Pic::Architecture::P16X:
+      if ( !sendChar(address >> 8, &crc) ) return false;          // address high
+      if ( !sendChar(address & 0xFF, &crc) ) return false;        // address low
+      break;
+    case Pic::Architecture::P18F:
+      if ( !sendChar(address >> 16, &crc) ) return false;           // address upper
+      if ( !sendChar((address >> 8) & 0xFF, &crc) ) return false;   // address high
+      if ( !sendChar(address & 0xFF, &crc) ) return false;          // address low
+      break;
+    case Pic::Architecture::P30F:
+      if ( !sendChar(address & 0xFF, &crc) ) return false;          // address low
+      if ( !sendChar((address >> 8) & 0xFF, &crc) ) return false;   // address high
+      if ( !sendChar(address >> 16, &crc) ) return false;           // address upper
+      break;
+    default: Q_ASSERT(false); return false;
+  }
+  return true;
+}
+
+bool TinyBootloader::Hardware::endWrite(uchar crc, uint &retries, bool &ok)
+{
+  if ( !sendChar(-crc & 0xFF, 0) ) return false;
+  if ( !waitReady(&ok) ) return false;
+  if ( !ok ) {
+    if ( retries==0 ) {
+      log(Log::LineType::Error, i18n("Too many failures: bailing out."));
+      return false;
+    }
+    retries--;
+    log(Log::LineType::Warning, i18n("CRC error from bootloader: retrying..."));
+  }
+  return true;
+}
+
+bool TinyBootloader::Hardware::writeCode(const Device::Array &data, bool erase)
+{
+  uint nb = data.count() - 100;
+  Device::Array wdata(nb+4);
+
+  // check that there is nothing on top of bootloader
+  for (uint i=nb; i<data.size(); i++) {
+    if ( data[i]==device().mask(Pic::MemoryRangeType::Code) ) continue;
+    uint address = device().addressIncrement(Pic::MemoryRangeType::Code) * i;
+    log(Log::LineType::Warning, "  " + i18n("Code is present in bootloader reserved area (at address %1). It will be ignored.").arg(toHexLabel(address, device().nbCharsAddress())));
+    break;
+  }
+
+  // check first 4 instructions for "goto" and copy them
+  if (erase) {
+    for (uint i=0; i<4; i++) wdata[nb+i] = device().nopInstruction();
+  } else {
+    bool ok = false;
+    for (uint i=0; i<4; i++) {
+      wdata[nb+i] = data[i];
+      if ( !ok && device().isGotoInstruction(data[i]) ) {
+        ok = true;
+        if ( i==3 && device().gotoInstruction(0x0, false).count()==2 )
+          log(Log::LineType::Warning, "  " + i18n("Only the first word of the \"goto\" instruction is into the first four instructions."));
+      }
+    }
+    if ( !ok ) log(Log::LineType::Warning, "  " + i18n("No \"goto\" instruction in the first four instructions."));
+  }
+
+  // place "goto size-100" at reset vector
+  wdata[0] = device().nopInstruction(); // for icd2
+  uint address = device().addressIncrement(Pic::MemoryRangeType::Code) * (nb+4);
+  Device::Array a = device().gotoInstruction(address, true);
+  for (uint i=0; i<a.size(); i++) wdata[1+i] = a[i];
+  // copy the rest
+  for (uint i=4; i<nb; i++) wdata[i] = data[i];
+
+  uint retries = _retries, nbWords = 0x20; // 16F: 64 bytes (80 bytes reserved) ; 18F: 64 bytes ; 30F: 96 bytes
+  Q_ASSERT( (data.count()%nbWords)==0 );
+  for (uint i=0; i<wdata.count(); i+=nbWords) {
+    if ( !erase ) {
+      bool write = false;
+      for (uint k=0; k<nbWords; k++) {
+        if ( wdata[i+k]==device().mask(Pic::MemoryRangeType::Code) ) continue;
+        write = true;
+        break;
+      }
+      if ( !write ) continue; // skip
+    }
+    for (;;) {
+      uchar crc = 0;
+      uint address = device().addressIncrement(Pic::MemoryRangeType::Code) * i;
+      if ( !sendCodeAddress(address, crc) ) return false;
+      uint nbw = device().nbBytesWord(Pic::MemoryRangeType::Code);
+      if ( !sendChar(nbw*nbWords, &crc) ) return false;
+      log(Log::DebugLevel::Normal, QString("write code memory at %1: %2 bytes").arg(toHexLabel(address, 4)).arg(2*nbWords));
+      for(uint k=0; k<nbWords; k++) {
+        if ( !sendChar(wdata[i+k].byte(0), &crc) ) return false;           // data low
+        if ( !sendChar(wdata[i+k].byte(1), &crc) ) return false;           // data high
+        if ( nbw==3 && !sendChar(wdata[i+k].byte(2), &crc) ) return false; // upper byte
+      }
+      bool ok;
+      if ( !endWrite(crc, retries, ok) ) return false;
+      if (ok) break;
+    }
+  }
+  return true;
+}
+
+bool TinyBootloader::Hardware::writeConfig(const Device::Array &data)
+{
+  if ( device().architecture()==Pic::Architecture::P16X ) return false;
+  uint retries = _retries;
+  for (uint i=0; i<data.count(); i++) {
+    for (;;) {
+      uchar crc = 0;
+      Address address = device().range(Pic::MemoryRangeType::Config).start + i;
+      switch (device().architecture().type()) {
+        case Pic::Architecture::P18F:
+          if ( !sendChar(0x80 | address.byte(2), &crc) ) return false; // address upper | flag
+          if ( !sendChar(address.byte(1), &crc) ) return false;        // address high
+          if ( !sendChar(address.byte(0), &crc) ) return false;        // address low
+          if ( !sendChar(1, &crc) ) return false;                       // nb bytes
+          if ( !sendChar(data[i].byte(0), &crc) ) return false;        // data
+          break;
+        case Pic::Architecture::P30F:
+          if ( !sendChar(address.byte(0), &crc) ) return false; // address low
+          if ( !sendChar(address.byte(1), &crc) ) return false; // address high
+          if ( !sendChar(address.byte(2), &crc) ) return false; // address upper
+          if ( !sendChar(2, &crc) ) return false;                // nb bytes
+          if ( !sendChar(data[i].byte(0), &crc) ) return false; // data low
+          if ( !sendChar(data[i].byte(1), &crc) ) return false; // data high
+          break;
+        default: Q_ASSERT(false); return false;
+      }
+      bool ok;
+      if ( !endWrite(crc, retries, ok) ) return false;
+      if (ok) break;
+    }
+  }
+  return true;
+}
+
+bool TinyBootloader::Hardware::writeEeprom(const Device::Array &data)
+{
+  uint retries = _retries;
+  for (uint i=0; i<data.count(); i++) {
+    for (;;) {
+      uchar crc = 0;
+      Address address = device().range(Pic::MemoryRangeType::Config).start + i;
+      switch (device().architecture().type()) {
+        case Pic::Architecture::P16X:
+          if ( !sendChar(0x40, &crc) ) return false;             // flag
+          if ( !sendChar(address.byte(0), &crc) ) return false; // address
+          if ( !sendChar(1, &crc) ) return false;                // nb bytes
+          if ( !sendChar(data[i].byte(0), &crc) ) return false; // data
+          break;
+        case Pic::Architecture::P18F:
+          if ( !sendChar(0x40, &crc) ) return false;             // flag
+          if ( !sendChar(address.byte(0), &crc) ) return false; // address
+          if ( !sendChar(data[i].byte(0), &crc) ) return false; // data
+          if ( !sendChar(0x00, &crc) ) return false;             // dummy
+          break;
+        case Pic::Architecture::P30F:
+          if ( !sendChar(address.byte(0), &crc) ) return false; // address low
+          if ( !sendChar(address.byte(1), &crc) ) return false; // address high
+          if ( !sendChar(address.byte(2), &crc) ) return false; // address upper
+          if ( !sendChar(2, &crc) ) return false;                // nb bytes
+          if ( !sendChar(data[i].byte(0), &crc) ) return false; // data low
+          if ( !sendChar(data[i].byte(1), &crc) ) return false; // data high
+          break;
+        default: Q_ASSERT(false); return false;
+      }
+      bool ok;
+      if ( !endWrite(crc, retries, ok) ) return false;
+      if (ok) break;
+    }
+  }
+  return true;
+}
+
+bool TinyBootloader::Hardware::write(Pic::MemoryRangeType type, const Device::Array &data)
+{
+  Q_ASSERT( data.count()==device().nbWords(type) );
+  if ( type==Pic::MemoryRangeType::Code ) return writeCode(data, false);
+  if ( type==Pic::MemoryRangeType::Config ) return writeConfig(data);
+  if ( type==Pic::MemoryRangeType::Eeprom ) return writeEeprom(data);
+  return false;
+}
+
+//-----------------------------------------------------------------------------
+bool TinyBootloader::DeviceSpecific::canWriteRange(Pic::MemoryRangeType type) const
+{
+  if ( type==Pic::MemoryRangeType::Eeprom || type==Pic::MemoryRangeType::Code ) return true;
+  if ( device().architecture()==Pic::Architecture::P18F && type==Pic::MemoryRangeType::Config ) return true;
+  return false;
+}
+
+bool TinyBootloader::DeviceSpecific::doErase(bool)
+{
+  bool eeprom = readConfigEntry(::Programmer::Config::ProgramEeprom).toBool();
+  if (eeprom) log(Log::LineType::Warning, "  " + i18n("Only code and EEPROM will be erased."));
+  else log(Log::LineType::Warning, "  " + i18n("Only code will be erased."));
+  if ( doEraseRange(Pic::MemoryRangeType::Code)==false ) return false;
+  if ( eeprom && doEraseRange(Pic::MemoryRangeType::Eeprom)==false ) return false;
+  return true;
+}
+
+bool TinyBootloader::DeviceSpecific::doEraseRange(Pic::MemoryRangeType type)
+{
+  Pic::Memory memory(device());
+  if ( type==Pic::MemoryRangeType::Code ) return static_cast<Hardware &>(hardware()).writeCode(memory.arrayForWriting(type), true);
+  return hardware().write(type, memory.arrayForWriting(type));
+}