1 // Copyright (C) 2014 Michael McMaster <michael@codesrc.com>
3 // This file is part of SCSI2SD.
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.
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.
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/>.
18 #include "ConfigUtil.hh"
26 #include <wx/wxprec.h>
30 #include <wx/base64.h>
31 #include <wx/buffer.h>
32 #include <wx/xml/xml.h>
35 using namespace SCSI2SD;
39 // Endian conversion routines.
40 // The Cortex-M3 inside the Cypress PSoC 5LP is a
41 // little-endian device.
54 uint16_t toLE16(uint16_t in)
62 return (in >> 8) | (in << 8);
65 uint16_t fromLE16(uint16_t in)
70 uint32_t toLE32(uint32_t in)
79 ((in >> 8) & 0xff00) |
80 ((in << 8) & 0xff0000) |
84 uint32_t fromLE32(uint32_t in)
92 ConfigUtil::DefaultBoardConfig()
95 memset(&config, 0, sizeof(config));
97 memcpy(config.magic, "BCFG", 4);
100 // Default to maximum fail-safe options.
101 config.flags6 = S2S_CFG_ENABLE_TERMINATOR;
102 config.selectionDelay = 255; // auto
108 ConfigUtil::Default(size_t targetIdx)
110 S2S_TargetCfg config;
111 memset(&config, 0, sizeof(config));
113 config.scsiId = targetIdx;
116 config.scsiId = config.scsiId | S2S_CFG_TARGET_ENABLED;
118 config.deviceType = S2S_CFG_FIXED;
120 // Default to maximum fail-safe options.
121 config.flagsDEPRECATED = 0;
122 config.deviceTypeModifier = 0;
123 config.sdSectorStart = 0;
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);
136 // Reserved fields, already set to 0
139 // not supported yet.
147 ConfigUtil::fromBytes(const uint8_t* data)
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);
161 ConfigUtil::toBytes(const S2S_TargetCfg& _config)
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);
170 const uint8_t* begin = reinterpret_cast<const uint8_t*>(&config);
171 return std::vector<uint8_t>(begin, begin + sizeof(config));
175 ConfigUtil::boardConfigFromBytes(const uint8_t* data)
178 memcpy(&result, data, sizeof(S2S_BoardCfg));
180 if (memcmp("BCFG", result.magic, 4))
182 return DefaultBoardConfig();
190 ConfigUtil::boardConfigToBytes(const S2S_BoardCfg& _config)
192 S2S_BoardCfg config(_config);
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));
200 ConfigUtil::toXML(const S2S_TargetCfg& config)
205 "<SCSITarget id=\"" <<
206 static_cast<int>(config.scsiId & S2S_CFG_TARGET_ID_BITS) << "\">\n" <<
209 (config.scsiId & S2S_CFG_TARGET_ENABLED ? "true" : "false") <<
213 " <!-- ********************************************************\n" <<
214 " Space separated list. Available options:\n" <<
215 " apple\t\tReturns Apple-specific mode pages\n" <<
216 " ********************************************************* -->\n" <<
218 (config.quirks & S2S_CFG_QUIRKS_APPLE ? "apple" : "") <<
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" <<
229 std::hex << static_cast<int>(config.deviceType) <<
233 " <!-- ********************************************************\n" <<
234 " Device type modifier is usually 0x00. Only change this if your\n" <<
235 " OS requires some special value.\n" <<
237 " 0x4C Data General Micropolis disk\n" <<
238 " ********************************************************* -->\n" <<
239 " <deviceTypeModifier>0x" <<
240 std::hex << static_cast<int>(config.deviceTypeModifier) <<
241 "</deviceTypeModifier>\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" <<
249 " <!-- ********************************************************\n" <<
250 " Drive geometry settings.\n" <<
251 " ********************************************************* -->\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" <<
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" <<
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" <<
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" <<
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" <<
276 " <!-- 16 character serial number -->\n" <<
277 " <serial>" << std::string(config.serial, 16) << "</serial>\n" <<
285 ConfigUtil::toXML(const S2S_BoardCfg& config)
289 s << "<S2S_BoardCfg>\n" <<
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" <<
296 " ********************************************************* -->\n" <<
297 " <enableTerminator>" <<
298 (config.flags6 & S2S_CFG_ENABLE_TERMINATOR ? "true" : "false") <<
299 "</enableTerminator>\n" <<
301 " <unitAttention>" <<
302 (config.flags & S2S_CFG_ENABLE_UNIT_ATTENTION ? "true" : "false") <<
303 "</unitAttention>\n" <<
306 (config.flags & S2S_CFG_ENABLE_PARITY ? "true" : "false") <<
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" <<
313 " ********************************************************* -->\n" <<
315 (config.flags & S2S_CFG_ENABLE_SCSI2 ? "true" : "false") <<
316 "</enableScsi2>\n" <<
319 (config.flags & S2S_CFG_ENABLE_CACHE ? "true" : "false") <<
320 "</enableCache>\n" <<
322 " <!-- ********************************************************\n" <<
323 " Setting to 'true' will result in increased performance at the\n" <<
324 " cost of lower noise immunity.\n" <<
325 " Only set to true when using short cables with only 1 or two\n" <<
326 " devices. This should remain off when using external SCSI1 DB25\n" <<
328 " ********************************************************* -->\n" <<
329 " <disableGlitchFilter>" <<
330 (config.flags & S2S_CFG_DISABLE_GLITCH ? "true" : "false") <<
331 "</disableGlitchFilter>\n" <<
334 " <enableDisconnect>" <<
335 (config.flags & S2S_CFG_ENABLE_DISCONNECT ? "true" : "false") <<
336 "</enableDisconnect>\n" <<
338 " <!-- ********************************************************\n" <<
339 " Respond to very short duration selection attempts. This supports\n" <<
340 " non-standard hardware, but is generally safe to enable.\n" <<
341 " Required for Philips P2000C.\n" <<
342 " ********************************************************* -->\n" <<
344 (config.flags & S2S_CFG_ENABLE_SEL_LATCH? "true" : "false") <<
348 " <!-- ********************************************************\n" <<
349 " Convert luns to IDs. The unit must already be configured to respond\n" <<
350 " on the ID. Allows dual drives to be accessed from a \n" <<
351 " XEBEC S1410 SASI bridge.\n" <<
352 " eg. Configured for dual drives as IDs 0 and 1, but the XEBEC will\n" <<
353 " access the second disk as ID0, lun 1.\n" <<
354 " See ttp://bitsavers.trailing-edge.com/pdf/xebec/104524C_S1410Man_Aug83.pdf\n" <<
355 " ********************************************************* -->\n" <<
357 (config.flags & S2S_CFG_MAP_LUNS_TO_IDS ? "true" : "false") <<
358 "</mapLunsToIds>\n" <<
365 static uint64_t parseInt(wxXmlNode* node, uint64_t limit)
367 std::string str(node->GetNodeContent().mb_str());
370 throw std::runtime_error("Empty " + node->GetName());
374 if (str.find("0x") == 0)
376 s << std::hex << str.substr(2);
387 throw std::runtime_error("Invalid value for " + node->GetName());
392 std::stringstream msg;
393 msg << "Invalid value for " << node->GetName() <<
394 " (max=" << limit << ")";
395 throw std::runtime_error(msg.str());
401 parseTarget(wxXmlNode* node)
406 s << node->GetAttribute("id", "7");
408 if (!s) throw std::runtime_error("Could not parse SCSITarget id attr");
410 S2S_TargetCfg result = ConfigUtil::Default(id & 0x7);
412 wxXmlNode *child = node->GetChildren();
415 if (child->GetName() == "enabled")
417 std::string s(child->GetNodeContent().mb_str());
420 result.scsiId |= S2S_CFG_TARGET_ENABLED;
424 result.scsiId = result.scsiId & ~S2S_CFG_TARGET_ENABLED;
427 else if (child->GetName() == "quirks")
429 std::stringstream s(std::string(child->GetNodeContent().mb_str()));
433 if (quirk == "apple")
435 result.quirks |= S2S_CFG_QUIRKS_APPLE;
439 else if (child->GetName() == "deviceType")
441 result.deviceType = parseInt(child, 0xFF);
443 else if (child->GetName() == "deviceTypeModifier")
445 result.deviceTypeModifier = parseInt(child, 0xFF);
447 else if (child->GetName() == "sdSectorStart")
449 result.sdSectorStart = parseInt(child, 0xFFFFFFFF);
451 else if (child->GetName() == "scsiSectors")
453 result.scsiSectors = parseInt(child, 0xFFFFFFFF);
455 else if (child->GetName() == "bytesPerSector")
457 result.bytesPerSector = parseInt(child, 8192);
459 else if (child->GetName() == "sectorsPerTrack")
461 result.sectorsPerTrack = parseInt(child, 255);
463 else if (child->GetName() == "headsPerCylinder")
465 result.headsPerCylinder = parseInt(child, 255);
467 else if (child->GetName() == "vendor")
469 std::string s(child->GetNodeContent().mb_str());
470 s = s.substr(0, sizeof(result.vendor));
471 memset(result.vendor, ' ', sizeof(result.vendor));
472 memcpy(result.vendor, s.c_str(), s.size());
474 else if (child->GetName() == "prodId")
476 std::string s(child->GetNodeContent().mb_str());
477 s = s.substr(0, sizeof(result.prodId));
478 memset(result.prodId, ' ', sizeof(result.prodId));
479 memcpy(result.prodId, s.c_str(), s.size());
481 else if (child->GetName() == "revision")
483 std::string s(child->GetNodeContent().mb_str());
484 s = s.substr(0, sizeof(result.revision));
485 memset(result.revision, ' ', sizeof(result.revision));
486 memcpy(result.revision, s.c_str(), s.size());
488 else if (child->GetName() == "serial")
490 std::string s(child->GetNodeContent().mb_str());
491 s = s.substr(0, sizeof(result.serial));
492 memset(result.serial, ' ', sizeof(result.serial));
493 memcpy(result.serial, s.c_str(), s.size());
497 child = child->GetNext();
503 parseBoardConfig(wxXmlNode* node)
505 S2S_BoardCfg result = ConfigUtil::DefaultBoardConfig();
507 wxXmlNode *child = node->GetChildren();
510 // FIXME WHERE IS SELECTION DELAY ? STARTUP DELAY ? FFS.
511 if (child->GetName() == "unitAttention")
513 std::string s(child->GetNodeContent().mb_str());
516 result.flags |= S2S_CFG_ENABLE_UNIT_ATTENTION;
520 result.flags = result.flags & ~S2S_CFG_ENABLE_UNIT_ATTENTION;
523 else if (child->GetName() == "parity")
525 std::string s(child->GetNodeContent().mb_str());
528 result.flags |= S2S_CFG_ENABLE_PARITY;
532 result.flags = result.flags & ~S2S_CFG_ENABLE_PARITY;
535 else if (child->GetName() == "enableScsi2")
537 std::string s(child->GetNodeContent().mb_str());
540 result.flags |= S2S_CFG_ENABLE_SCSI2;
544 result.flags = result.flags & ~S2S_CFG_ENABLE_SCSI2;
547 else if (child->GetName() == "disableGlitchFilter")
549 std::string s(child->GetNodeContent().mb_str());
552 result.flags |= S2S_CFG_DISABLE_GLITCH;
556 result.flags = result.flags & ~S2S_CFG_DISABLE_GLITCH;
559 else if (child->GetName() == "enableTerminator")
561 std::string s(child->GetNodeContent().mb_str());
564 result.flags6 |= S2S_CFG_ENABLE_TERMINATOR;
568 result.flags6 = result.flags & ~S2S_CFG_ENABLE_TERMINATOR;
571 else if (child->GetName() == "enableCache")
573 std::string s(child->GetNodeContent().mb_str());
576 result.flags |= S2S_CFG_ENABLE_CACHE;
580 result.flags = result.flags & ~S2S_CFG_ENABLE_CACHE;
583 else if (child->GetName() == "enableDisconnect")
585 std::string s(child->GetNodeContent().mb_str());
588 result.flags |= S2S_CFG_ENABLE_DISCONNECT;
592 result.flags = result.flags & ~S2S_CFG_ENABLE_DISCONNECT;
595 else if (child->GetName() == "selLatch")
597 std::string s(child->GetNodeContent().mb_str());
600 result.flags |= S2S_CFG_ENABLE_SEL_LATCH;
604 result.flags = result.flags & ~S2S_CFG_ENABLE_SEL_LATCH;
607 else if (child->GetName() == "mapLunsToIds")
609 std::string s(child->GetNodeContent().mb_str());
612 result.flags |= S2S_CFG_MAP_LUNS_TO_IDS;
616 result.flags = result.flags & ~S2S_CFG_MAP_LUNS_TO_IDS;
619 child = child->GetNext();
625 std::pair<S2S_BoardCfg, std::vector<S2S_TargetCfg>>
626 ConfigUtil::fromXML(const std::string& filename)
629 if (!doc.Load(filename))
631 throw std::runtime_error("Could not load XML file");
634 // start processing the XML file
635 if (doc.GetRoot()->GetName() != "SCSI2SD")
637 throw std::runtime_error("Invalid root node, expected <SCSI2SD>");
640 S2S_BoardCfg boardConfig = DefaultBoardConfig();
641 int boardConfigFound = 0;
643 std::vector<S2S_TargetCfg> targets;
644 wxXmlNode *child = doc.GetRoot()->GetChildren();
647 if (child->GetName() == "SCSITarget")
649 targets.push_back(parseTarget(child));
651 else if (child->GetName() == "S2S_BoardCfg")
653 boardConfig = parseBoardConfig(child);
654 boardConfigFound = 1;
656 child = child->GetNext();
659 if (!boardConfigFound && targets.size() > 0)
661 boardConfig.flags = targets[0].flagsDEPRECATED;
663 return make_pair(boardConfig, targets);