packages/ti/sdo/edma3/rm/docs/html/structedma3__rm__obj.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>EDMA3 Resource Manager: EDMA3_RM_Obj Struct Reference</title>
   4 <link href="tabs.css" rel="stylesheet" type="text/css">
   5 <link href="doxygen.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.9 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  14       <li><a href="files.html"><span>Files</span></a></li>
  15     </ul>
  16   </div>
  17   <div class="tabs">
  18     <ul>
  19       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  20       <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
  21       <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  22     </ul>
  23   </div>
  24 </div>
  25 <div class="contents">
  26 <h1>EDMA3_RM_Obj Struct Reference<br>
  27 <small>
  28 [<a class="el" href="group__Edma3ResMgrIntObjMaint.html">Object Maintenance</a>]</small>
  29 </h1><!-- doxytag: class="EDMA3_RM_Obj" -->EDMA3 Hardware Instance Configuration Structure.
  30 <a href="#_details">More...</a>
  31 <p>
  32 <code>#include &lt;<a class="el" href="edma3resmgr_8h_source.html">edma3resmgr.h</a>&gt;</code>
  33 <p>
  34 <table border="0" cellpadding="0" cellspacing="0">
  35 <tr><td></td></tr>
  36 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
  37 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEDMA3__RM__Obj.html#e3c0a4a97c25259407c34e3582255198">phyCtrllerInstId</a></td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__Edma3ResMgrIntObjMaint.html#g12f47d9e744ff042541b8f384331e213">EDMA3_RM_ObjState</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEDMA3__RM__Obj.html#a262df0776f0a9b6163e8f64d91a0265">state</a></td></tr>
  40
  41 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEDMA3__RM__Obj.html#13b4308a8ad6baf647b5c7adbe54702c">numOpens</a></td></tr>
  42
  43 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structEDMA3__RM__GblConfigParams.html">EDMA3_RM_GblConfigParams</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEDMA3__RM__Obj.html#6bac11beb5c7f95204cac16455bb424c">gblCfgParams</a></td></tr>
  44
  45 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Init-time Configuration structure for EDMA3 controller, to provide Global SoC specific Information.  <a href="#6bac11beb5c7f95204cac16455bb424c"></a><br></td></tr>
  46 </table>
  47 <hr><a name="_details"></a><h2>Detailed Description</h2>
  48 EDMA3 Hardware Instance Configuration Structure.
  49 <p>
  50 Used to maintain information of the EDMA3 HW configuration. One such storage exists for each instance of the EDMA 3 HW. <hr><h2>Field Documentation</h2>
  51 <a class="anchor" name="6bac11beb5c7f95204cac16455bb424c"></a><!-- doxytag: member="EDMA3_RM_Obj::gblCfgParams" ref="6bac11beb5c7f95204cac16455bb424c" args="" -->
  52 <div class="memitem">
  53 <div class="memproto">
  54       <table class="memname">
  55         <tr>
  56           <td class="memname"><a class="el" href="structEDMA3__RM__GblConfigParams.html">EDMA3_RM_GblConfigParams</a> <a class="el" href="structEDMA3__RM__Obj.html#6bac11beb5c7f95204cac16455bb424c">EDMA3_RM_Obj::gblCfgParams</a>          </td>
  57         </tr>
  58       </table>
  59 </div>
  60 <div class="memdoc">
  61
  62 <p>
  63 Init-time Configuration structure for EDMA3 controller, to provide Global SoC specific Information.
  64 <p>
  65 This configuration will can be provided by the user at run-time, while calling <a class="el" href="group__Edma3RMMain.html#gdc4459024208af43ca53740f5f0e24f2" title="Create EDMA3 Resource Manager Object.">EDMA3_RM_create()</a>.
  66 <p>Referenced by <a class="el" href="edma3resmgr_8c_source.html#l03695">EDMA3_RM_allocContiguousResource()</a>, <a class="el" href="edma3resmgr_8c_source.html#l02074">EDMA3_RM_allocLogicalChannel()</a>, <a class="el" href="edma3resmgr_8c_source.html#l01103">EDMA3_RM_allocResource()</a>, <a class="el" href="edma3resmgr_8c_source.html#l04696">EDMA3_RM_checkAndClearTcc()</a>, <a class="el" href="edma3resmgr_8c_source.html#l00953">EDMA3_RM_close()</a>, <a class="el" href="edma3resmgr_8c_source.html#l00367">EDMA3_RM_create()</a>, <a class="el" href="edma3resmgr_8c_source.html#l04257">EDMA3_RM_freeContiguousResource()</a>, <a class="el" href="edma3resmgr_8c_source.html#l02703">EDMA3_RM_freeLogicalChannel()</a>, <a class="el" href="edma3resmgr_8c_source.html#l01710">EDMA3_RM_freeResource()</a>, <a class="el" href="edma3resmgr_8c_source.html#l05325">EDMA3_RM_getBaseAddress()</a>, <a class="el" href="edma3resmgr_8c_source.html#l04475">EDMA3_RM_getCCRegister()</a>, <a class="el" href="edma3resmgr_8c_source.html#l04993">EDMA3_RM_getPaRAM()</a>, <a class="el" href="edma3resmgr_8c_source.html#l05165">EDMA3_RM_getPaRAMPhyAddr()</a>, <a class="el" href="edma3resmgr_8c_source.html#l03060">EDMA3_RM_mapEdmaChannel()</a>, <a class="el" href="edma3resmgr_8c_source.html#l03217">EDMA3_RM_mapQdmaChannel()</a>, <a class="el" href="edma3resmgr_8c_source.html#l00642">EDMA3_RM_open()</a>, <a class="el" href="edma3resmgr_8c_source.html#l03369">EDMA3_RM_registerTccCb()</a>, <a class="el" href="edma3resmgr_8c_source.html#l04382">EDMA3_RM_setCCRegister()</a>, <a class="el" href="edma3resmgr_8c_source.html#l04830">EDMA3_RM_setPaRAM()</a>, <a class="el" href="edma3resmgr_8c_source.html#l03529">EDMA3_RM_unregisterTccCb()</a>, <a class="el" href="edma3resmgr_8c_source.html#l04560">EDMA3_RM_waitAndClearTcc()</a>, <a class="el" href="edma3resmgr_8c_source.html#l05934">edma3CCErrHandler()</a>, <a class="el" href="edma3resmgr_8c_source.html#l05778">edma3ComplHandler()</a>, <a class="el" href="edma3resmgr_8c_source.html#l06310">edma3TCErrHandler()</a>, and <a class="el" href="edma3resmgr_8c_source.html#l07129">gblChngAllocContigRes()</a>.</p>
  67
  68 </div>
  69 </div><p>
  70 <a class="anchor" name="13b4308a8ad6baf647b5c7adbe54702c"></a><!-- doxytag: member="EDMA3_RM_Obj::numOpens" ref="13b4308a8ad6baf647b5c7adbe54702c" args="" -->
  71 <div class="memitem">
  72 <div class="memproto">
  73       <table class="memname">
  74         <tr>
  75           <td class="memname">unsigned int <a class="el" href="structEDMA3__RM__Obj.html#13b4308a8ad6baf647b5c7adbe54702c">EDMA3_RM_Obj::numOpens</a>          </td>
  76         </tr>
  77       </table>
  78 </div>
  79 <div class="memdoc">
  80
  81 <p>
  82 Number of active opens of RM Instances
  83 <p>Referenced by <a class="el" href="edma3resmgr_8c_source.html#l00953">EDMA3_RM_close()</a>, <a class="el" href="edma3resmgr_8c_source.html#l00367">EDMA3_RM_create()</a>, <a class="el" href="edma3resmgr_8c_source.html#l00642">EDMA3_RM_open()</a>, <a class="el" href="edma3resmgr_8c_source.html#l05934">edma3CCErrHandler()</a>, and <a class="el" href="edma3resmgr_8c_source.html#l06310">edma3TCErrHandler()</a>.</p>
  84
  85 </div>
  86 </div><p>
  87 <a class="anchor" name="e3c0a4a97c25259407c34e3582255198"></a><!-- doxytag: member="EDMA3_RM_Obj::phyCtrllerInstId" ref="e3c0a4a97c25259407c34e3582255198" args="" -->
  88 <div class="memitem">
  89 <div class="memproto">
  90       <table class="memname">
  91         <tr>
  92           <td class="memname">unsigned int <a class="el" href="structEDMA3__RM__Obj.html#e3c0a4a97c25259407c34e3582255198">EDMA3_RM_Obj::phyCtrllerInstId</a>          </td>
  93         </tr>
  94       </table>
  95 </div>
  96 <div class="memdoc">
  97
  98 <p>
  99 HW Instance Id of the EDMA3 Controller
 100 <p>Referenced by <a class="el" href="edma3resmgr_8c_source.html#l02074">EDMA3_RM_allocLogicalChannel()</a>, <a class="el" href="edma3resmgr_8c_source.html#l00953">EDMA3_RM_close()</a>, <a class="el" href="edma3resmgr_8c_source.html#l00367">EDMA3_RM_create()</a>, <a class="el" href="edma3resmgr_8c_source.html#l02703">EDMA3_RM_freeLogicalChannel()</a>, <a class="el" href="edma3resmgr_8c_source.html#l05498">EDMA3_RM_getInstanceInitCfg()</a>, <a class="el" href="edma3resmgr_8c_source.html#l04993">EDMA3_RM_getPaRAM()</a>, <a class="el" href="edma3resmgr_8c_source.html#l05165">EDMA3_RM_getPaRAMPhyAddr()</a>, <a class="el" href="edma3resmgr_8c_source.html#l04830">EDMA3_RM_setPaRAM()</a>, <a class="el" href="edma3resmgr_8c_source.html#l05934">edma3CCErrHandler()</a>, <a class="el" href="edma3resmgr_8c_source.html#l06637">edma3ShadowRegionInit()</a>, and <a class="el" href="edma3resmgr_8c_source.html#l06310">edma3TCErrHandler()</a>.</p>
 101
 102 </div>
 103 </div><p>
 104 <a class="anchor" name="a262df0776f0a9b6163e8f64d91a0265"></a><!-- doxytag: member="EDMA3_RM_Obj::state" ref="a262df0776f0a9b6163e8f64d91a0265" args="" -->
 105 <div class="memitem">
 106 <div class="memproto">
 107       <table class="memname">
 108         <tr>
 109           <td class="memname"><a class="el" href="group__Edma3ResMgrIntObjMaint.html#g12f47d9e744ff042541b8f384331e213">EDMA3_RM_ObjState</a> <a class="el" href="structEDMA3__RM__Obj.html#a262df0776f0a9b6163e8f64d91a0265">EDMA3_RM_Obj::state</a>          </td>
 110         </tr>
 111       </table>
 112 </div>
 113 <div class="memdoc">
 114
 115 <p>
 116 State information of the Resource Manager object
 117 <p>Referenced by <a class="el" href="edma3resmgr_8c_source.html#l00953">EDMA3_RM_close()</a>, <a class="el" href="edma3resmgr_8c_source.html#l00367">EDMA3_RM_create()</a>, <a class="el" href="edma3resmgr_8c_source.html#l00548">EDMA3_RM_delete()</a>, and <a class="el" href="edma3resmgr_8c_source.html#l00642">EDMA3_RM_open()</a>.</p>
 118
 119 </div>
 120 </div><p>
 121 <hr>The documentation for this struct was generated from the following file:<ul>
 122 <li><a class="el" href="edma3resmgr_8h_source.html">edma3resmgr.h</a></ul>
 123 </div>
 124 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 22:22:32 2009 for EDMA3 Resource Manager by&nbsp;
 125 <a href="http://www.doxygen.org/index.html">
 126 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
 127 </body>
 128 </html>