OpenCores
URL https://opencores.org/ocsvn/nocmodel/nocmodel/trunk

Subversion Repositories nocmodel

[/] [nocmodel/] [trunk/] [doc/] [nocmodel.basicmodels.basic_ipcore.html] - Rev 2

Compare with Previous | Blame | View Log

 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module nocmodel.basicmodels.basic_ipcore</title>
</head><body bgcolor="#f0f0f8">
 
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="nocmodel.html"><font color="#ffffff">nocmodel</font></a>.<a href="nocmodel.basicmodels.html"><font color="#ffffff">basicmodels</font></a>.basic_ipcore</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/oscard/Documentos/proyectos/nocmodel-0.1/nocmodel/basicmodels/basic_ipcore.py">/home/oscard/Documentos/proyectos/nocmodel-0.1/nocmodel/basicmodels/basic_ipcore.py</a></font></td></tr></table>
    <p><tt>Basic&nbsp;ipcore&nbsp;TLM&nbsp;model</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
 
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="logging.html">logging</a><br>
</td><td width="25%" valign=top><a href="myhdl.html">myhdl</a><br>
</td><td width="25%" valign=top><a href="networkx.html">networkx</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
 
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="nocmodel.noc_tlm_base.html#noc_tlm_base">nocmodel.noc_tlm_base.noc_tlm_base</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="nocmodel.basicmodels.basic_ipcore.html#basic_ipcore_tlm">basic_ipcore_tlm</a>
</font></dt></dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="basic_ipcore_tlm">class <strong>basic_ipcore_tlm</strong></a>(<a href="nocmodel.noc_tlm_base.html#noc_tlm_base">nocmodel.noc_tlm_base.noc_tlm_base</a>)</font></td></tr>
 
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>TLM&nbsp;model&nbsp;of&nbsp;a&nbsp;NoC&nbsp;ipcore.&nbsp;Its&nbsp;based&nbsp;on&nbsp;sending&nbsp;and&nbsp;receiving&nbsp;packets<br>
to&nbsp;a&nbsp;custom-based&nbsp;MyHDL&nbsp;generators.&nbsp;This&nbsp;class&nbsp;does&nbsp;not&nbsp;define&nbsp;any<br>
functionality.<br>
&nbsp;<br>
Attributes:<br>
*&nbsp;ipcore_ref:&nbsp;reference&nbsp;to&nbsp;ipcore&nbsp;base&nbsp;object<br>
&nbsp;<br>
Notes:<br>
*&nbsp;This&nbsp;model&nbsp;is&nbsp;completely&nbsp;behavioral.<br>
*&nbsp;See&nbsp;code&nbsp;comments&nbsp;to&nbsp;better&nbsp;understanding.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="basic_ipcore_tlm-__init__"><strong>__init__</strong></a>(self, ipcore_ref)</dt></dl>
 
<dl><dt><a name="basic_ipcore_tlm-recv"><strong>recv</strong></a>(self, src, dest, packet, addattrs<font color="#909090">=None</font>)</dt><dd><tt>Assumptions:&nbsp;<br>
*&nbsp;Safely&nbsp;ignore&nbsp;src&nbsp;and&nbsp;dest&nbsp;arguments,&nbsp;because&nbsp;this&nbsp;method&nbsp;<br>
&nbsp;&nbsp;is&nbsp;called&nbsp;only&nbsp;by&nbsp;local&nbsp;channel&nbsp;object.<br>
*&nbsp;In&nbsp;theory&nbsp;src&nbsp;should&nbsp;be&nbsp;self.<strong>localch</strong>,&nbsp;and&nbsp;dest&nbsp;should&nbsp;be&nbsp;<br>
&nbsp;&nbsp;self.<strong>ipcore_ref</strong>&nbsp;.&nbsp;This&nbsp;may&nbsp;be&nbsp;checked&nbsp;for&nbsp;errors.</tt></dd></dl>
 
