path: root/src/progs/icd2/base/icd2.cpp

/***************************************************************************
 *   Copyright (C) 2005-2006 Nicolas Hadacek <hadacek@kde.org>             *
 *   Copyright (C) 2002-2003 Stephen Landamore <stephen@landamore.com>     *
 *                                                                         *
 *   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 "icd2.h"

#include "common/global/global.h"
#include "common/common/misc.h"
#include "common/port/port_base.h"
#include "icd2_data.h"
#include "icd2_usb.h"

//-----------------------------------------------------------------------------
const uchar Icd2::TARGET_MODE_VALUES[Pic::Nb_TargetModes] = {
  0x00, // stopped
  0x01, // running
  0x02  // in programming
};

const char * const Icd2::RESET_MODE_VALUES[Pic::Nb_ResetModes] = {
  "00", // reset held
  "01"  // reset released
};

//-----------------------------------------------------------------------------
const Icd2::Hardware::VoltageTypeData Icd2::Hardware::VOLTAGE_TYPE_DATA[Pic::Nb_VoltageTypes] = {
 { "37", 0.07988 }, // icd Vpp
 { "34", 0.03908 }, // target Vdd
 { "35", 0.07988 }, // target Vpp
};

const char * const Icd2::Hardware::WRITE_MODE_VALUES[Pic::Nb_WriteModes] = {
  "00", // write only
  "01"  // erase then write
};

const int Icd2::TestData::RESULT_TYPE_VALUES[::Programmer::Nb_ResultTypes+1] = {
  0x00, // pass
  0x01, // low
  0x80, // high
  -2,   // not used
  -1
};

const char * const Icd2::TestData::VOLTAGE_LABELS[Nb_VoltageTypes] = {
  I18N_NOOP("Target Vdd"), I18N_NOOP("Module Vpp"), I18N_NOOP("MCLR ground"),
  I18N_NOOP("MCLR Vdd"), I18N_NOOP("MCLR Vpp")
};

Icd2::TestData::TestData()
{
  for (uint k=0; k<Nb_VoltageTypes; k++) _voltages[k] = -1;
}

Icd2::TestData::TestData(const TQString &rx)
{
  for (uint k=0; k<Nb_VoltageTypes; k++)
    _voltages[k] = fromHex(rx.mid(5 + 2*k, 2), 0);
}

bool Icd2::TestData::pass() const
{
  for (uint k=0; k<Nb_VoltageTypes; k++)
    if ( _voltages[k]!=RESULT_TYPE_VALUES[::Programmer::Pass] ) return false;
  return true;
}

TQString Icd2::TestData::result(VoltageType type) const
{
  for (uint i=0; i<=(::Programmer::Nb_ResultTypes); i++)
    if ( _voltages[type]==RESULT_TYPE_VALUES[i] ) return i18n(::Programmer::RESULT_TYPE_LABELS[i]);
  return toHex(_voltages[type], 2);
}

TQString Icd2::TestData::pretty(VoltageType type) const
{
  return i18n(VOLTAGE_LABELS[type]) + "=" + result(type);
}

//-----------------------------------------------------------------------------
const char *Icd2::Hardware::readCommand(Pic::MemoryRangeType type) const
{
  switch (type.type()) {
    case Pic::MemoryRangeType::Code:             return "47";
    case Pic::MemoryRangeType::Eeprom:           return "48";
    case Pic::MemoryRangeType::Config:
      if ( device().architecture()==Pic::Architecture::P18J ) return "47";
      return "49";
    case Pic::MemoryRangeType::UserId:           return "4A";
    case Pic::MemoryRangeType::DeviceId:
      if ( device().architecture()==Pic::Architecture::P30F ) return "49";
      return "4A";
    case Pic::MemoryRangeType::Cal:
    case Pic::MemoryRangeType::CalBackup:
      if ( device().architecture()==Pic::Architecture::P16X ) return "49"; // ?
      return "47"; // for baseline only ?
    case Pic::MemoryRangeType::DebugVector:      return "40";
    case Pic::MemoryRangeType::ProgramExecutive:
    case Pic::MemoryRangeType::HardwareStack:
    case Pic::MemoryRangeType::Nb_Types:    break;
  }
  Q_ASSERT(false);
  return 0;
}

const char *Icd2::Hardware::writeCommand(Pic::MemoryRangeType type) const
{
  switch (type.type()) {
    case Pic::MemoryRangeType::Code:             return "43";
    case Pic::MemoryRangeType::Eeprom:           return "44";
    case Pic::MemoryRangeType::Config:
      if ( device().architecture()==Pic::Architecture::P18J ) return "43";
      return "45";
    case Pic::MemoryRangeType::UserId:           return "46";
    case Pic::MemoryRangeType::DeviceId:         break;
    case Pic::MemoryRangeType::Cal:
    case Pic::MemoryRangeType::CalBackup:
      if ( device().architecture()==Pic::Architecture::P16X ) return "45"; // ?
      return "43"; // for baseline only ?
    case Pic::MemoryRangeType::DebugVector:      return "41";
    case Pic::MemoryRangeType::ProgramExecutive:
    case Pic::MemoryRangeType::HardwareStack:
    case Pic::MemoryRangeType::Nb_Types:    break;
  }
  Q_ASSERT(false);
  return 0;
}

bool Icd2::Hardware::uploadFirmware(const Pic::Memory &memory)
{
  if ( !internalConnect("V") ) return false;
  log(Log::LineType::Information, "  Uploading firmware to ICD2...");
  uint start = 0x0004, size = 0x1BFB;
  TQString cmd = "10" + toHex(start, 4) + toHex(size, 4);
  if ( !command(cmd, 0) ) return false;
  uint nbBytesWord = memory.device().nbBytesWord(Pic::MemoryRangeType::Code); // should be 2 for 16F876
  Device::Array data = memory.arrayForWriting(Pic::MemoryRangeType::Code);
  if ( !writeBlock(nbBytesWord, data, start, size) ) return false;
  if ( !receiveResponse(cmd, 0, false) ) return false;
  if ( !internalConnect("U") ) return false;
  return true;
}

bool Icd2::Hardware::setTarget()
{
  log(Log::DebugLevel::Normal, "  Set target");
  // set target family
  const Icd2::Data &d = data(device().name());
  if ( !command(TQString("2A") + toHex(d.famid, 2), 0) ) return false;
  // set code range end
  Address end = device().range(Pic::MemoryRangeType::Code).end;
  if ( device().range(Pic::MemoryRangeType::Cal).start==end ) end += 1;
  if ( !command("06" + toHex(end, 6), 0) ) return false;
  return true;
}

bool Icd2::Hardware::setup()
{
  // ??
  if ( device().architecture()==Pic::Architecture::P30F )
    if ( !command("0900", 0) ) return false;

  // ??
  _port->send("$7F00\x0D", 6);
  TQString s;
  if ( !_port->receive(2, s) ) return false;
  if ( s!="02" ) {
    log(Log::LineType::Error, i18n("Unexpected answer ($7F00) from ICD2 (%1).").arg(s));
    return false;
  }

  // ??
  if ( !command("08", 2) ) return false;
  if ( _rx.mid(5, 2)!="00" ) {
    log(Log::LineType::Error, i18n("Unexpected answer (08) from ICD2 (%1).").arg(_rx));
    return false;
  }

  return !hasError();
}

bool Icd2::Hardware::sendCommand(const TQString &s)
{
  //format: <LLXX....CC>
  TQString cs = s.upper();
  TQString tx = "<";
  tx += toHex(cs.length() + 6, 2);
  tx += cs;
  uchar chk = tx[1].latin1() + tx[2].latin1();
  for (uint i=0; i<uint(s.length()); i++) chk += cs[i].latin1();
  tx += toHex(chk, 2);
  tx += '>';
  log(Log::DebugLevel::Extra, TQString("send command: '%1'").arg(tx));
  TQByteArray a = toAscii(tx);
  return _port->send(a.data(), a.count());
}

bool Icd2::Hardware::receiveResponse(const TQString &command, uint responseSize, bool poll)
{
  // format: [LLXX...CC]
  uint size = responseSize + 8;
  if ( poll && _port->type()==PortType::USB ) {
    if ( !static_cast<USBPort *>(_port)->poll(size, _rx) ) return false;
  } else if ( !_port->receive(size, _rx, 180000) ) return false; // is 3 minutes enough ?? (we should really have an abort button here...)
  log(Log::DebugLevel::Extra, TQString("received answer: '%1'").arg(_rx));
  if ( size!=fromHex(_rx.mid(1, 2), 0) ) {
    log(Log::LineType::Error, i18n("Received length too short."));
    return false;
  }
  if ( uint(_rx.length())!=size ) {
    log(Log::LineType::Error, i18n("Received string too short."));
    return false;
  }
  if ( _rx[0]!='[' || _rx[size-1]!=']' ) {
    log(Log::LineType::Error, i18n("Malformed string received \"%1\"").arg(_rx));
    return false;
  }
  if ( command.mid(0, 2)!=_rx.mid(3, 2) ) {
    log(Log::LineType::Error, i18n("Wrong return value (\"%1\"; was expecting \"%2\")")
             .arg(_rx.mid(3, 2)).arg(command.mid(0, 2)));
    return false;
  }
  // verify the checksum
  uchar chk = 0;
  for (uint i=1; i<size-3; i++) chk += _rx[i].latin1();
  if ( chk!=fromHex(_rx.mid(size-3, 2), 0) ) {
    log(Log::LineType::Error, i18n("Bad checksum for received string"));
    return false;
  }
  return true;
}

bool Icd2::Hardware::command(const TQString &command, uint responseSize)
{
  if ( hasError() ) return false;
  if ( !sendCommand(command) ) return false;
  if ( !receiveResponse(command, responseSize, false) ) return false;
  return true;
}

bool Icd2::Hardware::getFirmwareVersion(VersionData &version)
{
  if ( !command("01", 6) ) return false;
  version = VersionData::fromHexString(_rx.mid(5, 6));
  return true;
}

uint Icd2::Hardware::getFirmwareId()
{
  if ( !command("07", 2) ) return 0;
  return fromHex(_rx.mid(5, 2), 0);
}

bool Icd2::Hardware::getDebugExecVersion(VersionData &version)
{
  if ( !command("04", 6) ) return false;
  version = VersionData::fromHexString(_rx.mid(5, 6));
  return true;
}

bool Icd2::Hardware::setTargetPowerOn(bool on)
{
  return command(TQString("05") + (on ? "FF" : "00"), 0);
}

bool Icd2::Hardware::readVoltage(Pic::VoltageType type, double &value)
{
  if ( !command(VOLTAGE_TYPE_DATA[type].command, 2) ) return false;
  value = VOLTAGE_TYPE_DATA[type].factor * fromHex(_rx.mid(5, 2), 0);
  return true;
}

bool Icd2::Hardware::readVoltages(VoltagesData &voltages)
{
  for (uint i=0; i<Pic::Nb_VoltageTypes; i++) {
    if ( !readVoltage(Pic::VoltageType(i), voltages[i].value) ) return false;
    voltages[i].error = false;
  }
  return true;
}

bool Icd2::Hardware::getTargetMode(Pic::TargetMode &tmode)
{
  if ( !command("2C", 2) ) return false;
  uchar mode = fromHex(_rx.mid(5, 2), 0);
  for (uint i=0; i<Pic::Nb_TargetModes; i++) {
    if ( mode!=TARGET_MODE_VALUES[i] ) continue;
    tmode = Pic::TargetMode(i);
    return true;
  }
  Q_ASSERT(false);
  return false;
}

bool Icd2::Hardware::setTargetReset(Pic::ResetMode mode)
{
  return command(TQString("33") + RESET_MODE_VALUES[mode], 0);
}

bool Icd2::Hardware::selfTest(TestData &test)
{
  if ( !command("02", 10) ) return false;
  test = TestData(_rx);
  return true;
}

bool Icd2::Hardware::readBlock(uint nbBytesWord, uint nbWords, Device::Array &data)
{
  //qDebug("readBlock %i %s", nbBytesWord, toHex(nbWords, 8).data());
  // receive data
  uint length = 2*nbBytesWord*nbWords+4;
  TQString s;
  uint i = 0;
  while ( i<length ) {
    uint maxSize = (_port->type()==PortType::Serial ? 2*nbBytesWord : 0x100);
    uint size = TQMIN(maxSize, length-i);
    TQString tmp;
    if ( _port->type()==PortType::USB ) {
      if ( !static_cast<USBPort *>(_port)->dataReceive(size, tmp) ) return false;
    } else if ( !_port->receive(size, tmp) ) return false;
    s += tmp;
    i += size;
  }

  // treat data
  if ( s[0]!='{' || s[s.length()-1]!='}' ) {
    log(Log::LineType::Error, i18n("Invalid begin or end character for read block."));
    return false;
  }
  log(Log::DebugLevel::Max, "received: " + s);
  data.resize(nbWords);
  TQ_UINT8 chk = 0;
  for (uint i=0; i<nbWords; i++) {
    TQString ts = s.mid(1+2*nbBytesWord*i, 2*nbBytesWord);
    //if ( i<10 ) qDebug("%i: %s", i, ts.data());
    data[i] = 0;
    for (int k=nbBytesWord-1; k>=0; k--) {
      data[i] = data[i] << 8;
      data[i] |= fromHex(ts.mid(2*k, 2), 0);
      chk += ts[2*k].latin1() + ts[2*k+1].latin1();
    }
  }

  TQString cs = s.mid(s.length()-3, 2);
  if ( chk!=fromHex(cs, 0) ) {
    log(Log::LineType::Error, i18n("Bad checksum for read block: %1 (%2 expected).").arg(cs).arg(toHex(chk, 2)));
    return false;
  }
  return true;
}

bool Icd2::Hardware::readMemory(Pic::MemoryRangeType type, uint wordOffset,
                                Device::Array &data, const ::Programmer::VerifyData *vdata)
{
  const char *r = readCommand(type);
  if ( r==0 ) return false;
  uint nbBytesWord = device().nbBytesWord(type);
  uint div = 2;
  if ( type==Pic::MemoryRangeType::Eeprom || nbBytesWord>=2 ) div = 1;
  uint inc = device().addressIncrement(type);
  Address start = device().range(type).start; // address
  uint todo = inc * data.count(); // address
  uint offset = inc * wordOffset; // address
  //qDebug("read size=%s div=%i nbBytes=%i", toHex(size, 8).data(), div, nbBytesWord);
  data.resize(0);
  do {
    uint size = TQMIN(todo, uint(0x1000)); // addresses
    uint nb = size / inc; // word
    //qDebug("read %s start=%s size=%s", Pic::MEMORY_RANGE_TYPE_DATA[type].label, toHex(start+offset, 8).data(), toHex(nb, 8).data());
    TQString cmd = r + toHex(start+offset, 8) + toHex(nb/div, 8);
    if ( !command(cmd, 0) ) return false;
    Device::Array pdata;
    if ( !readBlock(nbBytesWord, nb, pdata) ) return false;
    if ( !receiveResponse(cmd, 0, false) ) return false;
    if (vdata) {
      for (uint i=0; i<pdata.count(); i++)
        if ( !verifyWord(wordOffset+data.count()+i, pdata[i], type, *vdata) ) return false;
    }
    data += pdata;
    offset += size;
    todo -= size;
    if ( type==Pic::MemoryRangeType::Code || type==Pic::MemoryRangeType::Eeprom )
      _base.progressMonitor().addTaskProgress(nb);
  } while ( todo!=0 );
  return true;
}

bool Icd2::Hardware::writeBlock(uint nbBytesWord, const Device::Array &data, uint wordIndex, uint nbWords)
{
  log(Log::DebugLevel::Extra, TQString("writeBlock offset:%1 nbWords:%2 (size: %3)").arg(toHex(wordIndex, 8)).arg(toHex(nbWords, 8)).arg(toHex(data.size(), 8)));
  Q_ASSERT( wordIndex+nbWords<=data.size() );
  // prepare data
  TQString s = "{";
  uchar chk = 0;
  for (uint i=0; i<nbWords; i++) {
    TQString ts = toHex(data[wordIndex+i], 2*nbBytesWord);
    for (int k=nbBytesWord-1; k>=0; k--) {
      //if ( i<10 || i>=nbWords-10 ) qDebug("send: %i-%i %s", i, k, ts.mid(2*k, 2).data());
      s += ts.mid(2*k, 2);
      chk += ts[2*k].latin1() + ts[2*k+1].latin1();
    }
  }
  s += toHex(chk, 2);
  s += "}";
  log(Log::DebugLevel::Max, "send: " + s);

  // send data
  uint i = 0;
  while ( i<uint(s.length()) ) {
    uint maxSize = (_port->description().type==PortType::Serial ? 2*nbBytesWord : 0x100);
    if ( _port->description().type==PortType::Serial && i==0 ) maxSize = 1;
    uint size = TQMIN(maxSize, s.length()-i);
    TQByteArray a = toAscii(s);
    if ( _port->type()==PortType::USB ) {
      if ( !static_cast<USBPort *>(_port)->dataSend(a.data()+i, size) ) return false;
    } else if ( !_port->send(a.data()+i, size) ) return false;
    i += size;
  }

  //qDebug("done sending %i words (chk=%s)", nbWords, toHex(chk, 2).data());
  return true;
}

bool Icd2::Hardware::writeMemory(Pic::MemoryRangeType type, uint wordOffset, const Device::Array &data)
{
  //qDebug("write memory: offset:%s nbWords:%s (size: %s)", toHex(wordOffset, 4).data(), toHex(nbWords, 4).data(), toHex(data.size(), 4).data());
  const char *w = writeCommand(type);
  if ( w==0 ) return true;
  uint nbBytesWord = device().nbBytesWord(type);
  uint div = 2;
  if ( type==Pic::MemoryRangeType::Eeprom || nbBytesWord>=2 ) div = 1;
  uint inc = device().addressIncrement(type);
  Address start = device().range(type).start; // address
  uint todo = inc * data.count(); // address
  uint offset = inc * wordOffset; // address
  uint index = 0;
  //qDebug("write todo=%s div=%i nbBytes=%i dataSize=%i", toHex(todo, 8).data(), div, nbBytesWord, data.size());
  do {
    uint size = TQMIN(todo, uint(0x1000)); // address
    uint nb = size / inc; // word
    //qDebug("write %s start=%s nbWords=%s", Pic::MEMORY_RANGE_TYPE_DATA[type].label, toHex(start+offset, 8).data(), toHex(nb, 8).data());
    TQString cmd = w + toHex(start+offset+index, 8) + toHex(nb/div, 8);
    if ( !command(cmd, 0) ) return false;
    if ( !writeBlock(nbBytesWord, data, index/inc, nb) ) return false;
    if ( !receiveResponse(cmd, 0, false) ) return false;
    index += size;
    todo -= size;
    if ( type==Pic::MemoryRangeType::Code || type==Pic::MemoryRangeType::Eeprom )
      _base.progressMonitor().addTaskProgress(nb);
  } while ( todo!=0 );
  return true;
}

bool Icd2::Hardware::eraseAll()
{
  setTargetReset(Pic::ResetHeld);
  if ( hasError() ) return false;
  if ( !sendCommand("29") ) return false;
  if ( !receiveResponse("29", 0, true) ) return false; // poll
  return true;
}

bool Icd2::Hardware::haltRun()
{
  return command("2E", 0);
}

bool Icd2::Hardware::step()
{
  return command("2F", 0);
}

bool Icd2::Hardware::resumeRun()
{
  return command("30", 0);
}

bool Icd2::Hardware::setWriteMode(Pic::WriteMode mode)
{
  return command(TQString("4B") + WRITE_MODE_VALUES[mode], 0);
}

bool Icd2::Hardware::writeRegister(Address address, BitValue value, uint nbBytes)
{
  TQString cmd = "1B" + toHex(address, 8) + toHex(nbBytes, 8);
  if ( !command(cmd, 0) ) return false;
  Device::Array data(nbBytes);
  for (uint i=0; i<nbBytes; i++) data[nbBytes-i-1] = value.byte(i);
  if ( !writeBlock(1, data, 0, nbBytes) ) return false;
  return receiveResponse(cmd, 0, false);
}

bool Icd2::Hardware::readRegister(Address address, BitValue &value, uint nbBytes)
{
  TQString cmd = "1E" + toHex(address, 8) + toHex(nbBytes, 8);
  if ( !command(cmd, 0) ) return false;
  Device::Array data;
  if ( !readBlock(1, nbBytes, data) ) return false;
  if ( !receiveResponse(cmd, 0, false) ) return false;
  value = 0;
  for (uint i=0; i<nbBytes; i++) {
    value <<= 8;
    value += data[i];
  }
  return true;
}

BitValue Icd2::Hardware::getProgramCounter()
{
  if ( !command("3D", 8) ) return 0;
  return fromHex(_rx.mid(5, 8), 0);
}