#include <RFImplementation.hh>

Inheritance diagram for HDB::RFImplementation:

Collaboration diagram for HDB::RFImplementation:

Public Types
typedef HDB::Parameter	Parameter
	Parameter of FU implementation. More...

Public Member Functions
	RFImplementation (const std::string &moduleName, const std::string &clkPort, const std::string &rstPort, const std::string &glockPort, const std::string &sizeParam, const std::string &widthParam, const std::string &guardPort, bool sacParam=false)

virtual	~RFImplementation ()

	RFImplementation (const RFImplementation &o)

void	setSizeParameter (const std::string &sizeParam)

std::string	sizeParameter () const

void	setWidthParameter (const std::string &widthParam)

std::string	widthParameter () const

void	setGuardPort (const std::string &guardPort)

std::string	guardPort () const

void	setSeparateAddressCycleParameter (bool enable)

bool	separateAddressCycleParameter () const

void	addPort (RFPortImplementation *port)

void	addExternalPort (RFExternalPort *extPort)

void	deletePort (RFPortImplementation *port)

void	deleteExternalPort (RFExternalPort *port)

int	portCount () const

int	externalPortCount () const

RFPortImplementation &	port (int index) const

RFExternalPort &	externalPort (int index) const

void	addParameter (const std::string &name, const std::string &type, const std::string &value)

void	removeParameter (const std::string &name)

int	parameterCount () const

Parameter	parameter (int index) const

bool	hasParameter (const std::string &name) const

Public Member Functions inherited from HDB::HWBlockImplementation
	HWBlockImplementation (const std::string &moduleName, const std::string &clkPort, const std::string &rstPort, const std::string &glockPort)

	HWBlockImplementation (const HWBlockImplementation &b)

virtual	~HWBlockImplementation ()

bool	hasID () const

void	setID (RowID id)

RowID	id () const

void	setModuleName (const std::string &name)

std::string	moduleName () const

void	setClkPort (const std::string &name)

std::string	clkPort () const

void	setRstPort (const std::string &name)

std::string	rstPort () const

void	setGlockPort (const std::string &name)

std::string	glockPort () const

void	addImplementationFile (BlockImplementationFile *file)

void	removeImplementationFile (const BlockImplementationFile &file)

int	implementationFileCount () const

BlockImplementationFile &	file (int index) const

Private Types
typedef std::vector< RFPortImplementation * >	PortTable
	Vector type for RFPortImplementation. More...

typedef std::vector< RFExternalPort * >	ExternalPortTable
	Vector type for FUExternalPort. More...

typedef std::vector< Parameter >	ParameterTable
	Vector type for parameter names. More...

Private Attributes
std::string	sizeParam_
	Name of the size parameter. More...

std::string	widthParam_
	Name of the width parameter. More...

std::string	guardPort_
	Name of the guard port. More...

bool	sepAddrCycleParam_
	State of separate address cycle parameter. More...

PortTable	ports_
	Contains the ports. More...

ExternalPortTable	externalPorts_
	Contains the external ports. More...

ParameterTable	parameters_
	Contains the parameters. More...

Detailed Description

Repsesents an implementation of a RF in HDB.

Definition at line 50 of file RFImplementation.hh.

Member Typedef Documentation

◆ ExternalPortTable

typedef std::vector<RFExternalPort*> HDB::RFImplementation::ExternalPortTable

private

Vector type for FUExternalPort.

Definition at line 101 of file RFImplementation.hh.

◆ Parameter

typedef HDB::Parameter HDB::RFImplementation::Parameter

Parameter of FU implementation.

Definition at line 53 of file RFImplementation.hh.

◆ ParameterTable

typedef std::vector<Parameter> HDB::RFImplementation::ParameterTable

private

Vector type for parameter names.

Definition at line 103 of file RFImplementation.hh.

◆ PortTable

typedef std::vector<RFPortImplementation*> HDB::RFImplementation::PortTable

