torc::bitstream::Spartan3E Class Reference

Spartan3E bitstream. More...

#include <Spartan3E.hpp>

Inheritance diagram for torc::bitstream::Spartan3E:

Collaboration diagram for torc::bitstream::Spartan3E:

Data Structures
class	FrameAddress

Public Types
enum	ERegister {   eRegisterCRC = 0, eRegisterFAR, eRegisterFDRI, eRegisterFDRO,   eRegisterCMD, eRegisterCTL, eRegisterMASK, eRegisterSTAT,   eRegisterLOUT, eRegisterCOR, eRegisterMFWR, eRegisterFLR,   eRegisterIDCODE = 14, eRegisterCount }
	Configuration register enumeration. More...
enum	ECommand {   eCommandNULL = 0, eCommandWCFG, eCommandMFWR, eCommandLFRM,   eCommandRCFG, eCommandSTART, eCommandRCAP, eCommandRCRC,   eCommandAGHIGH, eCommandSWITCH, eCommandGRESTORE, eCommandSHUTDOWN,   eCommandGCAPTURE, eCommandDESYNCH, eCommandCount }
	Configuration command enumeration for eRegisterCMD. More...
enum	EFar {   eFarMaskColumn = 0x06000000, eFarShiftColumn = 25, eFarMaskMajor = 0x01fe0000, eFarShiftMajor = 17,   eFarMaskMinor = 0x0001fe00, eFarShiftMinor = 9 }
	Frame Address Register subfields. More...
enum	EFarTopBottom { eFarTop = 0, eFarBottom = 1 }
	Frame Address Register top and bottom constants. More...
enum	EFarBlockType {   eFarBlockType0 = 0, eFarBlockType1, eFarBlockType2, eFarBlockType3,   eFarBlockType4, eFarBlockType5, eFarBlockType6, eFarBlockType7,   eFarBlockTypeCount }
	Frame Address Register block type constants. More...
enum	EColumnType {   eColumnTypeEmpty = 0, eColumnTypeBram, eColumnTypeBramInt, eColumnTypeClb,   eColumnTypeClock, eColumnTypeClockLL, eColumnTypeTerm, eColumnTypeIob,   eColumnTypeCount }
	Major column types. More...
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...

Public Member Functions
	Spartan3E (void)
	Basic constructor. More...
virtual void	initializeDeviceInfo (const std::string &inDeviceName)
	Initialize the device information. More...
virtual void	initializeFrameMaps (void)
	Initialize the maps between frame indexes and frame addresses. This is generally only useful for internal purposes. More...
virtual uint32_t	getFrameLength (void) const
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	preflightPackets (void)
	Preflight the packets. More...
virtual void	updatePacketLength (void)
	Update the header packet length. 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	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...

Static Public Member Functions
static uint32_t	makeSubfield (ERegister inRegister, const std::string &inSubfield, const std::string &inSetting)
	Return the masked value for a subfield of the specified register. More...
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...

Protected Types
typedef boost::uint32_t	uint32_t
	Imported type name. More...
typedef std::map< uint32_t, Spartan3E::FrameAddress >	FrameIndexToAddress
	Map from frame index to frame address. More...
typedef std::map < Spartan3E::FrameAddress, uint32_t >	FrameAddressToIndex
	Map from frame address to frame index. More...
typedef std::vector< uint32_t >	ColumnIndexVector
	Array of vectors to store frame indexes of each block type. More...

Protected Attributes
FrameIndexToAddress	mFrameIndexToAddress
	Map of frame indexes to frame addresses. More...
FrameAddressToIndex	mFrameAddressToIndex
	Map of frame addressee to frame indexes. More...
ColumnIndexVector	mBitColumnIndexes [Spartan3E::eFarBlockTypeCount]
	Vector to store frame indexes of XDL columns. More...
ColumnIndexVector	mXdlColumnIndexes [Spartan3E::eFarBlockTypeCount]
	Vector to store frame indexes of Bitstream columns. More...

Static Protected Attributes
static const char *	sPacketTypeName [ePacketTypeCount]
	Packet type names. More...
