sam-t2/docs/mmi/mmi_register_instance.html

<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
   <title>SPARC Architectural Model: Device and Utility API</title>
</head>

<body bgcolor="#FFFFFF" LANG="en-US">
<h1>mmi_register_instance</h1>

<h4>NAME</h4>
<ul>mmi_register_instance - Register device instance with SAM</ul>

<h4>SYNOPSIS</h4>

<ul><font color="#0000FF">#include "mmi.h"</font>
<p><tt>
mmi_instance_t mmi_register_instance (const char* instance_name, const char *short_descr)
</tt>
</ul>

<h4>
DESCRIPTION</h4>

<ul>
<i>mmi_register_instance()</i> registers a
module instance with the simulation model and provides a short description. It returns an opaque pointer
used on subsequent actions on the module instance. <i>instance_name</i> is
the name of the device instance, and <i>short_descr</i> is a descriptive string
associated with the instance, and displayed by the <tt>modinfo</tt> UI command in SAM.

This function is typically called from within the instance creator function registered
by <a href="mmi_register_instance_creator.html"><tt>mmi_register_instance_creator()</tt></a>.

</ul>

<h4>
RETURN VALUES</h4>

<ul><i>mmi_register_instance()</i> returns an opaque instance pointer.</ul>

<h4>ERRORS</h4>
<ul><i>mmi_register_instance()</i> will fail if instance_name is not recognized by SAM.</ul>

<h4>SEE ALSO</h4>
<a href="intro.html">Introduction</a>
<br>
<a href="mmi_register_instance_creator.html">mmi_register_instance_creator</a>

<p>
<hr>


</body>
</html>