private

Vector type for RFPortImplementation.

Definition at line 99 of file RFImplementation.hh.

Constructor & Destructor Documentation

◆ RFImplementation() [1/2]

HDB::RFImplementation::RFImplementation	(	const std::string &	moduleName,
		const std::string &	clkPort,
		const std::string &	rstPort,
		const std::string &	glockPort,
		const std::string &	sizeParam,
		const std::string &	widthParam,
		const std::string &	guardPort,
		bool	sacParam = `false`
	)

The constructor.

Parameters

moduleName	Name of the module.
clkPort	Name of the clock port.
rstPort	Name of the reset port.
glockPort	Name of the global lock port.
sizeParam	Name of the parameter that defines the size of the register file.
widthParam	Name of the parameter that defines the width of the register file.
guardPort	Name of the guard port.
sacParam	Flag for separate address cycle. Default value is false.

Definition at line 61 of file RFImplementation.cc.

                    :
     HWBlockImplementation(moduleName, clkPort, rstPort, glockPort), 
     sizeParam_(sizeParam), widthParam_(widthParam), guardPort_(guardPort),
     sepAddrCycleParam_(sacParam) {
 }

◆ ~RFImplementation()

HDB::RFImplementation::~RFImplementation ( )

virtual

The destructor.

Definition at line 110 of file RFImplementation.cc.

                                     {
     SequenceTools::deleteAllItems(ports_);
     SequenceTools::deleteAllItems(externalPorts_);
 }

References SequenceTools::deleteAllItems(), externalPorts_, and ports_.

Here is the call graph for this function:

◆ RFImplementation() [2/2]

HDB::RFImplementation::RFImplementation ( const RFImplementation & original )

Copy constructor.

Parameters

original RFImplementation to copy.

Definition at line 81 of file RFImplementation.cc.

                                                                   :
     HWBlockImplementation(original) {
  
     sizeParam_ = original.sizeParam_;
     widthParam_ = original.widthParam_;
     guardPort_ = original.guardPort_;
     sepAddrCycleParam_ = original.sepAddrCycleParam_;
  
     // Deep copy ports.
     for (int i = 0; i < original.portCount(); i++) {
         RFPortImplementation* p = new RFPortImplementation(original.port(i));
         addPort(p);
     }
  
     // Copy parameters.
     parameters_ = original.parameters_;
  
     // Deep copy external ports.
     for (int i = 0; i < original.externalPortCount(); i++) {
         RFExternalPort* p = new RFExternalPort(original.externalPort(i));
         addExternalPort(p);
     }
  
 }

References addExternalPort(), addPort(), externalPort(), externalPortCount(), guardPort_, parameters_, port(), portCount(), sepAddrCycleParam_, sizeParam_, and widthParam_.

Here is the call graph for this function:

Member Function Documentation

◆ addExternalPort()

void HDB::RFImplementation::addExternalPort ( RFExternalPort * extPort )

Adds a new external port to the RF implementation.

Parameters

extPort The external port to be added.

Definition at line 214 of file RFImplementation.cc.

                                                          {
     externalPorts_.push_back(extPort);
 }

References externalPorts_.

Referenced by HDB::RFExternalPort::RFExternalPort(), and RFImplementation().

◆ addParameter()

void HDB::RFImplementation::addParameter	(	const std::string &	name,
		const std::string &	type,
		const std::string &	value
	)

Adds the given parameter for the implementation.

Parameters

name	Name of the parameter.
type	Type of the parameter.
value	Value of the parameter.

Exceptions

IllegalParameters If the RF implementation contains a parameter with the same name already.

Definition at line 318 of file RFImplementation.cc.

                             {
     if (hasParameter(name)) {
         throw IllegalParameters(__FILE__, __LINE__, __func__);
     } else {
         Parameter param = {name, type, value};
         parameters_.push_back(param);
     }
 }

References __func__, hasParameter(), and parameters_.