static const char *	sOpcodeName [eOpcodeCount]
	Packet opcode names. More...
static const char *	sRegisterName [eRegisterCount]
	Configuration register names. More...
static const char *	sCommandName [eCommandCount]
	Configuration command names. More...
static const Subfield	sCOR []
	Configuration Options Register (COR) subfields. More...
static const Subfield	sSTAT []
	Status Register (STAT) subfields. More...
static const Subfield	sCTL []
	Control Register (CTL) subfields. More...
static const Subfield	sMASK []
	Control Mask Register (MASK) subfields. More...

Friends
class	torc::bitstream::bitstream::Spartan3EUnitTest
class	torc::bitstream::bitstream::Spartan3EFarUnitTest
void	torc::bitstream::bitstream::testSpartan3EDevice (const std::string &inDeviceName, const boost::filesystem::path &inWorkingPath)
std::ostream &	operator<< (std::ostream &os, const Spartan3E &rhs)
	Insert the bitstream header into an output stream. More...

Detailed Description

Spartan3E bitstream.

Definition at line 38 of file Spartan3E.hpp.

Member Typedef Documentation

typedef std::vector<uint32_t> torc::bitstream::Spartan3E::ColumnIndexVector

protected

Array of vectors to store frame indexes of each block type.

Definition at line 189 of file Spartan3E.hpp.

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

inherited

Imported type name.

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

typedef std::map<Spartan3E::FrameAddress, uint32_t> torc::bitstream::Spartan3E::FrameAddressToIndex

protected

Map from frame address to frame index.

Definition at line 187 of file Spartan3E.hpp.

typedef std::map<uint32_t, Spartan3E::FrameAddress> torc::bitstream::Spartan3E::FrameIndexToAddress

protected

Map from frame index to frame address.

Definition at line 185 of file Spartan3E.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::Spartan3E::uint32_t

protected

Imported type name.

Definition at line 46 of file Spartan3E.hpp.

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

inherited

Imported type name.

Definition at line 61 of file bitstream/Bitstream.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::Spartan3E::EColumnType

Major column types.

These are defined and used for internal purposes only, and are not derived from any Xilinx documentation.

Enumerator
eColumnTypeEmpty
eColumnTypeBram
eColumnTypeBramInt
eColumnTypeClb
eColumnTypeClock
eColumnTypeClockLL
eColumnTypeTerm
eColumnTypeIob
eColumnTypeCount

Definition at line 78 of file Spartan3E.hpp.

                         { eColumnTypeEmpty = 0, eColumnTypeBram, eColumnTypeBramInt, eColumnTypeClb,
             eColumnTypeClock, eColumnTypeClockLL, eColumnTypeTerm, eColumnTypeIob, eColumnTypeCount };

enum torc::bitstream::Spartan3E::ECommand

Configuration command enumeration for eRegisterCMD.

See Also

CMD register commands: XAPP452, v1.1, June 25, 2008, Table 2.

Enumerator
eCommandNULL
eCommandWCFG
eCommandMFWR
eCommandLFRM
eCommandRCFG
eCommandSTART
eCommandRCAP
eCommandRCRC
eCommandAGHIGH
eCommandSWITCH
eCommandGRESTORE
eCommandSHUTDOWN
eCommandGCAPTURE
eCommandDESYNCH
eCommandCount

Definition at line 58 of file Spartan3E.hpp.

                      { eCommandNULL = 0, eCommandWCFG, eCommandMFWR, eCommandLFRM, eCommandRCFG, 
            eCommandSTART, eCommandRCAP, eCommandRCRC, eCommandAGHIGH, eCommandSWITCH, 
            eCommandGRESTORE, eCommandSHUTDOWN, eCommandGCAPTURE, eCommandDESYNCH, eCommandCount };

enum torc::bitstream::Spartan3E::EFar

Frame Address Register subfields.

See Also

Frame Address Register Description: XAPP452, v1.1, June 25, 2008, Figure 2.

