torc::bitstream::VirtexBitstream Class Reference

Virtex-class bitstream. More...

#include <VirtexBitstream.hpp>

Inheritance diagram for torc::bitstream::VirtexBitstream:

Collaboration diagram for torc::bitstream::VirtexBitstream:

Public Types
enum	{ eBlockTypeCount = 8 }
	The block type count is fixed at eight across all Xilinx architectures. More...
enum	EBitstreamType { eBitstreamTypeFull, eBitstreamTypePartialActive, eBitstreamTypePartialShutdown }
	The bitstream type to generate. Use eBitstreamFull to fully reconfigure a device, eBitstreamTypePartialActive to partially reconfigure it while it continues to run, or eBitstreamTypePartialShutdown to partially recongifure it after shutting it down. More...
enum	EFrameInclude { eFrameIncludeOnlyDirtyFrames, eFrameIncludeAllUsedFrames }
	The frames to include in a partial bitstream. Use eFrameIncludeOnlyDirtyFrames to include only dirty frames, or eFrameStateAllUsedFrames to include all allocated frames, dirty or not. Note that if not all frames were allocated, eFrameStateAllUsedFrames is not the same as a full bitstream. More...
typedef std::string	string
	Imported type name. More...
typedef boost::uint8_t	uint8_t
	Imported type name. More...
typedef boost::uint16_t	uint16_t
	Imported type name. More...
typedef torc::common::EDevice	EDevice
	Imported type name. More...
typedef std::map< std::string, uint32_t >	TileTypeNameToColumnType
	Mapping from tile type names to column types. More...
typedef std::map< uint16_t, uint32_t >	TileTypeIndexToColumnType
	Mapping from tile indexes to column types. More...
enum	EPacketType { ePacketType1 = 1, ePacketType2, ePacketTypeCount = 8 }
	Packet type enumeration. More...
enum	EOpcode {   eOpcodeNOP = 0, eOpcodeRead, eOpcodeWrite, eOpcodeReserved,   eOpcodeCount }
	Packet opcode enumeration. More...
enum	EPacket {   ePacketMaskType = 0xe0000000, ePacketShiftType = 29, ePacketMaskOpcode = 0x18000000, ePacketShiftOpcode = 27,   ePacketMaskType1Address = 0x07ffe000, ePacketShiftType1Address = 13, ePacketMaskType1Reserved = 0x00001800, ePacketShiftType1Reserved = 11,   ePacketMaskType1Count = 0x000007ff, ePacketShiftType1Count = 0, ePacketMaskType2Count = 0x07ffffff, ePacketShiftType2Count = 0 }
	Packet subfields. More...
enum	ESynchronization { eSynchronizationDummy = 0xffffffff, eSynchronizationSync = 0xaa995566, eSynchronizationBusWidthSync = 0x000000bb, eSynchronizationBusWidthDetect = 0x11220044 }
	Synchronization words. More...
typedef VirtexFrame	frame_t
	FrameSet frame type. More...
typedef VirtexFrame::word_t	word_t
	FrameSet word type. More...

Public Member Functions
	VirtexBitstream (void)
	Basic constructor. More...
virtual void	readPackets (std::istream &inStream)
	Read bitstream packets from a stream. More...
virtual void	writePackets (std::ostream &inStream)
	Write bitstream packets to a stream. More...
virtual void	readFramePackets (void)
	Read frame data into the frame blocks structure. More...
virtual void	updateFramePackets (EBitstreamType inBitstreamType=eBitstreamTypeFull, EFrameInclude inFrameInclusion=eFrameIncludeAllUsedFrames)
	Update the bitstream frame packets By default this updates the bitstream with full frame data. More...
virtual void	generateBitstream (EBitstreamType inBitstreamType=eBitstreamTypeFull, EFrameInclude inFrameInclusion=eFrameIncludeAllUsedFrames)
	Discard existing packets and generate bitstream packets from frame data. By default this generates packets for a full bitstream. More...
virtual VirtexPacketVector::iterator	deleteFramePackets (void)
	Discard the existing frame packets and return an iterator to the start position. More...
virtual VirtexPacketVector	generateFullBitstreamPackets (void)
	Return a packet vector with full frame data. More...
virtual VirtexPacketVector	generateFullBitstreamPrefix (void)
	Return a packet vector with the full bitstream prefix. More...
virtual VirtexPacketVector	generateFullBitstreamSuffix (void)
	Return a packet vector with the full bitstream suffix. More...
virtual VirtexPacketVector	generatePartialBitstreamPackets (EFrameInclude inFrameInclusion)
	Return a packet vector with partial frame data. More...
virtual VirtexPacketVector	generatePartialBitstreamPrefix (EBitstreamType inBitstreamType)
	Return a packet vector with the partial bitstream prefix. More...
virtual VirtexPacketVector	generatePartialBitstreamSuffix (EBitstreamType inBitstreamType)
	Return a packet vector with the partial bitstream suffix. More...
virtual void	preflightPackets (void)
	Preflight the packets. More...
virtual void	updatePacketLength (void)
	Update the header packet length. More...
iterator	insert (iterator position, const value_type &val)
	Regular std::vector inserter. More...
void	insert (iterator position, size_type n, const value_type &val)
	Regular std::vector inserter. More...
template<class InputIterator >
void	insert (iterator position, InputIterator first, InputIterator last)
	Regular std::vector inserter. More...
void	insert (VirtexPacketVector::iterator inPosition, const VirtexPacketVector &inVector)
	Insert the contents of a packet vector at the specified position. More...
void	append (const VirtexPacketVector &inVector)
	Append the contents of a packet vector to the end of the bitstream. More...
VirtexFrameBlocks &	getFrameBlocks (void)
	Return the configuration frame blocks. More...
void	write (std::ostream &inStream, uint8_t inVal)
	Write a uint8_t to the stream. More...
void	write (std::ostream &inStream, uint16_t inVal)
	Write a uint16_t to the stream. More...
void	write (std::ostream &inStream, uint32_t inVal)
	Write a uint32_t to the stream. More...
virtual void	write (std::ostream &inStream)
	Write the bitstream header and packets to a stream. More...
void	writeHeaderString (std::ostream &inStream, const string &inString)
	Write a Xilinx-style header string to the stream. More...
virtual void	readHeader (std::istream &inStream)
	Read the bitstream header. More...
void	cleanDateAndTime (void)
	Clean up the header date and time by replacing embedded spaces with zeros. More...
virtual void	initializeDeviceInfo (const std::string &inDeviceName)
	Initialize the maps between frame indexes and frame addresses. This is generally only useful for internal purposes. More...
virtual void	initializeFrameMaps (void)
	Initialize the maps between frame indexes and frame addresses. This is generally only useful for internal purposes. More...
virtual void	writeDeviceInfo (std::ostream &inStream, const std::string &inDeviceName)
	Output static device information to a stream. More...
void	setDeviceInfo (const DeviceInfo &rhs)
	Assign static device information for the current bitstream. More...
void	setDevice (const std::string &inDeviceName)
	Assign the device enumeration constant for the given device name. More...
virtual void	read (std::istream &inStream, bool inCleanDateAndTime=true)
	Read the bitstream header and packets from a stream. More...
virtual void	writeHeader (std::ostream &inStream)
	Write the bitstream header to the stream. More...
void	setDesignName (const string &inDesignName)
	Set the design name. More...
void	setDeviceName (const string &inDeviceName)
	Set the device name. More...
void	setDesignDate (const string &inDesignDate)
	Set the design date. More...
void	setDesignTime (const string &inDesignTime)
	Set the design time. More...
const string &	getDesignName (void) const
	Return the design name. More...
const string &	getDeviceName (void) const
	Return the device name. More...
const string &	getDesignDate (void) const
	Return the design date. More...
const string &	getDesignTime (void) const
	Return the design time. More...
uint32_t	getBitstreamByteLength (void) const
	Return the bitstream packet length in bytes. More...
uint32_t	getHeaderByteLength (void) const
	Return the bitstream header length in bytes. More...
virtual uint32_t	getFrameLength (void) const
	Return the frame length for the current device. More...

Static Public Member Functions
static bool	expect (std::istream &inStream, uint8_t inExpected)
	Look for the expected uint8_t in the stream and return true if it matches. More...
static bool	expect (std::istream &inStream, uint16_t inExpected)
	Look for the expected uint16_t in the stream and return true if it matches. More...
static bool	expect (std::istream &inStream, uint32_t inExpected)
	Look for the expected uint32_t in the stream and return true if it matches. More...
static void	readHeaderString (std::istream &inStream, string &outString)
	Read and return a bitstream header string. More...
static bool	readHeader (std::istream &inStream, string &outDesignName, string &outDeviceName, string &outDesignDate, string &outDesignTime, uint32_t &outBitstreamLength, uint32_t &outHeaderLength)
	Read a bitstream header, and return its fields. More...