Here is the call graph for this function:

◆ addPort()

void HDB::RFImplementation::addPort ( RFPortImplementation * port )

Adds a new port to the RF implementation.

Parameters

port	The port to be added.

Definition at line 204 of file RFImplementation.cc.

                                                     {
     ports_.push_back(port);
 }

References port(), and ports_.

Referenced by RFImplementation(), and HDB::RFPortImplementation::RFPortImplementation().

Here is the call graph for this function:

◆ deleteExternalPort()

void HDB::RFImplementation::deleteExternalPort ( RFExternalPort * port )

Deletes the given external port.

Parameters

port	The port to delete.

Exceptions

InstanceNotFound If the given port is not in this RF implementation.

Definition at line 242 of file RFImplementation.cc.

                                                          {
     bool removed = ContainerTools::deleteValueIfExists(externalPorts_, port);
     if (!removed) {
         throw InstanceNotFound(__FILE__, __LINE__, __func__);
     }
 }

References __func__, ContainerTools::deleteValueIfExists(), externalPorts_, and port().

Here is the call graph for this function:

◆ deletePort()

void HDB::RFImplementation::deletePort ( RFPortImplementation * port )

Deletes the given port from the RF implementation.

Parameters

port	The port to delete.

Exceptions

InstanceNotFound If the given port is not in this RF implementation.

Definition at line 227 of file RFImplementation.cc.

                                                        {
     bool deleted = ContainerTools::deleteValueIfExists(ports_, port);
     if (!deleted) {
         throw InstanceNotFound(__FILE__, __LINE__, __func__);
     }
 }

References __func__, ContainerTools::deleteValueIfExists(), port(), and ports_.

Here is the call graph for this function:

◆ externalPort()

RFExternalPort & HDB::RFImplementation::externalPort ( int index ) const

Returns the external port at the given position.

Parameters

index The position index.

Returns: The port.

Exceptions

OutOfRange If the given index is negative or not smaller the number of external ports.

Definition at line 299 of file RFImplementation.cc.

                                               {
     if (index < 0 || index >= externalPortCount()) {
         const string procName = "RFImplementation::externalPort";
         throw OutOfRange(__FILE__, __LINE__, procName);
     }
  
     return *externalPorts_[index];
 }

References externalPortCount(), and externalPorts_.

Referenced by RFImplementation(), and HDBToHtml::rfImplToHtml().

Here is the call graph for this function:

◆ externalPortCount()

int HDB::RFImplementation::externalPortCount ( ) const

Returns the number of external ports.

Returns: The number of external ports.

Definition at line 266 of file RFImplementation.cc.

                                           {
     return externalPorts_.size();
  
 }

References externalPorts_.

Referenced by externalPort(), RFImplementation(), and HDBToHtml::rfImplToHtml().

◆ guardPort()

std::string HDB::RFImplementation::guardPort ( ) const

Returns the name of the guard port.

Returns: The name of the guard port.

Definition at line 176 of file RFImplementation.cc.

                                   {
     return guardPort_;
 }

References guardPort_.

Referenced by HDBToHtml::rfImplToHtml(), and setGuardPort().

◆ hasParameter()

bool HDB::RFImplementation::hasParameter ( const std::string & name ) const

Tells whether the implementation has the given parameter.

Parameters

name	Name of the parameter.

Returns: True if the implementation has the parameter, otherwise false.

Definition at line 381 of file RFImplementation.cc.

                                                           {
     for (ParameterTable::const_iterator iter = parameters_.begin();
         iter != parameters_.end(); iter++) {
         if (iter->name == name) {
             return true;
         }
     }
     return false;
 }

References parameters_.

Referenced by addParameter().

◆ parameter()

RFImplementation::Parameter HDB::RFImplementation::parameter ( int index ) const

Returns a parameter by the given index.

Parameters

index The index.

Returns: The parameter.

Exceptions

