torc::bitstream::VirtexPacket Class Reference

Bitstream packet for Virtex class architectures. More...

#include <VirtexPacket.hpp>

Inheritance diagram for torc::bitstream::VirtexPacket:

Collaboration diagram for torc::bitstream::VirtexPacket:

Public Types
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
	VirtexPacket (void)
	Null constructor. More...
	VirtexPacket (uint32_t inHeader, uint32_t inCount, uint32_t inWord, uint32_t *inWords)
	Full constructor. More...
	VirtexPacket (uint32_t inHeader, uint32_t inWord)
	Header plus single word constructor. More...
	VirtexPacket (uint32_t inHeader)
	Header only constructor. More...
	VirtexPacket (const VirtexPacket &rhs)
	Copy constructor. More...
void	write (std::ostream &inStream) const
	Write a packet. More...
uint32_t	operator[] (size_t inIndex) const
EPacketType	getType (void) const
EOpcode	getOpcode (void) const
int	getAddress (void) const
uint32_t	getHeader (void) const
uint32_t	getWordCount (void) const
	Returns the number of payload words in the packet, excluding the header word. More...
uint32_t	getWordSize (void) const
	Returns the total number of words in the packet, including the header word. More...
const WordSharedArray	getWords (void) const
	brief Returns the raw packet words, including the header word. More...
bool	isType1 (void) const
bool	isType2 (void) const
bool	isNop (void) const
bool	isReserved (void) const
bool	isRead (void) const
bool	isWrite (void) const
bool	isDummyWord (void) const
bool	isSyncWord (void) const
bool	isBusWidthSyncWord (void) const
bool	isBusWidthDetectWord (void) const

Static Public Member Functions
static VirtexPacket	read (std::istream &inStream)
	Read a packet. More...
static VirtexPacket	makeNullType1Write (uint32_t inAddress)
	Construct a null type 1 write packet. More...
static VirtexPacket	makeType1Write (uint32_t inAddress, uint32_t inWord)
	Construct a type 1 write packet. More...
static VirtexPacket	makeType1Write (uint32_t inAddress, uint32_t inCount, uint32_t *inWords)
	Construct a multi-word type 1 write packet. More...
static VirtexPacket	makeType2Write (uint32_t inCount, uint32_t *inWords)
	Construct a type 2 write packet. More...
static uint32_t	makeHeader (EPacketType inType, EOpcode inOpcode, uint32_t inAddress, uint32_t inCount)
	Construct a packet header. More...

Data Fields
uint32_t	mHeader
uint32_t	mCount
uint32_t	mWord
WordSharedArray	mWords
EPacketType	mType
EOpcode	mOpcode
int	mAddress

Static Public Attributes
static const char *	sPacketTypeName [ePacketTypeCount]
	Packet type names. More...
static const char *	sOpcodeName [eOpcodeCount]
	Packet opcode names. More...

Protected Types
typedef boost::uint32_t	uint32_t
	Imported type name. More...
typedef boost::shared_array < uint32_t >	WordSharedArray
	Word shared array type. More...

Protected Member Functions
void	initialize (void)

Friends
class	torc::bitstream::bitstream::VirtexPacketUnitTest

Detailed Description

Bitstream packet for Virtex class architectures.

Definition at line 76 of file VirtexPacket.hpp.

Member Typedef Documentation

typedef boost::uint32_t torc::bitstream::VirtexPacket::uint32_t

protected

Imported type name.

Definition at line 81 of file VirtexPacket.hpp.

typedef boost::shared_array<uint32_t> torc::bitstream::VirtexPacket::WordSharedArray

protected

Word shared array type.

Definition at line 83 of file VirtexPacket.hpp.

Member Enumeration Documentation

enum torc::bitstream::VirtexPacketConstants::EOpcode

inherited

Packet opcode enumeration.

See Also

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

Enumerator
eOpcodeNOP
eOpcodeRead
eOpcodeWrite
eOpcodeReserved
eOpcodeCount

Definition at line 45 of file VirtexPacket.hpp.

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

enum torc::bitstream::VirtexPacketConstants::EPacket

inherited

Packet subfields.

See Also

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

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

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

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

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

Definition at line 51 of file VirtexPacket.hpp.

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

enum torc::bitstream::VirtexPacketConstants::EPacketType

inherited

Packet type enumeration.

See Also

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

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

Enumerator
ePacketType1
ePacketType2
ePacketTypeCount

Definition at line 41 of file VirtexPacket.hpp.

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