Enumerator
eFarMaskColumn
eFarShiftColumn
eFarMaskMajor
eFarShiftMajor
eFarMaskMinor
eFarShiftMinor

Definition at line 64 of file Spartan3E.hpp.

                  {
            eFarMaskColumn =    0x06000000,     eFarShiftColumn =   25,
            eFarMaskMajor =     0x01fe0000,     eFarShiftMajor  =   17,
            eFarMaskMinor =     0x0001fe00,     eFarShiftMinor  =    9
        };

enum torc::bitstream::Spartan3E::EFarBlockType

Frame Address Register block type constants.

Enumerator
eFarBlockType0
eFarBlockType1
eFarBlockType2
eFarBlockType3
eFarBlockType4
eFarBlockType5
eFarBlockType6
eFarBlockType7
eFarBlockTypeCount

Definition at line 73 of file Spartan3E.hpp.

                           { eFarBlockType0 = 0, eFarBlockType1, eFarBlockType2, eFarBlockType3, 
            eFarBlockType4, eFarBlockType5, eFarBlockType6, eFarBlockType7, eFarBlockTypeCount };

enum torc::bitstream::Spartan3E::EFarTopBottom

Frame Address Register top and bottom constants.

Enumerator
eFarTop
eFarBottom

Definition at line 71 of file Spartan3E.hpp.

{ eFarTop = 0, eFarBottom = 1 };

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::SpartanPacketConstants::EOpcode

inherited

Packet opcode enumeration.

Enumerator
eOpcodeNOP
eOpcodeRead
eOpcodeWrite
eOpcodeReserved
eOpcodeCount

Definition at line 42 of file SpartanPacket.hpp.

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

enum torc::bitstream::SpartanPacketConstants::EPacket

inherited

Packet subfields.

See Also

type 1 packet format: XAPP452, v1.1, June 25, 2008, Figure 6.

type 2 packet format: XAPP452, v1.1, June 25, 2008, Figure 7.

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

Definition at line 46 of file SpartanPacket.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::SpartanPacketConstants::EPacketType

inherited

Packet type enumeration.

See Also

packet type: XAPP452, v1.1, June 25, 2008, Figure 6, 7.

Enumerator
ePacketType1
ePacketType2
ePacketTypeCount

Definition at line 39 of file SpartanPacket.hpp.

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

enum torc::bitstream::Spartan3E::ERegister

Configuration register enumeration.

See Also

configuration registers: XAPP452, v1.1, June 25, 2008, Table 1.

Enumerator
eRegisterCRC
eRegisterFAR
eRegisterFDRI
eRegisterFDRO
eRegisterCMD
eRegisterCTL
eRegisterMASK
eRegisterSTAT
eRegisterLOUT
eRegisterCOR
eRegisterMFWR
eRegisterFLR
eRegisterIDCODE
eRegisterCount

Definition at line 52 of file Spartan3E.hpp.

                       { eRegisterCRC = 0, eRegisterFAR, eRegisterFDRI, eRegisterFDRO, 
            eRegisterCMD, eRegisterCTL, eRegisterMASK, eRegisterSTAT, eRegisterLOUT, eRegisterCOR, 
            eRegisterMFWR, eRegisterFLR, eRegisterIDCODE = 14, eRegisterCount };

enum torc::bitstream::SpartanPacketConstants::ESynchronization

inherited

Synchronization words.

See Also

Configuration Sequence: XAPP452, v1.1, June 25, 2008, Table 9.

Enumerator
eSynchronizationDummy
eSynchronizationSync
eSynchronizationBusWidthSync
eSynchronizationBusWidthDetect

Definition at line 60 of file SpartanPacket.hpp.

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

Constructor & Destructor Documentation

torc::bitstream::Spartan3E::Spartan3E ( void  )

inline

Basic constructor.

