TORC: torc/bitstream/Spartan6UnitTest.cpp Source File

00001 // Torc - Copyright 2011 University of Southern California.  All Rights Reserved.
00002 // $HeadURL: https://torc-isi.svn.sourceforge.net/svnroot/torc-isi/branches/staging/0.9/src/torc/bitstream/Spartan6UnitTest.cpp $
00003 // $Id: Spartan6UnitTest.cpp 10 2011-10-12 18:40:16Z nsteiner $
00004 
00005 // This program is free software: you can redistribute it and/or modify it under the terms of the 
00006 // GNU General Public License as published by the Free Software Foundation, either version 3 of the 
00007 // License, or (at your option) any later version.
00008 // 
00009 // This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
00010 // without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See 
00011 // the GNU General Public License for more details.
00012 // 
00013 // You should have received a copy of the GNU General Public License along with this program.  If 
00014 // not, see <http://www.gnu.org/licenses/>.
00015 
00016 /// \file
00017 /// \brief Unit test for the Spartan6 class.
00018 
00019 #include <boost/test/unit_test.hpp>
00020 #include "torc/bitstream/Spartan6.hpp"
00021 #include "torc/architecture/DDB.hpp"
00022 #include "torc/common/DeviceDesignator.hpp"
00023 #include "torc/bitstream/OutputStreamHelpers.hpp"
00024 #include "torc/common/TestHelpers.hpp"
00025 #include "torc/common/DirectoryTree.hpp"
00026 #include <fstream>
00027 #include <iostream>
00028 
00029 namespace torc {
00030 namespace bitstream {
00031 
00032 BOOST_AUTO_TEST_SUITE(bitstream)
00033 
00034 
00035 /// \brief Unit test for the Spartan6 class.
00036 BOOST_AUTO_TEST_CASE(Spartan6UnitTest) {
00037 
00038     // enums tested:
00039     //      EPacket
00040     //      EFar
00041     boost::uint16_t mask;
00042     // type 1 packet subfield masks
00043     mask = Spartan6::ePacketMaskType + Spartan6::ePacketMaskOpcode 
00044         + Spartan6::ePacketMaskTypeAddress + Spartan6::ePacketMaskType1Count;
00045     BOOST_CHECK_EQUAL(mask, 0xFFFFu);
00046     // type 2 packet subfield masks
00047     mask = Spartan6::ePacketMaskType + Spartan6::ePacketMaskOpcode 
00048         + Spartan6::ePacketMaskTypeAddress;
00049     BOOST_CHECK_EQUAL(mask, 0xFFE0u);
00050     // frame major address register subfield masks
00051     mask = Spartan6::eFarMajMaskBlock + Spartan6::eFarMajMaskRow + Spartan6::eFarMajMaskMajor;
00052     BOOST_CHECK_EQUAL(mask, 0xFFFFu);
00053     // frame minor address register subfield masks
00054     mask = Spartan6::eFarMinMaskBlock + Spartan6::eFarMinMaskMinor;
00055     BOOST_CHECK_EQUAL(mask, 0xC1FFu);
00056 
00057     // members tested:
00058     //      Spartan6::sPacketTypeName and EPacketTypeName
00059     BOOST_CHECK_EQUAL(Spartan6::sPacketTypeName[0],                         "[UNKNOWN TYPE 0]");
00060     BOOST_CHECK_EQUAL(Spartan6::sPacketTypeName[Spartan6::ePacketType1],        "TYPE1");
00061     BOOST_CHECK_EQUAL(Spartan6::sPacketTypeName[Spartan6::ePacketType2],        "TYPE2");
00062     BOOST_CHECK_EQUAL(Spartan6::sPacketTypeName[3],                         "[UNKNOWN TYPE 3]");
00063     BOOST_CHECK_EQUAL(Spartan6::sPacketTypeName[4],                         "[UNKNOWN TYPE 4]");
00064     BOOST_CHECK_EQUAL(Spartan6::sPacketTypeName[5],                         "[UNKNOWN TYPE 5]");
00065     BOOST_CHECK_EQUAL(Spartan6::sPacketTypeName[6],                         "[UNKNOWN TYPE 6]");
00066     BOOST_CHECK_EQUAL(Spartan6::sPacketTypeName[7],                         "[UNKNOWN TYPE 7]");
00067 
00068     // members tested:
00069     //      Spartan6::sOpcodeName and EOpcode
00070     BOOST_CHECK_EQUAL(Spartan6::sOpcodeName[Spartan6::eOpcodeNOP],          "NOP");
00071     BOOST_CHECK_EQUAL(Spartan6::sOpcodeName[Spartan6::eOpcodeRead],         "READ");
00072     BOOST_CHECK_EQUAL(Spartan6::sOpcodeName[Spartan6::eOpcodeWrite],            "WRITE");
00073     BOOST_CHECK_EQUAL(Spartan6::sOpcodeName[Spartan6::eOpcodeReserved],     "RESERVED");
00074 
00075     // members tested:
00076     //      Spartan6::sRegisterName and ERegister
00077     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterCRC],      "CRC");
00078     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterFARMAJ],       "FARMAJ");
00079     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterFARMIN],       "FARMIN");
00080     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterFDRI],     "FDRI");
00081     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterFDRO],     "FDRO");
00082     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterCMD],      "CMD");
00083     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterCTL],      "CTL");
00084     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterMASK],     "MASK");
00085     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterSTAT],     "STAT");
00086     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterLOUT],     "LOUT");
00087     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterCOR1],     "COR1");
00088     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterCOR2],     "COR2");
00089     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterPWRDN_REG],        "PWRDN_REG");
00090     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterFLR],      "FLR");
00091     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterIDCODE],       "IDCODE");
00092     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterCWDT],     "CWDT");
00093     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterHC_OPT_REG],       "HC_OPT_REG");
00094     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterCSBO],     "CSBO");
00095     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterGENERAL1],     "GENERAL1");
00096     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterGENERAL2],     "GENERAL2");
00097     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterGENERAL3],     "GENERAL3");
00098     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterGENERAL4],     "GENERAL4");
00099     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterGENERAL5],     "GENERAL5");
00100     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterMODE_REG],     "MODE_REG");
00101     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterPU_GWE],       "PU_GWE");
00102     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterPU_GTS],       "PU_GTS");
00103     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterMFWR],     "MFWR");
00104     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterCCLK_FREQ],        "CCLK_FREQ");
00105     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterSEU_OPT],      "SEU_OPT");
00106     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterEXP_SIGN],     "EXP_SIGN");
00107     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterRDBK_SIGN],        "RDBK_SIGN");
00108     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterBOOSTS],       "BOOSTS");
00109     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterEYE_MASK],     "EYE_MASK");
00110     BOOST_CHECK_EQUAL(Spartan6::sRegisterName[Spartan6::eRegisterCBC_REG],      "CBC_REG");
00111 
00112     // members tested:
00113     //      Spartan6::sCommandName and ECommand
00114     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandNULL],           "NULL");
00115     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandWCFG],           "WCFG");
00116     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandMFW],            "MFW");
00117     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandLFRM],           "LFRM");
00118     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandRCFG],           "RCFG");
00119     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandSTART],      "START");
00120     BOOST_CHECK_EQUAL(Spartan6::sCommandName[6],            "[UNKNOWN COMMAND 6]");
00121     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandRCRC],           "RCRC");
00122     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandAGHIGH],     "AGHIGH");
00123     BOOST_CHECK_EQUAL(Spartan6::sCommandName[9],          "[UNKNOWN COMMAND 9]");
00124     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandGRESTORE],       "GRESTORE");
00125     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandSHUTDOWN],       "SHUTDOWN");
00126     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandDESYNC],     "DESYNC");
00127     BOOST_CHECK_EQUAL(Spartan6::sCommandName[Spartan6::eCommandIPROG],      "IPROG");
00128 
00129     // build the file paths
00130     boost::filesystem::path regressionPath 
00131         = torc::common::DirectoryTree::getExecutablePath() / "regression";
00132     boost::filesystem::path generatedPath = regressionPath / "Spartan6UnitTest.generated.bit";
00133     //boost::filesystem::path generatedPath = regressionPath / "xc6slx4.partial.even.bit";
00134     boost::filesystem::path referencePath = regressionPath / "Spartan6UnitTest.reference.bit";
00135 
00136     // read the bitstream
00137     std::fstream fileStream(referencePath.string().c_str(), std::ios::binary | std::ios::in);
00138     //std::fstream fileStream(generatedPath.string().c_str(), std::ios::binary | std::ios::in);
00139     BOOST_REQUIRE(fileStream.good());
00140     Spartan6 bitstream;
00141     bitstream.read(fileStream, false);
00142     // write the bitstream digest to the console
00143     //std::cout << bitstream << std::endl;
00144 
00145     std::string designName = bitstream.getDesignName();
00146     std::string deviceName = bitstream.getDeviceName();
00147     std::string designDate = bitstream.getDesignDate();
00148     std::string designTime = bitstream.getDesignTime();
00149     torc::common::DeviceDesignator deviceDesignator(deviceName);
00150     std::cout << "family of " << deviceName << " is " << deviceDesignator.getFamily() << std::endl;
00151 
00152     // write the bitstream back out
00153     std::fstream outputStream(generatedPath.string().c_str(), std::ios::binary | std::ios::out);
00154     BOOST_REQUIRE(outputStream.good());
00155     bitstream.write(outputStream);
00156     outputStream.flush();
00157 
00158     // compare the reference and generated XDL
00159     BOOST_CHECK(torc::common::fileContentsAreEqual(generatedPath, referencePath));
00160 }
00161 BOOST_AUTO_TEST_SUITE_END()
00162 
00163 } // namespace bitstream
00164 } // namespace torc