static void	writeSubfieldSettings (std::ostream &inStream, uint32_t inWord, const Subfield *inSubfields)
	Insert 32 bit subfield settings into an output stream. More...
static void	writeSubfieldSettings (std::ostream &inStream, uint16_t inWord, const Subfield *inSubfields)
	Insert 16 bit subfield settings into an output stream. More...

Data Fields
EDevice	mDevice
	Bitstream device enumeration. More...
string	mDesignName
	Header design name. More...
string	mDeviceName
	Header device name. More...
string	mDesignDate
	Header design date. More...
string	mDesignTime
	Header design time. More...
uint32_t	mBitstreamByteLength
	Bitstream packet length in bytes. More...
uint32_t	mHeaderByteLength
	Header length in bytes. More...
ColumnDefVector	mColumnDefs
	Column type widths. More...
TileTypeNameToColumnType	mTileTypeNameToColumnType
TileTypeIndexToColumnType	mTileTypeIndexToColumnType
DeviceInfo	mDeviceInfo
	Device information. More...
FrameSet< VirtexFrame >	mBlock [Bitstream::eBlockTypeCount]
	FrameSets for each of the eight block types. More...

Protected Types
typedef boost::uint32_t	uint32_t
	Imported type name. More...

Protected Member Functions
void	unimplemented (std::string inName)
	Reports the named function as not yet implemented in the current architecture. More...
virtual void	updateCrc16 (torc::common::DeviceDesignator::EFamily inFamily)
	Update CRC-16 packets. More...
virtual void	updateCrc32 (torc::common::DeviceDesignator::EFamily inFamily)
	Update CRC-32 packets. More...
template<class ARCH >
void	readFramePackets4567 (uint32_t inBlockFrameIndexBounds[], std::map< typename ARCH::FrameAddress, uint32_t > &inFrameAddressToIndex, std::map< uint32_t, typename ARCH::FrameAddress > &inFrameIndexToAddress)
	Read frame packets in for Virtex4/5/6/7 devices. More...
template<class ARCH >
VirtexPacketVector::iterator	deleteFramePackets4567 (void)
	Discard the existing frame packets for Virtex4/5/6/7 devices. More...
template<class ARCH >
VirtexPacketVector	generateFullBitstreamPackets4567 (uint32_t inBlockFrameIndexBounds[])
	Return a packet vector with full frame data for Virtex4/5/6/7 devices. More...
template<class ARCH >
VirtexPacketVector	generatePartialBitstreamPackets4567 (EFrameInclude inFrameInclusion, std::map< typename ARCH::FrameAddress, uint32_t > &inFrameAddressToIndex, std::map< uint32_t, typename ARCH::FrameAddress > &inFrameIndexToAddress)
	Return a packet vector with partial frame data for Virtex4/5/6/7 devices. More...

Protected Attributes
VirtexFrameBlocks	mFrameBlocks
	Input Frame blocks. More...

Friends
class	torc::bitstream::bitstream::VirtexBitstreamUnitTest

Detailed Description

Virtex-class bitstream.

Definition at line 35 of file VirtexBitstream.hpp.

Member Typedef Documentation

typedef torc::common::EDevice torc::bitstream::Bitstream::EDevice

inherited

Imported type name.

Definition at line 64 of file bitstream/Bitstream.hpp.

typedef VirtexFrame torc::bitstream::FrameBlocks< VirtexFrame >::frame_t

inherited

FrameSet frame type.

Definition at line 83 of file FrameSet.hpp.

typedef std::string torc::bitstream::Bitstream::string

inherited

Imported type name.

Todo:

Bitstream access needs to be changed from public back to protected.

Definition at line 60 of file bitstream/Bitstream.hpp.

typedef std::map<uint16_t, uint32_t> torc::bitstream::Bitstream::TileTypeIndexToColumnType

inherited

Mapping from tile indexes to column types.

Definition at line 254 of file bitstream/Bitstream.hpp.

typedef std::map<std::string, uint32_t> torc::bitstream::Bitstream::TileTypeNameToColumnType

inherited

Mapping from tile type names to column types.

Definition at line 251 of file bitstream/Bitstream.hpp.

typedef boost::uint16_t torc::bitstream::Bitstream::uint16_t

inherited

Imported type name.

Definition at line 62 of file bitstream/Bitstream.hpp.

typedef boost::uint32_t torc::bitstream::VirtexBitstream::uint32_t

protected

Imported type name.

Definition at line 41 of file VirtexBitstream.hpp.

typedef boost::uint8_t torc::bitstream::Bitstream::uint8_t

inherited

Imported type name.

Definition at line 61 of file bitstream/Bitstream.hpp.

typedef VirtexFrame ::word_t torc::bitstream::FrameBlocks< VirtexFrame >::word_t

inherited

FrameSet word type.

Definition at line 85 of file FrameSet.hpp.

Member Enumeration Documentation

anonymous enum

inherited

The block type count is fixed at eight across all Xilinx architectures.

Enumerator
eBlockTypeCount

Definition at line 44 of file bitstream/Bitstream.hpp.

{ eBlockTypeCount = 8 };

enum torc::bitstream::Bitstream::EBitstreamType

inherited

The bitstream type to generate. Use eBitstreamFull to fully reconfigure a device, eBitstreamTypePartialActive to partially reconfigure it while it continues to run, or eBitstreamTypePartialShutdown to partially recongifure it after shutting it down.

Enumerator
eBitstreamTypeFull
eBitstreamTypePartialActive
eBitstreamTypePartialShutdown

Definition at line 49 of file bitstream/Bitstream.hpp.

                            { eBitstreamTypeFull, eBitstreamTypePartialActive, 
            eBitstreamTypePartialShutdown };

enum torc::bitstream::Bitstream::EFrameInclude

inherited

The frames to include in a partial bitstream. Use eFrameIncludeOnlyDirtyFrames to include only dirty frames, or eFrameStateAllUsedFrames to include all allocated frames, dirty or not. Note that if not all frames were allocated, eFrameStateAllUsedFrames is not the same as a full bitstream.

Enumerator
eFrameIncludeOnlyDirtyFrames
eFrameIncludeAllUsedFrames

Definition at line 56 of file bitstream/Bitstream.hpp.

{ eFrameIncludeOnlyDirtyFrames, eFrameIncludeAllUsedFrames };

enum torc::bitstream::VirtexPacketConstants::EOpcode

inherited

Packet opcode enumeration.

See Also

Opcode Format: UG191, v3.7, June 24, 2009, Table 6-3.

Enumerator
eOpcodeNOP
eOpcodeRead
eOpcodeWrite
eOpcodeReserved
eOpcodeCount

Definition at line 45 of file VirtexPacket.hpp.

{ eOpcodeNOP = 0, eOpcodeRead, eOpcodeWrite, eOpcodeReserved, eOpcodeCount };

enum torc::bitstream::VirtexPacketConstants::EPacket

inherited

Packet subfields.

See Also

type 1 packet format: UG071, v1.10, April 8, 2008, Table 7-2.

type 2 packet format: UG071, v1.10, April 8, 2008, Table 7-4.

type 1 packet format: XAPP151, v1.7, October 20, 2004, Figure 13.

type 2 packet format: XAPP151, v1.7, October 20, 2004, Figure 14.

Enumerator
ePacketMaskType
ePacketShiftType
ePacketMaskOpcode
ePacketShiftOpcode
ePacketMaskType1Address
ePacketShiftType1Address
ePacketMaskType1Reserved
ePacketShiftType1Reserved
ePacketMaskType1Count
ePacketShiftType1Count
ePacketMaskType2Count
ePacketShiftType2Count

Definition at line 51 of file VirtexPacket.hpp.

                     {
            // generic packet subfields
            ePacketMaskType =           0xe0000000,     ePacketShiftType =          29,
            ePacketMaskOpcode =         0x18000000,     ePacketShiftOpcode =        27,
            // type 1 packet subfields
            ePacketMaskType1Address =   0x07ffe000,     ePacketShiftType1Address =  13,
            ePacketMaskType1Reserved =  0x00001800,     ePacketShiftType1Reserved = 11,
            ePacketMaskType1Count =     0x000007ff,     ePacketShiftType1Count =     0,
            // type 2 packet subfields
            ePacketMaskType2Count =     0x07ffffff,     ePacketShiftType2Count =     0
        };

enum torc::bitstream::VirtexPacketConstants::EPacketType

inherited

Packet type enumeration.

See Also

packet type: UG071, v1.10, April 8, 2008, Tables 7-2 and 7-4.

packet type: XAPP151, v1.7, October 20, 2004, Figure 13, 14.

Enumerator
ePacketType1
ePacketType2
ePacketTypeCount

Definition at line 41 of file VirtexPacket.hpp.

{ ePacketType1 = 1, ePacketType2, ePacketTypeCount = 8 };

