torc::bitstream::Virtex4 Class Reference

Virtex4 bitstream. More...

#include <Virtex4.hpp>

Inheritance diagram for torc::bitstream::Virtex4:

Inheritance graph
[legend]
Collaboration diagram for torc::bitstream::Virtex4:

Collaboration graph
[legend]

List of all members.

Public Types

enum  ERegister {
  eRegisterCRC = 0, eRegisterFAR, eRegisterFDRI, eRegisterFDRO,
  eRegisterCMD, eRegisterCTL, eRegisterMASK, eRegisterSTAT,
  eRegisterLOUT, eRegisterCOR, eRegisterMFWR, eRegisterCBC,
  eRegisterIDCODE, eRegisterAXSS, eRegisterCount
}
 Configuration register enumeration. More...
enum  ECommand {
  eCommandNULL = 0, eCommandWCFG, eCommandMFWR, eCommandLFRM,
  eCommandRCFG, eCommandSTART, eCommandRCAP, eCommandRCRC,
  eCommandAGHIGH, eCommandSWITCH, eCommandGRESTORE, eCommandSHUTDOWN,
  eCommandGCAPTURE, eCommandDESYNC, eCommandCount
}
 Configuration command enumeration for eRegisterCMD. More...
enum  EFar {
  eFarMaskTopBottom = 0x00400000, eFarShiftTopBottom = 22, eFarMaskBlockType = 0x00380000, eFarShiftBlockType = 19,
  eFarMaskRow = 0x0007c000, eFarShiftRow = 14, eFarMaskMajor = 0x00003fc0, eFarShiftMajor = 6,
  eFarMaskMinor = 0x0000003f, eFarShiftMinor = 0
}
 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, eColumnTypeClb, eColumnTypeClock,
  eColumnTypeDsp, eColumnTypeGtx, eColumnTypeIob, eColumnTypeCount
}
 Major column types. More...
enum  { eFrameLength = 41 }
 Frame length. More...

Public Member Functions

 Virtex4 (void)
 Basic constructor.
virtual void initializeDeviceInfo (const std::string &inDeviceName)
 Initialize the device information.
virtual void initializeFrameMaps (void)
 Initialize the maps between frame indexes and frame addresses. This is generally only useful for internal purposes.
void initializeFullFrameBlocks (void)
 Loads full bitstream frames into block data structure.
VirtexFrameBlocks getBitstreamFrames (uint32_t inBlockCount, uint32_t inBitCol)
 Returns frames for queried bitstream co-ordinates.
VirtexFrameBlocks getXdlFrames (uint32_t inBlockCount, uint32_t inXdlCol)
 Returns frames for queried xdl co-ordinates.
virtual uint32_t getFrameLength (void) const
 Return the frame length for the current device.

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.

Protected Types

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

Protected Attributes

FrameIndexToAddress mFrameIndexToAddress
 Map of frame indexes to frame addresses.
FrameAddressToIndex mFrameAddressToIndex
 Map of frame addressee to frame indexes.
IndexVector mBitColumnIndexes [Virtex4::eFarBlockTypeCount]
 Vector to store frame indexes of XDL columns.
IndexVector mXdlColumnIndexes [Virtex4::eFarBlockTypeCount]
 Vector to store frame indexes of Bitstream columns.
uint32_t mBlockFrameIndexBounds [Virtex4::eFarBlockTypeCount]
 Array to hold frame index boundaries for blocks.
std::map< uint32_t, uint32_t > mXdlIndexToBitIndex
 Map of xdl columns to bit columns.

Static Protected Attributes

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

Friends

class torc::bitstream::bitstream::Virtex4UnitTest
class torc::bitstream::bitstream::Virtex4FarUnitTest
void testVirtex4Device (const std::string &inDeviceName, const boost::filesystem::path &inWorkingPath)
void testVirtex4FullMapping (const boost::filesystem::path &inWorkingPath)
void testVirtex4PartialMapping (const boost::filesystem::path &inWorkingPath)
std::ostream & operator<< (std::ostream &os, const Virtex4 &rhs)
 Insert the bitstream header into an output stream.

Classes

class  FrameAddress

Detailed Description

Virtex4 bitstream.

Definition at line 40 of file Virtex4.hpp.