<dl><dt><a name="basic_ipcore_tlm-register_generator"><strong>register_generator</strong></a>(self, genfunction, **kwargs)</dt><dd><tt>Register&nbsp;a&nbsp;new&nbsp;generator&nbsp;for&nbsp;this&nbsp;ipcore.&nbsp;<br>
&nbsp;<br>
Arguments:<br>
*&nbsp;genfunction:&nbsp;function&nbsp;that&nbsp;returns&nbsp;a&nbsp;MyHDL&nbsp;generator<br>
*&nbsp;kwargs:&nbsp;optional&nbsp;keyed&nbsp;arguments&nbsp;to&nbsp;pass&nbsp;to&nbsp;genfunction&nbsp;call<br>
&nbsp;<br>
Notes:<br>
*&nbsp;This&nbsp;method&nbsp;requires&nbsp;that&nbsp;genfunction&nbsp;has&nbsp;the&nbsp;following&nbsp;prototype:<br>
&nbsp;&nbsp;&nbsp;&nbsp;*&nbsp;my_function(din,&nbsp;dout,&nbsp;tlm_ref,&nbsp;&lt;other_arguments&gt;)<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*&nbsp;din&nbsp;is&nbsp;a&nbsp;MyHDL&nbsp;Signal&nbsp;of&nbsp;type&nbsp;packet,&nbsp;and&nbsp;is&nbsp;the&nbsp;input&nbsp;signal&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;to&nbsp;the&nbsp;ipcore.&nbsp;Use&nbsp;this&nbsp;signal&nbsp;to&nbsp;react&nbsp;to&nbsp;input&nbsp;events&nbsp;and&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;receive&nbsp;input&nbsp;packets.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*&nbsp;dout&nbsp;is&nbsp;a&nbsp;MyHDL&nbsp;Signal&nbsp;of&nbsp;type&nbsp;packet,&nbsp;and&nbsp;is&nbsp;the&nbsp;output&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;signal&nbsp;to&nbsp;the&nbsp;ipcore.&nbsp;Use&nbsp;this&nbsp;signal&nbsp;to&nbsp;send&nbsp;out&nbsp;packets&nbsp;to<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;local&nbsp;channel&nbsp;(and&nbsp;then&nbsp;insert&nbsp;into&nbsp;the&nbsp;NoC).<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*&nbsp;tlm_ref&nbsp;is&nbsp;a&nbsp;reference&nbsp;to&nbsp;this&nbsp;object.&nbsp;Normal&nbsp;use&nbsp;is&nbsp;to&nbsp;access<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;logging&nbsp;methods&nbsp;(e.g.&nbsp;tlm_ref.<a href="#basic_ipcore_tlm-info">info</a>("message")&nbsp;).<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*&nbsp;&lt;other_arguments&gt;&nbsp;may&nbsp;be&nbsp;defined,&nbsp;this&nbsp;method&nbsp;use&nbsp;kwargs&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;argument&nbsp;to&nbsp;pass&nbsp;them.</tt></dd></dl>
 
<dl><dt><a name="basic_ipcore_tlm-send"><strong>send</strong></a>(self, src, dest, packet, addattrs<font color="#909090">=None</font>)</dt><dd><tt>Assumptions:&nbsp;<br>
*&nbsp;Safely&nbsp;ignore&nbsp;src&nbsp;and&nbsp;dest&nbsp;arguments,&nbsp;because&nbsp;this&nbsp;method&nbsp;<br>
&nbsp;&nbsp;is&nbsp;called&nbsp;only&nbsp;by&nbsp;this&nbsp;object&nbsp;generators,&nbsp;therefore&nbsp;it&nbsp;always&nbsp;send&nbsp;<br>
&nbsp;&nbsp;packets&nbsp;to&nbsp;the&nbsp;ipcore&nbsp;related&nbsp;channel.<br>
*&nbsp;In&nbsp;theory&nbsp;src&nbsp;should&nbsp;be&nbsp;self.<strong>ipcore_ref</strong>,&nbsp;and&nbsp;dest&nbsp;should&nbsp;be&nbsp;<br>
&nbsp;&nbsp;self.<strong>localch</strong>&nbsp;.&nbsp;This&nbsp;may&nbsp;be&nbsp;checked&nbsp;for&nbsp;errors.</tt></dd></dl>
 
<hr>
Methods inherited from <a href="nocmodel.noc_tlm_base.html#noc_tlm_base">nocmodel.noc_tlm_base.noc_tlm_base</a>:<br>
<dl><dt><a name="basic_ipcore_tlm-debug"><strong>debug</strong></a>(self, msg, *args, **kwargs)</dt><dd><tt>#&nbsp;logging&nbsp;methods&nbsp;(only&nbsp;use&nbsp;4&nbsp;levels)</tt></dd></dl>
 
<dl><dt><a name="basic_ipcore_tlm-debugstate"><strong>debugstate</strong></a>(self)</dt><dd><tt>#&nbsp;special&nbsp;log</tt></dd></dl>
 
<dl><dt><a name="basic_ipcore_tlm-error"><strong>error</strong></a>(self, msg, *args, **kwargs)</dt></dl>
 
<dl><dt><a name="basic_ipcore_tlm-get_generators"><strong>get_generators</strong></a>(self)</dt></dl>
 
<dl><dt><a name="basic_ipcore_tlm-info"><strong>info</strong></a>(self, msg, *args, **kwargs)</dt></dl>
 
<dl><dt><a name="basic_ipcore_tlm-warning"><strong>warning</strong></a>(self, msg, *args, **kwargs)</dt></dl>
 
</td></tr></table></td></tr></table>
</body></html>

Compare with Previous | Blame | View Log

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.