OutOfRange If the index is negative or not smaller than the number of parameters.

Definition at line 366 of file RFImplementation.cc.

                                            {
     if (index < 0 || index >= parameterCount()) {
         throw OutOfRange(__FILE__, __LINE__, __func__);
     }
  
     return parameters_[index];
 }

References __func__, parameterCount(), and parameters_.

Referenced by HDBToHtml::rfImplToHtml().

Here is the call graph for this function:

◆ parameterCount()

int HDB::RFImplementation::parameterCount ( ) const

Returns the number of parameters.

Returns: The number of parameters.

Definition at line 352 of file RFImplementation.cc.

                                        {
     return parameters_.size();
 }

References parameters_.

Referenced by parameter(), and HDBToHtml::rfImplToHtml().

◆ port()

RFPortImplementation & HDB::RFImplementation::port ( int index ) const

Returns the port at the given position.

Parameters

index The position index.

Returns: The port.

Exceptions

OutOfRange If the index is negative or not smaller than the number of ports.

Definition at line 281 of file RFImplementation.cc.

                                       {
     if (index < 0 || index >= portCount()) {
         const string procName = "RFImplementation::port";
         throw OutOfRange(__FILE__, __LINE__, procName);
     }
  
     return *ports_[index];
 }

References portCount(), and ports_.

Referenced by addPort(), deleteExternalPort(), deletePort(), RFTestbenchGenerator::parseRfPorts(), RFImplementation(), and HDBToHtml::rfImplToHtml().

Here is the call graph for this function:

◆ portCount()

int HDB::RFImplementation::portCount ( ) const

Returns the number of ports.

Returns: The number of ports.

Definition at line 255 of file RFImplementation.cc.

                                   {
     return ports_.size();
 }

References ports_.

Referenced by RFTestbenchGenerator::parseRfPorts(), port(), RFImplementation(), and HDBToHtml::rfImplToHtml().

◆ removeParameter()

void HDB::RFImplementation::removeParameter ( const std::string & name )

Removes the parameter of the given name.

Parameters

name	Name of the parameter.

Definition at line 335 of file RFImplementation.cc.

                                                        {
     for (ParameterTable::iterator iter = parameters_.begin();
         iter != parameters_.end(); iter++) {
         if (iter->name == name) {
             parameters_.erase(iter);
             return;
         }
     }
 }

References parameters_.

◆ separateAddressCycleParameter()

bool HDB::RFImplementation::separateAddressCycleParameter ( ) const

Returns flag for separate address cycle.

Returns: The flag value. True if enabled.

Definition at line 194 of file RFImplementation.cc.

                                                            {
     return sepAddrCycleParam_;
 }

References sepAddrCycleParam_.

Referenced by HDBToHtml::rfImplToHtml(), and DefaultDecoderGenerator::sacEnabled().

◆ setGuardPort()

void HDB::RFImplementation::setGuardPort ( const std::string & guardPort )

Sets the name of the guard port.

Parameters

guardPort Name of the guard port.

Definition at line 165 of file RFImplementation.cc.

                                                          {
     guardPort_ = guardPort;
 }

References guardPort(), and guardPort_.

Here is the call graph for this function:

◆ setSeparateAddressCycleParameter()

void HDB::RFImplementation::setSeparateAddressCycleParameter ( bool enable )

Sets flag for separate address cycle.

Parameters

enable Flag value.

Definition at line 185 of file RFImplementation.cc.

                                                                    {
     sepAddrCycleParam_ = enable;
 }

References sepAddrCycleParam_.

◆ setSizeParameter()

void HDB::RFImplementation::setSizeParameter ( const std::string & sizeParam )

Sets the name of the size parameter.

Parameters

sizeParam Name of the size parameter.

Definition at line 121 of file RFImplementation.cc.

                                                              {
     sizeParam_ = sizeParam;
 }

References sizeParam_.

◆ setWidthParameter()