Member Typedef Documentation

typedef boost::uint32_t torc::bitstream::Virtex4::uint32_t [protected]

Imported type name.

Reimplemented from torc::bitstream::VirtexBitstream.

Definition at line 50 of file Virtex4.hpp.

typedef std::map<uint32_t, Virtex4::FrameAddress> torc::bitstream::Virtex4::FrameIndexToAddress [protected]

Map from frame index to frame address.

Definition at line 217 of file Virtex4.hpp.

typedef std::map<Virtex4::FrameAddress, uint32_t> torc::bitstream::Virtex4::FrameAddressToIndex [protected]

Map from frame address to frame index.

Definition at line 219 of file Virtex4.hpp.

typedef std::vector<uint32_t> torc::bitstream::Virtex4::IndexVector [protected]

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

Definition at line 221 of file Virtex4.hpp.

Member Enumeration Documentation

enum torc::bitstream::Virtex4::ERegister

Configuration register enumeration.

See also:
configuration registers: UG071, v1.10, April 8, 2008, Table 7-5.

Definition at line 56 of file Virtex4.hpp.

enum torc::bitstream::Virtex4::ECommand

Configuration command enumeration for eRegisterCMD.

See also:
CMD register commands: UG071, v1.10, April 8, 2008, Table 7-6.

Definition at line 62 of file Virtex4.hpp.

enum torc::bitstream::Virtex4::EFar

Frame Address Register subfields.

See also:
Frame Address Register Description: UG071, v1.10, April 8, 2008, Table 7-8.

Definition at line 68 of file Virtex4.hpp.

enum torc::bitstream::Virtex4::EFarTopBottom

Frame Address Register top and bottom constants.

Definition at line 77 of file Virtex4.hpp.

enum torc::bitstream::Virtex4::EFarBlockType

Frame Address Register block type constants.

Definition at line 79 of file Virtex4.hpp.

enum torc::bitstream::Virtex4::EColumnType

Major column types.

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

Definition at line 84 of file Virtex4.hpp.

anonymous enum

Frame length.

Constant frame length of 41 32-bit words for the entire Virtex5 family.

See also:
Virtex-4 Frame Count, Frame Length, Overhead and Bitstream Size: UG071, v.1.10, April 8, 2008, Table 7-1.

Definition at line 90 of file Virtex4.hpp.

Constructor & Destructor Documentation

torc::bitstream::Virtex4::Virtex4 ( void   )  [inline]

Basic constructor.

Definition at line 114 of file Virtex4.hpp.

Member Function Documentation

uint32_t torc::bitstream::Virtex4::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 223 of file Virtex4.cpp.

void torc::bitstream::Virtex4::initializeDeviceInfo ( const std::string &  inDeviceName  )  [virtual]

Initialize the device information.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 277 of file Virtex4.cpp.

void torc::bitstream::Virtex4::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 385 of file Virtex4.cpp.

void torc::bitstream::Virtex4::initializeFullFrameBlocks ( void   ) 

Loads full bitstream frames into block data structure.

Definition at line 463 of file Virtex4.cpp.

VirtexFrameBlocks torc::bitstream::Virtex4::getBitstreamFrames ( uint32_t  inBlockCount,
uint32_t  inBitCol 
)

Returns frames for queried bitstream co-ordinates.

Definition at line 484 of file Virtex4.cpp.

VirtexFrameBlocks torc::bitstream::Virtex4::getXdlFrames ( uint32_t  inBlockCount,
uint32_t  inXdlCol 
)

Returns frames for queried xdl co-ordinates.

Definition at line 507 of file Virtex4.cpp.

virtual uint32_t torc::bitstream::Virtex4::getFrameLength ( void   )  const [inline, virtual]

Return the frame length for the current device.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 156 of file Virtex4.hpp.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const Virtex4 &  rhs 
) [friend]

Insert the bitstream header into an output stream.

Definition at line 634 of file OutputStreamHelpers.cpp.

Member Data Documentation

const char * torc::bitstream::Virtex4::sPacketTypeName [static, protected]

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 96 of file Virtex4.hpp.

const char * torc::bitstream::Virtex4::sOpcodeName [static, protected]

Initial value:

 {
        "NOP", "READ", "WRITE", "RESERVED"
    }