enum torc::bitstream::VirtexPacketConstants::ESynchronization

inherited

Synchronization words.

See Also

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

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

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

Enumerator
eSynchronizationDummy
eSynchronizationSync
eSynchronizationBusWidthSync
eSynchronizationBusWidthDetect

Definition at line 67 of file VirtexPacket.hpp.

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

Constructor & Destructor Documentation

torc::bitstream::VirtexPacket::VirtexPacket ( void  )

inline

Null constructor.

Definition at line 108 of file VirtexPacket.hpp.

                           : mHeader(0), mCount(0), mWord(0), mWords(), mType(EPacketType(0)), 
            mOpcode(eOpcodeNOP), mAddress(0) {}

Here is the caller graph for this function:

torc::bitstream::VirtexPacket::VirtexPacket ( uint32_t  inHeader, uint32_t  inCount, uint32_t  inWord, uint32_t *  inWords  )

inline

Full constructor.

Definition at line 111 of file VirtexPacket.hpp.

            : mHeader(inHeader), mCount(inCount), mWord(inWord), mWords(WordSharedArray(inWords)), 
            mType(EPacketType(0)), mOpcode(eOpcodeNOP), mAddress(0) {
            initialize();
        }

Here is the call graph for this function:

torc::bitstream::VirtexPacket::VirtexPacket ( uint32_t  inHeader, uint32_t  inWord  )

inline

Header plus single word constructor.

Definition at line 117 of file VirtexPacket.hpp.

                                                         : mHeader(inHeader), mCount(1), 
            mWord(inWord), mWords(), mType(EPacketType(0)), mOpcode(eOpcodeNOP), mAddress(0) {
            initialize();
        }

Here is the call graph for this function:

torc::bitstream::VirtexPacket::VirtexPacket ( uint32_t  inHeader )

inline

Header only constructor.

Definition at line 122 of file VirtexPacket.hpp.

                                        : mHeader(inHeader), mCount(0), mWord(0), mWords(), 
            mType(EPacketType(0)), mOpcode(eOpcodeNOP), mAddress(0) {
            initialize();
        }

Here is the call graph for this function:

torc::bitstream::VirtexPacket::VirtexPacket ( const VirtexPacket &  rhs )

inline

Copy constructor.

Definition at line 127 of file VirtexPacket.hpp.

                                              : mHeader(rhs.mHeader), mCount(rhs.mCount), 
            mWord(rhs.mWord), mWords(rhs.mWords), mType(EPacketType(0)), mOpcode(eOpcodeNOP), 
            mAddress(0) {
            initialize();
        }

Here is the call graph for this function:

Member Function Documentation

int torc::bitstream::VirtexPacket::getAddress ( void  ) const

inline

Definition at line 243 of file VirtexPacket.hpp.

{ return mAddress; }

Here is the caller graph for this function:

uint32_t torc::bitstream::VirtexPacket::getHeader ( void  ) const

inline

Definition at line 244 of file VirtexPacket.hpp.

{ return mHeader; }

Here is the caller graph for this function:

EOpcode torc::bitstream::VirtexPacket::getOpcode ( void  ) const

inline

Definition at line 242 of file VirtexPacket.hpp.

{ return mOpcode; }

Here is the caller graph for this function:

EPacketType torc::bitstream::VirtexPacket::getType ( void  ) const

inline

Definition at line 241 of file VirtexPacket.hpp.

{ return mType; }

Here is the caller graph for this function:

uint32_t torc::bitstream::VirtexPacket::getWordCount ( void  ) const

inline

Returns the number of payload words in the packet, excluding the header word.

Definition at line 246 of file VirtexPacket.hpp.

{ return mCount; }

Here is the caller graph for this function:

const WordSharedArray torc::bitstream::VirtexPacket::getWords ( void  ) const

inline

brief Returns the raw packet words, including the header word.

Definition at line 250 of file VirtexPacket.hpp.

{ return mWords; }

Here is the caller graph for this function:

uint32_t torc::bitstream::VirtexPacket::getWordSize ( void  ) const

inline

Returns the total number of words in the packet, including the header word.

Definition at line 248 of file VirtexPacket.hpp.

{ return mCount + 1; }

Here is the caller graph for this function:

void torc::bitstream::VirtexPacket::initialize ( void  )

inlineprotected

