cptDetail_p.h File Reference

Definition of the CptDetail structure. More...

#include <PBS/L.h>

Classes
struct	CptDetail
	Structure containing some imformation about the current component. More...
Functions
CptDetail *	newCptDetail (void)
	Allocate and initialize a CptDetail structure.
void	deleteCptDetail (void *ptr)
	Free a CptDetail structure and its lists.
void	scpt_cptDetail (CptDetail *cd, const char *name, unsigned regWidth, unsigned multi)
	Populate the structure holding details of the current component.
void	sreg_cptDetail (CptDetail *cd, const char *regName)
	Add strings to the lists of children of the component.
void	sfld_cptDetail (CptDetail *cd)
	NO_OP.
void	ereg_cptDetail (CptDetail *cd, unsigned regId, unsigned nFld, const char *regName)
	Add field to the list of registers.
void	ecpt_cptDetail (CptDetail *cd, CptDetail *parent)
	Finish off any lists in the component.

---

Detailed Description

Definition of the CptDetail structure.

Author:

James Swain & Owen Saxton

$Id: cptDetail_p.h,v 1.4 2011/03/27 06:15:54 saxton Exp $

---

Function Documentation

void deleteCptDetail

(

void *

ptr

)

Free a CptDetail structure and its lists.

Parameters:

ptr

To structure to delete

References CptDetail::children, CptDetail::cptChildren, CptDetail::dtd, CptDetail::mapdtd, CptDetail::name, CptDetail::regs, and CptDetail::tag.

Referenced by ecpt_regState(), and fini_regState().

void ecpt_cptDetail	(	CptDetail *	cd,
		CptDetail *	parent
	)

Finish off any lists in the component.

Parameters:

	cd	Structure holding details of the current component
	parent	Pointer to parent CptDetail

References CptDetail::children, CptDetail::cptChildren, CptDetail::dtd, CptDetail::mapdtd, CptDetail::multi, CptDetail::name, and newlString().

Referenced by ecpt_regState().

void ereg_cptDetail	(	CptDetail *	cd,
		unsigned	regId,
		unsigned	nFld,
		const char *	regName
	)

Add field to the list of registers.

Parameters:

	cd	Pointer to the structure containing details of the current component
	regId	Register ID
	nFld	Number of fields in the register
	regName	Register name

References CptDetail::name, newlString(), and CptDetail::regs.

Referenced by ereg_regState().

CptDetail* newCptDetail

(

void

)

Allocate and initialize a CptDetail structure.

Returns:

Ptr to initialised CptDetail

References CptDetail::children, CptDetail::cptChildren, CptDetail::dtd, CptDetail::dtdCount, CptDetail::mapdtd, CptDetail::name, CptDetail::nReg, CptDetail::regEnums, CptDetail::regs, and CptDetail::tag.

Referenced by scpt_regState().

void scpt_cptDetail	(	CptDetail *	cd,
		const char *	name,
		unsigned	regWidth,
		unsigned	multi
	)

Populate the structure holding details of the current component.

Parameters:

	cd	Structure holding details of the current component
	name	Name of the component
	regWidth	Width (in bits) of the registers of this component
	multi	1 indicates that there can be multiple instances of this component (contained by the same parent) 0 indicates otherwise

References CptDetail::children, CptDetail::cptChildren, CptDetail::mapTag, CptDetail::multi, CptDetail::name, newlString(), newString(), CptDetail::regs, CptDetail::regWidth, and CptDetail::tag.

Referenced by scpt_regState().

void sfld_cptDetail

(

CptDetail *

cd

)

NO_OP.

Parameters:

cd

Pointer to the structure containing details of the current component

Referenced by sfld_regState().

void sreg_cptDetail	(	CptDetail *	cd,
		const char *	regName
	)

Add strings to the lists of children of the component.

Parameters:

	cd	Pointer to the structure containing details of the current component
	regName	String identifying the current register

References CptDetail::children, CptDetail::name, newlString(), CptDetail::nReg, and CptDetail::regEnums.

Referenced by sreg_regState().