Initial fork for SCSI2SD-V6 firmware.
[SCSI2SD-V6.git] / src / scsi2sd-util6 / ConfigUtil.cc
1 //      Copyright (C) 2014 Michael McMaster <michael@codesrc.com>
2 //
3 //      This file is part of SCSI2SD.
4 //
5 //      SCSI2SD is free software: you can redistribute it and/or modify
6 //      it under the terms of the GNU General Public License as published by
7 //      the Free Software Foundation, either version 3 of the License, or
8 //      (at your option) any later version.
9 //
10 //      SCSI2SD is distributed in the hope that it will be useful,
11 //      but WITHOUT ANY WARRANTY; without even the implied warranty of
12 //      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 //      GNU General Public License for more details.
14 //
15 //      You should have received a copy of the GNU General Public License
16 //      along with SCSI2SD.  If not, see <http://www.gnu.org/licenses/>.
17
18 #include "ConfigUtil.hh"
19
20 #include <limits>
21 #include <sstream>
22 #include <stdexcept>
23
24 #include <string.h>
25
26 #include <wx/wxprec.h>
27 #ifndef WX_PRECOMP
28 #include <wx/wx.h>
29 #endif
30 #include <wx/base64.h>
31 #include <wx/buffer.h>
32 #include <wx/xml/xml.h>
33
34
35 using namespace SCSI2SD;
36
37 namespace
38 {
39         // Endian conversion routines.
40         // The Cortex-M3 inside the Cypress PSoC 5LP is a
41         // little-endian device.
42
43         bool isHostLE()
44         {
45                 union
46                 {
47                         int i;
48                         char c[sizeof(int)];
49                 } x;
50                 x.i = 1;
51                 return (x.c[0] == 1);
52         }
53
54         uint16_t toLE16(uint16_t in)
55         {
56                 if (isHostLE())
57                 {
58                         return in;
59                 }
60                 else
61                 {
62                         return (in >> 8) | (in << 8);
63                 }
64         }
65         uint16_t fromLE16(uint16_t in)
66         {
67                 return toLE16(in);
68         }
69
70         uint32_t toLE32(uint32_t in)
71         {
72                 if (isHostLE())
73                 {
74                         return in;
75                 }
76                 else
77                 {
78                         return (in >> 24) |
79                                 ((in >> 8) & 0xff00) |
80                                 ((in << 8) & 0xff0000) |
81                                 (in << 24);
82                 }
83         }
84         uint32_t fromLE32(uint32_t in)
85         {
86                 return toLE32(in);
87         }
88
89 }
90
91 S2S_BoardCfg
92 ConfigUtil::DefaultBoardConfig()
93 {
94         S2S_BoardCfg config;
95         memset(&config, 0, sizeof(config));
96
97         memcpy(config.magic, "BCFG", 4);
98
99
100         // Default to maximum fail-safe options.
101         config.flags6 = S2S_CFG_ENABLE_TERMINATOR;
102         config.selectionDelay = 255; // auto
103
104         return config;
105 }
106
107 S2S_TargetCfg
108 ConfigUtil::Default(size_t targetIdx)
109 {
110         S2S_TargetCfg config;
111         memset(&config, 0, sizeof(config));
112
113         config.scsiId = targetIdx;
114         if (targetIdx == 0)
115         {
116                 config.scsiId = config.scsiId | S2S_CFG_TARGET_ENABLED;
117         }
118         config.deviceType = S2S_CFG_FIXED;
119
120         // Default to maximum fail-safe options.
121         config.flagsDEPRECATED = 0;
122         config.deviceTypeModifier = 0;
123         config.sdSectorStart = 0;
124
125         // Default to 2GB. Many systems have trouble with > 2GB disks, and
126         // a few start to complain at 1GB.
127         config.scsiSectors = 4194303; // 2GB - 1 sector
128         config.bytesPerSector = 512;
129         config.sectorsPerTrack = 63;
130         config.headsPerCylinder = 255;
131         memcpy(config.vendor, " codesrc", 8);
132         memcpy(config.prodId, "         SCSI2SD", 16);
133         memcpy(config.revision, " 6.0", 4);
134         memcpy(config.serial, "1234567812345678", 16);
135
136         // Reserved fields, already set to 0
137         // config.reserved
138
139         // not supported yet.
140         // config.vpd
141
142         return config;
143 }
144
145
146 S2S_TargetCfg
147 ConfigUtil::fromBytes(const uint8_t* data)
148 {
149         S2S_TargetCfg result;
150         memcpy(&result, data, sizeof(S2S_TargetCfg));
151         result.sdSectorStart = toLE32(result.sdSectorStart);
152         result.scsiSectors = toLE32(result.scsiSectors);
153         result.bytesPerSector = toLE16(result.bytesPerSector);
154         result.sectorsPerTrack = toLE16(result.sectorsPerTrack);
155         result.headsPerCylinder = toLE16(result.headsPerCylinder);
156         return result;
157 }
158
159
160 std::vector<uint8_t>
161 ConfigUtil::toBytes(const S2S_TargetCfg& _config)
162 {
163         S2S_TargetCfg config(_config);
164         config.sdSectorStart = fromLE32(config.sdSectorStart);
165         config.scsiSectors = fromLE32(config.scsiSectors);
166         config.bytesPerSector = fromLE16(config.bytesPerSector);
167         config.sectorsPerTrack = fromLE16(config.sectorsPerTrack);
168         config.headsPerCylinder = fromLE16(config.headsPerCylinder);
169
170         const uint8_t* begin = reinterpret_cast<const uint8_t*>(&config);
171         return std::vector<uint8_t>(begin, begin + sizeof(config));
172 }
173
174 S2S_BoardCfg
175 ConfigUtil::boardConfigFromBytes(const uint8_t* data)
176 {
177         S2S_BoardCfg result;
178         memcpy(&result, data, sizeof(S2S_BoardCfg));
179
180         if (memcmp("BCFG", result.magic, 4))
181         {
182                 return DefaultBoardConfig();
183         }
184
185         return result;
186 }
187
188
189 std::vector<uint8_t>
190 ConfigUtil::boardConfigToBytes(const S2S_BoardCfg& _config)
191 {
192         S2S_BoardCfg config(_config);
193
194         memcpy(config.magic, "BCFG", 4);
195         const uint8_t* begin = reinterpret_cast<const uint8_t*>(&config);
196         return std::vector<uint8_t>(begin, begin + sizeof(config));
197 }
198
199 std::string
200 ConfigUtil::toXML(const S2S_TargetCfg& config)
201 {
202         std::stringstream s;
203
204         s <<
205                 "<SCSITarget id=\"" <<
206                         static_cast<int>(config.scsiId & S2S_CFG_TARGET_ID_BITS) << "\">\n" <<
207
208                 "       <enabled>" <<
209                         (config.scsiId & S2S_CFG_TARGET_ENABLED ? "true" : "false") <<
210                         "</enabled>\n" <<
211
212                 "\n" <<
213                 "       <!-- ********************************************************\n" <<
214                 "       Space separated list. Available options:\n" <<
215                 "       apple\t\tReturns Apple-specific mode pages\n" <<
216                 "       ********************************************************* -->\n" <<
217                 "       <quirks>" <<
218                         (config.quirks & S2S_CFG_QUIRKS_APPLE ? "apple" : "") <<
219                         "</quirks>\n" <<
220
221                 "\n\n" <<
222                 "       <!-- ********************************************************\n" <<
223                 "       0x0    Fixed hard drive.\n" <<
224                 "       0x1    Removable drive.\n" <<
225                 "       0x2    Optical drive  (ie. CD drive).\n" <<
226                 "       0x3    1.44MB Floppy Drive.\n" <<
227                 "       ********************************************************* -->\n" <<
228                 "       <deviceType>0x" <<
229                                 std::hex << static_cast<int>(config.deviceType) <<
230                         "</deviceType>\n" <<
231
232                 "\n\n" <<
233                 "       <!-- ********************************************************\n" <<
234                 "       Device type modifier is usually 0x00. Only change this if your\n" <<
235                 "       OS requires some special value.\n" <<
236                 "\n" <<
237                 "       0x4C    Data General Micropolis disk\n" <<
238                 "       ********************************************************* -->\n" <<
239                 "       <deviceTypeModifier>0x" <<
240                                 std::hex << static_cast<int>(config.deviceTypeModifier) <<
241                         "</deviceTypeModifier>\n" <<
242
243                 "\n\n" <<
244                 "       <!-- ********************************************************\n" <<
245                 "       SD card offset, as a sector number (always 512 bytes).\n" <<
246                 "       ********************************************************* -->\n" <<
247                 "       <sdSectorStart>" << std::dec << config.sdSectorStart << "</sdSectorStart>\n" <<
248                 "\n\n" <<
249                 "       <!-- ********************************************************\n" <<
250                 "       Drive geometry settings.\n" <<
251                 "       ********************************************************* -->\n" <<
252                 "\n"
253                 "       <scsiSectors>" << std::dec << config.scsiSectors << "</scsiSectors>\n" <<
254                 "       <bytesPerSector>" << std::dec << config.bytesPerSector << "</bytesPerSector>\n" <<
255                 "       <sectorsPerTrack>" << std::dec << config.sectorsPerTrack<< "</sectorsPerTrack>\n" <<
256                 "       <headsPerCylinder>" << std::dec << config.headsPerCylinder << "</headsPerCylinder>\n" <<
257                 "\n\n" <<
258                 "       <!-- ********************************************************\n" <<
259                 "       Drive identification information. The SCSI2SD doesn't\n" <<
260                 "       care what these are set to. Use these strings to trick a OS\n" <<
261                 "       thinking a specific hard drive model is attached.\n" <<
262                 "       ********************************************************* -->\n" <<
263                 "\n"
264                 "       <!-- 8 character vendor string -->\n" <<
265                 "       <!-- For Apple HD SC Setup/Drive Setup, use ' SEAGATE' -->\n" <<
266                 "       <vendor>" << std::string(config.vendor, 8) << "</vendor>\n" <<
267                 "\n" <<
268                 "       <!-- 16 character produce identifier -->\n" <<
269                 "       <!-- For Apple HD SC Setup/Drive Setup, use '          ST225N' -->\n" <<
270                 "       <prodId>" << std::string(config.prodId, 16) << "</prodId>\n" <<
271                 "\n" <<
272                 "       <!-- 4 character product revision number -->\n" <<
273                 "       <!-- For Apple HD SC Setup/Drive Setup, use '1.0 ' -->\n" <<
274                 "       <revision>" << std::string(config.revision, 4) << "</revision>\n" <<
275                 "\n" <<
276                 "       <!-- 16 character serial number -->\n" <<
277                 "       <serial>" << std::string(config.serial, 16) << "</serial>\n" <<
278                 "\n" <<
279                 "</SCSITarget>\n";
280
281         return s.str();
282 }
283
284 std::string
285 ConfigUtil::toXML(const S2S_BoardCfg& config)
286 {
287         std::stringstream s;
288
289         s << "<S2S_BoardCfg>\n" <<
290
291                 "       <!-- ********************************************************\n" <<
292                 "       Enable the onboard active terminator.\n"
293                 "       Both ends of the SCSI chain should be terminated. Disable\n" <<
294                 "       only if the SCSI2SD is in the middle of a chain with other\n" <<
295                 "       devices.\n" <<
296                 "       ********************************************************* -->\n" <<
297                 "       <enableTerminator>" <<
298                         (config.flags6 & S2S_CFG_ENABLE_TERMINATOR ? "true" : "false") <<
299                         "</enableTerminator>\n" <<
300
301                 "       <unitAttention>" <<
302                         (config.flags & S2S_CFG_ENABLE_UNIT_ATTENTION ? "true" : "false") <<
303                         "</unitAttention>\n" <<
304
305                 "       <parity>" <<
306                         (config.flags & S2S_CFG_ENABLE_PARITY ? "true" : "false") <<
307                         "</parity>\n" <<
308
309                 "       <!-- ********************************************************\n" <<
310                 "       Only set to true when using with a fast SCSI2 host\n " <<
311                 "       controller. This can cause problems with older/slower\n" <<
312                 "       hardware.\n" <<
313                 "       ********************************************************* -->\n" <<
314                 "       <enableScsi2>" <<
315                         (config.flags & S2S_CFG_ENABLE_SCSI2 ? "true" : "false") <<
316                         "</enableScsi2>\n" <<
317
318                 "       <enableCache>" <<
319                         (config.flags & S2S_CFG_ENABLE_CACHE ? "true" : "false") <<
320                         "</enableCache>\n" <<
321
322                 "       <enableDisconnect>" <<
323                         (config.flags & S2S_CFG_ENABLE_DISCONNECT ? "true" : "false") <<
324                         "</enableDisconnect>\n" <<
325
326                 "       <!-- ********************************************************\n" <<
327                 "       Respond to very short duration selection attempts. This supports\n" <<
328                 "       non-standard hardware, but is generally safe to enable.\n" <<
329                 "       Required for Philips P2000C.\n" <<
330                 "       ********************************************************* -->\n" <<
331                 "       <selLatch>" <<
332                         (config.flags & S2S_CFG_ENABLE_SEL_LATCH? "true" : "false") <<
333                         "</selLatch>\n" <<
334
335
336                 "       <!-- ********************************************************\n" <<
337                 "       Convert luns to IDs. The unit must already be configured to respond\n" <<
338                 "       on the ID. Allows dual drives to be accessed from a \n" <<
339                 "       XEBEC S1410 SASI bridge.\n" <<
340                 "       eg. Configured for dual drives as IDs 0 and 1, but the XEBEC will\n" <<
341                 "       access the second disk as ID0, lun 1.\n" <<
342                 "       See ttp://bitsavers.trailing-edge.com/pdf/xebec/104524C_S1410Man_Aug83.pdf\n" <<
343                 "       ********************************************************* -->\n" <<
344                 "       <mapLunsToIds>" <<
345                         (config.flags & S2S_CFG_MAP_LUNS_TO_IDS ? "true" : "false") <<
346                         "</mapLunsToIds>\n" <<
347                 "</S2S_BoardCfg>\n";
348
349         return s.str();
350 }
351
352
353 static uint64_t parseInt(wxXmlNode* node, uint64_t limit)
354 {
355         std::string str(node->GetNodeContent().mb_str());
356         if (str.empty())
357         {
358                 throw std::runtime_error("Empty " + node->GetName());
359         }
360
361         std::stringstream s;
362         if (str.find("0x") == 0)
363         {
364                 s << std::hex << str.substr(2);
365         }
366         else
367         {
368                 s << str;
369         }
370
371         uint64_t result;
372         s >> result;
373         if (!s)
374         {
375                 throw std::runtime_error("Invalid value for " + node->GetName());
376         }
377
378         if (result > limit)
379         {
380                 std::stringstream msg;
381                 msg << "Invalid value for " << node->GetName() <<
382                         " (max=" << limit << ")";
383                 throw std::runtime_error(msg.str());
384         }
385         return result;
386 }
387
388 static S2S_TargetCfg
389 parseTarget(wxXmlNode* node)
390 {
391         int id;
392         {
393                 std::stringstream s;
394                 s << node->GetAttribute("id", "7");
395                 s >> id;
396                 if (!s) throw std::runtime_error("Could not parse SCSITarget id attr");
397         }
398         S2S_TargetCfg result = ConfigUtil::Default(id & 0x7);
399
400         wxXmlNode *child = node->GetChildren();
401         while (child)
402         {
403                 if (child->GetName() == "enabled")
404                 {
405                         std::string s(child->GetNodeContent().mb_str());
406                         if (s == "true")
407                         {
408                                 result.scsiId |= S2S_CFG_TARGET_ENABLED;
409                         }
410                         else
411                         {
412                                 result.scsiId = result.scsiId & ~S2S_CFG_TARGET_ENABLED;
413                         }
414                 }
415                 else if (child->GetName() == "quirks")
416                 {
417                         std::stringstream s(std::string(child->GetNodeContent().mb_str()));
418                         std::string quirk;
419                         while (s >> quirk)
420                         {
421                                 if (quirk == "apple")
422                                 {
423                                         result.quirks |= S2S_CFG_QUIRKS_APPLE;
424                                 }
425                         }
426                 }
427                 else if (child->GetName() == "deviceType")
428                 {
429                         result.deviceType = parseInt(child, 0xFF);
430                 }
431                 else if (child->GetName() == "deviceTypeModifier")
432                 {
433                         result.deviceTypeModifier = parseInt(child, 0xFF);
434                 }
435                 else if (child->GetName() == "sdSectorStart")
436                 {
437                         result.sdSectorStart = parseInt(child, 0xFFFFFFFF);
438                 }
439                 else if (child->GetName() == "scsiSectors")
440                 {
441                         result.scsiSectors = parseInt(child, 0xFFFFFFFF);
442                 }
443                 else if (child->GetName() == "bytesPerSector")
444                 {
445                         result.bytesPerSector = parseInt(child, 8192);
446                 }
447                 else if (child->GetName() == "sectorsPerTrack")
448                 {
449                         result.sectorsPerTrack = parseInt(child, 255);
450                 }
451                 else if (child->GetName() == "headsPerCylinder")
452                 {
453                         result.headsPerCylinder = parseInt(child, 255);
454                 }
455                 else if (child->GetName() == "vendor")
456                 {
457                         std::string s(child->GetNodeContent().mb_str());
458                         s = s.substr(0, sizeof(result.vendor));
459                         memset(result.vendor, ' ', sizeof(result.vendor));
460                         memcpy(result.vendor, s.c_str(), s.size());
461                 }
462                 else if (child->GetName() == "prodId")
463                 {
464                         std::string s(child->GetNodeContent().mb_str());
465                         s = s.substr(0, sizeof(result.prodId));
466                         memset(result.prodId, ' ', sizeof(result.prodId));
467                         memcpy(result.prodId, s.c_str(), s.size());
468                 }
469                 else if (child->GetName() == "revision")
470                 {
471                         std::string s(child->GetNodeContent().mb_str());
472                         s = s.substr(0, sizeof(result.revision));
473                         memset(result.revision, ' ', sizeof(result.revision));
474                         memcpy(result.revision, s.c_str(), s.size());
475                 }
476                 else if (child->GetName() == "serial")
477                 {
478                         std::string s(child->GetNodeContent().mb_str());
479                         s = s.substr(0, sizeof(result.serial));
480                         memset(result.serial, ' ', sizeof(result.serial));
481                         memcpy(result.serial, s.c_str(), s.size());
482                 }
483
484
485                 child = child->GetNext();
486         }
487         return result;
488 }
489
490 static S2S_BoardCfg
491 parseBoardConfig(wxXmlNode* node)
492 {
493         S2S_BoardCfg result = ConfigUtil::DefaultBoardConfig();
494
495         wxXmlNode *child = node->GetChildren();
496         while (child)
497         {
498 // FIXME WHERE IS SELECTION DELAY ? STARTUP DELAY ? FFS.
499                 if (child->GetName() == "unitAttention")
500                 {
501                         std::string s(child->GetNodeContent().mb_str());
502                         if (s == "true")
503                         {
504                                 result.flags |= S2S_CFG_ENABLE_UNIT_ATTENTION;
505                         }
506                         else
507                         {
508                                 result.flags = result.flags & ~S2S_CFG_ENABLE_UNIT_ATTENTION;
509                         }
510                 }
511                 else if (child->GetName() == "parity")
512                 {
513                         std::string s(child->GetNodeContent().mb_str());
514                         if (s == "true")
515                         {
516                                 result.flags |= S2S_CFG_ENABLE_PARITY;
517                         }
518                         else
519                         {
520                                 result.flags = result.flags & ~S2S_CFG_ENABLE_PARITY;
521                         }
522                 }
523                 else if (child->GetName() == "enableScsi2")
524                 {
525                         std::string s(child->GetNodeContent().mb_str());
526                         if (s == "true")
527                         {
528                                 result.flags |= S2S_CFG_ENABLE_SCSI2;
529                         }
530                         else
531                         {
532                                 result.flags = result.flags & ~S2S_CFG_ENABLE_SCSI2;
533                         }
534                 }
535                 else if (child->GetName() == "enableTerminator")
536                 {
537                         std::string s(child->GetNodeContent().mb_str());
538                         if (s == "true")
539                         {
540                                 result.flags6 |= S2S_CFG_ENABLE_TERMINATOR;
541                         }
542                         else
543                         {
544                                 result.flags6 = result.flags & ~S2S_CFG_ENABLE_TERMINATOR;
545                         }
546                 }
547                 else if (child->GetName() == "enableCache")
548                 {
549                         std::string s(child->GetNodeContent().mb_str());
550                         if (s == "true")
551                         {
552                                 result.flags |= S2S_CFG_ENABLE_CACHE;
553                         }
554                         else
555                         {
556                                 result.flags = result.flags & ~S2S_CFG_ENABLE_CACHE;
557                         }
558                 }
559                 else if (child->GetName() == "enableDisconnect")
560                 {
561                         std::string s(child->GetNodeContent().mb_str());
562                         if (s == "true")
563                         {
564                                 result.flags |= S2S_CFG_ENABLE_DISCONNECT;
565                         }
566                         else
567                         {
568                                 result.flags = result.flags & ~S2S_CFG_ENABLE_DISCONNECT;
569                         }
570                 }
571                 else if (child->GetName() == "selLatch")
572                 {
573                         std::string s(child->GetNodeContent().mb_str());
574                         if (s == "true")
575                         {
576                                 result.flags |= S2S_CFG_ENABLE_SEL_LATCH;
577                         }
578                         else
579                         {
580                                 result.flags = result.flags & ~S2S_CFG_ENABLE_SEL_LATCH;
581                         }
582                 }
583                 else if (child->GetName() == "mapLunsToIds")
584                 {
585                         std::string s(child->GetNodeContent().mb_str());
586                         if (s == "true")
587                         {
588                                 result.flags |= S2S_CFG_MAP_LUNS_TO_IDS;
589                         }
590                         else
591                         {
592                                 result.flags = result.flags & ~S2S_CFG_MAP_LUNS_TO_IDS;
593                         }
594                 }
595                 child = child->GetNext();
596         }
597         return result;
598 }
599
600
601 std::pair<S2S_BoardCfg, std::vector<S2S_TargetCfg>>
602 ConfigUtil::fromXML(const std::string& filename)
603 {
604         wxXmlDocument doc;
605         if (!doc.Load(filename))
606         {
607                 throw std::runtime_error("Could not load XML file");
608         }
609
610         // start processing the XML file
611         if (doc.GetRoot()->GetName() != "SCSI2SD")
612         {
613                 throw std::runtime_error("Invalid root node, expected <SCSI2SD>");
614         }
615
616         S2S_BoardCfg boardConfig = DefaultBoardConfig();
617         int boardConfigFound = 0;
618
619         std::vector<S2S_TargetCfg> targets;
620         wxXmlNode *child = doc.GetRoot()->GetChildren();
621         while (child)
622         {
623                 if (child->GetName() == "SCSITarget")
624                 {
625                         targets.push_back(parseTarget(child));
626                 }
627                 else if (child->GetName() == "S2S_BoardCfg")
628                 {
629                         boardConfig = parseBoardConfig(child);
630                         boardConfigFound = 1;
631                 }
632                 child = child->GetNext();
633         }
634
635         if (!boardConfigFound && targets.size() > 0)
636         {
637                 boardConfig.flags = targets[0].flagsDEPRECATED;
638         }
639         return make_pair(boardConfig, targets);
640 }
641