TORC: torc/bitstream/Spartan6BitstreamUnitTest.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/Spartan6BitstreamUnitTest.cpp $
00003 // $Id: Spartan6BitstreamUnitTest.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 SpartanBitstream class.
00018 
00019 #include <boost/test/unit_test.hpp>
00020 #include "torc/bitstream/Spartan6Bitstream.hpp"
00021 #include "torc/bitstream/Spartan6Packet.hpp"
00022 #include "torc/bitstream/Spartan6.hpp"
00023 #include "torc/common/DeviceDesignator.hpp"
00024 #include "torc/bitstream/OutputStreamHelpers.hpp"
00025 #include "torc/common/TestHelpers.hpp"
00026 #include "torc/common/DirectoryTree.hpp"
00027 #include <fstream>
00028 #include <iostream>
00029 
00030 namespace torc {
00031 namespace bitstream {
00032 
00033 BOOST_AUTO_TEST_SUITE(bitstream)
00034 
00035 /// \brief Unit test for the Spartan6Bitstream class.
00036 BOOST_AUTO_TEST_CASE(Spartan6BitstreamCrcUnitTest) {
00037     std::fstream fileStream("Spartan6UnitTest.reference.bit", std::ios::binary | std::ios::in);
00038     Spartan6 bitstream;
00039     bitstream.read(fileStream, false);
00040     std::cout << bitstream << std::endl;
00041     bitstream.preflightPackets();
00042     BOOST_REQUIRE(true);
00043 }
00044 /// \brief Unit test for the Spartan6Bitstream class.
00045 BOOST_AUTO_TEST_CASE(Spartan6BistreamUnitTest) {
00046 
00047     // build the file paths
00048     boost::filesystem::path regressionPath 
00049         = torc::common::DirectoryTree::getExecutablePath() / "regression";
00050     boost::filesystem::path generatedPath = regressionPath / "Spartan6UnitTest.generated.bit";
00051     boost::filesystem::path referencePath = regressionPath / "Spartan6UnitTest.reference.bit";
00052 
00053     // read the reference bitstream
00054     std::fstream fileStream1(referencePath.string().c_str(), std::ios::binary | std::ios::in);
00055     BOOST_REQUIRE(fileStream1.good());
00056     Spartan6 bitstream1;
00057     bitstream1.read(fileStream1, false);
00058     // find the type 2 write packet
00059     Spartan6Packet frameContents;
00060     Spartan6::const_iterator p = bitstream1.begin();
00061     Spartan6::const_iterator e = bitstream1.end();
00062     while(p < e) { 
00063         if(p->isType2() && !p->isSyncWord1() && p->isWrite()) { frameContents = *p; break; }
00064         p++;
00065     }
00066 
00067     // declare a bitstream of unspecified architectures
00068     Spartan6Bitstream bitstream;
00069     // prepare the bitstream header
00070     bitstream.setDesignName("Spartan6UnitTest.reference.ncd;UserID=0xFFFFFFFF");
00071     bitstream.setDeviceName("6slx25csg324");
00072     bitstream.setDesignDate("2011/02/09");
00073     bitstream.setDesignTime("13:28:37");
00074 
00075     // construct and add packets to the bitstream
00076     Spartan6Packet dummy(Spartan6::eSynchronizationDummy);
00077     Spartan6Packet nop(Spartan6Packet::makeHeader(Spartan6::ePacketType1, Spartan6::eOpcodeNOP, 
00078         0, 0));
00079     // dummy words
00080     bitstream.insert(bitstream.end(), 8, dummy);
00081     // sync
00082     bitstream.push_back(Spartan6Packet(Spartan6::eSynchronizationSync0));
00083     bitstream.push_back(Spartan6Packet(Spartan6::eSynchronizationSync1));
00084     // reset CRC command
00085     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCMD, Spartan6::eCommandRCRC));
00086     // nop command
00087     bitstream.push_back(nop);
00088     // FLR command
00089     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterFLR, 0x0488));
00090     // configuration options register 1 
00091     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCOR1, 
00092             Spartan6::makeSubfield(Spartan6::eRegisterCOR1, "Drive_Awake", "0") |
00093             Spartan6::makeSubfield(Spartan6::eRegisterCOR1, "CRC_Bypass", "0") |
00094             Spartan6::makeSubfield(Spartan6::eRegisterCOR1, "DonePipe", "No") |
00095             Spartan6::makeSubfield(Spartan6::eRegisterCOR1, "DriveDone", "No") |
00096             Spartan6::makeSubfield(Spartan6::eRegisterCOR1, "StartupClk", "Cclk") |
00097         0x3d00)); // No documentation for this Value
00098     // configuration options register 2
00099     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCOR2, 
00100             Spartan6::makeSubfield(Spartan6::eRegisterCOR2, "Reset_on_err", "Disable") |
00101             Spartan6::makeSubfield(Spartan6::eRegisterCOR2, "DONE_cycle", "5") |
00102             Spartan6::makeSubfield(Spartan6::eRegisterCOR2, "LCK_cycle", "NoWait") |
00103             Spartan6::makeSubfield(Spartan6::eRegisterCOR2, "GTS_cycle", "6") |
00104             Spartan6::makeSubfield(Spartan6::eRegisterCOR2, "GWE_cycle", "[UNDEFINED 6]") |
00105         0));
00106     // write the ID code
00107     bitstream.push_back(Spartan6Packet::makeType1Write32(Spartan6::eRegisterIDCODE, 0x04004093));
00108     // control register mask
00109     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterMASK, 
00110             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "DEC", "Writable") |
00111             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "Security", "Protected") |
00112             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "Persist", "Writable") |
00113             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "USE_EFUSE_KEY", "Writable") |
00114             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "CRC_EXTSTAT_DISABLE", "Writable") |
00115             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "RESERVED", "Writable") |
00116         0x80)); // No documentation for this Value
00117     // control register 
00118     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCTL, 
00119             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "DEC", "No") |
00120             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "Security", "None") |
00121             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "Persist", "No") |
00122             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "USE_EFUSE_KEY", "0") |
00123             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "CRC_EXTSTAT_DISABLE", "0") |
00124         0x0081)); // No documentation for this Value
00125     bitstream.insert(bitstream.end(), 17, nop);
00126     // SEU_OPT register 
00127     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterSEU_OPT, 
00128             Spartan6::makeSubfield(Spartan6::eRegisterSEU_OPT, "SEU_FREQ", "0x01be") |
00129             Spartan6::makeSubfield(Spartan6::eRegisterSEU_OPT, "SEU_RUN_ON_ERR", "Run") |
00130             Spartan6::makeSubfield(Spartan6::eRegisterSEU_OPT, "GLUT_MASK", "Unmask") |
00131             Spartan6::makeSubfield(Spartan6::eRegisterSEU_OPT, "SEU_ENABLE", "DISABLE") |
00132         0x3cc0)); // No documentation for this Value
00133     // PWRDN_REG register 
00134     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterPWRDN_REG, 
00135             Spartan6::makeSubfield(Spartan6::eRegisterPWRDN_REG, "EN_EYES", "Disable") |
00136             Spartan6::makeSubfield(Spartan6::eRegisterPWRDN_REG, "FILTER", "0") |
00137             Spartan6::makeSubfield(Spartan6::eRegisterPWRDN_REG, "EN_PGSR", "No") |
00138             Spartan6::makeSubfield(Spartan6::eRegisterPWRDN_REG, "EN_PWRDN", "0") |
00139             Spartan6::makeSubfield(Spartan6::eRegisterPWRDN_REG, "KEEP_SCLK", "1") |
00140         0x0880)); // No documentation for this Value
00141     // CBC write command
00142     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCBC_REG, 0));
00143     // HC_OPT_REG register 
00144     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterHC_OPT_REG, 
00145             Spartan6::makeSubfield(Spartan6::eRegisterHC_OPT_REG, "INIT", "0") |
00146         0x1f)); // No documentation for this Value
00147     // CWDT write command
00148     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCWDT, 0xffff));
00149     // PU_GTS write command
00150     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterPU_GTS, 0x0005));
00151     // MFWR write command
00152     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterMFWR, 0x0004));
00153     // PU_GWE write command
00154     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterPU_GWE, 0x0100));
00155     // GENERAL2 write command
00156     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterGENERAL2, 0x0000));
00157     // GENERAL3 write command
00158     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterGENERAL3, 0x0000));
00159     // GENERAL4 write command
00160     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterGENERAL4, 0x0000));
00161     // GENERAL5 write command
00162     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterGENERAL5, 0x0000));
00163     // MODE_REG register 
00164     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterMODE_REG, 
00165             Spartan6::makeSubfield(Spartan6::eRegisterMODE_REG, "NEW_MODE", "No") |
00166             Spartan6::makeSubfield(Spartan6::eRegisterMODE_REG, "BUSWIDTH", "0") |
00167             Spartan6::makeSubfield(Spartan6::eRegisterMODE_REG, "BOOTMODE", "0") |
00168             Spartan6::makeSubfield(Spartan6::eRegisterMODE_REG, "BOOTVSEL", "[READ ONLY]") |
00169         0));
00170     // EXP_SIGN write command
00171     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterEXP_SIGN, 0x1be2));
00172     // EXP_SIGN write command
00173     bitstream.push_back(Spartan6Packet::makeType1Write32(Spartan6::eRegisterRDBK_SIGN, 0x00000000));
00174     // nop command
00175     bitstream.push_back(nop);
00176     bitstream.push_back(nop);
00177     // frame address register
00178     bitstream.push_back(Spartan6Packet::makeType1Write32(Spartan6::eRegisterFARMAJ, 0x00000000));
00179     // enable configuration write command
00180     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCMD, Spartan6::eCommandWCFG));
00181     // write 0 bytes to FDRI (in preparation for type 2 write packet)
00182     //bitstream.push_back(Spartan6Packet::makeNullType2Write(Spartan6::eRegisterFDRI));
00183     // note that we do not release the buffer as it will be taken over by the packet
00184     //size_t length = 0x00061cca;
00185     //uint16_t* buffer = new uint16_t[length];
00186     //uint16_t* ptr = buffer + length - 1;
00187     //while(ptr >= buffer) *ptr-- = 0;
00188   //*(buffer + 0) = 0xabcd;
00189     //*(buffer + length - 1) = 0x0123;
00190     //bitstream.push_back(Spartan6Packet::makeType2Write(0x00061cca, Spartan6::eRegisterFDRI, buffer));
00191     bitstream.push_back(frameContents);
00192     // CRC Word? 
00193     uint16_t crcEndWord = 0x0015;
00194     bitstream.push_back(Spartan6Packet(crcEndWord));
00195     // CWDT write command
00196     size_t length = 15;
00197     uint16_t* buffer = new uint16_t[length];
00198     uint16_t* ptr = buffer + length - 1;
00199     while(ptr >= buffer) *ptr-- = 0x2000;
00200     bitstream.push_back(Spartan6Packet::makeType1Write(length, Spartan6::eRegisterCWDT, buffer));
00201     // 9 NOPs
00202     bitstream.insert(bitstream.end(), 9, nop);
00203     // restore command
00204     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCMD, 
00205         Spartan6::eCommandGRESTORE));
00206     // last frame command
00207     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCMD, 
00208         Spartan6::eCommandLFRM));
00209     // 4 NOPs
00210     bitstream.insert(bitstream.end(), 4, nop);
00211     // restore command
00212     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCMD, 
00213         Spartan6::eCommandGRESTORE));
00214     // start command
00215     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCMD, 
00216         Spartan6::eCommandSTART));
00217     // control register mask
00218     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterMASK, 
00219             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "DEC", "Writable") |
00220             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "Security", "Writable") |
00221             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "Persist", "Writable") |
00222             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "USE_EFUSE_KEY", "Writable") |
00223             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "CRC_EXTSTAT_DISABLE", "Writable") |
00224             Spartan6::makeSubfield(Spartan6::eRegisterMASK, "RESERVED", "Writable") |
00225         0x80)); // No documentation for this Value
00226     // control register 
00227     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCTL, 
00228             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "DEC", "No") |
00229             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "Security", "None") |
00230             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "Persist", "No") |
00231             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "USE_EFUSE_KEY", "0") |
00232             Spartan6::makeSubfield(Spartan6::eRegisterCTL, "CRC_EXTSTAT_DISABLE", "0") |
00233         0x81)); // No documentation for this Value
00234     // write the CRC value
00235     bitstream.push_back(Spartan6Packet::makeType1Write32(Spartan6::eRegisterCRC, 0x0002109d));
00236     // desync command
00237     bitstream.push_back(Spartan6Packet::makeType1Write(Spartan6::eRegisterCMD, 
00238         Spartan6::eCommandDESYNC));
00239     bitstream.insert(bitstream.end(), 14, nop);
00240 
00241     // write the bitstream back out
00242     std::fstream outputStream(generatedPath.string().c_str(), std::ios::binary | std::ios::out);
00243     BOOST_REQUIRE(outputStream.good());
00244     bitstream.write(outputStream);
00245     outputStream.flush();
00246 
00247     // read the bitstream
00248     std::fstream fileStream2(generatedPath.string().c_str(), std::ios::binary | std::ios::in);
00249     BOOST_REQUIRE(fileStream2.good());
00250     Spartan6 bitstream2;
00251     bitstream2.read(fileStream2, false);
00252     // write the bitstream digest to the console
00253     std::cout << bitstream2 << std::endl;
00254     std::cerr << "TYPEOF BITSTREAM: " << typeid(bitstream2).name() << std::endl;
00255 
00256     // compare the reference and generated XDL
00257     //BOOST_CHECK(fileContentsAreEqual(generatedPath, referencePath));
00258 
00259 }
00260 
00261 BOOST_AUTO_TEST_SUITE_END()
00262 
00263 } // namespace bitstream
00264 } // namespace torc
00265