[keystone-rtos/edma3_lld.git] / packages / ti / sdo / edma3 / rm / docs / html / group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html
diff --git a/packages/ti/sdo/edma3/rm/docs/html/group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html b/packages/ti/sdo/edma3/rm/docs/html/group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html
index f63f43b356874dd1a319308fbefc1a0a640d2471..ff7c9506611779ed552f1ab53e022ba97ee288bf 100755 (executable)
--- a/packages/ti/sdo/edma3/rm/docs/html/group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html
+++ b/packages/ti/sdo/edma3/rm/docs/html/group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>EDMA3 Resource Manager: EDMA3 Resource Manager Initialization APIs</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-<link href="tabs.css" rel="stylesheet" type="text/css">
-</head><body>
-<!-- Generated by Doxygen 1.5.5 -->
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="classes.html"><span>Data Structures</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
</div>
<div class="contents">
-<h1>EDMA3 Resource Manager Initialization APIs<br>
+<h1>EDMA3 Resource Manager Initialization APIs<br/>
<small>
[<a class="el" href="group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n.html">EDMA3 Resource Manager APIs</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
-<tr><td></td></tr>
-<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">EDMA3_RM_Result </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html#gdc4459024208af43ca53740f5f0e24f2">EDMA3_RM_create</a> (unsigned int phyCtrllerInstId, const <a class="el" href="struct_e_d_m_a3___r_m___gbl_config_params.html">EDMA3_RM_GblConfigParams</a> *gblCfgParams, const void *miscParam)</td></tr>
-
-<tr><td class="mdescLeft"> </td><td class="mdescRight">Create EDMA3 Resource Manager Object. <a href="#gdc4459024208af43ca53740f5f0e24f2"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">EDMA3_RM_Result </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html#g91cc5101fd09c700b6d2a2e72baf88fe">EDMA3_RM_delete</a> (unsigned int phyCtrllerInstId, const void *param)</td></tr>
-
-<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete EDMA3 Resource Manager Object. <a href="#g91cc5101fd09c700b6d2a2e72baf88fe"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">EDMA3_RM_Handle </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html#g06b18003d700ce3c227f70e422dd9897">EDMA3_RM_open</a> (unsigned int phyCtrllerInstId, const <a class="el" href="struct_e_d_m_a3___r_m___param.html">EDMA3_RM_Param</a> *initParam, EDMA3_RM_Result *errorCode)</td></tr>
-
-<tr><td class="mdescLeft"> </td><td class="mdescRight">Open EDMA3 Resource Manager Instance. <a href="#g06b18003d700ce3c227f70e422dd9897"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">EDMA3_RM_Result </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html#g92776ae6a8795fe8ffce672e8a04e409">EDMA3_RM_close</a> (EDMA3_RM_Handle hEdmaResMgr, const void *param)</td></tr>
-
-<tr><td class="mdescLeft"> </td><td class="mdescRight">Close EDMA3 Resource Manager Instance. <a href="#g92776ae6a8795fe8ffce672e8a04e409"></a><br></td></tr>
+<tr><td colspan="2"><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">EDMA3_RM_Result </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html#gadc4459024208af43ca53740f5f0e24f2">EDMA3_RM_create</a> (unsigned int phyCtrllerInstId, const <a class="el" href="struct_e_d_m_a3___r_m___gbl_config_params.html">EDMA3_RM_GblConfigParams</a> *gblCfgParams, const void *miscParam)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Create EDMA3 Resource Manager Object. <a href="#gadc4459024208af43ca53740f5f0e24f2"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">EDMA3_RM_Result </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html#ga91cc5101fd09c700b6d2a2e72baf88fe">EDMA3_RM_delete</a> (unsigned int phyCtrllerInstId, const void *param)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete EDMA3 Resource Manager Object. <a href="#ga91cc5101fd09c700b6d2a2e72baf88fe"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">EDMA3_RM_Handle </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html#ga06b18003d700ce3c227f70e422dd9897">EDMA3_RM_open</a> (unsigned int phyCtrllerInstId, const <a class="el" href="struct_e_d_m_a3___r_m___param.html">EDMA3_RM_Param</a> *initParam, EDMA3_RM_Result *errorCode)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Open EDMA3 Resource Manager Instance. <a href="#ga06b18003d700ce3c227f70e422dd9897"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">EDMA3_RM_Result </td><td class="memItemRight" valign="bottom"><a class="el" href="group___e_d_m_a3___l_l_d___r_m___f_u_n_c_t_i_o_n___i_n_i_t.html#ga92776ae6a8795fe8ffce672e8a04e409">EDMA3_RM_close</a> (EDMA3_RM_Handle hEdmaResMgr, const void *param)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Close EDMA3 Resource Manager Instance. <a href="#ga92776ae6a8795fe8ffce672e8a04e409"></a><br/></td></tr>
</table>
-<hr><h2>Function Documentation</h2>
-<a class="anchor" name="gdc4459024208af43ca53740f5f0e24f2"></a><!-- doxytag: member="edma3_rm.h::EDMA3_RM_create" ref="gdc4459024208af43ca53740f5f0e24f2" args="(unsigned int phyCtrllerInstId, const EDMA3_RM_GblConfigParams *gblCfgParams, const void *miscParam)" -->
+<hr/><h2>Function Documentation</h2>
+<a class="anchor" id="gadc4459024208af43ca53740f5f0e24f2"></a><!-- doxytag: member="edma3_rm.h::EDMA3_RM_create" ref="gadc4459024208af43ca53740f5f0e24f2" args="(unsigned int phyCtrllerInstId, const EDMA3_RM_GblConfigParams *gblCfgParams, const void *miscParam)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">EDMA3_RM_Result EDMA3_RM_create </td>
+ <td class="memname">EDMA3_RM_Result EDMA3_RM_create </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>phyCtrllerInstId</em>, </td>
<tr>
<td></td>
<td>)</td>
- <td></td><td></td><td width="100%"></td>
+ <td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
-<p>
-Create EDMA3 Resource Manager Object.
-<p>
-This API is used to create the EDMA3 Resource Manager Object. It should be called only ONCE for each EDMA3 hardware instance.<p>
-Init-time Configuration structure for EDMA3 hardware is provided to pass the SoC specific information. This configuration information could be provided by the user at init-time. In case user doesn't provide it, this information could be taken from the SoC specific configuration file edma3_<SOC_NAME>_cfg.c, in case it is available.<p>
-This API clears the error specific registers (EMCR/EMCRh, QEMCR, CCERRCLR) and sets the TCs priorities and Event Queues' watermark levels, if the 'miscParam' argument is NULL. User can avoid these registers' programming (in some specific use cases) by SETTING the 'isSlave' field of 'EDMA3_RM_MiscParam' configuration structure and passing this structure as the third argument (miscParam).<p>
-After successful completion of this API, Resource Manager Object's state changes to EDMA3_RM_CREATED from EDMA3_RM_DELETED.<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
+<p>Create EDMA3 Resource Manager Object. </p>
+<p>This API is used to create the EDMA3 Resource Manager Object. It should be called only ONCE for each EDMA3 hardware instance.</p>
+<p>Init-time Configuration structure for EDMA3 hardware is provided to pass the SoC specific information. This configuration information could be provided by the user at init-time. In case user doesn't provide it, this information could be taken from the SoC specific configuration file edma3_<SOC_NAME>_cfg.c, in case it is available.</p>
+<p>This API clears the error specific registers (EMCR/EMCRh, QEMCR, CCERRCLR) and sets the TCs priorities and Event Queues' watermark levels, if the 'miscParam' argument is NULL. User can avoid these registers' programming (in some specific use cases) by SETTING the 'isSlave' field of 'EDMA3_RM_MiscParam' configuration structure and passing this structure as the third argument (miscParam).</p>
+<p>After successful completion of this API, Resource Manager Object's state changes to EDMA3_RM_CREATED from EDMA3_RM_DELETED.</p>
+<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>phyCtrllerInstId</em> </td><td>[IN] EDMA3 Controller Instance Id (Hardware instance id, starting from 0). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>gblCfgParams</em> </td><td>[IN] SoC specific configuration structure for the EDMA3 Hardware. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>miscParam</em> </td><td>[IN] Misc configuration options provided in the structure 'EDMA3_RM_MiscParam'. For default options, user can pass NULL in this argument.</td></tr>
</table>
+ </dd>
</dl>
-<dl class="return" compact><dt><b>Returns:</b></dt><dd>EDMA3_RM_SOK or EDMA3_RM Error Code </dd></dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>EDMA3_RM_SOK or EDMA3_RM Error Code </dd></dl>
</div>
-</div><p>
-<a class="anchor" name="g91cc5101fd09c700b6d2a2e72baf88fe"></a><!-- doxytag: member="edma3_rm.h::EDMA3_RM_delete" ref="g91cc5101fd09c700b6d2a2e72baf88fe" args="(unsigned int phyCtrllerInstId, const void *param)" -->
+</div>
+<a class="anchor" id="ga91cc5101fd09c700b6d2a2e72baf88fe"></a><!-- doxytag: member="edma3_rm.h::EDMA3_RM_delete" ref="ga91cc5101fd09c700b6d2a2e72baf88fe" args="(unsigned int phyCtrllerInstId, const void *param)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">EDMA3_RM_Result EDMA3_RM_delete </td>
+ <td class="memname">EDMA3_RM_Result EDMA3_RM_delete </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>phyCtrllerInstId</em>, </td>
@@ -103,33 +100,32 @@ After successful completion of this API, Resource Manager Object's state changes
<tr>
<td></td>
<td>)</td>
- <td></td><td></td><td width="100%"></td>
+ <td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
-<p>
-Delete EDMA3 Resource Manager Object.
-<p>
-This API is used to delete the EDMA3 RM Object. It should be called once for each EDMA3 hardware instance, ONLY after closing all the previously opened EDMA3 RM Instances.<p>
-After successful completion of this API, Resource Manager Object's state changes to EDMA3_RM_DELETED.<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
+<p>Delete EDMA3 Resource Manager Object. </p>
+<p>This API is used to delete the EDMA3 RM Object. It should be called once for each EDMA3 hardware instance, ONLY after closing all the previously opened EDMA3 RM Instances.</p>
+<p>After successful completion of this API, Resource Manager Object's state changes to EDMA3_RM_DELETED.</p>
+<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>phyCtrllerInstId</em> </td><td>[IN] EDMA3 Phy Controller Instance Id (Hardware instance id, starting from 0). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>[IN] For possible future use.</td></tr>
</table>
+ </dd>
</dl>
-<dl class="return" compact><dt><b>Returns:</b></dt><dd>EDMA3_RM_SOK or EDMA3_RM Error Code </dd></dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>EDMA3_RM_SOK or EDMA3_RM Error Code </dd></dl>
</div>
-</div><p>
-<a class="anchor" name="g06b18003d700ce3c227f70e422dd9897"></a><!-- doxytag: member="edma3_rm.h::EDMA3_RM_open" ref="g06b18003d700ce3c227f70e422dd9897" args="(unsigned int phyCtrllerInstId, const EDMA3_RM_Param *initParam, EDMA3_RM_Result *errorCode)" -->
+</div>
+<a class="anchor" id="ga06b18003d700ce3c227f70e422dd9897"></a><!-- doxytag: member="edma3_rm.h::EDMA3_RM_open" ref="ga06b18003d700ce3c227f70e422dd9897" args="(unsigned int phyCtrllerInstId, const EDMA3_RM_Param *initParam, EDMA3_RM_Result *errorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">EDMA3_RM_Handle EDMA3_RM_open </td>
+ <td class="memname">EDMA3_RM_Handle EDMA3_RM_open </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>phyCtrllerInstId</em>, </td>
@@ -149,37 +145,36 @@ After successful completion of this API, Resource Manager Object's state changes
<tr>
<td></td>
<td>)</td>
- <td></td><td></td><td width="100%"></td>
+ <td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
-<p>
-Open EDMA3 Resource Manager Instance.
-<p>
-This API is used to open an EDMA3 Resource Manager Instance. It could be called multiple times, for each possible EDMA3 shadow region. Maximum EDMA3_MAX_RM_INSTANCES instances are allowed for each EDMA3 hardware instance.<p>
-Also, only ONE Master Resource Manager Instance is permitted. This master instance (and hence the region to which it belongs) will only receive the EDMA3 interrupts, if enabled.<p>
-User could pass the instance specific configuration structure (initParam->rmInstInitConfig) as a part of the 'initParam' structure, during init-time. In case user doesn't provide it, this information could be taken from the SoC specific configuration file edma3_<SOC_NAME>_cfg.c, in case it is available.<p>
-By default, this Resource Manager instance will clear the PaRAM Sets while allocating them. To change the default behavior, user should use the IOCTL interface appropriately.<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
+<p>Open EDMA3 Resource Manager Instance. </p>
+<p>This API is used to open an EDMA3 Resource Manager Instance. It could be called multiple times, for each possible EDMA3 shadow region. Maximum EDMA3_MAX_RM_INSTANCES instances are allowed for each EDMA3 hardware instance.</p>
+<p>Also, only ONE Master Resource Manager Instance is permitted. This master instance (and hence the region to which it belongs) will only receive the EDMA3 interrupts, if enabled.</p>
+<p>User could pass the instance specific configuration structure (initParam->rmInstInitConfig) as a part of the 'initParam' structure, during init-time. In case user doesn't provide it, this information could be taken from the SoC specific configuration file edma3_<SOC_NAME>_cfg.c, in case it is available.</p>
+<p>By default, this Resource Manager instance will clear the PaRAM Sets while allocating them. To change the default behavior, user should use the IOCTL interface appropriately.</p>
+<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>phyCtrllerInstId</em> </td><td>[IN] EDMA3 Controller Instance Id (Hardware instance id, starting from 0). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>initParam</em> </td><td>[IN] Used to Initialize the Resource Manager Instance (Master or Slave). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>errorCode</em> </td><td>[OUT] Error code while opening RM instance.</td></tr>
</table>
+ </dd>
</dl>
-<dl class="return" compact><dt><b>Returns:</b></dt><dd>Handle to the opened Resource Manager instance Or NULL in case of error.</dd></dl>
-<dl class="note" compact><dt><b>Note:</b></dt><dd>This function disables the global interrupts (by calling API edma3OsProtectEntry with protection level EDMA3_OS_PROTECT_INTERRUPT) while modifying the global RM data structures, to make it re-entrant. </dd></dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Handle to the opened Resource Manager instance Or NULL in case of error.</dd></dl>
+<dl class="note"><dt><b>Note:</b></dt><dd>This function disables the global interrupts (by calling API edma3OsProtectEntry with protection level EDMA3_OS_PROTECT_INTERRUPT) while modifying the global RM data structures, to make it re-entrant. </dd></dl>
</div>
-</div><p>
-<a class="anchor" name="g92776ae6a8795fe8ffce672e8a04e409"></a><!-- doxytag: member="edma3_rm.h::EDMA3_RM_close" ref="g92776ae6a8795fe8ffce672e8a04e409" args="(EDMA3_RM_Handle hEdmaResMgr, const void *param)" -->
+</div>
+<a class="anchor" id="ga92776ae6a8795fe8ffce672e8a04e409"></a><!-- doxytag: member="edma3_rm.h::EDMA3_RM_close" ref="ga92776ae6a8795fe8ffce672e8a04e409" args="(EDMA3_RM_Handle hEdmaResMgr, const void *param)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">EDMA3_RM_Result EDMA3_RM_close </td>
+ <td class="memname">EDMA3_RM_Result EDMA3_RM_close </td>
<td>(</td>
<td class="paramtype">EDMA3_RM_Handle </td>
<td class="paramname"> <em>hEdmaResMgr</em>, </td>
@@ -193,30 +188,29 @@ By default, this Resource Manager instance will clear the PaRAM Sets while alloc
<tr>
<td></td>
<td>)</td>
- <td></td><td></td><td width="100%"></td>
+ <td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
-<p>
-Close EDMA3 Resource Manager Instance.
-<p>
-This API is used to close a previously opened EDMA3 RM Instance.<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
+<p>Close EDMA3 Resource Manager Instance. </p>
+<p>This API is used to close a previously opened EDMA3 RM Instance.</p>
+<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hEdmaResMgr</em> </td><td>[IN] Handle to the previously opened Resource Manager Instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>[IN] For possible future use.</td></tr>
</table>
+ </dd>
</dl>
-<dl class="return" compact><dt><b>Returns:</b></dt><dd>EDMA3_RM_SOK or EDMA3_RM Error Code</dd></dl>
-<dl class="note" compact><dt><b>Note:</b></dt><dd>This function disables the global interrupts (by calling API edma3OsProtectEntry with protection level EDMA3_OS_PROTECT_INTERRUPT) while modifying the global RM data structures, to make it re-entrant. </dd></dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>EDMA3_RM_SOK or EDMA3_RM Error Code</dd></dl>
+<dl class="note"><dt><b>Note:</b></dt><dd>This function disables the global interrupts (by calling API edma3OsProtectEntry with protection level EDMA3_OS_PROTECT_INTERRUPT) while modifying the global RM data structures, to make it re-entrant. </dd></dl>
</div>
-</div><p>
</div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 7 12:02:44 2010 for EDMA3 Resource Manager by
+</div>
+<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Jan 28 16:33:50 2011 for EDMA3 Resource Manager by
<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>