Packet opcode names.

Definition at line 98 of file Virtex4.hpp.

const char * torc::bitstream::Virtex4::sRegisterName [static, protected]

Initial value:

 {
        "CRC", "FAR", "FDRI", "FDRO", "CMD", "CTL", "MASK", "STAT", "LOUT", "COR", "MFWR", "CBC", 
        "IDCODE", "AXSS"
    }
Configuration register names.

Definition at line 100 of file Virtex4.hpp.

const char * torc::bitstream::Virtex4::sCommandName [static, protected]

Initial value:

 {
        "NULL", "WCFG", "MFWR", "LFRM", "RCFG", "START", "RCAP", "RCRC", "AGHIGH", "SWITCH", 
        "GRESTORE", "SHUTDOWN", "GCAPTURE", "DESYNC"
    }
Configuration command names.

Definition at line 102 of file Virtex4.hpp.

const Bitstream::Subfield torc::bitstream::Virtex4::sCOR [static, protected]

Configuration Options Register (COR) subfields.

See also:
Configuration Options Register Description: UG071, v1.10, April 8, 2008, Table 7-10.

Definition at line 104 of file Virtex4.hpp.

const Bitstream::Subfield torc::bitstream::Virtex4::sSTAT [static, protected]

Status Register (STAT) subfields.

See also:
Status Register Description: UG071, v1.10, April 8, 2008, Table 7-9.
Note:
The "bitgen" names attempt to mimic the general bitgen convention.

Definition at line 106 of file Virtex4.hpp.

const Bitstream::Subfield torc::bitstream::Virtex4::sCTL [static, protected]

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}},
        {0x00000100,  8, "GLUTMASK", "GLUTMASK", 0, 
            
            
            
            
            VALUES{"Masked", "Dynamic", 0}},
        {0x40000000, 30, "ICAP_sel", "ICAP_SEL", 0, 
            
            
            VALUES{"Top", "Bottom", 0}},
        {0, 0, 0, 0, 0, 0}
    }
Control Register (CTL) subfields.

See also:
Control Register Description: UG071, v1.10, April 8, 2008, Table 7-7.

Definition at line 108 of file Virtex4.hpp.

const Bitstream::Subfield torc::bitstream::Virtex4::sMASK [static, protected]

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}},
        {0x00000100,  8, "GLUTMASK", "GLUTMASK", 0, VALUES{"Protected", "Writable", 0}},
        {0x40000000, 30, "ICAP_sel", "ICAP_SEL", 0, VALUES{"Protected", "Writable", 0}},
        {0, 0, 0, 0, 0, 0}
    }
Control Mask Register (MASK) subfields.

See also:
Control Mask Register Description: Inferred from Table 7-7.

Definition at line 110 of file Virtex4.hpp.

FrameIndexToAddress torc::bitstream::Virtex4::mFrameIndexToAddress [protected]

Map of frame indexes to frame addresses.

Definition at line 225 of file Virtex4.hpp.

FrameAddressToIndex torc::bitstream::Virtex4::mFrameAddressToIndex [protected]

Map of frame addressee to frame indexes.

Definition at line 227 of file Virtex4.hpp.

IndexVector torc::bitstream::Virtex4::mBitColumnIndexes[Virtex4::eFarBlockTypeCount] [protected]

Vector to store frame indexes of XDL columns.

Definition at line 229 of file Virtex4.hpp.

IndexVector torc::bitstream::Virtex4::mXdlColumnIndexes[Virtex4::eFarBlockTypeCount] [protected]

Vector to store frame indexes of Bitstream columns.

Definition at line 231 of file Virtex4.hpp.

uint32_t torc::bitstream::Virtex4::mBlockFrameIndexBounds[Virtex4::eFarBlockTypeCount] [protected]

Array to hold frame index boundaries for blocks.

Definition at line 233 of file Virtex4.hpp.

std::map<uint32_t, uint32_t> torc::bitstream::Virtex4::mXdlIndexToBitIndex [protected]

Map of xdl columns to bit columns.

Definition at line 235 of file Virtex4.hpp.

The documentation for this class was generated from the following files:
Generated on Thu Oct 13 16:49:50 2011 for TORC by  doxygen 1.5.6