torc::bitstream::Spartan6Bitstream Class Reference

Spartan-class bitstream. More...

#include <Spartan6Bitstream.hpp>

Inheritance diagram for torc::bitstream::Spartan6Bitstream:

Collaboration diagram for torc::bitstream::Spartan6Bitstream:

Data Structures
struct	CRC
	CRC class for the Spartan6 architecture. More...

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 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 = 0xe000, ePacketShiftType = 13, ePacketMaskOpcode = 0x1800, ePacketShiftOpcode = 11,   ePacketMaskTypeAddress = 0x07e0, ePacketShiftTypeAddress = 5, ePacketMaskType1Count = 0x001f, ePacketShiftType1Count = 0,   ePacketMaskType2Count0 = 0xffff, ePacketShiftType2Count0 = 0, ePacketMaskType2Count1 = 0xffff, ePacketShiftType2Count1 = 0 }
	Packet subfields. More...
enum	ESynchronization {   eSynchronizationDummy = 0xffff, eSynchronizationSync0 = 0xaa99, eSynchronizationSync1 = 0x5566, eSynchronizationBusWidthSync0 = 0x0000,   eSynchronizationBusWidthSync1 = 0x00bb, eSynchronizationBusWidthDetect0 = 0x1122, eSynchronizationBusWidthDetect1 = 0x0044 }
	Synchronization words. More...