void HDB::RFImplementation::setWidthParameter ( const std::string & widthParam )

Sets the name of the width parameter.

Parameters

widthParam Name of the width parameter.

Definition at line 143 of file RFImplementation.cc.

                                                                {
     widthParam_ = widthParam;
 }

References widthParam_.

◆ sizeParameter()

std::string HDB::RFImplementation::sizeParameter ( ) const

Returns the name of the size parameter.

Returns: The name of the size parameter.

Definition at line 132 of file RFImplementation.cc.

                                       {
     return sizeParam_;
 }

References sizeParam_.

Referenced by RFTestbenchGenerator::createTbInstantiation(), and HDBToHtml::rfImplToHtml().

◆ widthParameter()

std::string HDB::RFImplementation::widthParameter ( ) const

Returns the name of the width parameter.

Returns: The name of the width parameter.

Definition at line 154 of file RFImplementation.cc.

                                        {
     return widthParam_;
 }

References widthParam_.

Referenced by RFTestbenchGenerator::createTbInstantiation(), and HDBToHtml::rfImplToHtml().

Member Data Documentation

◆ externalPorts_

ExternalPortTable HDB::RFImplementation::externalPorts_

private

Contains the external ports.

Definition at line 117 of file RFImplementation.hh.

Referenced by addExternalPort(), deleteExternalPort(), externalPort(), externalPortCount(), and ~RFImplementation().

◆ guardPort_

std::string HDB::RFImplementation::guardPort_

private

Name of the guard port.

Definition at line 110 of file RFImplementation.hh.

Referenced by guardPort(), RFImplementation(), and setGuardPort().

◆ parameters_

ParameterTable HDB::RFImplementation::parameters_

private

Contains the parameters.

Definition at line 119 of file RFImplementation.hh.

Referenced by addParameter(), hasParameter(), parameter(), parameterCount(), removeParameter(), and RFImplementation().

◆ ports_

PortTable HDB::RFImplementation::ports_

private

Contains the ports.

Definition at line 115 of file RFImplementation.hh.

Referenced by addPort(), deletePort(), port(), portCount(), and ~RFImplementation().

◆ sepAddrCycleParam_

bool HDB::RFImplementation::sepAddrCycleParam_

private

State of separate address cycle parameter.

Definition at line 112 of file RFImplementation.hh.

Referenced by RFImplementation(), separateAddressCycleParameter(), and setSeparateAddressCycleParameter().

◆ sizeParam_

std::string HDB::RFImplementation::sizeParam_

private

Name of the size parameter.

Definition at line 106 of file RFImplementation.hh.

Referenced by RFImplementation(), setSizeParameter(), and sizeParameter().

◆ widthParam_

std::string HDB::RFImplementation::widthParam_

private

Name of the width parameter.

Definition at line 108 of file RFImplementation.hh.

Referenced by RFImplementation(), setWidthParameter(), and widthParameter().

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

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ExternalPortTable

◆ Parameter

◆ ParameterTable

◆ PortTable

Constructor & Destructor Documentation

◆ RFImplementation() [1/2]

◆ ~RFImplementation()

◆ RFImplementation() [2/2]

Member Function Documentation

◆ addExternalPort()

◆ addParameter()

◆ addPort()

◆ deleteExternalPort()

◆ deletePort()

◆ externalPort()

◆ externalPortCount()

◆ guardPort()

◆ hasParameter()

◆ parameter()

◆ parameterCount()

◆ port()

◆ portCount()

◆ removeParameter()

◆ separateAddressCycleParameter()

◆ setGuardPort()

◆ setSeparateAddressCycleParameter()

◆ setSizeParameter()

◆ setWidthParameter()

◆ sizeParameter()

◆ widthParameter()

Member Data Documentation

◆ externalPorts_

◆ guardPort_

◆ parameters_

◆ ports_

◆ sepAddrCycleParam_

◆ sizeParam_

◆ widthParam_