enum torc::bitstream::VirtexPacketConstants::ESynchronization

inherited

Synchronization words.

See Also

Configuration Sequence: UG191, v3.7, June 24, 2009, Table 6-15.

Configuration Sequence: UG071, v1.10, April 8, 2008, Table 7-11.

Configuration Sequence: XAPP511, v1.7, October 20, 2004, Figure 23.

Enumerator
eSynchronizationDummy
eSynchronizationSync
eSynchronizationBusWidthSync
eSynchronizationBusWidthDetect

Definition at line 67 of file VirtexPacket.hpp.

                              {
            eSynchronizationDummy =             0xffffffff,
            eSynchronizationSync =              0xaa995566,
            eSynchronizationBusWidthSync =      0x000000bb,
            eSynchronizationBusWidthDetect =    0x11220044
        };

Constructor & Destructor Documentation

torc::bitstream::VirtexBitstream::VirtexBitstream ( void  )

inline

Basic constructor.

Definition at line 69 of file VirtexBitstream.hpp.

                              : Bitstream(), VirtexPacketVector(), VirtexPacketConstants(), 
            VirtexFrameBlocks() {}

Member Function Documentation

void torc::bitstream::VirtexBitstream::append ( const VirtexPacketVector &  inVector )

inline

Append the contents of a packet vector to the end of the bitstream.

Definition at line 134 of file VirtexBitstream.hpp.

                                                        {
            VirtexPacketVector::insert(end(), inVector.begin(), inVector.end());
        }

void torc::bitstream::Bitstream::cleanDateAndTime ( void  )

inlineinherited

Clean up the header date and time by replacing embedded spaces with zeros.

Definition at line 183 of file bitstream/Bitstream.hpp.

                                    {
            // some versions of the tools leave spaces inside the date and time fields
            size_t pos = 0;
            while((pos = mDesignDate.find(' ', pos)) != string::npos) mDesignDate[pos] = '0';
            pos = 0;
            while((pos = mDesignTime.find(' ', pos)) != string::npos) mDesignTime[pos] = '0';
        }

Here is the caller graph for this function:

VirtexPacketVector::iterator torc::bitstream::VirtexBitstream::deleteFramePackets ( void  )

virtual

Discard the existing frame packets and return an iterator to the start position.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, and torc::bitstream::Virtex4.

Definition at line 202 of file VirtexBitstream.cpp.

                                                                       {
        unimplemented("deleteFramePackets()");
        return end();
    }

template<class ARCH >

VirtexPacketVector::iterator torc::bitstream::VirtexBitstream::deleteFramePackets4567 ( void  )

protected

Discard the existing frame packets for Virtex4/5/6/7 devices.

Todo:

Throw some meaningful exception

Definition at line 213 of file VirtexBitstream.cpp.

        {
        // walk the bitstream and look for frame packet boundaries
        // we begin with the first FAR write, and end before the first CRC write after an FDRI write
        iterator b = begin();
        iterator p = b;
        iterator e = end();
        iterator start = e;
        iterator stop = b;
        iterator fdri = b;
        while(p < e) {
            // look up the current packet
            const VirtexPacket& packet = *p;
            // start from the first FAR write
            if(start == e && packet.isWrite() && packet.getAddress() == ARCH::eRegisterFAR) {
                start = p;
            }
            // remember the last FDRI write (including a trailing Type 2 write if present)
            if(packet.isWrite() && packet.getAddress() == ARCH::eRegisterFDRI) {
                fdri = p;
                if((p+1)->isWrite() && (p+1)->isType2()) fdri++;
            }
            // stop on the first CRC after the last FDRI write
            // (Beware: the zero "address" of a Type 2 packet looks like the CRC register)
            if(stop < fdri && packet.isWrite() && packet.isType1() 
                && packet.getAddress() == ARCH::eRegisterCRC) {
                stop = p;
            }
            p++;
        }
        // look for anything unexpected
        p = start;
        while(p < stop) {
            // look up the current packet
            const VirtexPacket& packet = *p++;
            // abort if we find anything unexpected
            if(start < e && stop > b && !(
                packet.isNop() || (
                packet.isWrite() && (
                    packet.getAddress() == ARCH::eRegisterFAR ||
                    packet.getAddress() == ARCH::eRegisterLOUT ||
                    packet.getAddress() == ARCH::eRegisterFDRI ||
                    packet.getAddress() == ARCH::eRegisterCRC ||
                    (packet.getAddress() == ARCH::eRegisterCMD && packet[1] == ARCH::eCommandWCFG)
            )))) {
                /// \todo Throw some meaningful exception
                std::cerr << "Unable to safely distinguish frame packets." << std::endl;
                return e;
            }
        }
        // if we found the expected FAR -> FDRI -> CRC structure, delete the frame packets
        if(start < stop && b < stop) {
            erase(start, stop);
            return start;
        }
        // if we didn't find frame packets or delete anything, return the end iterator
        return e;
    }

Here is the call graph for this function:

static bool torc::bitstream::Bitstream::expect ( std::istream &  inStream, uint8_t  inExpected  )

inlinestaticinherited

Look for the expected uint8_t in the stream and return true if it matches.

Definition at line 89 of file bitstream/Bitstream.hpp.

                                                                     {
            // read the actual data from the stream
            uint8_t actual = 0;
            inStream.read((char*) &actual, sizeof(actual));
            // return equality
            return inExpected == actual;
        }

Here is the caller graph for this function:

static bool torc::bitstream::Bitstream::expect ( std::istream &  inStream, uint16_t  inExpected  )

inlinestaticinherited

Look for the expected uint16_t in the stream and return true if it matches.

Definition at line 97 of file bitstream/Bitstream.hpp.

                                                                      {
            // read the actual data from the stream
            uint16_t actual = 0;
            inStream.read((char*) &actual, sizeof(actual));
            // return equality
            return inExpected == ntohs(actual);
        }

static bool torc::bitstream::Bitstream::expect ( std::istream &  inStream, uint32_t  inExpected  )

inlinestaticinherited

Look for the expected uint32_t in the stream and return true if it matches.

Definition at line 105 of file bitstream/Bitstream.hpp.

                                                                      {
            // read the actual data from the stream
            uint32_t actual = 0;
            inStream.read((char*) &actual, sizeof(actual));
            // return equality
            return inExpected == ntohl(actual);
        }

void torc::bitstream::VirtexBitstream::generateBitstream ( EBitstreamType  inBitstreamType = eBitstreamTypeFull, EFrameInclude  inFrameInclusion = eFrameIncludeAllUsedFrames  )

virtual

Discard existing packets and generate bitstream packets from frame data. By default this generates packets for a full bitstream.

Parameters

inBitstreamType	The type of bitstream to generate: full, active partial, or shutdown partial.
inFrameInclusion	The type of frames to include in partial bitstreams: only dirty frames or all frames.

Definition at line 58 of file VirtexBitstream.cpp.

                                        {
        // discard all packets
        clear();
        if(inBitstreamType == eBitstreamTypeFull) {
            // generate the prefix
            append(generateFullBitstreamPrefix());
            // generate the frame packets
            append(generateFullBitstreamPackets());
            // generate the suffix
            append(generateFullBitstreamSuffix());
        } else {
            // generate the prefix
            append(generatePartialBitstreamPrefix(inBitstreamType));
            // generate the frame packets
            append(generatePartialBitstreamPackets(inFrameInclusion));
            // generate the suffix
            append(generatePartialBitstreamSuffix(inBitstreamType));
        }
    }

VirtexPacketVector torc::bitstream::VirtexBitstream::generateFullBitstreamPackets ( void  )

virtual

Return a packet vector with full frame data.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, and torc::bitstream::Virtex4.

Definition at line 272 of file VirtexBitstream.cpp.

                                                                         {
        unimplemented("generateFullBitstreamPackets()");
        return VirtexPacketVector();
    }

template<class ARCH >

VirtexPacketVector torc::bitstream::VirtexBitstream::generateFullBitstreamPackets4567 ( uint32_t  inBlockFrameIndexBounds[] )

protected

Return a packet vector with full frame data for Virtex4/5/6/7 devices.