Definition at line 103 of file Spartan3E.hpp.

                        : SpartanBitstream() {
//          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, 76,  0,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeBramInt] = ColumnDef("BramInt",  0,  0, 19,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeClb]     = ColumnDef("Clb",     19,  0,  0,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeClock]   = ColumnDef("Clock",    3,  0,  0,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeClockLL] = ColumnDef("ClockLL",  4,  0,  0,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeIob]     = ColumnDef("Iob",     19,  0,  0,  0,  0,  0,  0,  0);
            mColumnDefs[eColumnTypeTerm]    = ColumnDef("Term",     2,  0,  0,  0,  0,  0,  0,  0);
            // map type type names to column types
            mTileTypeNameToColumnType["BRAMSITE2"]      = eColumnTypeBram;
            mTileTypeNameToColumnType["BRAM3_SMALL"]    = eColumnTypeBramInt;
            mTileTypeNameToColumnType["CENTER_SMALL"]   = eColumnTypeClb;
            mTileTypeNameToColumnType["CLKV"]           = eColumnTypeClock;
            mTileTypeNameToColumnType["CLKV_LL"]        = eColumnTypeClockLL;
            mTileTypeNameToColumnType["LIOIS"]          = eColumnTypeIob;
            mTileTypeNameToColumnType["RIOIS"]          = eColumnTypeIob;
            mTileTypeNameToColumnType["LTERM"]          = eColumnTypeTerm;
            mTileTypeNameToColumnType["RTERM"]          = eColumnTypeTerm;
        }

Member Function Documentation

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:

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);
        }

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:

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

inlinevirtual

Reimplemented from torc::bitstream::Bitstream.

