ReferenceBlock.cpp

   1 #include "ReferenceBlock.h"
   2
   3 #include "ReferenceInterface.h"
   4 #include "BlockParameter.h"
   5 #include "BlockParameterUser.h"
   6 #include "BlockParameterGeneric.h"
   7 #include "BlockParameterPort.h"
   8 #include "BlockParameterWishbone.h"
   9
  10 ReferenceBlock::ReferenceBlock(const QString _xmlFile) : AbstractBlock() {
  11   xmlFile = _xmlFile;
  12 }
  13
  14 void ReferenceBlock::addCategory(int id) {
  15  categories.append(id);
  16 }
  17
  18 void ReferenceBlock::setBriefDescription(const QString& str) {
  19   if(str != NULL)
  20     descriptionBrief = str;
  21 }
  22
  23 void ReferenceBlock::setDetailedDescription(const QString& str) {
  24   if(str != NULL)
  25     descriptionDetail = str;
  26 }
  27
  28 void ReferenceBlock::addImplementation(BlockImplementation *impl) {
  29   implementations.append(impl);
  30 }
  31
  32 void ReferenceBlock::setHashMd5() {
  33   QFile file(xmlFile);
  34   if (file.open(QIODevice::ReadOnly)) {
  35     QByteArray fileData = file.readAll();
  36     QByteArray hashData = QCryptographicHash::hash(fileData, QCryptographicHash::Md5);
  37     hashMd5 = QString(hashData.toHex());
  38     cout << qPrintable(xmlFile) << " has md5 hash : " << qPrintable(hashMd5) << endl;
  39   }
  40   else {
  41     hashMd5 = "";
  42   }
  43 }
  44
  45 void ReferenceBlock::load(QDomElement &elt) throw(Exception) {
  46
  47
  48   cout << "Block : get informations" << endl;
  49   QDomElement eltInfo  = elt.firstChildElement("informations");
  50   try {
  51     loadInformations(eltInfo);
  52   }
  53   catch(int err) {
  54     throw(err);
  55   }
  56
  57   cout << "Block : get params" << endl;
  58   QDomElement eltParams  = eltInfo.nextSiblingElement("parameters");
  59   try {
  60     loadParameters(eltParams);
  61   }
  62   catch(int err) {
  63     throw(err);
  64   }
  65
  66   cout << "Block : get interfaces" << endl;
  67   QDomElement eltInter  = eltParams.nextSiblingElement("interfaces");
  68   try {
  69     loadInterfaces(eltInter);
  70   }
  71   catch(int err) {
  72     throw(err);
  73   }
  74
  75   // create interfaces that correspond to a wishbone parameter, if any.
  76   try {
  77     createInterfaceForParameters();
  78   }
  79   catch(int err) {
  80     throw(err);
  81   }
  82 }
  83
  84 void ReferenceBlock::loadInformations(QDomElement &elt) throw(Exception) {
  85
  86   bool ok;
  87   if ((elt.isNull()) || (elt.tagName() != "informations")) throw (Exception(BLOCKFILE_CORRUPTED));
  88   // getting name
  89   cout << "Block info : get name" << endl;
  90   QDomNode nodeName = elt.firstChild();
  91   QDomNode nodeNameTxt = nodeName.firstChild();
  92   if (nodeNameTxt.isNull()) {
  93     name = "no_name";
  94   }
  95   else {
  96     QDomText txtName = nodeNameTxt.toText();
  97     name = txtName.data().trimmed();
  98     cout<< "block name : " << qPrintable(name) << endl;
  99   }
 100
 101   // getting categories
 102   cout << "Block info : get categories" << endl;
 103   QDomElement eltCat = nodeName.nextSiblingElement("category");
 104
 105   QString idsStr = eltCat.attribute("ids","none");
 106   if (idsStr == "none") throw (Exception(BLOCKFILE_CORRUPTED));
 107   QStringList listCat = idsStr.split(",");
 108   foreach(QString str, listCat)
 109   {
 110     int idCat = str.toInt(&ok);
 111     categories.append(idCat);
 112   }
 113
 114   // getting description
 115   cout << "Block info : get description" << endl;
 116   QDomElement eltDesc = eltCat.nextSiblingElement("description");
 117   // getting brief
 118   QDomElement eltBrief = eltDesc.firstChildElement("brief");
 119   QDomNode nodeBriefTxt = eltBrief.firstChild();
 120   if (nodeBriefTxt.isNull()) {
 121     descriptionBrief = "no brief description";
 122   }
 123   else {
 124     QDomText txtBrief = nodeBriefTxt.toText();
 125     descriptionBrief = txtBrief.data().trimmed();
 126     cout << "block brief desc : " << qPrintable(descriptionBrief) << endl;
 127   }
 128   // getting detailed
 129   QDomElement eltDetail = eltBrief.nextSiblingElement("detailed");
 130   QDomNode nodeDetailTxt = eltDetail.firstChild();
 131   if (nodeDetailTxt.isNull()) {
 132     descriptionDetail = "no detailed description";
 133   }
 134   else {
 135     QDomText txtDetail = nodeDetailTxt.toText();
 136     descriptionDetail = txtDetail.data().trimmed();
 137     cout << "block detail desc : " << qPrintable(descriptionDetail) << endl;
 138   }
 139 }
 140
 141 void ReferenceBlock::loadParameters(QDomElement &elt) throw(Exception) {
 142
 143   if ((elt.isNull()) || (elt.tagName() != "parameters")) throw (Exception(BLOCKFILE_CORRUPTED));
 144
 145   QDomNodeList listNodeParam = elt.elementsByTagName("parameter");
 146   for(int i=0; i<listNodeParam.size(); i++) {
 147     QDomNode node = listNodeParam.at(i);
 148     QDomElement elt = node.toElement();
 149     QString nameStr = elt.attribute("name","none");
 150     QString contextStr = elt.attribute("context","none");
 151     QString typeStr = elt.attribute("type","none");
 152     QString valueStr = elt.attribute("value","none");
 153     BlockParameter *param = NULL;
 154
 155     if(valueStr == "none"){
 156         if (contextStr == "generic") throw (Exception(BLOCKFILE_CORRUPTED)); // set is required for generics
 157         valueStr = "";
 158     }
 159     if (contextStr == "user") {
 160       param = new BlockParameterUser(this,nameStr,valueStr);
 161     }
 162     else if (contextStr == "generic") {
 163       param = new BlockParameterGeneric(this,nameStr,typeStr,valueStr);
 164     }
 165     else if (contextStr == "wb") {
 166       QString widthStr = elt.attribute("width","none");
 167       QString wbStr = elt.attribute("wishbone","none");
 168       int access = 0;
 169       int duration = 0;
 170       QString wbValue = "";
 171       QStringList listWb = wbStr.split(",");
 172       cout << "wb param has:";
 173       foreach(QString s, listWb) {
 174         cout << qPrintable(s) << " | ";
 175       }
 176       cout << endl;
 177
 178       if (listWb.at(0) == "r") {
 179         access = BlockParameter::Read;
 180       }
 181       else if (listWb.at(0) == "w") {
 182         access = BlockParameter::Write;
 183         bool ok;
 184         wbValue = listWb.at(1).toInt(&ok);
 185         if(!ok){
 186             if(listWb.at(1) == "true" || listWb.at(1) == "false"){
 187                 wbValue = listWb.at(1);
 188             } else {
 189                 wbValue = "data";
 190             }
 191         }
 192         if(listWb.at(2) == "trigger") {
 193             duration = BlockParameter::Trigger;
 194         }
 195         else if(listWb.at(2) == "perm") {
 196             duration = BlockParameter::Permanent;
 197         }
 198       }
 199       param = new BlockParameterWishbone(this,nameStr,typeStr,widthStr,valueStr,access,wbValue,duration);
 200     }
 201     else if (contextStr == "port") {
 202       QString ifaceStr = elt.attribute("iface","none");
 203       param = new BlockParameterPort(this,nameStr,valueStr,ifaceStr);
 204
 205     }
 206     else {
 207       throw (Exception(BLOCKFILE_CORRUPTED));
 208     }
 209     params.append(param);
 210   }
 211 }
 212
 213 void ReferenceBlock::loadInterfaces(QDomElement &elt) throw(Exception) {
 214
 215   QString nameStr;
 216   QString typeStr;
 217   QString widthStr;
 218   QString purposeStr;
 219   int purpose;
 220   QString multStr;
 221   int mult;
 222   AbstractInterface* inter;
 223
 224   if ((elt.isNull()) || (elt.tagName() != "interfaces")) throw (Exception(BLOCKFILE_CORRUPTED));
 225
 226   QDomElement eltInputs = elt.firstChildElement("inputs");
 227   QDomNodeList listNodeInputs = eltInputs.elementsByTagName("input");
 228   for(int i=0;i<listNodeInputs.size();i++) {
 229     QDomNode node = listNodeInputs.at(i);
 230     QDomElement eltInput = node.toElement();
 231     nameStr = eltInput.attribute("name","none");
 232     typeStr = eltInput.attribute("type","none");
 233     widthStr = eltInput.attribute("width","none");
 234     purposeStr = eltInput.attribute("purpose","none");
 235     cout << "block : " << this->getName().toStdString() << endl;
 236     cout << "purpose for " << nameStr.toStdString() << " : " << purposeStr.toStdString() << endl;
 237     purpose = ReferenceInterface::translatePurpose(purposeStr);
 238     cout << "translated purpose : " << purpose << endl;
 239     multStr = eltInput.attribute("multiplicity","none");
 240     mult = ReferenceInterface::translateMultiplicity(multStr);
 241
 242     inter = new ReferenceInterface(this,nameStr,typeStr,widthStr,AbstractInterface::Input, purpose, mult);
 243     inputs.append(inter);
 244   }
 245
 246   QDomElement eltOutputs = eltInputs.nextSiblingElement("outputs");
 247   QDomNodeList listNodeOutputs = eltOutputs.elementsByTagName("output");
 248   for(int i=0;i<listNodeOutputs.size();i++) {
 249     QDomNode node = listNodeOutputs.at(i);
 250     QDomElement eltOutput = node.toElement();
 251     nameStr = eltOutput.attribute("name","none");
 252     typeStr = eltOutput.attribute("type","none");
 253     widthStr = eltOutput.attribute("width","none");
 254     purposeStr = eltOutput.attribute("purpose","none");
 255     purpose = ReferenceInterface::translatePurpose(purposeStr);
 256     multStr = eltOutput.attribute("multiplicity","none");
 257     mult = ReferenceInterface::translateMultiplicity(multStr);
 258
 259     inter = new ReferenceInterface(this,nameStr,typeStr,widthStr,AbstractInterface::Output, purpose, mult);
 260     outputs.append(inter);
 261   }
 262
 263   QDomElement eltBidirs = eltInputs.nextSiblingElement("bidirs");
 264   QDomNodeList listNodeBidirs = eltBidirs.elementsByTagName("bidir");
 265   for(int i=0;i<listNodeBidirs.size();i++) {
 266     QDomNode node = listNodeBidirs.at(i);
 267     QDomElement eltBidir = node.toElement();
 268     nameStr = eltBidir.attribute("name","none");
 269     typeStr = eltBidir.attribute("type","none");
 270     widthStr = eltBidir.attribute("width","none");
 271     purposeStr = eltBidir.attribute("purpose","none");
 272     purpose = ReferenceInterface::translatePurpose(purposeStr);
 273     multStr = eltBidir.attribute("multiplicity","none");
 274     mult = ReferenceInterface::translateMultiplicity(multStr);
 275
 276     inter = new ReferenceInterface(this,nameStr,typeStr,widthStr,AbstractInterface::InOut, purpose, mult);
 277     bidirs.append(inter);
 278   }
 279 }
 280
 281 void ReferenceBlock::createInterfaceForParameters() throw(Exception){
 282   ReferenceInterface* iface = NULL;
 283   foreach(BlockParameter* param, params) {
 284
 285     if (param->isWishboneParameter()) {
 286
 287       BlockParameterWishbone* p = (BlockParameterWishbone*)param;
 288       cout << "creating interface for parameter wb " << qPrintable(p->getName()) << endl;
 289
 290       if (p->getWBAccess() == BlockParameter::Read) {
 291         iface = new ReferenceInterface(this,p->getName(),p->getTypeString(),p->getWidth(), AbstractInterface::Output, AbstractInterface::Wishbone,1);
 292         outputs.append(iface);
 293       }
 294       else if (p->getWBAccess() == BlockParameter::Write) {
 295         iface = new ReferenceInterface(this,p->getName(),p->getTypeString(),p->getWidth(), AbstractInterface::Input, AbstractInterface::Wishbone,1);
 296         inputs.append(iface);
 297       }
 298       else {
 299         throw (Exception(BLOCKFILE_CORRUPTED));
 300       }
 301     }
 302   }
 303 }
 304
 305 void ReferenceBlock::parametersValidation(QList<AbstractBlock *> *checkedBlocks, QList<AbstractBlock *> *blocksToConfigure) {
 306     return;
 307 }
 308
 309 /* operator<<() :
 310    only used to save all ReferenceBlock in a library in binary format, so that reference blocks
 311    are read very fast at application startup.
 312
 313  */
 314 QDataStream& operator<<(QDataStream &out, const ReferenceBlock &b) {
 315
 316   out.setVersion(QDataStream::Qt_5_0);
 317
 318   QByteArray blockData;
 319   QDataStream toWrite(&blockData, QIODevice::WriteOnly);
 320
 321   toWrite << b.name;
 322   toWrite << b.xmlFile;
 323   toWrite << b.descriptionBrief;
 324   toWrite << b.descriptionDetail;
 325   toWrite << b.categories;
 326   toWrite << b.hashMd5;
 327   toWrite << b.params.size();
 328   BlockParameter* p;
 329   for(int i=0;i<b.params.size();i++) {
 330     p = b.params.at(i);
 331     toWrite << p->getContext();
 332     toWrite << p->getName();
 333     toWrite << p->getTypeString();
 334     toWrite << p->getValue().toString();
 335     if (p->isPortParameter()) {
 336       toWrite << ((BlockParameterPort*)p)->getIfaceName();
 337     }
 338     else if (p->isWishboneParameter()) {
 339       BlockParameterWishbone* pwb = (BlockParameterWishbone*)p;
 340       toWrite << pwb->getWidth();
 341       toWrite << pwb->getWBAccess();
 342       toWrite << pwb->getWBValue();
 343       toWrite << pwb->getWBDuration();
 344     }
 345
 346   }
 347
 348   toWrite << b.inputs.size();
 349   for(int i=0; i<b.inputs.size(); i++){
 350     ReferenceInterface *iface = (ReferenceInterface *)(b.inputs.at(i));
 351     toWrite << iface->getName();
 352     toWrite << iface->getWidth();
 353     toWrite << iface->getPurpose();
 354     toWrite << iface->getDirection();
 355     toWrite << iface->getMultiplicity();
 356   }
 357   toWrite << b.outputs.size();
 358   for(int i=0; i<b.outputs.size(); i++){
 359     ReferenceInterface *iface = (ReferenceInterface *)(b.outputs.at(i));
 360     toWrite << iface->getName();
 361     toWrite << iface->getWidth();
 362     toWrite << iface->getPurpose();
 363     toWrite << iface->getDirection();
 364     toWrite << iface->getMultiplicity();
 365   }
 366   toWrite << b.bidirs.size();
 367   for(int i=0; i<b.bidirs.size(); i++){
 368     ReferenceInterface *iface = (ReferenceInterface *)(b.bidirs.at(i));
 369     toWrite << iface->getName();
 370     toWrite << iface->getWidth();
 371     toWrite << iface->getPurpose();
 372     toWrite << iface->getDirection();
 373     toWrite << iface->getMultiplicity();
 374   }
 375
 376   out << blockData;
 377
 378   return out;
 379 }
 380
 381 QDataStream& operator>>(QDataStream &in, ReferenceBlock &b) {
 382
 383   quint32 blockSize;
 384   ReferenceInterface* iface;
 385   BlockParameter* p;
 386   int val;
 387   QString txt="";
 388
 389   in.setVersion(QDataStream::Qt_5_0);
 390
 391   in >> blockSize;
 392
 393   in >> b.name;
 394   in >> b.xmlFile;
 395   in >> b.descriptionBrief;
 396   in >> b.descriptionDetail;
 397   in >> b.categories;
 398   in >> b.hashMd5;
 399   b.params.clear();
 400   int nb;
 401   in >> nb;
 402   cout << qPrintable(b.name) << " has " << nb << " parameters" << endl;
 403   for(int i=0;i<nb;i++) {
 404     QString contextStr = "";
 405     QString nameStr= "";
 406     QString typeStr = "";
 407     QString valueStr = "";
 408     in >> contextStr;
 409     in >> nameStr;
 410     in >> typeStr;
 411     in >> valueStr;
 412
 413     if (contextStr == "user") {
 414       p = new BlockParameterUser(&b,nameStr,valueStr);
 415     }
 416     else if (contextStr == "generic") {
 417       p = new BlockParameterGeneric(&b,nameStr,typeStr,valueStr);
 418     }
 419     else if (contextStr == "port") {
 420       QString ifaceStr = "";
 421       in >> ifaceStr;
 422       p = new BlockParameterPort(&b,nameStr,valueStr,ifaceStr);
 423     }
 424     else if (contextStr == "wb") {
 425       QString widthStr = "";
 426       int wbAccess;
 427       QString wbValue;
 428       int wbDuration;
 429       in >> widthStr;
 430       in >> wbAccess;
 431       in >> wbValue;
 432       in >> wbDuration;
 433       p = new BlockParameterWishbone(&b,nameStr,typeStr,widthStr,valueStr,wbAccess,wbValue,wbDuration);
 434     }
 435     b.params.append(p);
 436   }
 437
 438   b.inputs.clear();
 439   in >> nb;
 440   for(int i=0;i<nb;i++) {
 441     iface = new ReferenceInterface(&b);
 442     in >> txt;
 443     iface->setName(txt);
 444     in >> txt;
 445     iface->setWidth(txt);
 446     in >> val;
 447     iface->setPurpose(val);
 448     in >> val;
 449     iface->setDirection(val);
 450     in >> val;
 451     iface->setMultiplicity(val);
 452     b.inputs.append(iface);
 453   }
 454
 455   b.outputs.clear();
 456   in >> nb;
 457   for(int i=0;i<nb;i++) {
 458     iface = new ReferenceInterface(&b);
 459     in >> txt;
 460     iface->setName(txt);
 461     in >> txt;
 462     iface->setWidth(txt);
 463     in >> val;
 464     iface->setPurpose(val);
 465     in >> val;
 466     iface->setDirection(val);
 467     in >> val;
 468     iface->setMultiplicity(val);
 469     b.outputs.append(iface);
 470   }
 471
 472   b.bidirs.clear();
 473   in >> nb;
 474   for(int i=0;i<nb;i++) {
 475     iface = new ReferenceInterface(&b);
 476     in >> txt;
 477     iface->setName(txt);
 478     in >> txt;
 479     iface->setWidth(txt);
 480     in >> val;
 481     iface->setPurpose(val);
 482     in >> val;
 483     iface->setDirection(val);
 484     in >> val;
 485     iface->setMultiplicity(val);
 486     b.bidirs.append(iface);
 487   }
 488
 489   return in;
 490 }