Definition at line 85 of file VirtexPacket.hpp.

                              {
            mType = EPacketType((mHeader & ePacketMaskType) >> ePacketShiftType);
            mOpcode = EOpcode((mHeader & ePacketMaskOpcode) >> ePacketShiftOpcode);
            if(mType == ePacketType1) 
                mAddress = (mHeader & ePacketMaskType1Address) >> ePacketShiftType1Address;
        }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isBusWidthDetectWord ( void  ) const

inline

Definition at line 261 of file VirtexPacket.hpp.

{ return mHeader == eSynchronizationBusWidthDetect; }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isBusWidthSyncWord ( void  ) const

inline

Definition at line 260 of file VirtexPacket.hpp.

{ return mHeader == eSynchronizationBusWidthSync; }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isDummyWord ( void  ) const

inline

Definition at line 258 of file VirtexPacket.hpp.

{ return mHeader == eSynchronizationDummy; }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isNop ( void  ) const

inline

Definition at line 254 of file VirtexPacket.hpp.

{ return mOpcode == eOpcodeNOP; }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isRead ( void  ) const

inline

Definition at line 256 of file VirtexPacket.hpp.

{ return mOpcode == eOpcodeRead; }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isReserved ( void  ) const

inline

Definition at line 255 of file VirtexPacket.hpp.

{ return mOpcode == eOpcodeReserved; }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isSyncWord ( void  ) const

inline

Definition at line 259 of file VirtexPacket.hpp.

{ return mHeader == eSynchronizationSync; }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isType1 ( void  ) const

inline

Definition at line 252 of file VirtexPacket.hpp.

{ return mType == ePacketType1; }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isType2 ( void  ) const

inline

Definition at line 253 of file VirtexPacket.hpp.

{ return mType == ePacketType2; }

Here is the caller graph for this function:

bool torc::bitstream::VirtexPacket::isWrite ( void  ) const

inline

Definition at line 257 of file VirtexPacket.hpp.

{ return mOpcode == eOpcodeWrite; }

Here is the caller graph for this function:

static uint32_t torc::bitstream::VirtexPacket::makeHeader ( EPacketType  inType, EOpcode  inOpcode, uint32_t  inAddress, uint32_t  inCount  )

inlinestatic

Construct a packet header.

Todo:

Generate an error or throw an exception on invalid packet types?

Definition at line 215 of file VirtexPacket.hpp.

                              {
            // type 1 packets
            if(inType == ePacketType1) return 
                ((inType << ePacketShiftType) & ePacketMaskType) |
                ((inOpcode << ePacketShiftOpcode) & ePacketMaskOpcode) |
                ((inAddress << ePacketShiftType1Address) & ePacketMaskType1Address) |
                ((inCount << ePacketShiftType1Count) & ePacketMaskType1Count);
            // type 2 packets
            else if(inType == ePacketType2) return
                ((inType << ePacketShiftType) & ePacketMaskType) |
                ((inOpcode << ePacketShiftOpcode) & ePacketMaskOpcode) |
                ((inCount << ePacketShiftType2Count) & ePacketMaskType2Count);
            // undefined packet types
            else
                /// \todo Generate an error or throw an exception on invalid packet types?
                return 0;
        }

Here is the caller graph for this function:

static VirtexPacket torc::bitstream::VirtexPacket::makeNullType1Write ( uint32_t  inAddress )

inlinestatic

Construct a null type 1 write packet.

A type 1 write packet to the FDRI register is generally only useful to specify the current register in preparation for a type 2 write. The type 2 write header includes a size but specifies no target register, hence the prior null type 1 packet.