Definition at line 170 of file Spartan3E.hpp.

                                                    {
            using namespace torc::common;
            // lengths obtained directly from bitstream Frame Length Register
            switch(mDevice) {
                case eXC3S100E: return 49;
                case eXC3S250E: return 73;
                case eXC3S500E: return 97;
                case eXC3S1200E: return 125;
                case eXC3S1600E: return 157;
                default: 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:

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

virtual

Initialize the device information.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 218 of file Spartan3E.cpp.

                                                                      {
        using namespace torc::common;
        switch(mDevice) {
            case eXC3S100E: setDeviceInfo(xc3s100e); break;
            case eXC3S250E: setDeviceInfo(xc3s250e); break;
            case eXC3S500E: setDeviceInfo(xc3s500e); break;
            case eXC3S1200E: setDeviceInfo(xc3s1200e); break;
            case eXC3S1600E: setDeviceInfo(xc3s1600e); break;
            default: break;
        }
    }

Here is the call graph for this function:

void torc::bitstream::Spartan3E::initializeFrameMaps ( void  )

virtual

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

Reimplemented from torc::bitstream::Bitstream.

Definition at line 313 of file Spartan3E.cpp.

                                            {

        uint32_t frameCount = 0;
        uint32_t frameIndex = 0;
        bool clockColumn = true;
        uint32_t width;
        for(uint32_t i = 0; i < Spartan3E::eFarBlockTypeCount; i++) {
            Spartan3E::EFarBlockType blockType = Spartan3E::EFarBlockType(i);
            //Set first frame index to 0
            uint32_t bitIndex = 0;
            uint32_t xdlIndex = 0;
            mBitColumnIndexes[i].push_back(bitIndex);
            mXdlColumnIndexes[i].push_back(xdlIndex);
            // build the columns
            uint32_t farMajor = 0;
            typedef torc::common::EncapsulatedInteger<uint16_t> ColumnIndex;
            if(clockColumn) {
              if(mDeviceInfo.getColCount() > 41)
                width = mColumnDefs[eColumnTypeClockLL][i];
              else
                width = mColumnDefs[eColumnTypeClock][i];
              clockColumn = false;
              for(uint32_t farMinor = 0; farMinor < width; farMinor++) {
                  Spartan3E::FrameAddress far(blockType, farMajor, farMinor);
                  mFrameIndexToAddress[frameIndex] = far;
                  mFrameAddressToIndex[far] = frameIndex;
                  frameIndex++;
              }
              if(width > 0) farMajor++;
              frameCount += width;
            }
            for(ColumnIndex col; col < mDeviceInfo.getColCount(); col++) {
                if(mDeviceInfo.getColumnTypes()[col] == eColumnTypeClock ||
                     mDeviceInfo.getColumnTypes()[col] == eColumnTypeClockLL)
                  continue;
                else
                {
                  width = mColumnDefs[mDeviceInfo.getColumnTypes()[col]][i];
                  //printf("Width found: %d", width);
                }
                for(uint32_t farMinor = 0; farMinor < width; farMinor++) {
                    Spartan3E::FrameAddress far(blockType, farMajor, farMinor);
                    mFrameIndexToAddress[frameIndex] = far;
                    mFrameAddressToIndex[far] = frameIndex;
                    frameIndex++;
                }
                if(width > 0) farMajor++;
                frameCount += width;

                //Indexes for Bitstream Columns, only stores non-empty tile types
                if(mDeviceInfo.getColumnTypes()[col] != Spartan3E::eColumnTypeEmpty) {
                  bitIndex += width;
                  mBitColumnIndexes[i].push_back(bitIndex);
                }
                //Indexes for XDL Columns, stores interconnect and tile indexes for
                //non-empty tiles
                xdlIndex += width;
                mXdlColumnIndexes[i].push_back(xdlIndex);
            }
        }

        //Test to check proper indexing
        bool debug = false;
        if(debug) {
          for(uint32_t i = 0; i < Spartan3E::eFarBlockTypeCount; i++) {
            for(uint32_t j = 0; j < mBitColumnIndexes[i].size(); j++) 
              std::cout << "Bit Value at index: (" << i << ", " << j << ") : " << mBitColumnIndexes[i][j] << std::endl;
            for(uint32_t k = 0; k < mXdlColumnIndexes[i].size(); k++)
              std::cout << "Xdl Value at index: (" << i << ", " << k << ") : " << mXdlColumnIndexes[i][k] << std::endl;
          }
        }
    }

Here is the call graph for this function:

uint32_t torc::bitstream::Spartan3E::makeSubfield ( ERegister  inRegister, const std::string &  inSubfield, const std::string &  inSetting  )

static

Return the masked value for a subfield of the specified register.

Definition at line 186 of file Spartan3E.cpp.

                                    {
        const Subfield* subfields;
        switch(inRegister) {
        case eRegisterCOR: subfields = sCOR; break;
        case eRegisterSTAT: subfields = sSTAT; break;
        case eRegisterCTL: subfields = sCTL; break;
        case eRegisterMASK: subfields = sMASK; break;
        default: return 0;
        }
        for(uint32_t field = 0; subfields[field].mMask != 0; field++) {
            const Subfield& subfield = subfields[field];
            if(inSubfield != subfield.mBitgenName && inSubfield != subfield.mConfigGuideName) 
                continue;
            const char** ptr = subfield.mValues;
            for(uint32_t i = 0; *ptr != 0; i++, ptr++) {
                if(inSetting == *ptr) return (i << subfield.mShift) & subfield.mMask;
            }
        }
        return 0;
    }

Here is the caller graph for this function:

void torc::bitstream::SpartanBitstream::preflightPackets ( void  )

virtualinherited

Preflight the packets.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 50 of file SpartanBitstream.cpp.

                                                {
        // determine which architecture this is
        DeviceDesignator deviceDesignator(getDeviceName());
        DeviceDesignator::EFamily family = deviceDesignator.getFamily();
        // 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(family) {
        case DeviceDesignator::eFamilySpartan3E: 
            cmdRegister = Spartan3E::eRegisterCMD; rcrcCommand = Spartan3E::eCommandRCRC; 
            fdriRegister = Spartan3E::eRegisterFDRI; crcRegister = Spartan3E::eRegisterCRC; 
            addressLength = 5; autoCrc = true; 
            break;
        default:
            std::cerr << "Unsupported architecture in SpartanBitstream::preflightPackets()."
                << 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 SpartanPacket& 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) = SpartanPacket::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
                if(autoCrc && address == fdriRegister) {
                    //printf("Expected Auto CRC16:   %4.4x\n", (*p)[0]);
                    //printf("Calculated Auto CRC16: %4.4x\n", crc16.checksum());
                    *p = SpartanPacket(crc16.checksum()); // current word is FDRI, next is Auto CRC
                    crc16.reset();
                }
            }
        }
    }

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:

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::SpartanBitstream::readPackets ( std::istream &  inStream )

