Brian,
As promised here are the header files for committee review.
The C++ header has minimum required public class interfaces.
Implementations can extend with private content as required.
The C header should stand fully by itself in any implementation.
-- johnS
______________________________/\/ \ \
John Stickley \ \ \
Principal Engineer \ \________________
Mentor Graphics - MED \_
17 E. Cedar Place \ john_stickley@mentor.com
Ramsey, NJ 07446 \ Phone: (201) 818-2585
________________________________________________________________
//
// scemi.h - SCE-MI C++ Interface
//
#ifndef INCLUDED_SCEMI
#define INCLUDED_SCEMI
class SceMiParameters;
class SceMiMessageData;
class SceMiMessageInPortProxy;
class SceMiMessageOutPortProxy;
#include "scemicommontypes.hxx"
class SceMiParameters {
public:
// CREATORS
//
// This constructor initializes some parameters from the
// parameters file in the config directory, and some other
// parameters directly from the config file.
//
SceMiParameters(
const char* configBasePath = "scemi",
SceMiEC* ec = NULL);
~SceMiParameters();
// ACCESSORS
//
// This accessor returns the number of instances of objects of
// the specified objectKind name.
//
unsigned int NumberOfObjects(
const char* objectKind, // Input: Object kind name.
SceMiEC* ec = 0) const; // Input/Output: Error status.
//
// These accessors return an integer or string attribute values of the
// given object kind. It is considered an error if the index > number
// returned by ::NumberOfObjects() or the objectKind and attributeName
// arguments are unrecognized.
//
int AttributeIntegerValue(
const char* objectKind, // Input: Object kind name.
unsigned int index, // Input: Index of object instance.
const char* attributeName, // Input: Name of attribute being read.
SceMiEC* ec = NULL) const; // Input/Output: Error status.
const char* AttributeStringValue(
const char* objectKind, // Input: Object kind name.
unsigned int index, // Input: Index of object instance.
const char* attributeName, // Input: Name of attribute being read.
SceMiEC* ec = NULL) const; // Input/Output: Error status.
// MANIPULATORS
//
// These manipulators override an integer or string attribute values of the
// given object kind. It is considered an error if the index > number
// returned by ::NumberOfObjects(). or the objectKind and attributeName
// arguments are unrecognized.
//
void OverrideAttributeIntegerValue(
const char* objectKind, // Input: Object kind name.
unsigned int index, // Input: Index of object instance.
const char* attributeName, // Input: Name of attribute being read.
int value, // Input: New integer value of attribute.
SceMiEC* ec = NULL); // Input/Output: Error status.
void OverrideAttributeStringValue(
const char* objectKind, // Input: Object kind name.
unsigned int index, // Input: Index of object instance.
const char* attributeName, // Input: Name of attribute being read.
const char* value, // Input: New string value of attribute.
SceMiEC* ec = NULL); // Input/Output: Error status.
};
//
// class SceMiMessagePortProxy
//
// Description
// -----------
// The class SceMiMessagePortProxy is the base class for SceMiMessageInPortProxy
// and SceMiMessageOutPortProxy. It contains information and methods
// common to both types of port.
//
class SceMiMessagePortProxy {
public:
// ACCESSORS
const char* TransactorName() const;
const char* PortName() const;
const unsigned PortWidth() const;
};
//
// class SceMiMessageInPortProxy
//
// Description
// -----------
// The class SceMiMessageInPortProxy presents a C++ proxy for a transactor
// message input port. The input channel to that transactor is represented
// by the Send() method.
//
class SceMiMessageInPortProxy : public SceMiMessagePortProxy {
public:
//
// This method sends message to the transactor input port.
//
void Send(
const SceMiMessageData &data, // Message payload to be sent.
SceMiEC* ec = NULL);
//
// Replace port binding.
// The binding argument represents a callback function and context
// pointer tray (see comments in scemicommontypes.h for struct
// SceMiMessageInPortBinding).
//
void ReplaceBinding(
const SceMiMessageInPortBinding* binding,
SceMiEC* ec = NULL);
};
//
// class SceMiMessageOutPortProxy
//
// Description
// -----------
// The class SceMiMessageOutPortProxy presents a C++ proxy for a transactor
// message output port.
//
class SceMiMessageOutPortProxy : public SceMiMessagePortProxy {
public:
//
// Replace port binding.
// The binding argument represents a callback function and context
// pointer tray (see comments in scemicommontypes.h for struct
// SceMiMessageOutPortBinding).
//
void ReplaceBinding(
const SceMiMessageOutPortBinding* binding,
SceMiEC* ec = NULL);
};
//
// class SceMiMessageData
//
// Description
// -----------
// The class SceMiMessageData represents a fixed length array of data which
// is transferred between models.
//
class SceMiMessageData {
public:
// CREATORS
//
// Constructor: The message in port proxy for which
// this message data object must be suitably sized.
//
SceMiMessageData(
const SceMiMessageInPortProxy& messageInPortProxy,
SceMiEC* ec = NULL);
~SceMiMessageData();
// Return size of vector in bits
unsigned WidthInBits() const;
// Return size of array in 32 bit words.
unsigned WidthInWords() const;
void Set( unsigned i, SceMiU32 word, SceMiEC* ec = NULL);
void SetBit( unsigned i, int bit, SceMiEC* ec = NULL);
void SetBitRange(
unsigned int i, unsigned int range, SceMiU32 bits, SceMiEC* ec = NULL);
SceMiU32 Get( unsigned i, SceMiEC* ec = NULL) const;
int GetBit( unsigned i, SceMiEC* ec = NULL) const;
SceMiU32 GetBitRange(
unsigned int i, unsigned int range, SceMiEC* ec = NULL);
SceMiU64 CycleStamp() const;
};
//
// class SceMi
//
// Description
// -----------
// This file defines the public interface to class SceMi.
//
class SceMi {
public:
//
// Check version string against supported versions.
// Returns -1 if passed string not supported.
// Returns interface version # if it is supported.
// This interface version # can be passed to SceMi::Init().
//
static int Version(
const char* versionString);
//
// This function wraps constructor of class SceMi. If an instance
// of class SceMi has been established on a prior call to the
// SceMi::Init() function, that pointer is returned since a single
// instance of class SceMi is reusable among all C models.
// Returns NULL if error occurred, check ec for status or register
// an error callback.
//
// The caller is required to pass in the version of SceMi it is
// expecting to work with. Call SceMi::Version to convert a version
// string to an integer suitable for this version's "version" argument.
//
// The caller is also expected to have instantiated a SceMiParameters
// object, and pass a pointer to that object into this function.
//
static SceMi*
Init(
int version,
const SceMiParameters* parameters,
SceMiEC* ec = NULL);
//
// Shut down the SCEMI interface.
//
static void
Shutdown(
SceMi* mct,
SceMiEC* ec = NULL);
//
// Create proxy for message input port.
//
// Pass in the instance name in the bridge netlist of
// the transactor and port to which binding is requested.
//
// The binding argument is a callback function and context
// pointer tray. For more details, see the comments in
// scemicommontypes.h by struct SceMiMessageInPortBinding.
//
SceMiMessageInPortProxy*
BindMessageInPort(
const char* transactorName,
const char* portName,
const SceMiMessageInPortBinding* binding,
SceMiEC* ec = NULL);
//
// Create proxy for message output port.
//
// Pass in the instance name in the bridge netlist of
// the transactor and port to which binding is requested.
//
// The binding argument is a callback function and context
// pointer tray. For more details, see the comments in
// scemicommontypes.h by struct SceMiMessageOutPortBinding.
//
SceMiMessageOutPortProxy*
BindMessageOutPort(
const char* transactorName,
const char* portName,
const SceMiMessageOutPortBinding* binding,
SceMiEC* ec = NULL);
//
// Service arriving transactions from the portal.
// Messages enqueued by SceMiMessageOutPortProxy methods, or which are
// are from output transactions that pending dispatch to the
// SceMiMessageOutPortProxy callbacks, may not be handled until
// ServiceLoop() is called. This function returns the # of output
// messages that were dispatched.
//
// Regarding the service loop handler (aka "g function"):
// If g is NULL, check for transfers to be performed and
// dispatch them returning immediately afterwards. If g is
// non-NULL, enter into a loop of performing transfers and
// calling 'g'. When 'g' returns 0 return from the loop.
// When 'g' is called, an indication of whether there is at
// least 1 message pending will be made with the 'pending' flag.
//
// The user context object pointer is uninterpreted by
// ServiceLoop() and is passed straight to the 'g' function.
//
int
ServiceLoop(
SceMiServiceLoopHandler g = NULL,
void* context = NULL,
SceMiEC* ec = NULL);
//
// Register an error handler which is called in the event
// that an error occurs. If no handler is registered, the
// default error handler is called.
//
static void
RegisterErrorHandler(
SceMiErrorHandler errorHandler,
void* context);
//
// Register an info handler which is called in the event
// that a text message needs to be issued. If no handler
// is registered, the message is printed to stdout in
// Ikos message format.
//
static void
RegisterInfoHandler(
SceMiInfoHandler infoHandler,
void* context);
};
#endif
/*
* scemi.h
*
* This file is the header file for the SCEMI C API.
*/
#ifndef INCLUDED_SCEMI
#define INCLUDED_SCEMI
typedef void SceMi;
typedef void SceMiParameters;
typedef void SceMiMessageData;
typedef void SceMiMessageInPortProxy;
typedef void SceMiMessageOutPortProxy;
#include "scemicommontypes.h"
#ifdef __cplusplus
extern "C" {
#endif
/*
* Register an error handler which is called in the event
* that an error occurs. If no handler is registered, the
* default error handler is called. The errorHandler will
* pass back the 'context' object registered by the user
* when making this function call. The system makes no
* assumptions about the 'context' pointer and will not
* modify it.
*/
void
SceMiRegisterErrorHandler(
SceMiErrorHandler errorHandler,
void* context);
/*
* Register an info handler which is called in the event
* that an informational text message needs to be printed.
* If no handler is registered, the message is printed to stdout.
*/
void SceMiRegisterInfoHandler(
SceMiInfoHandler infoHandler,
void* context );
/*
* Check version string against supported versions.
* Return -1 if passed string not supported.
* Return interface version # if it is supported. This interface
* version # can be passed to the SceMiInit() function.
*/
int
SceMiVersion(
const char* versionString);
/*
* This function wraps constructor of class SceMi. If an instance
* of class SceMi has been established on a prior call to the
* the SceMiInit() function, that pointer is returned since a single
* instance of class SceMi is reusable among all C models.
*
* The caller must provide the interface version # it is expecting
* to work with. If the caller requests an unsupported version,
* an error is returned.
*
* The caller must also provide a pointer to a filled-in SceMiParameters
* struct that contains global interface specification parameters.
*
* Returns NULL if error occurred, check ec for status or register
* an error callback.
*/
SceMi*
SceMiInit(
int version,
const SceMiParameters* parameters,
SceMiEC* ec);
/*
* Shut down the specified SCEMI interface.
*/
void
SceMiShutdown(
SceMi* mctHandle,
SceMiEC* ec);
/*
* Create proxy for message input port.
*
* The caller must provide the handle to the initialized SceMi system,
* as well as the name of the transactor and port to which binding
* is requested.
*
* The 'binding' input is a callback function and context pointer tray.
* See the comments in scemitypes.h for struct SceMiMessageInPortBinding.
*/
SceMiMessageInPortProxy*
SceMiBindMessageInPort(
SceMi* mctHandle,
const char* transactorName,
const char* portName,
const SceMiMessageInPortBinding* binding,
SceMiEC* ec);
/*
* Create proxy for message output port.
*
* The caller must provide the handle to the initialized SceMi system,
* as well as the name of the transactor and port to which binding
* is requested.
*
* The 'binding' input is a callback function and context pointer tray.
* See the comments in scemitypes.h for struct SceMiMessageOutPortBinding.
*/
SceMiMessageOutPortProxy*
SceMiBindMessageOutPort(
SceMi* mctHandle,
const char* transactorName,
const char* portName,
const SceMiMessageOutPortBinding* binding,
SceMiEC* ec);
/*
* Service arriving transactions from the portal.
* Messages enqueued by SceMiMessageOutPortProxy methods, or which are
* are from output transactions that pending dispatch to the
* SceMiMessageOutPortProxy callbacks, may not be handled until
* ServiceLoop() is called. This function returns the # of output
* messages that were dispatched.
*
* The 'g' input is a pointer to a user-defined service function.
* If g is NULL, check for transfers to be performed and
* dispatch them returning immediately afterwards. If g is
* non-NULL, enter into a loop of performing transfers and
* calling 'g'. When 'g' returns 0 return from the loop.
* When 'g' is called, an indication of whether there is at
* least 1 message pending will be made with the 'pending' flag.
*
* The 'context' input is a user context object pointer.
* This pointer is uninterpreted by the SceMiServiceLoop()
* method and is passed on to the 'g' callback function.
*/
int
SceMiServiceLoop(
SceMi* mctHandle,
SceMiServiceLoopHandler g,
void* context,
SceMiEC* ec);
SceMiParameters*
SceMiParametersNew(
const char* paramsFile,
SceMiEC* ec);
unsigned int
SceMiParametersNumberOfObjects(
const SceMiParameters* parametersHandle,
const char* objectKind,
SceMiEC* ec);
int
SceMiParametersAttributeIntegerValue(
const SceMiParameters* parametersHandle,
const char* objectKind,
unsigned int index,
const char* attributeName,
SceMiEC* ec);
const char*
SceMiParametersAttributeStringValue(
const SceMiParameters* parametersHandle,
const char* objectKind,
unsigned int index,
const char* attributeName,
SceMiEC* ec);
void
SceMiParametersOverrideAttributeIntegerValue(
SceMiParameters* parametersHandle,
const char* objectKind,
unsigned int index,
const char* attributeName,
int value,
SceMiEC* ec);
void
SceMiParametersOverrideAttributeStringValue(
SceMiParameters* parametersHandle,
const char* objectKind,
unsigned int index,
const char* attributeName,
const char* value,
SceMiEC* ec);
/*
* SceMiMessageData initialization function.
* This is called to construct a new SceMiMessageData object.
*/
SceMiMessageData*
SceMiMessageDataNew(
const SceMiMessageInPortProxy* messageInPortProxyHandle,
SceMiEC* ec);
/*
* Destroy a SceMiMessageData object previously returned from
* SceMiMessageDataNew.
*/
void
SceMiMessageDataDelete(
SceMiMessageData* messageDataHandle);
/*
* Return size of message data array in 32 bit words.
*/
unsigned
SceMiMessageDataWidthInBits(
const SceMiMessageData* messageDataHandle);
/*
* Return size of array in 32 bit words.
*/
unsigned
SceMiMessageDataWidthInWords(
const SceMiMessageData* messageDataHandle);
/*
* Set value of message data word at given index.
*/
void
SceMiMessageDataSet(
SceMiMessageData* messageDataHandle,
unsigned i,
SceMiU32 word,
SceMiEC* ec);
/*
* Set bit in message data word at given index.
*/
void
SceMiMessageDataSetBit(
SceMiMessageData* messageDataHandle,
unsigned i,
int bit,
SceMiEC* ec);
/*
* Set bit range in message data word at given index.
*/
void SceMiMessageDataSetBitRange(
SceMiMessageData* messageDataHandle,
unsigned i,
unsigned range,
SceMiU32 bits,
SceMiEC *ec);
/*
* Return value of message data word at given index.
*/
SceMiU32
SceMiMessageDataGet(
const SceMiMessageData* messageDataHandle,
unsigned i,
SceMiEC* ec);
/*
* Return value of bit in message data word at given index.
*/
int
SceMiMessageDataGetBit(
const SceMiMessageData* messageDataHandle,
unsigned i,
SceMiEC* ec);
/*
* Return value of bit range in message data word at given index.
*/
SceMiU32
SceMiMessageDataGetBitRange(
const SceMiMessageData *messageDataHandle,
unsigned int i,
unsigned int range,
SceMiEC *ec);
/*
* Get cyclestamp.
*/
SceMiU64
SceMiMessageDataCycleStamp(
const SceMiMessageData* messageDataHandle);
/*
* This method sends a message with the specified payload to the
* transactor input port. The data will transparently be delivered
* to the transactor as 1 or more chunks.
*/
void
SceMiMessageInPortProxySend(
SceMiMessageInPortProxy* messageInPortProxyHandle,
const SceMiMessageData* messageDataHandle,
SceMiEC* ec);
const char*
SceMiMessageInPortProxyTransactorName(
const SceMiMessageInPortProxy* messageInPortProxyHandle);
const char*
SceMiMessageInPortProxyPortName(
const SceMiMessageInPortProxy* messageInPortProxyHandle);
unsigned
SceMiMessageInPortProxyPortWidth(
const SceMiMessageInPortProxy* messageInPortProxyHandle);
const char*
SceMiMessageOutPortProxyTransactorName(
const SceMiMessageOutPortProxy* messageOutPortProxyHandle);
const char*
SceMiMessageOutPortProxyPortName(
const SceMiMessageOutPortProxy* messageOutPortProxyHandle);
unsigned
SceMiMessageOutPortProxyPortWidth(
const SceMiMessageOutPortProxy* messageOutPortProxyHandle);
#ifdef __cplusplus
};
#endif
#endif
Received on Wed Mar 24 18:25:12 2004
This archive was generated by hypermail 2.1.8 : Wed Mar 24 2004 - 18:26:19 PST