torc::bitstream::Virtex5 Class Reference

Virtex5 bitstream. More...

#include <Virtex5.hpp>

Inheritance diagram for torc::bitstream::Virtex5:

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

Collaboration graph
[legend]

List of all members.

Public Types

enum  ERegister {
  eRegisterCRC = 0, eRegisterFAR, eRegisterFDRI, eRegisterFDRO,
  eRegisterCMD, eRegisterCTL0, eRegisterMASK, eRegisterSTAT,
  eRegisterLOUT, eRegisterCOR0, eRegisterMFWR, eRegisterCBC,
  eRegisterIDCODE, eRegisterAXSS, eRegisterCOR1, eRegisterCSOB,
  eRegisterWBSTAR, eRegisterTIMER, eRegisterBOOTSTS = 22, eRegisterCTL1 = 24,
  eRegisterCount
}
 Configuration register enumeration. More...
enum  ECommand {
  eCommandNULL = 0, eCommandWCFG, eCommandMFW, eCommandDGHIGH,
  eCommandLFRM = eCommandDGHIGH, eCommandRCFG, eCommandSTART, eCommandRCAP,
  eCommandRCRC, eCommandAGHIGH, eCommandSWITCH, eCommandGRESTORE,
  eCommandSHUTDOWN, eCommandGCAPTURE, eCommandDESYNCH, eCommandReserved,
  eCommandIPROG, eCommandLTIMER = 17, eCommandCount
}
 Configuration command enumeration for eRegisterCMD. More...
enum  EFar {
  eFarMaskBlockType = 0x00e00000, eFarShiftBlockType = 21, eFarMaskTopBottom = 0x00100000, eFarShiftTopBottom = 20,
  eFarMaskRow = 0x000f8000, eFarShiftRow = 15, eFarMaskMajor = 0x00007f80, eFarShiftMajor = 7,
  eFarMaskMinor = 0x0000007f, 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  { eStartAddr = 0x03ffffff, eTimerValue = 0x00ffffff }
 Assorted 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

