[processor-sdk/performance-audio-sr.git] / pdk_k2g_1_0_1 / packages / ti / csl / docs / doxygen / html / csl__dfe_get_base_address_8c.html
diff --git a/pdk_k2g_1_0_1/packages/ti/csl/docs/doxygen/html/csl__dfe_get_base_address_8c.html b/pdk_k2g_1_0_1/packages/ti/csl/docs/doxygen/html/csl__dfe_get_base_address_8c.html
+++ /dev/null
@@ -1,117 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>csl_dfeGetBaseAddress.c File Reference</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-<link href="tabs.css" rel="stylesheet" type="text/css">
-</head><body>
-<table width=100%>
-<tr>
- <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border=0 src="../../tilogo.gif"></a></td>
- <td bgcolor="red"><img src="../../titagline.gif"></td>
-</tr>
-</table>
-<!-- Generated by Doxygen 1.8.9.1 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li class="current"><a href="files.html"><span>Files</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>Globals</span></a></li>
- </ul>
- </div>
-<div id="nav-path" class="navpath">
- <ul>
-<li class="navelem"><a class="el" href="dir_19d806e154b23a5f4c4c08b2e30365a6.html">soc</a></li><li class="navelem"><a class="el" href="dir_ac2ee3219e32ebb8436dcf0841fcc12d.html">k2l</a></li><li class="navelem"><a class="el" href="dir_40fbead9fa3603474e0297bbd2216832.html">src</a></li> </ul>
-</div>
-</div><!-- top -->
-<div class="header">
- <div class="summary">
-<a href="#func-members">Functions</a> </div>
- <div class="headertitle">
-<div class="title">csl_dfeGetBaseAddress.c File Reference</div> </div>
-</div><!--header-->
-<div class="contents">
-
-<p>File for functional layer of CSL API CSL_dfeGetBaseAddress ()
-<a href="#details">More...</a></p>
-<div class="textblock"><code>#include <ti/csl/soc.h></code><br />
-<code>#include <ti/csl/csl_dfe.h></code><br />
-</div><table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
-Functions</h2></td></tr>
-<tr class="memitem:a87f31549cf070f5f8468adadeb8be4e9"><td class="memItemLeft" align="right" valign="top">CSL_Status </td><td class="memItemRight" valign="bottom"><a class="el" href="csl__dfe_get_base_address_8c.html#a87f31549cf070f5f8468adadeb8be4e9">CSL_dfeGetBaseAddress</a> (CSL_InstNum dfeNum, CSL_DfeParam *pDfeParam, CSL_DfeBaseAddress *pBaseAddress)</td></tr>
-<tr class="separator:a87f31549cf070f5f8468adadeb8be4e9"><td class="memSeparator" colspan="2"> </td></tr>
-</table>
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>File for functional layer of CSL API CSL_dfeGetBaseAddress () </p>
-<p>===========================================================================</p>
-<p>The CSL_dfeGetBaseAddress function definition. </p>
-</div><h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="a87f31549cf070f5f8468adadeb8be4e9"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">CSL_Status CSL_dfeGetBaseAddress </td>
- <td>(</td>
- <td class="paramtype">CSL_InstNum </td>
- <td class="paramname"><em>dfeNum</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">CSL_DfeParam * </td>
- <td class="paramname"><em>pDfeParam</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">CSL_DfeBaseAddress * </td>
- <td class="paramname"><em>pBaseAddress</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
-</div><div class="memdoc">
-<p>============================================================================ <br />
-<b>CSL_dfeGetBaseAddress</b> </p>
-<p><b>Description</b> <br />
- Function to get the base address of the peripheral instance. This function is used for getting the base address of the peripheral instance. This function will be called inside the CSL_dfeOpen() function call. This function is open for re-implementing if the user wants to modify the base address of the peripheral object to point to a different location and there by allow CSL initiated write/reads into peripheral. MMR's go to an alternate location.</p>
-<p><b>Arguments</b> </p><pre class="fragment"> dfeNum Specifies the instance of the DFE to be opened.
-
- pdfe2Param Module specific parameters.
-
- pBaseAddress Pointer to baseaddress structure containing base
- address details.</pre><p><b> Return Value </b> CSL_Status </p><ul>
-<li>CSL_SOK Successful on getting the base address of bwmngmt </li>
-<li>CSL_ESYS_FAIL The instance number is invalid. </li>
-<li>CSL_ESYS_INVPARAMS Inavlid parameters</li>
-</ul>
-<p><b> Pre Condition </b> <br />
- None</p>
-<p><b> Post Condition </b> <br />
- Base Address structure is populated</p>
-<p><b>Affects</b> <br />
- 1. The status variable </p><pre class="fragment"> 2. Base address structure is modified.
-</pre><p><b>Example</b> </p><pre class="fragment"> CSL_Status status;
- CSL_dfeBaseAddress baseAddress;
-
- ...
- status = CSL_dfeGetBaseAddress(CSL_DFE, NULL, &baseAddress);</pre><hr/>
-
-</div>
-</div>
-</div><!-- contents -->
-<hr size="1"><small>
-Copyright 2016, Texas Instruments Incorporated</small>
-</body>
-</html>