Definition at line 287 of file VirtexBitstream.cpp.

                                            {

        // declare the packet vector and define a NOP packet
        typedef VirtexFrame::word_t word_t;
        VirtexPacketVector packets;
        VirtexPacket nop(VirtexPacket::makeHeader(ePacketType1, eOpcodeNOP, 0, 0));

        // determine the total size of the frames to write
        size_t size = 0;
        for(int i = 0; i < eBlockTypeCount; i++) 
            size += inBlockFrameIndexBounds[i] * getFrameLength();
        word_t* frameContents = new VirtexFrameSet::word_t[size];
        word_t* pos = frameContents;
        // gather the frames to write
        for(int i = 0; i < eBlockTypeCount; i++) {
            // look up the frame set for this block type
            VirtexFrameSet& frameSet = mFrameBlocks.mBlock[i];
            // iterate through the frames in the set and collect the frame words
            VirtexFrameSet::iterator p = frameSet.begin();
            VirtexFrameSet::iterator e = frameSet.end();
            while(p < e) {
                // look up the current frame
                VirtexFrameSharedPtr framePtr = *p++;
                // set up the pointers
                const word_t* wp = framePtr->getWords();
                const word_t* we = wp + framePtr->getLength();
                // and copy the frame words into the new memory
                if(wp) do { *pos++ = *wp++; } while(wp < we); // frames with words allocated
                else do { *pos++ = 0; wp++; } while(wp < we); // frames with no words allocated
            }
        }
        // write the starting frame address
        packets.push_back(VirtexPacket::makeType1Write(ARCH::eRegisterFAR, 0));
        // write the write configuration register command
        packets.push_back(VirtexPacket::makeType1Write(ARCH::eRegisterCMD, ARCH::eCommandWCFG));
        packets.push_back(nop);
        // write 0 bytes to FDRI (in preparation for type 2 write packet)
        packets.push_back(VirtexPacket::makeNullType1Write(ARCH::eRegisterFDRI));
        // write all frames to FDRI
        packets.push_back(VirtexPacket::makeType2Write(size, frameContents));

        // return the packet vector
        return packets;
    }

VirtexPacketVector torc::bitstream::VirtexBitstream::generateFullBitstreamPrefix ( void  )

virtual

Return a packet vector with the full bitstream prefix.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, and torc::bitstream::Virtex4.

Definition at line 333 of file VirtexBitstream.cpp.

                                                                        {
        unimplemented("generateFullBitstreamPrefix()");
        return VirtexPacketVector();
    }

VirtexPacketVector torc::bitstream::VirtexBitstream::generateFullBitstreamSuffix ( void  )

virtual

Return a packet vector with the full bitstream suffix.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, and torc::bitstream::Virtex4.

Definition at line 338 of file VirtexBitstream.cpp.

                                                                        {
        unimplemented("generateFullBitstreamSuffix()");
        return VirtexPacketVector();
    }

VirtexPacketVector torc::bitstream::VirtexBitstream::generatePartialBitstreamPackets ( EFrameInclude  inFrameInclusion )

virtual

Return a packet vector with partial frame data.

Parameters

inFrameInclusion

The type of frames to include: only dirty frames or all frames.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, and torc::bitstream::Virtex4.

Definition at line 343 of file VirtexBitstream.cpp.

                                        {
        unimplemented("generatePartialBitstreamPackets()");
        return VirtexPacketVector();
    }

template<class ARCH >

VirtexPacketVector torc::bitstream::VirtexBitstream::generatePartialBitstreamPackets4567 ( EFrameInclude  inFrameInclusion, std::map< typename ARCH::FrameAddress, uint32_t > &  inFrameAddressToIndex, std::map< uint32_t, typename ARCH::FrameAddress > &  inFrameIndexToAddress  )

protected

Return a packet vector with partial frame data for Virtex4/5/6/7 devices.

Todo:

mFrameIndexToAddress.size() is too short because excludes pad frames

Definition at line 367 of file VirtexBitstream.cpp.

                                                                            {
        // clean up the template parameters
        typedef typename ARCH::FrameAddress FrameAddress;
        typedef std::map<FrameAddress, uint32_t> FrameAddressToIndex;
        typedef std::map<uint32_t, FrameAddress> FrameIndexToAddress;

        // declare the packet vector and define a NOP packet
        typedef VirtexFrame::word_t word_t;
        VirtexPacketVector packets;
        VirtexPacket nop(VirtexPacket::makeHeader(ePacketType1, eOpcodeNOP, 0, 0));

        // write the starting frame address
        packets.push_back(VirtexPacket::makeType1Write(ARCH::eRegisterFAR, 0));
        // write the write configuration register command
        packets.push_back(VirtexPacket::makeType1Write(ARCH::eRegisterCMD, ARCH::eCommandWCFG));
        packets.push_back(nop);

        // iterate through the frame blocks looking for groups of contiguous frames that are in use
        bool empty = true;
        uint32_t index = 0;
        uint32_t blockStart = 0;
        for(int i = 0; i < eBlockTypeCount; i++) {
            blockStart += index;
            index = 0;
            bool started = false;
            uint32_t startIndex = 0;
            // look up the frame set for this block type
            VirtexFrameSet& frameSet = mFrameBlocks.mBlock[i];
            // iterate through the frames in the set and add up their lengths
            VirtexFrameSet::iterator p = frameSet.begin();
            VirtexFrameSet::iterator e = frameSet.end();
            while(p < e) {
                // look up the current frame
                VirtexFrameSharedPtr framePtr = *p++;
                // determine whether the frame fits inclusion criteria
                    // we include dirty frames, we include clean frames if permitted by the caller, 
                    // and if we are collecting frames and we encounter pad frames, we include them,
                    // but we stop collecting if we reach the last frame in the set
                /// \todo mFrameIndexToAddress.size() is too short because excludes pad frames
                bool include = p < e 
                    && (
                        framePtr->isDirty() 
                        || (inFrameInclusion == eFrameIncludeAllUsedFrames && framePtr->isUsed()) 
                        || (started && blockStart + index < inFrameIndexToAddress.size() && 
                            inFrameIndexToAddress.find(blockStart + index) 
                                == inFrameIndexToAddress.end())
                    );
                // if we are accumulating frames and this frame doesn't meet the criteria, process 
                // the collection of frames and stop collecting
                if((started && !include)) {
                    started = false;
                    uint32_t stopIndex = index + (p == e ? 1 : 0);
                    uint32_t currentIndex = startIndex;
                    // std::cerr << "    stopped at: " << stopIndex << std::endl;
                    // include two trailing pad frames if appropriate
                    if(inFrameIndexToAddress.find(blockStart + stopIndex + 1) 
                        == inFrameIndexToAddress.end()) {
                        stopIndex++;
                        if(inFrameIndexToAddress.find(blockStart + stopIndex + 1) 
                            == inFrameIndexToAddress.end())
                            stopIndex++;
                    }
                    // determine the length of the contiguous block
                    size_t size = (stopIndex - startIndex) * getFrameLength();
                    // allocate a word array
                    word_t* frameContents = new VirtexFrameSet::word_t[size];
                    word_t* pos = frameContents;
                    while(currentIndex < stopIndex) {
                        // look up the current frame
                        VirtexFrameSharedPtr framePtr = mFrameBlocks.mBlock[i][currentIndex];
                        // set up the pointers
                        const word_t* wp = framePtr->getWords();
                        const word_t* we = wp + framePtr->getLength();
                        // and copy the frame words into the new memory
                        if(wp) do { *pos++ = *wp++; } while(wp < we); // frames with words
                        else do { *pos++ = 0; wp++; } while(wp < we); // frames with no words
                        currentIndex++;
                    }
                    // write the starting frame address
                    packets.push_back(VirtexPacket::makeType1Write(ARCH::eRegisterFAR, 
                        inFrameIndexToAddress[blockStart + startIndex]));
                    packets.push_back(nop);
                    // if the size is more than 2048 words, we have to use a Type 2 write
                    if(size > 2048) {
                        // write 0 bytes to FDRI (in preparation for type 2 write packet)
                        packets.push_back(VirtexPacket::makeNullType1Write(ARCH::eRegisterFDRI));
                        // write all frames to FDRI
                        packets.push_back(VirtexPacket::makeType2Write(size, frameContents));
                    } else {
                        // write all frames to FDRI
                        packets.push_back(VirtexPacket::makeType1Write(ARCH::eRegisterFDRI, size, 
                            frameContents));
                    }
                    if(size) empty = false;
                // if we are not collecting, but we encounter a frame to include, begin collecting
                } else if(!started && include) {
                    // std::cerr << "    started at: " << index << std::endl;
                    startIndex = index;
                    started = true;
                }
                // increment the frame index
                index++;
            }
        }

        // if we generated no frame contents, discard the wrapper packets
        if(empty) packets.clear();
        // return the packet vector
        return packets;
    }

VirtexPacketVector torc::bitstream::VirtexBitstream::generatePartialBitstreamPrefix ( EBitstreamType  inBitstreamType )

virtual

Return a packet vector with the partial bitstream prefix.

Parameters

inBitstreamType

The type of partial bitstream to generate: active or shutdown.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, and torc::bitstream::Virtex4.

Definition at line 481 of file VirtexBitstream.cpp.

                                        {
        unimplemented("generatePartialBitstreamPrefix()");
        return VirtexPacketVector();
    }

VirtexPacketVector torc::bitstream::VirtexBitstream::generatePartialBitstreamSuffix ( EBitstreamType  inBitstreamType )

virtual

Return a packet vector with the partial bitstream suffix.

Parameters

