Bitstream Interpretation Library (BIL)  0.1
Public Member Functions | Protected Member Functions
bil::V5BitstreamReader Class Reference

Loads Virtex-5 bitstream raw data. More...

#include <bitstream/V5BitstreamReader.hpp>

List of all members.

Public Member Functions

void read (Bitstream &bitstream, const boost::uint32_t *words, size_t wordCount)
 Loads Virtex-5 bitstream raw data.

Protected Member Functions

virtual size_t extractPacket (const boost::uint32_t *words, size_t wordCount, std::auto_ptr< Packet > &packetPtr)
 Create a packet from raw data.
bool behindSyncWord () const
 Tells, if sync word was passed.
bool lastPacketWasType1 () const
 Tells, if the last packet processed was a type 1 packet.
RegisterAddress::address_t lastType1Address () const
 Gets the register address of the last processed type 1 packet.

Detailed Description

Loads Virtex-5 bitstream raw data.

This class reads a Virtex-5 raw bitstream, constructs the packets out of it, and puts them into a Bitstream instance. While loading, the packet stream will be syntax checked.

Definition at line 22 of file V5BitstreamReader.hpp.


Member Function Documentation

void V5BitstreamReader::read ( Bitstream bitstream,
const boost::uint32_t *  words,
size_t  wordCount 
)

Loads Virtex-5 bitstream raw data.

Parameters:
bitstreamBitstream instance to load packets into.
wordsPointer to data words to load.
wordCountNumber of data words to load.
Exceptions:
.

Definition at line 16 of file V5BitstreamReader.cpp.

size_t V5BitstreamReader::extractPacket ( const boost::uint32_t *  words,
size_t  wordCount,
std::auto_ptr< Packet > &  packetPtr 
)
protectedvirtual

Create a packet from raw data.

Parameters:
wordsPointer to data words to load.
wordCountNumber of data words to load.
packetPtrThe newly created packet.
Returns:
Number of raw data words this packet is loaded from.
Exceptions:
.

Definition at line 45 of file V5BitstreamReader.cpp.

bool V5BitstreamReader::behindSyncWord ( ) const
protected

Tells, if sync word was passed.

Returns:
True if sync word was passed, false otherwise.

Definition at line 105 of file V5BitstreamReader.cpp.

bool V5BitstreamReader::lastPacketWasType1 ( ) const
protected

Tells, if the last packet processed was a type 1 packet.

Returns:
True if last packet was a type 1 packet, false otherwise.

Definition at line 111 of file V5BitstreamReader.cpp.

RegisterAddress::address_t V5BitstreamReader::lastType1Address ( ) const
protected

Gets the register address of the last processed type 1 packet.

Returns:
The register address.

Definition at line 117 of file V5BitstreamReader.cpp.


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