virtualinherited

Read bitstream packets from a stream.

Note

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

Reimplemented from torc::bitstream::Bitstream.

Definition at line 27 of file SpartanBitstream.cpp.

                                                           {
        uint32_t bitstreamWordLength = mBitstreamByteLength >> 2;
        uint32_t cumulativeWordLength = 0;
        while(cumulativeWordLength < bitstreamWordLength) {
            push_back(SpartanPacket::read(inStream));
            uint32_t wordSize = back().getWordSize();
            cumulativeWordLength += wordSize;
            // infer Auto CRCs for writes equal to or longer than one frame (not rigorously correct)
            if(wordSize <= getFrameLength()) continue;
            uint32_t autoCrc = 0;
            inStream.read((char*) &autoCrc, sizeof(autoCrc));
            autoCrc = ntohl(autoCrc);
            push_back(SpartanPacket(autoCrc));
            cumulativeWordLength++;
        }
    }

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::SpartanBitstream::updatePacketLength ( void  )

virtualinherited

Update the header packet length.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 121 of file SpartanBitstream.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::SpartanBitstream::writePackets ( std::ostream &  inStream )

virtualinherited

Write bitstream packets to a stream.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 44 of file SpartanBitstream.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

std::ostream& operator<< ( std::ostream &  os, const Spartan3E &  rhs  )

friend

Insert the bitstream header into an output stream.

