stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/XilinxProcessorIPLib/drivers/bram/doc/html/api/xbram_8c.html

102 lines
5.2 KiB
HTML
Raw Normal View History

embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
Xilinx Driver bram v4_0: xbram.c File Reference
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
</title>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xbram.c File Reference</h1><code>#include &quot;<a class="el" href="xbram_8h.html">xbram.h</a>&quot;</code><br/>
<code>#include &quot;xstatus.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xbram_8c.html#a3ce9315dffb9dcef3c85b6471d7ac6bf">XBram_CfgInitialize</a> (<a class="el" href="struct_x_bram.html">XBram</a> *InstancePtr, <a class="el" href="struct_x_bram___config.html">XBram_Config</a> *Config, u32 EffectiveAddr)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The implementation of the <a class="el" href="struct_x_bram.html">XBram</a> driver's basic functionality. See <a class="el" href="xbram_8h.html">xbram.h</a> for more information about the driver.</p>
<dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
<p>None</p>
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
<pre>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
----- ---- -------- -----------------------------------------------
1.00a sa 05/11/10 First release
3.01a sa 13/01/12 Added CorrectableFailingDataRegs and
UncorrectableFailingDataRegs in
XBram_CfgInitialize API.
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
</pre> <hr/><h2>Function Documentation</h2>
<a class="anchor" id="a3ce9315dffb9dcef3c85b6471d7ac6bf"></a><!-- doxytag: member="xbram.c::XBram_CfgInitialize" ref="a3ce9315dffb9dcef3c85b6471d7ac6bf" args="(XBram *InstancePtr, XBram_Config *Config, u32 EffectiveAddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
<tr>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
<td class="memname">int XBram_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_bram.html">XBram</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
</tr>
<tr>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_bram___config.html">XBram_Config</a> *&nbsp;</td>
<td class="paramname"> <em>Config</em>, </td>
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
</tr>
<tr>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddr</em></td><td>&nbsp;</td>
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
</tr>
<tr>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
<td></td>
<td>)</td>
<td></td><td></td><td></td>
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
</tr>
</table>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
</div>
<div class="memdoc">
<p>Initialize the <a class="el" href="struct_x_bram.html">XBram</a> instance provided by the caller based on the given configuration data.</p>
<p>Nothing is done except to initialize the InstancePtr.</p>
<dl><dt><b>Parameters:</b></dt><dd>
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to an <a class="el" href="struct_x_bram.html">XBram</a> instance. The memory the pointer references must be pre-allocated by the caller. Further calls to manipulate the driver through the <a class="el" href="struct_x_bram.html">XBram</a> API must be made with this pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Config</em>&nbsp;</td><td>is a reference to a structure containing information about a specific BRAM device. This function initializes an InstancePtr object for a specific device specified by the contents of Config. This function can initialize multiple instance objects with the use of multiple calls giving different Config information on each call. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddr</em>&nbsp;</td><td>is the device base address in the virtual memory address space. The caller is responsible for keeping the address mapping from EffectiveAddr to the device physical base address unchanged once this function is invoked. Unexpected errors may occur if the address mapping changes after this function is called. If address translation is not used, use Config-&gt;BaseAddress for this parameters, passing the physical address instead.</td></tr>
</table>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
</dd>
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
</dl>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS Initialization was successful.</li>
</ul>
embeddesw: Add initial code support Added initial support Xilinx Embedded Software. Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30
</dd></dl>
doxygen: Update doxygen for the drivers to include .h files in documentation. This patch updates the doxygen for the drivers axivdma, can, canps ,devcfg , bram to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-08-21 14:11:58 +05:30
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
Reference in a new issue Copy permalink