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   // getting each input
 228   QDomNodeList listNodeInputs = eltInputs.elementsByTagName("input");
 229   for(int i=0;i<listNodeInputs.size();i++) {
 230     QDomNode node = listNodeInputs.at(i);
 231     QDomElement eltInput = node.toElement();
 232     nameStr = eltInput.attribute("name","none");
 233     typeStr = eltInput.attribute("type","none");
 234     widthStr = eltInput.attribute("width","none");
 235     purposeStr = eltInput.attribute("purpose","none");
 236     cout << "block : " << this->getName().toStdString() << endl;
 237     cout << "purpose for " << nameStr.toStdString() << " : " << purposeStr.toStdString() << endl;
 238     purpose = ReferenceInterface::translatePurpose(purposeStr);
 239     cout << "translated purpose : " << purpose << endl;
 240     multStr = eltInput.attribute("multiplicity","none");
 241     mult = ReferenceInterface::translateMultiplicity(multStr);
 242
 243     inter = new ReferenceInterface(this,nameStr,typeStr,widthStr,AbstractInterface::Input, purpose, mult);
 244     inputs.append(inter);
 245   }
 246   // getting each control
 247   QDomNodeList listNodeInCtl = eltInputs.elementsByTagName("control");
 248   for(int i=0;i<listNodeInCtl.size();i++) {
 249     QDomNode node = listNodeInCtl.at(i);
 250     QDomElement eltInput = node.toElement();
 251     nameStr = eltInput.attribute("iface","none");
 252     AbstractInterface* dataIface = getIfaceFromName(nameStr);
 253     if (dataIface == NULL) throw (Exception(BLOCKFILE_CORRUPTED));
 254     nameStr = dataIface->getName()+"_ctl";
 255     inter = new ReferenceInterface(this,nameStr,"boolean","1",AbstractInterface::Input, AbstractInterface::Control, 1);
 256     if (!inter->setAssociatedIface(dataIface)) {
 257       throw (Exception(BLOCKFILE_CORRUPTED));
 258     }
 259     cout << "created a control input named " << qPrintable(inter->getName()) << endl;
 260     inputs.append(inter);
 261   }
 262   QDomElement eltOutputs = eltInputs.nextSiblingElement("outputs");
 263   QDomNodeList listNodeOutputs = eltOutputs.elementsByTagName("output");
 264   for(int i=0;i<listNodeOutputs.size();i++) {
 265     QDomNode node = listNodeOutputs.at(i);
 266     QDomElement eltOutput = node.toElement();
 267     nameStr = eltOutput.attribute("name","none");
 268     typeStr = eltOutput.attribute("type","none");
 269     widthStr = eltOutput.attribute("width","none");
 270     purposeStr = eltOutput.attribute("purpose","none");
 271     purpose = ReferenceInterface::translatePurpose(purposeStr);
 272     multStr = eltOutput.attribute("multiplicity","none");
 273     mult = ReferenceInterface::translateMultiplicity(multStr);
 274
 275     inter = new ReferenceInterface(this,nameStr,typeStr,widthStr,AbstractInterface::Output, purpose, mult);
 276     outputs.append(inter);
 277   }
 278   // getting each control
 279   QDomNodeList listNodeOutCtl = eltOutputs.elementsByTagName("control");
 280   for(int i=0;i<listNodeOutCtl.size();i++) {
 281     QDomNode node = listNodeOutCtl.at(i);
 282     QDomElement eltOutput = node.toElement();
 283     nameStr = eltOutput.attribute("iface","none");
 284     AbstractInterface* dataIface = getIfaceFromName(nameStr);
 285     if (dataIface == NULL) throw (Exception(BLOCKFILE_CORRUPTED));
 286     nameStr = dataIface->getName()+"_ctl";
 287     inter = new ReferenceInterface(this,nameStr,"boolean","1",AbstractInterface::Output, AbstractInterface::Control, 1);
 288     if (!inter->setAssociatedIface(dataIface)) {
 289       throw (Exception(BLOCKFILE_CORRUPTED));
 290     }
 291     cout << "created a control output named " << qPrintable(inter->getName()) << endl;
 292     outputs.append(inter);
 293   }
 294
 295   QDomElement eltBidirs = eltInputs.nextSiblingElement("bidirs");
 296   QDomNodeList listNodeBidirs = eltBidirs.elementsByTagName("bidir");
 297   for(int i=0;i<listNodeBidirs.size();i++) {
 298     QDomNode node = listNodeBidirs.at(i);
 299     QDomElement eltBidir = node.toElement();
 300     nameStr = eltBidir.attribute("name","none");
 301     typeStr = eltBidir.attribute("type","none");
 302     widthStr = eltBidir.attribute("width","none");
 303     purposeStr = eltBidir.attribute("purpose","none");
 304     purpose = ReferenceInterface::translatePurpose(purposeStr);
 305     multStr = eltBidir.attribute("multiplicity","none");
 306     mult = ReferenceInterface::translateMultiplicity(multStr);
 307
 308     inter = new ReferenceInterface(this,nameStr,typeStr,widthStr,AbstractInterface::InOut, purpose, mult);
 309     bidirs.append(inter);
 310   }
 311 }
 312
 313 void ReferenceBlock::createInterfaceForParameters() throw(Exception){
 314   ReferenceInterface* iface = NULL;
 315   foreach(BlockParameter* param, params) {
 316
 317     if (param->isWishboneParameter()) {
 318
 319       BlockParameterWishbone* p = (BlockParameterWishbone*)param;
 320       cout << "creating interface for parameter wb " << qPrintable(p->getName()) << endl;
 321
 322       if (p->getWBAccess() == BlockParameter::Read) {
 323         iface = new ReferenceInterface(this,p->getName(),p->getTypeString(),p->getWidth(), AbstractInterface::Output, AbstractInterface::Wishbone,1);
 324         outputs.append(iface);
 325       }
 326       else if (p->getWBAccess() == BlockParameter::Write) {
 327         iface = new ReferenceInterface(this,p->getName(),p->getTypeString(),p->getWidth(), AbstractInterface::Input, AbstractInterface::Wishbone,1);
 328         inputs.append(iface);
 329       }
 330       else {
 331         throw (Exception(BLOCKFILE_CORRUPTED));
 332       }
 333     }
 334   }
 335 }
 336
 337 void ReferenceBlock::parametersValidation(QList<AbstractBlock *> *checkedBlocks, QList<AbstractBlock *> *blocksToConfigure) {
 338     return;
 339 }
 340
 341 /* operator<<() :
 342    only used to save all ReferenceBlock in a library in binary format, so that reference blocks
 343    are read very fast at application startup.
 344
 345  */
 346 QDataStream& operator<<(QDataStream &out, const ReferenceBlock &b) {
 347
 348   out.setVersion(QDataStream::Qt_5_0);
 349
 350   QByteArray blockData;
 351   QDataStream toWrite(&blockData, QIODevice::WriteOnly);
 352
 353   toWrite << b.name;
 354   toWrite << b.xmlFile;
 355   toWrite << b.descriptionBrief;
 356   toWrite << b.descriptionDetail;
 357   toWrite << b.categories;
 358   toWrite << b.hashMd5;
 359   toWrite << b.params.size();
 360   BlockParameter* p;
 361   for(int i=0;i<b.params.size();i++) {
 362     p = b.params.at(i);
 363     toWrite << p->getContext();
 364     toWrite << p->getName();
 365     toWrite << p->getTypeString();
 366     toWrite << p->getValue().toString();
 367     if (p->isPortParameter()) {
 368       toWrite << ((BlockParameterPort*)p)->getIfaceName();
 369     }
 370     else if (p->isWishboneParameter()) {
 371       BlockParameterWishbone* pwb = (BlockParameterWishbone*)p;
 372       toWrite << pwb->getWidth();
 373       toWrite << pwb->getWBAccess();
 374       toWrite << pwb->getWBValue();
 375       toWrite << pwb->getWBDuration();
 376     }
 377
 378   }
 379
 380   toWrite << b.inputs.size();
 381   // firstly write control ifaces
 382   for(int i=0; i<b.inputs.size(); i++){
 383     ReferenceInterface *iface = (ReferenceInterface *)(b.inputs.at(i));
 384     if (iface->getPurpose() == AbstractInterface::Control) {
 385       toWrite << iface->getName();
 386       toWrite << iface->getWidth();
 387       toWrite << iface->getPurpose();
 388       toWrite << iface->getDirection();
 389       toWrite << iface->getMultiplicity();
 390     }
 391   }
 392   // secondly, write other ifaces
 393   for(int i=0; i<b.inputs.size(); i++){
 394     ReferenceInterface *iface = (ReferenceInterface *)(b.inputs.at(i));
 395     if (iface->getPurpose() != AbstractInterface::Control) {
 396       toWrite << iface->getName();
 397       toWrite << iface->getWidth();
 398       toWrite << iface->getPurpose();
 399       toWrite << iface->getDirection();
 400       toWrite << iface->getMultiplicity();
 401     }
 402   }
 403   toWrite << b.outputs.size();
 404   // firstly write control ifaces
 405   for(int i=0; i<b.outputs.size(); i++){
 406     ReferenceInterface *iface = (ReferenceInterface *)(b.outputs.at(i));
 407     if (iface->getPurpose() == AbstractInterface::Control) {
 408       toWrite << iface->getName();
 409       toWrite << iface->getWidth();
 410       toWrite << iface->getPurpose();
 411       toWrite << iface->getDirection();
 412       toWrite << iface->getMultiplicity();
 413     }
 414   }
 415   // secondly, write other ifaces
 416   for(int i=0; i<b.outputs.size(); i++){
 417     ReferenceInterface *iface = (ReferenceInterface *)(b.outputs.at(i));
 418     if (iface->getPurpose() != AbstractInterface::Control) {
 419       toWrite << iface->getName();
 420       toWrite << iface->getWidth();
 421       toWrite << iface->getPurpose();
 422       toWrite << iface->getDirection();
 423       toWrite << iface->getMultiplicity();
 424     }
 425   }
 426   toWrite << b.bidirs.size();
 427   for(int i=0; i<b.bidirs.size(); i++){
 428     ReferenceInterface *iface = (ReferenceInterface *)(b.bidirs.at(i));
 429     toWrite << iface->getName();
 430     toWrite << iface->getWidth();
 431     toWrite << iface->getPurpose();
 432     toWrite << iface->getDirection();
 433     toWrite << iface->getMultiplicity();
 434   }
 435
 436   out << blockData;
 437
 438   return out;
 439 }
 440
 441 QDataStream& operator>>(QDataStream &in, ReferenceBlock &b) {
 442
 443   quint32 blockSize;
 444   ReferenceInterface* iface;
 445   BlockParameter* p;
 446   int val;
 447   QString txt="";
 448
 449   in.setVersion(QDataStream::Qt_5_0);
 450
 451   in >> blockSize;
 452
 453   in >> b.name;
 454   in >> b.xmlFile;
 455   in >> b.descriptionBrief;
 456   in >> b.descriptionDetail;
 457   in >> b.categories;
 458   in >> b.hashMd5;
 459   b.params.clear();
 460   int nb;
 461   in >> nb;
 462   cout << qPrintable(b.name) << " has " << nb << " parameters" << endl;
 463   for(int i=0;i<nb;i++) {
 464     QString contextStr = "";
 465     QString nameStr= "";
 466     QString typeStr = "";
 467     QString valueStr = "";
 468     in >> contextStr;
 469     in >> nameStr;
 470     in >> typeStr;
 471     in >> valueStr;
 472
 473     if (contextStr == "user") {
 474       p = new BlockParameterUser(&b,nameStr,valueStr);
 475     }
 476     else if (contextStr == "generic") {
 477       p = new BlockParameterGeneric(&b,nameStr,typeStr,valueStr);
 478     }
 479     else if (contextStr == "port") {
 480       QString ifaceStr = "";
 481       in >> ifaceStr;
 482       p = new BlockParameterPort(&b,nameStr,valueStr,ifaceStr);
 483     }
 484     else if (contextStr == "wb") {
 485       QString widthStr = "";
 486       int wbAccess;
 487       QString wbValue;
 488       int wbDuration;
 489       in >> widthStr;
 490       in >> wbAccess;
 491       in >> wbValue;
 492       in >> wbDuration;
 493       p = new BlockParameterWishbone(&b,nameStr,typeStr,widthStr,valueStr,wbAccess,wbValue,wbDuration);
 494     }
 495     b.params.append(p);
 496   }
 497
 498   b.inputs.clear();
 499   in >> nb;
 500   for(int i=0;i<nb;i++) {
 501     iface = new ReferenceInterface(&b);
 502     in >> txt;
 503     iface->setName(txt);
 504     in >> txt;
 505     iface->setWidth(txt);
 506     in >> val;
 507     iface->setPurpose(val);
 508     in >> val;
 509     iface->setDirection(val);
 510     in >> val;
 511     iface->setMultiplicity(val);
 512     b.inputs.append(iface);
 513     if (iface->getPurpose() == AbstractInterface::Data) {
 514       QString ctlRefName = iface->getName()+"_ctl";
 515       ReferenceInterface* ctlRefIface = AI_TO_REF(b.getIfaceFromName(ctlRefName));
 516       if (ctlRefIface != NULL) {
 517         if (! ctlRefIface->setAssociatedIface(iface)) {
 518           cerr << "Abnormal case while reading a reference block in library" << endl;
 519         }
 520       }
 521     }
 522   }
 523
 524   b.outputs.clear();
 525   in >> nb;
 526   for(int i=0;i<nb;i++) {
 527     iface = new ReferenceInterface(&b);
 528     in >> txt;
 529     iface->setName(txt);
 530     in >> txt;
 531     iface->setWidth(txt);
 532     in >> val;
 533     iface->setPurpose(val);
 534     in >> val;
 535     iface->setDirection(val);
 536     in >> val;
 537     iface->setMultiplicity(val);
 538     b.outputs.append(iface);
 539     if (iface->getPurpose() == AbstractInterface::Data) {
 540       QString ctlRefName = iface->getName()+"_ctl";
 541       ReferenceInterface* ctlRefIface = AI_TO_REF(b.getIfaceFromName(ctlRefName));
 542       if (ctlRefIface != NULL) {
 543         if (! ctlRefIface->setAssociatedIface(iface)) {
 544           cerr << "Abnormal case while reading a reference block in library" << endl;
 545         }
 546       }
 547     }
 548   }
 549
 550   b.bidirs.clear();
 551   in >> nb;
 552   for(int i=0;i<nb;i++) {
 553     iface = new ReferenceInterface(&b);
 554     in >> txt;
 555     iface->setName(txt);
 556     in >> txt;
 557     iface->setWidth(txt);
 558     in >> val;
 559     iface->setPurpose(val);
 560     in >> val;
 561     iface->setDirection(val);
 562     in >> val;
 563     iface->setMultiplicity(val);
 564     b.bidirs.append(iface);
 565   }
 566
 567   return in;
 568 }