Definition at line 188 of file VirtexPacket.hpp.

                                                                   {
            return VirtexPacket(makeHeader(ePacketType1, eOpcodeWrite, inAddress, 0), 0, 0, 0);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static VirtexPacket torc::bitstream::VirtexPacket::makeType1Write ( uint32_t  inAddress, uint32_t  inWord  )

inlinestatic

Construct a type 1 write packet.

Definition at line 192 of file VirtexPacket.hpp.

                                                                                {
            return VirtexPacket(makeHeader(ePacketType1, eOpcodeWrite, inAddress, 1), 1, inWord, 0);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static VirtexPacket torc::bitstream::VirtexPacket::makeType1Write ( uint32_t  inAddress, uint32_t  inCount, uint32_t *  inWords  )

inlinestatic

Construct a multi-word type 1 write packet.

Definition at line 196 of file VirtexPacket.hpp.

        {
            return VirtexPacket(makeHeader(ePacketType1, eOpcodeWrite, inAddress, inCount), 
                inCount, 0, inWords);
        }

Here is the call graph for this function:

static VirtexPacket torc::bitstream::VirtexPacket::makeType2Write ( uint32_t  inCount, uint32_t *  inWords  )

inlinestatic

Construct a type 2 write packet.

Definition at line 202 of file VirtexPacket.hpp.

                                                                                {
            return VirtexPacket(makeHeader(ePacketType2, eOpcodeWrite, 0, inCount), inCount, 0, 
                inWords);
        }

Here is the call graph for this function:

uint32_t torc::bitstream::VirtexPacket::operator[] ( size_t  inIndex ) const

inline

Definition at line 234 of file VirtexPacket.hpp.

                                                   {
            if(inIndex == 0) return mHeader;
            if(inIndex == 1 && mCount == 1) return mWord;
            if(inIndex <= mCount) return mWords[inIndex-1];
            return 0;
        }

static VirtexPacket torc::bitstream::VirtexPacket::read ( std::istream &  inStream )

inlinestatic

Read a packet.

Todo:

we should throw an exception on invalid packet types

Definition at line 134 of file VirtexPacket.hpp.

                                                       {
            uint32_t count = 0;
            uint32_t header = 0;
            uint32_t word = 0;
            uint32_t* raw_words = 0;
            // read the header
            inStream.read((char*) &header, sizeof(header));
            header = ntohl(header);
            // process synchronization packets
            if(header == eSynchronizationDummy || header == eSynchronizationSync
                || header == eSynchronizationBusWidthSync 
                || header == eSynchronizationBusWidthDetect) {
                return VirtexPacket(header, 0, 0, 0);
            }
            // determine the payload length
            EPacketType type = EPacketType((header & ePacketMaskType) >> ePacketShiftType);
            switch(type) {
            case ePacketType1:
                count = (header & ePacketMaskType1Count) >> ePacketShiftType1Count;
                break;
            case ePacketType2:
                count = (header & ePacketMaskType2Count) >> ePacketShiftType2Count;
                break;
            default:
                /// \todo we should throw an exception on invalid packet types
                count = 0;
                break;
            }
            // read the packet payload
            if(count == 1) {
                inStream.read((char*) &word, sizeof(word));
                word = ntohl(word);
            } else if(count > 1) {
                raw_words = new uint32_t[count];
                inStream.read((char*) raw_words, count << 2);
                uint32_t* wordPtr = raw_words;
                for(uint32_t i = 0; i < count; i++, wordPtr++) *wordPtr = ntohl(*wordPtr);
            }
            // create and return the packet
            return VirtexPacket(header, count, word, raw_words);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::bitstream::VirtexPacket::write ( std::ostream &  inStream ) const

inline

Write a packet.

Definition at line 176 of file VirtexPacket.hpp.

                                               {
            uint32_t size = getWordSize();
            for(uint32_t i = 0; i < size; i++) {
                uint32_t word = htonl(operator[](i));
                inStream.write((char*) &word, sizeof(word));
            }
        }

Here is the call graph for this function:

Friends And Related Function Documentation

friend class torc::bitstream::bitstream::VirtexPacketUnitTest

friend

Definition at line 77 of file VirtexPacket.hpp.

Field Documentation

int torc::bitstream::VirtexPacket::mAddress

Definition at line 100 of file VirtexPacket.hpp.

uint32_t torc::bitstream::VirtexPacket::mCount

Definition at line 95 of file VirtexPacket.hpp.

uint32_t torc::bitstream::VirtexPacket::mHeader

Definition at line 94 of file VirtexPacket.hpp.

EOpcode torc::bitstream::VirtexPacket::mOpcode

Definition at line 99 of file VirtexPacket.hpp.

EPacketType torc::bitstream::VirtexPacket::mType

Definition at line 98 of file VirtexPacket.hpp.

uint32_t torc::bitstream::VirtexPacket::mWord

Definition at line 96 of file VirtexPacket.hpp.

WordSharedArray torc::bitstream::VirtexPacket::mWords

Definition at line 97 of file VirtexPacket.hpp.

const char * torc::bitstream::VirtexPacket::sOpcodeName

static

Initial value:

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

Packet opcode names.

Definition at line 104 of file VirtexPacket.hpp.

const char * torc::bitstream::VirtexPacket::sPacketTypeName

static

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 102 of file VirtexPacket.hpp.

---

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

• VirtexPacket.hpp
• VirtexPacket.cpp