inBitstreamType

The type of partial bitstream to generate: active or shutdown.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, and torc::bitstream::Virtex4.

Definition at line 487 of file VirtexBitstream.cpp.

                                        {
        unimplemented("generatePartialBitstreamSuffix()");
        return VirtexPacketVector();
    }

uint32_t torc::bitstream::Bitstream::getBitstreamByteLength ( void  ) const

inlineinherited

Return the bitstream packet length in bytes.

The length includes all packet data, but does not include the bitstream header.

Definition at line 340 of file bitstream/Bitstream.hpp.

{ return mBitstreamByteLength; }

const string& torc::bitstream::Bitstream::getDesignDate ( void  ) const

inlineinherited

Return the design date.

Definition at line 335 of file bitstream/Bitstream.hpp.

{ return mDesignDate; }

const string& torc::bitstream::Bitstream::getDesignName ( void  ) const

inlineinherited

Return the design name.

Definition at line 331 of file bitstream/Bitstream.hpp.

{ return mDesignName; }

const string& torc::bitstream::Bitstream::getDesignTime ( void  ) const

inlineinherited

Return the design time.

Definition at line 337 of file bitstream/Bitstream.hpp.

{ return mDesignTime; }

const string& torc::bitstream::Bitstream::getDeviceName ( void  ) const

inlineinherited

Return the device name.

Definition at line 333 of file bitstream/Bitstream.hpp.

{ return mDeviceName; }

Here is the caller graph for this function:

VirtexFrameBlocks& torc::bitstream::VirtexBitstream::getFrameBlocks ( void  )

inline

Return the configuration frame blocks.

Definition at line 139 of file VirtexBitstream.hpp.

{ return mFrameBlocks; }

virtual uint32_t torc::bitstream::Bitstream::getFrameLength ( void  ) const

inlinevirtualinherited

Return the frame length for the current device.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex5, torc::bitstream::Virtex6, torc::bitstream::Virtex4, torc::bitstream::Virtex2, torc::bitstream::Virtex, torc::bitstream::Spartan6, torc::bitstream::Spartan3E, torc::bitstream::VirtexE, and torc::bitstream::Virtex2P.

Definition at line 344 of file bitstream/Bitstream.hpp.

{ return 0; }

uint32_t torc::bitstream::Bitstream::getHeaderByteLength ( void  ) const

inlineinherited

Return the bitstream header length in bytes.

Definition at line 342 of file bitstream/Bitstream.hpp.

{ return mHeaderByteLength; }

Here is the caller graph for this function:

virtual void torc::bitstream::Bitstream::initializeDeviceInfo ( const std::string &  inDeviceName )

inlinevirtualinherited

Initialize the maps between frame indexes and frame addresses. This is generally only useful for internal purposes.

Todo:

This function should be made pure virtual.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, torc::bitstream::Virtex4, torc::bitstream::Spartan3E, torc::bitstream::Virtex2, torc::bitstream::Virtex, torc::bitstream::Virtex2P, and torc::bitstream::VirtexE.

Definition at line 214 of file bitstream/Bitstream.hpp.

{}

Here is the caller graph for this function:

virtual void torc::bitstream::Bitstream::initializeFrameMaps ( void  )

inlinevirtualinherited

Initialize the maps between frame indexes and frame addresses. This is generally only useful for internal purposes.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, torc::bitstream::Virtex4, torc::bitstream::Spartan3E, torc::bitstream::Virtex2, torc::bitstream::Virtex, and torc::bitstream::VirtexE.

Definition at line 217 of file bitstream/Bitstream.hpp.

{}

iterator torc::bitstream::VirtexBitstream::insert ( iterator  position, const value_type &  val  )

inline

Regular std::vector inserter.

Definition at line 116 of file VirtexBitstream.hpp.

                                                                  {
            return VirtexPacketVector::insert(position, val);
        }

Here is the caller graph for this function:

void torc::bitstream::VirtexBitstream::insert ( iterator  position, size_type  n, const value_type &  val  )

inline

Regular std::vector inserter.

Definition at line 120 of file VirtexBitstream.hpp.

                                                                           {
            VirtexPacketVector::insert(position, n, val);
        }

template<class InputIterator >

void torc::bitstream::VirtexBitstream::insert ( iterator  position, InputIterator  first, InputIterator  last  )

inline

Regular std::vector inserter.

Definition at line 124 of file VirtexBitstream.hpp.

                                {
            VirtexPacketVector::insert(position, first, last);
        }

void torc::bitstream::VirtexBitstream::insert ( VirtexPacketVector::iterator  inPosition, const VirtexPacketVector &  inVector  )

inline

Insert the contents of a packet vector at the specified position.

Definition at line 129 of file VirtexBitstream.hpp.

                                                {
            VirtexPacketVector::insert(inPosition, inVector.begin(), inVector.end());
        }

void torc::bitstream::VirtexBitstream::preflightPackets ( void  )

virtual

Preflight the packets.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 493 of file VirtexBitstream.cpp.

                                               {
        // determine which architecture this is
        DeviceDesignator deviceDesignator(getDeviceName());
        DeviceDesignator::EFamily family = deviceDesignator.getFamily();
        switch(family) {
            case DeviceDesignator::eFamilyVirtex: case DeviceDesignator::eFamilyVirtexE:
            case DeviceDesignator::eFamilyVirtex2: case DeviceDesignator::eFamilyVirtex2P:
                updateCrc16(family); break;
            case DeviceDesignator::eFamilyVirtex4: case DeviceDesignator::eFamilyVirtex5: 
            case DeviceDesignator::eFamilyVirtex6: case DeviceDesignator::eFamilyArtix7:
            case DeviceDesignator::eFamilyKintex7: case DeviceDesignator::eFamilyVirtex7: 
            case DeviceDesignator::eFamilyZynq7000: default:
                updateCrc32(family); break;
        }
    }

Here is the call graph for this function:

virtual void torc::bitstream::Bitstream::read ( std::istream &  inStream, bool  inCleanDateAndTime = true  )

inlinevirtualinherited

Read the bitstream header and packets from a stream.