Definition at line 88 of file bitstream/OutputStreamHelpers.cpp.

                                                                  {
        // insert the bitstream header
        os << static_cast<const Bitstream>(rhs) << std::endl;
        uint32_t cumulativeWordLength = 0;
        bool newColumn = false;
        bool newBlock = false;
        uint32_t oldColumnValue = 0;
        uint32_t oldBlockValue = 0;
        uint32_t currentColumnValue = 0;
        uint32_t currentBlockValue = 0;

        // iterate over the packets
        Spartan3E::ERegister address = Spartan3E::ERegister();
        //SpartanPacketVector::const_iterator p = rhs.begin();
        std::vector<SpartanPacket>::const_iterator p = rhs.begin();
        //SpartanPacketVector::const_iterator e = rhs.end();
        std::vector<SpartanPacket>::const_iterator e = rhs.end();
        while(p < e) {

            // insert the byte address
            os << "    " << Hex32(rhs.getHeaderByteLength() + (cumulativeWordLength << 2)) << ": ";
            // look up the packet
            const SpartanPacket& packet = *p++;
            cumulativeWordLength += packet.getWordSize();

            // handle dummy words
            if(packet.isDummyWord()) {
                os << "DUMMY" << std::endl;

            // handle sync words
            } else if(packet.isSyncWord()) {
                os << "SYNC" << std::endl;

            // handle reserved packets
            } else if(packet.isReserved()) {
                os << Spartan3E::sOpcodeName[packet.getOpcode()] << std::endl;
            
            // handle NOP packets
            } else if(packet.isNop()) {
                int nops = 1;
                while(p < e && p->isNop()) { nops++; p++; }
                cumulativeWordLength += nops - 1;
                os << "NOP x " << nops << std::endl;

            // handle regular type 1 or type 2 packets
            } else {

                // look up the packet details
                Spartan3E::EPacketType type = packet.getType();
                Spartan3E::EOpcode opcode = packet.getOpcode();
                uint32_t wordCount = packet.getWordCount();
                const uint32_t word = packet[1];

                // account for the packet type
                os << Spartan3E::sPacketTypeName[type];
                switch(type) {
                case Spartan3E::ePacketType1: 
                    address = Spartan3E::ERegister(packet.getAddress());
                    break;
                case Spartan3E::ePacketType2: 
                    break;
                default: 
                    os << std::endl;
                    continue;
                }

                // handle read packets
                if(opcode == packet.isRead()) {
                    os << " READ " << Spartan3E::sRegisterName[address];

                // handle write packets
                } else if(opcode == Spartan3E::eOpcodeWrite) {
                    os << " WRITE " << Spartan3E::sRegisterName[address];
                    // process according to register address
                    switch(address) {
                    case Spartan3E::eRegisterFDRI:
                        os << ": " << Hex32(wordCount) << " words";
                        if(wordCount == 0) break;
                        // include the Auto CRC information
                        os << std::endl << "    ";
                        os << Hex32(rhs.getHeaderByteLength() + (cumulativeWordLength << 2)) 
                            << ": Auto CRC: " << Hex16(p->getHeader());
                        cumulativeWordLength += 1;
                        p++;
                        break;
                    case Spartan3E::eRegisterCMD: 
                        os << " " << Spartan3E::sCommandName[word];
                        break;
                    case Spartan3E::eRegisterCOR:
                        os << ": " << Hex32(word);
                        Spartan3E::writeSubfieldSettings(os, uint32_t(word), Spartan3E::sCOR);
                        break;
                    case Spartan3E::eRegisterSTAT:
                        os << ": " << Hex32(word);
                        Spartan3E::writeSubfieldSettings(os, uint32_t(word), Spartan3E::sSTAT);
                        break;
                    case Spartan3E::eRegisterCTL:
                        os << ": " << Hex32(word);
                        Spartan3E::writeSubfieldSettings(os, uint32_t(word), Spartan3E::sCTL);
                        break;
                    case Spartan3E::eRegisterMASK:
                        os << ": " << Hex32(word);
                        Spartan3E::writeSubfieldSettings(os, uint32_t(word), Spartan3E::sMASK);
                        break;
                    // Added to make frame mapping debug easier
                    case Spartan3E::eRegisterLOUT:
                        oldColumnValue = currentColumnValue;
                        oldBlockValue = currentBlockValue;
                        currentColumnValue = (word & Virtex::eFarMaskMajor);
                        currentBlockValue = (word & Virtex::eFarMaskBlockType);
                        newColumn = (currentColumnValue != oldColumnValue);
                        newBlock = (currentBlockValue != oldBlockValue);
                        os << ": " << Hex32(word);
                        if(newColumn) std::cout << "\t\t\t!!!New Column!!!";
                        if(newBlock) std::cout << "\t\t\t\t\t***New Block***" << Hex32(currentBlockValue);
                        break;
                    default:
                        // output the register contents
                        os << ": " << Hex32(word);
                        break;
                    }
                    os << std::endl;
                }

            }

        }

        // return the stream reference
        return os;
    }

friend class torc::bitstream::bitstream::Spartan3EFarUnitTest

friend

Definition at line 40 of file Spartan3E.hpp.

friend class torc::bitstream::bitstream::Spartan3EUnitTest

friend

Definition at line 39 of file Spartan3E.hpp.

void torc::bitstream::bitstream::testSpartan3EDevice ( const std::string &  inDeviceName, const boost::filesystem::path &  inWorkingPath  )

friend

Field Documentation

ColumnIndexVector torc::bitstream::Spartan3E::mBitColumnIndexes[Spartan3E::eFarBlockTypeCount]

protected

Vector to store frame indexes of XDL columns.

Definition at line 197 of file Spartan3E.hpp.

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.

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.

FrameAddressToIndex torc::bitstream::Spartan3E::mFrameAddressToIndex

protected

Map of frame addressee to frame indexes.

Definition at line 195 of file Spartan3E.hpp.

FrameIndexToAddress torc::bitstream::Spartan3E::mFrameIndexToAddress

protected

Map of frame indexes to frame addresses.

Definition at line 193 of file Spartan3E.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.

ColumnIndexVector torc::bitstream::Spartan3E::mXdlColumnIndexes[Spartan3E::eFarBlockTypeCount]

protected

