Virtex2.hpp

Go to the documentation of this file.

// Torc - Copyright 2011-2013 University of Southern California.  All Rights Reserved.
// $HeadURL$
// $Id$

// 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 3 of the 
// License, or (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See 
// the GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License along with this program.  If 
// not, see <http://www.gnu.org/licenses/>.

/// \file
/// \brief Header for the Virtex2 class.

#ifndef TORC_BITSTREAM_VIRTEX2_HPP
#define TORC_BITSTREAM_VIRTEX2_HPP

#include <boost/cstdint.hpp>
#include <boost/filesystem.hpp>
#include "torc/bitstream/VirtexBitstream.hpp"
#include "torc/bitstream/VirtexFrameAddress.hpp"
#include <map>

namespace torc { namespace architecture { class DDB; } }

namespace torc {
namespace bitstream {

namespace bitstream { class Virtex2UnitTest; }
namespace bitstream { class Virtex2FarUnitTest; }
namespace bitstream { void testVirtex2Device(const std::string& inDeviceName, 
    const boost::filesystem::path& inWorkingPath); }
namespace bitstream { void testVirtex2FullMapping(const boost::filesystem::path& inWorkingPath); }

    /// \brief Virtex2 bitstream.
    class Virtex2 : public VirtexBitstream {
        friend class torc::bitstream::bitstream::Virtex2UnitTest;
        friend class torc::bitstream::bitstream::Virtex2FarUnitTest;
        friend void torc::bitstream::bitstream::testVirtex2Device(const std::string& inDeviceName, 
            const boost::filesystem::path& inWorkingPath);
        friend void torc::bitstream::bitstream::testVirtex2FullMapping(const boost::filesystem::path& inWorkingPath);
    protected:
    // typedefs
        /// \brief Imported type name.
        typedef boost::uint32_t uint32_t;
    public:
    // enumerations
        //
        /// \brief Configuration register enumeration.
        /// \see configuration registers: UG002, v2.2, November, 2007, Table 4-19.
        enum ERegister { eRegisterCRC = 0, eRegisterFAR, eRegisterFDRI, eRegisterFDRO, 
            eRegisterCMD, eRegisterCTL, eRegisterMASK, eRegisterSTAT, eRegisterLOUT, eRegisterCOR, 
            eRegisterMFWR, eRegisterFLR, eRegisterKEY, eRegisterCBC, eRegisterIDCODE, 
            eRegisterCount };
        //
        /// \brief Configuration command enumeration for eRegisterCMD.
        /// \see CMD register commands: UG002, v2.2, November, 2007, Table 4-23.
        enum ECommand { eCommandNULL = 0, eCommandWCFG, eCommandMFWR, eCommandLFRM, eCommandRCFG, 
            eCommandSTART, eCommandRCAP, eCommandRCRC, eCommandAGHIGH, eCommandSWITCH, 
            eCommandGRESTORE, eCommandSHUTDOWN, eCommandGCAPTURE, eCommandDESYNCH, eCommandCount };
        //
        /// \brief Frame Address Register subfields.
        /// \see Frame Address Register Description: UG002, v2.2, November, 2007, Figure 4-32.
        enum EFar {
            eFarMaskBlockType   =   0x06000000,     eFarShiftBlockType =    25,
            eFarMaskMajor       =   0x01fe0000,     eFarShiftMajor =        17,
            eFarMaskMinor       =   0x0001fe00,     eFarShiftMinor =         9,
        };
        /// \brief Frame Address Register block type constants.
        enum EFarBlockType { eFarBlockType0 = 0, eFarBlockType1, eFarBlockType2, eFarBlockType3, 
            eFarBlockType4, eFarBlockType5, eFarBlockType6, eFarBlockType7, eFarBlockTypeCount };
        /// \brief Major column types.
        /// \details These are defined and used for internal purposes only, and are not derived 
        ///     from any Xilinx documentation.
        enum EColumnType { eColumnTypeEmpty = 0, eColumnTypeBram, eColumnTypeClb, eColumnTypeClock,
            eColumnTypeDsp, eColumnTypeGtx, eColumnTypeIob, eColumnTypeCount };
    protected:
    // members
//      /// \brief Configuration controller registers.
//      uint32_t mRegister[eRegisterCount];
        /// \brief Packet type names.
        static const char* sPacketTypeName[ePacketTypeCount];
        /// \brief Packet opcode names.
        static const char* sOpcodeName[eOpcodeCount];
        /// \brief Configuration register names.
        static const char* sRegisterName[eRegisterCount];
        /// \brief Configuration command names.
        static const char* sCommandName[eCommandCount];
        /// \brief Configuration Options Register (COR) subfields.
        static const Subfield sCOR[];
        /// \brief Status Register (STAT) subfields.
        static const Subfield sSTAT[];
        /// \brief Control Register (CTL) subfields.
        static const Subfield sCTL[];
        /// \brief Control Mask Register (MASK) subfields.
        static const Subfield sMASK[];
    // functions
        string mPrivateDeviceName;
    public:
    // constructors
        /// \brief Basic constructor.
        Virtex2(void) : VirtexBitstream() {
//          for(int i = 0; i < eRegisterCount; i++) mRegister[i] = 0;
            // initialize the column type widths for this family
            mColumnDefs.resize(eColumnTypeCount);
            mColumnDefs[eColumnTypeEmpty]   = ColumnDef("Empty",    0,  0,  0,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeBram]    = ColumnDef("Bram",     0, 64, 22,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeClb]     = ColumnDef("Clb",     22,  0,  0,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeClock]   = ColumnDef("Clock",    4,  0,  0,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeGtx]     = ColumnDef("Gtx",     22,  0,  0,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeIob]     = ColumnDef("Iob",      4,  0,  0,  0,  0,  0,  0,  0);
            // map type type names to column types
            mTileTypeNameToColumnType["BRAM0"]      = eColumnTypeBram;
            mTileTypeNameToColumnType["CENTER"]     = eColumnTypeClb;
            mTileTypeNameToColumnType["CLKV"]       = eColumnTypeClock;
            mTileTypeNameToColumnType["LR_IOIS"]    = eColumnTypeGtx;
            mTileTypeNameToColumnType["LTERM010"]   = eColumnTypeIob;
            mTileTypeNameToColumnType["RTERM010"]   = eColumnTypeIob;
        }
    // functions
        /// \brief Return the masked value for a subfield of the specified register.
        static uint32_t makeSubfield(ERegister inRegister, const std::string& inSubfield, 
            const std::string& inSetting);
        /// \note This function should be called after the bitstream header has been read.
        virtual void readPackets(std::istream& inStream);
    // functions
        /// \brief Initialize the device information.
        virtual void initializeDeviceInfo(const std::string& inDeviceName);
        /// \brief Initialize the maps between frame indexes and frame addresses.
        /// \detail This is generally only useful for internal purposes.
        virtual void initializeFrameMaps(void);
        /// \brief Loads full bitstream frames into block data structure.
        void initializeFullFrameBlocks(void);
        /// \brief Returns frames for queried bitstream coordinates
        VirtexFrameBlocks getBitstreamFrames(uint32_t inBlockCount, uint32_t inBitCol);
        /// \brief Returns frames for queried xdl coordinates
        VirtexFrameBlocks getXdlFrames(uint32_t inBlockCount, uint32_t inXdlCol);
    // inserters
        /// \brief Insert the bitstream header into an output stream.
        friend std::ostream& operator<< (std::ostream& os, const Virtex2& rhs);
    // inner classes
        class FrameAddress : public VirtexFrameAddress {
        protected:
            virtual void assign(uint32_t inAddress) {
                mBlockType = EFarBlockType((inAddress & eFarMaskBlockType) >> eFarShiftBlockType);
                mMajor = (inAddress & eFarMaskMajor) >> eFarShiftMajor;
                mMinor = (inAddress & eFarMaskMinor) >> eFarShiftMinor;
            }
        public:
            FrameAddress(void) : mBlockType(eFarBlockType0), mMajor(0), mMinor(0) {}
            FrameAddress(EFarBlockType inBlockType, uint32_t inMajor, uint32_t inMinor) : 
                mBlockType(inBlockType), mMajor(inMajor), mMinor(inMinor) {}
            FrameAddress(uint32_t inAddress) { assign(inAddress); }
            EFarBlockType mBlockType;
            uint32_t mMajor;
            uint32_t mMinor;
            virtual bool operator== (const VirtexFrameAddress& vrhs) const {
                const FrameAddress& rhs = reinterpret_cast<const FrameAddress&>(vrhs);
                return mBlockType == rhs.mBlockType && mMajor == rhs.mMajor && mMinor == rhs.mMinor;
            }
            virtual bool operator< (const VirtexFrameAddress& vrhs) const {
                const FrameAddress& rhs = reinterpret_cast<const FrameAddress&>(vrhs);
                int diffBlockType = mBlockType - rhs.mBlockType;
                if(diffBlockType) return diffBlockType < 0;
                int diffMajor = mMajor - rhs.mMajor;
                if(diffMajor) return diffMajor < 0;
                return mMinor < rhs.mMinor;
            }
            friend std::ostream& operator<< (std::ostream& os, const Virtex2::FrameAddress& rhs) {
                return os << rhs.mBlockType << "(" << rhs.mMajor << "." << rhs.mMinor << ")";
            }
        private:
            //operator uint32_t (void) const {
            //  return 
            //      ((mTopBottom << eFarShiftTopBottom) & eFarMaskTopBottom) | 
            //      ((mBlockType << eFarShiftBlockType) & eFarMaskBlockType) |
            //      ((mRow << eFarShiftRow) & eFarMaskRow) | 
            //      ((mMajor << eFarShiftMajor) & eFarMaskMajor) | 
            //      ((mMinor << eFarShiftMinor) & eFarMaskMinor);
            //}
        };
    // accessors
        virtual uint32_t getFrameLength(void) const {
            using namespace torc::common;
            // Frame Length Register Value: UG002, v2.2, November 5, 2007, Table 4-15.
            switch(mDevice) {
                case eXC2V40: return 26;
                case eXC2V80: return 46;
                case eXC2V250: return 66;
                case eXC2V500: return 86;
                case eXC2V1000: return 106;
                case eXC2V1500: return 126;
                case eXC2V2000: return 146;
                case eXC2V3000: return 166;
                case eXC2V4000: return 206;
                case eXC2V6000: return 246;
                case eXC2V8000: return 286;
                default: return 0;
            }
        }
        /// \brief Return the number of frame rows for the current device.
        virtual uint32_t getFrameRowCount(void) const { return 0; }
    protected:
    // typedefs
        /// \brief Map from frame index to frame address.
        typedef std::map<uint32_t, Virtex2::FrameAddress> FrameIndexToAddress;
        /// \brief Map from frame address to frame index.
        typedef std::map<Virtex2::FrameAddress, uint32_t> FrameAddressToIndex;
        /// \brief Array of vectors to store frame indexes of each block type
        typedef std::vector<uint32_t> IndexVector;

    // members
        /// \brief Map of frame indexes to frame addresses.
        FrameIndexToAddress mFrameIndexToAddress;
        /// \brief Map of frame addressee to frame indexes.
        FrameAddressToIndex mFrameAddressToIndex;
        /// \brief Vector to store frame indexes of XDL columns.
        IndexVector mBitColumnIndexes[Virtex2::eFarBlockTypeCount];
        /// \brief Vector to store frame indexes of Bitstream columns.
        IndexVector mXdlColumnIndexes[Virtex2::eFarBlockTypeCount];
        /// \brief Array to hold frame index boundaries for blocks.
        uint32_t mBlockFrameIndexBounds[Virtex2::eFarBlockTypeCount];
        /// \brief Map of XDL column indexes to bitstream column indexes.
        std::map<uint32_t, uint32_t> mXdlColumnToBitColumn;
    };

} // namespace bitstream
} // namespace torc

#endif // TORC_BITSTREAM_VIRTEX2_HPP