Public Member Functions
	Spartan6Bitstream (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	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	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...

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

Friends
class	torc::bitstream::bitstream::Spartan6BitstreamUnitTest

Detailed Description

Spartan-class bitstream.

Definition at line 32 of file Spartan6Bitstream.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 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::Spartan6Bitstream::uint16_t

protected

Imported type name.

Definition at line 38 of file Spartan6Bitstream.hpp.

typedef boost::uint32_t torc::bitstream::Spartan6Bitstream::uint32_t

protected

Definition at line 39 of file Spartan6Bitstream.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::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::Spartan6PacketConstants::EOpcode

inherited

Packet opcode enumeration.

See Also

Opcode Format: UG380, v2.2, July 30, 2010, Table 5-23

Enumerator
eOpcodeNOP
eOpcodeRead
eOpcodeWrite
eOpcodeReserved
eOpcodeCount

Definition at line 44 of file Spartan6Packet.hpp.

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

enum torc::bitstream::Spartan6PacketConstants::EPacket

inherited

Packet subfields.

See Also

type 1 packet format: UG380, v2.2, July 30, 2010, Table 5-24

type 2 packet format: UG380, v2.2, July 30, 2010, Table 5-26

type 2 packet format: UG380, v2.2, July 30, 2010, Table 5-27

Enumerator
ePacketMaskType
ePacketShiftType
ePacketMaskOpcode
ePacketShiftOpcode
ePacketMaskTypeAddress
ePacketShiftTypeAddress
ePacketMaskType1Count
ePacketShiftType1Count
ePacketMaskType2Count0
ePacketShiftType2Count0
ePacketMaskType2Count1
ePacketShiftType2Count1

Definition at line 49 of file Spartan6Packet.hpp.

                     {
            // generic packet subfields
            ePacketMaskType =            0xe000,        ePacketShiftType =            13,
            ePacketMaskOpcode =          0x1800,        ePacketShiftOpcode =          11,
            ePacketMaskTypeAddress =     0x07e0,        ePacketShiftTypeAddress =      5,
          // type 1 packet subfields
            ePacketMaskType1Count =      0x001f,        ePacketShiftType1Count =       0,
            // type 2 packet subfields
            ePacketMaskType2Count0 =     0xffff,        ePacketShiftType2Count0 =      0,
            ePacketMaskType2Count1 =     0xffff,        ePacketShiftType2Count1 =      0
        };

enum torc::bitstream::Spartan6PacketConstants::EPacketType

inherited

Packet type enumeration.

See Also

packet type: UG380, v2.2, July 30, 2010, Table 5-24, 5-26

Enumerator
ePacketType1
ePacketType2
ePacketTypeCount

Definition at line 40 of file Spartan6Packet.hpp.

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

enum torc::bitstream::Spartan6PacketConstants::ESynchronization

inherited

Synchronization words.

See Also

Configuration Sequence: UG380, v2.2, July 30, 2010, Table 5-50.

Enumerator
eSynchronizationDummy
eSynchronizationSync0
eSynchronizationSync1
eSynchronizationBusWidthSync0
eSynchronizationBusWidthSync1
eSynchronizationBusWidthDetect0
eSynchronizationBusWidthDetect1

Definition at line 63 of file Spartan6Packet.hpp.

                              {
            eSynchronizationDummy =           0xffff,
            eSynchronizationSync0 =           0xaa99,
            eSynchronizationSync1 =           0x5566,
            eSynchronizationBusWidthSync0 =   0x0000,
            eSynchronizationBusWidthSync1 =   0x00bb,
            eSynchronizationBusWidthDetect0 = 0x1122,
            eSynchronizationBusWidthDetect1 = 0x0044
        };

Constructor & Destructor Documentation

torc::bitstream::Spartan6Bitstream::Spartan6Bitstream ( void  )

inline

Basic constructor.

Definition at line 87 of file Spartan6Bitstream.hpp.

: Bitstream(), Spartan6PacketVector(), Spartan6PacketConstants() {}

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::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.

{}

void torc::bitstream::Spartan6Bitstream::preflightPackets ( void  )

virtual

Preflight the packets.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 53 of file Spartan6Bitstream.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::eFamilySpartan6: 
            cmdRegister = Spartan6::eRegisterCMD; rcrcCommand = Spartan6::eCommandRCRC; 
            fdriRegister = Spartan6::eRegisterFDRI; crcRegister = Spartan6::eRegisterCRC; 
            /*addressLength = 6*/ (void) addressLength; autoCrc = true; 
            break;
        default:
            std::cerr << "Unsupported architecture in Spartan6Bitstream::preflightPackets()."
                << std::endl;
            break;
        }
        // begin CRC calculation: calculation is derived from one of the following simulation files:
        //      ISE/verilog/src/unisims/SIM_CONFIG_S6.v
        //      ISE/vhdl/src/unisims/primitive/SIM_CONFIG_S6.vhd
        CRC crc;
        iterator p = begin();
        iterator e = end();
        while(p < e) {
            // look up the current packet
            const Spartan6Packet& packet = *p++;
            // only process write packets with non-zero payload length
            if(!packet.isWrite()) continue;
            uint32_t 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:   %8.8x\n", uint32_t(packet[1]) << 16 | packet[2]);
                //printf("Calculated CRC16: %8.8x\n", uint32_t(crc));
                *(p-1) = Spartan6Packet::makeType1Write32(crcRegister, crc);
                crc.reset();
            // reset CRC command
            } else if(address == cmdRegister && wordCount >= 1 && packet[1] == rcrcCommand) {
                crc.reset();
            // registers that are omitted from CRC calculation
            } else if(address == Spartan6::eRegisterBOOSTS || address == Spartan6::eRegisterSTAT 
                || address == Spartan6::eRegisterLOUT || address == Spartan6::eRegisterCSBO 
                || address == Spartan6::eRegisterRDBK_SIGN || address == Spartan6::eRegisterFDRO) {
            // process packet contents
            } else {
                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);
                    crc.update(address, word);
                    // debugging output
                    //for(int32_t c = sizeof(crc_curr) - 1; c >= 0; c--) printf("%d", crc_curr[c]);
                    //printf("\n");
                }
                // process the Auto CRC
                if(autoCrc && address == fdriRegister) {
                    //printf("Expected Auto CRC16:   %8.8x\n", (uint32_t((*p)[0]) << 16) | (*p)[1]);
                    //printf("Calculated Auto CRC16: %8.8x\n", uint32_t(crc));
                    // current packet is FDRI, next is Auto CRC
                    *p = Spartan6Packet(crc >> 16, crc & 0xffff);
                    // unlike the Spartan3E, the CRC is not reset after an Auto CRC
                    //crc.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::Spartan6Bitstream::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.

Definition at line 27 of file Spartan6Bitstream.cpp.

                                                            {
        uint16_t bitstreamWordLength = mBitstreamByteLength >> 1;
        uint16_t cumulativeWordLength = 0;
        while(cumulativeWordLength < bitstreamWordLength) {
            push_back(Spartan6Packet::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;
            uint16_t autoCrcHi = 0;
            uint16_t autoCrcLo = 0;
            inStream.read((char*) &autoCrcHi, sizeof(autoCrcHi));
            inStream.read((char*) &autoCrcLo, sizeof(autoCrcLo));
            autoCrcHi = ntohs(autoCrcHi);
            autoCrcLo = ntohs(autoCrcLo);
            push_back(Spartan6Packet(autoCrcHi, autoCrcLo));
            cumulativeWordLength += 2;
        }
    }

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

virtual

Update the header packet length.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 126 of file Spartan6Bitstream.cpp.

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

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::Spartan6Bitstream::writePackets ( std::ostream &  inStream )

virtual

Write bitstream packets to a stream.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 47 of file Spartan6Bitstream.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::Spartan6BitstreamUnitTest

friend

Definition at line 34 of file Spartan6Bitstream.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.

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.

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:

• Spartan6Bitstream.hpp
• Spartan6Bitstream.cpp