Vector to store frame indexes of Bitstream columns.

Definition at line 199 of file Spartan3E.hpp.

const char * torc::bitstream::Spartan3E::sCommandName

staticprotected

Initial value:

= {
        "NULL", "WCFG", "MFWR", "LFRM", "RCFG", "START", "RCAP", "RCRC", "AGHIGH", "SWITCH", 
        "GRESTORE", "SHUTDOWN", "GCAPTURE", "DESYNCH"
    }

Configuration command names.

Definition at line 91 of file Spartan3E.hpp.

const Bitstream::Subfield torc::bitstream::Spartan3E::sCOR

staticprotected

Configuration Options Register (COR) subfields.

See Also

Configuration Options Register Description: XAPP452, v1.1, June 25, 2008, Table 5.

Definition at line 93 of file Spartan3E.hpp.

const Bitstream::Subfield torc::bitstream::Spartan3E::sCTL

staticprotected

Initial value:

= { 
        {0x00000001,  0, "GTS_USER_B", "GTS_USER_B", 0, 
            
            
            VALUES{"IoDisabled", "IoActive", 0}},
        {0x00000008,  3, "Persist", "PERSIST", 0, 
            
            
            VALUES{"No", "Yes", 0}},
        {0x00000030,  4, "Security", "SBITS", 0, 
            
            
            
            VALUES{"None", "Level1", "Level2", "Level2", 0}},
        {0, 0, 0, 0, 0, 0}
    }

Control Register (CTL) subfields.

See Also

Control Register Description: XAPP452, v1.1, June 25, 2008, Table 3.

Definition at line 97 of file Spartan3E.hpp.

const Bitstream::Subfield torc::bitstream::Spartan3E::sMASK

staticprotected

Initial value:

= { 
        {0x00000001,  0, "GTS_USER_B", "GTS_USER_B", 0, VALUES{"Protected", "Writable", 0}},
        {0x00000008,  3, "Persist", "PERSIST", 0, VALUES{"Protected", "Writable", 0}},
        {0x00000080,  4, "Security", "SBITS", 0, 
            VALUES{"Protected", "[UNKNOWN 1]", "[UNKNOWN 2]", "Writable", 0}},
        {0, 0, 0, 0, 0, 0}
    }

Control Mask Register (MASK) subfields.

See Also

Control Mask Register Description: Inferred from Table 3.

Definition at line 99 of file Spartan3E.hpp.

const char * torc::bitstream::Spartan3E::sOpcodeName

staticprotected

Initial value:

= {
        "NOP", "READ", "WRITE", "RESERVED"
    }

Packet opcode names.

Definition at line 87 of file Spartan3E.hpp.

const char * torc::bitstream::Spartan3E::sPacketTypeName

staticprotected

Initial value:

= {
        "[UNKNOWN TYPE 0]", "TYPE1", "TYPE2", "[UNKNOWN TYPE 3]", "[UNKNOWN TYPE 4]", 
        "[UNKNOWN TYPE 5]", "[UNKNOWN TYPE 6]", "[UNKNOWN TYPE 7]"
    }

Packet type names.

Definition at line 85 of file Spartan3E.hpp.

const char * torc::bitstream::Spartan3E::sRegisterName

staticprotected

Initial value:

= {
        "CRC", "FAR", "FDRI", "FDRO", "CMD", "CTL", "MASK", "STAT", "LOUT", "COR", "MFWR", "FLR",
        "[UNKNOWN_REGISTER 12]", "[UNKNOWN_REGISTER 13]", "IDCODE"
    }

Configuration register names.

Definition at line 89 of file Spartan3E.hpp.

const Bitstream::Subfield torc::bitstream::Spartan3E::sSTAT

staticprotected

Status Register (STAT) subfields.

See Also

Status Register Description: XAPP452, v1.1, June 25, 2008, Table 4.

Note

The "bitgen" names attempt to mimic the general bitgen convention.

Definition at line 95 of file Spartan3E.hpp.

---

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

• Spartan3E.hpp
• Spartan3E.cpp