Definition at line 266 of file bitstream/Bitstream.hpp.

                                                                                {
            readHeader(inStream);
            readPackets(inStream);
            if(inCleanDateAndTime) cleanDateAndTime();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::bitstream::VirtexBitstream::readFramePackets ( void  )

virtual

Read frame data into the frame blocks structure.

Reimplemented in torc::bitstream::Virtex7, torc::bitstream::Virtex6, torc::bitstream::Virtex5, and torc::bitstream::Virtex4.

Definition at line 83 of file VirtexBitstream.cpp.

                                               {
        unimplemented("readFramePackets(void)");
    }

template<class ARCH >

void torc::bitstream::VirtexBitstream::readFramePackets4567 ( uint32_t  inBlockFrameIndexBounds[], std::map< typename ARCH::FrameAddress, uint32_t > &  inFrameAddressToIndex, std::map< uint32_t, typename ARCH::FrameAddress > &  inFrameIndexToAddress  )

protected

Read frame packets in for Virtex4/5/6/7 devices.

Todo:

Definition at line 101 of file VirtexBitstream.cpp.

                                                                            {
        // clean up the template parameters
        typedef typename ARCH::FrameAddress FrameAddress;
        typedef std::map<FrameAddress, uint32_t> FrameAddressToIndex;
        typedef std::map<uint32_t, FrameAddress> FrameIndexToAddress;
        // declare a shared word array
        boost::shared_array<uint32_t> frameWords;
        // precalculate the start indexes of all blocks, and create all possible frames
        uint32_t frameStart[eBlockTypeCount + 1];
        frameStart[0] = 0;
        VirtexFrame frame(ARCH::eFrameLength);
        for(int i = 0; i < eBlockTypeCount; i++) {
            frameStart[i + 1] = frameStart[i] + inBlockFrameIndexBounds[i];
            // clear any existing frames
            mFrameBlocks.mBlock[i].clear();
            // populate the block with the correct number of empty frames
            for(uint32_t j = 0; j < inBlockFrameIndexBounds[i]; j++) {
                mFrameBlocks.mBlock[i].push_back(VirtexFrameSet::FrameSharedPtr
                    (new VirtexFrame(getFrameLength())));
                mFrameBlocks.mBlock[i].back()->setUsed(false);
            }
        }
        // walk the bitstream and extract all frames
        const uint32_t frameLength = getFrameLength();
        uint32_t frameIndex = 0;
        FrameAddress frameAddress;
        typename ARCH::ERegister lastAddress = typename ARCH::ERegister();
        typename ARCH::iterator p = begin();
        typename ARCH::iterator e = end();
        while(p < e) {
            const VirtexPacket& packet = *p++;
            // process FAR write packets
            if(packet.isWrite() && packet.getAddress() == ARCH::eRegisterFAR) {
                // extract the new frame address
                frameAddress = typename ARCH::FrameAddress(packet[1]);
                // convert the frame address to the corresponding frame index
                typename FrameAddressToIndex::iterator ip 
                    = inFrameAddressToIndex.find(frameAddress);
                if(ip != inFrameAddressToIndex.end()) frameIndex = ip->second;
            }
            // process FDRI write packets
            else if(packet.isWrite() 
                && (
                    // this is a Type 2 packet and the prior Type 1 address was FDRI
                    (packet.isType2() && lastAddress == ARCH::eRegisterFDRI)
                ||
                    // this is a non-empty Type 1 packet and its address is FDRI
                    (packet.isType1() && packet.getAddress() == ARCH::eRegisterFDRI 
                    && packet.getWordCount() > 0)
                )) {
                // determine the number of frames in the packet and look up the frame words
                const uint32_t numWords = packet.getWordCount();
                boost::shared_array<uint32_t> frameWords(packet.getWords());
                uint32_t position = 0;
                // iterate over every frame in the packet
                while(position + frameLength <= numWords) {
                    // look up the current block type and the frame index into that block type
                    typename ARCH::EFarBlockType blockType = frameAddress.mBlockType;
                    uint32_t index = frameIndex - frameStart[blockType];
                    mFrameBlocks.mBlock[blockType][index] = VirtexFrameSet::FrameSharedPtr
                        (new VirtexFrame(frameLength, &frameWords[position]));
                    mFrameBlocks.mBlock[blockType][index]->setUsed();
                    position += frameLength;
                    frameIndex++;
                    typename FrameIndexToAddress::iterator ap 
                        = inFrameIndexToAddress.find(frameIndex);
                    if(ap != inFrameIndexToAddress.end()) frameAddress = ap->second;
                    // sanity escape exit (which also breaks out of the higher level loop)
                    if(position > numWords) {
                        std::cerr << "Overflowed expected frame counts for device." << std::endl;
                        break;
                    }
                }
                if(frameIndex != frameStart[frameAddress.mBlockType + 1]) {
                    // if we ended on a pad frame, where the current index has no corresponding 
                    // frame address, we need to advance to the next valid frame address
                    if(inFrameIndexToAddress.find(frameIndex) == inFrameIndexToAddress.end()) 
                        frameIndex++;
                    if(inFrameIndexToAddress.find(frameIndex) == inFrameIndexToAddress.end()) 
                        frameIndex++;
                    // at this point we should again be on a valid frame
                    typename FrameIndexToAddress::iterator ap 
                        = inFrameIndexToAddress.find(frameIndex);
                    if(ap != inFrameIndexToAddress.end()) frameAddress = ap->second;
                    else if(frameIndex == frameStart[frameAddress.mBlockType + 1]) /* at end */;
                    else {
                        std::cerr << "Failed to find the next valid frame address at the end of a "
                            "packet." << std::endl;
                    }
                }
            }
            // remember the last register address for Type 2 packets
            if(packet.isType1()) lastAddress = typename ARCH::ERegister(packet.getAddress());
            // process MFWR write packets
            /// \todo
        }
    }

Here is the call graph for this function:

static bool torc::bitstream::Bitstream::readHeader ( std::istream &  inStream, string &  outDesignName, string &  outDeviceName, string &  outDesignDate, string &  outDesignTime, uint32_t &  outBitstreamLength, uint32_t &  outHeaderLength  )

inlinestaticinherited

Read a bitstream header, and return its fields.

Definition at line 142 of file bitstream/Bitstream.hpp.

                                                                     {
            // assume success unless we find otherwise
            bool success = true;
            // read the magic length
            success &= expect(inStream, uint16_t(0x0009));
            // read the magic bytes
            success &= expect(inStream, uint32_t(0x0ff00ff0));
            success &= expect(inStream, uint32_t(0x0ff00ff0));
            success &= expect(inStream, uint8_t(0x00));
            // read the mysterious 0x0001
            success &= expect(inStream, uint16_t(0x0001));
            // read the 'a' byte
            success &= expect(inStream, uint8_t('a'));
            // read the design name length
            readHeaderString(inStream, outDesignName);
            // read the 'b' byte
            success &= expect(inStream, uint8_t('b'));
            // read the device name length
            readHeaderString(inStream, outDeviceName);
            // read the 'c' byte
            success &= expect(inStream, uint8_t('c'));
            // read the design date length
            readHeaderString(inStream, outDesignDate);
            // read the 'd' byte
            success &= expect(inStream, uint8_t('d'));
            // read the design time length
            readHeaderString(inStream, outDesignTime);
            // read the 'e' byte
            success &= expect(inStream, uint8_t('e'));
            // read the inStream length
            inStream.read((char*) &outBitstreamLength, sizeof(outBitstreamLength));
            outBitstreamLength = ntohl(outBitstreamLength);
            // determine the header length
            outHeaderLength = 34 + outDesignName.length() + outDeviceName.length() 
                + outDesignDate.length() + outDesignTime.length();
            // return the result
            return success;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void torc::bitstream::Bitstream::readHeader ( std::istream &  inStream )

inlinevirtualinherited

Read the bitstream header.

Definition at line 274 of file bitstream/Bitstream.hpp.

                                                      {
            readHeader(inStream, mDesignName, mDeviceName, mDesignDate, mDesignTime, 
                mBitstreamByteLength, mHeaderByteLength);
            setDevice(mDeviceName);
        }

Here is the call graph for this function:

static void torc::bitstream::Bitstream::readHeaderString ( std::istream &  inStream, string &  outString  )

inlinestaticinherited

Read and return a bitstream header string.

Definition at line 124 of file bitstream/Bitstream.hpp.

                                                                              {
            // read the string length
            uint16_t length = 0;
            inStream.read((char*) &length, sizeof(length));
            length = ntohs(length);
            if(length > 0) {
                // create a buffer
                char* buffer = new char[length];
                // read the null-terminated string
                inStream.read(buffer, length);
                // copy the data into the string
                outString.assign(buffer, length - 1);
                delete[] buffer;
            } else {
                outString.clear();
            }
        }

Here is the caller graph for this function:

void torc::bitstream::VirtexBitstream::readPackets ( std::istream &  inStream )

virtual

Read bitstream packets from a stream.

Note

This function should be called after the bitstream header has been read.

Reimplemented from torc::bitstream::Bitstream.

Reimplemented in torc::bitstream::Virtex2.

Definition at line 31 of file VirtexBitstream.cpp.

                                                          {
        uint32_t bitstreamWordLength = mBitstreamByteLength >> 2;
        uint32_t cumulativeWordLength = 0;
        while(cumulativeWordLength < bitstreamWordLength) {
            push_back(VirtexPacket::read(inStream));
            cumulativeWordLength += back().getWordSize();
        }
    }

void torc::bitstream::Bitstream::setDesignDate ( const string &  inDesignDate )

inlineinherited

Set the design date.

Definition at line 327 of file bitstream/Bitstream.hpp.

{ mDesignDate = inDesignDate; }

Here is the caller graph for this function:

void torc::bitstream::Bitstream::setDesignName ( const string &  inDesignName )

inlineinherited

Set the design name.

Definition at line 323 of file bitstream/Bitstream.hpp.

{ mDesignName = inDesignName; }

Here is the caller graph for this function:

void torc::bitstream::Bitstream::setDesignTime ( const string &  inDesignTime )

inlineinherited

Set the design time.

Definition at line 329 of file bitstream/Bitstream.hpp.

{ mDesignTime = inDesignTime; }

Here is the caller graph for this function:

void torc::bitstream::Bitstream::setDevice ( const std::string &  inDeviceName )

inlineinherited

Assign the device enumeration constant for the given device name.

Definition at line 225 of file bitstream/Bitstream.hpp.

                                                      {
            mDevice = torc::common::Devices::getDeviceEnum(inDeviceName);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::bitstream::Bitstream::setDeviceInfo ( const DeviceInfo &  rhs )

inlineinherited

Assign static device information for the current bitstream.

Definition at line 223 of file bitstream/Bitstream.hpp.

{ mDeviceInfo = rhs; }

Here is the caller graph for this function:

void torc::bitstream::Bitstream::setDeviceName ( const string &  inDeviceName )

inlineinherited

Set the device name.

Definition at line 325 of file bitstream/Bitstream.hpp.

{ mDeviceName = inDeviceName; }

Here is the caller graph for this function:

void torc::bitstream::VirtexBitstream::unimplemented ( std::string  inName )

protected

Reports the named function as not yet implemented in the current architecture.

Definition at line 79 of file VirtexBitstream.cpp.

                                                        {
        std::cerr << inName << " is not yet implemented for this architecture." << std::endl;
    }

void torc::bitstream::VirtexBitstream::updateCrc16 ( torc::common::DeviceDesignator::EFamily  inFamily )

protectedvirtual

Update CRC-16 packets.

Definition at line 509 of file VirtexBitstream.cpp.

                                                                      {
        // set up family-specific variables
        uint32_t crcRegister = 0;
        uint32_t cmdRegister = 0;
        uint32_t fdriRegister = 0;
        uint32_t rcrcCommand = 0;
        uint32_t addressLength = 0;
        bool autoCrc = false;
        switch(inFamily) {
        case DeviceDesignator::eFamilyVirtex: case DeviceDesignator::eFamilyVirtexE: 
            cmdRegister = Virtex::eRegisterCMD; rcrcCommand = Virtex::eCommandRCRC; 
            fdriRegister = Virtex::eRegisterFDRI; crcRegister = Virtex::eRegisterCRC; 
            addressLength = 4; autoCrc = false; 
            break;
        case DeviceDesignator::eFamilyVirtex2: case DeviceDesignator::eFamilyVirtex2P: 
            cmdRegister = Virtex2::eRegisterCMD; rcrcCommand = Virtex2::eCommandRCRC; 
            fdriRegister = Virtex2::eRegisterFDRI; crcRegister = Virtex::eRegisterCRC; 
            addressLength = 5; autoCrc = true; 
            break;
        default:
            std::cerr << "Unsupported architecture in VirtexBitstream::updateCrc16()." << std::endl;
            break;
        }
        // begin CRC calculation
        uint32_t address = 0;
        iterator p = begin();
        iterator e = end();
        // CRC-16-IBM polynomial for Spartan3/6 and Virtex/E/2/2P families
        boost::crc_basic<16> crc16(0x8005, 0, 0, false, true);
        while(p < e) {
            // look up the current packet
            const VirtexPacket& packet = *p++;
            // only process write packets with non-zero payload length
            if(!packet.isWrite()) continue;
            if(packet.isType1()) address = packet.getAddress();
            uint32_t wordCount = packet.getWordCount();
            if(wordCount == 0) continue;
            // CRC register write (this is what compares the expected and supplied CRC values)
            if(address == crcRegister) {
                //printf("Expected CRC16:   %4.4x\n", packet[1]);
                //printf("Calculated CRC16: %4.4x\n", crc16.checksum());
                *(p-1) = VirtexPacket::makeType1Write(crcRegister, crc16.checksum());
                crc16.reset();
            // reset CRC command
            } else if(address == cmdRegister && wordCount >= 1 && packet[1] == rcrcCommand) {
                crc16.reset();
            // process packet contents
            } else {
                uint32_t j;
                uint32_t mask;
                for(uint32_t i = 1; i <= wordCount; i++) {
                    uint32_t word = packet[i];
                    //printf("Address: %4.4x\n", address);
                    //printf("Word: %8.8x\n", word);
                    for(j = 0, mask = 1; j < 32; j++, mask <<= 1) {
                        crc16.process_bit((word & mask) ? 1 : 0);
                    }
                    for(j = 0, mask = 1; j < addressLength; j++, mask <<= 1) {
                        crc16.process_bit((address & mask) ? 1 : 0);
                    }
                }
                // process the Auto CRC on Virtex2 and Virtex2P
                if(autoCrc && address == fdriRegister) {
                    //printf("Expected Auto CRC16:   %4.4x\n", packet[1]);
                    //printf("Calculated Auto CRC16: %4.4x\n", crc16.checksum());
                    *p = VirtexPacket(crc16.checksum()); // current word is FDRI, next is Auto CRC
                    crc16.reset();
                }
            }
        }
    }

Here is the call graph for this function:

void torc::bitstream::VirtexBitstream::updateCrc32 ( torc::common::DeviceDesignator::EFamily  inFamily )

protectedvirtual

Update CRC-32 packets.

Definition at line 581 of file VirtexBitstream.cpp.

                                                                      {
        // set up family-specific variables
        uint32_t crcRegister = 0;
        uint32_t cmdRegister = 0;
        uint32_t rcrcCommand = 0;
        uint32_t addressLength = 5;
        switch(inFamily) {
        case DeviceDesignator::eFamilyVirtex4: 
            cmdRegister = Virtex4::eRegisterCMD; rcrcCommand = Virtex4::eCommandRCRC; 
            crcRegister = Virtex4::eRegisterCRC; 
            break;
        case DeviceDesignator::eFamilyVirtex5: 
            cmdRegister = Virtex5::eRegisterCMD; rcrcCommand = Virtex5::eCommandRCRC; 
            crcRegister = Virtex5::eRegisterCRC; 
            break;
        case DeviceDesignator::eFamilyVirtex6: 
            cmdRegister = Virtex6::eRegisterCMD; rcrcCommand = Virtex6::eCommandRCRC; 
            crcRegister = Virtex6::eRegisterCRC; 
            break;
        case DeviceDesignator::eFamilyArtix7: case DeviceDesignator::eFamilyKintex7: 
        case DeviceDesignator::eFamilyVirtex7: case DeviceDesignator::eFamilyZynq7000: 
            cmdRegister = Virtex7::eRegisterCMD; rcrcCommand = Virtex7::eCommandRCRC; 
            crcRegister = Virtex7::eRegisterCRC; 
            break;
        default:
            std::cerr << "Unsupported architecture in VirtexBitstream::updateCrc32()." << std::endl;
            break;
        }
        // begin CRC calculation
        uint32_t address = 0;
        iterator p = begin();
        iterator e = end();
        // CRC-32C (Castagnoli) polynomial for Virtex4/5/6/7 families
        boost::crc_basic<32> crc32(0x1edc6f41, 0, 0, false, true);
        while(p < e) {
            // look up the current packet
            const VirtexPacket& packet = *p++;
            // only process write packets with non-zero payload length
            if(!packet.isWrite()) continue;
            if(packet.isType1()) address = packet.getAddress();
            uint32_t wordCount = packet.getWordCount();
            if(wordCount == 0) continue;
            // CRC register write (this is what compares the expected and supplied CRC values)
            if(address == crcRegister) {
                //printf("Expected CRC32:   %8.8x\n", packet[1]);
                //printf("Calculated CRC32: %8.8x\n", crc32.checksum());
                *(p-1) = VirtexPacket::makeType1Write(crcRegister, crc32.checksum());
                crc32.reset();
            // reset CRC command
            } else if(address == cmdRegister && wordCount >= 1 && packet[1] == rcrcCommand) {
                crc32.reset();
            // process packet contents
            } else {
                uint32_t j;
                uint32_t mask;
                for(uint32_t i = 1; i <= wordCount; i++) {
                    uint32_t word = packet[i];
                    //printf("Address: %4.4x\n", address);
                    //printf("Word: %8.8x\n", word);
                    for(j = 0, mask = 1; j < 32; j++, mask <<= 1) {
                        crc32.process_bit((word & mask) ? 1 : 0);
                    }
                    for(j = 0, mask = 1; j < addressLength; j++, mask <<= 1) {
                        crc32.process_bit((address & mask) ? 1 : 0);
                    }
                }
            }
        }
    }

Here is the call graph for this function:

void torc::bitstream::VirtexBitstream::updateFramePackets ( EBitstreamType  inBitstreamType = eBitstreamTypeFull, EFrameInclude  inFrameInclusion = eFrameIncludeAllUsedFrames  )

virtual

Update the bitstream frame packets By default this updates the bitstream with full frame data.

Parameters

inBitstreamType	The type of bitstream to generate: full or partial.
inFrameInclusion	The type of frames to include in partial bitstreams: only dirty frames or all frames.

Definition at line 46 of file VirtexBitstream.cpp.

                                        {
        // delete the existing frame packets
        iterator position = deleteFramePackets();
        // insert the new frame packets in place of the old ones
        if(inBitstreamType == eBitstreamTypeFull) {
            insert(position, generateFullBitstreamPackets());
        } else {
            insert(position, generatePartialBitstreamPackets(inFrameInclusion));
        }
    }

Here is the caller graph for this function:

void torc::bitstream::VirtexBitstream::updatePacketLength ( void  )

virtual

Update the header packet length.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 651 of file VirtexBitstream.cpp.

                                                 {
        uint32_t totalWordCount = 0;
        iterator p = begin();
        iterator e = end();
        while(p < e) totalWordCount += (p++)->getWordSize();
        mBitstreamByteLength = totalWordCount << 2;
    }

void torc::bitstream::Bitstream::write ( std::ostream &  inStream, uint8_t  inVal  )

inlineinherited

Write a uint8_t to the stream.

Definition at line 67 of file bitstream/Bitstream.hpp.

                                                        {
            uint8_t actual = inVal;
            inStream.write((char*) &actual, sizeof(actual));
        }

Here is the caller graph for this function:

void torc::bitstream::Bitstream::write ( std::ostream &  inStream, uint16_t  inVal  )

inlineinherited

Write a uint16_t to the stream.

Definition at line 72 of file bitstream/Bitstream.hpp.

                                                         {
            uint16_t actual = htons(inVal);
            inStream.write((char*) &actual, sizeof(actual));
        }

void torc::bitstream::Bitstream::write ( std::ostream &  inStream, uint32_t  inVal  )

inlineinherited

Write a uint32_t to the stream.

Definition at line 77 of file bitstream/Bitstream.hpp.

                                                         {
            uint32_t actual = htonl(inVal);
            inStream.write((char*) &actual, sizeof(actual));
        }

virtual void torc::bitstream::Bitstream::write ( std::ostream &  inStream )

inlinevirtualinherited

Write the bitstream header and packets to a stream.

Definition at line 280 of file bitstream/Bitstream.hpp.

                                                 {
            preflightPackets();
            updatePacketLength();
            writeHeader(inStream);
            writePackets(inStream);
        }

Here is the call graph for this function:

void torc::bitstream::Bitstream::writeDeviceInfo ( std::ostream &  inStream, const std::string &  inDeviceName  )

virtualinherited

Output static device information to a stream.

This is used to generate the static column maps for bitstream frame mapping.

Definition at line 74 of file Bitstream.cpp.

                                       {
        // write the device column composition
        inStream << "\t// " << inDeviceName << " static device information." << std::endl;
        inStream << "\tboost::uint32_t " << inDeviceName << "Columns[] = { ";
        ColumnTypeVector::const_iterator p = mDeviceInfo.getColumnTypes().begin();
        ColumnTypeVector::const_iterator e = mDeviceInfo.getColumnTypes().end();
        while(p < e) inStream << mColumnDefs[*p++].getName() << ", ";
        inStream << "END };" << std::endl;
        // instantiate the device information
        inStream << "\tDeviceInfo " << inDeviceName << "(" << mDeviceInfo.getTileCount() << ", " 
            << mDeviceInfo.getRowCount() << ", " << mDeviceInfo.getColCount() << ", " 
            << inDeviceName << "Columns);" << std::endl;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void torc::bitstream::Bitstream::writeHeader ( std::ostream &  inStream )

inlinevirtualinherited

Write the bitstream header to the stream.

Definition at line 293 of file bitstream/Bitstream.hpp.

                                                       {
            // write the magic length
            write(inStream, uint16_t(0x0009));
            // write the magic bytes with null termination
            write(inStream, uint32_t(0x0ff00ff0));
            write(inStream, uint32_t(0x0ff00ff0));
            write(inStream, uint8_t(0x00));
            // write the mysterious 0x0001
            write(inStream, uint16_t(0x0001));
            // write the 'a' byte and the design name
            write(inStream, uint8_t('a'));
            writeHeaderString(inStream, mDesignName);
            // write the 'b' byte and the device name
            write(inStream, uint8_t('b'));
            writeHeaderString(inStream, mDeviceName);
            // write the 'c' byte and the design date
            write(inStream, uint8_t('c'));
            writeHeaderString(inStream, mDesignDate);
            // write the 'd' byte and the design time
            write(inStream, uint8_t('d'));
            writeHeaderString(inStream, mDesignTime);
            // write the 'e' byte and the design name
            write(inStream, uint8_t('e'));
            write(inStream, uint32_t(mBitstreamByteLength));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::bitstream::Bitstream::writeHeaderString ( std::ostream &  inStream, const string &  inString  )

inlineinherited

Write a Xilinx-style header string to the stream.

Definition at line 82 of file bitstream/Bitstream.hpp.

                                                                             {
            // write the string length
            uint16_t length = inString.length() + 1;
            write(inStream, uint16_t(length));
            inStream.write(inString.c_str(), length);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::bitstream::VirtexBitstream::writePackets ( std::ostream &  inStream )

virtual

Write bitstream packets to a stream.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 40 of file VirtexBitstream.cpp.

                                                           {
        const_iterator p = begin();
        const_iterator e = end();
        while(p < e) p++->write(inStream);
    }

void torc::bitstream::Bitstream::writeSubfieldSettings ( std::ostream &  inStream, uint32_t  inWord, const Subfield *  inSubfields  )

staticinherited

Insert 32 bit subfield settings into an output stream.

Definition at line 26 of file Bitstream.cpp.

                                     {
        // count the subfields
        int subfieldCount = 0;
        while(inSubfields[subfieldCount].mMask) subfieldCount++;
        // generate the output
        inStream << " (";
        for(int index = subfieldCount; index > 0; index--) {
            uint32_t field = index - 1;
            const Subfield& subfield = inSubfields[field];
            uint32_t value = (inWord & subfield.mMask) >> subfield.mShift;
            inStream << (*subfield.mBitgenName == 0 ? subfield.mConfigGuideName 
                : subfield.mBitgenName) << ":";
            const char** ptr = subfield.mValues;
            for(uint32_t i = 0; ; i++) {
                if(*ptr == 0) { inStream << "[UNKNOWN " << i << "]"; break; }
                if(value == i) { inStream << *ptr; break; }
                ptr++;
            }
            if(index > 1) inStream << ", ";
        }
        inStream << ")";
    }

Here is the caller graph for this function:

void torc::bitstream::Bitstream::writeSubfieldSettings ( std::ostream &  inStream, uint16_t  inWord, const Subfield *  inSubfields  )

staticinherited

Insert 16 bit subfield settings into an output stream.

Definition at line 50 of file Bitstream.cpp.

                                     {
        // count the subfields
        int subfieldCount = 0;
        while(inSubfields[subfieldCount].mMask) subfieldCount++;
        // generate the output
        inStream << " (";
        for(int index = subfieldCount; index > 0; index--) {
            uint16_t field = index - 1;
            const Subfield& subfield = inSubfields[field];
            uint16_t value = (inWord & subfield.mMask) >> subfield.mShift;
            inStream << (*subfield.mBitgenName == 0 ? subfield.mConfigGuideName 
                : subfield.mBitgenName) << ":";
            const char** ptr = subfield.mValues;
            for(uint16_t i = 0; ; i++) {
                if(*ptr == 0) { inStream << "[UNKNOWN " << i << "]"; break; }
                if(value == i) { inStream << *ptr; break; }
                ptr++;
            }
            if(index > 1) inStream << ", ";
        }
        inStream << ")";
    }

Friends And Related Function Documentation

friend class torc::bitstream::bitstream::VirtexBitstreamUnitTest

friend

Definition at line 37 of file VirtexBitstream.hpp.

Field Documentation

uint32_t torc::bitstream::Bitstream::mBitstreamByteLength

inherited

Bitstream packet length in bytes.

This is the length in bytes of all the bitstream packets, without the bitstream header.

Definition at line 242 of file bitstream/Bitstream.hpp.

FrameSet<VirtexFrame > torc::bitstream::FrameBlocks< VirtexFrame >::mBlock[Bitstream::eBlockTypeCount]

inherited

FrameSets for each of the eight block types.

Definition at line 88 of file FrameSet.hpp.

ColumnDefVector torc::bitstream::Bitstream::mColumnDefs

inherited

Column type widths.

Definition at line 249 of file bitstream/Bitstream.hpp.

string torc::bitstream::Bitstream::mDesignDate

inherited

Header design date.

Definition at line 236 of file bitstream/Bitstream.hpp.

string torc::bitstream::Bitstream::mDesignName

inherited

Header design name.

Definition at line 232 of file bitstream/Bitstream.hpp.

string torc::bitstream::Bitstream::mDesignTime

inherited

Header design time.

Definition at line 238 of file bitstream/Bitstream.hpp.

EDevice torc::bitstream::Bitstream::mDevice

inherited

Bitstream device enumeration.

Definition at line 230 of file bitstream/Bitstream.hpp.

DeviceInfo torc::bitstream::Bitstream::mDeviceInfo

inherited

Device information.

Definition at line 257 of file bitstream/Bitstream.hpp.

string torc::bitstream::Bitstream::mDeviceName

inherited

Header device name.

Definition at line 234 of file bitstream/Bitstream.hpp.

VirtexFrameBlocks torc::bitstream::VirtexBitstream::mFrameBlocks

protected

Input Frame blocks.

Definition at line 65 of file VirtexBitstream.hpp.

uint32_t torc::bitstream::Bitstream::mHeaderByteLength

inherited

Header length in bytes.

This is the length of the header itself, as opposed to mBitstreamByteLength, which is the length of bitstream reported by the header.

Definition at line 246 of file bitstream/Bitstream.hpp.

TileTypeIndexToColumnType torc::bitstream::Bitstream::mTileTypeIndexToColumnType

inherited

Definition at line 255 of file bitstream/Bitstream.hpp.

TileTypeNameToColumnType torc::bitstream::Bitstream::mTileTypeNameToColumnType

inherited

Definition at line 252 of file bitstream/Bitstream.hpp.

---

The documentation for this class was generated from the following files:

• VirtexBitstream.hpp
• VirtexBitstream.cpp