 Virtex5 (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)
 Loads partial bitstream frames into block data structure.
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,
Virtex5::FrameAddress > 		FrameIndexToAddress
 Map from frame index to frame address.
typedef std::map
< Virtex5::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 [Virtex5::eFarBlockTypeCount]
 Vector to store frame indexes of XDL columns.
IndexVector mXdlColumnIndexes [Virtex5::eFarBlockTypeCount]
 Vector to store frame indexes of Bitstream columns.
uint32_t mBlockFrameIndexBounds [Virtex5::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 sCOR0 []
 Configuration Options Register 0 (COR) subfields.
static const Subfield sCOR1 []
 Configuration Options Register 1 (COR) subfields.
static const Subfield sSTAT []
 Status Register (STAT) subfields.
static const Subfield sCTL0 []
 Control Register 0 (CTL) subfields.
static const Subfield sCTL1 []
 Control Register 1 (CTL) subfields.
static const Subfield sMASK0 []
 Control Mask Register (MASK) subfields.
static const Subfield sWBSTAR []
 Warm Boot Start Address Register (WBSTAR) subfields.
static const Subfield sTIMER []
 Watchdog Timer Register (TIMER) subfields.
static const Subfield sBOOTSTS []
 Boot History Status Register (BOOTSTS) subfields.

Friends

class torc::bitstream::bitstream::Virtex5UnitTest
class torc::bitstream::bitstream::Virtex5FarUnitTest
void testVirtex5Device (const std::string &inDeviceName, const boost::filesystem::path &inWorkingPath)
void testVirtex5FullMapping (const boost::filesystem::path &inWorkingPath)
void testVirtex5PartialMapping (const boost::filesystem::path &inWorkingPath)
std::ostream & operator<< (std::ostream &os, const Virtex5 &rhs)
 Insert the bitstream header into an output stream.

Classes

class  FrameAddress

Detailed Description

Virtex5 bitstream.

Definition at line 41 of file Virtex5.hpp.

Member Typedef Documentation

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

Imported type name.

Reimplemented from torc::bitstream::VirtexBitstream.

Definition at line 51 of file Virtex5.hpp.

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

Map from frame index to frame address.

Definition at line 247 of file Virtex5.hpp.

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

Map from frame address to frame index.

Definition at line 249 of file Virtex5.hpp.

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

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

Definition at line 251 of file Virtex5.hpp.

Member Enumeration Documentation

enum torc::bitstream::Virtex5::ERegister

Configuration register enumeration.

See also:
Type 1 Packet Registers: UG191, v3.7, June 24, 2009, Table 6-5.

Definition at line 56 of file Virtex5.hpp.

enum torc::bitstream::Virtex5::ECommand

Configuration command enumeration for eRegisterCMD.

See also:
Command Register Codes: UG191, v3.7, June 24, 2009, Table 6-6.

Definition at line 64 of file Virtex5.hpp.

enum torc::bitstream::Virtex5::EFar

Frame Address Register subfields.

See also:
Frame Address Register Description: UG191, v3.7, June 24, 2009, Table 6-8.

Definition at line 72 of file Virtex5.hpp.

enum torc::bitstream::Virtex5::EFarTopBottom

Frame Address Register top and bottom constants.

See also:
Frame Address Register Description: UG191, v3.7, June 24, 2009, Table 6-8.

Definition at line 82 of file Virtex5.hpp.

enum torc::bitstream::Virtex5::EFarBlockType

Frame Address Register block type constants.

Definition at line 85 of file Virtex5.hpp.

anonymous enum

Assorted constants.

See also:
WBSTAR Register Description: UG191, v3.7, June 24, 2009, Table 6-12.

Definition at line 90 of file Virtex5.hpp.

enum torc::bitstream::Virtex5::EColumnType

Major column types.

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

Definition at line 97 of file Virtex5.hpp.

anonymous enum

Frame length.

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

See also:
Virtex-5 Frame Count, Frame Length, Overhead, and Bitstream Size: UG191, v.3.7, June 24, 2009, Table 6-1.

Definition at line 103 of file Virtex5.hpp.

Constructor & Destructor Documentation

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

Basic constructor.

Definition at line 141 of file Virtex5.hpp.

Member Function Documentation

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

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

Initialize the device information.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 412 of file Virtex5.cpp.

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

void torc::bitstream::Virtex5::initializeFullFrameBlocks ( void   ) 

Loads full bitstream frames into block data structure.

Definition at line 615 of file Virtex5.cpp.

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

Loads partial bitstream frames into block data structure.

Returns frames for queried bitstream co-ordinates

Definition at line 661 of file Virtex5.cpp.

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

Returns frames for queried xdl co-ordinates.

Definition at line 684 of file Virtex5.cpp.

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

Return the frame length for the current device.

Reimplemented from torc::bitstream::Bitstream.

Definition at line 185 of file Virtex5.hpp.

Friends And Related Function Documentation

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

Insert the bitstream header into an output stream.

Definition at line 772 of file OutputStreamHelpers.cpp.

Member Data Documentation

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

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

Initial value:

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

Definition at line 115 of file Virtex5.hpp.

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

Initial value:

 {
        "CRC", "FAR", "FDRI", "FDRO", "CMD", "CTL0", "MASK", "STAT", "LOUT", "COR0", "MFWR", "CBC", 
        "IDCODE", "AXSS", "COR1", "CSOB", "WBSTAR", "TIMER", "[UNKNOWN REG 18]", 
        "[UNKNOWN REG 19]", "[UNKNOWN REG 20]", "[UNKNOWN REG 21]", "BOOTSTS", "[UNKNOWN REG 23]", 
        "CTL1"
    }
Configuration register names.

Definition at line 117 of file Virtex5.hpp.

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

Initial value:

 {
        "NULL", "WCFG", "MFW", "DGHIGH/LFRM", "RCFG", "START", "RCAP", "RCRC", "AGHIGH", "SWITCH", 
        "GRESTORE", "SHUTDOWN", "GCAPTURE", "DESYNCH", "Reserved", "IPROG", "[UNKNOWN CMD 16]", 
        "LTIMER"
    }
Configuration command names.

Definition at line 119 of file Virtex5.hpp.

const Bitstream::Subfield torc::bitstream::Virtex5::sCOR0 [static, protected]

Configuration Options Register 0 (COR) subfields.

See also:
Configuration Options Register 0 (COR0): UG191, v3.7, June 24, 2009, Table 6-10.

Definition at line 121 of file Virtex5.hpp.

const Bitstream::Subfield torc::bitstream::Virtex5::sCOR1 [static, protected]

Initial value:

 {
        {0x00000003,  0, "BPI_page_size", "BPI_PAGE_SIZE", 0,
            
            
            VALUES{"1", "4", "8", "Reserved", 0}},
        {0x0000000C,  2, "BPI_1st_read_cycle", "BPI_1ST_READ_CYCLES", 0,
            
            
            VALUES{"1", "4", "8", "Reserved", 0}},
        {0x00000100,  8, "ContinuousReadbackCRC", "RBCRC_EN", 0, 
            
            
            VALUES{"Disabled", "Enabled", 0}},
        {0x00000200,  9, "InitAsCRCErrorPin", "RBCRC_NO_PIN", 0, 
            
            
            VALUES{"Disabled", "Enabled", 0}},
        {0x00020000, 17, "PersistDeassertAtDesynch", "PERSIST_DEASSERT_AT_DESYNCH", 0,
            
            
            VALUES{"Disabled", "Enabled", 0}},
        {0, 0, 0, 0, 0, 0}
    }
Configuration Options Register 1 (COR) subfields.

See also:
Configuration Options Register 1 (COR1): UG191, v3.7, June 24, 2009, Table 6-11.

Definition at line 123 of file Virtex5.hpp.

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

Status Register (STAT) subfields.

See also:
Status Register Description: UG191, v3.7, June 24, 2009, Table 6-9.

Definition at line 125 of file Virtex5.hpp.

const Bitstream::Subfield torc::bitstream::Virtex5::sCTL0 [static, protected]

Control Register 0 (CTL) subfields.

See also:
Control Register 0 (CTL0): UG191, v3.7, June 24, 2009, Figure 6-1.

Definition at line 127 of file Virtex5.hpp.

const Bitstream::Subfield torc::bitstream::Virtex5::sCTL1 [static, protected]

Initial value:

 {
        {0, 0, 0, 0, 0, 0}
    }
Control Register 1 (CTL) subfields.

See also:
Control Register 1 (CTL1): UG191, v3.7, June 24, 2009, Figure 6-2.

Definition at line 129 of file Virtex5.hpp.

const Bitstream::Subfield torc::bitstream::Virtex5::sMASK0 [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}},
        {0x00000030,  4, "Security", "SBITS", 0, 
            VALUES{"Protected", "[UNKNOWN 1]", "[UNKNOWN 2]", "Writable", 0}},
        {0x00000040,  6, "Encrypt", "DEC", 0,  VALUES{"Protected", "Writable", 0}},
        {0x00000100,  8, "GLUTMASK", "GLUTMASK", 0,  VALUES{"Protected", "Writable", 0}},
        {0x00001000, 12, "OverTempPowerDown", "OverTempPowerDown", 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 Register 0 (CTL0): UG191, v3.7, June 24, 2009, Figure 6-1.

Definition at line 131 of file Virtex5.hpp.

const Bitstream::Subfield torc::bitstream::Virtex5::sWBSTAR [static, protected]

Initial value:

 {
        {0x18000000, 27, "NextRevisionSelect", "RS[1:0]", 0,
            
            VALUES{"00", "01", "10", "11", 0}},
        {0x04000000, 26, "RevisionSelectTristate", "RS_TS_B", 0, 
            
            VALUES{"Disabled", "Enabled", 0}},
        {0, 0, 0, 0, 0, 0}
    }
Warm Boot Start Address Register (WBSTAR) subfields.

See also:
WBSTAR Register Description: UG191, v3.7, June 24, 2009, Table 6-12.

Definition at line 133 of file Virtex5.hpp.

const Bitstream::Subfield torc::bitstream::Virtex5::sTIMER [static, protected]

Initial value:

 {
        {0x01000000, 24, "TimerForConfig", "TIMER_CFG_MON", 0, 
            
            VALUES{"Disabled", "Enabled", 0}},
        {0x02000000, 25, "TimerForUser", "TIMER_USR_MON", 0, 
            
            VALUES{"Disabled", "Enabled", 0}},
        {0, 0, 0, 0, 0, 0}
    }
Watchdog Timer Register (TIMER) subfields.

See also:
TIMER Register Description: UG191, v3.7, June 24, 2009, Table 6-13.

Definition at line 135 of file Virtex5.hpp.

const Bitstream::Subfield torc::bitstream::Virtex5::sBOOTSTS [static, protected]

Boot History Status Register (BOOTSTS) subfields.

See also:
BOOTSTS Register Description: UG191, v3.7, June 24, 2009, Table 6-14.

Definition at line 137 of file Virtex5.hpp.

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

Map of frame indexes to frame addresses.

Definition at line 255 of file Virtex5.hpp.

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

Map of frame addressee to frame indexes.

Definition at line 257 of file Virtex5.hpp.

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

Vector to store frame indexes of XDL columns.

Definition at line 259 of file Virtex5.hpp.

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

Vector to store frame indexes of Bitstream columns.

Definition at line 261 of file Virtex5.hpp.

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

Array to hold frame index boundaries for blocks.

Definition at line 263 of file Virtex5.hpp.

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

Map of xdl columns to bit columns.

Definition at line 265 of file Virtex5.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