torc::bitstream::SpartanPacket Class Reference

Bitstream packet for Spartan class architectures. More...

#include <SpartanPacket.hpp>

Inheritance diagram for torc::bitstream::SpartanPacket:

Collaboration diagram for torc::bitstream::SpartanPacket:

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
	SpartanPacket (void)
	Null constructor. More...
	SpartanPacket (uint32_t inHeader, uint32_t inCount, uint32_t inWord, uint32_t *inWords)
	Full constructor. More...
	SpartanPacket (uint32_t inHeader, uint32_t inWord)
	Header plus single word constructor. More...
	SpartanPacket (uint32_t inHeader)
	Header only constructor. More...
	SpartanPacket (const SpartanPacket &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...
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 SpartanPacket	read (std::istream &inStream)
	Read a packet. More...
static SpartanPacket	makeNullType1Write (uint32_t inAddress)
	Construct a null type 1 write packet. More...
static SpartanPacket	makeType1Write (uint32_t inAddress, uint32_t inWord)
	Construct a type 1 write packet. More...
static SpartanPacket	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::SpartanPacketUnitTest

Detailed Description

Bitstream packet for Spartan class architectures.

Definition at line 69 of file SpartanPacket.hpp.

Member Typedef Documentation

typedef boost::uint32_t torc::bitstream::SpartanPacket::uint32_t

protected

Imported type name.

Definition at line 74 of file SpartanPacket.hpp.

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

protected

Word shared array type.

Definition at line 76 of file SpartanPacket.hpp.

Member Enumeration Documentation

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

inline

Null constructor.

Definition at line 101 of file SpartanPacket.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::SpartanPacket::SpartanPacket ( uint32_t  inHeader, uint32_t  inCount, uint32_t  inWord, uint32_t *  inWords  )

inline

Full constructor.

Definition at line 104 of file SpartanPacket.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::SpartanPacket::SpartanPacket ( uint32_t  inHeader, uint32_t  inWord  )

inline

Header plus single word constructor.

Definition at line 110 of file SpartanPacket.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::SpartanPacket::SpartanPacket ( uint32_t  inHeader )

inline

Header only constructor.

Definition at line 115 of file SpartanPacket.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::SpartanPacket::SpartanPacket ( const SpartanPacket &  rhs )

inline

Copy constructor.

Definition at line 120 of file SpartanPacket.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::SpartanPacket::getAddress ( void  ) const

inline

Definition at line 237 of file SpartanPacket.hpp.

{ return mAddress; }

Here is the caller graph for this function:

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

inline

Definition at line 238 of file SpartanPacket.hpp.

{ return mHeader; }

Here is the caller graph for this function:

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

inline

Definition at line 236 of file SpartanPacket.hpp.

{ return mOpcode; }

Here is the caller graph for this function:

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

inline

Definition at line 235 of file SpartanPacket.hpp.

{ return mType; }

Here is the caller graph for this function:

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

inline

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

Definition at line 240 of file SpartanPacket.hpp.

{ return mCount; }

Here is the caller graph for this function:

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

inline

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

Definition at line 242 of file SpartanPacket.hpp.

{ return mCount + 1; }

Here is the caller graph for this function:

void torc::bitstream::SpartanPacket::initialize ( void  )

inlineprotected

Definition at line 78 of file SpartanPacket.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::SpartanPacket::isBusWidthDetectWord ( void  ) const

inline

Definition at line 254 of file SpartanPacket.hpp.

{ return mHeader == eSynchronizationBusWidthDetect; }

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

inline

Definition at line 253 of file SpartanPacket.hpp.

{ return mHeader == eSynchronizationBusWidthSync; }

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

inline

Definition at line 251 of file SpartanPacket.hpp.

{ return mHeader == eSynchronizationDummy; }

Here is the caller graph for this function:

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

inline

Definition at line 247 of file SpartanPacket.hpp.

{ return mOpcode == eOpcodeNOP; }

Here is the caller graph for this function:

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

inline

Definition at line 249 of file SpartanPacket.hpp.

{ return mOpcode == eOpcodeRead; }

Here is the caller graph for this function:

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

inline

Definition at line 248 of file SpartanPacket.hpp.

{ return mOpcode == eOpcodeReserved; }

Here is the caller graph for this function:

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

inline

Definition at line 252 of file SpartanPacket.hpp.

{ return mHeader == eSynchronizationSync; }

Here is the caller graph for this function:

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

inline

Definition at line 245 of file SpartanPacket.hpp.

{ return mType == ePacketType1; }

Here is the caller graph for this function:

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

inline

Definition at line 246 of file SpartanPacket.hpp.

{ return mType == ePacketType2; }

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

inline

Definition at line 250 of file SpartanPacket.hpp.

{ return mOpcode == eOpcodeWrite; }

Here is the caller graph for this function:

static uint32_t torc::bitstream::SpartanPacket::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 209 of file SpartanPacket.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 SpartanPacket torc::bitstream::SpartanPacket::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 187 of file SpartanPacket.hpp.

                                                                    {
            return SpartanPacket(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 SpartanPacket torc::bitstream::SpartanPacket::makeType1Write ( uint32_t  inAddress, uint32_t  inWord  )

inlinestatic

Construct a type 1 write packet.

Definition at line 191 of file SpartanPacket.hpp.

                                                                                 {
            return SpartanPacket(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 SpartanPacket torc::bitstream::SpartanPacket::makeType2Write ( uint32_t  inCount, uint32_t *  inWords  )

inlinestatic

Construct a type 2 write packet.

Definition at line 196 of file SpartanPacket.hpp.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

inline

Definition at line 228 of file SpartanPacket.hpp.

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

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

inlinestatic

Read a packet.

Todo:

we should throw an exception on invalid packet types

Definition at line 127 of file SpartanPacket.hpp.

                                                        {
            uint32_t count = 0;
            uint32_t header = 0;
            uint32_t word = 0;
            uint32_t* raw_words = 0;
            //bool debug = true;
            // read the header
            inStream.read((char*) &header, sizeof(header));
            header = ntohl(header);
            // process synchronization packets
            if(header == eSynchronizationDummy || header == eSynchronizationSync
                || header == eSynchronizationBusWidthSync 
                || header == eSynchronizationBusWidthDetect) {
                //if(debug) printf("Header in sync: %x\n", header) ;
                return SpartanPacket(header, 0, 0, 0);
            }
            // determine the payload length
            EPacketType type = EPacketType((header & ePacketMaskType) >> ePacketShiftType);
            switch(type) {
            case ePacketType1:
                count = (header & ePacketMaskType1Count) >> ePacketShiftType1Count;
                //if(debug) printf("Type 1: Packet Header: %x\n", header);
                //if(debug) std::cout << "Type 1: Packet Count: " << count << std::endl;
                break;
            case ePacketType2:
                count = (header & ePacketMaskType2Count) >> ePacketShiftType2Count;
                //if(debug) std::cout << "Type 2: Packet Count: " << count << std::endl;
                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);
                //if(debug) printf("Packet Count: %x\n", count);
                uint32_t* wordPtr = raw_words;
                for(uint32_t i = 0; i < count; i++, wordPtr++) *wordPtr = ntohl(*wordPtr);
            }
            // create and return the packet
            return SpartanPacket(header, count, word, raw_words);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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

inline

Write a packet.

Definition at line 175 of file SpartanPacket.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::SpartanPacketUnitTest

friend

Definition at line 70 of file SpartanPacket.hpp.

Field Documentation

int torc::bitstream::SpartanPacket::mAddress

Definition at line 93 of file SpartanPacket.hpp.

uint32_t torc::bitstream::SpartanPacket::mCount

Definition at line 88 of file SpartanPacket.hpp.

uint32_t torc::bitstream::SpartanPacket::mHeader

Definition at line 87 of file SpartanPacket.hpp.

EOpcode torc::bitstream::SpartanPacket::mOpcode

Definition at line 92 of file SpartanPacket.hpp.

EPacketType torc::bitstream::SpartanPacket::mType

Definition at line 91 of file SpartanPacket.hpp.

uint32_t torc::bitstream::SpartanPacket::mWord

Definition at line 89 of file SpartanPacket.hpp.

WordSharedArray torc::bitstream::SpartanPacket::mWords

Definition at line 90 of file SpartanPacket.hpp.

const char * torc::bitstream::SpartanPacket::sOpcodeName

static

Initial value:

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

Packet opcode names.

Definition at line 97 of file SpartanPacket.hpp.

const char * torc::bitstream::SpartanPacket::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 95 of file SpartanPacket.hpp.

---

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

• SpartanPacket.hpp
• SpartanPacket.cpp