projects / OpenSPARC-T2-SAM / blame
| Commit | Line | Data |
|---|---|---|
| 920dae64 AT |
1 | <!doctype html public "-//w3c//dtd html 4.0 transitional//en"> |
| 2 | <html> | |
| 3 | <head> | |
| 4 | <title>SPARC Architectural Model: Device and Utility API</title> | |
| 5 | </head> | |
| 6 | ||
| 7 | <body bgcolor="#FFFFFF" LANG="en-US"> | |
| 8 | <h1>mmi_register_instance</h1> | |
| 9 | ||
| 10 | <h4>NAME</h4> | |
| 11 | <ul>mmi_register_instance - Register device instance with SAM</ul> | |
| 12 | ||
| 13 | <h4>SYNOPSIS</h4> | |
| 14 | ||
| 15 | <ul><font color="#0000FF">#include "mmi.h"</font> | |
| 16 | <p><tt> | |
| 17 | mmi_instance_t mmi_register_instance (const char* instance_name, const char *short_descr) | |
| 18 | </tt> | |
| 19 | </ul> | |
| 20 | ||
| 21 | <h4> | |
| 22 | DESCRIPTION</h4> | |
| 23 | ||
| 24 | <ul> | |
| 25 | <i>mmi_register_instance()</i> registers a | |
| 26 | module instance with the simulation model and provides a short description. It returns an opaque pointer | |
| 27 | used on subsequent actions on the module instance. <i>instance_name</i> is | |
| 28 | the name of the device instance, and <i>short_descr</i> is a descriptive string | |
| 29 | associated with the instance, and displayed by the <tt>modinfo</tt> UI command in SAM. | |
| 30 | ||
| 31 | This function is typically called from within the instance creator function registered | |
| 32 | by <a href="mmi_register_instance_creator.html"><tt>mmi_register_instance_creator()</tt></a>. | |
| 33 | ||
| 34 | </ul> | |
| 35 | ||
| 36 | <h4> | |
| 37 | RETURN VALUES</h4> | |
| 38 | ||
| 39 | <ul><i>mmi_register_instance()</i> returns an opaque instance pointer.</ul> | |
| 40 | ||
| 41 | <h4>ERRORS</h4> | |
| 42 | <ul><i>mmi_register_instance()</i> will fail if instance_name is not recognized by SAM.</ul> | |
| 43 | ||
| 44 | <h4>SEE ALSO</h4> | |
| 45 | <a href="intro.html">Introduction</a> | |
| 46 | <br> | |
| 47 | <a href="mmi_register_instance_creator.html">mmi_register_instance_creator</a> | |
| 48 | ||
| 49 | <p> | |
| 50 | <hr> | |
| 51 | ||
| 52 | ||
| 53 | </body> | |
| 54 | </html> |