1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
|
/***************************************************************************
* Copyright (C) 2005-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 <qfile.h>
#include <qregexp.h>
#include "xml_to_data/device_xml_to_data.h"
#include "common/common/misc.h"
#include "devices/pic/base/pic_config.h"
#include "devices/pic/base/pic_register.h"
namespace Pic
{
class XmlToData : public Device::XmlToData<Data>
{
private:
virtual QString namespaceName() const { return "Pic"; }
bool getVoltages(ProgVoltageType type, QDomElement element)
{
QDomElement voltages = findUniqueElement(element, "voltages", "name", type.key());
if ( voltages.isNull() ) return false;
bool ok1, ok2, ok3;
data()->_voltages[type].min = voltages.attribute("min").toDouble(&ok1);
data()->_voltages[type].max = voltages.attribute("max").toDouble(&ok2);
data()->_voltages[type].nominal = voltages.attribute("nominal").toDouble(&ok3);
if ( !ok1 || !ok2 || !ok3 ) qFatal(QString("Cannot extract voltage value for \"%1\"").arg(type.key()));
if ( data()->_voltages[type].min>data()->_voltages[type].max
|| data()->_voltages[type].nominal<data()->_voltages[type].min
|| data()->_voltages[type].nominal>data()->_voltages[type].max )
qFatal("Inconsistent voltages order");
return true;
}
bool getMemoryRange(MemoryRangeType type, QDomElement element)
{
QDomElement range = findUniqueElement(element, "memory", "name", type.key());
if ( range.isNull() ) return false;
data()->_ranges[type].properties = Present;
bool ok;
uint nbCharsAddress = data()->nbCharsAddress();
data()->_ranges[type].start = fromHexLabel(range.attribute("start"), nbCharsAddress, &ok);
if ( !ok ) qFatal("Cannot extract start address");
data()->_ranges[type].end = fromHexLabel(range.attribute("end"), nbCharsAddress, &ok);
if ( !ok ) qFatal("Cannot extract end address");
if ( data()->_ranges[type].end<data()->_ranges[type].start ) qFatal("Memory range end is before its start");
uint nbCharsWord = data()->nbCharsWord(type);
if ( data()->nbBitsWord(type)==0 ) qFatal(QString("Architecture doesn't contain memory range %1").arg(type.key()));
if ( type==MemoryRangeType::UserId ) {
data()->_userIdRecommendedMask = fromHexLabel(range.attribute("rmask"), nbCharsWord, &ok);
if ( !ok ) qFatal("Cannot extract rmask value for user id");
if ( !data()->_userIdRecommendedMask.isInside(data()->mask(type)) ) qFatal(QString("rmask is not inside mask %1 (%2)").arg(toHexLabel(data()->_userIdRecommendedMask, 8)).arg(toHexLabel(data()->mask(type), 8)));
}
if ( range.attribute("hexfile_offset")!="?" ) {
data()->_ranges[type].properties |= Programmable;
if ( !range.attribute("hexfile_offset").isEmpty() ) {
data()->_ranges[type].hexFileOffset = fromHexLabel(range.attribute("hexfile_offset"), nbCharsAddress, &ok);
if ( !ok ) qFatal("Cannot extract hexfile_offset");
}
}
if ( type==MemoryRangeType::Cal && !data()->is18Family() ) {
data()->_calibration.opcodeMask = fromHexLabel(range.attribute("cal_opmask"), nbCharsWord, &ok);
if ( !ok ) qFatal("Cannot extract calibration opcode mask");
data()->_calibration.opcode = fromHexLabel(range.attribute("cal_opcode"), nbCharsWord, &ok);
if ( !ok ) qFatal("Cannot extract calibration opcode");
if ( !data()->_calibration.opcode.isInside(data()->_calibration.opcodeMask) ) qFatal("Calibration opcode should be inside opcode mask");
if ( !data()->_calibration.opcodeMask.isInside(data()->mask(type)) ) qFatal("Calibration mask should be inside opcode mask");
}
QString wwa = range.attribute("word_write_align");
QString wea = range.attribute("word_erase_align");
if ( type==MemoryRangeType::Code ) {
if ( data()->_architecture==Architecture::P18F || data()->_architecture==Architecture::P18J ) {
data()->_nbWordsCodeWrite = wwa.toUInt(&ok);
if ( !ok || data()->_nbWordsCodeWrite==0 || (data()->_nbWordsCodeWrite%4)!=0 ) qFatal("Missing or malformed word write align");
data()->_nbWordsCodeRowErase = wea.toUInt(&ok);
if ( !ok || (data()->_nbWordsCodeRowErase%4)!=0 ) qFatal("Missing or malformed word erase align");
} else {
if ( !wwa.isEmpty() || !wea.isEmpty() ) qFatal("word align should not be defined for this device family/subfamily");
data()->_nbWordsCodeWrite = 0; // #### TODO
data()->_nbWordsCodeRowErase = 0; // #### TODO
}
} else if ( !wwa.isEmpty() || !wea.isEmpty() ) qFatal("word align should not be defined for this memory range");
return true;
}
bool hasValue(const Pic::Config::Mask &mask, BitValue value)
{
for (uint i=0; i<uint(mask.values.count()); i++)
if ( mask.values[i].value==value ) return true;
return false;
}
void processName(const Pic::Config::Mask &cmask, BitValue pmask, Pic::Config::Value &cvalue)
{
QStringList &cnames = cvalue.configNames[Pic::ConfigNameType::Default];
if ( cvalue.name=="invalid" ) {
cvalue.name = QString::null;
if ( !cnames.isEmpty() ) qFatal(QString("No cname should be defined for invalid value in mask %1").arg(cmask.name));
return;
}
if ( cvalue.name.isEmpty() ) qFatal(QString("Empty value name in mask %1").arg(cmask.name));
if ( cmask.value.isInside(pmask) ) { // protected bits
if ( !cnames.isEmpty() ) qFatal(QString("Config name should be null for protected config mask \"%1\"").arg(cmask.name));
} else {
if ( cnames.isEmpty() && cmask.name!="BSSEC" && cmask.name!="BSSIZ" && cmask.name!="SSSEC" && cmask.name!="SSSIZ" ) {
// ### FIXME: 18J 24H 30F1010/202X
if ( data()->architecture()!=Pic::Architecture::P18J && data()->architecture()!=Pic::Architecture::P24H
&& data()->architecture()!=Pic::Architecture::P24F && data()->architecture()!=Pic::Architecture::P33F
&& data()->name()!="30F1010" && data()->name()!="30F2020" && data()->name()!="30F2023" )
qFatal(QString("cname not defined for \"%1\" (%2)").arg(cvalue.name).arg(cmask.name));
}
if ( cnames.count()==1 && cnames[0]=="_" ) cnames.clear();
for (uint i=0; i<uint(cnames.count()); i++) {
if ( cnames[i].startsWith("0x") ) {
if ( cnames.count()!=1 ) qFatal("Hex cname cannot be combined");
bool ok;
BitValue v = fromHexLabel(cnames[i], &ok);
uint nbChars = data()->nbCharsWord(MemoryRangeType::Config);
BitValue mask = cmask.value.complementInMask(maxValue(NumberBase::Hex, nbChars));
if ( ok && v==(mask | cvalue.value) ) continue;
} else if ( XOR(cnames[i].startsWith("_"), data()->architecture()==Pic::Architecture::P30F) ) continue;
qFatal(QString("Invalid config name for \"%1\"/\"%2\"").arg(cmask.name).arg(cvalue.name));
}
QStringList &ecnames = cvalue.configNames[Pic::ConfigNameType::Extra];
for (uint i=0; i<uint(ecnames.count()); i++)
if ( ecnames[i][0]!='_' ) qFatal(QString("Invalid extra config name for %1").arg(cvalue.name));
}
}
Pic::Config::Mask toConfigMask(QDomElement mask, BitValue pmask)
{
uint nbChars = data()->nbCharsWord(MemoryRangeType::Config);
bool ok;
QString defName;
QMap<Pic::ConfigNameType, QStringList> defConfigNames;
Config::Mask cmask;
cmask.name = mask.attribute("name");
if ( !Config::hasMaskName(cmask.name) ) qFatal(QString("Unknown mask name %1").arg(cmask.name));
cmask.value = fromHexLabel(mask.attribute("value"), nbChars, &ok);
if ( !ok || cmask.value==0 || cmask.value>data()->mask(MemoryRangeType::Config) )
qFatal(QString("Malformed mask value in mask %1").arg(mask.attribute("name")));
//QStringList names;
QDomNode child = mask.firstChild();
while ( !child.isNull() ) {
QDomElement value = child.toElement();
child = child.nextSibling();
if ( value.isNull() ) continue;
if ( value.nodeName()!="value" ) qFatal(QString("Non value child in mask %1").arg(cmask.name));
if ( value.attribute("value")=="default" ) {
if ( !defName.isEmpty() ) qFatal(QString("Default value already defined for mask %1").arg(cmask.name));
defName = value.attribute("name");
//if ( names.contains(defName) ) qFatal(QString("Value name duplicated in mask %1").arg(cmask.name));
//names.append(defName);
FOR_EACH(Pic::ConfigNameType, type) defConfigNames[type] = QStringList::split(' ', value.attribute(type.data().key));
continue;
}
Config::Value cvalue;
cvalue.value = fromHexLabel(value.attribute("value"), nbChars, &ok);
if ( !ok || !cvalue.value.isInside(cmask.value) ) qFatal(QString("Malformed value in mask %1").arg(cmask.name));
cvalue.name = value.attribute("name");
//if ( names.contains(cvalue.name) ) qFatal(QString("Value name duplicated in mask %1").arg(cmask.name));
//names.append(cvalue.name);
FOR_EACH(Pic::ConfigNameType, type) cvalue.configNames[type] = QStringList::split(' ', value.attribute(type.data().key));
processName(cmask, pmask, cvalue);
cmask.values.append(cvalue);
}
// add default values
if ( !defName.isEmpty() ) {
uint nb = 0;
BitValue::const_iterator it;
for (it=cmask.value.begin(); it!=cmask.value.end(); ++it) {
if ( hasValue(cmask, *it) ) continue; // already set
nb++;
Config::Value cvalue;
cvalue.value = *it;
cvalue.name = defName;
cvalue.configNames = defConfigNames;
processName(cmask, pmask, cvalue);
cmask.values.append(cvalue);
}
if ( nb<=1 ) qFatal(QString("Default value used less than twice in mask %1").arg(cmask.name));
}
qHeapSort(cmask.values);
return cmask;
}
Pic::Config::Word toConfigWord(QDomElement config)
{
uint nbChars = data()->nbCharsWord(MemoryRangeType::Config);
Config::Word cword;
cword.name = config.attribute("name");
if ( cword.name.isNull() ) qFatal("Config word name not specified.");
bool ok;
cword.wmask = fromHexLabel(config.attribute("wmask"), nbChars, &ok);
BitValue gmask = data()->mask(MemoryRangeType::Config);
if ( !ok || cword.wmask>gmask ) qFatal(QString("Missing or malformed config wmask \"%1\"").arg(config.attribute("wmask")));
cword.bvalue = fromHexLabel(config.attribute("bvalue"), nbChars, &ok);
if ( !ok ) qFatal(QString("Missing or malformed config bvalue \"%1\"").arg(config.attribute("bvalue")));
if ( config.attribute("pmask").isEmpty() ) cword.pmask = 0;
else {
bool ok;
cword.pmask = fromHexLabel(config.attribute("pmask"), nbChars, &ok);
if ( !ok || cword.pmask>gmask ) qFatal("Missing or malformed config pmask");
}
cword.ignoredCNames = QStringList::split(' ', config.attribute("icnames"));
for (uint i=0; i<uint(cword.ignoredCNames.count()); i++)
if ( cword.ignoredCNames[i][0]!='_' ) qFatal(QString("Invalid ignored config name for %1").arg(cword.name));
QDomNode child = config.firstChild();
while ( !child.isNull() ) {
QDomElement mask = child.toElement();
child = child.nextSibling();
if ( mask.isNull() ) continue;
if ( mask.nodeName()!="mask" ) qFatal(QString("Non mask child in config %1").arg(cword.name));
if ( mask.attribute("name").isEmpty() ) qFatal(QString("Empty mask name in config %1").arg(cword.name));
Config::Mask cmask = toConfigMask(mask, cword.pmask);
if ( !cmask.value.isInside(gmask) ) qFatal(QString("Mask value not inside mask in config %1").arg(cword.name));
for (uint i=0; i<uint(cword.masks.count()); i++) {
if ( cword.masks[i].name==cmask.name ) qFatal(QString("Duplicated mask name %1 in config %2").arg(cmask.name).arg(cword.name));
if ( cmask.value.isOverlapping(cword.masks[i].value) ) qFatal(QString("Overlapping masks in config %1").arg(cword.name));
}
cword.masks.append(cmask);
}
qHeapSort(cword.masks);
BitValue mask = (cword.usedMask() | cword.bvalue).clearMaskBits(cword.pmask);
if ( config.attribute("cmask").isEmpty() ) {
if ( data()->_architecture==Pic::Architecture::P30F ) cword.cmask = cword.wmask;
else cword.cmask = mask;
} else {
bool ok;
cword.cmask = fromHexLabel(config.attribute("cmask"), nbChars, &ok);
if ( !ok || cword.cmask>gmask ) qFatal("Missing or malformed config cmask");
//if ( data()->_architecture==Pic::Architecture::P30X &&cword.cmask==cword.wmask ) qFatal(QString("Redundant cmask in %1").arg(cword.name));
if ( cword.cmask==mask ) qFatal(QString("Redundant cmask in %1").arg(cword.name));
}
if ( !cword.pmask.isInside(cword.usedMask()) ) qFatal("pmask should be inside or'ed mask values.");
return cword;
}
QValueVector<Pic::Config::Word> getConfigWords(QDomElement element)
{
uint nbWords = data()->nbWords(MemoryRangeType::Config);
QValueVector<Config::Word> configWords(nbWords);
QDomNode child = element.firstChild();
while ( !child.isNull() ) {
QDomElement config = child.toElement();
child = child.nextSibling();
if ( config.isNull() || config.nodeName()!="config" ) continue;
bool ok;
uint offset = fromHexLabel(config.attribute("offset"), 1, &ok);
if ( !ok ) qFatal("Missing or malformed config offset");
if ( (offset % data()->addressIncrement(MemoryRangeType::Config))!=0 ) qFatal("Config offset not aligned");
offset /= data()->addressIncrement(MemoryRangeType::Config);
if ( offset>=nbWords ) qFatal(QString("Offset too big %1/%2").arg(offset).arg(nbWords));
if ( !configWords[offset].name.isNull() ) qFatal(QString("Config offset %1 is duplicated").arg(offset));
for (uint i=0; i<nbWords; i++) {
if ( !configWords[i].name.isNull() && configWords[i].name==config.attribute("name") )
qFatal(QString("Duplicated config name %1").arg(configWords[i].name));
}
configWords[offset] = toConfigWord(config);
}
return configWords;
}
QString getChecksumData(QDomElement checksum)
{
Checksum::Data cdata;
cdata.blankChecksum = 0x0;
cdata.checkChecksum = 0x0;
const Protection &protection = data()->_config->protection();
QString valueName;
if ( protection.family()==Protection::BlockProtection ) {
valueName = checksum.attribute("protected_blocks");
bool ok;
uint nb = valueName.toUInt(&ok);
uint max = (protection.hasBootBlock() ? 1 : 0) + protection.nbBlocks();
if ( !ok || nb>max ) qFatal("Invalid number of protected blocks for checksum");
if ( nb>0 ) cdata.protectedMaskNames += "CPB";
for (uint i=1; i<nb; i++) cdata.protectedMaskNames += "CP_" + QString::number(i-1);
cdata.bbsize = checksum.attribute("bbsize");
const Config::Mask *mask = data()->_config->findMask(protection.bootSizeMaskName());
if ( mask==0 ) {
if ( !cdata.bbsize.isEmpty() ) qFatal("Device does not have a variable boot size (no \"bbsize\" allowed in checksum)");
} else if ( cdata.bbsize.isEmpty() ) {
if ( nb==1 ) qFatal("\"bbsize\" should be define in checksum for \"protected_blocks\"==1");
} else {
const Config::Value *value = data()->_config->findValue(protection.bootSizeMaskName(), cdata.bbsize);
if ( value==0 ) qFatal("Invalid \"bbsize\" in checksum");
valueName += "_" + cdata.bbsize;
}
} else {
valueName = checksum.attribute("protected");
if ( protection.family()==Protection::NoProtection && !valueName.isEmpty() )
qFatal("Checksum protected attribute for device with no code protection");
}
if ( data()->_checksums.contains(valueName) ) qFatal("Duplicate checksum protected range");
QString s = checksum.attribute("constant");
if ( s.isEmpty() ) cdata.constant = 0x0000;
else {
bool ok;
cdata.constant = fromHexLabel(s, 4, &ok);
if ( !ok ) qFatal("Malformed checksum constant");
}
s = checksum.attribute("type");
if ( s.isEmpty() ) cdata.algorithm = Checksum::Algorithm::Normal;
else {
cdata.algorithm = Checksum::Algorithm::fromKey(s);
if ( cdata.algorithm==Checksum::Algorithm::Nb_Types ) qFatal("Unrecognized checksum algorithm");
}
s = checksum.attribute("mprotected");
if ( !s.isEmpty() ) {
QStringList list = QStringList::split(" ", s);
for (uint i=0; i<uint(list.count()); i++) {
const Config::Mask *mask = data()->config().findMask(list[i]);
if ( mask==0 ) qFatal(QString("Not valid mask name for \"protected\" tag in checksum: %1").arg(list[i]));
if ( mask->values.count()==2 ) continue;
for (uint k=0; k<uint(mask->values.count()); k++) {
QString valueName = mask->values[k].name;
if ( valueName.isEmpty() ) continue;
if ( !protection.isNoneProtectedValueName(valueName) && !protection.isAllProtectedValueName(valueName) )
qFatal(QString("Not switch protection from mask name for \"protected\" tag in checksum: %1").arg(list[i]));
}
}
cdata.protectedMaskNames = list;
}
s = checksum.attribute("bchecksum");
if ( s.isEmpty() ) qFatal("No blank checksum");
else {
bool ok;
cdata.blankChecksum = fromHexLabel(s, 4, &ok);
if ( !ok ) qFatal("Malformed blank checksum");
}
s = checksum.attribute("cchecksum");
if ( s.isEmpty() ) qFatal("No check checksum");
else {
bool ok;
cdata.checkChecksum = fromHexLabel(s, 4, &ok);
if ( !ok ) qFatal("Malformed check checksum");
}
data()->_checksums[valueName] = cdata;
return valueName;
}
virtual void processDevice(QDomElement device)
{
Device::XmlToDataBase::processDevice(device);
QString arch = device.attribute("architecture");
data()->_architecture = Architecture::fromKey(arch);
if ( data()->_architecture==Architecture::Nb_Types ) qFatal(QString("Unrecognized architecture \"%1\"").arg(arch));
if ( (data()->_architecture==Architecture::P18F && data()->_name.contains("C"))
|| (data()->_architecture==Architecture::P18F && data()->_name.contains("J")) ) qFatal("Not matching family");
bool ok;
QString pc = device.attribute("pc");
data()->_nbBitsPC = data()->_architecture.data().nbBitsPC;
if ( data()->_nbBitsPC==0 ) {
data()->_nbBitsPC = pc.toUInt(&ok);
if ( !ok || data()->_nbBitsPC==0 ) qFatal("Malformed or missing PC");
} else if ( !pc.isEmpty() ) qFatal("No PC should be provided for this device architecture");
QString sw = device.attribute("self_write");
data()->_selfWrite = (data()->_memoryTechnology!=Device::MemoryTechnology::Flash ? SelfWrite::No : data()->_architecture.data().selfWrite);
if ( data()->_selfWrite==SelfWrite::Nb_Types ) {
data()->_selfWrite = SelfWrite::fromKey(sw);
if ( data()->_selfWrite==SelfWrite::Nb_Types ) qFatal("Malformed or missing self-write field");
} else if ( !sw.isEmpty() ) qFatal("Self-write is set for the whole family or non-flash device");
// device ids
FOR_EACH(Device::Special, special) {
QString key = "id" + (special==Device::Special::Normal ? QString::null : QString("_") + special.key());
QString id = device.attribute(key);
if ( id.isEmpty() ) {
if ( special==Device::Special::Normal ) data()->_ids[special] = 0x0000;
} else {
data()->_ids[special] = fromHexLabel(id, 4, &ok);
if ( !ok ) qFatal("Malformed id");
}
}
// voltages
QStringList names;
FOR_EACH(ProgVoltageType, vtype) {
names += vtype.key();
if ( !getVoltages(vtype, device) ) {
switch (vtype.type()) {
case ProgVoltageType::Vpp:
case ProgVoltageType::VddBulkErase: qFatal(QString("Voltage \"%1\" not defined").arg(vtype.key()));
case ProgVoltageType::VddWrite: data()->_voltages[ProgVoltageType::VddWrite] = data()->_voltages[ProgVoltageType::VddBulkErase]; break;
case ProgVoltageType::Nb_Types: Q_ASSERT(false); break;
}
}
}
//if ( data()->vddMin()>data()->_voltages[ProgVoltageType::VddWrite].min ) qFatal("Vdd min higher than VddWrite min");
//if ( data()->vddMax()<data()->_voltages[ProgVoltageType::VddWrite].max ) qFatal("Vdd max lower than VddWrite max");
if ( data()->_voltages[ProgVoltageType::VddWrite].min>data()->_voltages[ProgVoltageType::VddBulkErase].min ) qFatal("VddWrite min higher than VddBulkErase min");
if ( data()->_voltages[ProgVoltageType::VddWrite].max<data()->_voltages[ProgVoltageType::VddBulkErase].max ) qFatal("VddWrite max lower than VddBulkErase max");
checkTagNames(device, "voltages", names);
// memory ranges
names.clear();
FOR_EACH(MemoryRangeType, i) {
names += i.key();
if ( !getMemoryRange(i, device) ) continue;
if ( !(data()->_ranges[i].properties & Programmable) ) continue;
for(MemoryRangeType k; k<i; ++k) {
if ( !(data()->_ranges[k].properties & Present)
|| !(data()->_ranges[k].properties & Programmable) ) continue;
if ( i==MemoryRangeType::DebugVector
&& k==MemoryRangeType::ProgramExecutive ) continue;
if ( k==MemoryRangeType::DebugVector
&& i==MemoryRangeType::ProgramExecutive ) continue;
Address start1 = data()->_ranges[k].start + data()->_ranges[k].hexFileOffset;
Address end1 = data()->_ranges[k].end + data()->_ranges[k].hexFileOffset;
Address start2 = data()->_ranges[i].start + data()->_ranges[i].hexFileOffset;
Address end2 = data()->_ranges[i].end + data()->_ranges[i].hexFileOffset;
if ( end1>=start2 && start1<=end2 )
qFatal(QString("Overlapping memory ranges (%1 and %2)").arg(k.key()).arg(i.key()));
}
}
checkTagNames(device, "memory", names);
if ( XOR(data()->_ids[Device::Special::Normal]!=0x0000, (data()->_ranges[MemoryRangeType::DeviceId].properties & Present)) )
qFatal("Id present and device id memory range absent or the opposite");
// config words
QValueVector<Config::Word> cwords = getConfigWords(device);
uint nbWords = data()->nbWords(MemoryRangeType::Config);
data()->_config->_words.resize(nbWords);
FOR_EACH(Pic::ConfigNameType, type) {
QMap<QString, QString> cnames; // cname -> mask name
for (uint i=0; i<nbWords; i++) {
if ( cwords[i].name.isNull() ) qFatal(QString("Config word #%1 not defined").arg(i));
data()->_config->_words[i] = cwords[i];
const Config::Word &word = data()->_config->_words[i];
for (uint j=0; j<uint(word.masks.count()); j++) {
const Config::Mask &mask = word.masks[j];
for (uint k=0; k<uint(mask.values.count()); k++) {
const QStringList &vcnames = mask.values[k].configNames[type];
for (uint l=0; l<uint(vcnames.count()); l++) {
if ( vcnames[l].startsWith("0x") ) continue;
if ( cnames.contains(vcnames[l]) && cnames[vcnames[l]]!=mask.name )
qFatal(QString("Duplicated config name for %1/%2").arg(mask.name).arg(mask.values[k].name));
cnames[vcnames[l]] = word.masks[j].name;
}
}
}
}
}
// check validity of value names
for (uint i=0; i<nbWords; i++) {
const Config::Word &word = data()->_config->_words[i];
for (uint j=0; j<uint(word.masks.count()); j++) {
const Config::Mask &mask = word.masks[j];
for (uint k=0; k<uint(mask.values.count()); k++) {
const Config::Value &value = mask.values[k];
if ( !value.isValid() ) continue;
if ( !data()->_config->checkValueName(mask.name, value.name) )
qFatal(QString("Malformed value name \"%1\" in mask %2").arg(value.name).arg(mask.name));
}
}
}
// check if all values are explicit
for (uint i=0; i<nbWords; i++) {
const Config::Word &word = data()->_config->_words[i];
for (uint j=0; j<uint(word.masks.count()); j++) {
const Config::Mask &mask = word.masks[j];
BitValue::const_iterator it;
for (it=mask.value.begin(); it!=mask.value.end(); ++it)
if ( !hasValue(mask, *it) ) qFatal(QString("Value %1 not defined in mask %2").arg(toHexLabel(*it, data()->nbCharsWord(MemoryRangeType::Config))).arg(mask.name));
}
}
// checksums (after config bits!)
QDomElement checksums = findUniqueElement(device, "checksums", QString::null, QString::null);
if ( checksums.isNull() ) {
// qFatal("No checksum defined"); // #### FIXME
} else {
QMap<QString, bool> valueNames;
const Pic::Protection &protection = data()->_config->protection();
if ( protection.family()==Protection::BasicProtection ) {
QString maskName = protection.maskName(Protection::ProgramProtected, MemoryRangeType::Code);
const Pic::Config::Mask *mask = data()->_config->findMask(maskName);
Q_ASSERT(mask);
for (uint i=0; i<uint(mask->values.count()); i++) valueNames[mask->values[i].name] = false;
}
QDomNode child = checksums.firstChild();
while ( !child.isNull() ) {
if ( !child.isElement() ) continue;
if ( child.nodeName()!="checksum" ) qFatal("Childs of \"checksums\" should \"checksum\"");
QString valueName = getChecksumData(child.toElement());
if ( protection.family()==Protection::BasicProtection ) {
if ( !valueNames.contains(valueName) ) qFatal("Unknown protected attribute");
valueNames[valueName] = true;
}
child = child.nextSibling();
}
QMap<QString, bool>::const_iterator it;
for (it=valueNames.begin(); it!=valueNames.end(); ++it)
if ( !it.key().isEmpty() && !it.data() ) qFatal(QString("Missing checksum \"%1\"").arg(it.key()));
}
}
void processMirrored(QDomElement element)
{
QValueVector<RangeData> mirrored;
QDomNode child = element.firstChild();
while ( !child.isNull() ) {
if ( !child.isElement() ) qFatal("\"mirror\" child should be an element");
QDomElement e = child.toElement();
if ( e.nodeName()!="range" ) qFatal("\"mirror\" child should be \"range\"");
RangeData rd;
bool ok;
rd.start = fromHexLabel(e.attribute("start"), &ok);
Address end = fromHexLabel(e.attribute("end"), &ok);
rd.length = end-rd.start+1;
if ( !mirrored.isEmpty() && rd.length!=mirrored[0].length )
qFatal("Mirrored are not of the same length");
mirrored.append(rd);
child = child.nextSibling();
}
if ( !mirrored.isEmpty() ) static_cast<RegistersData *>(data()->_registersData)->mirrored.append(mirrored);
}
void processUnused(QDomElement e)
{
RangeData rd;
bool ok;
rd.start = fromHexLabel(e.attribute("start"), &ok);
if (!ok) qFatal("Malformed start for unused register");
Address end = fromHexLabel(e.attribute("end"), &ok);
rd.length = end-rd.start+1;
if (!ok) qFatal("Malformed end for unused register");
static_cast<RegistersData *>(data()->_registersData)->unused.append(rd);
}
void processSfr(QDomElement e)
{
QString name = e.attribute("name");
if ( name.isEmpty() ) qFatal("SFR cannot have empty name");
if ( data()->registersData().sfrs.contains(name) || data()->registersData().combined.contains(name) )
qFatal("SFR name is duplicated");
bool ok;
uint address = fromHexLabel(e.attribute("address"), &ok);
if ( !ok ) qFatal(QString("SFR %1 address %2 is malformed").arg(name).arg(e.attribute("address")));
uint rlength = data()->registersData().nbBanks * data()->architecture().data().registerBankLength;
if ( address>=rlength ) qFatal(QString("Address %1 outside register range").arg(toHexLabel(address, 3)));
RegisterData rdata;
rdata.address = address;
uint nb = data()->registersData().nbBits();
if ( nb>Device::MAX_NB_PORT_BITS ) qFatal(QString("Need higher MAX_NB_PORT_BITS: %1").arg(nb));
QString access = e.attribute("access");
if ( uint(access.length())!=nb ) qFatal("access is missing or malformed");
QString mclr = e.attribute("mclr");
if ( uint(mclr.length())!=nb ) qFatal("mclr is missing or malformed");
QString por = e.attribute("por");
if ( uint(por.length())!=nb ) qFatal("por is missing or malformed");
for (uint i=0; i<nb; i++) {
uint k = nb - i - 1;
bool ok;
rdata.bits[k].properties = RegisterBitProperties(fromHex(access[i].latin1(), &ok));
if ( !ok || rdata.bits[k].properties>MaxRegisterBitProperty ) qFatal(QString("Malformed access bit %1").arg(k));
rdata.bits[k].mclr = RegisterBitState(fromHex(mclr[i].latin1(), &ok));
if ( !ok || rdata.bits[k].mclr>Nb_RegisterBitStates ) qFatal(QString("Malformed mclr bit %1").arg(k));
rdata.bits[k].por = RegisterBitState(fromHex(por[i].latin1(), &ok));
if ( !ok || rdata.bits[k].por>Nb_RegisterBitStates ) qFatal(QString("Malformed por bit %1").arg(k));
}
static_cast<RegistersData *>(data()->_registersData)->sfrs[name] = rdata;
}
void processCombined(QDomElement e)
{
QString name = e.attribute("name");
if ( name.isEmpty() ) qFatal("Combined register cannot have empty name");
if ( data()->registersData().sfrs.contains(name) || data()->registersData().combined.contains(name) )
qFatal("Combined register name is duplicated");
bool ok;
CombinedData rdata;
rdata.address = fromHexLabel(e.attribute("address"), &ok);
if ( !ok ) qFatal(QString("Combined %1 address %2 is malformed").arg(name).arg(e.attribute("address")));
uint rlength = data()->registersData().nbBanks * data()->architecture().data().registerBankLength;
if ( rdata.address>=rlength ) qFatal(QString("Address %1 outside register range").arg(toHexLabel(rdata.address, 3)));
rdata.nbChars = 2*e.attribute("size").toUInt(&ok);
if ( !ok || rdata.nbChars<2 ) qFatal(QString("Combined %1 size %2 is malformed").arg(name).arg(e.attribute("size")));
Address end = rdata.address + rdata.nbChars/2 - 1;
if ( end>=rlength ) qFatal(QString("Address %1 outside register range").arg(toHexLabel(end, 3)));
static_cast<RegistersData *>(data()->_registersData)->combined[name] = rdata;
}
void processDeviceRegisters(QDomElement element)
{
QString s = element.attribute("same_as");
if ( !s.isEmpty() ) {
if ( !_map.contains(s) ) qFatal(QString("Registers same as unknown device %1").arg(s));
const Pic::Data *d = static_cast<const Pic::Data *>(_map[s]);
data()->_registersData = d->_registersData;
return;
}
RegistersData &rdata = *static_cast<RegistersData *>(data()->_registersData);
bool ok;
rdata.nbBanks = element.attribute("nb_banks").toUInt(&ok);
if ( !ok || data()->registersData().nbBanks==0 ) qFatal("Malformed number of banks");
if ( data()->is18Family() ) {
rdata.accessBankSplit = fromHexLabel(element.attribute("access_bank_split_offset"), &ok);
if ( !ok || rdata.accessBankSplit==0 || rdata.accessBankSplit>=0xFF ) qFatal("Malformed access bank split offset");
rdata.unusedBankMask = fromHexLabel(element.attribute("unused_bank_mask"), &ok);
if ( !ok || rdata.unusedBankMask>=maxValue(NumberBase::Hex, rdata.nbBanks) ) qFatal("Malformed access unused bank mask");
} else {
rdata.accessBankSplit = 0;
rdata.unusedBankMask = 0;
}
QDomNode child = element.firstChild();
while ( !child.isNull() ) {
if ( !child.isElement() ) qFatal("\"device\" child should be an element");
QDomElement e = child.toElement();
if ( e.nodeName()=="mirror" ) processMirrored(e);
else if ( e.nodeName()=="unused" ) processUnused(e);
else if ( e.nodeName()=="combined" ) processCombined(e);
else if ( e.nodeName()=="sfr" ) processSfr(e);
else qFatal(QString("Node name \"%1\" is not recognized").arg(e.nodeName()));
child = child.nextSibling();
}
for (uint i=0; i<Device::MAX_NB_PORTS; i++) {
QString portname = rdata.portName(i);
if ( portname.isEmpty() ) break;
bool hasPort = rdata.sfrs.contains(portname);
QString trisname = rdata.trisName(i);
if ( trisname.isEmpty() ) continue;
bool hasTris = rdata.sfrs.contains(trisname);
if ( !hasPort && hasTris ) qFatal(QString("%1 needs %2 to be present").arg(trisname).arg(portname));
QString latchname = rdata.latchName(i);
if ( latchname.isEmpty() ) continue;
bool hasLatch = rdata.sfrs.contains(latchname);
if ( !hasPort && hasLatch ) qFatal(QString("%1 needs %2 to be present").arg(latchname).arg(portname));
}
}
void processRegistersFile(const QString &filename, QStringList &devices)
{
QDomDocument doc = parseFile(filename);
QDomElement root = doc.documentElement();
if ( root.nodeName()!="registers" ) qFatal("root node should be \"registers\"");
for (QDomNode child=root.firstChild(); !child.isNull(); child = child.nextSibling()) {
if ( child.isComment() ) qDebug("comment: %s", child.toComment().data().latin1());
else {
if ( !child.isElement() ) qFatal("\"registers\" child should be an element");
if ( child.nodeName()!="device" ) qFatal("Device node should be named \"device\"");
QDomElement device = child.toElement();
QString name = device.attribute("name");
if ( devices.contains(name) ) qFatal(QString("Registers already defined for %1").arg(name));
if ( _map.contains(name) ) {
_data = _map[name];
processDeviceRegisters(device);
devices.append(name);
}
}
}
}
void processRegisters()
{
QStringList devices;
processRegistersFile("registers/registers.xml", devices);
processRegistersFile("registers/registers_missing.xml", devices);
// check if we miss any register description
QMap<QString, Device::Data *>::const_iterator it = _map.begin();
for (; it!=_map.end(); ++it) {
_data = it.data();
if ( !devices.contains(it.key()) ) qWarning("Register description not found for %s", it.key().latin1());
}
}
virtual void checkPins(const QMap<QString, uint> &pinLabels) const
{
if ( !pinLabels.contains("VDD") ) qFatal("No VDD pin specified");
if ( !pinLabels.contains("VSS") ) qFatal("No VSS pin specified");
QMap<QString, uint>::const_iterator it;
for (it=pinLabels.begin(); it!=pinLabels.end(); ++it) {
if ( it.key()=="VDD" || it.key()=="VSS" || it.key().startsWith("CCP") ) continue;
if ( it.data()!=1 ) qFatal(QString("Duplicated pin \"%1\"").arg(it.key()));
}
const Pic::RegistersData &rdata = static_cast<const Pic::RegistersData &>(*_data->registersData());
for (uint i=0; i<Device::MAX_NB_PORTS; i++) {
if ( !rdata.hasPort(i) ) continue;
for (uint k=0; k<Device::MAX_NB_PORT_BITS; k++) {
if ( !rdata.hasPortBit(i, k) ) continue;
QString name = rdata.portBitName(i, k);
if ( !pinLabels.contains(name) ) qFatal(QString("Pin \"%1\" not present").arg(name));
}
}
}
virtual void parse()
{
Device::XmlToDataBase::parse();
processRegisters();
}
}; // class Pic::XmlToData
} // namespace
//-----------------------------------------------------------------------------
XML_MAIN(Pic::XmlToData)
|