stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

doxygen: Update doxygen for the drivers to include .h files in documentation.

Browse source 
This patch updates the doxygen for the drivers
llfifo,mbox,mig_7series,mutex,nandps to include .h files
in the listof files provided in the index.html file.

Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
This commit is contained in:
Kedareswara rao Appana 2014-08-21 15:45:45 +05:30 • committed by Jagannadha Sutradharudu Teki
parent 8933d11dd5
commit 86bd3b7ed3
128 changed files with 21094 additions and 16481 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/annotated.html
View file

@ -2,28 +2,41 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class List Xilinx Driver llfifo v4_0: Class List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li id="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<li class="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> <h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td class="indexvalue"></td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

39
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/classes.html Executable file
View file

@ -0,0 +1,39 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: Alphabetical List
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class Index</h1><div class="qindex"><a class="qindex" href="#letter_X">X</a></div>
<table align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
<tr><td><a name="letter_X"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&nbsp;&nbsp;X&nbsp;&nbsp;</div></td></tr></table>
</td><td><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a>&nbsp;&nbsp;&nbsp;</td></tr><tr><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a>&nbsp;&nbsp;&nbsp;</td></tr></table><div class="qindex"><a class="qindex" href="#letter_X">X</a></div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

49
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/files.html
View file

@ -2,27 +2,44 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
File Index Xilinx Driver llfifo v4_0: File Index
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li id="current"><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table> <li class="current"><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>File List</h1>Here is a list of all files with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="xdebug_8h.html">xdebug.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xllfifo_8c.html">xllfifo.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xllfifo_8c.html">xllfifo.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xllfifo_8h.html">xllfifo.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xllfifo__g_8c.html">xllfifo_g.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xllfifo__hw_8h.html">xllfifo_hw.h</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xllfifo__hw_8h.html">xllfifo_hw.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xllfifo__sinit_8c.html">xllfifo_sinit.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xstreamer_8c.html">xstreamer.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xstreamer_8h.html">xstreamer.h</a></td><td class="indexvalue"></td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

141
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/functions.html
View file

@ -2,50 +2,111 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver llfifo v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<ul> <li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<li id="current"><a href="functions.html"><span>All</span></a></li> </ul>
<li><a href="functions_vars.html"><span>Variables</span></a></li> </div>
</ul> <div class="tabs">
<ul>
<li class="current"><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
</div> </div>
Here is a list of all documented class members with links to the class documentation for each member: <div class="contents">
<p> Here is a list of all class members with links to the classes they belong to:<ul>
<ul> <li>_words
: <a class="el" href="union_x_strm___aligned_buffer_type.html#a459bdbeb843b8316832b438cd7b217c0">XStrm_AlignedBufferType</a>
</li>
<li>AlignedBuffer
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a5d1f8f992cd102849b29a2df35751393">XStrm_RxFifoStreamer</a>
, <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab219d36b21fc84935af04761c15ff26d">XStrm_TxFifoStreamer</a>
</li>
<li>Axi4BaseAddress <li>Axi4BaseAddress
: <a class="el" href="struct_x_ll_fifo.html#438cd6b96ee27adaa3fea84002cd9ca7">XLlFifo</a><li>BaseAddress : <a class="el" href="struct_x_ll_fifo.html#a455c634fb80553cecfcba0845eb99937">XLlFifo</a>
: <a class="el" href="struct_x_ll_fifo.html#2fac08c24c8373333b9f2a62008c62f3">XLlFifo</a><li>Datainterface , <a class="el" href="struct_x_ll_fifo___config.html#a600aa696ac4ce50735710630b367246c">XLlFifo_Config</a>
: <a class="el" href="struct_x_ll_fifo.html#ee4242124c1d886b866be52f6257213b">XLlFifo</a><li>FifoInstance </li>
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">XStrm_TxFifoStreamer</a>, <a class="el" href="struct_x_strm___rx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">XStrm_RxFifoStreamer</a><li>FifoWidth <li>BaseAddress
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">XStrm_TxFifoStreamer</a>, <a class="el" href="struct_x_strm___rx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">XStrm_RxFifoStreamer</a><li>FrmByteCnt : <a class="el" href="struct_x_ll_fifo.html#ab1d14782860778f2546bee03cb27f192">XLlFifo</a>
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#c9b82181b5681676c677e9642eb1bfcb">XStrm_RxFifoStreamer</a><li>GetLenFn , <a class="el" href="struct_x_ll_fifo___config.html#a02a215c2efef7ec7033f0a08b86b4a9d">XLlFifo_Config</a>
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#dd45a9ebbb8375a67632dfde3cf8b54d">XStrm_RxFifoStreamer</a><li>GetOccupancyFn </li>
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#e49284720f12f2cbdaffc98fd54d0dc6">XStrm_RxFifoStreamer</a><li>GetVacancyFn <li>bytes
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#df4ee39f9fabb84e3ecdd90bf816cc4e">XStrm_TxFifoStreamer</a><li>HeadIndex : <a class="el" href="union_x_strm___aligned_buffer_type.html#ade878ac1f429178b76fa7c27e5d3ed0e">XStrm_AlignedBufferType</a>
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#de91e0d42dec554b7f9d31df3c1b4a30">XStrm_RxFifoStreamer</a><li>IsReady </li>
: <a class="el" href="struct_x_ll_fifo.html#217c41df00b2eee11e1009f5e63905ed">XLlFifo</a><li>ReadFn <li>Datainterface
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#4afca30e32cb505d0e7fed24f7fcaff7">XStrm_RxFifoStreamer</a><li>RxStreamer : <a class="el" href="struct_x_ll_fifo.html#a9e2342496ea8183c012567d7c89851b3">XLlFifo</a>
: <a class="el" href="struct_x_ll_fifo.html#d886e27309d954a46cafa61bd18f0750">XLlFifo</a><li>SetLenFn , <a class="el" href="struct_x_ll_fifo___config.html#a9e1566949ac9b883fe383d308dea1a43">XLlFifo_Config</a>
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#d4667ecb5841d1d626c39b7f026dd98f">XStrm_TxFifoStreamer</a><li>TailIndex </li>
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#343b2db47525585673b88c2c3a7d7389">XStrm_TxFifoStreamer</a><li>TxStreamer <li>DeviceId
: <a class="el" href="struct_x_ll_fifo.html#45c391d0a8e6df6b45e6dd49661f27d6">XLlFifo</a><li>WriteFn : <a class="el" href="struct_x_ll_fifo___config.html#a18aac4f0cfbb75922f630c92b0d35308">XLlFifo_Config</a>
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#bbf213c206b45f0f121c0cae755b6788">XStrm_TxFifoStreamer</a></ul> </li>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <li>FifoInstance
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#ab278ceaef035943f8a3a8b85a8cab99d">XStrm_RxFifoStreamer</a>
, <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ac20fde8a3090fddfc01f8b2900fd9051">XStrm_TxFifoStreamer</a>
</li>
<li>FifoWidth
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#a474cf91d66d43f716a34299d4ab9b9b2">XStrm_TxFifoStreamer</a>
, <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a3ad4cdd1ad14dcecfaf5f923850289fb">XStrm_RxFifoStreamer</a>
</li>
<li>FrmByteCnt
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a9fa74d02f4fa2607e78b11de059be837">XStrm_RxFifoStreamer</a>
</li>
<li>GetLenFn
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a01fa1cc2098388ac9371beb090c0c212">XStrm_RxFifoStreamer</a>
</li>
<li>GetOccupancyFn
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a8d552e42f58c3230de010178832b41b1">XStrm_RxFifoStreamer</a>
</li>
<li>GetVacancyFn
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab33212eea0a6327f2c6b1173510170a9">XStrm_TxFifoStreamer</a>
</li>
<li>HeadIndex
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a6321ab6bf1a1f3979c0771618a4aba7c">XStrm_RxFifoStreamer</a>
</li>
<li>IsReady
: <a class="el" href="struct_x_ll_fifo.html#abe388bb422699248b26a9d76652474b1">XLlFifo</a>
</li>
<li>ReadFn
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#af3bfc974fd88c7b707edf680b3c9aed2">XStrm_RxFifoStreamer</a>
</li>
<li>RxStreamer
: <a class="el" href="struct_x_ll_fifo.html#a456fbf87ce23b1334c67b386722b1434">XLlFifo</a>
</li>
<li>SetLenFn
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#aa315e740022ccc81ef9cccfe7c82022d">XStrm_TxFifoStreamer</a>
</li>
<li>TailIndex
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#a265500391a387c5354a14fea79a1b446">XStrm_TxFifoStreamer</a>
</li>
<li>TxStreamer
: <a class="el" href="struct_x_ll_fifo.html#a13363fb4d5d45a5725b7427b36c44817">XLlFifo</a>
</li>
<li>WriteFn
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#abaed83d1259485a6deadbf4644b0be1b">XStrm_TxFifoStreamer</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

141
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/functions_vars.html
View file

@ -2,50 +2,111 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members - Variables Xilinx Driver llfifo v4_0: Class Members - Variables
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<ul> <li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<li><a href="functions.html"><span>All</span></a></li> </ul>
<li id="current"><a href="functions_vars.html"><span>Variables</span></a></li> </div>
</ul> <div class="tabs">
<ul>
<li><a href="functions.html"><span>All</span></a></li>
<li class="current"><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
</div> </div>
&nbsp; <div class="contents">
<p> &nbsp;<ul>
<ul> <li>_words
: <a class="el" href="union_x_strm___aligned_buffer_type.html#a459bdbeb843b8316832b438cd7b217c0">XStrm_AlignedBufferType</a>
</li>
<li>AlignedBuffer
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a5d1f8f992cd102849b29a2df35751393">XStrm_RxFifoStreamer</a>
, <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab219d36b21fc84935af04761c15ff26d">XStrm_TxFifoStreamer</a>
</li>
<li>Axi4BaseAddress <li>Axi4BaseAddress
: <a class="el" href="struct_x_ll_fifo.html#438cd6b96ee27adaa3fea84002cd9ca7">XLlFifo</a><li>BaseAddress : <a class="el" href="struct_x_ll_fifo.html#a455c634fb80553cecfcba0845eb99937">XLlFifo</a>
: <a class="el" href="struct_x_ll_fifo.html#2fac08c24c8373333b9f2a62008c62f3">XLlFifo</a><li>Datainterface , <a class="el" href="struct_x_ll_fifo___config.html#a600aa696ac4ce50735710630b367246c">XLlFifo_Config</a>
: <a class="el" href="struct_x_ll_fifo.html#ee4242124c1d886b866be52f6257213b">XLlFifo</a><li>FifoInstance </li>
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">XStrm_TxFifoStreamer</a>, <a class="el" href="struct_x_strm___rx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">XStrm_RxFifoStreamer</a><li>FifoWidth <li>BaseAddress
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">XStrm_TxFifoStreamer</a>, <a class="el" href="struct_x_strm___rx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">XStrm_RxFifoStreamer</a><li>FrmByteCnt : <a class="el" href="struct_x_ll_fifo.html#ab1d14782860778f2546bee03cb27f192">XLlFifo</a>
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#c9b82181b5681676c677e9642eb1bfcb">XStrm_RxFifoStreamer</a><li>GetLenFn , <a class="el" href="struct_x_ll_fifo___config.html#a02a215c2efef7ec7033f0a08b86b4a9d">XLlFifo_Config</a>
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#dd45a9ebbb8375a67632dfde3cf8b54d">XStrm_RxFifoStreamer</a><li>GetOccupancyFn </li>
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#e49284720f12f2cbdaffc98fd54d0dc6">XStrm_RxFifoStreamer</a><li>GetVacancyFn <li>bytes
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#df4ee39f9fabb84e3ecdd90bf816cc4e">XStrm_TxFifoStreamer</a><li>HeadIndex : <a class="el" href="union_x_strm___aligned_buffer_type.html#ade878ac1f429178b76fa7c27e5d3ed0e">XStrm_AlignedBufferType</a>
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#de91e0d42dec554b7f9d31df3c1b4a30">XStrm_RxFifoStreamer</a><li>IsReady </li>
: <a class="el" href="struct_x_ll_fifo.html#217c41df00b2eee11e1009f5e63905ed">XLlFifo</a><li>ReadFn <li>Datainterface
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#4afca30e32cb505d0e7fed24f7fcaff7">XStrm_RxFifoStreamer</a><li>RxStreamer : <a class="el" href="struct_x_ll_fifo.html#a9e2342496ea8183c012567d7c89851b3">XLlFifo</a>
: <a class="el" href="struct_x_ll_fifo.html#d886e27309d954a46cafa61bd18f0750">XLlFifo</a><li>SetLenFn , <a class="el" href="struct_x_ll_fifo___config.html#a9e1566949ac9b883fe383d308dea1a43">XLlFifo_Config</a>
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#d4667ecb5841d1d626c39b7f026dd98f">XStrm_TxFifoStreamer</a><li>TailIndex </li>
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#343b2db47525585673b88c2c3a7d7389">XStrm_TxFifoStreamer</a><li>TxStreamer <li>DeviceId
: <a class="el" href="struct_x_ll_fifo.html#45c391d0a8e6df6b45e6dd49661f27d6">XLlFifo</a><li>WriteFn : <a class="el" href="struct_x_ll_fifo___config.html#a18aac4f0cfbb75922f630c92b0d35308">XLlFifo_Config</a>
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#bbf213c206b45f0f121c0cae755b6788">XStrm_TxFifoStreamer</a></ul> </li>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <li>FifoInstance
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#ab278ceaef035943f8a3a8b85a8cab99d">XStrm_RxFifoStreamer</a>
, <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ac20fde8a3090fddfc01f8b2900fd9051">XStrm_TxFifoStreamer</a>
</li>
<li>FifoWidth
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#a474cf91d66d43f716a34299d4ab9b9b2">XStrm_TxFifoStreamer</a>
, <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a3ad4cdd1ad14dcecfaf5f923850289fb">XStrm_RxFifoStreamer</a>
</li>
<li>FrmByteCnt
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a9fa74d02f4fa2607e78b11de059be837">XStrm_RxFifoStreamer</a>
</li>
<li>GetLenFn
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a01fa1cc2098388ac9371beb090c0c212">XStrm_RxFifoStreamer</a>
</li>
<li>GetOccupancyFn
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a8d552e42f58c3230de010178832b41b1">XStrm_RxFifoStreamer</a>
</li>
<li>GetVacancyFn
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab33212eea0a6327f2c6b1173510170a9">XStrm_TxFifoStreamer</a>
</li>
<li>HeadIndex
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a6321ab6bf1a1f3979c0771618a4aba7c">XStrm_RxFifoStreamer</a>
</li>
<li>IsReady
: <a class="el" href="struct_x_ll_fifo.html#abe388bb422699248b26a9d76652474b1">XLlFifo</a>
</li>
<li>ReadFn
: <a class="el" href="struct_x_strm___rx_fifo_streamer.html#af3bfc974fd88c7b707edf680b3c9aed2">XStrm_RxFifoStreamer</a>
</li>
<li>RxStreamer
: <a class="el" href="struct_x_ll_fifo.html#a456fbf87ce23b1334c67b386722b1434">XLlFifo</a>
</li>
<li>SetLenFn
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#aa315e740022ccc81ef9cccfe7c82022d">XStrm_TxFifoStreamer</a>
</li>
<li>TailIndex
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#a265500391a387c5354a14fea79a1b446">XStrm_TxFifoStreamer</a>
</li>
<li>TxStreamer
: <a class="el" href="struct_x_ll_fifo.html#a13363fb4d5d45a5725b7427b36c44817">XLlFifo</a>
</li>
<li>WriteFn
: <a class="el" href="struct_x_strm___tx_fifo_streamer.html#abaed83d1259485a6deadbf4644b0be1b">XStrm_TxFifoStreamer</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

413
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/globals.html
View file

@ -2,78 +2,355 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver llfifo v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_x">- x -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_m"><span>m</span></a></li>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_f">- f -</a></h3><ul>
<li>FIFO_WIDTH_BYTES
: <a class="el" href="xllfifo_8c.html#a9ab678f3af0afefab24bc4f670a50bf6">xllfifo.c</a>
</li>
</ul>
<h3><a class="anchor" id="index_l">- l -</a></h3><ul>
<li>LARGEST_FIFO_KEYHOLE_SIZE_WORDS
: <a class="el" href="xstreamer_8h.html#a4a3e97b47b47ea3b883952f58cb9deb9">xstreamer.h</a>
</li>
</ul>
<h3><a class="anchor" id="index_m">- m -</a></h3><ul>
<li>min
: <a class="el" href="xstreamer_8c.html#abb702d8b501669a23aa0ab3b281b9384">xstreamer.c</a>
</li>
</ul>
<h3><a class="anchor" id="index_x">- x -</a></h3><ul>
<li>xdbg_printf
: <a class="el" href="xdebug_8h.html#ac91e7d6ead432cebc3c8890d9bcbad22">xdebug.h</a>
</li>
<li>xdbg_stmnt
: <a class="el" href="xdebug_8h.html#a12060fbd49869828f1554c4ddd071fd5">xdebug.h</a>
, <a class="el" href="xstreamer_8c.html#af522443c3d427ece2a8ce4e2231eca29">xstreamer.c</a>
, <a class="el" href="xllfifo_8c.html#aacc66a5dc69ac5a882fa7f3d161efbcb">xllfifo.c</a>
</li>
<li>XLLF_IER_OFFSET <li>XLLF_IER_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#157358fc70b32ed02eede19396c37227">xllfifo_hw.h</a><li>XLLF_INT_ALL_MASK : <a class="el" href="xllfifo__hw_8h.html#ac34e090e52a9ef5cdf4337cae6ca717c">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#d2e5148e49d444ad8796e36252c46e81">xllfifo_hw.h</a><li>XLLF_INT_ERROR_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#4a0f6d0c44a2a1573bbf51e476e00cf9">xllfifo_hw.h</a><li>XLLF_INT_RC_MASK <li>XLLF_INT_ALL_MASK
: <a class="el" href="xllfifo__hw_8h.html#de24693de66b32baef68cc915a17bcfc">xllfifo_hw.h</a><li>XLLF_INT_RFPE_MASK : <a class="el" href="xllfifo__hw_8h.html#ae3bfcad24428233d9e2a8a861e2d9eed">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#06379cac996cdf25a22bd14c37a085de">xllfifo_hw.h</a><li>XLLF_INT_RFPF_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#12a8feb60aee777fb81f2a584c15864d">xllfifo_hw.h</a><li>XLLF_INT_RPORE_MASK <li>XLLF_INT_ERROR_MASK
: <a class="el" href="xllfifo__hw_8h.html#95a78b1bffb8995c7f624f02c96c428a">xllfifo_hw.h</a><li>XLLF_INT_RPUE_MASK : <a class="el" href="xllfifo__hw_8h.html#a97d0964de7c5721e6856a9d7ccb22ebd">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#0bac7a80d8da784d9159174fa11fa278">xllfifo_hw.h</a><li>XLLF_INT_RPURE_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#bb6cc4592a675ac8ee78ffad1e16a3b9">xllfifo_hw.h</a><li>XLLF_INT_RRC_MASK <li>XLLF_INT_RC_MASK
: <a class="el" href="xllfifo__hw_8h.html#8c6ab6f058f3e52c0d43662b23ddfd54">xllfifo_hw.h</a><li>XLLF_INT_RXERROR_MASK : <a class="el" href="xllfifo__hw_8h.html#a838f0b2d56bffea01160c141b0c1de67">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#2823005e2cd6f215e717890b689e9607">xllfifo_hw.h</a><li>XLLF_INT_TC_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#b1248f82ad0acbbfe6aefc826eee8239">xllfifo_hw.h</a><li>XLLF_INT_TFPE_MASK <li>XLLF_INT_RFPE_MASK
: <a class="el" href="xllfifo__hw_8h.html#30f8f1dddee24d76333b226eda9d6922">xllfifo_hw.h</a><li>XLLF_INT_TFPF_MASK : <a class="el" href="xllfifo__hw_8h.html#abeef1be2532662b2b6aa865057e30b48">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#e0553df0226753c63505d7c9ff806b66">xllfifo_hw.h</a><li>XLLF_INT_TPOE_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#96b260ca18f29130d64f61750bc73f63">xllfifo_hw.h</a><li>XLLF_INT_TRC_MASK <li>XLLF_INT_RFPF_MASK
: <a class="el" href="xllfifo__hw_8h.html#424c103c10189f0758f68979b93b1ba3">xllfifo_hw.h</a><li>XLLF_INT_TSE_MASK : <a class="el" href="xllfifo__hw_8h.html#acb37ede3ec3b10522a8bf3c597747331">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#9ed3beb2bfaf076ecc17500261fc1fc8">xllfifo_hw.h</a><li>XLLF_INT_TXERROR_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#033fd27374cd979e7ac62d912752f6f1">xllfifo_hw.h</a><li>XLLF_ISR_OFFSET <li>XLLF_INT_RPORE_MASK
: <a class="el" href="xllfifo__hw_8h.html#b65b5fff63fe2d283135b7b48cc4a3cb">xllfifo_hw.h</a><li>XLLF_LLR_OFFSET : <a class="el" href="xllfifo__hw_8h.html#a98ccef60e66cffea379deead95c3084e">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#ca5518ce40ed58b4a0d66fd9d4591770">xllfifo_hw.h</a><li>XLLF_LLR_RESET_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#7dd9eff0c61ff88767f7cdf02382a578">xllfifo_hw.h</a><li>XLLF_RDFD_OFFSET <li>XLLF_INT_RPUE_MASK
: <a class="el" href="xllfifo__hw_8h.html#a110c69f638afab4b79bdceb51ca8e21">xllfifo_hw.h</a><li>XLLF_RDFO_OFFSET : <a class="el" href="xllfifo__hw_8h.html#a2c30251a44596328ec255b652e20f15a">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#c21c4cd243180fc4722399079f306f70">xllfifo_hw.h</a><li>XLLF_RDFR_OFFSET </li>
: <a class="el" href="xllfifo__hw_8h.html#2891dd374c94dba427ccb7348af436fe">xllfifo_hw.h</a><li>XLLF_RDFR_RESET_MASK <li>XLLF_INT_RPURE_MASK
: <a class="el" href="xllfifo__hw_8h.html#6e4540ab5197b0f4f0cb7865cf5eeefb">xllfifo_hw.h</a><li>XLLF_RDR_OFFSET : <a class="el" href="xllfifo__hw_8h.html#ab34174dc4dc0d42aa610f51bcf2cb492">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#7cfae35278ee5b4a7473d72ca607471f">xllfifo_hw.h</a><li>XLLF_RLF_OFFSET </li>
: <a class="el" href="xllfifo__hw_8h.html#3d02c0acee29c02f7549b92034775bd5">xllfifo_hw.h</a><li>XLLF_TDFD_OFFSET <li>XLLF_INT_RRC_MASK
: <a class="el" href="xllfifo__hw_8h.html#4fcbcb1153a0ae21e53db6b06d37c43a">xllfifo_hw.h</a><li>XLLF_TDFR_OFFSET : <a class="el" href="xllfifo__hw_8h.html#aaa9d308d7b3224c47b619467c2384754">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#808f00e5bddbbdea20f968733e6a42ea">xllfifo_hw.h</a><li>XLLF_TDFR_RESET_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#1708f62c9cf2c58e16474b841fa875ad">xllfifo_hw.h</a><li>XLLF_TDFV_OFFSET <li>XLLF_INT_RXERROR_MASK
: <a class="el" href="xllfifo__hw_8h.html#8719eb6c565749ba769747963a866f76">xllfifo_hw.h</a><li>XLLF_TDR_OFFSET : <a class="el" href="xllfifo__hw_8h.html#a2e6b02f445993c00ec77914e3696fd9a">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#4299b29acab7a138d6b156938130003c">xllfifo_hw.h</a><li>XLLF_TLF_OFFSET </li>
: <a class="el" href="xllfifo__hw_8h.html#df69b35e2b7b4c93f781810a5ae07234">xllfifo_hw.h</a><li>XLlFifo_CfgInitialize() <li>XLLF_INT_TC_MASK
: <a class="el" href="xllfifo_8c.html#2fe123c957f759858100542feb21be2d">xllfifo.c</a><li>XLlFifo_Initialize() : <a class="el" href="xllfifo__hw_8h.html#abca5de4c7fc02bcad56912a2919319ae">xllfifo_hw.h</a>
: <a class="el" href="xllfifo_8c.html#83642984b46fd728640f099a09eeeebd">xllfifo.c</a><li>XLlFifo_ReadReg </li>
: <a class="el" href="xllfifo__hw_8h.html#6308af367549a2674208333738d82a41">xllfifo_hw.h</a><li>XLlFifo_WriteReg <li>XLLF_INT_TFPE_MASK
: <a class="el" href="xllfifo__hw_8h.html#92a5f75ce8fd49b80d6a7b9182debbec">xllfifo_hw.h</a></ul> : <a class="el" href="xllfifo__hw_8h.html#a7e06f24d66d729c445ebb72dde652aad">xllfifo_hw.h</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
<li>XLLF_INT_TFPF_MASK
: <a class="el" href="xllfifo__hw_8h.html#a8b6dae752508cc137eb13b88561f88a5">xllfifo_hw.h</a>
</li>
<li>XLLF_INT_TPOE_MASK
: <a class="el" href="xllfifo__hw_8h.html#a44becb1eedec6a7d02293d1f088d30c7">xllfifo_hw.h</a>
</li>
<li>XLLF_INT_TRC_MASK
: <a class="el" href="xllfifo__hw_8h.html#a08cda800d1468726a65844d40100b9cb">xllfifo_hw.h</a>
</li>
<li>XLLF_INT_TSE_MASK
: <a class="el" href="xllfifo__hw_8h.html#a77c2faac5f93834b0a6f7b9da529c5ad">xllfifo_hw.h</a>
</li>
<li>XLLF_INT_TXERROR_MASK
: <a class="el" href="xllfifo__hw_8h.html#a417b7cfe9d44e8154311f8d7c5cef577">xllfifo_hw.h</a>
</li>
<li>XLLF_ISR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a90a5fafb06870a7ff8043d3a34bf54cc">xllfifo_hw.h</a>
</li>
<li>XLLF_LLR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a5331d2736e9b1b516b4262d8e3f11690">xllfifo_hw.h</a>
</li>
<li>XLLF_LLR_RESET_MASK
: <a class="el" href="xllfifo__hw_8h.html#ad8b59856939038963e68acf4e2e2c47c">xllfifo_hw.h</a>
</li>
<li>XLLF_RDFD_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a93e049a21e43548bf03161b4a4394440">xllfifo_hw.h</a>
</li>
<li>XLLF_RDFO_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a9c4bbf51bc4b0410b61ef3933776a63c">xllfifo_hw.h</a>
</li>
<li>XLLF_RDFR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#ae1533e466df30729597a1b44ed1059ed">xllfifo_hw.h</a>
</li>
<li>XLLF_RDFR_RESET_MASK
: <a class="el" href="xllfifo__hw_8h.html#a11c4da53ae9b166832186f9a817fba6d">xllfifo_hw.h</a>
</li>
<li>XLLF_RDR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#af0240fc89cce2e27e1943d2e23a5af25">xllfifo_hw.h</a>
</li>
<li>XLLF_RLF_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a267285e6015808291ef6671038cba888">xllfifo_hw.h</a>
</li>
<li>XLLF_TDFD_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#aeca8c86badc0df67426442f9bb6a5195">xllfifo_hw.h</a>
</li>
<li>XLLF_TDFR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#aa55be9e9452783cde92cd70a33e31e56">xllfifo_hw.h</a>
</li>
<li>XLLF_TDFR_RESET_MASK
: <a class="el" href="xllfifo__hw_8h.html#af7b4bcf41280c1fb01684b6706603420">xllfifo_hw.h</a>
</li>
<li>XLLF_TDFV_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#ab77ae26c2fe9b0ac15ebdbf0c6c30960">xllfifo_hw.h</a>
</li>
<li>XLLF_TDR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a5c691ac1237fb77b8e356a7d2b0b8b54">xllfifo_hw.h</a>
</li>
<li>XLLF_TLF_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#ac14e6d7e1116f9a43c0adfbe93422fa7">xllfifo_hw.h</a>
</li>
<li>XLlFfio_LookupConfig()
: <a class="el" href="xllfifo_8h.html#adeafd207ee98a329f48eea9769b0994d">xllfifo.h</a>
, <a class="el" href="xllfifo__sinit_8c.html#adeafd207ee98a329f48eea9769b0994d">xllfifo_sinit.c</a>
</li>
<li>XLlFifo_CfgInitialize()
: <a class="el" href="xllfifo_8c.html#adc1db2785627a0d8da46dc60990889a0">xllfifo.c</a>
, <a class="el" href="xllfifo_8h.html#adc1db2785627a0d8da46dc60990889a0">xllfifo.h</a>
</li>
<li>XLlFifo_ConfigTable
: <a class="el" href="xllfifo__g_8c.html#a8d8699cda15349615b0a3073547ff70b">xllfifo_g.c</a>
</li>
<li>XLLFIFO_H
: <a class="el" href="xllfifo_8h.html#ae7e2d915a0bab3a686ef155a6523690c">xllfifo.h</a>
</li>
<li>XLLFIFO_HW_H
: <a class="el" href="xllfifo__hw_8h.html#a21ece87fb4445617bfa12ac6396cff9d">xllfifo_hw.h</a>
</li>
<li>XLlFifo_Initialize()
: <a class="el" href="xllfifo_8c.html#a1fdf07ca198f5cfe2dc14ced21e5631d">xllfifo.c</a>
, <a class="el" href="xllfifo_8h.html#a1fdf07ca198f5cfe2dc14ced21e5631d">xllfifo.h</a>
</li>
<li>XLlFifo_IntClear
: <a class="el" href="xllfifo_8h.html#ac712eea89e9d7fa37d095003c927c61e">xllfifo.h</a>
</li>
<li>XLlFifo_IntDisable
: <a class="el" href="xllfifo_8h.html#abff8f5ef31f09865808da90055e29d42">xllfifo.h</a>
</li>
<li>XLlFifo_IntEnable
: <a class="el" href="xllfifo_8h.html#ae65ece5c6c9cce1ccdcf9d404fd8f463">xllfifo.h</a>
</li>
<li>XLlFifo_IntPending
: <a class="el" href="xllfifo_8h.html#ac356d3e8d55aa6e82753400f0bd026a1">xllfifo.h</a>
</li>
<li>XLlFifo_iRead_Aligned()
: <a class="el" href="xllfifo_8c.html#a18bc620d388cbca83d63cc1c6ef33225">xllfifo.c</a>
</li>
<li>XLlFifo_iRxGetLen()
: <a class="el" href="xllfifo_8c.html#aad292ddf2a2c9dde261b93da802c8080">xllfifo.c</a>
, <a class="el" href="xllfifo_8h.html#aad292ddf2a2c9dde261b93da802c8080">xllfifo.h</a>
</li>
<li>XLlFifo_iRxOccupancy()
: <a class="el" href="xllfifo_8h.html#ae2da9fa947a6e50edd41375ddc4c9964">xllfifo.h</a>
</li>
<li>XLlFifo_IsRxDone
: <a class="el" href="xllfifo_8h.html#a556524c17aee71ae8407540a5e2cd65f">xllfifo.h</a>
</li>
<li>XLlFifo_IsRxEmpty
: <a class="el" href="xllfifo_8h.html#aba876eb888126638848fb2f89a9b4436">xllfifo.h</a>
</li>
<li>XLlFifo_IsTxDone
: <a class="el" href="xllfifo_8h.html#a869bc4c1072da021e747a0a179bfe2da">xllfifo.h</a>
</li>
<li>XLlFifo_iTxSetLen()
: <a class="el" href="xllfifo_8h.html#aa49ecc1529434fd932d8a65d63a1a04d">xllfifo.h</a>
, <a class="el" href="xllfifo_8c.html#aa49ecc1529434fd932d8a65d63a1a04d">xllfifo.c</a>
</li>
<li>XLlFifo_iTxVacancy()
: <a class="el" href="xllfifo_8c.html#ac02405b23499d780e7bc1dfe371281a6">xllfifo.c</a>
, <a class="el" href="xllfifo_8h.html#ac02405b23499d780e7bc1dfe371281a6">xllfifo.h</a>
</li>
<li>XLlFifo_iWrite_Aligned()
: <a class="el" href="xllfifo_8c.html#a9be5556d593980195e43a31ffb37e0fe">xllfifo.c</a>
</li>
<li>XLlFifo_print_reg_i
: <a class="el" href="xllfifo__hw_8h.html#a01a5e222565f9ccbd6d4d560ffac13b3">xllfifo_hw.h</a>
</li>
<li>XLlFifo_print_reg_o
: <a class="el" href="xllfifo__hw_8h.html#accd84dea11dd4d1e8b267efed7c17a0c">xllfifo_hw.h</a>
</li>
<li>XLlFifo_Read
: <a class="el" href="xllfifo_8h.html#aadc3685592b060c0d864850e86be5c03">xllfifo.h</a>
</li>
<li>XLlFifo_ReadRdr
: <a class="el" href="xllfifo_8h.html#a59307ef23e5b4b71d0d01cef8e06e247">xllfifo.h</a>
</li>
<li>XLlFifo_ReadReg
: <a class="el" href="xllfifo__hw_8h.html#a7526eab563fa4e0fe8b60474e96afe55">xllfifo_hw.h</a>
</li>
<li>XLlFifo_reg_name
: <a class="el" href="xllfifo__hw_8h.html#af61ed2e41013c8f487f5337e3731014c">xllfifo_hw.h</a>
</li>
<li>XLlFifo_Reset
: <a class="el" href="xllfifo_8h.html#ace8f47c03f1818797c152cb27296df7c">xllfifo.h</a>
</li>
<li>XLlFifo_RxGetLen
: <a class="el" href="xllfifo_8h.html#a53af32ae6901462cc8d6fb9adc04655e">xllfifo.h</a>
</li>
<li>XLlFifo_RxGetWord()
: <a class="el" href="xllfifo_8c.html#aed3ae31c8c24f46139fbd709027329ec">xllfifo.c</a>
, <a class="el" href="xllfifo_8h.html#aed3ae31c8c24f46139fbd709027329ec">xllfifo.h</a>
</li>
<li>XLlFifo_RxOccupancy
: <a class="el" href="xllfifo_8h.html#a12da547aa1c9a85e2b0b151f438ff9d5">xllfifo.h</a>
</li>
<li>XLlFifo_RxReset
: <a class="el" href="xllfifo_8h.html#af3739a78b92f17cead0d831757b3a134">xllfifo.h</a>
</li>
<li>XLlFifo_Status
: <a class="el" href="xllfifo_8h.html#a095f3e0f8571dc02959852e38237f23e">xllfifo.h</a>
</li>
<li>XLlFifo_TxPutWord()
: <a class="el" href="xllfifo_8c.html#a29654d755dce84b861022179c99ca7a3">xllfifo.c</a>
, <a class="el" href="xllfifo_8h.html#a29654d755dce84b861022179c99ca7a3">xllfifo.h</a>
</li>
<li>XLlFifo_TxReset
: <a class="el" href="xllfifo_8h.html#a922419fdcd342fa709fb07ec1a9e5577">xllfifo.h</a>
</li>
<li>XLlFifo_TxSetLen
: <a class="el" href="xllfifo_8h.html#acd09ed5189e0b85994901102655964f7">xllfifo.h</a>
</li>
<li>XLlFifo_TxVacancy
: <a class="el" href="xllfifo_8h.html#af2884c49ae41dc5c5317c2ef6df45a28">xllfifo.h</a>
</li>
<li>XLlFifo_Write
: <a class="el" href="xllfifo_8h.html#a1fa93f486abaaf35c7d599a8cd91b295">xllfifo.h</a>
</li>
<li>XLlFifo_WriteReg
: <a class="el" href="xllfifo__hw_8h.html#acd283ce73981f7f9eab94f8bb421bc78">xllfifo_hw.h</a>
</li>
<li>XLlFifo_WriteTdr
: <a class="el" href="xllfifo_8h.html#a105828f79f13c07d571db218c5837fae">xllfifo.h</a>
</li>
<li>XSTREAMER_H
: <a class="el" href="xstreamer_8h.html#ab615f7de0f7b5b69b912da2f24c0f4b9">xstreamer.h</a>
</li>
<li>XStrm_GetLenFnType
: <a class="el" href="xstreamer_8h.html#a967adc3a060d1799795857d4e1ab0397">xstreamer.h</a>
</li>
<li>XStrm_GetOccupancyFnType
: <a class="el" href="xstreamer_8h.html#a63293ed02cfb43a6207cd1eb888a8a21">xstreamer.h</a>
</li>
<li>XStrm_GetVacancyFnType
: <a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">xstreamer.h</a>
</li>
<li>XStrm_IsRxInternalEmpty
: <a class="el" href="xstreamer_8h.html#a2357fcad0c03d6b706d5ad71c4d7b749">xstreamer.h</a>
</li>
<li>XStrm_Read()
: <a class="el" href="xstreamer_8c.html#a915d68a9cce0f2464fc7644383cb887a">xstreamer.c</a>
, <a class="el" href="xstreamer_8h.html#a214198a61d21fbbb252338c775ec4d34">xstreamer.h</a>
</li>
<li>XStrm_RxGetLen()
: <a class="el" href="xstreamer_8c.html#a479d2eb3193ad0a5efc3c3b432a78381">xstreamer.c</a>
, <a class="el" href="xstreamer_8h.html#a479d2eb3193ad0a5efc3c3b432a78381">xstreamer.h</a>
</li>
<li>XStrm_RxInitialize()
: <a class="el" href="xstreamer_8h.html#a52ec29cc3b758b6a2b857d883ac69d4a">xstreamer.h</a>
</li>
<li>XStrm_RxOccupancy
: <a class="el" href="xstreamer_8h.html#a52d6c5d159859cfcf8e43daf7d54ad07">xstreamer.h</a>
</li>
<li>XStrm_SetLenFnType
: <a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">xstreamer.h</a>
</li>
<li>XStrm_TxInitialize()
: <a class="el" href="xstreamer_8c.html#a8a67c77f811a505b658e06642eb9c964">xstreamer.c</a>
, <a class="el" href="xstreamer_8h.html#a8a67c77f811a505b658e06642eb9c964">xstreamer.h</a>
</li>
<li>XStrm_TxSetLen()
: <a class="el" href="xstreamer_8h.html#a1e99fb51e0cfab7d0e8de5e93c27fd9c">xstreamer.h</a>
, <a class="el" href="xstreamer_8c.html#a1e99fb51e0cfab7d0e8de5e93c27fd9c">xstreamer.c</a>
</li>
<li>XStrm_TxVacancy
: <a class="el" href="xstreamer_8h.html#a7c2fa1c0b560f90b656aaac27721769c">xstreamer.h</a>
</li>
<li>XStrm_Write()
: <a class="el" href="xstreamer_8h.html#abcdec1e8914d00b5f4c0e77425d15cbf">xstreamer.h</a>
, <a class="el" href="xstreamer_8c.html#a1f43ea833af99162745ceef66849b666">xstreamer.c</a>
</li>
<li>XStrm_XferFnType
: <a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">xstreamer.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

325
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/globals_defs.html
View file

@ -2,76 +2,271 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver llfifo v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li id="current"><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- 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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li class="current"><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_m"><span>m</span></a></li>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp; &nbsp;
<p>
<h3><a class="anchor" name="index_x">- x -</a></h3><ul> <h3><a class="anchor" id="index_f">- f -</a></h3><ul>
<li>FIFO_WIDTH_BYTES
: <a class="el" href="xllfifo_8c.html#a9ab678f3af0afefab24bc4f670a50bf6">xllfifo.c</a>
</li>
</ul>
<h3><a class="anchor" id="index_l">- l -</a></h3><ul>
<li>LARGEST_FIFO_KEYHOLE_SIZE_WORDS
: <a class="el" href="xstreamer_8h.html#a4a3e97b47b47ea3b883952f58cb9deb9">xstreamer.h</a>
</li>
</ul>
<h3><a class="anchor" id="index_m">- m -</a></h3><ul>
<li>min
: <a class="el" href="xstreamer_8c.html#abb702d8b501669a23aa0ab3b281b9384">xstreamer.c</a>
</li>
</ul>
<h3><a class="anchor" id="index_x">- x -</a></h3><ul>
<li>xdbg_printf
: <a class="el" href="xdebug_8h.html#ac91e7d6ead432cebc3c8890d9bcbad22">xdebug.h</a>
</li>
<li>xdbg_stmnt
: <a class="el" href="xdebug_8h.html#a12060fbd49869828f1554c4ddd071fd5">xdebug.h</a>
</li>
<li>XLLF_IER_OFFSET <li>XLLF_IER_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#157358fc70b32ed02eede19396c37227">xllfifo_hw.h</a><li>XLLF_INT_ALL_MASK : <a class="el" href="xllfifo__hw_8h.html#ac34e090e52a9ef5cdf4337cae6ca717c">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#d2e5148e49d444ad8796e36252c46e81">xllfifo_hw.h</a><li>XLLF_INT_ERROR_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#4a0f6d0c44a2a1573bbf51e476e00cf9">xllfifo_hw.h</a><li>XLLF_INT_RC_MASK <li>XLLF_INT_ALL_MASK
: <a class="el" href="xllfifo__hw_8h.html#de24693de66b32baef68cc915a17bcfc">xllfifo_hw.h</a><li>XLLF_INT_RFPE_MASK : <a class="el" href="xllfifo__hw_8h.html#ae3bfcad24428233d9e2a8a861e2d9eed">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#06379cac996cdf25a22bd14c37a085de">xllfifo_hw.h</a><li>XLLF_INT_RFPF_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#12a8feb60aee777fb81f2a584c15864d">xllfifo_hw.h</a><li>XLLF_INT_RPORE_MASK <li>XLLF_INT_ERROR_MASK
: <a class="el" href="xllfifo__hw_8h.html#95a78b1bffb8995c7f624f02c96c428a">xllfifo_hw.h</a><li>XLLF_INT_RPUE_MASK : <a class="el" href="xllfifo__hw_8h.html#a97d0964de7c5721e6856a9d7ccb22ebd">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#0bac7a80d8da784d9159174fa11fa278">xllfifo_hw.h</a><li>XLLF_INT_RPURE_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#bb6cc4592a675ac8ee78ffad1e16a3b9">xllfifo_hw.h</a><li>XLLF_INT_RRC_MASK <li>XLLF_INT_RC_MASK
: <a class="el" href="xllfifo__hw_8h.html#8c6ab6f058f3e52c0d43662b23ddfd54">xllfifo_hw.h</a><li>XLLF_INT_RXERROR_MASK : <a class="el" href="xllfifo__hw_8h.html#a838f0b2d56bffea01160c141b0c1de67">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#2823005e2cd6f215e717890b689e9607">xllfifo_hw.h</a><li>XLLF_INT_TC_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#b1248f82ad0acbbfe6aefc826eee8239">xllfifo_hw.h</a><li>XLLF_INT_TFPE_MASK <li>XLLF_INT_RFPE_MASK
: <a class="el" href="xllfifo__hw_8h.html#30f8f1dddee24d76333b226eda9d6922">xllfifo_hw.h</a><li>XLLF_INT_TFPF_MASK : <a class="el" href="xllfifo__hw_8h.html#abeef1be2532662b2b6aa865057e30b48">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#e0553df0226753c63505d7c9ff806b66">xllfifo_hw.h</a><li>XLLF_INT_TPOE_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#96b260ca18f29130d64f61750bc73f63">xllfifo_hw.h</a><li>XLLF_INT_TRC_MASK <li>XLLF_INT_RFPF_MASK
: <a class="el" href="xllfifo__hw_8h.html#424c103c10189f0758f68979b93b1ba3">xllfifo_hw.h</a><li>XLLF_INT_TSE_MASK : <a class="el" href="xllfifo__hw_8h.html#acb37ede3ec3b10522a8bf3c597747331">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#9ed3beb2bfaf076ecc17500261fc1fc8">xllfifo_hw.h</a><li>XLLF_INT_TXERROR_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#033fd27374cd979e7ac62d912752f6f1">xllfifo_hw.h</a><li>XLLF_ISR_OFFSET <li>XLLF_INT_RPORE_MASK
: <a class="el" href="xllfifo__hw_8h.html#b65b5fff63fe2d283135b7b48cc4a3cb">xllfifo_hw.h</a><li>XLLF_LLR_OFFSET : <a class="el" href="xllfifo__hw_8h.html#a98ccef60e66cffea379deead95c3084e">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#ca5518ce40ed58b4a0d66fd9d4591770">xllfifo_hw.h</a><li>XLLF_LLR_RESET_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#7dd9eff0c61ff88767f7cdf02382a578">xllfifo_hw.h</a><li>XLLF_RDFD_OFFSET <li>XLLF_INT_RPUE_MASK
: <a class="el" href="xllfifo__hw_8h.html#a110c69f638afab4b79bdceb51ca8e21">xllfifo_hw.h</a><li>XLLF_RDFO_OFFSET : <a class="el" href="xllfifo__hw_8h.html#a2c30251a44596328ec255b652e20f15a">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#c21c4cd243180fc4722399079f306f70">xllfifo_hw.h</a><li>XLLF_RDFR_OFFSET </li>
: <a class="el" href="xllfifo__hw_8h.html#2891dd374c94dba427ccb7348af436fe">xllfifo_hw.h</a><li>XLLF_RDFR_RESET_MASK <li>XLLF_INT_RPURE_MASK
: <a class="el" href="xllfifo__hw_8h.html#6e4540ab5197b0f4f0cb7865cf5eeefb">xllfifo_hw.h</a><li>XLLF_RDR_OFFSET : <a class="el" href="xllfifo__hw_8h.html#ab34174dc4dc0d42aa610f51bcf2cb492">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#7cfae35278ee5b4a7473d72ca607471f">xllfifo_hw.h</a><li>XLLF_RLF_OFFSET </li>
: <a class="el" href="xllfifo__hw_8h.html#3d02c0acee29c02f7549b92034775bd5">xllfifo_hw.h</a><li>XLLF_TDFD_OFFSET <li>XLLF_INT_RRC_MASK
: <a class="el" href="xllfifo__hw_8h.html#4fcbcb1153a0ae21e53db6b06d37c43a">xllfifo_hw.h</a><li>XLLF_TDFR_OFFSET : <a class="el" href="xllfifo__hw_8h.html#aaa9d308d7b3224c47b619467c2384754">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#808f00e5bddbbdea20f968733e6a42ea">xllfifo_hw.h</a><li>XLLF_TDFR_RESET_MASK </li>
: <a class="el" href="xllfifo__hw_8h.html#1708f62c9cf2c58e16474b841fa875ad">xllfifo_hw.h</a><li>XLLF_TDFV_OFFSET <li>XLLF_INT_RXERROR_MASK
: <a class="el" href="xllfifo__hw_8h.html#8719eb6c565749ba769747963a866f76">xllfifo_hw.h</a><li>XLLF_TDR_OFFSET : <a class="el" href="xllfifo__hw_8h.html#a2e6b02f445993c00ec77914e3696fd9a">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#4299b29acab7a138d6b156938130003c">xllfifo_hw.h</a><li>XLLF_TLF_OFFSET </li>
: <a class="el" href="xllfifo__hw_8h.html#df69b35e2b7b4c93f781810a5ae07234">xllfifo_hw.h</a><li>XLlFifo_ReadReg <li>XLLF_INT_TC_MASK
: <a class="el" href="xllfifo__hw_8h.html#6308af367549a2674208333738d82a41">xllfifo_hw.h</a><li>XLlFifo_WriteReg : <a class="el" href="xllfifo__hw_8h.html#abca5de4c7fc02bcad56912a2919319ae">xllfifo_hw.h</a>
: <a class="el" href="xllfifo__hw_8h.html#92a5f75ce8fd49b80d6a7b9182debbec">xllfifo_hw.h</a></ul> </li>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <li>XLLF_INT_TFPE_MASK
: <a class="el" href="xllfifo__hw_8h.html#a7e06f24d66d729c445ebb72dde652aad">xllfifo_hw.h</a>
</li>
<li>XLLF_INT_TFPF_MASK
: <a class="el" href="xllfifo__hw_8h.html#a8b6dae752508cc137eb13b88561f88a5">xllfifo_hw.h</a>
</li>
<li>XLLF_INT_TPOE_MASK
: <a class="el" href="xllfifo__hw_8h.html#a44becb1eedec6a7d02293d1f088d30c7">xllfifo_hw.h</a>
</li>
<li>XLLF_INT_TRC_MASK
: <a class="el" href="xllfifo__hw_8h.html#a08cda800d1468726a65844d40100b9cb">xllfifo_hw.h</a>
</li>
<li>XLLF_INT_TSE_MASK
: <a class="el" href="xllfifo__hw_8h.html#a77c2faac5f93834b0a6f7b9da529c5ad">xllfifo_hw.h</a>
</li>
<li>XLLF_INT_TXERROR_MASK
: <a class="el" href="xllfifo__hw_8h.html#a417b7cfe9d44e8154311f8d7c5cef577">xllfifo_hw.h</a>
</li>
<li>XLLF_ISR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a90a5fafb06870a7ff8043d3a34bf54cc">xllfifo_hw.h</a>
</li>
<li>XLLF_LLR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a5331d2736e9b1b516b4262d8e3f11690">xllfifo_hw.h</a>
</li>
<li>XLLF_LLR_RESET_MASK
: <a class="el" href="xllfifo__hw_8h.html#ad8b59856939038963e68acf4e2e2c47c">xllfifo_hw.h</a>
</li>
<li>XLLF_RDFD_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a93e049a21e43548bf03161b4a4394440">xllfifo_hw.h</a>
</li>
<li>XLLF_RDFO_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a9c4bbf51bc4b0410b61ef3933776a63c">xllfifo_hw.h</a>
</li>
<li>XLLF_RDFR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#ae1533e466df30729597a1b44ed1059ed">xllfifo_hw.h</a>
</li>
<li>XLLF_RDFR_RESET_MASK
: <a class="el" href="xllfifo__hw_8h.html#a11c4da53ae9b166832186f9a817fba6d">xllfifo_hw.h</a>
</li>
<li>XLLF_RDR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#af0240fc89cce2e27e1943d2e23a5af25">xllfifo_hw.h</a>
</li>
<li>XLLF_RLF_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a267285e6015808291ef6671038cba888">xllfifo_hw.h</a>
</li>
<li>XLLF_TDFD_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#aeca8c86badc0df67426442f9bb6a5195">xllfifo_hw.h</a>
</li>
<li>XLLF_TDFR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#aa55be9e9452783cde92cd70a33e31e56">xllfifo_hw.h</a>
</li>
<li>XLLF_TDFR_RESET_MASK
: <a class="el" href="xllfifo__hw_8h.html#af7b4bcf41280c1fb01684b6706603420">xllfifo_hw.h</a>
</li>
<li>XLLF_TDFV_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#ab77ae26c2fe9b0ac15ebdbf0c6c30960">xllfifo_hw.h</a>
</li>
<li>XLLF_TDR_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#a5c691ac1237fb77b8e356a7d2b0b8b54">xllfifo_hw.h</a>
</li>
<li>XLLF_TLF_OFFSET
: <a class="el" href="xllfifo__hw_8h.html#ac14e6d7e1116f9a43c0adfbe93422fa7">xllfifo_hw.h</a>
</li>
<li>XLLFIFO_H
: <a class="el" href="xllfifo_8h.html#ae7e2d915a0bab3a686ef155a6523690c">xllfifo.h</a>
</li>
<li>XLLFIFO_HW_H
: <a class="el" href="xllfifo__hw_8h.html#a21ece87fb4445617bfa12ac6396cff9d">xllfifo_hw.h</a>
</li>
<li>XLlFifo_IntClear
: <a class="el" href="xllfifo_8h.html#ac712eea89e9d7fa37d095003c927c61e">xllfifo.h</a>
</li>
<li>XLlFifo_IntDisable
: <a class="el" href="xllfifo_8h.html#abff8f5ef31f09865808da90055e29d42">xllfifo.h</a>
</li>
<li>XLlFifo_IntEnable
: <a class="el" href="xllfifo_8h.html#ae65ece5c6c9cce1ccdcf9d404fd8f463">xllfifo.h</a>
</li>
<li>XLlFifo_IntPending
: <a class="el" href="xllfifo_8h.html#ac356d3e8d55aa6e82753400f0bd026a1">xllfifo.h</a>
</li>
<li>XLlFifo_IsRxDone
: <a class="el" href="xllfifo_8h.html#a556524c17aee71ae8407540a5e2cd65f">xllfifo.h</a>
</li>
<li>XLlFifo_IsRxEmpty
: <a class="el" href="xllfifo_8h.html#aba876eb888126638848fb2f89a9b4436">xllfifo.h</a>
</li>
<li>XLlFifo_IsTxDone
: <a class="el" href="xllfifo_8h.html#a869bc4c1072da021e747a0a179bfe2da">xllfifo.h</a>
</li>
<li>XLlFifo_print_reg_i
: <a class="el" href="xllfifo__hw_8h.html#a01a5e222565f9ccbd6d4d560ffac13b3">xllfifo_hw.h</a>
</li>
<li>XLlFifo_print_reg_o
: <a class="el" href="xllfifo__hw_8h.html#accd84dea11dd4d1e8b267efed7c17a0c">xllfifo_hw.h</a>
</li>
<li>XLlFifo_Read
: <a class="el" href="xllfifo_8h.html#aadc3685592b060c0d864850e86be5c03">xllfifo.h</a>
</li>
<li>XLlFifo_ReadRdr
: <a class="el" href="xllfifo_8h.html#a59307ef23e5b4b71d0d01cef8e06e247">xllfifo.h</a>
</li>
<li>XLlFifo_ReadReg
: <a class="el" href="xllfifo__hw_8h.html#a7526eab563fa4e0fe8b60474e96afe55">xllfifo_hw.h</a>
</li>
<li>XLlFifo_reg_name
: <a class="el" href="xllfifo__hw_8h.html#af61ed2e41013c8f487f5337e3731014c">xllfifo_hw.h</a>
</li>
<li>XLlFifo_Reset
: <a class="el" href="xllfifo_8h.html#ace8f47c03f1818797c152cb27296df7c">xllfifo.h</a>
</li>
<li>XLlFifo_RxGetLen
: <a class="el" href="xllfifo_8h.html#a53af32ae6901462cc8d6fb9adc04655e">xllfifo.h</a>
</li>
<li>XLlFifo_RxOccupancy
: <a class="el" href="xllfifo_8h.html#a12da547aa1c9a85e2b0b151f438ff9d5">xllfifo.h</a>
</li>
<li>XLlFifo_RxReset
: <a class="el" href="xllfifo_8h.html#af3739a78b92f17cead0d831757b3a134">xllfifo.h</a>
</li>
<li>XLlFifo_Status
: <a class="el" href="xllfifo_8h.html#a095f3e0f8571dc02959852e38237f23e">xllfifo.h</a>
</li>
<li>XLlFifo_TxReset
: <a class="el" href="xllfifo_8h.html#a922419fdcd342fa709fb07ec1a9e5577">xllfifo.h</a>
</li>
<li>XLlFifo_TxSetLen
: <a class="el" href="xllfifo_8h.html#acd09ed5189e0b85994901102655964f7">xllfifo.h</a>
</li>
<li>XLlFifo_TxVacancy
: <a class="el" href="xllfifo_8h.html#af2884c49ae41dc5c5317c2ef6df45a28">xllfifo.h</a>
</li>
<li>XLlFifo_Write
: <a class="el" href="xllfifo_8h.html#a1fa93f486abaaf35c7d599a8cd91b295">xllfifo.h</a>
</li>
<li>XLlFifo_WriteReg
: <a class="el" href="xllfifo__hw_8h.html#acd283ce73981f7f9eab94f8bb421bc78">xllfifo_hw.h</a>
</li>
<li>XLlFifo_WriteTdr
: <a class="el" href="xllfifo_8h.html#a105828f79f13c07d571db218c5837fae">xllfifo.h</a>
</li>
<li>XSTREAMER_H
: <a class="el" href="xstreamer_8h.html#ab615f7de0f7b5b69b912da2f24c0f4b9">xstreamer.h</a>
</li>
<li>XStrm_IsRxInternalEmpty
: <a class="el" href="xstreamer_8h.html#a2357fcad0c03d6b706d5ad71c4d7b749">xstreamer.h</a>
</li>
<li>XStrm_RxOccupancy
: <a class="el" href="xstreamer_8h.html#a52d6c5d159859cfcf8e43daf7d54ad07">xstreamer.h</a>
</li>
<li>XStrm_TxVacancy
: <a class="el" href="xstreamer_8h.html#a7c2fa1c0b560f90b656aaac27721769c">xstreamer.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

134
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/globals_func.html
View file

@ -2,36 +2,120 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver llfifo v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li><a href="globals.html"><span>All</span></a></li> </ul>
<li id="current"><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li><a href="globals_defs.html"><span>Defines</span></a></li> <div class="tabs">
</ul> <ul>
<li><a href="globals.html"><span>All</span></a></li>
<li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
</div> </div>
<div class="contents">
&nbsp; &nbsp;
<p>
<ul> <h3><a class="anchor" id="index_x">- x -</a></h3><ul>
<li>xdbg_stmnt()
: <a class="el" href="xllfifo_8c.html#aacc66a5dc69ac5a882fa7f3d161efbcb">xllfifo.c</a>
, <a class="el" href="xstreamer_8c.html#af522443c3d427ece2a8ce4e2231eca29">xstreamer.c</a>
</li>
<li>XLlFfio_LookupConfig()
: <a class="el" href="xllfifo__sinit_8c.html#adeafd207ee98a329f48eea9769b0994d">xllfifo_sinit.c</a>
, <a class="el" href="xllfifo_8h.html#adeafd207ee98a329f48eea9769b0994d">xllfifo.h</a>
</li>
<li>XLlFifo_CfgInitialize() <li>XLlFifo_CfgInitialize()
: <a class="el" href="xllfifo_8c.html#2fe123c957f759858100542feb21be2d">xllfifo.c</a><li>XLlFifo_Initialize() : <a class="el" href="xllfifo_8c.html#adc1db2785627a0d8da46dc60990889a0">xllfifo.c</a>
: <a class="el" href="xllfifo_8c.html#83642984b46fd728640f099a09eeeebd">xllfifo.c</a></ul> , <a class="el" href="xllfifo_8h.html#adc1db2785627a0d8da46dc60990889a0">xllfifo.h</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
<li>XLlFifo_Initialize()
: <a class="el" href="xllfifo_8h.html#a1fdf07ca198f5cfe2dc14ced21e5631d">xllfifo.h</a>
, <a class="el" href="xllfifo_8c.html#a1fdf07ca198f5cfe2dc14ced21e5631d">xllfifo.c</a>
</li>
<li>XLlFifo_iRead_Aligned()
: <a class="el" href="xllfifo_8c.html#a18bc620d388cbca83d63cc1c6ef33225">xllfifo.c</a>
</li>
<li>XLlFifo_iRxGetLen()
: <a class="el" href="xllfifo_8c.html#aad292ddf2a2c9dde261b93da802c8080">xllfifo.c</a>
, <a class="el" href="xllfifo_8h.html#aad292ddf2a2c9dde261b93da802c8080">xllfifo.h</a>
</li>
<li>XLlFifo_iRxOccupancy()
: <a class="el" href="xllfifo_8h.html#ae2da9fa947a6e50edd41375ddc4c9964">xllfifo.h</a>
</li>
<li>XLlFifo_iTxSetLen()
: <a class="el" href="xllfifo_8c.html#aa49ecc1529434fd932d8a65d63a1a04d">xllfifo.c</a>
, <a class="el" href="xllfifo_8h.html#aa49ecc1529434fd932d8a65d63a1a04d">xllfifo.h</a>
</li>
<li>XLlFifo_iTxVacancy()
: <a class="el" href="xllfifo_8h.html#ac02405b23499d780e7bc1dfe371281a6">xllfifo.h</a>
, <a class="el" href="xllfifo_8c.html#ac02405b23499d780e7bc1dfe371281a6">xllfifo.c</a>
</li>
<li>XLlFifo_iWrite_Aligned()
: <a class="el" href="xllfifo_8c.html#a9be5556d593980195e43a31ffb37e0fe">xllfifo.c</a>
</li>
<li>XLlFifo_RxGetWord()
: <a class="el" href="xllfifo_8h.html#aed3ae31c8c24f46139fbd709027329ec">xllfifo.h</a>
, <a class="el" href="xllfifo_8c.html#aed3ae31c8c24f46139fbd709027329ec">xllfifo.c</a>
</li>
<li>XLlFifo_TxPutWord()
: <a class="el" href="xllfifo_8c.html#a29654d755dce84b861022179c99ca7a3">xllfifo.c</a>
, <a class="el" href="xllfifo_8h.html#a29654d755dce84b861022179c99ca7a3">xllfifo.h</a>
</li>
<li>XStrm_Read()
: <a class="el" href="xstreamer_8h.html#a214198a61d21fbbb252338c775ec4d34">xstreamer.h</a>
, <a class="el" href="xstreamer_8c.html#a915d68a9cce0f2464fc7644383cb887a">xstreamer.c</a>
</li>
<li>XStrm_RxGetLen()
: <a class="el" href="xstreamer_8h.html#a479d2eb3193ad0a5efc3c3b432a78381">xstreamer.h</a>
, <a class="el" href="xstreamer_8c.html#a479d2eb3193ad0a5efc3c3b432a78381">xstreamer.c</a>
</li>
<li>XStrm_RxInitialize()
: <a class="el" href="xstreamer_8h.html#a52ec29cc3b758b6a2b857d883ac69d4a">xstreamer.h</a>
</li>
<li>XStrm_TxInitialize()
: <a class="el" href="xstreamer_8c.html#a8a67c77f811a505b658e06642eb9c964">xstreamer.c</a>
, <a class="el" href="xstreamer_8h.html#a8a67c77f811a505b658e06642eb9c964">xstreamer.h</a>
</li>
<li>XStrm_TxSetLen()
: <a class="el" href="xstreamer_8c.html#a1e99fb51e0cfab7d0e8de5e93c27fd9c">xstreamer.c</a>
, <a class="el" href="xstreamer_8h.html#a1e99fb51e0cfab7d0e8de5e93c27fd9c">xstreamer.h</a>
</li>
<li>XStrm_Write()
: <a class="el" href="xstreamer_8h.html#abcdec1e8914d00b5f4c0e77425d15cbf">xstreamer.h</a>
, <a class="el" href="xstreamer_8c.html#a1f43ea833af99162745ceef66849b666">xstreamer.c</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

61
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/globals_type.html Executable file
View file

@ -0,0 +1,61 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: Class Members
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li class="current"><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp;<ul>
<li>XStrm_GetLenFnType
: <a class="el" href="xstreamer_8h.html#a967adc3a060d1799795857d4e1ab0397">xstreamer.h</a>
</li>
<li>XStrm_GetOccupancyFnType
: <a class="el" href="xstreamer_8h.html#a63293ed02cfb43a6207cd1eb888a8a21">xstreamer.h</a>
</li>
<li>XStrm_GetVacancyFnType
: <a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">xstreamer.h</a>
</li>
<li>XStrm_SetLenFnType
: <a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">xstreamer.h</a>
</li>
<li>XStrm_XferFnType
: <a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">xstreamer.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

49
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/globals_vars.html Executable file
View file

@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: Class Members
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li class="current"><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp;<ul>
<li>XLlFifo_ConfigTable
: <a class="el" href="xllfifo__g_8c.html#a8d8699cda15349615b0a3073547ff70b">xllfifo_g.c</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

114
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/index.html
View file

@ -2,83 +2,84 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
llfifo v4_0 Xilinx Driver llfifo v4_0: llfifo v4_0
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li id="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li class="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<h1>llfifo v4_0</h1> <li><a href="files.html"><span>Files</span></a></li>
<p> </ul>
The Xilinx Dual Channel Fifo driver component. This driver supports the Virtex-5(TM) and Virtex-4(TM) XPS_ll_Fifo and the AxiFifo.<p> </div>
For a full description of the bridge features, please see the HW spec. This driver supports the following features:<ul> </div>
<li>Memory mapped access to host interface registers</li><li>API for polled frame transfers</li><li>API for interrupt driven frame transfers</li><li>Virtual memory support</li><li>Full duplex operation</li></ul> <div class="contents">
<p> <h1>llfifo v4_0</h1><p>The Xilinx Dual Channel Fifo driver component. This driver supports the Virtex-5(TM) and Virtex-4(TM) XPS_ll_Fifo and the AxiFifo.</p>
<p>For a full description of the bridge features, please see the HW spec. This driver supports the following features:</p>
<ul>
<li>Memory mapped access to host interface registers</li>
<li>API for polled frame transfers</li>
<li>API for interrupt driven frame transfers</li>
<li>Virtual memory support</li>
<li>Full duplex operation</li>
</ul>
<h2>Driver Description</h2> <h2>Driver Description</h2>
<p> <p>This driver enables higher layer software to access the XPS_llFifo core using any alignment in the data buffers.</p>
This driver enables higher layer software to access the XPS_llFifo core using any alignment in the data buffers.<p> <p>This driver supports send and receive channels in the same instance structure in the same fashion as the hardware core.</p>
This driver supports send and receive channels in the same instance structure in the same fashion as the hardware core.<p>
<h2>Initialization</h2> <h2>Initialization</h2>
<p> <p>An instance of this driver is initialized using a call to Initialize().</p>
An instance of this driver is initialized using a call to Initialize().<p>
<h2>Usage</h2> <h2>Usage</h2>
<p> <p>It is fairly simple to use the API provided by this FIFO driver. The only somewhat tricky part is that the calling code must correctly call a couple routines in the right sequence for receive and transmit.</p>
It is fairly simple to use the API provided by this FIFO driver. The only somewhat tricky part is that the calling code must correctly call a couple routines in the right sequence for receive and transmit.<p> <p>This sequence is described here. Check the routine functional descriptions for information on how to use a specific API routine.</p>
This sequence is described here. Check the routine functional descriptions for information on how to use a specific API routine.<p>
<h3>Receive</h3> <h3>Receive</h3>
<p> <p>A frame is received by using the following sequence:<br/>
A frame is received by using the following sequence:<br> 1) call <a class="el" href="xllfifo_8h.html#a12da547aa1c9a85e2b0b151f438ff9d5">XLlFifo_RxOccupancy()</a> to check the occupancy count<br/>
1) call XLlFifo_RxOccupancy() to check the occupancy count<br> 2) call <a class="el" href="xllfifo_8h.html#a53af32ae6901462cc8d6fb9adc04655e">XLlFifo_RxGetLen()</a> to get the length of the next incoming frame<br/>
2) call XLlFifo_RxGetLen() to get the length of the next incoming frame<br> 3) call <a class="el" href="xllfifo_8h.html#aadc3685592b060c0d864850e86be5c03">XLlFifo_Read()</a> one or more times to read the number of bytes reported by <a class="el" href="xllfifo_8h.html#a53af32ae6901462cc8d6fb9adc04655e">XLlFifo_RxGetLen()</a>.<br/>
3) call XLlFifo_Read() one or more times to read the number of bytes reported by XLlFifo_RxGetLen().<br> </p>
<p> <p>For example: </p>
For example: <pre> <pre>
while (XLlFifo_RxOccupancy(&amp;RxInstance)) { while (<a class="el" href="xllfifo_8h.html#a12da547aa1c9a85e2b0b151f438ff9d5">XLlFifo_RxOccupancy(&amp;RxInstance)</a>) {
frame_len = XLlFifo_RxGetLen(&amp;RxInstance); frame_len = <a class="el" href="xllfifo_8h.html#a53af32ae6901462cc8d6fb9adc04655e">XLlFifo_RxGetLen(&amp;RxInstance)</a>;
while (frame_len) { while (frame_len) {
unsigned bytes = min(sizeof(buffer), frame_len); unsigned bytes = min(sizeof(buffer), frame_len);
XLlFifo_Read(&amp;RxInstance, buffer, bytes); <a class="el" href="xllfifo_8h.html#aadc3685592b060c0d864850e86be5c03">XLlFifo_Read(&amp;RxInstance, buffer, bytes)</a>;
// ******** // ********
// do something with buffer here // do something with buffer here
// ******** // ********
frame_len -= bytes; frame_len -= bytes;
} }
} }
</pre><p> </pre><p>This FIFO hardware core does <b>not</b> support a sequence where the calling code calls RxGetLen() twice in a row and then receive the data for two frames. Each frame must be read in by calling RxGetLen() just prior to reading the data.</p>
This FIFO hardware core does <b>not</b> support a sequence where the calling code calls RxGetLen() twice in a row and then receive the data for two frames. Each frame must be read in by calling RxGetLen() just prior to reading the data.<p>
<h3>Transmit</h3> <h3>Transmit</h3>
<p> <p>A frame is transmittted by using the following sequence:<br/>
A frame is transmittted by using the following sequence:<br> 1) call <a class="el" href="xllfifo_8h.html#a1fa93f486abaaf35c7d599a8cd91b295">XLlFifo_Write()</a> one or more times to write all the of bytes in the next frame.<br/>
1) call XLlFifo_Write() one or more times to write all the of bytes in the next frame.<br> 2) call <a class="el" href="xllfifo_8h.html#acd09ed5189e0b85994901102655964f7">XLlFifo_TxSetLen()</a> to begin the transmission of frame just written.<br/>
2) call XLlFifo_TxSetLen() to begin the transmission of frame just written.<br> </p>
<p> <p>For example: </p>
For example: <pre> <pre>
frame_left = frame_len; frame_left = frame_len;
while (frame_left) { while (frame_left) {
unsigned bytes = min(sizeof(buffer), frame_left); unsigned bytes = min(sizeof(buffer), frame_left);
XLlFifo_Write(&amp;TxInstance, buffer, bytes); <a class="el" href="xllfifo_8h.html#a1fa93f486abaaf35c7d599a8cd91b295">XLlFifo_Write(&amp;TxInstance, buffer, bytes)</a>;
// ******** // ********
// do something here to refill buffer // do something here to refill buffer
// ******** // ********
frame_left -= bytes; frame_left -= bytes;
} }
XLlFifo_TxSetLen(&amp;RxInstance, frame_len); <a class="el" href="xllfifo_8h.html#acd09ed5189e0b85994901102655964f7">XLlFifo_TxSetLen(&amp;RxInstance, frame_len)</a>;
</pre><p> </pre><p>This FIFO hardware core does <b>not</b> support a sequence where the calling code writes the data for two frames and then calls TxSetLen() twice in a row. Each frame must be written by writting the data for one frame and then calling TxSetLen().</p>
This FIFO hardware core does <b>not</b> support a sequence where the calling code writes the data for two frames and then calls TxSetLen() twice in a row. Each frame must be written by writting the data for one frame and then calling TxSetLen().<p>
<h2>Interrupts</h2> <h2>Interrupts</h2>
<p> <p>This driver does not handle interrupts from the FIFO hardware. The software layer above may make use of the interrupts by setting up its own handlers for the interrupts.</p>
This driver does not handle interrupts from the FIFO hardware. The software layer above may make use of the interrupts by setting up its own handlers for the interrupts.<p>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- -------- ------------------------------------------------------- ----- ---- -------- -------------------------------------------------------
1.00a jvb 10/12/06 First release 1.00a jvb 10/12/06 First release
1.01a sdm 08/22/08 Removed support for static interrupt handlers from the 1.01a sdm 08/22/08 Removed support for static interrupt handlers from the
@ -94,15 +95,14 @@ This driver does not handle interrupts from the FIFO hardware. The software laye
in streamer are empty. Earlier implementation using in streamer are empty. Earlier implementation using
HeadIndex was not very clear and could give improper HeadIndex was not very clear and could give improper
results for some cases. results for some cases.
Changed the macro XLlFifo_IsRxEmpty in file xllfifo.h Changed the macro XLlFifo_IsRxEmpty in file <a class="el" href="xllfifo_8h.html">xllfifo.h</a>
These changes are done to fix the CR 604650. These changes are done to fix the CR 604650.
2.03a asa 14/08/12 Added XLLF_TDR_OFFSET, XLLF_RDR_OFFSET 2.03a asa 14/08/12 Added XLLF_TDR_OFFSET, XLLF_RDR_OFFSET
defines for the new registers, and XLLF_INT_TFPF_MASK, defines for the new registers, and XLLF_INT_TFPF_MASK,
XLLF_INT_TFPE_MASK, XLLF_INT_RFPF_MASK and XLLF_INT_TFPE_MASK, XLLF_INT_RFPF_MASK and
XLLF_INT_RFPE_MASK for the new version of the XLLF_INT_RFPE_MASK for the new version of the
AXI4-Stream FIFO core (v2.01a and later)</pre><p> AXI4-Stream FIFO core (v2.01a and later)</pre><pre> 3.00a adk 08/10/13 Added support for AXI4 Datainterface.Changes are
<pre> 3.00a adk 08/10/13 Added support for AXI4 Datainterface.Changes are In Xllfifo.c file XLlFifo_RxGetWord,XLlFifo_TxPutword.
In <a class="el" href="xllfifo_8c.html">Xllfifo.c</a> file XLlFifo_RxGetWord,XLlFifo_TxPutword.
In XLlfifo.h file updated XLlfifo structure for In XLlfifo.h file updated XLlfifo structure for
Axi4BaseAddress and for Datainterface type provided Axi4BaseAddress and for Datainterface type provided
polling and interrupt examples. XLlfifo_IsRxDone Macro polling and interrupt examples. XLlfifo_IsRxDone Macro
@ -110,5 +110,9 @@ This driver does not handle interrupts from the FIFO hardware. The software laye
Added Static initialzation for the driver. Added Static initialzation for the driver.
XLlFifo_Initialize is still used to make the driver XLlFifo_Initialize is still used to make the driver
backward compatible. backward compatible.
4.0 adk 19/12/13 Updated as per the New Tcl API's</pre><p> 4.0 adk 19/12/13 Updated as per the New Tcl API's</pre><pre> </pre> </div>
<pre> </pre> Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

55
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/struct_x_ll_fifo-members.html
View file

@ -2,30 +2,41 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Member List Xilinx Driver llfifo v4_0: Member List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XLlFifo Member List</h1>This is the complete list of members for <a class="el" href="struct_x_ll_fifo.html">XLlFifo</a>, including all inherited members.<p><table> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#438cd6b96ee27adaa3fea84002cd9ca7">Axi4BaseAddress</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#2fac08c24c8373333b9f2a62008c62f3">BaseAddress</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr> </ul>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#ee4242124c1d886b866be52f6257213b">Datainterface</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr> </div>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#217c41df00b2eee11e1009f5e63905ed">IsReady</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr> </div>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#d886e27309d954a46cafa61bd18f0750">RxStreamer</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr> <div class="contents">
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#45c391d0a8e6df6b45e6dd49661f27d6">TxStreamer</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr> <h1>XLlFifo Member List</h1>This is the complete list of members for <a class="el" href="struct_x_ll_fifo.html">XLlFifo</a>, including all inherited members.<table>
</table>Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#a455c634fb80553cecfcba0845eb99937">Axi4BaseAddress</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#ab1d14782860778f2546bee03cb27f192">BaseAddress</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#a9e2342496ea8183c012567d7c89851b3">Datainterface</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#abe388bb422699248b26a9d76652474b1">IsReady</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#a456fbf87ce23b1334c67b386722b1434">RxStreamer</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo.html#a13363fb4d5d45a5725b7427b36c44817">TxStreamer</a></td><td><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

255
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/struct_x_ll_fifo.html
View file

@ -2,185 +2,138 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
XLlFifo Struct Reference Xilinx Driver llfifo v4_0: XLlFifo Struct Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XLlFifo Struct Reference</h1><!-- doxytag: class="XLlFifo" --><code>#include &lt;xllfifo.h&gt;</code> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<p> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<a href="struct_x_ll_fifo-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> </ul>
This typedef defines a run-time instance of an XLlFifo device. </div>
<p> </div>
<div class="contents">
<h1>XLlFifo Struct Reference</h1><!-- doxytag: class="XLlFifo" -->
<p><code>#include &lt;xllfifo.h&gt;</code></p>
<p><a href="struct_x_ll_fifo-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#ab1d14782860778f2546bee03cb27f192">BaseAddress</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#2fac08c24c8373333b9f2a62008c62f3">BaseAddress</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#abe388bb422699248b26a9d76652474b1">IsReady</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#a455c634fb80553cecfcba0845eb99937">Axi4BaseAddress</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#217c41df00b2eee11e1009f5e63905ed">IsReady</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#a9e2342496ea8183c012567d7c89851b3">Datainterface</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#a456fbf87ce23b1334c67b386722b1434">RxStreamer</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#438cd6b96ee27adaa3fea84002cd9ca7">Axi4BaseAddress</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#a13363fb4d5d45a5725b7427b36c44817">TxStreamer</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#ee4242124c1d886b866be52f6257213b">Datainterface</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#d886e27309d954a46cafa61bd18f0750">RxStreamer</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html#45c391d0a8e6df6b45e6dd49661f27d6">TxStreamer</a></td></tr>
</table> </table>
<hr><h2>Member Data Documentation</h2> <hr/><a name="_details"></a><h2>Detailed Description</h2>
<a class="anchor" name="438cd6b96ee27adaa3fea84002cd9ca7"></a><!-- doxytag: member="XLlFifo::Axi4BaseAddress" ref="438cd6b96ee27adaa3fea84002cd9ca7" args="" --><p> <p>This typedef defines a run-time instance of an <a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> device. </p>
<table class="mdTable" cellpadding="2" cellspacing="0"> <hr/><h2>Member Data Documentation</h2>
<tr> <a class="anchor" id="a455c634fb80553cecfcba0845eb99937"></a><!-- doxytag: member="XLlFifo::Axi4BaseAddress" ref="a455c634fb80553cecfcba0845eb99937" args="" -->
<td class="mdRow"> <div class="memitem">
<table cellpadding="0" cellspacing="0" border="0"> <div class="memproto">
<table class="memname">
<tr> <tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_ll_fifo.html#438cd6b96ee27adaa3fea84002cd9ca7">XLlFifo::Axi4BaseAddress</a> </td> <td class="memname">u32 <a class="el" href="struct_x_ll_fifo.html#a455c634fb80553cecfcba0845eb99937">XLlFifo::Axi4BaseAddress</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>BaseAddress if the FIFO Data interface is AXI4 this address should use for FIFO access </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
BaseAddress if the FIFO Data interface is AXI4 this address should use for FIFO access </td> </div>
</tr> <a class="anchor" id="ab1d14782860778f2546bee03cb27f192"></a><!-- doxytag: member="XLlFifo::BaseAddress" ref="ab1d14782860778f2546bee03cb27f192" args="" -->
</table> <div class="memitem">
<a class="anchor" name="2fac08c24c8373333b9f2a62008c62f3"></a><!-- doxytag: member="XLlFifo::BaseAddress" ref="2fac08c24c8373333b9f2a62008c62f3" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_ll_fifo.html#2fac08c24c8373333b9f2a62008c62f3">XLlFifo::BaseAddress</a> </td> <td class="memname">u32 <a class="el" href="struct_x_ll_fifo.html#ab1d14782860778f2546bee03cb27f192">XLlFifo::BaseAddress</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>BaseAddress is the physical base address of the device's registers </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
BaseAddress is the physical base address of the device's registers </td> </div>
</tr> <a class="anchor" id="a9e2342496ea8183c012567d7c89851b3"></a><!-- doxytag: member="XLlFifo::Datainterface" ref="a9e2342496ea8183c012567d7c89851b3" args="" -->
</table> <div class="memitem">
<a class="anchor" name="ee4242124c1d886b866be52f6257213b"></a><!-- doxytag: member="XLlFifo::Datainterface" ref="ee4242124c1d886b866be52f6257213b" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_ll_fifo.html#ee4242124c1d886b866be52f6257213b">XLlFifo::Datainterface</a> </td> <td class="memname">u32 <a class="el" href="struct_x_ll_fifo.html#a9e2342496ea8183c012567d7c89851b3">XLlFifo::Datainterface</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Data interface of the FIFO. This value is zero if the Datainterface is AXI4-lite. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Data interface of the FIFO. This value is zero if the Datainterface is AXI4-lite. </td> </div>
</tr> <a class="anchor" id="abe388bb422699248b26a9d76652474b1"></a><!-- doxytag: member="XLlFifo::IsReady" ref="abe388bb422699248b26a9d76652474b1" args="" -->
</table> <div class="memitem">
<a class="anchor" name="217c41df00b2eee11e1009f5e63905ed"></a><!-- doxytag: member="XLlFifo::IsReady" ref="217c41df00b2eee11e1009f5e63905ed" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_ll_fifo.html#217c41df00b2eee11e1009f5e63905ed">XLlFifo::IsReady</a> </td> <td class="memname">u32 <a class="el" href="struct_x_ll_fifo.html#abe388bb422699248b26a9d76652474b1">XLlFifo::IsReady</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>IsReady is non-zero if the driver instance has been initialized. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
IsReady is non-zero if the driver instance has been initialized. </td> </div>
</tr> <a class="anchor" id="a456fbf87ce23b1334c67b386722b1434"></a><!-- doxytag: member="XLlFifo::RxStreamer" ref="a456fbf87ce23b1334c67b386722b1434" args="" -->
</table> <div class="memitem">
<a class="anchor" name="d886e27309d954a46cafa61bd18f0750"></a><!-- doxytag: member="XLlFifo::RxStreamer" ref="d886e27309d954a46cafa61bd18f0750" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> <a class="el" href="struct_x_ll_fifo.html#d886e27309d954a46cafa61bd18f0750">XLlFifo::RxStreamer</a> </td> <td class="memname"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> <a class="el" href="struct_x_ll_fifo.html#a456fbf87ce23b1334c67b386722b1434">XLlFifo::RxStreamer</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>RxStreamer is the byte streamer instance for the receive channel. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
RxStreamer is the byte streamer instance for the receive channel. </td> </div>
</tr> <a class="anchor" id="a13363fb4d5d45a5725b7427b36c44817"></a><!-- doxytag: member="XLlFifo::TxStreamer" ref="a13363fb4d5d45a5725b7427b36c44817" args="" -->
</table> <div class="memitem">
<a class="anchor" name="45c391d0a8e6df6b45e6dd49661f27d6"></a><!-- doxytag: member="XLlFifo::TxStreamer" ref="45c391d0a8e6df6b45e6dd49661f27d6" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> <a class="el" href="struct_x_ll_fifo.html#45c391d0a8e6df6b45e6dd49661f27d6">XLlFifo::TxStreamer</a> </td> <td class="memname"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> <a class="el" href="struct_x_ll_fifo.html#a13363fb4d5d45a5725b7427b36c44817">XLlFifo::TxStreamer</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>TxStreamer is the byte streamer instance for the transmit channel. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr> </div>
<td> </div>
&nbsp; <hr/>The documentation for this struct was generated from the following file:<ul>
</td> <li><a class="el" href="xllfifo_8h.html">xllfifo.h</a></li>
<td> </ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
TxStreamer is the byte streamer instance for the transmit channel. </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xllfifo.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

40
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/struct_x_ll_fifo___config-members.html Executable file
View file

@ -0,0 +1,40 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: Member List
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XLlFifo_Config Member List</h1>This is the complete list of members for <a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a>, including all inherited members.<table>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo___config.html#a600aa696ac4ce50735710630b367246c">Axi4BaseAddress</a></td><td><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo___config.html#a02a215c2efef7ec7033f0a08b86b4a9d">BaseAddress</a></td><td><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo___config.html#a9e1566949ac9b883fe383d308dea1a43">Datainterface</a></td><td><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_ll_fifo___config.html#a18aac4f0cfbb75922f630c92b0d35308">DeviceId</a></td><td><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

106
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/struct_x_ll_fifo___config.html Executable file
View file

@ -0,0 +1,106 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: XLlFifo_Config Struct Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XLlFifo_Config Struct Reference</h1><!-- doxytag: class="XLlFifo_Config" -->
<p><code>#include &lt;xllfifo.h&gt;</code></p>
<p><a href="struct_x_ll_fifo___config-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo___config.html#a18aac4f0cfbb75922f630c92b0d35308">DeviceId</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo___config.html#a02a215c2efef7ec7033f0a08b86b4a9d">BaseAddress</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo___config.html#a600aa696ac4ce50735710630b367246c">Axi4BaseAddress</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo___config.html#a9e1566949ac9b883fe383d308dea1a43">Datainterface</a></td></tr>
</table>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a600aa696ac4ce50735710630b367246c"></a><!-- doxytag: member="XLlFifo_Config::Axi4BaseAddress" ref="a600aa696ac4ce50735710630b367246c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 <a class="el" href="struct_x_ll_fifo___config.html#a600aa696ac4ce50735710630b367246c">XLlFifo_Config::Axi4BaseAddress</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Axi4 interface Base address </p>
</div>
</div>
<a class="anchor" id="a02a215c2efef7ec7033f0a08b86b4a9d"></a><!-- doxytag: member="XLlFifo_Config::BaseAddress" ref="a02a215c2efef7ec7033f0a08b86b4a9d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 <a class="el" href="struct_x_ll_fifo___config.html#a02a215c2efef7ec7033f0a08b86b4a9d">XLlFifo_Config::BaseAddress</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Base Address of the AXI FIFO </p>
</div>
</div>
<a class="anchor" id="a9e1566949ac9b883fe383d308dea1a43"></a><!-- doxytag: member="XLlFifo_Config::Datainterface" ref="a9e1566949ac9b883fe383d308dea1a43" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 <a class="el" href="struct_x_ll_fifo___config.html#a9e1566949ac9b883fe383d308dea1a43">XLlFifo_Config::Datainterface</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Type of Datainterface </p>
</div>
</div>
<a class="anchor" id="a18aac4f0cfbb75922f630c92b0d35308"></a><!-- doxytag: member="XLlFifo_Config::DeviceId" ref="a18aac4f0cfbb75922f630c92b0d35308" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 <a class="el" href="struct_x_ll_fifo___config.html#a18aac4f0cfbb75922f630c92b0d35308">XLlFifo_Config::DeviceId</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deviceid of the AXI FIFO </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="xllfifo_8h.html">xllfifo.h</a></li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

58
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/struct_x_strm___rx_fifo_streamer-members.html
View file

@ -2,31 +2,43 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Member List Xilinx Driver llfifo v4_0: Member List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XStrm_RxFifoStreamer Member List</h1>This is the complete list of members for <a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a>, including all inherited members.<p><table> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">FifoInstance</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">FifoWidth</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr> </ul>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#c9b82181b5681676c677e9642eb1bfcb">FrmByteCnt</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr> </div>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#dd45a9ebbb8375a67632dfde3cf8b54d">GetLenFn</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr> </div>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#e49284720f12f2cbdaffc98fd54d0dc6">GetOccupancyFn</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr> <div class="contents">
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#de91e0d42dec554b7f9d31df3c1b4a30">HeadIndex</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr> <h1>XStrm_RxFifoStreamer Member List</h1>This is the complete list of members for <a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a>, including all inherited members.<table>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#4afca30e32cb505d0e7fed24f7fcaff7">ReadFn</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr> <tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a5d1f8f992cd102849b29a2df35751393">AlignedBuffer</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr>
</table>Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#ab278ceaef035943f8a3a8b85a8cab99d">FifoInstance</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a3ad4cdd1ad14dcecfaf5f923850289fb">FifoWidth</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a9fa74d02f4fa2607e78b11de059be837">FrmByteCnt</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a01fa1cc2098388ac9371beb090c0c212">GetLenFn</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a8d552e42f58c3230de010178832b41b1">GetOccupancyFn</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a6321ab6bf1a1f3979c0771618a4aba7c">HeadIndex</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html#af3bfc974fd88c7b707edf680b3c9aed2">ReadFn</a></td><td><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

301
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/struct_x_strm___rx_fifo_streamer.html
View file

@ -2,210 +2,167 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
XStrm_RxFifoStreamer Struct Reference Xilinx Driver llfifo v4_0: XStrm_RxFifoStreamer Struct Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XStrm_RxFifoStreamer Struct Reference</h1><!-- doxytag: class="XStrm_RxFifoStreamer" --><code>#include &lt;xstreamer.h&gt;</code> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<p> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<a href="struct_x_strm___rx_fifo_streamer-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> </ul>
This typedef defines a run-time instance of a receive byte-streamer. </div>
<p> </div>
<div class="contents">
<h1>XStrm_RxFifoStreamer Struct Reference</h1><!-- doxytag: class="XStrm_RxFifoStreamer" -->
<p><code>#include &lt;xstreamer.h&gt;</code></p>
<p><a href="struct_x_strm___rx_fifo_streamer-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">union <a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a5d1f8f992cd102849b29a2df35751393">AlignedBuffer</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#de91e0d42dec554b7f9d31df3c1b4a30">HeadIndex</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a6321ab6bf1a1f3979c0771618a4aba7c">HeadIndex</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a3ad4cdd1ad14dcecfaf5f923850289fb">FifoWidth</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">FifoWidth</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a9fa74d02f4fa2607e78b11de059be837">FrmByteCnt</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#ab278ceaef035943f8a3a8b85a8cab99d">FifoInstance</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#c9b82181b5681676c677e9642eb1bfcb">FrmByteCnt</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#af3bfc974fd88c7b707edf680b3c9aed2">ReadFn</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="xstreamer_8h.html#a967adc3a060d1799795857d4e1ab0397">XStrm_GetLenFnType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a01fa1cc2098388ac9371beb090c0c212">GetLenFn</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">FifoInstance</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="xstreamer_8h.html#a63293ed02cfb43a6207cd1eb888a8a21">XStrm_GetOccupancyFnType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#a8d552e42f58c3230de010178832b41b1">GetOccupancyFn</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XStrm_XferFnType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#4afca30e32cb505d0e7fed24f7fcaff7">ReadFn</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XStrm_GetLenFnType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#dd45a9ebbb8375a67632dfde3cf8b54d">GetLenFn</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XStrm_GetOccupancyFnType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html#e49284720f12f2cbdaffc98fd54d0dc6">GetOccupancyFn</a></td></tr>
</table> </table>
<hr><h2>Member Data Documentation</h2> <hr/><a name="_details"></a><h2>Detailed Description</h2>
<a class="anchor" name="c35cdf02e30463bc50a4a156aef31689"></a><!-- doxytag: member="XStrm_RxFifoStreamer::FifoInstance" ref="c35cdf02e30463bc50a4a156aef31689" args="" --><p> <p>This typedef defines a run-time instance of a receive byte-streamer. </p>
<table class="mdTable" cellpadding="2" cellspacing="0"> <hr/><h2>Member Data Documentation</h2>
<tr> <a class="anchor" id="a5d1f8f992cd102849b29a2df35751393"></a><!-- doxytag: member="XStrm_RxFifoStreamer::AlignedBuffer" ref="a5d1f8f992cd102849b29a2df35751393" args="" -->
<td class="mdRow"> <div class="memitem">
<table cellpadding="0" cellspacing="0" border="0"> <div class="memproto">
<table class="memname">
<tr> <tr>
<td class="md" nowrap valign="top">void* <a class="el" href="struct_x_strm___rx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">XStrm_RxFifoStreamer::FifoInstance</a> </td> <td class="memname">union <a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a> <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a5d1f8f992cd102849b29a2df35751393">XStrm_RxFifoStreamer::AlignedBuffer</a><code> [write]</code></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
FifoInstance is the FIFO driver instance to pass to ReadFn, GetLenFn, and GetOccupancyFn routines. </td> </div>
</tr> <a class="anchor" id="ab278ceaef035943f8a3a8b85a8cab99d"></a><!-- doxytag: member="XStrm_RxFifoStreamer::FifoInstance" ref="ab278ceaef035943f8a3a8b85a8cab99d" args="" -->
</table> <div class="memitem">
<a class="anchor" name="ea1ed20f09c791584946ac39c807b429"></a><!-- doxytag: member="XStrm_RxFifoStreamer::FifoWidth" ref="ea1ed20f09c791584946ac39c807b429" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">unsigned <a class="el" href="struct_x_strm___rx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">XStrm_RxFifoStreamer::FifoWidth</a> </td> <td class="memname">void* <a class="el" href="struct_x_strm___rx_fifo_streamer.html#ab278ceaef035943f8a3a8b85a8cab99d">XStrm_RxFifoStreamer::FifoInstance</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>FifoInstance is the FIFO driver instance to pass to ReadFn, GetLenFn, and GetOccupancyFn routines. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
FifoWidth is the FIFO key hole width in bytes. </td> </div>
</tr> <a class="anchor" id="a3ad4cdd1ad14dcecfaf5f923850289fb"></a><!-- doxytag: member="XStrm_RxFifoStreamer::FifoWidth" ref="a3ad4cdd1ad14dcecfaf5f923850289fb" args="" -->
</table> <div class="memitem">
<a class="anchor" name="c9b82181b5681676c677e9642eb1bfcb"></a><!-- doxytag: member="XStrm_RxFifoStreamer::FrmByteCnt" ref="c9b82181b5681676c677e9642eb1bfcb" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">unsigned <a class="el" href="struct_x_strm___rx_fifo_streamer.html#c9b82181b5681676c677e9642eb1bfcb">XStrm_RxFifoStreamer::FrmByteCnt</a> </td> <td class="memname">unsigned <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a3ad4cdd1ad14dcecfaf5f923850289fb">XStrm_RxFifoStreamer::FifoWidth</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>FifoWidth is the FIFO key hole width in bytes. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
FrmByteCnt is the number of bytes in the next Frame. </td> </div>
</tr> <a class="anchor" id="a9fa74d02f4fa2607e78b11de059be837"></a><!-- doxytag: member="XStrm_RxFifoStreamer::FrmByteCnt" ref="a9fa74d02f4fa2607e78b11de059be837" args="" -->
</table> <div class="memitem">
<a class="anchor" name="dd45a9ebbb8375a67632dfde3cf8b54d"></a><!-- doxytag: member="XStrm_RxFifoStreamer::GetLenFn" ref="dd45a9ebbb8375a67632dfde3cf8b54d" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">XStrm_GetLenFnType <a class="el" href="struct_x_strm___rx_fifo_streamer.html#dd45a9ebbb8375a67632dfde3cf8b54d">XStrm_RxFifoStreamer::GetLenFn</a> </td> <td class="memname">unsigned <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a9fa74d02f4fa2607e78b11de059be837">XStrm_RxFifoStreamer::FrmByteCnt</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>FrmByteCnt is the number of bytes in the next Frame. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
GetLenFn is the routine the streamer uses to initiate receive operations on the FIFO. </td> </div>
</tr> <a class="anchor" id="a01fa1cc2098388ac9371beb090c0c212"></a><!-- doxytag: member="XStrm_RxFifoStreamer::GetLenFn" ref="a01fa1cc2098388ac9371beb090c0c212" args="" -->
</table> <div class="memitem">
<a class="anchor" name="e49284720f12f2cbdaffc98fd54d0dc6"></a><!-- doxytag: member="XStrm_RxFifoStreamer::GetOccupancyFn" ref="e49284720f12f2cbdaffc98fd54d0dc6" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">XStrm_GetOccupancyFnType <a class="el" href="struct_x_strm___rx_fifo_streamer.html#e49284720f12f2cbdaffc98fd54d0dc6">XStrm_RxFifoStreamer::GetOccupancyFn</a> </td> <td class="memname"><a class="el" href="xstreamer_8h.html#a967adc3a060d1799795857d4e1ab0397">XStrm_GetLenFnType</a> <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a01fa1cc2098388ac9371beb090c0c212">XStrm_RxFifoStreamer::GetLenFn</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>GetLenFn is the routine the streamer uses to initiate receive operations on the FIFO. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
GetOccupancyFn is the routine the streamer uses to get the occupancy from the FIFO. </td> </div>
</tr> <a class="anchor" id="a8d552e42f58c3230de010178832b41b1"></a><!-- doxytag: member="XStrm_RxFifoStreamer::GetOccupancyFn" ref="a8d552e42f58c3230de010178832b41b1" args="" -->
</table> <div class="memitem">
<a class="anchor" name="de91e0d42dec554b7f9d31df3c1b4a30"></a><!-- doxytag: member="XStrm_RxFifoStreamer::HeadIndex" ref="de91e0d42dec554b7f9d31df3c1b4a30" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">unsigned <a class="el" href="struct_x_strm___rx_fifo_streamer.html#de91e0d42dec554b7f9d31df3c1b4a30">XStrm_RxFifoStreamer::HeadIndex</a> </td> <td class="memname"><a class="el" href="xstreamer_8h.html#a63293ed02cfb43a6207cd1eb888a8a21">XStrm_GetOccupancyFnType</a> <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a8d552e42f58c3230de010178832b41b1">XStrm_RxFifoStreamer::GetOccupancyFn</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>GetOccupancyFn is the routine the streamer uses to get the occupancy from the FIFO. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
HeadIndex is the index to the AlignedBuffer as bytes. </td> </div>
</tr> <a class="anchor" id="a6321ab6bf1a1f3979c0771618a4aba7c"></a><!-- doxytag: member="XStrm_RxFifoStreamer::HeadIndex" ref="a6321ab6bf1a1f3979c0771618a4aba7c" args="" -->
</table> <div class="memitem">
<a class="anchor" name="4afca30e32cb505d0e7fed24f7fcaff7"></a><!-- doxytag: member="XStrm_RxFifoStreamer::ReadFn" ref="4afca30e32cb505d0e7fed24f7fcaff7" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">XStrm_XferFnType <a class="el" href="struct_x_strm___rx_fifo_streamer.html#4afca30e32cb505d0e7fed24f7fcaff7">XStrm_RxFifoStreamer::ReadFn</a> </td> <td class="memname">unsigned <a class="el" href="struct_x_strm___rx_fifo_streamer.html#a6321ab6bf1a1f3979c0771618a4aba7c">XStrm_RxFifoStreamer::HeadIndex</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>HeadIndex is the index to the AlignedBuffer as bytes. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr> </div>
<td> </div>
&nbsp; <a class="anchor" id="af3bfc974fd88c7b707edf680b3c9aed2"></a><!-- doxytag: member="XStrm_RxFifoStreamer::ReadFn" ref="af3bfc974fd88c7b707edf680b3c9aed2" args="" -->
</td> <div class="memitem">
<td> <div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a> <a class="el" href="struct_x_strm___rx_fifo_streamer.html#af3bfc974fd88c7b707edf680b3c9aed2">XStrm_RxFifoStreamer::ReadFn</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ReadFn is the routine the streamer uses to receive bytes from the Fifo. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="xstreamer_8h.html">xstreamer.h</a></li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
ReadFn is the routine the streamer uses to receive bytes from the Fifo. </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xstreamer.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

56
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/struct_x_strm___tx_fifo_streamer-members.html
View file

@ -2,30 +2,42 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Member List Xilinx Driver llfifo v4_0: Member List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XStrm_TxFifoStreamer Member List</h1>This is the complete list of members for <a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a>, including all inherited members.<p><table> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">FifoInstance</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">FifoWidth</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr> </ul>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#df4ee39f9fabb84e3ecdd90bf816cc4e">GetVacancyFn</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr> </div>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#d4667ecb5841d1d626c39b7f026dd98f">SetLenFn</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr> </div>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#343b2db47525585673b88c2c3a7d7389">TailIndex</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr> <div class="contents">
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#bbf213c206b45f0f121c0cae755b6788">WriteFn</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr> <h1>XStrm_TxFifoStreamer Member List</h1>This is the complete list of members for <a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a>, including all inherited members.<table>
</table>Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab219d36b21fc84935af04761c15ff26d">AlignedBuffer</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#ac20fde8a3090fddfc01f8b2900fd9051">FifoInstance</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#a474cf91d66d43f716a34299d4ab9b9b2">FifoWidth</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab33212eea0a6327f2c6b1173510170a9">GetVacancyFn</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#aa315e740022ccc81ef9cccfe7c82022d">SetLenFn</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#a265500391a387c5354a14fea79a1b446">TailIndex</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html#abaed83d1259485a6deadbf4644b0be1b">WriteFn</a></td><td><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

269
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/struct_x_strm___tx_fifo_streamer.html
View file

@ -2,185 +2,152 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
XStrm_TxFifoStreamer Struct Reference Xilinx Driver llfifo v4_0: XStrm_TxFifoStreamer Struct Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XStrm_TxFifoStreamer Struct Reference</h1><!-- doxytag: class="XStrm_TxFifoStreamer" --><code>#include &lt;xstreamer.h&gt;</code> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<p> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<a href="struct_x_strm___tx_fifo_streamer-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> </ul>
This typedef defines a run-time instance of a transmit byte-streamer. </div>
<p> </div>
<div class="contents">
<h1>XStrm_TxFifoStreamer Struct Reference</h1><!-- doxytag: class="XStrm_TxFifoStreamer" -->
<p><code>#include &lt;xstreamer.h&gt;</code></p>
<p><a href="struct_x_strm___tx_fifo_streamer-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">union <a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab219d36b21fc84935af04761c15ff26d">AlignedBuffer</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#343b2db47525585673b88c2c3a7d7389">TailIndex</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#a265500391a387c5354a14fea79a1b446">TailIndex</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#a474cf91d66d43f716a34299d4ab9b9b2">FifoWidth</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">FifoWidth</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#ac20fde8a3090fddfc01f8b2900fd9051">FifoInstance</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#abaed83d1259485a6deadbf4644b0be1b">WriteFn</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">FifoInstance</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#aa315e740022ccc81ef9cccfe7c82022d">SetLenFn</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab33212eea0a6327f2c6b1173510170a9">GetVacancyFn</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XStrm_XferFnType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#bbf213c206b45f0f121c0cae755b6788">WriteFn</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XStrm_SetLenFnType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#d4667ecb5841d1d626c39b7f026dd98f">SetLenFn</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XStrm_GetVacancyFnType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html#df4ee39f9fabb84e3ecdd90bf816cc4e">GetVacancyFn</a></td></tr>
</table> </table>
<hr><h2>Member Data Documentation</h2> <hr/><a name="_details"></a><h2>Detailed Description</h2>
<a class="anchor" name="c35cdf02e30463bc50a4a156aef31689"></a><!-- doxytag: member="XStrm_TxFifoStreamer::FifoInstance" ref="c35cdf02e30463bc50a4a156aef31689" args="" --><p> <p>This typedef defines a run-time instance of a transmit byte-streamer. </p>
<table class="mdTable" cellpadding="2" cellspacing="0"> <hr/><h2>Member Data Documentation</h2>
<tr> <a class="anchor" id="ab219d36b21fc84935af04761c15ff26d"></a><!-- doxytag: member="XStrm_TxFifoStreamer::AlignedBuffer" ref="ab219d36b21fc84935af04761c15ff26d" args="" -->
<td class="mdRow"> <div class="memitem">
<table cellpadding="0" cellspacing="0" border="0"> <div class="memproto">
<table class="memname">
<tr> <tr>
<td class="md" nowrap valign="top">void* <a class="el" href="struct_x_strm___tx_fifo_streamer.html#c35cdf02e30463bc50a4a156aef31689">XStrm_TxFifoStreamer::FifoInstance</a> </td> <td class="memname">union <a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a> <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab219d36b21fc84935af04761c15ff26d">XStrm_TxFifoStreamer::AlignedBuffer</a><code> [write]</code></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
FifoInstance is the FIFO driver instance to pass to WriteFn, SetLenFn, and GetVacancyFn routines. </td> </div>
</tr> <a class="anchor" id="ac20fde8a3090fddfc01f8b2900fd9051"></a><!-- doxytag: member="XStrm_TxFifoStreamer::FifoInstance" ref="ac20fde8a3090fddfc01f8b2900fd9051" args="" -->
</table> <div class="memitem">
<a class="anchor" name="ea1ed20f09c791584946ac39c807b429"></a><!-- doxytag: member="XStrm_TxFifoStreamer::FifoWidth" ref="ea1ed20f09c791584946ac39c807b429" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">unsigned <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ea1ed20f09c791584946ac39c807b429">XStrm_TxFifoStreamer::FifoWidth</a> </td> <td class="memname">void* <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ac20fde8a3090fddfc01f8b2900fd9051">XStrm_TxFifoStreamer::FifoInstance</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>FifoInstance is the FIFO driver instance to pass to WriteFn, SetLenFn, and GetVacancyFn routines. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
FifoWidth is the FIFO key hole width in bytes. </td> </div>
</tr> <a class="anchor" id="a474cf91d66d43f716a34299d4ab9b9b2"></a><!-- doxytag: member="XStrm_TxFifoStreamer::FifoWidth" ref="a474cf91d66d43f716a34299d4ab9b9b2" args="" -->
</table> <div class="memitem">
<a class="anchor" name="df4ee39f9fabb84e3ecdd90bf816cc4e"></a><!-- doxytag: member="XStrm_TxFifoStreamer::GetVacancyFn" ref="df4ee39f9fabb84e3ecdd90bf816cc4e" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">XStrm_GetVacancyFnType <a class="el" href="struct_x_strm___tx_fifo_streamer.html#df4ee39f9fabb84e3ecdd90bf816cc4e">XStrm_TxFifoStreamer::GetVacancyFn</a> </td> <td class="memname">unsigned <a class="el" href="struct_x_strm___tx_fifo_streamer.html#a474cf91d66d43f716a34299d4ab9b9b2">XStrm_TxFifoStreamer::FifoWidth</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>FifoWidth is the FIFO key hole width in bytes. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
GetVaccancyFn is the routine the streamer uses to get the vacancy from the FIFO. </td> </div>
</tr> <a class="anchor" id="ab33212eea0a6327f2c6b1173510170a9"></a><!-- doxytag: member="XStrm_TxFifoStreamer::GetVacancyFn" ref="ab33212eea0a6327f2c6b1173510170a9" args="" -->
</table> <div class="memitem">
<a class="anchor" name="d4667ecb5841d1d626c39b7f026dd98f"></a><!-- doxytag: member="XStrm_TxFifoStreamer::SetLenFn" ref="d4667ecb5841d1d626c39b7f026dd98f" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">XStrm_SetLenFnType <a class="el" href="struct_x_strm___tx_fifo_streamer.html#d4667ecb5841d1d626c39b7f026dd98f">XStrm_TxFifoStreamer::SetLenFn</a> </td> <td class="memname"><a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a> <a class="el" href="struct_x_strm___tx_fifo_streamer.html#ab33212eea0a6327f2c6b1173510170a9">XStrm_TxFifoStreamer::GetVacancyFn</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>GetVaccancyFn is the routine the streamer uses to get the vacancy from the FIFO. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
SetLenFn is the routine the streamer uses to initiate transmit operations on the FIFO. </td> </div>
</tr> <a class="anchor" id="aa315e740022ccc81ef9cccfe7c82022d"></a><!-- doxytag: member="XStrm_TxFifoStreamer::SetLenFn" ref="aa315e740022ccc81ef9cccfe7c82022d" args="" -->
</table> <div class="memitem">
<a class="anchor" name="343b2db47525585673b88c2c3a7d7389"></a><!-- doxytag: member="XStrm_TxFifoStreamer::TailIndex" ref="343b2db47525585673b88c2c3a7d7389" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">unsigned <a class="el" href="struct_x_strm___tx_fifo_streamer.html#343b2db47525585673b88c2c3a7d7389">XStrm_TxFifoStreamer::TailIndex</a> </td> <td class="memname"><a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a> <a class="el" href="struct_x_strm___tx_fifo_streamer.html#aa315e740022ccc81ef9cccfe7c82022d">XStrm_TxFifoStreamer::SetLenFn</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>SetLenFn is the routine the streamer uses to initiate transmit operations on the FIFO. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
TailIndex is the index to the AlignedBuffer as bytes </td> </div>
</tr> <a class="anchor" id="a265500391a387c5354a14fea79a1b446"></a><!-- doxytag: member="XStrm_TxFifoStreamer::TailIndex" ref="a265500391a387c5354a14fea79a1b446" args="" -->
</table> <div class="memitem">
<a class="anchor" name="bbf213c206b45f0f121c0cae755b6788"></a><!-- doxytag: member="XStrm_TxFifoStreamer::WriteFn" ref="bbf213c206b45f0f121c0cae755b6788" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">XStrm_XferFnType <a class="el" href="struct_x_strm___tx_fifo_streamer.html#bbf213c206b45f0f121c0cae755b6788">XStrm_TxFifoStreamer::WriteFn</a> </td> <td class="memname">unsigned <a class="el" href="struct_x_strm___tx_fifo_streamer.html#a265500391a387c5354a14fea79a1b446">XStrm_TxFifoStreamer::TailIndex</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>TailIndex is the index to the AlignedBuffer as bytes </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr> </div>
<td> </div>
&nbsp; <a class="anchor" id="abaed83d1259485a6deadbf4644b0be1b"></a><!-- doxytag: member="XStrm_TxFifoStreamer::WriteFn" ref="abaed83d1259485a6deadbf4644b0be1b" args="" -->
</td> <div class="memitem">
<td> <div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a> <a class="el" href="struct_x_strm___tx_fifo_streamer.html#abaed83d1259485a6deadbf4644b0be1b">XStrm_TxFifoStreamer::WriteFn</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>WriteFn is the routine the streamer uses to transmit bytes to the Fifo. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="xstreamer_8h.html">xstreamer.h</a></li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
WriteFn is the routine the streamer uses to transmit bytes to the Fifo. </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xstreamer.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

15
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/tabs.css
View file

@ -32,7 +32,7 @@ DIV.tabs A
float : left; float : left;
background : url("tab_r.gif") no-repeat right top; background : url("tab_r.gif") no-repeat right top;
border-bottom : 1px solid #84B0C7; border-bottom : 1px solid #84B0C7;
font-size : x-small; font-size : 80%;
font-weight : bold; font-weight : bold;
text-decoration : none; text-decoration : none;
} }
@ -57,7 +57,7 @@ DIV.tabs SPAN
white-space : nowrap; white-space : nowrap;
} }
DIV.tabs INPUT DIV.tabs #MSearchBox
{ {
float : right; float : right;
display : inline; display : inline;
@ -66,7 +66,7 @@ DIV.tabs INPUT
DIV.tabs TD DIV.tabs TD
{ {
font-size : x-small; font-size : 80%;
font-weight : bold; font-weight : bold;
text-decoration : none; text-decoration : none;
} }
@ -82,21 +82,24 @@ DIV.tabs A:hover SPAN
background-position: 0% -150px; background-position: 0% -150px;
} }
DIV.tabs LI#current A DIV.tabs LI.current A
{ {
background-position: 100% -150px; background-position: 100% -150px;
border-width : 0px; border-width : 0px;
} }
DIV.tabs LI#current SPAN DIV.tabs LI.current SPAN
{ {
background-position: 0% -150px; background-position: 0% -150px;
padding-bottom : 6px; padding-bottom : 6px;
} }
DIV.nav DIV.navpath
{ {
background : none; background : none;
border : none; border : none;
border-bottom : 1px solid #84B0C7; border-bottom : 1px solid #84B0C7;
text-align : center;
margin : 2px;
padding : 2px;
} }

38
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/union_x_strm___aligned_buffer_type-members.html Executable file
View file

@ -0,0 +1,38 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: Member List
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XStrm_AlignedBufferType Member List</h1>This is the complete list of members for <a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a>, including all inherited members.<table>
<tr class="memlist"><td><a class="el" href="union_x_strm___aligned_buffer_type.html#a459bdbeb843b8316832b438cd7b217c0">_words</a></td><td><a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="union_x_strm___aligned_buffer_type.html#ade878ac1f429178b76fa7c27e5d3ed0e">bytes</a></td><td><a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

74
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/union_x_strm___aligned_buffer_type.html Executable file
View file

@ -0,0 +1,74 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: XStrm_AlignedBufferType Union Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XStrm_AlignedBufferType Union Reference</h1><!-- doxytag: class="XStrm_AlignedBufferType" -->
<p><code>#include &lt;xstreamer.h&gt;</code></p>
<p><a href="union_x_strm___aligned_buffer_type-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="union_x_strm___aligned_buffer_type.html#a459bdbeb843b8316832b438cd7b217c0">_words</a> [LARGEST_FIFO_KEYHOLE_SIZE_WORDS]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="union_x_strm___aligned_buffer_type.html#ade878ac1f429178b76fa7c27e5d3ed0e">bytes</a> [LARGEST_FIFO_KEYHOLE_SIZE_WORDS *4]</td></tr>
</table>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a459bdbeb843b8316832b438cd7b217c0"></a><!-- doxytag: member="XStrm_AlignedBufferType::_words" ref="a459bdbeb843b8316832b438cd7b217c0" args="[LARGEST_FIFO_KEYHOLE_SIZE_WORDS]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 <a class="el" href="union_x_strm___aligned_buffer_type.html#a459bdbeb843b8316832b438cd7b217c0">XStrm_AlignedBufferType::_words</a>[LARGEST_FIFO_KEYHOLE_SIZE_WORDS]</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ade878ac1f429178b76fa7c27e5d3ed0e"></a><!-- doxytag: member="XStrm_AlignedBufferType::bytes" ref="ade878ac1f429178b76fa7c27e5d3ed0e" args="[LARGEST_FIFO_KEYHOLE_SIZE_WORDS *4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="union_x_strm___aligned_buffer_type.html#ade878ac1f429178b76fa7c27e5d3ed0e">XStrm_AlignedBufferType::bytes</a>[LARGEST_FIFO_KEYHOLE_SIZE_WORDS *4]</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this union was generated from the following file:<ul>
<li><a class="el" href="xstreamer_8h.html">xstreamer.h</a></li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

77
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/xdebug_8h.html Executable file
View file

@ -0,0 +1,77 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: xdebug.h File Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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>xdebug.h File Reference</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdebug_8h.html#a12060fbd49869828f1554c4ddd071fd5">xdbg_stmnt</a>(x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdebug_8h.html#ac91e7d6ead432cebc3c8890d9bcbad22">xdbg_printf</a>(...)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ac91e7d6ead432cebc3c8890d9bcbad22"></a><!-- doxytag: member="xdebug.h::xdbg_printf" ref="ac91e7d6ead432cebc3c8890d9bcbad22" args="(...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xdbg_printf</td>
<td>(</td>
<td class="paramtype"> <em>...</em>&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a12060fbd49869828f1554c4ddd071fd5"></a><!-- doxytag: member="xdebug.h::xdbg_stmnt" ref="a12060fbd49869828f1554c4ddd071fd5" args="(x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xdbg_stmnt</td>
<td>(</td>
<td class="paramtype">x&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

419
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/xllfifo_8c.html
View file

@ -2,30 +2,53 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
xllfifo.c File Reference Xilinx Driver llfifo v4_0: xllfifo.c File Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>xllfifo.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
The Xilinx local link FIFO driver component. This driver supports the Xilinx xps_ll_fifo core.<p> <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xllfifo.c File Reference</h1><code>#include &quot;xstatus.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="xllfifo_8h.html">xllfifo.h</a>&quot;</code><br/>
<code>#include &quot;xil_assert.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#a9ab678f3af0afefab24bc4f670a50bf6">FIFO_WIDTH_BYTES</a>&nbsp;&nbsp;&nbsp;4</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#aacc66a5dc69ac5a882fa7f3d161efbcb">xdbg_stmnt</a> (u32 _xllfifo_rr_value;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#aad292ddf2a2c9dde261b93da802c8080">XLlFifo_iRxGetLen</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#a18bc620d388cbca83d63cc1c6ef33225">XLlFifo_iRead_Aligned</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, void *BufPtr, unsigned WordCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#ac02405b23499d780e7bc1dfe371281a6">XLlFifo_iTxVacancy</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#aa49ecc1529434fd932d8a65d63a1a04d">XLlFifo_iTxSetLen</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, u32 Bytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#a9be5556d593980195e43a31ffb37e0fe">XLlFifo_iWrite_Aligned</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, void *BufPtr, unsigned WordCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#adc1db2785627a0d8da46dc60990889a0">XLlFifo_CfgInitialize</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, <a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a> *Config, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#aed3ae31c8c24f46139fbd709027329ec">XLlFifo_RxGetWord</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#a29654d755dce84b861022179c99ca7a3">XLlFifo_TxPutWord</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, u32 Word)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#a1fdf07ca198f5cfe2dc14ced21e5631d">XLlFifo_Initialize</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, u32 BaseAddress)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The Xilinx local link FIFO driver component. This driver supports the Xilinx xps_ll_fifo core.</p>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- -------- ------------------------------------------------------- ----- ---- -------- -------------------------------------------------------
1.00a jvb 10/13/06 First release 1.00a jvb 10/13/06 First release
1.00a xd 12/17/07 Added type casting to fix CR #456850 1.00a xd 12/17/07 Added type casting to fix CR #456850
@ -37,115 +60,295 @@ The Xilinx local link FIFO driver component. This driver supports the Xilinx xps
XLlFifo_RxGetWord, XLlFifo_TxPutword inorder to XLlFifo_RxGetWord, XLlFifo_TxPutword inorder to
handle AXI4 Datainterface. Added Config handle AXI4 Datainterface. Added Config
initialization for the driver. initialization for the driver.
</pre> </pre> <hr/><h2>Define Documentation</h2>
<p> <a class="anchor" id="a9ab678f3af0afefab24bc4f670a50bf6"></a><!-- doxytag: member="xllfifo.c::FIFO_WIDTH_BYTES" ref="a9ab678f3af0afefab24bc4f670a50bf6" args="" -->
<code>#include &quot;xstatus.h&quot;</code><br> <div class="memitem">
<code>#include &quot;xllfifo.h&quot;</code><br> <div class="memproto">
<code>#include &quot;xil_assert.h&quot;</code><br> <table class="memname">
<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">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#2fe123c957f759858100542feb21be2d">XLlFifo_CfgInitialize</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, XLlFifo_Config *Config, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8c.html#83642984b46fd728640f099a09eeeebd">XLlFifo_Initialize</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, u32 BaseAddress)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="2fe123c957f759858100542feb21be2d"></a><!-- doxytag: member="xllfifo.c::XLlFifo_CfgInitialize" ref="2fe123c957f759858100542feb21be2d" args="(XLlFifo *InstancePtr, XLlFifo_Config *Config, u32 EffectiveAddress)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">int XLlFifo_CfgInitialize </td> <td class="memname">#define FIFO_WIDTH_BYTES&nbsp;&nbsp;&nbsp;4</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>XLlFifo_Config *&nbsp;</td>
<td class="mdname" nowrap> <em>Config</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u32&nbsp;</td>
<td class="mdname" nowrap> <em>EffectiveAddress</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
XLlFifo_CfgInitialize initializes an XPS_ll_Fifo device along with the <em>InstancePtr</em> that references it.<p> </div>
<dl compact><dt><b>Parameters:</b></dt><dd> <hr/><h2>Function Documentation</h2>
<a class="anchor" id="aacc66a5dc69ac5a882fa7f3d161efbcb"></a><!-- doxytag: member="xllfifo.c::xdbg_stmnt" ref="aacc66a5dc69ac5a882fa7f3d161efbcb" args="(u32 _xllfifo_rr_value;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xdbg_stmnt </td>
<td>(</td>
<td class="paramtype">u32 _xllfifo_rr_value;&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="adc1db2785627a0d8da46dc60990889a0"></a><!-- doxytag: member="xllfifo.c::XLlFifo_CfgInitialize" ref="adc1db2785627a0d8da46dc60990889a0" args="(XLlFifo *InstancePtr, XLlFifo_Config *Config, u32 EffectiveAddress)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XLlFifo_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a> *&nbsp;</td>
<td class="paramname"> <em>Config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddress</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_CfgInitialize initializes an XPS_ll_Fifo device along with the <em>InstancePtr</em> that references it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the Axi Streaming FIFO instance to be worked on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the Axi Streaming FIFO instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CfgPtr</em>&nbsp;</td><td>references the structure holding the hardware configuration for the Axi Streaming FIFO core to initialize. </td></tr> <tr><td valign="top"></td><td valign="top"><em>CfgPtr</em>&nbsp;</td><td>references the structure holding the hardware configuration for the Axi Streaming FIFO core to initialize. </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> <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> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd>N/A </dd></dl> <dl class="return"><dt><b>Returns:</b></dt><dd>N/A </dd></dl>
</td>
</tr> </div>
</table> </div>
<a class="anchor" name="83642984b46fd728640f099a09eeeebd"></a><!-- doxytag: member="xllfifo.c::XLlFifo_Initialize" ref="83642984b46fd728640f099a09eeeebd" args="(XLlFifo *InstancePtr, u32 BaseAddress)" --><p> <a class="anchor" id="a1fdf07ca198f5cfe2dc14ced21e5631d"></a><!-- doxytag: member="xllfifo.c::XLlFifo_Initialize" ref="a1fdf07ca198f5cfe2dc14ced21e5631d" args="(XLlFifo *InstancePtr, u32 BaseAddress)" -->
<table class="mdTable" cellpadding="2" cellspacing="0"> <div class="memitem">
<tr> <div class="memproto">
<td class="mdRow"> <table class="memname">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">void XLlFifo_Initialize </td> <td class="memname">void XLlFifo_Initialize </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td> <td class="paramname"> <em>InstancePtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u32&nbsp;</td> <td class="paramtype">u32&nbsp;</td>
<td class="mdname" nowrap> <em>BaseAddress</em></td> <td class="paramname"> <em>BaseAddress</em></td><td>&nbsp;</td>
</tr> </tr>
<tr> <tr>
<td class="md"></td> <td></td>
<td class="md">)&nbsp;</td> <td>)</td>
<td class="md" colspan="2"></td> <td></td><td></td><td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>XLlFifo_Initialize initializes an XPS_ll_Fifo device along with the <em>InstancePtr</em> that references it.</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
XLlFifo_Initialize initializes an XPS_ll_Fifo device along with the <em>InstancePtr</em> that references it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the memory instance to be associated with the FIFO device upon initialization.</td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the memory instance to be associated with the FIFO device upon initialization.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>BaseAddress</em>&nbsp;</td><td>is the processor address used to access the base address of the Fifo device.</td></tr> <tr><td valign="top"></td><td valign="top"><em>BaseAddress</em>&nbsp;</td><td>is the processor address used to access the base address of the Fifo device.</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd>N/A </dd></dl> <dl class="return"><dt><b>Returns:</b></dt><dd>N/A </dd></dl>
</td>
</tr> </div>
</table> </div>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <a class="anchor" id="a18bc620d388cbca83d63cc1c6ef33225"></a><!-- doxytag: member="xllfifo.c::XLlFifo_iRead_Aligned" ref="a18bc620d388cbca83d63cc1c6ef33225" args="(XLlFifo *InstancePtr, void *BufPtr, unsigned WordCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XLlFifo_iRead_Aligned </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>BufPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>WordCount</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aad292ddf2a2c9dde261b93da802c8080"></a><!-- doxytag: member="xllfifo.c::XLlFifo_iRxGetLen" ref="aad292ddf2a2c9dde261b93da802c8080" args="(XLlFifo *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XLlFifo_iRxGetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa49ecc1529434fd932d8a65d63a1a04d"></a><!-- doxytag: member="xllfifo.c::XLlFifo_iTxSetLen" ref="aa49ecc1529434fd932d8a65d63a1a04d" args="(XLlFifo *InstancePtr, u32 Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XLlFifo_iTxSetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac02405b23499d780e7bc1dfe371281a6"></a><!-- doxytag: member="xllfifo.c::XLlFifo_iTxVacancy" ref="ac02405b23499d780e7bc1dfe371281a6" args="(XLlFifo *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XLlFifo_iTxVacancy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9be5556d593980195e43a31ffb37e0fe"></a><!-- doxytag: member="xllfifo.c::XLlFifo_iWrite_Aligned" ref="a9be5556d593980195e43a31ffb37e0fe" args="(XLlFifo *InstancePtr, void *BufPtr, unsigned WordCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XLlFifo_iWrite_Aligned </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>BufPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>WordCount</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aed3ae31c8c24f46139fbd709027329ec"></a><!-- doxytag: member="xllfifo.c::XLlFifo_RxGetWord" ref="aed3ae31c8c24f46139fbd709027329ec" args="(XLlFifo *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XLlFifo_RxGetWord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a29654d755dce84b861022179c99ca7a3"></a><!-- doxytag: member="xllfifo.c::XLlFifo_TxPutWord" ref="a29654d755dce84b861022179c99ca7a3" args="(XLlFifo *InstancePtr, u32 Word)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XLlFifo_TxPutWord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Word</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

940
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/xllfifo_8h.html Executable file
View file

@ -0,0 +1,940 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: xllfifo.h File Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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>xllfifo.h File Reference</h1><code>#include &quot;<a class="el" href="xstreamer_8h.html">xstreamer.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="xllfifo__hw_8h.html">xllfifo_hw.h</a>&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#ae7e2d915a0bab3a686ef155a6523690c">XLLFIFO_H</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#ace8f47c03f1818797c152cb27296df7c">XLlFifo_Reset</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a095f3e0f8571dc02959852e38237f23e">XLlFifo_Status</a>(InstancePtr)&nbsp;&nbsp;&nbsp;XLlFifo_ReadReg((InstancePtr)-&gt;BaseAddress, XLLF_ISR_OFFSET)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#ae65ece5c6c9cce1ccdcf9d404fd8f463">XLlFifo_IntEnable</a>(InstancePtr, Mask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#abff8f5ef31f09865808da90055e29d42">XLlFifo_IntDisable</a>(InstancePtr, Mask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#ac356d3e8d55aa6e82753400f0bd026a1">XLlFifo_IntPending</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#ac712eea89e9d7fa37d095003c927c61e">XLlFifo_IntClear</a>(InstancePtr, Mask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#af3739a78b92f17cead0d831757b3a134">XLlFifo_RxReset</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#aba876eb888126638848fb2f89a9b4436">XLlFifo_IsRxEmpty</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a12da547aa1c9a85e2b0b151f438ff9d5">XLlFifo_RxOccupancy</a>(InstancePtr)&nbsp;&nbsp;&nbsp;XStrm_RxOccupancy(&amp;((InstancePtr)-&gt;RxStreamer))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a53af32ae6901462cc8d6fb9adc04655e">XLlFifo_RxGetLen</a>(InstancePtr)&nbsp;&nbsp;&nbsp;XStrm_RxGetLen(&amp;((InstancePtr)-&gt;RxStreamer))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#aadc3685592b060c0d864850e86be5c03">XLlFifo_Read</a>(InstancePtr, BufPtr, Bytes)&nbsp;&nbsp;&nbsp;XStrm_Read(&amp;((InstancePtr)-&gt;RxStreamer), (BufPtr), (Bytes))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a922419fdcd342fa709fb07ec1a9e5577">XLlFifo_TxReset</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a869bc4c1072da021e747a0a179bfe2da">XLlFifo_IsTxDone</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a556524c17aee71ae8407540a5e2cd65f">XLlFifo_IsRxDone</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#af2884c49ae41dc5c5317c2ef6df45a28">XLlFifo_TxVacancy</a>(InstancePtr)&nbsp;&nbsp;&nbsp;XStrm_TxVacancy(&amp;((InstancePtr)-&gt;TxStreamer))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#acd09ed5189e0b85994901102655964f7">XLlFifo_TxSetLen</a>(InstancePtr, Bytes)&nbsp;&nbsp;&nbsp;XStrm_TxSetLen(&amp;((InstancePtr)-&gt;TxStreamer), (Bytes))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a1fa93f486abaaf35c7d599a8cd91b295">XLlFifo_Write</a>(InstancePtr, BufPtr, Bytes)&nbsp;&nbsp;&nbsp;XStrm_Write(&amp;((InstancePtr)-&gt;TxStreamer), (BufPtr), (Bytes))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a105828f79f13c07d571db218c5837fae">XLlFifo_WriteTdr</a>(InstancePtr, Tdest)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a59307ef23e5b4b71d0d01cef8e06e247">XLlFifo_ReadRdr</a>(InstancePtr)&nbsp;&nbsp;&nbsp;XLlFifo_ReadReg((InstancePtr)-&gt;BaseAddress, XLLF_RDR_OFFSET)</td></tr>
<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="xllfifo_8h.html#adc1db2785627a0d8da46dc60990889a0">XLlFifo_CfgInitialize</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, <a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a> *Config, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a1fdf07ca198f5cfe2dc14ced21e5631d">XLlFifo_Initialize</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, u32 BaseAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#adeafd207ee98a329f48eea9769b0994d">XLlFfio_LookupConfig</a> (u32 DeviceId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#ae2da9fa947a6e50edd41375ddc4c9964">XLlFifo_iRxOccupancy</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#aad292ddf2a2c9dde261b93da802c8080">XLlFifo_iRxGetLen</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#ac02405b23499d780e7bc1dfe371281a6">XLlFifo_iTxVacancy</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#aa49ecc1529434fd932d8a65d63a1a04d">XLlFifo_iTxSetLen</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, u32 Bytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#aed3ae31c8c24f46139fbd709027329ec">XLlFifo_RxGetWord</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo_8h.html#a29654d755dce84b861022179c99ca7a3">XLlFifo_TxPutWord</a> (<a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *InstancePtr, u32 Word)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ae7e2d915a0bab3a686ef155a6523690c"></a><!-- doxytag: member="xllfifo.h::XLLFIFO_H" ref="ae7e2d915a0bab3a686ef155a6523690c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLLFIFO_H</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac712eea89e9d7fa37d095003c927c61e"></a><!-- doxytag: member="xllfifo.h::XLlFifo_IntClear" ref="ac712eea89e9d7fa37d095003c927c61e" args="(InstancePtr, Mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_IntClear</td>
<td>(</td>
<td class="paramtype">InstancePtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Mask&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xllfifo__hw_8h.html#acd283ce73981f7f9eab94f8bb421bc78">XLlFifo_WriteReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#a90a5fafb06870a7ff8043d3a34bf54cc">XLLF_ISR_OFFSET</a>, \
((Mask) &amp; <a class="code" href="xllfifo__hw_8h.html#ae3bfcad24428233d9e2a8a861e2d9eed">XLLF_INT_ALL_MASK</a>))
</pre></div><p>XLlFifo_IntClear clears pending interrupts specified in <em>Mask</em> for the FIFO specified by <em>InstancePtr</em>. The corresponding pending interrupt for each bit set to 1 in <em>Mask</em>, will be cleared. In other words, XLlFifo_IntClear uses the "set a bit to clear it" scheme.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Mask</em>&nbsp;</td><td>contains a bit mask of the pending interrupts to clear. The mask can be formed using a set of bitwise or'd values from the <code>XLLF_INT_*_MASK</code> preprocessor symbols.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xllfifo_8h.html#ac712eea89e9d7fa37d095003c927c61e">XLlFifo_IntClear(XLlFifo *InstancePtr, u32 Mask)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abff8f5ef31f09865808da90055e29d42"></a><!-- doxytag: member="xllfifo.h::XLlFifo_IntDisable" ref="abff8f5ef31f09865808da90055e29d42" args="(InstancePtr, Mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_IntDisable</td>
<td>(</td>
<td class="paramtype">InstancePtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Mask&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">{ \
u32 Reg = <a class="code" href="xllfifo__hw_8h.html#a7526eab563fa4e0fe8b60474e96afe55">XLlFifo_ReadReg</a>((InstancePtr)-&gt;BaseAddress, \
<a class="code" href="xllfifo__hw_8h.html#ac34e090e52a9ef5cdf4337cae6ca717c">XLLF_IER_OFFSET</a>); \
Reg &amp;= ~((Mask) &amp; <a class="code" href="xllfifo__hw_8h.html#ae3bfcad24428233d9e2a8a861e2d9eed">XLLF_INT_ALL_MASK</a>); \
<a class="code" href="xllfifo__hw_8h.html#acd283ce73981f7f9eab94f8bb421bc78">XLlFifo_WriteReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#ac34e090e52a9ef5cdf4337cae6ca717c">XLLF_IER_OFFSET</a>, \
Reg); \
}
</pre></div><p>XLlFifo_IntDisable disables the interrupts specified in <em>Mask</em> for the FIFO specified by <em>InstancePtr</em>. The corresponding interrupt for each bit set to 1 in <em>Mask</em>, will be disabled. In other words, XLlFifo_IntDisable uses the "set a bit to clear it" scheme.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Mask</em>&nbsp;</td><td>contains a bit mask of the interrupts to disable. The mask can be formed using a set of bitwise or'd values from the <code>XLLF_INT_*_MASK</code> preprocessor symbols.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xllfifo_8h.html#abff8f5ef31f09865808da90055e29d42">XLlFifo_IntDisable(XLlFifo *InstancePtr, u32 Mask)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae65ece5c6c9cce1ccdcf9d404fd8f463"></a><!-- doxytag: member="xllfifo.h::XLlFifo_IntEnable" ref="ae65ece5c6c9cce1ccdcf9d404fd8f463" args="(InstancePtr, Mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_IntEnable</td>
<td>(</td>
<td class="paramtype">InstancePtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Mask&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">{ \
u32 Reg = <a class="code" href="xllfifo__hw_8h.html#a7526eab563fa4e0fe8b60474e96afe55">XLlFifo_ReadReg</a>((InstancePtr)-&gt;BaseAddress, \
<a class="code" href="xllfifo__hw_8h.html#ac34e090e52a9ef5cdf4337cae6ca717c">XLLF_IER_OFFSET</a>); \
Reg |= ((Mask) &amp; <a class="code" href="xllfifo__hw_8h.html#ae3bfcad24428233d9e2a8a861e2d9eed">XLLF_INT_ALL_MASK</a>); \
<a class="code" href="xllfifo__hw_8h.html#acd283ce73981f7f9eab94f8bb421bc78">XLlFifo_WriteReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#ac34e090e52a9ef5cdf4337cae6ca717c">XLLF_IER_OFFSET</a>, \
Reg); \
}
</pre></div><p>XLlFifo_IntEnable enables the interrupts specified in <em>Mask</em> for the FIFO specified by <em>InstancePtr</em>. The corresponding interrupt for each bit set to 1 in <em>Mask</em>, will be enabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Mask</em>&nbsp;</td><td>contains a bit mask of the interrupts to enable. The mask can be formed using a set of bitwise or'd values from the <code>XLLF_INT_*_MASK</code> preprocessor symbols.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xllfifo_8h.html#ae65ece5c6c9cce1ccdcf9d404fd8f463">XLlFifo_IntEnable(XLlFifo *InstancePtr, u32 Mask)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac356d3e8d55aa6e82753400f0bd026a1"></a><!-- doxytag: member="xllfifo.h::XLlFifo_IntPending" ref="ac356d3e8d55aa6e82753400f0bd026a1" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_IntPending</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xllfifo__hw_8h.html#a7526eab563fa4e0fe8b60474e96afe55">XLlFifo_ReadReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#ac34e090e52a9ef5cdf4337cae6ca717c">XLLF_IER_OFFSET</a>) &amp; \
<a class="code" href="xllfifo__hw_8h.html#a7526eab563fa4e0fe8b60474e96afe55">XLlFifo_ReadReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#a90a5fafb06870a7ff8043d3a34bf54cc">XLLF_ISR_OFFSET</a>))
</pre></div><p>XLlFifo_IntPending returns a bit mask of the pending interrupts for the FIFO specified by <em>InstancePtr</em>. Each bit set to 1 in the return value represents a pending interrupt.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>XLlFifo_IntPending returns a bit mask of the interrupts that are pending. The mask will be a set of bitwise or'd values from the <code>XLLF_INT_*_MASK</code> preprocessor symbols.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xllfifo_8h.html#ac356d3e8d55aa6e82753400f0bd026a1">XLlFifo_IntPending(XLlFifo *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a556524c17aee71ae8407540a5e2cd65f"></a><!-- doxytag: member="xllfifo.h::XLlFifo_IsRxDone" ref="a556524c17aee71ae8407540a5e2cd65f" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_IsRxDone</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xllfifo__hw_8h.html#a7526eab563fa4e0fe8b60474e96afe55">XLlFifo_ReadReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#a90a5fafb06870a7ff8043d3a34bf54cc">XLLF_ISR_OFFSET</a>) &amp; \
<a class="code" href="xllfifo__hw_8h.html#a838f0b2d56bffea01160c141b0c1de67">XLLF_INT_RC_MASK</a>) \
? TRUE : FALSE)
</pre></div><p>XLlFifo_IsRxDone returns true if the reception in the receive channel of the FIFO, specified by <em>InstancePtr</em>, is complete. XLlFifo_IsRxDone works only if the RC bit in the ISR register is cleared before receiving a frame.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>XLlFifo_IsRxDone returns TRUE when the receive channel of the FIFO is complete. Otherwise, XLlFifo_IsRxDone returns FALSE.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: int <a class="el" href="xllfifo_8h.html#a556524c17aee71ae8407540a5e2cd65f">XLlFifo_IsRxDone(XLlFifo *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aba876eb888126638848fb2f89a9b4436"></a><!-- doxytag: member="xllfifo.h::XLlFifo_IsRxEmpty" ref="aba876eb888126638848fb2f89a9b4436" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_IsRxEmpty</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xllfifo__hw_8h.html#a7526eab563fa4e0fe8b60474e96afe55">XLlFifo_ReadReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#a9c4bbf51bc4b0410b61ef3933776a63c">XLLF_RDFO_OFFSET</a>) == 0) \
? TRUE : FALSE)
</pre></div><p>XLlFifo_IsRxEmpty returns true if the receive channel of the FIFO, specified by <em>InstancePtr</em>, is empty.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>XLlFifo_IsRxEmpty returns TRUE when the receive channel of the FIFO is empty. Otherwise, XLlFifo_IsRxEmpty returns FALSE.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: int <a class="el" href="xllfifo_8h.html#aba876eb888126638848fb2f89a9b4436">XLlFifo_IsRxEmpty(XLlFifo *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a869bc4c1072da021e747a0a179bfe2da"></a><!-- doxytag: member="xllfifo.h::XLlFifo_IsTxDone" ref="a869bc4c1072da021e747a0a179bfe2da" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_IsTxDone</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xllfifo__hw_8h.html#a7526eab563fa4e0fe8b60474e96afe55">XLlFifo_ReadReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#a90a5fafb06870a7ff8043d3a34bf54cc">XLLF_ISR_OFFSET</a>) &amp; \
<a class="code" href="xllfifo__hw_8h.html#abca5de4c7fc02bcad56912a2919319ae">XLLF_INT_TC_MASK</a>) \
? TRUE : FALSE)
</pre></div><p>XLlFifo_IsTxDone returns true if the transmission in the transmit channel of the FIFO, specified by <em>InstancePtr</em>, is complete. XLlFifo_IsTxDone works only if the TC bit in the IS register is cleared before sending a frame.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>XLlFifo_IsTxDone returns TRUE when the transmit channel of the FIFO is complete. Otherwise, XLlFifo_IsTxDone returns FALSE.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: int <a class="el" href="xllfifo_8h.html#a869bc4c1072da021e747a0a179bfe2da">XLlFifo_IsTxDone(XLlFifo *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aadc3685592b060c0d864850e86be5c03"></a><!-- doxytag: member="xllfifo.h::XLlFifo_Read" ref="aadc3685592b060c0d864850e86be5c03" args="(InstancePtr, BufPtr, Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_Read</td>
<td>(</td>
<td class="paramtype">InstancePtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BufPtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Bytes&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;XStrm_Read(&amp;((InstancePtr)-&gt;RxStreamer), (BufPtr), (Bytes))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_Read reads <em>Bytes</em> bytes from the receive channel of the FIFO referenced by <em>InstancePtr</em> to the block of memory, referenced by <em>BufPtr</em>.</p>
<p>Care must be taken to ensure that the number of bytes read with one or more calls to <a class="el" href="xllfifo_8h.html#aadc3685592b060c0d864850e86be5c03">XLlFifo_Read()</a> does not exceed the number of bytes available given from the last call to <a class="el" href="xllfifo_8h.html#a53af32ae6901462cc8d6fb9adc04655e">XLlFifo_RxGetLen()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>BufPtr</em>&nbsp;</td><td>specifies the memory address to place the data read.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Bytes</em>&nbsp;</td><td>specifies the number of bytes to read.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Error handling is handled through hardware exceptions and interrupts.</dd></dl>
<p>C Signature: void <a class="el" href="xllfifo_8h.html#aadc3685592b060c0d864850e86be5c03">XLlFifo_Read(XLlFifo *InstancePtr, void *BufPtr, unsigned Bytes)</a> </p>
</div>
</div>
<a class="anchor" id="a59307ef23e5b4b71d0d01cef8e06e247"></a><!-- doxytag: member="xllfifo.h::XLlFifo_ReadRdr" ref="a59307ef23e5b4b71d0d01cef8e06e247" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_ReadRdr</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;XLlFifo_ReadReg((InstancePtr)-&gt;BaseAddress, XLLF_RDR_OFFSET)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_ReadTdr returns the contents of the Receive Destination Register(RDR).</p>
<p>The RDR contains destination address corresponding to the valid packet that is received. The RDR should only be read when a receive packet is available for processing (the receive occupancy is not zero). Once the RDR is read, the receive packet data should be read from the receive data FIFO before the RDR is read again. The RDR values are stored in the receive data FIFO by the AXI4-Stream FIFO core with the data of each packet. The RDR value for the subsequent packet to be processed is moved to the RDR when the previous RDR value has been read.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The Receive Destination address read from the RDR.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C Signature: u32 <a class="el" href="xllfifo_8h.html#a59307ef23e5b4b71d0d01cef8e06e247">XLlFifo_ReadRdr(XLlFifo *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ace8f47c03f1818797c152cb27296df7c"></a><!-- doxytag: member="xllfifo.h::XLlFifo_Reset" ref="ace8f47c03f1818797c152cb27296df7c" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_Reset</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xllfifo__hw_8h.html#acd283ce73981f7f9eab94f8bb421bc78">XLlFifo_WriteReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#a5331d2736e9b1b516b4262d8e3f11690">XLLF_LLR_OFFSET</a>, \
<a class="code" href="xllfifo__hw_8h.html#ad8b59856939038963e68acf4e2e2c47c">XLLF_LLR_RESET_MASK</a>)
</pre></div><p>XLlFifo_Reset resets both the Tx and Rx channels and the local link interface the FIFO specified by <em>InstancePtr</em>. XLlFifo_TxReset resets also sends a reset pulse to the downstream device (e.g. TEMAC). XLlFifo_Reset drops any bytes in the FIFO not yet retrieved. XLlFifo_Reset drops any bytes in the FIFO not yet transmitted.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xllfifo_8h.html#ace8f47c03f1818797c152cb27296df7c">XLlFifo_Reset(XLlFifo *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a53af32ae6901462cc8d6fb9adc04655e"></a><!-- doxytag: member="xllfifo.h::XLlFifo_RxGetLen" ref="a53af32ae6901462cc8d6fb9adc04655e" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_RxGetLen</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;XStrm_RxGetLen(&amp;((InstancePtr)-&gt;RxStreamer))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_RxGetLen notifies the hardware that the program is ready to receive the next frame from the receive channel of the FIFO, specified by <em>InstancePtr</em>.</p>
<p>Note that the program must first call XLlFifo_RxGetLen before pulling data out of the receive channel of the FIFO with XLlFifo_Read.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>XLlFifo_RxGetLen returns the number of bytes available in the next frame.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
<p>C Signature: u32 <a class="el" href="xllfifo_8h.html#a53af32ae6901462cc8d6fb9adc04655e">XLlFifo_RxGetLen(XLlFifo *InstancePtr)</a> </p>
</div>
</div>
<a class="anchor" id="a12da547aa1c9a85e2b0b151f438ff9d5"></a><!-- doxytag: member="xllfifo.h::XLlFifo_RxOccupancy" ref="a12da547aa1c9a85e2b0b151f438ff9d5" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_RxOccupancy</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;XStrm_RxOccupancy(&amp;((InstancePtr)-&gt;RxStreamer))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_RxOccupancy returns the number of 32-bit words available (occupancy) to be read from the receive channel of the FIFO, specified by <em>InstancePtr</em>.</p>
<p>The xps_ll_fifo core uses the same fifo to store data values and frame length values. Upon initialization, the XLlFifo_RxOccupancy will give the value of 1, which means one length value (a reserved fifo location) and no data values.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>XLlFifo_RxOccupancy returns the occupancy count for the specified packet FIFO.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
<p>C Signature: u32 <a class="el" href="xllfifo_8h.html#a12da547aa1c9a85e2b0b151f438ff9d5">XLlFifo_RxOccupancy(XLlFifo *InstancePtr)</a> </p>
</div>
</div>
<a class="anchor" id="af3739a78b92f17cead0d831757b3a134"></a><!-- doxytag: member="xllfifo.h::XLlFifo_RxReset" ref="af3739a78b92f17cead0d831757b3a134" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_RxReset</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xllfifo__hw_8h.html#acd283ce73981f7f9eab94f8bb421bc78">XLlFifo_WriteReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#ae1533e466df30729597a1b44ed1059ed">XLLF_RDFR_OFFSET</a>, \
<a class="code" href="xllfifo__hw_8h.html#a11c4da53ae9b166832186f9a817fba6d">XLLF_RDFR_RESET_MASK</a>)
</pre></div><p>XLlFifo_RxReset resets the receive channel of the FIFO specified by <em>InstancePtr</em>. XLlFifo_RxReset drops any bytes in the FIFO not yet retrieved.</p>
<p>The calling software may want to test for the completion of the reset by reading the interrupt status (IS) register and testing for the Rx Reset complete (RRC) bit.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xllfifo_8h.html#af3739a78b92f17cead0d831757b3a134">XLlFifo_RxReset(XLlFifo *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a095f3e0f8571dc02959852e38237f23e"></a><!-- doxytag: member="xllfifo.h::XLlFifo_Status" ref="a095f3e0f8571dc02959852e38237f23e" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_Status</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;XLlFifo_ReadReg((InstancePtr)-&gt;BaseAddress, XLLF_ISR_OFFSET)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_Status returns a bit mask of the interrupt status register (ISR) for the FIFO specified by <em>InstancePtr</em>. XLlFifo_Status can be used to query the status of the FIFO without having to have interrupts enabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>XLlFifo_IntStatus returns a bit mask of the status conditions. The mask will be a set of bitwise or'd values from the <code>XLLF_INT_*_MASK</code> preprocessor symbols.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 XLlFifo_IntStatus(XLlFifo *InstancePtr) </dd></dl>
</div>
</div>
<a class="anchor" id="a922419fdcd342fa709fb07ec1a9e5577"></a><!-- doxytag: member="xllfifo.h::XLlFifo_TxReset" ref="a922419fdcd342fa709fb07ec1a9e5577" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_TxReset</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xllfifo__hw_8h.html#acd283ce73981f7f9eab94f8bb421bc78">XLlFifo_WriteReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#aa55be9e9452783cde92cd70a33e31e56">XLLF_TDFR_OFFSET</a>, \
<a class="code" href="xllfifo__hw_8h.html#af7b4bcf41280c1fb01684b6706603420">XLLF_TDFR_RESET_MASK</a>)
</pre></div><p>XLlFifo_TxReset resets the transmit channel of the FIFO specified by <em>InstancePtr</em>. XLlFifo_TxReset drops any bytes in the FIFO not yet transmitted.</p>
<p>The calling software may want to test for the completion of the reset by reading the interrupt status (IS) register and testing for the Tx Reset complete (TRC) bit.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xllfifo_8h.html#a922419fdcd342fa709fb07ec1a9e5577">XLlFifo_TxReset(XLlFifo *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="acd09ed5189e0b85994901102655964f7"></a><!-- doxytag: member="xllfifo.h::XLlFifo_TxSetLen" ref="acd09ed5189e0b85994901102655964f7" args="(InstancePtr, Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_TxSetLen</td>
<td>(</td>
<td class="paramtype">InstancePtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Bytes&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;XStrm_TxSetLen(&amp;((InstancePtr)-&gt;TxStreamer), (Bytes))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_TxSetLen begins a hardware transfer of <em>Bytes</em> bytes out of the transmit channel of the FIFO specified by <em>InstancePtr</em>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Bytes</em>&nbsp;</td><td>specifies the frame length in bytes.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
<p>C Signature: void <a class="el" href="xllfifo_8h.html#acd09ed5189e0b85994901102655964f7">XLlFifo_TxSetLen(XLlFifo *InstancePtr, u32 Bytes)</a> </p>
</div>
</div>
<a class="anchor" id="af2884c49ae41dc5c5317c2ef6df45a28"></a><!-- doxytag: member="xllfifo.h::XLlFifo_TxVacancy" ref="af2884c49ae41dc5c5317c2ef6df45a28" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_TxVacancy</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;XStrm_TxVacancy(&amp;((InstancePtr)-&gt;TxStreamer))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_TxVacancy returns the number of unused 32 bit words available (vacancy) in the send channel of the FIFO specified by <em>InstancePtr</em>.</p>
<p>The xps_ll_fifo core uses tXLLF_he same fifo to store data values and frame length values. Upon initialization, the XLlFifo_TxVacancy will give the value of FIFO_WIDTH - 1, which means one length value used (a reserved fifo location) and no data values yet present.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>XLlFifo_TxVacancy returns the vacancy count in 32-bit words for the specified FIFO.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xllfifo_8h.html#af2884c49ae41dc5c5317c2ef6df45a28">XLlFifo_TxVacancy(XLlFifo *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1fa93f486abaaf35c7d599a8cd91b295"></a><!-- doxytag: member="xllfifo.h::XLlFifo_Write" ref="a1fa93f486abaaf35c7d599a8cd91b295" args="(InstancePtr, BufPtr, Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_Write</td>
<td>(</td>
<td class="paramtype">InstancePtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BufPtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Bytes&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;XStrm_Write(&amp;((InstancePtr)-&gt;TxStreamer), (BufPtr), (Bytes))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_Write writes <em>Bytes</em> bytes of the block of memory, referenced by <em>BufPtr</em>, to the transmit channel of the FIFO referenced by <em>InstancePtr</em>.</p>
<p>Care must be taken to ensure that the number of bytes written with one or more calls to <a class="el" href="xllfifo_8h.html#a1fa93f486abaaf35c7d599a8cd91b295">XLlFifo_Write()</a> matches the number of bytes given in the next call to <a class="el" href="xllfifo_8h.html#acd09ed5189e0b85994901102655964f7">XLlFifo_TxSetLen()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>BufPtr</em>&nbsp;</td><td>specifies the memory address of data to write.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Bytes</em>&nbsp;</td><td>specifies the number of bytes to write.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Error handling is handled through hardware exceptions and interrupts.</dd></dl>
<p>C Signature: void <a class="el" href="xllfifo_8h.html#a1fa93f486abaaf35c7d599a8cd91b295">XLlFifo_Write(XLlFifo *InstancePtr, void *BufPtr, unsigned Bytes)</a> </p>
</div>
</div>
<a class="anchor" id="a105828f79f13c07d571db218c5837fae"></a><!-- doxytag: member="xllfifo.h::XLlFifo_WriteTdr" ref="a105828f79f13c07d571db218c5837fae" args="(InstancePtr, Tdest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XLlFifo_WriteTdr</td>
<td>(</td>
<td class="paramtype">InstancePtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Tdest&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xllfifo__hw_8h.html#acd283ce73981f7f9eab94f8bb421bc78">XLlFifo_WriteReg</a>((InstancePtr)-&gt;BaseAddress, <a class="code" href="xllfifo__hw_8h.html#a5c691ac1237fb77b8e356a7d2b0b8b54">XLLF_TDR_OFFSET</a>, \
Tdest &amp; 0xF)
</pre></div><p>XLlFifo_WriteTdr writes to the Transmit Destination Register (TDR)</p>
<p>The TDR stores the destination address corresponding to the packet to be transmitted. When presenting a transmit packet to the AXI4-Stream FIFO core the following sequence should be followed</p>
<ul>
<li>Write the destination address into TDR first,</li>
<li>Write the packet data to the Transmit Data FIFO next</li>
<li>Write the length of the packet into the Transmit Length Register.</li>
</ul>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the FIFO on which to operate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Tdest</em>&nbsp;</td><td>is the Transmit Destination address to be written to TDR.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C Signature: void <a class="el" href="xllfifo_8h.html#a105828f79f13c07d571db218c5837fae">XLlFifo_WriteTdr(XLlFifo *InstancePtr, u32 Tdest)</a>; </dd></dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="adeafd207ee98a329f48eea9769b0994d"></a><!-- doxytag: member="xllfifo.h::XLlFfio_LookupConfig" ref="adeafd207ee98a329f48eea9769b0994d" args="(u32 DeviceId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a>* XLlFfio_LookupConfig </td>
<td>(</td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>DeviceId</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Look up the hardware configuration for a device 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>DeviceId</em>&nbsp;</td><td>is the unique device ID of the device to lookup for</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The configuration structure for the device. If the device ID is not found,a NULL pointer is returned.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="adc1db2785627a0d8da46dc60990889a0"></a><!-- doxytag: member="xllfifo.h::XLlFifo_CfgInitialize" ref="adc1db2785627a0d8da46dc60990889a0" args="(XLlFifo *InstancePtr, XLlFifo_Config *Config, u32 EffectiveAddress)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XLlFifo_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a> *&nbsp;</td>
<td class="paramname"> <em>Config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddress</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_CfgInitialize initializes an XPS_ll_Fifo device along with the <em>InstancePtr</em> that references it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the Axi Streaming FIFO instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CfgPtr</em>&nbsp;</td><td>references the structure holding the hardware configuration for the Axi Streaming FIFO core to initialize. </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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A </dd></dl>
</div>
</div>
<a class="anchor" id="a1fdf07ca198f5cfe2dc14ced21e5631d"></a><!-- doxytag: member="xllfifo.h::XLlFifo_Initialize" ref="a1fdf07ca198f5cfe2dc14ced21e5631d" args="(XLlFifo *InstancePtr, u32 BaseAddress)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XLlFifo_Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>BaseAddress</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XLlFifo_Initialize initializes an XPS_ll_Fifo device along with the <em>InstancePtr</em> that references it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>references the memory instance to be associated with the FIFO device upon initialization.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>BaseAddress</em>&nbsp;</td><td>is the processor address used to access the base address of the Fifo device.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>N/A </dd></dl>
</div>
</div>
<a class="anchor" id="aad292ddf2a2c9dde261b93da802c8080"></a><!-- doxytag: member="xllfifo.h::XLlFifo_iRxGetLen" ref="aad292ddf2a2c9dde261b93da802c8080" args="(XLlFifo *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XLlFifo_iRxGetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae2da9fa947a6e50edd41375ddc4c9964"></a><!-- doxytag: member="xllfifo.h::XLlFifo_iRxOccupancy" ref="ae2da9fa947a6e50edd41375ddc4c9964" args="(XLlFifo *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XLlFifo_iRxOccupancy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa49ecc1529434fd932d8a65d63a1a04d"></a><!-- doxytag: member="xllfifo.h::XLlFifo_iTxSetLen" ref="aa49ecc1529434fd932d8a65d63a1a04d" args="(XLlFifo *InstancePtr, u32 Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XLlFifo_iTxSetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac02405b23499d780e7bc1dfe371281a6"></a><!-- doxytag: member="xllfifo.h::XLlFifo_iTxVacancy" ref="ac02405b23499d780e7bc1dfe371281a6" args="(XLlFifo *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XLlFifo_iTxVacancy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aed3ae31c8c24f46139fbd709027329ec"></a><!-- doxytag: member="xllfifo.h::XLlFifo_RxGetWord" ref="aed3ae31c8c24f46139fbd709027329ec" args="(XLlFifo *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XLlFifo_RxGetWord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a29654d755dce84b861022179c99ca7a3"></a><!-- doxytag: member="xllfifo.h::XLlFifo_TxPutWord" ref="a29654d755dce84b861022179c99ca7a3" args="(XLlFifo *InstancePtr, u32 Word)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XLlFifo_TxPutWord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_ll_fifo.html">XLlFifo</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Word</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

64
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/xllfifo__g_8c.html Executable file
View file

@ -0,0 +1,64 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: xllfifo_g.c File Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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>xllfifo_g.c File Reference</h1><code>#include &quot;xparameters.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="xllfifo_8h.html">xllfifo.h</a>&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo__g_8c.html#a8d8699cda15349615b0a3073547ff70b">XLlFifo_ConfigTable</a> []</td></tr>
</table>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="a8d8699cda15349615b0a3073547ff70b"></a><!-- doxytag: member="xllfifo_g.c::XLlFifo_ConfigTable" ref="a8d8699cda15349615b0a3073547ff70b" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a> <a class="el" href="xllfifo__g_8c.html#a8d8699cda15349615b0a3073547ff70b">XLlFifo_ConfigTable</a>[]</td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment">
{
{
XPAR_AXI_FIFO_MM_S_1_DEVICE_ID,
XPAR_AXI_FIFO_MM_S_1_BASEADDR,
XPAR_AXI_FIFO_MM_S_1_AXI4_BASEADDR,
XPAR_AXI_FIFO_MM_S_1_DATA_INTERFACE_TYPE
}
}
</pre></div>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

1369
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/xllfifo__hw_8h.html
View file

File diff suppressed because it is too large Load diff

69
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/xllfifo__sinit_8c.html Executable file
View file

@ -0,0 +1,69 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: xllfifo_sinit.c File Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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>xllfifo_sinit.c File Reference</h1><code>#include &quot;xparameters.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="xllfifo_8h.html">xllfifo.h</a>&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"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xllfifo__sinit_8c.html#adeafd207ee98a329f48eea9769b0994d">XLlFfio_LookupConfig</a> (u32 DeviceId)</td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="adeafd207ee98a329f48eea9769b0994d"></a><!-- doxytag: member="xllfifo_sinit.c::XLlFfio_LookupConfig" ref="adeafd207ee98a329f48eea9769b0994d" args="(u32 DeviceId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_ll_fifo___config.html">XLlFifo_Config</a>* XLlFfio_LookupConfig </td>
<td>(</td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>DeviceId</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Look up the hardware configuration for a device 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>DeviceId</em>&nbsp;</td><td>is the unique device ID of the device to lookup for</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The configuration structure for the device. If the device ID is not found,a NULL pointer is returned.</dd></dl>
<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>

253
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/xstreamer_8c.html Executable file
View file

@ -0,0 +1,253 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: xstreamer.c File Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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>xstreamer.c File Reference</h1><code>#include &quot;<a class="el" href="xstreamer_8h.html">xstreamer.h</a>&quot;</code><br/>
<code>#include &quot;xil_assert.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#abb702d8b501669a23aa0ab3b281b9384">min</a>(x, y)&nbsp;&nbsp;&nbsp;(((x) &lt; (y)) ? (x) : (y))</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#af522443c3d427ece2a8ce4e2231eca29">xdbg_stmnt</a> (u32 _xstrm_ro_value;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a8a67c77f811a505b658e06642eb9c964">XStrm_TxInitialize</a> (<a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *InstancePtr, unsigned FifoWidth, void *FifoInstance, <a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a> WriteFn, <a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a> SetLenFn, <a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a> GetVacancyFn)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a479d2eb3193ad0a5efc3c3b432a78381">XStrm_RxGetLen</a> (<a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a915d68a9cce0f2464fc7644383cb887a">XStrm_Read</a> (<a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *InstancePtr, void *BufPtr, unsigned Bytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a1e99fb51e0cfab7d0e8de5e93c27fd9c">XStrm_TxSetLen</a> (<a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *InstancePtr, u32 Bytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8c.html#a1f43ea833af99162745ceef66849b666">XStrm_Write</a> (<a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *InstancePtr, void *BufPtr, unsigned Bytes)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="abb702d8b501669a23aa0ab3b281b9384"></a><!-- doxytag: member="xstreamer.c::min" ref="abb702d8b501669a23aa0ab3b281b9384" args="(x, y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define min</td>
<td>(</td>
<td class="paramtype">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">y&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;(((x) &lt; (y)) ? (x) : (y))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="af522443c3d427ece2a8ce4e2231eca29"></a><!-- doxytag: member="xstreamer.c::xdbg_stmnt" ref="af522443c3d427ece2a8ce4e2231eca29" args="(u32 _xstrm_ro_value;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xdbg_stmnt </td>
<td>(</td>
<td class="paramtype">u32 _xstrm_ro_value;&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a915d68a9cce0f2464fc7644383cb887a"></a><!-- doxytag: member="xstreamer.c::XStrm_Read" ref="a915d68a9cce0f2464fc7644383cb887a" args="(XStrm_RxFifoStreamer *InstancePtr, void *BufPtr, unsigned Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_Read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>BufPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>Bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a479d2eb3193ad0a5efc3c3b432a78381"></a><!-- doxytag: member="xstreamer.c::XStrm_RxGetLen" ref="a479d2eb3193ad0a5efc3c3b432a78381" args="(XStrm_RxFifoStreamer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XStrm_RxGetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8a67c77f811a505b658e06642eb9c964"></a><!-- doxytag: member="xstreamer.c::XStrm_TxInitialize" ref="a8a67c77f811a505b658e06642eb9c964" args="(XStrm_TxFifoStreamer *InstancePtr, unsigned FifoWidth, void *FifoInstance, XStrm_XferFnType WriteFn, XStrm_SetLenFnType SetLenFn, XStrm_GetVacancyFnType GetVacancyFn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_TxInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>FifoWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>FifoInstance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a>&nbsp;</td>
<td class="paramname"> <em>WriteFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a>&nbsp;</td>
<td class="paramname"> <em>SetLenFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a>&nbsp;</td>
<td class="paramname"> <em>GetVacancyFn</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1e99fb51e0cfab7d0e8de5e93c27fd9c"></a><!-- doxytag: member="xstreamer.c::XStrm_TxSetLen" ref="a1e99fb51e0cfab7d0e8de5e93c27fd9c" args="(XStrm_TxFifoStreamer *InstancePtr, u32 Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_TxSetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1f43ea833af99162745ceef66849b666"></a><!-- doxytag: member="xstreamer.c::XStrm_Write" ref="a1f43ea833af99162745ceef66849b666" args="(XStrm_TxFifoStreamer *InstancePtr, void *BufPtr, unsigned Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_Write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>BufPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>Bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

434
XilinxProcessorIPLib/drivers/llfifo/doc/html/api/xstreamer_8h.html Executable file
View file

@ -0,0 +1,434 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver llfifo v4_0: xstreamer.h File Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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>xstreamer.h File Reference</h1><code>#include &quot;xenv.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="xdebug_8h.html">xdebug.h</a>&quot;</code><br/>
<code>#include &quot;xil_types.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">union &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="union_x_strm___aligned_buffer_type.html">XStrm_AlignedBufferType</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#ab615f7de0f7b5b69b912da2f24c0f4b9">XSTREAMER_H</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a4a3e97b47b47ea3b883952f58cb9deb9">LARGEST_FIFO_KEYHOLE_SIZE_WORDS</a>&nbsp;&nbsp;&nbsp;4</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a7c2fa1c0b560f90b656aaac27721769c">XStrm_TxVacancy</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a52d6c5d159859cfcf8e43daf7d54ad07">XStrm_RxOccupancy</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a2357fcad0c03d6b706d5ad71c4d7b749">XStrm_IsRxInternalEmpty</a>(InstancePtr)&nbsp;&nbsp;&nbsp;(((InstancePtr)-&gt;FrmByteCnt == 0) ? TRUE : FALSE)</td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a> )(void *FifoInstance, void *BufPtr, unsigned WordCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef u32(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a967adc3a060d1799795857d4e1ab0397">XStrm_GetLenFnType</a> )(void *FifoInstance)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a> )(void *FifoInstance, u32 ByteCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef u32(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a63293ed02cfb43a6207cd1eb888a8a21">XStrm_GetOccupancyFnType</a> )(void *FifoInstance)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef u32(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a> )(void *FifoInstance)</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a52ec29cc3b758b6a2b857d883ac69d4a">XStrm_RxInitialize</a> (<a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *InstancePtr, unsigned FifoWidth, void *FifoInstance, <a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a> ReadFn, <a class="el" href="xstreamer_8h.html#a967adc3a060d1799795857d4e1ab0397">XStrm_GetLenFnType</a> GetLenFn, <a class="el" href="xstreamer_8h.html#a63293ed02cfb43a6207cd1eb888a8a21">XStrm_GetOccupancyFnType</a> GetOccupancyFn)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a8a67c77f811a505b658e06642eb9c964">XStrm_TxInitialize</a> (<a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *InstancePtr, unsigned FifoWidth, void *FifoInstance, <a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a> WriteFn, <a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a> SetLenFn, <a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a> GetVacancyFn)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a1e99fb51e0cfab7d0e8de5e93c27fd9c">XStrm_TxSetLen</a> (<a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *InstancePtr, u32 Bytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#abcdec1e8914d00b5f4c0e77425d15cbf">XStrm_Write</a> (<a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *InstancePtr, void *BufPtr, unsigned bytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a479d2eb3193ad0a5efc3c3b432a78381">XStrm_RxGetLen</a> (<a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xstreamer_8h.html#a214198a61d21fbbb252338c775ec4d34">XStrm_Read</a> (<a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *InstancePtr, void *BufPtr, unsigned bytes)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a4a3e97b47b47ea3b883952f58cb9deb9"></a><!-- doxytag: member="xstreamer.h::LARGEST_FIFO_KEYHOLE_SIZE_WORDS" ref="a4a3e97b47b47ea3b883952f58cb9deb9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LARGEST_FIFO_KEYHOLE_SIZE_WORDS&nbsp;&nbsp;&nbsp;4</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab615f7de0f7b5b69b912da2f24c0f4b9"></a><!-- doxytag: member="xstreamer.h::XSTREAMER_H" ref="ab615f7de0f7b5b69b912da2f24c0f4b9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XSTREAMER_H</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2357fcad0c03d6b706d5ad71c4d7b749"></a><!-- doxytag: member="xstreamer.h::XStrm_IsRxInternalEmpty" ref="a2357fcad0c03d6b706d5ad71c4d7b749" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XStrm_IsRxInternalEmpty</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;(((InstancePtr)-&gt;FrmByteCnt == 0) ? TRUE : FALSE)</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a52d6c5d159859cfcf8e43daf7d54ad07"></a><!-- doxytag: member="xstreamer.h::XStrm_RxOccupancy" ref="a52d6c5d159859cfcf8e43daf7d54ad07" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XStrm_RxOccupancy</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">( \
((*(InstancePtr)-&gt;GetOccupancyFn)((InstancePtr)-&gt;FifoInstance)) + \
( \
((InstancePtr)-&gt;FrmByteCnt) ? \
((InstancePtr)-&gt;FifoWidth - (InstancePtr)-&gt;HeadIndex) : \
0 \
) \
)
</pre></div>
</div>
</div>
<a class="anchor" id="a7c2fa1c0b560f90b656aaac27721769c"></a><!-- doxytag: member="xstreamer.h::XStrm_TxVacancy" ref="a7c2fa1c0b560f90b656aaac27721769c" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XStrm_TxVacancy</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">(((*(InstancePtr)-&gt;GetVacancyFn)((InstancePtr)-&gt;FifoInstance)) - \
(((InstancePtr)-&gt;TailIndex + 3) / 4))
</pre></div>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a967adc3a060d1799795857d4e1ab0397"></a><!-- doxytag: member="xstreamer.h::XStrm_GetLenFnType" ref="a967adc3a060d1799795857d4e1ab0397" args=")(void *FifoInstance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef u32(* <a class="el" href="xstreamer_8h.html#a967adc3a060d1799795857d4e1ab0397">XStrm_GetLenFnType</a>)(void *FifoInstance)</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a63293ed02cfb43a6207cd1eb888a8a21"></a><!-- doxytag: member="xstreamer.h::XStrm_GetOccupancyFnType" ref="a63293ed02cfb43a6207cd1eb888a8a21" args=")(void *FifoInstance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef u32(* <a class="el" href="xstreamer_8h.html#a63293ed02cfb43a6207cd1eb888a8a21">XStrm_GetOccupancyFnType</a>)(void *FifoInstance)</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a5f92d41a20196392c2f4f61ec8757e85"></a><!-- doxytag: member="xstreamer.h::XStrm_GetVacancyFnType" ref="a5f92d41a20196392c2f4f61ec8757e85" args=")(void *FifoInstance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef u32(* <a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a>)(void *FifoInstance)</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a353349b163baa3064b69277a3dbcb96c"></a><!-- doxytag: member="xstreamer.h::XStrm_SetLenFnType" ref="a353349b163baa3064b69277a3dbcb96c" args=")(void *FifoInstance, u32 ByteCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a>)(void *FifoInstance, u32 ByteCount)</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2b6ed316a48db32e9569b2ff8b992c4d"></a><!-- doxytag: member="xstreamer.h::XStrm_XferFnType" ref="a2b6ed316a48db32e9569b2ff8b992c4d" args=")(void *FifoInstance, void *BufPtr, unsigned WordCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* <a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a>)(void *FifoInstance, void *BufPtr, unsigned WordCount)</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a214198a61d21fbbb252338c775ec4d34"></a><!-- doxytag: member="xstreamer.h::XStrm_Read" ref="a214198a61d21fbbb252338c775ec4d34" args="(XStrm_RxFifoStreamer *InstancePtr, void *BufPtr, unsigned bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_Read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>BufPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a479d2eb3193ad0a5efc3c3b432a78381"></a><!-- doxytag: member="xstreamer.h::XStrm_RxGetLen" ref="a479d2eb3193ad0a5efc3c3b432a78381" args="(XStrm_RxFifoStreamer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XStrm_RxGetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a52ec29cc3b758b6a2b857d883ac69d4a"></a><!-- doxytag: member="xstreamer.h::XStrm_RxInitialize" ref="a52ec29cc3b758b6a2b857d883ac69d4a" args="(XStrm_RxFifoStreamer *InstancePtr, unsigned FifoWidth, void *FifoInstance, XStrm_XferFnType ReadFn, XStrm_GetLenFnType GetLenFn, XStrm_GetOccupancyFnType GetOccupancyFn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_RxInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___rx_fifo_streamer.html">XStrm_RxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>FifoWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>FifoInstance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a>&nbsp;</td>
<td class="paramname"> <em>ReadFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a967adc3a060d1799795857d4e1ab0397">XStrm_GetLenFnType</a>&nbsp;</td>
<td class="paramname"> <em>GetLenFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a63293ed02cfb43a6207cd1eb888a8a21">XStrm_GetOccupancyFnType</a>&nbsp;</td>
<td class="paramname"> <em>GetOccupancyFn</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8a67c77f811a505b658e06642eb9c964"></a><!-- doxytag: member="xstreamer.h::XStrm_TxInitialize" ref="a8a67c77f811a505b658e06642eb9c964" args="(XStrm_TxFifoStreamer *InstancePtr, unsigned FifoWidth, void *FifoInstance, XStrm_XferFnType WriteFn, XStrm_SetLenFnType SetLenFn, XStrm_GetVacancyFnType GetVacancyFn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_TxInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>FifoWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>FifoInstance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a2b6ed316a48db32e9569b2ff8b992c4d">XStrm_XferFnType</a>&nbsp;</td>
<td class="paramname"> <em>WriteFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a353349b163baa3064b69277a3dbcb96c">XStrm_SetLenFnType</a>&nbsp;</td>
<td class="paramname"> <em>SetLenFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xstreamer_8h.html#a5f92d41a20196392c2f4f61ec8757e85">XStrm_GetVacancyFnType</a>&nbsp;</td>
<td class="paramname"> <em>GetVacancyFn</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1e99fb51e0cfab7d0e8de5e93c27fd9c"></a><!-- doxytag: member="xstreamer.h::XStrm_TxSetLen" ref="a1e99fb51e0cfab7d0e8de5e93c27fd9c" args="(XStrm_TxFifoStreamer *InstancePtr, u32 Bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_TxSetLen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abcdec1e8914d00b5f4c0e77425d15cbf"></a><!-- doxytag: member="xstreamer.h::XStrm_Write" ref="abcdec1e8914d00b5f4c0e77425d15cbf" args="(XStrm_TxFifoStreamer *InstancePtr, void *BufPtr, unsigned bytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XStrm_Write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_strm___tx_fifo_streamer.html">XStrm_TxFifoStreamer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>BufPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&nbsp;</td>
<td class="paramname"> <em>bytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

41
XilinxProcessorIPLib/drivers/mbox/doc/html/api/annotated.html
View file

@ -2,27 +2,38 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class List Xilinx Driver mbox v4_0: Class List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li id="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<li class="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> <h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="struct_x_mbox.html">XMbox</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_mbox.html">XMbox</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td class="indexvalue"></td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

39
XilinxProcessorIPLib/drivers/mbox/doc/html/api/classes.html Executable file
View file

@ -0,0 +1,39 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver mbox v4_0: Alphabetical List
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class Index</h1><div class="qindex"><a class="qindex" href="#letter_X">X</a></div>
<table align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
<tr><td><a name="letter_X"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&nbsp;&nbsp;X&nbsp;&nbsp;</div></td></tr></table>
</td><td><a class="el" href="struct_x_mbox.html">XMbox</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a>&nbsp;&nbsp;&nbsp;</td></tr></table><div class="qindex"><a class="qindex" href="#letter_X">X</a></div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

44
XilinxProcessorIPLib/drivers/mbox/doc/html/api/files.html
View file

@ -2,29 +2,41 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
File Index Xilinx Driver mbox v4_0: File Index
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li id="current"><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table> <li class="current"><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>File List</h1>Here is a list of all files with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="xmbox_8c.html">xmbox.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xmbox_8c.html">xmbox.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xmbox_8h.html">xmbox.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xmbox__g_8c.html">xmbox_g.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xmbox__g_8c.html">xmbox_g.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xmbox__hw_8h.html">xmbox_hw.h</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xmbox__hw_8h.html">xmbox_hw.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xmbox__sinit_8c.html">xmbox_sinit.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xmbox__sinit_8c.html">xmbox_sinit.c</a></td><td class="indexvalue"></td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

83
XilinxProcessorIPLib/drivers/mbox/doc/html/api/functions.html
View file

@ -2,40 +2,63 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver mbox v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<ul> <li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<li id="current"><a href="functions.html"><span>All</span></a></li> </ul>
<li><a href="functions_vars.html"><span>Variables</span></a></li> </div>
</ul> <div class="tabs">
<ul>
<li class="current"><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
</div> </div>
Here is a list of all documented class members with links to the class documentation for each member: <div class="contents">
<p> Here is a list of all class members with links to the classes they belong to:<ul>
<ul>
<li>BaseAddress <li>BaseAddress
: <a class="el" href="struct_x_mbox___config.html#2fac08c24c8373333b9f2a62008c62f3">XMbox_Config</a><li>Config : <a class="el" href="struct_x_mbox___config.html#af0e602602db24b7b3b9494cb08abb927">XMbox_Config</a>
: <a class="el" href="struct_x_mbox.html#fa535ffb25e1fd20341652f9be21e06e">XMbox</a><li>DeviceId </li>
: <a class="el" href="struct_x_mbox___config.html#d0263c6cf0769cabc86cfe88226d204b">XMbox_Config</a><li>IsReady <li>Config
: <a class="el" href="struct_x_mbox.html#217c41df00b2eee11e1009f5e63905ed">XMbox</a><li>RecvID : <a class="el" href="struct_x_mbox.html#ada3e15b402bdd502048b69a87dfd70a8">XMbox</a>
: <a class="el" href="struct_x_mbox___config.html#993a0c797b79f93abc1b0229362c5f3b">XMbox_Config</a><li>SendID </li>
: <a class="el" href="struct_x_mbox___config.html#473e348d4102abcfda44499473119ede">XMbox_Config</a><li>UseFSL <li>DeviceId
: <a class="el" href="struct_x_mbox___config.html#0e3ae0f407ad9b60a4bd302aaa2607a8">XMbox_Config</a></ul> : <a class="el" href="struct_x_mbox___config.html#a8c1ef8d0a7976f0d4b358f8afbf7f48b">XMbox_Config</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
<li>IsReady
: <a class="el" href="struct_x_mbox.html#ac30a078abf5bafc3b3ff0559894f333f">XMbox</a>
</li>
<li>RecvID
: <a class="el" href="struct_x_mbox___config.html#a609445dac27b19ef129dd295fc252453">XMbox_Config</a>
</li>
<li>SendID
: <a class="el" href="struct_x_mbox___config.html#a9e08e69be2c504f49b76b7b992701e5f">XMbox_Config</a>
</li>
<li>UseFSL
: <a class="el" href="struct_x_mbox___config.html#ae59a7f14795bc768c36b105863e2efc8">XMbox_Config</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

83
XilinxProcessorIPLib/drivers/mbox/doc/html/api/functions_vars.html
View file

@ -2,40 +2,63 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members - Variables Xilinx Driver mbox v4_0: Class Members - Variables
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<ul> <li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<li><a href="functions.html"><span>All</span></a></li> </ul>
<li id="current"><a href="functions_vars.html"><span>Variables</span></a></li> </div>
</ul> <div class="tabs">
<ul>
<li><a href="functions.html"><span>All</span></a></li>
<li class="current"><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
</div> </div>
&nbsp; <div class="contents">
<p> &nbsp;<ul>
<ul>
<li>BaseAddress <li>BaseAddress
: <a class="el" href="struct_x_mbox___config.html#2fac08c24c8373333b9f2a62008c62f3">XMbox_Config</a><li>Config : <a class="el" href="struct_x_mbox___config.html#af0e602602db24b7b3b9494cb08abb927">XMbox_Config</a>
: <a class="el" href="struct_x_mbox.html#fa535ffb25e1fd20341652f9be21e06e">XMbox</a><li>DeviceId </li>
: <a class="el" href="struct_x_mbox___config.html#d0263c6cf0769cabc86cfe88226d204b">XMbox_Config</a><li>IsReady <li>Config
: <a class="el" href="struct_x_mbox.html#217c41df00b2eee11e1009f5e63905ed">XMbox</a><li>RecvID : <a class="el" href="struct_x_mbox.html#ada3e15b402bdd502048b69a87dfd70a8">XMbox</a>
: <a class="el" href="struct_x_mbox___config.html#993a0c797b79f93abc1b0229362c5f3b">XMbox_Config</a><li>SendID </li>
: <a class="el" href="struct_x_mbox___config.html#473e348d4102abcfda44499473119ede">XMbox_Config</a><li>UseFSL <li>DeviceId
: <a class="el" href="struct_x_mbox___config.html#0e3ae0f407ad9b60a4bd302aaa2607a8">XMbox_Config</a></ul> : <a class="el" href="struct_x_mbox___config.html#a8c1ef8d0a7976f0d4b358f8afbf7f48b">XMbox_Config</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
<li>IsReady
: <a class="el" href="struct_x_mbox.html#ac30a078abf5bafc3b3ff0559894f333f">XMbox</a>
</li>
<li>RecvID
: <a class="el" href="struct_x_mbox___config.html#a609445dac27b19ef129dd295fc252453">XMbox_Config</a>
</li>
<li>SendID
: <a class="el" href="struct_x_mbox___config.html#a9e08e69be2c504f49b76b7b992701e5f">XMbox_Config</a>
</li>
<li>UseFSL
: <a class="el" href="struct_x_mbox___config.html#ae59a7f14795bc768c36b105863e2efc8">XMbox_Config</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

269
XilinxProcessorIPLib/drivers/mbox/doc/html/api/globals.html
View file

@ -2,80 +2,209 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver mbox v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_x">- x -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_x">- x -</a></h3><ul>
<li>XMB_ERROR_FIFO_EMPTY <li>XMB_ERROR_FIFO_EMPTY
: <a class="el" href="xmbox__hw_8h.html#4433691fc1d9723a1762ccd93abfdccb">xmbox_hw.h</a><li>XMB_ERROR_FIFO_FULL : <a class="el" href="xmbox__hw_8h.html#a1fc712eb56bcc330c46c5bfe3f3c1583">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#302a95787e205b0cfff4b2ca17bf4cca">xmbox_hw.h</a><li>XMB_ERROR_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#6d68a937dabf298978c8a73973abbc47">xmbox_hw.h</a><li>XMB_IE_REG_OFFSET <li>XMB_ERROR_FIFO_FULL
: <a class="el" href="xmbox__hw_8h.html#1e38fec2a51cccba61522506994de1cb">xmbox_hw.h</a><li>XMB_IP_REG_OFFSET : <a class="el" href="xmbox__hw_8h.html#a90d8c6add066bca7fc234e0908a2ab56">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#515b28e524d7bb1c2f72d5f42e0e6187">xmbox_hw.h</a><li>XMB_IS_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#750b579b89b494d4a747d4dd63304001">xmbox_hw.h</a><li>XMB_IX_ERR <li>XMB_ERROR_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#a88ff00c2f1304f39037f72f932916c8">xmbox_hw.h</a><li>XMB_IX_RTA : <a class="el" href="xmbox__hw_8h.html#a777c199c53e918c3cbb896187ce28914">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#cd3acbc8a38ae9770d142ceaba965849">xmbox_hw.h</a><li>XMB_IX_STA </li>
: <a class="el" href="xmbox__hw_8h.html#ad11082dd63b3730afa071df17019155">xmbox_hw.h</a><li>XMB_READ_REG_OFFSET <li>XMB_IE_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#7275d9f52811db090e851be413c62c05">xmbox_hw.h</a><li>XMB_RIT_REG_OFFSET : <a class="el" href="xmbox__hw_8h.html#a992a83c0e5454de142ae0110531e6116">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#595daf977d0d55380530d42ada68e622">xmbox_hw.h</a><li>XMB_SIT_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#dd64b8525f4eac09c8b9f0b88fc78878">xmbox_hw.h</a><li>XMB_STATUS_FIFO_EMPTY <li>XMB_IP_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#8fedd89e5ec3583a7797af8ebfdb529e">xmbox_hw.h</a><li>XMB_STATUS_FIFO_FULL : <a class="el" href="xmbox__hw_8h.html#a40250159d7755332fc0e4149b46985d7">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#653c371ab0f1fd4f6798f8c51be574db">xmbox_hw.h</a><li>XMB_STATUS_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#4ee23a3d2aca5433b3d330092df18cb0">xmbox_hw.h</a><li>XMB_STATUS_RTA <li>XMB_IS_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#b28f0c2edb3c0e202df742ea0d7202d3">xmbox_hw.h</a><li>XMB_STATUS_STA : <a class="el" href="xmbox__hw_8h.html#a24776289ecaec70de8722b0d4e34db6f">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#f125596a84554053e7176296547d0ca2">xmbox_hw.h</a><li>XMB_WRITE_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#10c44462e85c10947d3f3b3378965529">xmbox_hw.h</a><li>XMbox_CfgInitialize() <li>XMB_IX_ERR
: <a class="el" href="xmbox_8c.html#03167856611920557ccd189ebc9942e4">xmbox.c</a><li>XMbox_ClearInterrupt() : <a class="el" href="xmbox__hw_8h.html#ad879d5982bf753dcf27efc6bb8cca604">xmbox_hw.h</a>
: <a class="el" href="xmbox_8c.html#071b085ea3599cd6a1fb60acd270304e">xmbox.c</a><li>XMbox_Flush() </li>
: <a class="el" href="xmbox_8c.html#bb4866d110cafc17ae2f796d67555342">xmbox.c</a><li>XMbox_GetInterruptEnable() <li>XMB_IX_RTA
: <a class="el" href="xmbox_8c.html#86189b15b3be4d88b99c201f9afefaa6">xmbox.c</a><li>XMbox_GetInterruptStatus() : <a class="el" href="xmbox__hw_8h.html#ac4ca917f4f31be7e899e1adaa4c503aa">xmbox_hw.h</a>
: <a class="el" href="xmbox_8c.html#5238e5e07452d1f67fd73872aa68829a">xmbox.c</a><li>XMbox_GetStatus() </li>
: <a class="el" href="xmbox_8c.html#2eb8e80874c451ea3bc857131e69fcf9">xmbox.c</a><li>XMbox_IsEmpty() <li>XMB_IX_STA
: <a class="el" href="xmbox_8c.html#2944a536e30ffa972cccfb6629944e14">xmbox.c</a><li>XMbox_IsEmptyHw : <a class="el" href="xmbox__hw_8h.html#a03584ed8fe52cb5f04450bec96f00e51">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#66f05b684becb55adf0bfa57d9f9fc2c">xmbox_hw.h</a><li>XMbox_IsFull() </li>
: <a class="el" href="xmbox_8c.html#0033b5fdf52a30afa9bf44d804aab0c5">xmbox.c</a><li>XMbox_IsFullHw <li>XMB_READ_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#1e3284d4d66b15f0fd44e6eb8f7cc6b0">xmbox_hw.h</a><li>XMbox_Read() : <a class="el" href="xmbox__hw_8h.html#a3a1f7a91d465c1e6be224c7f73d8ecea">xmbox_hw.h</a>
: <a class="el" href="xmbox_8c.html#3a9fc221c6ba749d5d4157f2f7c71400">xmbox.c</a><li>XMbox_ReadBlocking() </li>
: <a class="el" href="xmbox_8c.html#50ed591178c351824dd96d676ee23412">xmbox.c</a><li>XMbox_ReadMBox <li>XMB_RIT_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#6adb2ab206b41b713e7348184473b2ae">xmbox_hw.h</a><li>XMbox_ReadReg : <a class="el" href="xmbox__hw_8h.html#ac1a7132725b8bd47cf0ddfa5e219a63a">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#7498da3346c504b21c64870802bff019">xmbox_hw.h</a><li>XMbox_SetInterruptEnable() </li>
: <a class="el" href="xmbox_8c.html#c460a83470911ffe10ef8acf0e5e4745">xmbox.c</a><li>XMbox_SetReceiveThreshold() <li>XMB_SIT_REG_OFFSET
: <a class="el" href="xmbox_8c.html#faaa97b523bfc0e4f88b53d0fab3e30b">xmbox.c</a><li>XMbox_SetSendThreshold() : <a class="el" href="xmbox__hw_8h.html#abf6dc425ab72da28a9f30d37f803ec25">xmbox_hw.h</a>
: <a class="el" href="xmbox_8c.html#6981f31c1911a95bf94b3e2608e3febe">xmbox.c</a><li>XMbox_Write() </li>
: <a class="el" href="xmbox_8c.html#3d9b8fdcdbe1a4ba26787aaa2575dab4">xmbox.c</a><li>XMbox_WriteBlocking() <li>XMB_STATUS_FIFO_EMPTY
: <a class="el" href="xmbox_8c.html#b643bb1dd7ebdaa7674cb17d63ea7cc4">xmbox.c</a><li>XMbox_WriteMBox : <a class="el" href="xmbox__hw_8h.html#aa79d42f5c0e43f6b6679a42f119f9563">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#edee2f8bd3df3ebc6abcd8a858ab2eb3">xmbox_hw.h</a><li>XMbox_WriteReg </li>
: <a class="el" href="xmbox__hw_8h.html#147539a7b475d1c20958b47222594fa5">xmbox_hw.h</a></ul> <li>XMB_STATUS_FIFO_FULL
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. : <a class="el" href="xmbox__hw_8h.html#a03cf0e55c079a09632583ac77df57329">xmbox_hw.h</a>
</li>
<li>XMB_STATUS_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#a939d1f0b71e575a31a3689ca28cbc749">xmbox_hw.h</a>
</li>
<li>XMB_STATUS_RTA
: <a class="el" href="xmbox__hw_8h.html#a5961a437539596663a0f87843d6f04d7">xmbox_hw.h</a>
</li>
<li>XMB_STATUS_STA
: <a class="el" href="xmbox__hw_8h.html#a12ee4cdd2f16e453fc3acca51768fb30">xmbox_hw.h</a>
</li>
<li>XMB_WRITE_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#a1cfe8987e8a70162381ff6893967fbd8">xmbox_hw.h</a>
</li>
<li>XMbox_CfgInitialize()
: <a class="el" href="xmbox_8c.html#ae0968f8608b3f8667ef6f5ec89e56f58">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#ae0968f8608b3f8667ef6f5ec89e56f58">xmbox.h</a>
</li>
<li>XMbox_ClearInterrupt()
: <a class="el" href="xmbox_8c.html#ab93a50b0032e4b6202c23c4201e0591e">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#ab93a50b0032e4b6202c23c4201e0591e">xmbox.h</a>
</li>
<li>XMbox_ConfigTable
: <a class="el" href="xmbox__g_8c.html#ad28284f96fddcd9fdbd1efd18363bd43">xmbox_g.c</a>
, <a class="el" href="xmbox__sinit_8c.html#ad28284f96fddcd9fdbd1efd18363bd43">xmbox_sinit.c</a>
</li>
<li>XMbox_Flush()
: <a class="el" href="xmbox_8c.html#a10691489238a2a1b8515468b416d773e">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#a10691489238a2a1b8515468b416d773e">xmbox.h</a>
</li>
<li>XMbox_FSLIsEmpty
: <a class="el" href="xmbox__hw_8h.html#aa74c9f619d2ee4f3b668743954223ea6">xmbox_hw.h</a>
</li>
<li>XMbox_FSLIsFull
: <a class="el" href="xmbox__hw_8h.html#a59470c703fb9332335643ba020898e59">xmbox_hw.h</a>
</li>
<li>XMbox_FSLReadMBox
: <a class="el" href="xmbox__hw_8h.html#a597515ed7cbc30c2bcb4409f4a463dcf">xmbox_hw.h</a>
</li>
<li>XMbox_FSLWriteMBox
: <a class="el" href="xmbox__hw_8h.html#a575df2eee6d404775c6b2e2843421a53">xmbox_hw.h</a>
</li>
<li>XMbox_GetInterruptEnable()
: <a class="el" href="xmbox_8h.html#acb96b1964aa476b4d60df4fd2440022c">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#acb96b1964aa476b4d60df4fd2440022c">xmbox.c</a>
</li>
<li>XMbox_GetInterruptStatus()
: <a class="el" href="xmbox_8c.html#af73757d06d4cc60466e563ab185a6c07">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#af73757d06d4cc60466e563ab185a6c07">xmbox.h</a>
</li>
<li>XMbox_GetStatus()
: <a class="el" href="xmbox_8c.html#a8620711a04da0032b216e3f57a80570d">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#a8620711a04da0032b216e3f57a80570d">xmbox.h</a>
</li>
<li>XMBOX_H
: <a class="el" href="xmbox_8h.html#aca6cee42c48f97f22103bbd9d3d41160">xmbox.h</a>
</li>
<li>XMBOX_HW_H
: <a class="el" href="xmbox__hw_8h.html#a2d4e8969a50b066c107ffe7ea7b11e93">xmbox_hw.h</a>
</li>
<li>XMbox_IsEmpty()
: <a class="el" href="xmbox_8h.html#abb01fe466ffcd0da315ffee115f4cd60">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#abb01fe466ffcd0da315ffee115f4cd60">xmbox.c</a>
</li>
<li>XMbox_IsEmptyHw
: <a class="el" href="xmbox__hw_8h.html#aa533a34a21931e86fe66cbd144659b87">xmbox_hw.h</a>
</li>
<li>XMbox_IsFull()
: <a class="el" href="xmbox_8h.html#aa9db05bc2935bcc2230ff023b5c9cbcc">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#aa9db05bc2935bcc2230ff023b5c9cbcc">xmbox.c</a>
</li>
<li>XMbox_IsFullHw
: <a class="el" href="xmbox__hw_8h.html#a686ca5f4834e7e613350a2166cd49398">xmbox_hw.h</a>
</li>
<li>XMbox_LookupConfig()
: <a class="el" href="xmbox__sinit_8c.html#a7267e216a269efdaa394aefe18af45a7">xmbox_sinit.c</a>
, <a class="el" href="xmbox_8h.html#a7267e216a269efdaa394aefe18af45a7">xmbox.h</a>
</li>
<li>XMbox_Read()
: <a class="el" href="xmbox_8c.html#aa1f68405027d147c68aa53bcb49fbd5a">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#aa1f68405027d147c68aa53bcb49fbd5a">xmbox.h</a>
</li>
<li>XMbox_ReadBlocking()
: <a class="el" href="xmbox_8c.html#ab14511b623c1d3c191cdc441b8909006">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#ab14511b623c1d3c191cdc441b8909006">xmbox.h</a>
</li>
<li>XMbox_ReadMBox
: <a class="el" href="xmbox__hw_8h.html#a20e3d2cc2c9ecc47fc1ce4420a8b69f8">xmbox_hw.h</a>
</li>
<li>XMbox_ReadReg
: <a class="el" href="xmbox__hw_8h.html#a4f0eb6f00b1c4baf91576f2e6a32af87">xmbox_hw.h</a>
</li>
<li>XMbox_SetInterruptEnable()
: <a class="el" href="xmbox_8h.html#a8e56860ea2cf7f4f1df0f1862d8c4c61">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#a8e56860ea2cf7f4f1df0f1862d8c4c61">xmbox.c</a>
</li>
<li>XMbox_SetReceiveThreshold()
: <a class="el" href="xmbox_8c.html#a8c05b007d0f92ca32702db58573302a9">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#a8c05b007d0f92ca32702db58573302a9">xmbox.h</a>
</li>
<li>XMbox_SetSendThreshold()
: <a class="el" href="xmbox_8h.html#a4fb918498d8adc676f4ea554585609d2">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#a4fb918498d8adc676f4ea554585609d2">xmbox.c</a>
</li>
<li>XMbox_Write()
: <a class="el" href="xmbox_8h.html#a254c4e5a042e34520c3669fbf9651bc2">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#a254c4e5a042e34520c3669fbf9651bc2">xmbox.c</a>
</li>
<li>XMbox_WriteBlocking()
: <a class="el" href="xmbox_8h.html#a23ee00f97807790770f2dab9b2ea3b0e">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#a23ee00f97807790770f2dab9b2ea3b0e">xmbox.c</a>
</li>
<li>XMbox_WriteMBox
: <a class="el" href="xmbox__hw_8h.html#a267447e4cde5a2e0320ebba438c22a47">xmbox_hw.h</a>
</li>
<li>XMbox_WriteReg
: <a class="el" href="xmbox__hw_8h.html#a299c2eb6c04531a5da2202b9968531c7">xmbox_hw.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

172
XilinxProcessorIPLib/drivers/mbox/doc/html/api/globals_defs.html
View file

@ -2,58 +2,134 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver mbox v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li><a href="globals.html"><span>All</span></a></li> </ul>
<li><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li id="current"><a href="globals_defs.html"><span>Defines</span></a></li> <div class="tabs">
</ul> <ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li class="current"><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div> </div>
&nbsp; <div class="contents">
<p> &nbsp;<ul>
<ul>
<li>XMB_ERROR_FIFO_EMPTY <li>XMB_ERROR_FIFO_EMPTY
: <a class="el" href="xmbox__hw_8h.html#4433691fc1d9723a1762ccd93abfdccb">xmbox_hw.h</a><li>XMB_ERROR_FIFO_FULL : <a class="el" href="xmbox__hw_8h.html#a1fc712eb56bcc330c46c5bfe3f3c1583">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#302a95787e205b0cfff4b2ca17bf4cca">xmbox_hw.h</a><li>XMB_ERROR_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#6d68a937dabf298978c8a73973abbc47">xmbox_hw.h</a><li>XMB_IE_REG_OFFSET <li>XMB_ERROR_FIFO_FULL
: <a class="el" href="xmbox__hw_8h.html#1e38fec2a51cccba61522506994de1cb">xmbox_hw.h</a><li>XMB_IP_REG_OFFSET : <a class="el" href="xmbox__hw_8h.html#a90d8c6add066bca7fc234e0908a2ab56">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#515b28e524d7bb1c2f72d5f42e0e6187">xmbox_hw.h</a><li>XMB_IS_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#750b579b89b494d4a747d4dd63304001">xmbox_hw.h</a><li>XMB_IX_ERR <li>XMB_ERROR_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#a88ff00c2f1304f39037f72f932916c8">xmbox_hw.h</a><li>XMB_IX_RTA : <a class="el" href="xmbox__hw_8h.html#a777c199c53e918c3cbb896187ce28914">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#cd3acbc8a38ae9770d142ceaba965849">xmbox_hw.h</a><li>XMB_IX_STA </li>
: <a class="el" href="xmbox__hw_8h.html#ad11082dd63b3730afa071df17019155">xmbox_hw.h</a><li>XMB_READ_REG_OFFSET <li>XMB_IE_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#7275d9f52811db090e851be413c62c05">xmbox_hw.h</a><li>XMB_RIT_REG_OFFSET : <a class="el" href="xmbox__hw_8h.html#a992a83c0e5454de142ae0110531e6116">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#595daf977d0d55380530d42ada68e622">xmbox_hw.h</a><li>XMB_SIT_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#dd64b8525f4eac09c8b9f0b88fc78878">xmbox_hw.h</a><li>XMB_STATUS_FIFO_EMPTY <li>XMB_IP_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#8fedd89e5ec3583a7797af8ebfdb529e">xmbox_hw.h</a><li>XMB_STATUS_FIFO_FULL : <a class="el" href="xmbox__hw_8h.html#a40250159d7755332fc0e4149b46985d7">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#653c371ab0f1fd4f6798f8c51be574db">xmbox_hw.h</a><li>XMB_STATUS_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#4ee23a3d2aca5433b3d330092df18cb0">xmbox_hw.h</a><li>XMB_STATUS_RTA <li>XMB_IS_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#b28f0c2edb3c0e202df742ea0d7202d3">xmbox_hw.h</a><li>XMB_STATUS_STA : <a class="el" href="xmbox__hw_8h.html#a24776289ecaec70de8722b0d4e34db6f">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#f125596a84554053e7176296547d0ca2">xmbox_hw.h</a><li>XMB_WRITE_REG_OFFSET </li>
: <a class="el" href="xmbox__hw_8h.html#10c44462e85c10947d3f3b3378965529">xmbox_hw.h</a><li>XMbox_IsEmptyHw <li>XMB_IX_ERR
: <a class="el" href="xmbox__hw_8h.html#66f05b684becb55adf0bfa57d9f9fc2c">xmbox_hw.h</a><li>XMbox_IsFullHw : <a class="el" href="xmbox__hw_8h.html#ad879d5982bf753dcf27efc6bb8cca604">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#1e3284d4d66b15f0fd44e6eb8f7cc6b0">xmbox_hw.h</a><li>XMbox_ReadMBox </li>
: <a class="el" href="xmbox__hw_8h.html#6adb2ab206b41b713e7348184473b2ae">xmbox_hw.h</a><li>XMbox_ReadReg <li>XMB_IX_RTA
: <a class="el" href="xmbox__hw_8h.html#7498da3346c504b21c64870802bff019">xmbox_hw.h</a><li>XMbox_WriteMBox : <a class="el" href="xmbox__hw_8h.html#ac4ca917f4f31be7e899e1adaa4c503aa">xmbox_hw.h</a>
: <a class="el" href="xmbox__hw_8h.html#edee2f8bd3df3ebc6abcd8a858ab2eb3">xmbox_hw.h</a><li>XMbox_WriteReg </li>
: <a class="el" href="xmbox__hw_8h.html#147539a7b475d1c20958b47222594fa5">xmbox_hw.h</a></ul> <li>XMB_IX_STA
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. : <a class="el" href="xmbox__hw_8h.html#a03584ed8fe52cb5f04450bec96f00e51">xmbox_hw.h</a>
</li>
<li>XMB_READ_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#a3a1f7a91d465c1e6be224c7f73d8ecea">xmbox_hw.h</a>
</li>
<li>XMB_RIT_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#ac1a7132725b8bd47cf0ddfa5e219a63a">xmbox_hw.h</a>
</li>
<li>XMB_SIT_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#abf6dc425ab72da28a9f30d37f803ec25">xmbox_hw.h</a>
</li>
<li>XMB_STATUS_FIFO_EMPTY
: <a class="el" href="xmbox__hw_8h.html#aa79d42f5c0e43f6b6679a42f119f9563">xmbox_hw.h</a>
</li>
<li>XMB_STATUS_FIFO_FULL
: <a class="el" href="xmbox__hw_8h.html#a03cf0e55c079a09632583ac77df57329">xmbox_hw.h</a>
</li>
<li>XMB_STATUS_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#a939d1f0b71e575a31a3689ca28cbc749">xmbox_hw.h</a>
</li>
<li>XMB_STATUS_RTA
: <a class="el" href="xmbox__hw_8h.html#a5961a437539596663a0f87843d6f04d7">xmbox_hw.h</a>
</li>
<li>XMB_STATUS_STA
: <a class="el" href="xmbox__hw_8h.html#a12ee4cdd2f16e453fc3acca51768fb30">xmbox_hw.h</a>
</li>
<li>XMB_WRITE_REG_OFFSET
: <a class="el" href="xmbox__hw_8h.html#a1cfe8987e8a70162381ff6893967fbd8">xmbox_hw.h</a>
</li>
<li>XMbox_FSLIsEmpty
: <a class="el" href="xmbox__hw_8h.html#aa74c9f619d2ee4f3b668743954223ea6">xmbox_hw.h</a>
</li>
<li>XMbox_FSLIsFull
: <a class="el" href="xmbox__hw_8h.html#a59470c703fb9332335643ba020898e59">xmbox_hw.h</a>
</li>
<li>XMbox_FSLReadMBox
: <a class="el" href="xmbox__hw_8h.html#a597515ed7cbc30c2bcb4409f4a463dcf">xmbox_hw.h</a>
</li>
<li>XMbox_FSLWriteMBox
: <a class="el" href="xmbox__hw_8h.html#a575df2eee6d404775c6b2e2843421a53">xmbox_hw.h</a>
</li>
<li>XMBOX_H
: <a class="el" href="xmbox_8h.html#aca6cee42c48f97f22103bbd9d3d41160">xmbox.h</a>
</li>
<li>XMBOX_HW_H
: <a class="el" href="xmbox__hw_8h.html#a2d4e8969a50b066c107ffe7ea7b11e93">xmbox_hw.h</a>
</li>
<li>XMbox_IsEmptyHw
: <a class="el" href="xmbox__hw_8h.html#aa533a34a21931e86fe66cbd144659b87">xmbox_hw.h</a>
</li>
<li>XMbox_IsFullHw
: <a class="el" href="xmbox__hw_8h.html#a686ca5f4834e7e613350a2166cd49398">xmbox_hw.h</a>
</li>
<li>XMbox_ReadMBox
: <a class="el" href="xmbox__hw_8h.html#a20e3d2cc2c9ecc47fc1ce4420a8b69f8">xmbox_hw.h</a>
</li>
<li>XMbox_ReadReg
: <a class="el" href="xmbox__hw_8h.html#a4f0eb6f00b1c4baf91576f2e6a32af87">xmbox_hw.h</a>
</li>
<li>XMbox_WriteMBox
: <a class="el" href="xmbox__hw_8h.html#a267447e4cde5a2e0320ebba438c22a47">xmbox_hw.h</a>
</li>
<li>XMbox_WriteReg
: <a class="el" href="xmbox__hw_8h.html#a299c2eb6c04531a5da2202b9968531c7">xmbox_hw.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

142
XilinxProcessorIPLib/drivers/mbox/doc/html/api/globals_func.html
View file

@ -2,49 +2,115 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver mbox v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li><a href="globals.html"><span>All</span></a></li> </ul>
<li id="current"><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li><a href="globals_defs.html"><span>Defines</span></a></li> <div class="tabs">
</ul> <ul>
<li><a href="globals.html"><span>All</span></a></li>
<li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
</div> </div>
<div class="contents">
&nbsp; &nbsp;
<p>
<ul> <h3><a class="anchor" id="index_x">- x -</a></h3><ul>
<li>XMbox_CfgInitialize() <li>XMbox_CfgInitialize()
: <a class="el" href="xmbox_8c.html#03167856611920557ccd189ebc9942e4">xmbox.c</a><li>XMbox_ClearInterrupt() : <a class="el" href="xmbox_8c.html#ae0968f8608b3f8667ef6f5ec89e56f58">xmbox.c</a>
: <a class="el" href="xmbox_8c.html#071b085ea3599cd6a1fb60acd270304e">xmbox.c</a><li>XMbox_Flush() , <a class="el" href="xmbox_8h.html#ae0968f8608b3f8667ef6f5ec89e56f58">xmbox.h</a>
: <a class="el" href="xmbox_8c.html#bb4866d110cafc17ae2f796d67555342">xmbox.c</a><li>XMbox_GetInterruptEnable() </li>
: <a class="el" href="xmbox_8c.html#86189b15b3be4d88b99c201f9afefaa6">xmbox.c</a><li>XMbox_GetInterruptStatus() <li>XMbox_ClearInterrupt()
: <a class="el" href="xmbox_8c.html#5238e5e07452d1f67fd73872aa68829a">xmbox.c</a><li>XMbox_GetStatus() : <a class="el" href="xmbox_8h.html#ab93a50b0032e4b6202c23c4201e0591e">xmbox.h</a>
: <a class="el" href="xmbox_8c.html#2eb8e80874c451ea3bc857131e69fcf9">xmbox.c</a><li>XMbox_IsEmpty() , <a class="el" href="xmbox_8c.html#ab93a50b0032e4b6202c23c4201e0591e">xmbox.c</a>
: <a class="el" href="xmbox_8c.html#2944a536e30ffa972cccfb6629944e14">xmbox.c</a><li>XMbox_IsFull() </li>
: <a class="el" href="xmbox_8c.html#0033b5fdf52a30afa9bf44d804aab0c5">xmbox.c</a><li>XMbox_Read() <li>XMbox_Flush()
: <a class="el" href="xmbox_8c.html#3a9fc221c6ba749d5d4157f2f7c71400">xmbox.c</a><li>XMbox_ReadBlocking() : <a class="el" href="xmbox_8c.html#a10691489238a2a1b8515468b416d773e">xmbox.c</a>
: <a class="el" href="xmbox_8c.html#50ed591178c351824dd96d676ee23412">xmbox.c</a><li>XMbox_SetInterruptEnable() , <a class="el" href="xmbox_8h.html#a10691489238a2a1b8515468b416d773e">xmbox.h</a>
: <a class="el" href="xmbox_8c.html#c460a83470911ffe10ef8acf0e5e4745">xmbox.c</a><li>XMbox_SetReceiveThreshold() </li>
: <a class="el" href="xmbox_8c.html#faaa97b523bfc0e4f88b53d0fab3e30b">xmbox.c</a><li>XMbox_SetSendThreshold() <li>XMbox_GetInterruptEnable()
: <a class="el" href="xmbox_8c.html#6981f31c1911a95bf94b3e2608e3febe">xmbox.c</a><li>XMbox_Write() : <a class="el" href="xmbox_8h.html#acb96b1964aa476b4d60df4fd2440022c">xmbox.h</a>
: <a class="el" href="xmbox_8c.html#3d9b8fdcdbe1a4ba26787aaa2575dab4">xmbox.c</a><li>XMbox_WriteBlocking() , <a class="el" href="xmbox_8c.html#acb96b1964aa476b4d60df4fd2440022c">xmbox.c</a>
: <a class="el" href="xmbox_8c.html#b643bb1dd7ebdaa7674cb17d63ea7cc4">xmbox.c</a></ul> </li>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <li>XMbox_GetInterruptStatus()
: <a class="el" href="xmbox_8c.html#af73757d06d4cc60466e563ab185a6c07">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#af73757d06d4cc60466e563ab185a6c07">xmbox.h</a>
</li>
<li>XMbox_GetStatus()
: <a class="el" href="xmbox_8c.html#a8620711a04da0032b216e3f57a80570d">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#a8620711a04da0032b216e3f57a80570d">xmbox.h</a>
</li>
<li>XMbox_IsEmpty()
: <a class="el" href="xmbox_8c.html#abb01fe466ffcd0da315ffee115f4cd60">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#abb01fe466ffcd0da315ffee115f4cd60">xmbox.h</a>
</li>
<li>XMbox_IsFull()
: <a class="el" href="xmbox_8h.html#aa9db05bc2935bcc2230ff023b5c9cbcc">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#aa9db05bc2935bcc2230ff023b5c9cbcc">xmbox.c</a>
</li>
<li>XMbox_LookupConfig()
: <a class="el" href="xmbox_8h.html#a7267e216a269efdaa394aefe18af45a7">xmbox.h</a>
, <a class="el" href="xmbox__sinit_8c.html#a7267e216a269efdaa394aefe18af45a7">xmbox_sinit.c</a>
</li>
<li>XMbox_Read()
: <a class="el" href="xmbox_8c.html#aa1f68405027d147c68aa53bcb49fbd5a">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#aa1f68405027d147c68aa53bcb49fbd5a">xmbox.h</a>
</li>
<li>XMbox_ReadBlocking()
: <a class="el" href="xmbox_8c.html#ab14511b623c1d3c191cdc441b8909006">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#ab14511b623c1d3c191cdc441b8909006">xmbox.h</a>
</li>
<li>XMbox_SetInterruptEnable()
: <a class="el" href="xmbox_8c.html#a8e56860ea2cf7f4f1df0f1862d8c4c61">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#a8e56860ea2cf7f4f1df0f1862d8c4c61">xmbox.h</a>
</li>
<li>XMbox_SetReceiveThreshold()
: <a class="el" href="xmbox_8h.html#a8c05b007d0f92ca32702db58573302a9">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#a8c05b007d0f92ca32702db58573302a9">xmbox.c</a>
</li>
<li>XMbox_SetSendThreshold()
: <a class="el" href="xmbox_8c.html#a4fb918498d8adc676f4ea554585609d2">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#a4fb918498d8adc676f4ea554585609d2">xmbox.h</a>
</li>
<li>XMbox_Write()
: <a class="el" href="xmbox_8h.html#a254c4e5a042e34520c3669fbf9651bc2">xmbox.h</a>
, <a class="el" href="xmbox_8c.html#a254c4e5a042e34520c3669fbf9651bc2">xmbox.c</a>
</li>
<li>XMbox_WriteBlocking()
: <a class="el" href="xmbox_8c.html#a23ee00f97807790770f2dab9b2ea3b0e">xmbox.c</a>
, <a class="el" href="xmbox_8h.html#a23ee00f97807790770f2dab9b2ea3b0e">xmbox.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

49
XilinxProcessorIPLib/drivers/mbox/doc/html/api/globals_vars.html Executable file
View file

@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver mbox v4_0: Class Members
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li class="current"><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp;<ul>
<li>XMbox_ConfigTable
: <a class="el" href="xmbox__g_8c.html#ad28284f96fddcd9fdbd1efd18363bd43">xmbox_g.c</a>
, <a class="el" href="xmbox__sinit_8c.html#ad28284f96fddcd9fdbd1efd18363bd43">xmbox_sinit.c</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

74
XilinxProcessorIPLib/drivers/mbox/doc/html/api/index.html
View file

@ -2,46 +2,51 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
mbox v4_0 Xilinx Driver mbox v4_0: mbox v4_0
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li id="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li class="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<h1>mbox v4_0</h1> <li><a href="files.html"><span>Files</span></a></li>
<p> </ul>
The Xilinx mailbox driver. This driver supports the Xilinx Mailbox device. More detailed description of the driver operation can be found in the <a class="el" href="xmbox_8c.html">xmbox.c</a> file.<p> </div>
</div>
<div class="contents">
<h1>mbox v4_0</h1><p>The Xilinx mailbox driver. This driver supports the Xilinx Mailbox device. More detailed description of the driver operation can be found in the <a class="el" href="xmbox_8c.html">xmbox.c</a> file.</p>
<ul> <ul>
<li>The Xilinx Mailbox is intended to be used as a bi-directional communication core between a pair of processors. The mailbox API shall allow software to send messages in a FIFO fashion, where the receiver is intended to be software on another processor.</li><li>The mailbox implementation provides for a way to "send" and "receive" in an atomic fashion using seperate FIFOs in the mailbox core.</li><li>The API itself does not stop the use case where there is more than one sender on the transmit side and more than one receiver on the receiving side (just like TCP/IP sockets). However, unless there is a protocol implemented in the messages being transferred, it is typically good practice to assign just one transmit processor and one receiver processor to a single mailbox.</li><li>The API provides for both blocking and non-blocking semantics on the send and receive operations.</li></ul> <li>The Xilinx Mailbox is intended to be used as a bi-directional communication core between a pair of processors. The mailbox API shall allow software to send messages in a FIFO fashion, where the receiver is intended to be software on another processor.</li>
<p> <li>The mailbox implementation provides for a way to "send" and "receive" in an atomic fashion using seperate FIFOs in the mailbox core.</li>
<b>Initialization &amp; Configuration</b><p> <li>The API itself does not stop the use case where there is more than one sender on the transmit side and more than one receiver on the receiving side (just like TCP/IP sockets). However, unless there is a protocol implemented in the messages being transferred, it is typically good practice to assign just one transmit processor and one receiver processor to a single mailbox.</li>
The <a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> structure is used by the driver to configure itself. This configuration structure is typically created by the tool-chain based on HW build properties.<p> <li>The API provides for both blocking and non-blocking semantics on the send and receive operations.</li>
</ul>
<p><b>Initialization &amp; Configuration</b></p>
<p>The <a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> structure is used by the driver to configure itself. This configuration structure is typically created by the tool-chain based on HW build properties.</p>
<ul> <ul>
<li>XMbox_LookupConfig(DeviceId) - Use the device identifier to find the static configuration structure defined in <a class="el" href="xmbox__g_8c.html">XMbox_g.c</a>. This is setup by the tools. For some operating systems the config structure will be initialized by the software and this call is not needed. This function returns the CfgPtr argument used by the CfgInitialize function described below.</li></ul> <li>XMbox_LookupConfig(DeviceId) - Use the device identifier to find the static configuration structure defined in XMbox_g.c. This is setup by the tools. For some operating systems the config structure will be initialized by the software and this call is not needed. This function returns the CfgPtr argument used by the CfgInitialize function described below.</li>
<p> </ul>
<ul> <ul>
<li>XMbox_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddress) - Uses a configuration structure provided by the caller. If running in a system with address translation, the provided virtual memory base address replaces the physical address present in the configuration structure. The EffectiveAddress argument is required regardless of operating system environment, i.e. in standalone, CfgPtr-&gt;BaseAddress is recommended, not the xparameters.h define.</li></ul> <li>XMbox_CfgInitialize(InstancePtr, CfgPtr, EffectiveAddress) - Uses a configuration structure provided by the caller. If running in a system with address translation, the provided virtual memory base address replaces the physical address present in the configuration structure. The EffectiveAddress argument is required regardless of operating system environment, i.e. in standalone, CfgPtr-&gt;BaseAddress is recommended, not the xparameters.h define.</li>
<p> </ul>
<b>Interrupts</b><p> <p><b>Interrupts</b></p>
The Mailbox hardware has two interrupt outputs, one for each interface.<p> <p>The Mailbox hardware has two interrupt outputs, one for each interface.</p>
For an interface that uses Direct FSL the associated interrupt pin shall be high while there is data in the FIFO for this interface.<p> <p>For an interface that uses Direct FSL the associated interrupt pin shall be high while there is data in the FIFO for this interface.</p>
For a PLB interface there shall be 3 associated interrupt sources that can be controlled through dedicated registers. Each of these sources shall be associated with a specific bit position in the related register. The sources shall be: Send Threshold Interrupt (STI), Receive Threshold Interrupt (RTI) and FIFO Error (ERR). RTI is set when the number of entries in the receive FIFO become greater than the RIT value (rising edge on RTA). STI is set when the number of entries in the send FIFO becomes equal or less than the SIT value (rising edge on STA). RTI and STI are only set when their respective conditions goes from false to true, not continuously when the condition is fulfilled.<p> <p>For a PLB interface there shall be 3 associated interrupt sources that can be controlled through dedicated registers. Each of these sources shall be associated with a specific bit position in the related register. The sources shall be: Send Threshold Interrupt (STI), Receive Threshold Interrupt (RTI) and FIFO Error (ERR). RTI is set when the number of entries in the receive FIFO become greater than the RIT value (rising edge on RTA). STI is set when the number of entries in the send FIFO becomes equal or less than the SIT value (rising edge on STA). RTI and STI are only set when their respective conditions goes from false to true, not continuously when the condition is fulfilled.</p>
The Mailbox driver does not have an interrupt service routine. It is the responsibility of the caller of Mailbox functions to manage the interrupt including connecting to the interrupt and enabling/disabling the interrupt. The user can create a handler to service the interrupts generated by the Mailbox IP.<p> <p>The Mailbox driver does not have an interrupt service routine. It is the responsibility of the caller of Mailbox functions to manage the interrupt including connecting to the interrupt and enabling/disabling the interrupt. The user can create a handler to service the interrupts generated by the Mailbox IP.</p>
Using the Blocking version of the Read function is not recommended since the processor will hang until the requested length is received, which might be quite a long time.<p> <p>Using the Blocking version of the Read function is not recommended since the processor will hang until the requested length is received, which might be quite a long time.</p>
<dl compact><dt><b>Note:</b></dt><dd></dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
This driver is intended to be RTOS and processor independent. It works with physical addresses only. Any needs for dynamic memory management, threads or thread mutual exclusion, virtual memory, or cache control must be satisfied by the layer above this driver.<p> <p>This driver is intended to be RTOS and processor independent. It works with physical addresses only. Any needs for dynamic memory management, threads or thread mutual exclusion, virtual memory, or cache control must be satisfied by the layer above this driver.</p>
Possible Optimization technique: If the interface for the hardware is only expected to be the memory mapped or the FSL interface for the lifetime of the project, it is reasonable to remove the other, unused, leg through the functions which allow access to the other interface method, i.e. if FSL is the only available interface the memory mapped clause in the if statements can be removed improving the performance some due to the lack of the test and branch.<p> <p>Possible Optimization technique: If the interface for the hardware is only expected to be the memory mapped or the FSL interface for the lifetime of the project, it is reasonable to remove the other, unused, leg through the functions which allow access to the other interface method, i.e. if FSL is the only available interface the memory mapped clause in the if statements can be removed improving the performance some due to the lack of the test and branch.</p>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- -------- ----------------------------------------------- ----- ---- -------- -----------------------------------------------
1.00a va First release 1.00a va First release
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS
@ -64,4 +69,9 @@ Possible Optimization technique: If the interface for the hardware is only expec
tests will not be run if there is only one Processor tests will not be run if there is only one Processor
in design CR#715626 in design CR#715626
4.0 adk 19/12/13 Updated as per the New Tcl API's 4.0 adk 19/12/13 Updated as per the New Tcl API's
</pre> Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </pre> </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

47
XilinxProcessorIPLib/drivers/mbox/doc/html/api/struct_x_mbox-members.html
View file

@ -2,26 +2,37 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Member List Xilinx Driver mbox v4_0: Member List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XMbox Member List</h1>This is the complete list of members for <a class="el" href="struct_x_mbox.html">XMbox</a>, including all inherited members.<p><table> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_mbox.html#fa535ffb25e1fd20341652f9be21e06e">Config</a></td><td><a class="el" href="struct_x_mbox.html">XMbox</a></td><td></td></tr> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_mbox.html#217c41df00b2eee11e1009f5e63905ed">IsReady</a></td><td><a class="el" href="struct_x_mbox.html">XMbox</a></td><td></td></tr> </ul>
</table>Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
</div>
<div class="contents">
<h1>XMbox Member List</h1>This is the complete list of members for <a class="el" href="struct_x_mbox.html">XMbox</a>, including all inherited members.<table>
<tr class="memlist"><td><a class="el" href="struct_x_mbox.html#ada3e15b402bdd502048b69a87dfd70a8">Config</a></td><td><a class="el" href="struct_x_mbox.html">XMbox</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_mbox.html#ac30a078abf5bafc3b3ff0559894f333f">IsReady</a></td><td><a class="el" href="struct_x_mbox.html">XMbox</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

127
XilinxProcessorIPLib/drivers/mbox/doc/html/api/struct_x_mbox.html
View file

@ -2,85 +2,78 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
XMbox Struct Reference Xilinx Driver mbox v4_0: XMbox Struct Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XMbox Struct Reference</h1><!-- doxytag: class="XMbox" --><code>#include &lt;xmbox.h&gt;</code> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<p> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<a href="struct_x_mbox-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> </ul>
The XMbox driver instance data. The user is required to allocate a variable of this type for every mbox device in the system. A pointer to a variable of this type is then passed to the driver API functions. </div>
<p> </div>
<div class="contents">
<h1>XMbox Struct Reference</h1><!-- doxytag: class="XMbox" -->
<p><code>#include &lt;xmbox.h&gt;</code></p>
<p><a href="struct_x_mbox-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox.html#ada3e15b402bdd502048b69a87dfd70a8">Config</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox.html#fa535ffb25e1fd20341652f9be21e06e">Config</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox.html#ac30a078abf5bafc3b3ff0559894f333f">IsReady</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox.html#217c41df00b2eee11e1009f5e63905ed">IsReady</a></td></tr>
</table> </table>
<hr><h2>Member Data Documentation</h2> <hr/><a name="_details"></a><h2>Detailed Description</h2>
<a class="anchor" name="fa535ffb25e1fd20341652f9be21e06e"></a><!-- doxytag: member="XMbox::Config" ref="fa535ffb25e1fd20341652f9be21e06e" args="" --><p> <p>The <a class="el" href="struct_x_mbox.html">XMbox</a> driver instance data. The user is required to allocate a variable of this type for every mbox device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
<table class="mdTable" cellpadding="2" cellspacing="0"> <hr/><h2>Member Data Documentation</h2>
<tr> <a class="anchor" id="ada3e15b402bdd502048b69a87dfd70a8"></a><!-- doxytag: member="XMbox::Config" ref="ada3e15b402bdd502048b69a87dfd70a8" args="" -->
<td class="mdRow"> <div class="memitem">
<table cellpadding="0" cellspacing="0" border="0"> <div class="memproto">
<table class="memname">
<tr> <tr>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> <a class="el" href="struct_x_mbox.html#fa535ffb25e1fd20341652f9be21e06e">XMbox::Config</a> </td> <td class="memname"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> <a class="el" href="struct_x_mbox.html#ada3e15b402bdd502048b69a87dfd70a8">XMbox::Config</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Configuration data, includes base address </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Configuration data, includes base address </td> </div>
</tr> <a class="anchor" id="ac30a078abf5bafc3b3ff0559894f333f"></a><!-- doxytag: member="XMbox::IsReady" ref="ac30a078abf5bafc3b3ff0559894f333f" args="" -->
</table> <div class="memitem">
<a class="anchor" name="217c41df00b2eee11e1009f5e63905ed"></a><!-- doxytag: member="XMbox::IsReady" ref="217c41df00b2eee11e1009f5e63905ed" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_mbox.html#217c41df00b2eee11e1009f5e63905ed">XMbox::IsReady</a> </td> <td class="memname">u32 <a class="el" href="struct_x_mbox.html#ac30a078abf5bafc3b3ff0559894f333f">XMbox::IsReady</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Device is initialized and ready </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr> </div>
<td> </div>
&nbsp; <hr/>The documentation for this struct was generated from the following file:<ul>
</td> <li><a class="el" href="xmbox_8h.html">xmbox.h</a></li>
<td> </ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
Device is initialized and ready </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xmbox.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

53
XilinxProcessorIPLib/drivers/mbox/doc/html/api/struct_x_mbox___config-members.html
View file

@ -2,29 +2,40 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Member List Xilinx Driver mbox v4_0: Member List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XMbox_Config Member List</h1>This is the complete list of members for <a class="el" href="struct_x_mbox___config.html">XMbox_Config</a>, including all inherited members.<p><table> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#2fac08c24c8373333b9f2a62008c62f3">BaseAddress</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#d0263c6cf0769cabc86cfe88226d204b">DeviceId</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr> </ul>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#993a0c797b79f93abc1b0229362c5f3b">RecvID</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr> </div>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#473e348d4102abcfda44499473119ede">SendID</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr> </div>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#0e3ae0f407ad9b60a4bd302aaa2607a8">UseFSL</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr> <div class="contents">
</table>Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <h1>XMbox_Config Member List</h1>This is the complete list of members for <a class="el" href="struct_x_mbox___config.html">XMbox_Config</a>, including all inherited members.<table>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#af0e602602db24b7b3b9494cb08abb927">BaseAddress</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#a8c1ef8d0a7976f0d4b358f8afbf7f48b">DeviceId</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#a609445dac27b19ef129dd295fc252453">RecvID</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#a9e08e69be2c504f49b76b7b992701e5f">SendID</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_mbox___config.html#ae59a7f14795bc768c36b105863e2efc8">UseFSL</a></td><td><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

223
XilinxProcessorIPLib/drivers/mbox/doc/html/api/struct_x_mbox___config.html
View file

@ -2,160 +2,123 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
XMbox_Config Struct Reference Xilinx Driver mbox v4_0: XMbox_Config Struct Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XMbox_Config Struct Reference</h1><!-- doxytag: class="XMbox_Config" --><code>#include &lt;xmbox.h&gt;</code> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<p> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<a href="struct_x_mbox___config-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> </ul>
This typedef contains configuration information for the device. </div>
<p> </div>
<div class="contents">
<h1>XMbox_Config Struct Reference</h1><!-- doxytag: class="XMbox_Config" -->
<p><code>#include &lt;xmbox.h&gt;</code></p>
<p><a href="struct_x_mbox___config-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#a8c1ef8d0a7976f0d4b358f8afbf7f48b">DeviceId</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#d0263c6cf0769cabc86cfe88226d204b">DeviceId</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#af0e602602db24b7b3b9494cb08abb927">BaseAddress</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#ae59a7f14795bc768c36b105863e2efc8">UseFSL</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#2fac08c24c8373333b9f2a62008c62f3">BaseAddress</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#a9e08e69be2c504f49b76b7b992701e5f">SendID</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#a609445dac27b19ef129dd295fc252453">RecvID</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#0e3ae0f407ad9b60a4bd302aaa2607a8">UseFSL</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#473e348d4102abcfda44499473119ede">SendID</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html#993a0c797b79f93abc1b0229362c5f3b">RecvID</a></td></tr>
</table> </table>
<hr><h2>Member Data Documentation</h2> <hr/><a name="_details"></a><h2>Detailed Description</h2>
<a class="anchor" name="2fac08c24c8373333b9f2a62008c62f3"></a><!-- doxytag: member="XMbox_Config::BaseAddress" ref="2fac08c24c8373333b9f2a62008c62f3" args="" --><p> <p>This typedef contains configuration information for the device. </p>
<table class="mdTable" cellpadding="2" cellspacing="0"> <hr/><h2>Member Data Documentation</h2>
<tr> <a class="anchor" id="af0e602602db24b7b3b9494cb08abb927"></a><!-- doxytag: member="XMbox_Config::BaseAddress" ref="af0e602602db24b7b3b9494cb08abb927" args="" -->
<td class="mdRow"> <div class="memitem">
<table cellpadding="0" cellspacing="0" border="0"> <div class="memproto">
<table class="memname">
<tr> <tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_mbox___config.html#2fac08c24c8373333b9f2a62008c62f3">XMbox_Config::BaseAddress</a> </td> <td class="memname">u32 <a class="el" href="struct_x_mbox___config.html#af0e602602db24b7b3b9494cb08abb927">XMbox_Config::BaseAddress</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Register base address </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Register base address </td> </div>
</tr> <a class="anchor" id="a8c1ef8d0a7976f0d4b358f8afbf7f48b"></a><!-- doxytag: member="XMbox_Config::DeviceId" ref="a8c1ef8d0a7976f0d4b358f8afbf7f48b" args="" -->
</table> <div class="memitem">
<a class="anchor" name="d0263c6cf0769cabc86cfe88226d204b"></a><!-- doxytag: member="XMbox_Config::DeviceId" ref="d0263c6cf0769cabc86cfe88226d204b" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u16 <a class="el" href="struct_x_mbox___config.html#d0263c6cf0769cabc86cfe88226d204b">XMbox_Config::DeviceId</a> </td> <td class="memname">u16 <a class="el" href="struct_x_mbox___config.html#a8c1ef8d0a7976f0d4b358f8afbf7f48b">XMbox_Config::DeviceId</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Unique ID of device </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Unique ID of device </td> </div>
</tr> <a class="anchor" id="a609445dac27b19ef129dd295fc252453"></a><!-- doxytag: member="XMbox_Config::RecvID" ref="a609445dac27b19ef129dd295fc252453" args="" -->
</table> <div class="memitem">
<a class="anchor" name="993a0c797b79f93abc1b0229362c5f3b"></a><!-- doxytag: member="XMbox_Config::RecvID" ref="993a0c797b79f93abc1b0229362c5f3b" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u8 <a class="el" href="struct_x_mbox___config.html#993a0c797b79f93abc1b0229362c5f3b">XMbox_Config::RecvID</a> </td> <td class="memname">u8 <a class="el" href="struct_x_mbox___config.html#a609445dac27b19ef129dd295fc252453">XMbox_Config::RecvID</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>FSL link for the read i/f mailbox. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
FSL link for the read i/f mailbox. </td> </div>
</tr> <a class="anchor" id="a9e08e69be2c504f49b76b7b992701e5f"></a><!-- doxytag: member="XMbox_Config::SendID" ref="a9e08e69be2c504f49b76b7b992701e5f" args="" -->
</table> <div class="memitem">
<a class="anchor" name="473e348d4102abcfda44499473119ede"></a><!-- doxytag: member="XMbox_Config::SendID" ref="473e348d4102abcfda44499473119ede" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u8 <a class="el" href="struct_x_mbox___config.html#473e348d4102abcfda44499473119ede">XMbox_Config::SendID</a> </td> <td class="memname">u8 <a class="el" href="struct_x_mbox___config.html#a9e08e69be2c504f49b76b7b992701e5f">XMbox_Config::SendID</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>FSL link for the write i/f mailbox. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
FSL link for the write i/f mailbox. </td> </div>
</tr> <a class="anchor" id="ae59a7f14795bc768c36b105863e2efc8"></a><!-- doxytag: member="XMbox_Config::UseFSL" ref="ae59a7f14795bc768c36b105863e2efc8" args="" -->
</table> <div class="memitem">
<a class="anchor" name="0e3ae0f407ad9b60a4bd302aaa2607a8"></a><!-- doxytag: member="XMbox_Config::UseFSL" ref="0e3ae0f407ad9b60a4bd302aaa2607a8" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u8 <a class="el" href="struct_x_mbox___config.html#0e3ae0f407ad9b60a4bd302aaa2607a8">XMbox_Config::UseFSL</a> </td> <td class="memname">u8 <a class="el" href="struct_x_mbox___config.html#ae59a7f14795bc768c36b105863e2efc8">XMbox_Config::UseFSL</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>use the FSL for the interface. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr> </div>
<td> </div>
&nbsp; <hr/>The documentation for this struct was generated from the following file:<ul>
</td> <li><a class="el" href="xmbox_8h.html">xmbox.h</a></li>
<td> </ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
use the FSL for the interface. </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xmbox.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

15
XilinxProcessorIPLib/drivers/mbox/doc/html/api/tabs.css
View file

@ -32,7 +32,7 @@ DIV.tabs A
float : left; float : left;
background : url("tab_r.gif") no-repeat right top; background : url("tab_r.gif") no-repeat right top;
border-bottom : 1px solid #84B0C7; border-bottom : 1px solid #84B0C7;
font-size : x-small; font-size : 80%;
font-weight : bold; font-weight : bold;
text-decoration : none; text-decoration : none;
} }
@ -57,7 +57,7 @@ DIV.tabs SPAN
white-space : nowrap; white-space : nowrap;
} }
DIV.tabs INPUT DIV.tabs #MSearchBox
{ {
float : right; float : right;
display : inline; display : inline;
@ -66,7 +66,7 @@ DIV.tabs INPUT
DIV.tabs TD DIV.tabs TD
{ {
font-size : x-small; font-size : 80%;
font-weight : bold; font-weight : bold;
text-decoration : none; text-decoration : none;
} }
@ -82,21 +82,24 @@ DIV.tabs A:hover SPAN
background-position: 0% -150px; background-position: 0% -150px;
} }
DIV.tabs LI#current A DIV.tabs LI.current A
{ {
background-position: 100% -150px; background-position: 100% -150px;
border-width : 0px; border-width : 0px;
} }
DIV.tabs LI#current SPAN DIV.tabs LI.current SPAN
{ {
background-position: 0% -150px; background-position: 0% -150px;
padding-bottom : 6px; padding-bottom : 6px;
} }
DIV.nav DIV.navpath
{ {
background : none; background : none;
border : none; border : none;
border-bottom : 1px solid #84B0C7; border-bottom : 1px solid #84B0C7;
text-align : center;
margin : 2px;
padding : 2px;
} }

1018
XilinxProcessorIPLib/drivers/mbox/doc/html/api/xmbox_8c.html
View file

File diff suppressed because it is too large Load diff

664
XilinxProcessorIPLib/drivers/mbox/doc/html/api/xmbox_8h.html Executable file
View file

@ -0,0 +1,664 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver mbox v4_0: xmbox.h File Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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>xmbox.h File Reference</h1><code>#include &quot;xstatus.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="xmbox__hw_8h.html">xmbox_hw.h</a>&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mbox.html">XMbox</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#aca6cee42c48f97f22103bbd9d3d41160">XMBOX_H</a></td></tr>
<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="xmbox_8h.html#ae0968f8608b3f8667ef6f5ec89e56f58">XMbox_CfgInitialize</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, <a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> *ConfigPtr, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#aa1f68405027d147c68aa53bcb49fbd5a">XMbox_Read</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 *BufferPtr, u32 RequestedBytes, u32 *BytesRecvdPtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#ab14511b623c1d3c191cdc441b8909006">XMbox_ReadBlocking</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 *BufferPtr, u32 RequestedBytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#a254c4e5a042e34520c3669fbf9651bc2">XMbox_Write</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 *BufferPtr, u32 RequestedBytes, u32 *BytesSentPtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#a23ee00f97807790770f2dab9b2ea3b0e">XMbox_WriteBlocking</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 *BufferPtr, u32 RequestedBytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#abb01fe466ffcd0da315ffee115f4cd60">XMbox_IsEmpty</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#aa9db05bc2935bcc2230ff023b5c9cbcc">XMbox_IsFull</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#a10691489238a2a1b8515468b416d773e">XMbox_Flush</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#a8e56860ea2cf7f4f1df0f1862d8c4c61">XMbox_SetInterruptEnable</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 Mask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#acb96b1964aa476b4d60df4fd2440022c">XMbox_GetInterruptEnable</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#af73757d06d4cc60466e563ab185a6c07">XMbox_GetInterruptStatus</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#ab93a50b0032e4b6202c23c4201e0591e">XMbox_ClearInterrupt</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 Mask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#a8620711a04da0032b216e3f57a80570d">XMbox_GetStatus</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#a4fb918498d8adc676f4ea554585609d2">XMbox_SetSendThreshold</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 Value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#a8c05b007d0f92ca32702db58573302a9">XMbox_SetReceiveThreshold</a> (<a class="el" href="struct_x_mbox.html">XMbox</a> *InstancePtr, u32 Value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox_8h.html#a7267e216a269efdaa394aefe18af45a7">XMbox_LookupConfig</a> (u16 DeviceId)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="aca6cee42c48f97f22103bbd9d3d41160"></a><!-- doxytag: member="xmbox.h::XMBOX_H" ref="aca6cee42c48f97f22103bbd9d3d41160" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XMBOX_H</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae0968f8608b3f8667ef6f5ec89e56f58"></a><!-- doxytag: member="xmbox.h::XMbox_CfgInitialize" ref="ae0968f8608b3f8667ef6f5ec89e56f58" args="(XMbox *InstancePtr, XMbox_Config *ConfigPtr, u32 EffectiveAddress)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMbox_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> *&nbsp;</td>
<td class="paramname"> <em>ConfigPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddress</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes a specific mailbox.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mbox.html">XMbox</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CfgPtr</em>&nbsp;</td><td>is the device configuration structure containing required HW build data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddr</em>&nbsp;</td><td>is the Physical address of the hardware in a Virtual Memory operating system environment. It is the Base Address in a stand alone environment.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if initialization was successful</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ab93a50b0032e4b6202c23c4201e0591e"></a><!-- doxytag: member="xmbox.h::XMbox_ClearInterrupt" ref="ab93a50b0032e4b6202c23c4201e0591e" args="(XMbox *InstancePtr, u32 Mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XMbox_ClearInterrupt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Mask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears pending interrupts with the provided mask. This function should be called after the software has serviced the interrupts that are pending. This function clears the corresponding bits of the Interrupt Status Register. This function can only be used for Non-FSL interface. If not, the function will fail in an assert.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Mask</em>&nbsp;</td><td>is a logical OR of XMB_IX_* constants found in <a class="el" href="xmbox__hw_8h.html">xmbox_hw.h</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a10691489238a2a1b8515468b416d773e"></a><!-- doxytag: member="xmbox.h::XMbox_Flush" ref="a10691489238a2a1b8515468b416d773e" args="(XMbox *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMbox_Flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the mailbox FIFOs by empting the READ FIFO and making sure the Error Status is zero.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mbox.html">XMbox</a> instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE if there are any outstanding errors.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Data from read FIFO is thrown away. </dd></dl>
</div>
</div>
<a class="anchor" id="acb96b1964aa476b4d60df4fd2440022c"></a><!-- doxytag: member="xmbox.h::XMbox_GetInterruptEnable" ref="acb96b1964aa476b4d60df4fd2440022c" args="(XMbox *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XMbox_GetInterruptEnable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the interrupt enable for the mailbox. AND the result of this function with XMB_IX_* to determine which interrupts of this mailbox are enabled. This function can only be used for Non-FSL interface. If not, the function will fail in an assert.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Mask of interrupt bits made up of XMB_IX_* constants found in <a class="el" href="xmbox__hw_8h.html">xmbox_hw.h</a>.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="af73757d06d4cc60466e563ab185a6c07"></a><!-- doxytag: member="xmbox.h::XMbox_GetInterruptStatus" ref="af73757d06d4cc60466e563ab185a6c07" args="(XMbox *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XMbox_GetInterruptStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the interrupt status for the mailbox. AND the results of this function with XMB_IX_* to determine which interrupts are currently pending to the processor. This function can only be used for Non-FSL interface. If not, the function will fail in an assert.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Mask of interrupt bits made up of XMB_IX_* constants found in <a class="el" href="xmbox__hw_8h.html">xmbox_hw.h</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a8620711a04da0032b216e3f57a80570d"></a><!-- doxytag: member="xmbox.h::XMbox_GetStatus" ref="a8620711a04da0032b216e3f57a80570d" args="(XMbox *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XMbox_GetStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns Status register contents. This function can only be used for Non-FSL interface. If not, the function will fail in an assert. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Value returns Status Register contents.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="abb01fe466ffcd0da315ffee115f4cd60"></a><!-- doxytag: member="xmbox.h::XMbox_IsEmpty" ref="abb01fe466ffcd0da315ffee115f4cd60" args="(XMbox *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XMbox_IsEmpty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks to see if there is data available to be read.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mbox.html">XMbox</a> instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>FALSE if there is data to be read.</li>
<li>TRUE is there no data to be read.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="aa9db05bc2935bcc2230ff023b5c9cbcc"></a><!-- doxytag: member="xmbox.h::XMbox_IsFull" ref="aa9db05bc2935bcc2230ff023b5c9cbcc" args="(XMbox *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32 XMbox_IsFull </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks to see if there is room in the write FIFO.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mbox.html">XMbox</a> instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>FALSE if there is room in write FIFO.</li>
<li>TRUE if there is room in write FIFO.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a7267e216a269efdaa394aefe18af45a7"></a><!-- doxytag: member="xmbox.h::XMbox_LookupConfig" ref="a7267e216a269efdaa394aefe18af45a7" args="(u16 DeviceId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a>* XMbox_LookupConfig </td>
<td>(</td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>DeviceId</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa1f68405027d147c68aa53bcb49fbd5a"></a><!-- doxytag: member="xmbox.h::XMbox_Read" ref="aa1f68405027d147c68aa53bcb49fbd5a" args="(XMbox *InstancePtr, u32 *BufferPtr, u32 RequestedBytes, u32 *BytesRecvdPtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMbox_Read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 *&nbsp;</td>
<td class="paramname"> <em>BufferPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>RequestedBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 *&nbsp;</td>
<td class="paramname"> <em>BytesRecvdPtr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads requested bytes from the mailbox referenced by InstancePtr,into the buffer pointed to by the provided pointer. The number of bytes must be a multiple of 4 (bytes). If not, the call will fail in an assert.</p>
<p>This function is non blocking.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mbox.html">XMbox</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BufferPtr</em>&nbsp;</td><td>is the buffer to read the mailbox contents into, aligned to a word boundary. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>RequestedBytes</em>&nbsp;</td><td>is the number of bytes of data requested. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BytesRecvdPtr</em>&nbsp;</td><td>is the memory that is updated with the number of bytes of data actually read.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>XST_NO_DATA ifthere was no data in the mailbox.</li>
</ul>
</dd></dl>
<p>On success, the number of bytes read is returned through the pointer. The call may return with fewer bytes placed in the buffer than requested (not including zero). This is not necessarily an error condition and indicates the amount of data that was currently available in the mailbox.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ab14511b623c1d3c191cdc441b8909006"></a><!-- doxytag: member="xmbox.h::XMbox_ReadBlocking" ref="ab14511b623c1d3c191cdc441b8909006" args="(XMbox *InstancePtr, u32 *BufferPtr, u32 RequestedBytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XMbox_ReadBlocking </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 *&nbsp;</td>
<td class="paramname"> <em>BufferPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>RequestedBytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads requested bytes from the mailbox referenced by InstancePtr,into the buffer pointed to by the provided pointer. The number of bytes must be a multiple of 4 (bytes). If not, the call will fail in an assert.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mbox.html">XMbox</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BufferPtr</em>&nbsp;</td><td>is the buffer to read the mailbox contents into, aligned to a word boundary. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>RequestedBytes</em>&nbsp;</td><td>is the number of bytes of data requested.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The call blocks until the number of bytes requested are available. </dd></dl>
</div>
</div>
<a class="anchor" id="a8e56860ea2cf7f4f1df0f1862d8c4c61"></a><!-- doxytag: member="xmbox.h::XMbox_SetInterruptEnable" ref="a8e56860ea2cf7f4f1df0f1862d8c4c61" args="(XMbox *InstancePtr, u32 Mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XMbox_SetInterruptEnable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Mask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the interrupt enable register for this mailbox. This function can only be used for Non-FSL interface. If not, the function will fail in an assert.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Mask</em>&nbsp;</td><td>is a logical OR of XMB_IX_* constants found in <a class="el" href="xmbox__hw_8h.html">xmbox_hw.h</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a8c05b007d0f92ca32702db58573302a9"></a><!-- doxytag: member="xmbox.h::XMbox_SetReceiveThreshold" ref="a8c05b007d0f92ca32702db58573302a9" args="(XMbox *InstancePtr, u32 Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XMbox_SetReceiveThreshold </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Value</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the Receive Interrupt Threshold. This function can only be used for Non-FSL interface. If not, the function will fail in an assert. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Value</em>&nbsp;</td><td>is a value to set for the RIT. Only lower Log2(FIFO Depth) bits are used.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a4fb918498d8adc676f4ea554585609d2"></a><!-- doxytag: member="xmbox.h::XMbox_SetSendThreshold" ref="a4fb918498d8adc676f4ea554585609d2" args="(XMbox *InstancePtr, u32 Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XMbox_SetSendThreshold </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>Value</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Send Interrupt Threshold. This function can only be used for Non-FSL interface. If not, the function will fail in an assert.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Value</em>&nbsp;</td><td>is a value to set for the SIT. Only lower Log2(FIFO Depth) bits are used.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a254c4e5a042e34520c3669fbf9651bc2"></a><!-- doxytag: member="xmbox.h::XMbox_Write" ref="a254c4e5a042e34520c3669fbf9651bc2" args="(XMbox *InstancePtr, u32 *BufferPtr, u32 RequestedBytes, u32 *BytesSentPtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMbox_Write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 *&nbsp;</td>
<td class="paramname"> <em>BufferPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>RequestedBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 *&nbsp;</td>
<td class="paramname"> <em>BytesSentPtr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes the requested bytes from the buffer pointed to by the provided pointer into the mailbox referenced by InstancePtr.The number of bytes must be a multiple of 4 (bytes). If not, the call will fail in an assert.</p>
<p>This function is non blocking.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mbox.html">XMbox</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BufferPtr</em>&nbsp;</td><td>is the source data buffer, aligned to a word boundary. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>RequestedBytes</em>&nbsp;</td><td>is the number of bytes requested to be written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BytesRecvdPtr</em>&nbsp;</td><td>points to memory which is updated with the actual number of bytes written, return value. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
<ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FIFO_NO_ROOM if the fifo was full.</li>
</ul>
<p>On success, the number of bytes successfully written into the destination mailbox is returned in the provided pointer. The call may return with zero. This is not necessarily an error condition and indicates that the mailbox is currently full.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The provided buffer pointed to by BufferPtr must be aligned to a word boundary. </dd></dl>
</div>
</div>
<a class="anchor" id="a23ee00f97807790770f2dab9b2ea3b0e"></a><!-- doxytag: member="xmbox.h::XMbox_WriteBlocking" ref="a23ee00f97807790770f2dab9b2ea3b0e" args="(XMbox *InstancePtr, u32 *BufferPtr, u32 RequestedBytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XMbox_WriteBlocking </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mbox.html">XMbox</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 *&nbsp;</td>
<td class="paramname"> <em>BufferPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>RequestedBytes</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes the requested bytes from the buffer pointed to by the provided pointer into the mailbox referenced by InstancePtr. The number of bytes must be a multiple of 4 (bytes). If not, the call will fail in an assert.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mbox.html">XMbox</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>BufferPtr</em>&nbsp;</td><td>is the source data buffer, aligned to a word boundary. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>RequestedBytes</em>&nbsp;</td><td>is the number of bytes requested to be written.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The call blocks until the number of bytes requested are written. The provided buffer pointed to by BufferPtr must be aligned to a word boundary. </dd></dl>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

89
XilinxProcessorIPLib/drivers/mbox/doc/html/api/xmbox__g_8c.html
View file

@ -2,39 +2,72 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
xmbox_g.c File Reference Xilinx Driver mbox v4_0: xmbox_g.c File Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>xmbox_g.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
This file contains a configuration table that specifies the configuration of Mbox devices in the system.<p> <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xmbox_g.c File Reference</h1><code>#include &quot;<a class="el" href="xmbox_8h.html">xmbox.h</a>&quot;</code><br/>
<code>#include &quot;xparameters.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox__g_8c.html#ad28284f96fddcd9fdbd1efd18363bd43">XMbox_ConfigTable</a> []</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This file contains a configuration table that specifies the configuration of Mbox devices in the system.</p>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- -------- --------------------------------------------------- ----- ---- -------- ---------------------------------------------------
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS
</pre><p> </pre><dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
<dl compact><dt><b>Note:</b></dt><dd></dd></dl> <p>None. </p>
None. <hr/><h2>Variable Documentation</h2>
<p> <a class="anchor" id="ad28284f96fddcd9fdbd1efd18363bd43"></a><!-- doxytag: member="xmbox_g.c::XMbox_ConfigTable" ref="ad28284f96fddcd9fdbd1efd18363bd43" args="[]" -->
<code>#include &quot;xmbox.h&quot;</code><br> <div class="memitem">
<code>#include &quot;xparameters.h&quot;</code><br> <div class="memproto">
<table border="0" cellpadding="0" cellspacing="0"> <table class="memname">
<tr><td></td></tr> <tr>
</table> <td class="memname"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> <a class="el" href="xmbox__sinit_8c.html#ad28284f96fddcd9fdbd1efd18363bd43">XMbox_ConfigTable</a>[]</td>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </tr>
</table>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment">
{
{
XPAR_XMBOX_0_DEVICE_ID,
XPAR_XMBOX_0_BASEADDR,
XPAR_XMBOX_0_USE_FSL,
XPAR_XMBOX_0_SEND_ID,
XPAR_XMBOX_0_RECV_ID
}
}
</pre></div>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

1101
XilinxProcessorIPLib/drivers/mbox/doc/html/api/xmbox__hw_8h.html
View file

File diff suppressed because it is too large Load diff

97
XilinxProcessorIPLib/drivers/mbox/doc/html/api/xmbox__sinit_8c.html
View file

@ -2,37 +2,80 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
xmbox_sinit.c File Reference Xilinx Driver mbox v4_0: xmbox_sinit.c File Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>xmbox_sinit.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
Implements static initialization See xmbox.h for more information about the component.<p> <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<pre> </ul>
MODIFICATION HISTORY:</pre><p> </div>
<pre> Ver Who Date Changes </div>
----- ---- -------- --------------------------------------------------- <div class="contents">
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS</pre><p> <h1>xmbox_sinit.c File Reference</h1><code>#include &quot;<a class="el" href="xmbox_8h.html">xmbox.h</a>&quot;</code><br/>
<pre> </pre> <code>#include &quot;xparameters.h&quot;</code><br/>
<p>
<code>#include &quot;xmbox.h&quot;</code><br>
<code>#include &quot;xparameters.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr> <tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox__sinit_8c.html#a7267e216a269efdaa394aefe18af45a7">XMbox_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmbox__sinit_8c.html#ad28284f96fddcd9fdbd1efd18363bd43">XMbox_ConfigTable</a> []</td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Implements static initialization See <a class="el" href="xmbox_8h.html">xmbox.h</a> for more information about the component.</p>
<pre>
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
----- ---- -------- ---------------------------------------------------
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS</pre><pre> </pre> <hr/><h2>Function Documentation</h2>
<a class="anchor" id="a7267e216a269efdaa394aefe18af45a7"></a><!-- doxytag: member="xmbox_sinit.c::XMbox_LookupConfig" ref="a7267e216a269efdaa394aefe18af45a7" args="(u16 DeviceId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a>* XMbox_LookupConfig </td>
<td>(</td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>DeviceId</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="ad28284f96fddcd9fdbd1efd18363bd43"></a><!-- doxytag: member="xmbox_sinit.c::XMbox_ConfigTable" ref="ad28284f96fddcd9fdbd1efd18363bd43" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_mbox___config.html">XMbox_Config</a> <a class="el" href="xmbox__sinit_8c.html#ad28284f96fddcd9fdbd1efd18363bd43">XMbox_ConfigTable</a>[]</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

36
XilinxProcessorIPLib/drivers/mig_7series/doc/html/api/files.html Executable file
View file

@ -0,0 +1,36 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver mig_7series v2_0: File Index
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="files.html"><span>File&nbsp;List</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>File List</h1>Here is a list of all files with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="xmig__7series_8h.html">xmig_7series.h</a></td><td class="indexvalue"></td></tr>
</table>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

30
XilinxProcessorIPLib/drivers/mig_7series/doc/html/api/index.html
View file

@ -2,18 +2,28 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
mig_7series v2_0 Xilinx Driver mig_7series v2_0: mig_7series v2_0
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li id="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>mig_7series v2_0</h1> <li class="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<p> <li><a href="files.html"><span>Files</span></a></li>
This driver exists only to allow the SDK tools to create a memory test application and to populate xparameters.h with memory range constants. There is no source code. VER WHO DATE Changes 2.0 adk 19/12/13 Updated as per the New Tcl API's Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </ul>
</div>
</div>
<div class="contents">
<h1>mig_7series v2_0</h1><p>This driver exists only to allow the SDK tools to create a memory test application and to populate xparameters.h with memory range constants. There is no source code. VER WHO DATE Changes 2.0 adk 19/12/13 Updated as per the New Tcl API's </p>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

15
XilinxProcessorIPLib/drivers/mig_7series/doc/html/api/tabs.css
View file

@ -32,7 +32,7 @@ DIV.tabs A
float : left; float : left;
background : url("tab_r.gif") no-repeat right top; background : url("tab_r.gif") no-repeat right top;
border-bottom : 1px solid #84B0C7; border-bottom : 1px solid #84B0C7;
font-size : x-small; font-size : 80%;
font-weight : bold; font-weight : bold;
text-decoration : none; text-decoration : none;
} }
@ -57,7 +57,7 @@ DIV.tabs SPAN
white-space : nowrap; white-space : nowrap;
} }
DIV.tabs INPUT DIV.tabs #MSearchBox
{ {
float : right; float : right;
display : inline; display : inline;
@ -66,7 +66,7 @@ DIV.tabs INPUT
DIV.tabs TD DIV.tabs TD
{ {
font-size : x-small; font-size : 80%;
font-weight : bold; font-weight : bold;
text-decoration : none; text-decoration : none;
} }
@ -82,21 +82,24 @@ DIV.tabs A:hover SPAN
background-position: 0% -150px; background-position: 0% -150px;
} }
DIV.tabs LI#current A DIV.tabs LI.current A
{ {
background-position: 100% -150px; background-position: 100% -150px;
border-width : 0px; border-width : 0px;
} }
DIV.tabs LI#current SPAN DIV.tabs LI.current SPAN
{ {
background-position: 0% -150px; background-position: 0% -150px;
padding-bottom : 6px; padding-bottom : 6px;
} }
DIV.nav DIV.navpath
{ {
background : none; background : none;
border : none; border : none;
border-bottom : 1px solid #84B0C7; border-bottom : 1px solid #84B0C7;
text-align : center;
margin : 2px;
padding : 2px;
} }

36
XilinxProcessorIPLib/drivers/mig_7series/doc/html/api/xmig__7series_8h.html Executable file
View file

@ -0,0 +1,36 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver mig_7series v2_0: xmig_7series.h File Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 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>
</ul>
</div>
</div>
<div class="contents">
<h1>xmig_7series.h File Reference</h1><table border="0" cellpadding="0" cellspacing="0">
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

41
XilinxProcessorIPLib/drivers/mutex/doc/html/api/annotated.html
View file

@ -2,27 +2,38 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class List Xilinx Driver mutex v4_0: Class List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li id="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<li class="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> <h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="struct_x_mutex.html">XMutex</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_mutex.html">XMutex</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td class="indexvalue"></td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

39
XilinxProcessorIPLib/drivers/mutex/doc/html/api/classes.html Executable file
View file

@ -0,0 +1,39 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver mutex v4_0: Alphabetical List
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class Index</h1><div class="qindex"><a class="qindex" href="#letter_X">X</a></div>
<table align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
<tr><td><a name="letter_X"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&nbsp;&nbsp;X&nbsp;&nbsp;</div></td></tr></table>
</td><td><a class="el" href="struct_x_mutex.html">XMutex</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a>&nbsp;&nbsp;&nbsp;</td></tr></table><div class="qindex"><a class="qindex" href="#letter_X">X</a></div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

44
XilinxProcessorIPLib/drivers/mutex/doc/html/api/files.html
View file

@ -2,30 +2,42 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
File Index Xilinx Driver mutex v4_0: File Index
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li id="current"><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table> <li class="current"><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>File List</h1>Here is a list of all files with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="xmutex_8c.html">xmutex.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xmutex_8c.html">xmutex.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xmutex_8h.html">xmutex.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xmutex__g_8c.html">xmutex_g.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xmutex__g_8c.html">xmutex_g.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xmutex__hw_8h.html">xmutex_hw.h</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xmutex__hw_8h.html">xmutex_hw.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xmutex__selftest_8c.html">xmutex_selftest.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xmutex__selftest_8c.html">xmutex_selftest.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xmutex__sinit_8c.html">xmutex_sinit.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xmutex__sinit_8c.html">xmutex_sinit.c</a></td><td class="indexvalue"></td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

79
XilinxProcessorIPLib/drivers/mutex/doc/html/api/functions.html
View file

@ -2,39 +2,60 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver mutex v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<ul> <li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<li id="current"><a href="functions.html"><span>All</span></a></li> </ul>
<li><a href="functions_vars.html"><span>Variables</span></a></li> </div>
</ul> <div class="tabs">
<ul>
<li class="current"><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
</div> </div>
Here is a list of all documented class members with links to the class documentation for each member: <div class="contents">
<p> Here is a list of all class members with links to the classes they belong to:<ul>
<ul>
<li>BaseAddress <li>BaseAddress
: <a class="el" href="struct_x_mutex___config.html#2fac08c24c8373333b9f2a62008c62f3">XMutex_Config</a><li>Config : <a class="el" href="struct_x_mutex___config.html#a99c7f36433d122562bc4a9e488c83250">XMutex_Config</a>
: <a class="el" href="struct_x_mutex.html#fa535ffb25e1fd20341652f9be21e06e">XMutex</a><li>DeviceId </li>
: <a class="el" href="struct_x_mutex___config.html#d0263c6cf0769cabc86cfe88226d204b">XMutex_Config</a><li>IsReady <li>Config
: <a class="el" href="struct_x_mutex.html#217c41df00b2eee11e1009f5e63905ed">XMutex</a><li>NumMutex : <a class="el" href="struct_x_mutex.html#a7546022d3c935b840c762b763b94b460">XMutex</a>
: <a class="el" href="struct_x_mutex___config.html#d296e9a137bcc27fec7c06eecd30ee3e">XMutex_Config</a><li>UserReg </li>
: <a class="el" href="struct_x_mutex___config.html#f486f2fe492689adb9c74eee489f77d3">XMutex_Config</a></ul> <li>DeviceId
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. : <a class="el" href="struct_x_mutex___config.html#abfface1411085aac250f14a09f79877f">XMutex_Config</a>
</li>
<li>IsReady
: <a class="el" href="struct_x_mutex.html#aab67818beece616d3da30ef3944681e8">XMutex</a>
</li>
<li>NumMutex
: <a class="el" href="struct_x_mutex___config.html#a6a5e5f976fbe7c908f0595ee6d6ed0ee">XMutex_Config</a>
</li>
<li>UserReg
: <a class="el" href="struct_x_mutex___config.html#aee8b1e02a59b48c5b337d6701e3661ce">XMutex_Config</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

79
XilinxProcessorIPLib/drivers/mutex/doc/html/api/functions_vars.html
View file

@ -2,39 +2,60 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members - Variables Xilinx Driver mutex v4_0: Class Members - Variables
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<ul> <li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<li><a href="functions.html"><span>All</span></a></li> </ul>
<li id="current"><a href="functions_vars.html"><span>Variables</span></a></li> </div>
</ul> <div class="tabs">
<ul>
<li><a href="functions.html"><span>All</span></a></li>
<li class="current"><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
</div> </div>
&nbsp; <div class="contents">
<p> &nbsp;<ul>
<ul>
<li>BaseAddress <li>BaseAddress
: <a class="el" href="struct_x_mutex___config.html#2fac08c24c8373333b9f2a62008c62f3">XMutex_Config</a><li>Config : <a class="el" href="struct_x_mutex___config.html#a99c7f36433d122562bc4a9e488c83250">XMutex_Config</a>
: <a class="el" href="struct_x_mutex.html#fa535ffb25e1fd20341652f9be21e06e">XMutex</a><li>DeviceId </li>
: <a class="el" href="struct_x_mutex___config.html#d0263c6cf0769cabc86cfe88226d204b">XMutex_Config</a><li>IsReady <li>Config
: <a class="el" href="struct_x_mutex.html#217c41df00b2eee11e1009f5e63905ed">XMutex</a><li>NumMutex : <a class="el" href="struct_x_mutex.html#a7546022d3c935b840c762b763b94b460">XMutex</a>
: <a class="el" href="struct_x_mutex___config.html#d296e9a137bcc27fec7c06eecd30ee3e">XMutex_Config</a><li>UserReg </li>
: <a class="el" href="struct_x_mutex___config.html#f486f2fe492689adb9c74eee489f77d3">XMutex_Config</a></ul> <li>DeviceId
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. : <a class="el" href="struct_x_mutex___config.html#abfface1411085aac250f14a09f79877f">XMutex_Config</a>
</li>
<li>IsReady
: <a class="el" href="struct_x_mutex.html#aab67818beece616d3da30ef3944681e8">XMutex</a>
</li>
<li>NumMutex
: <a class="el" href="struct_x_mutex___config.html#a6a5e5f976fbe7c908f0595ee6d6ed0ee">XMutex_Config</a>
</li>
<li>UserReg
: <a class="el" href="struct_x_mutex___config.html#aee8b1e02a59b48c5b337d6701e3661ce">XMutex_Config</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

168
XilinxProcessorIPLib/drivers/mutex/doc/html/api/globals.html
View file

@ -2,50 +2,138 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver mutex v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li id="current"><a href="globals.html"><span>All</span></a></li> </ul>
<li><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li><a href="globals_defs.html"><span>Defines</span></a></li> <div class="tabs">
</ul> <ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
</div> </div>
Here is a list of all documented file members with links to the documentation: <div class="contents">
<p> Here is a list of all file members with links to the files they belong to:
<ul>
<h3><a class="anchor" id="index_l">- l -</a></h3><ul>
<li>LOCKED_BIT <li>LOCKED_BIT
: <a class="el" href="xmutex__hw_8h.html#4fc77b2601b1ea7abdfb64a06b1cd1fb">xmutex_hw.h</a><li>OWNER_MASK : <a class="el" href="xmutex__hw_8h.html#a086991b467a934c97022a305bb957977">xmutex_hw.h</a>
: <a class="el" href="xmutex__hw_8h.html#cfe4cc17f438ed2613082cd60f49fc4d">xmutex_hw.h</a><li>OWNER_SHIFT </li>
: <a class="el" href="xmutex__hw_8h.html#8ec2c7708e3b28590514f57108cd3a81">xmutex_hw.h</a><li>XMU_MUTEX_REG_OFFSET </ul>
: <a class="el" href="xmutex__hw_8h.html#a523470c9ee0a5b3684cd6bae8c8d013">xmutex_hw.h</a><li>XMU_USER_REG_OFFSET
: <a class="el" href="xmutex__hw_8h.html#7292f56c48208381c8070d405d20052b">xmutex_hw.h</a><li>XMutex_CfgInitialize()
: <a class="el" href="xmutex_8c.html#dc27f84b9e6ead30caefc29c5d1859f3">xmutex.c</a><li>XMutex_GetStatus() <h3><a class="anchor" id="index_o">- o -</a></h3><ul>
: <a class="el" href="xmutex_8c.html#55eae2392bd9d0db37cf219cff46807b">xmutex.c</a><li>XMutex_GetUser() <li>OWNER_MASK
: <a class="el" href="xmutex_8c.html#127d6d7fbffafcea12f60241e778a9aa">xmutex.c</a><li>XMutex_IsLocked() : <a class="el" href="xmutex__hw_8h.html#a97587665957065c60155f02edb2d195d">xmutex_hw.h</a>
: <a class="el" href="xmutex_8c.html#534e5652ec502b9143fa9710d6159cce">xmutex.c</a><li>XMutex_Lock() </li>
: <a class="el" href="xmutex_8c.html#cd8ce9ec19b4e949d66f23c56fb529f5">xmutex.c</a><li>XMutex_ReadReg <li>OWNER_SHIFT
: <a class="el" href="xmutex__hw_8h.html#a816305f630601c4d710b9f3e808bf51">xmutex_hw.h</a><li>XMutex_SelfTest() : <a class="el" href="xmutex__hw_8h.html#ad3725eb84e9d09431334eecbcf66bcd1">xmutex_hw.h</a>
: <a class="el" href="xmutex__selftest_8c.html#63fe6504008f00ed771e28d35de1a3c7">xmutex_selftest.c</a><li>XMutex_SetUser() </li>
: <a class="el" href="xmutex_8c.html#fcbbce6ca788475a9f64a15d26da2b33">xmutex.c</a><li>XMutex_Trylock() </ul>
: <a class="el" href="xmutex_8c.html#4d8ec1fd7ded72c8a41252d1a01a3495">xmutex.c</a><li>XMutex_Unlock()
: <a class="el" href="xmutex_8c.html#40ee82db86b1d11f43092cd949b78eb3">xmutex.c</a><li>XMutex_WriteReg
: <a class="el" href="xmutex__hw_8h.html#6758828f46a00f7d7f996c710711622f">xmutex_hw.h</a></ul> <h3><a class="anchor" id="index_x">- x -</a></h3><ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <li>XMU_MUTEX_OFFSET
: <a class="el" href="xmutex__hw_8h.html#ac14e6e73d44fa8510ea7016607af6824">xmutex_hw.h</a>
</li>
<li>XMU_MUTEX_REG_OFFSET
: <a class="el" href="xmutex__hw_8h.html#ac717e990a2cbe85f19525c46aefc84b6">xmutex_hw.h</a>
</li>
<li>XMU_USER_REG_OFFSET
: <a class="el" href="xmutex__hw_8h.html#a7317a6291745987d25c994702005fff2">xmutex_hw.h</a>
</li>
<li>XMutex_CfgInitialize()
: <a class="el" href="xmutex_8c.html#a250cfb7229128feb084799a476d423d6">xmutex.c</a>
, <a class="el" href="xmutex_8h.html#a250cfb7229128feb084799a476d423d6">xmutex.h</a>
</li>
<li>XMutex_ConfigTable
: <a class="el" href="xmutex__g_8c.html#aa6144336e4a9674cb9a3f2c5c0f0f79c">xmutex_g.c</a>
, <a class="el" href="xmutex__sinit_8c.html#aa6144336e4a9674cb9a3f2c5c0f0f79c">xmutex_sinit.c</a>
</li>
<li>XMutex_GetStatus()
: <a class="el" href="xmutex_8c.html#a0fcbb23b06dc9fb716e3812696321f66">xmutex.c</a>
, <a class="el" href="xmutex_8h.html#a0fcbb23b06dc9fb716e3812696321f66">xmutex.h</a>
</li>
<li>XMutex_GetUser()
: <a class="el" href="xmutex_8c.html#ad7d5c5cd3b24ffee6dcc093b98c8546a">xmutex.c</a>
, <a class="el" href="xmutex_8h.html#ad7d5c5cd3b24ffee6dcc093b98c8546a">xmutex.h</a>
</li>
<li>XMUTEX_H
: <a class="el" href="xmutex_8h.html#a12f26d74626ae4179bad889dc5a3e6c9">xmutex.h</a>
</li>
<li>XMUTEX_HW_H
: <a class="el" href="xmutex__hw_8h.html#a60f85a9b89886d33d2e255bcf8abb0f2">xmutex_hw.h</a>
</li>
<li>XMutex_IsLocked()
: <a class="el" href="xmutex_8c.html#a37302270d3c1c86dc0bffdfc7043b902">xmutex.c</a>
, <a class="el" href="xmutex_8h.html#a37302270d3c1c86dc0bffdfc7043b902">xmutex.h</a>
</li>
<li>XMutex_Lock()
: <a class="el" href="xmutex_8c.html#a1255fbeea64f519d8def63e542ce8703">xmutex.c</a>
, <a class="el" href="xmutex_8h.html#a1255fbeea64f519d8def63e542ce8703">xmutex.h</a>
</li>
<li>XMutex_LookupConfig()
: <a class="el" href="xmutex_8h.html#a9b36fec5e8de70e5338132b29709f76a">xmutex.h</a>
, <a class="el" href="xmutex__sinit_8c.html#a9b36fec5e8de70e5338132b29709f76a">xmutex_sinit.c</a>
</li>
<li>XMutex_Offset
: <a class="el" href="xmutex__hw_8h.html#ac12aae3b150f35f5b214c329ed88b0d8">xmutex_hw.h</a>
</li>
<li>XMutex_ReadReg
: <a class="el" href="xmutex__hw_8h.html#ac521c86ba5c4f2bad8f73e515897a766">xmutex_hw.h</a>
</li>
<li>XMutex_SelfTest()
: <a class="el" href="xmutex_8h.html#a1599a86dd180f3bd789a2fc472e9aa29">xmutex.h</a>
, <a class="el" href="xmutex__selftest_8c.html#a1599a86dd180f3bd789a2fc472e9aa29">xmutex_selftest.c</a>
</li>
<li>XMutex_SetUser()
: <a class="el" href="xmutex_8h.html#a941e13d2534884adf4926f05bae3966e">xmutex.h</a>
, <a class="el" href="xmutex_8c.html#a941e13d2534884adf4926f05bae3966e">xmutex.c</a>
</li>
<li>XMutex_Trylock()
: <a class="el" href="xmutex_8h.html#af1857cffa94ba8b3bdf491f1a0096340">xmutex.h</a>
, <a class="el" href="xmutex_8c.html#af1857cffa94ba8b3bdf491f1a0096340">xmutex.c</a>
</li>
<li>XMutex_Unlock()
: <a class="el" href="xmutex_8c.html#a82790dd21650e2b03e2c0a0f69a605d3">xmutex.c</a>
, <a class="el" href="xmutex_8h.html#a82790dd21650e2b03e2c0a0f69a605d3">xmutex.h</a>
</li>
<li>XMutex_WriteReg
: <a class="el" href="xmutex__hw_8h.html#a33160589a1793006209e4e259ca7de35">xmutex_hw.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

98
XilinxProcessorIPLib/drivers/mutex/doc/html/api/globals_defs.html
View file

@ -2,41 +2,77 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver mutex v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li><a href="globals.html"><span>All</span></a></li> </ul>
<li><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li id="current"><a href="globals_defs.html"><span>Defines</span></a></li> <div class="tabs">
</ul> <ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li class="current"><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div> </div>
&nbsp; <div class="contents">
<p> &nbsp;<ul>
<ul>
<li>LOCKED_BIT <li>LOCKED_BIT
: <a class="el" href="xmutex__hw_8h.html#4fc77b2601b1ea7abdfb64a06b1cd1fb">xmutex_hw.h</a><li>OWNER_MASK : <a class="el" href="xmutex__hw_8h.html#a086991b467a934c97022a305bb957977">xmutex_hw.h</a>
: <a class="el" href="xmutex__hw_8h.html#cfe4cc17f438ed2613082cd60f49fc4d">xmutex_hw.h</a><li>OWNER_SHIFT </li>
: <a class="el" href="xmutex__hw_8h.html#8ec2c7708e3b28590514f57108cd3a81">xmutex_hw.h</a><li>XMU_MUTEX_REG_OFFSET <li>OWNER_MASK
: <a class="el" href="xmutex__hw_8h.html#a523470c9ee0a5b3684cd6bae8c8d013">xmutex_hw.h</a><li>XMU_USER_REG_OFFSET : <a class="el" href="xmutex__hw_8h.html#a97587665957065c60155f02edb2d195d">xmutex_hw.h</a>
: <a class="el" href="xmutex__hw_8h.html#7292f56c48208381c8070d405d20052b">xmutex_hw.h</a><li>XMutex_ReadReg </li>
: <a class="el" href="xmutex__hw_8h.html#a816305f630601c4d710b9f3e808bf51">xmutex_hw.h</a><li>XMutex_WriteReg <li>OWNER_SHIFT
: <a class="el" href="xmutex__hw_8h.html#6758828f46a00f7d7f996c710711622f">xmutex_hw.h</a></ul> : <a class="el" href="xmutex__hw_8h.html#ad3725eb84e9d09431334eecbcf66bcd1">xmutex_hw.h</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
<li>XMU_MUTEX_OFFSET
: <a class="el" href="xmutex__hw_8h.html#ac14e6e73d44fa8510ea7016607af6824">xmutex_hw.h</a>
</li>
<li>XMU_MUTEX_REG_OFFSET
: <a class="el" href="xmutex__hw_8h.html#ac717e990a2cbe85f19525c46aefc84b6">xmutex_hw.h</a>
</li>
<li>XMU_USER_REG_OFFSET
: <a class="el" href="xmutex__hw_8h.html#a7317a6291745987d25c994702005fff2">xmutex_hw.h</a>
</li>
<li>XMUTEX_H
: <a class="el" href="xmutex_8h.html#a12f26d74626ae4179bad889dc5a3e6c9">xmutex.h</a>
</li>
<li>XMUTEX_HW_H
: <a class="el" href="xmutex__hw_8h.html#a60f85a9b89886d33d2e255bcf8abb0f2">xmutex_hw.h</a>
</li>
<li>XMutex_Offset
: <a class="el" href="xmutex__hw_8h.html#ac12aae3b150f35f5b214c329ed88b0d8">xmutex_hw.h</a>
</li>
<li>XMutex_ReadReg
: <a class="el" href="xmutex__hw_8h.html#ac521c86ba5c4f2bad8f73e515897a766">xmutex_hw.h</a>
</li>
<li>XMutex_WriteReg
: <a class="el" href="xmutex__hw_8h.html#a33160589a1793006209e4e259ca7de35">xmutex_hw.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

107
XilinxProcessorIPLib/drivers/mutex/doc/html/api/globals_func.html
View file

@ -2,43 +2,84 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver mutex v4_0: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li><a href="globals.html"><span>All</span></a></li> </ul>
<li id="current"><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li><a href="globals_defs.html"><span>Defines</span></a></li> <div class="tabs">
</ul> <ul>
<li><a href="globals.html"><span>All</span></a></li>
<li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div> </div>
&nbsp; <div class="contents">
<p> &nbsp;<ul>
<ul>
<li>XMutex_CfgInitialize() <li>XMutex_CfgInitialize()
: <a class="el" href="xmutex_8c.html#dc27f84b9e6ead30caefc29c5d1859f3">xmutex.c</a><li>XMutex_GetStatus() : <a class="el" href="xmutex_8c.html#a250cfb7229128feb084799a476d423d6">xmutex.c</a>
: <a class="el" href="xmutex_8c.html#55eae2392bd9d0db37cf219cff46807b">xmutex.c</a><li>XMutex_GetUser() , <a class="el" href="xmutex_8h.html#a250cfb7229128feb084799a476d423d6">xmutex.h</a>
: <a class="el" href="xmutex_8c.html#127d6d7fbffafcea12f60241e778a9aa">xmutex.c</a><li>XMutex_IsLocked() </li>
: <a class="el" href="xmutex_8c.html#534e5652ec502b9143fa9710d6159cce">xmutex.c</a><li>XMutex_Lock() <li>XMutex_GetStatus()
: <a class="el" href="xmutex_8c.html#cd8ce9ec19b4e949d66f23c56fb529f5">xmutex.c</a><li>XMutex_SelfTest() : <a class="el" href="xmutex_8h.html#a0fcbb23b06dc9fb716e3812696321f66">xmutex.h</a>
: <a class="el" href="xmutex__selftest_8c.html#63fe6504008f00ed771e28d35de1a3c7">xmutex_selftest.c</a><li>XMutex_SetUser() , <a class="el" href="xmutex_8c.html#a0fcbb23b06dc9fb716e3812696321f66">xmutex.c</a>
: <a class="el" href="xmutex_8c.html#fcbbce6ca788475a9f64a15d26da2b33">xmutex.c</a><li>XMutex_Trylock() </li>
: <a class="el" href="xmutex_8c.html#4d8ec1fd7ded72c8a41252d1a01a3495">xmutex.c</a><li>XMutex_Unlock() <li>XMutex_GetUser()
: <a class="el" href="xmutex_8c.html#40ee82db86b1d11f43092cd949b78eb3">xmutex.c</a></ul> : <a class="el" href="xmutex_8c.html#ad7d5c5cd3b24ffee6dcc093b98c8546a">xmutex.c</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. , <a class="el" href="xmutex_8h.html#ad7d5c5cd3b24ffee6dcc093b98c8546a">xmutex.h</a>
</li>
<li>XMutex_IsLocked()
: <a class="el" href="xmutex_8h.html#a37302270d3c1c86dc0bffdfc7043b902">xmutex.h</a>
, <a class="el" href="xmutex_8c.html#a37302270d3c1c86dc0bffdfc7043b902">xmutex.c</a>
</li>
<li>XMutex_Lock()
: <a class="el" href="xmutex_8c.html#a1255fbeea64f519d8def63e542ce8703">xmutex.c</a>
, <a class="el" href="xmutex_8h.html#a1255fbeea64f519d8def63e542ce8703">xmutex.h</a>
</li>
<li>XMutex_LookupConfig()
: <a class="el" href="xmutex_8h.html#a9b36fec5e8de70e5338132b29709f76a">xmutex.h</a>
, <a class="el" href="xmutex__sinit_8c.html#a9b36fec5e8de70e5338132b29709f76a">xmutex_sinit.c</a>
</li>
<li>XMutex_SelfTest()
: <a class="el" href="xmutex_8h.html#a1599a86dd180f3bd789a2fc472e9aa29">xmutex.h</a>
, <a class="el" href="xmutex__selftest_8c.html#a1599a86dd180f3bd789a2fc472e9aa29">xmutex_selftest.c</a>
</li>
<li>XMutex_SetUser()
: <a class="el" href="xmutex_8c.html#a941e13d2534884adf4926f05bae3966e">xmutex.c</a>
, <a class="el" href="xmutex_8h.html#a941e13d2534884adf4926f05bae3966e">xmutex.h</a>
</li>
<li>XMutex_Trylock()
: <a class="el" href="xmutex_8h.html#af1857cffa94ba8b3bdf491f1a0096340">xmutex.h</a>
, <a class="el" href="xmutex_8c.html#af1857cffa94ba8b3bdf491f1a0096340">xmutex.c</a>
</li>
<li>XMutex_Unlock()
: <a class="el" href="xmutex_8h.html#a82790dd21650e2b03e2c0a0f69a605d3">xmutex.h</a>
, <a class="el" href="xmutex_8c.html#a82790dd21650e2b03e2c0a0f69a605d3">xmutex.c</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

49
XilinxProcessorIPLib/drivers/mutex/doc/html/api/globals_vars.html Executable file
View file

@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver mutex v4_0: Class Members
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li class="current"><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp;<ul>
<li>XMutex_ConfigTable
: <a class="el" href="xmutex__g_8c.html#aa6144336e4a9674cb9a3f2c5c0f0f79c">xmutex_g.c</a>
, <a class="el" href="xmutex__sinit_8c.html#aa6144336e4a9674cb9a3f2c5c0f0f79c">xmutex_sinit.c</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

65
XilinxProcessorIPLib/drivers/mutex/doc/html/api/index.html
View file

@ -2,40 +2,46 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
mutex v4_0 Xilinx Driver mutex v4_0: mutex v4_0
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li id="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li class="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<h1>mutex v4_0</h1> <li><a href="files.html"><span>Files</span></a></li>
<p> </ul>
The Xilinx Mutex driver. This driver supports the Xilinx Mutex Core. More detailed description of the driver operation can be found in the <a class="el" href="xmutex_8c.html">xmutex.c</a> file.<p> </div>
<b>Features</b><p> </div>
The Xilinx Mutex supports the following features:<ul> <div class="contents">
<li>Provide for synchronization between multiple processors in the system.</li><li>Write to lock scheme with CPU ID encoded.</li><li>Multiple Mutex locks within a single instance of the device.</li><li>An optional user field within each Mutex that can be read or written to by software.</li></ul> <h1>mutex v4_0</h1><p>The Xilinx Mutex driver. This driver supports the Xilinx Mutex Core. More detailed description of the driver operation can be found in the <a class="el" href="xmutex_8c.html">xmutex.c</a> file.</p>
<p> <p><b>Features</b></p>
This driver is intended to be RTOS and processor independent. Any needs for dynamic memory management, threads or thread mutual exclusion, virtual memory, or cache control must be satisfied by the layer above this driver. The effective address provided to the <a class="el" href="xmutex_8c.html#dc27f84b9e6ead30caefc29c5d1859f3">XMutex_CfgInitialize()</a> function can be either the real, physical address or the remapped virtual address. The remapping of this address occurs above this driver, no remapping occurs within the driver itself.<p> <p>The Xilinx Mutex supports the following features:</p>
<b>Initialization &amp; Configuration</b><p>
The <a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> structure is used by the driver to configure itself. This configuration structure is typically created by the tool-chain based on HW build properties.<p>
To support multiple runtime loading and initialization strategies employed by various operating systems, the driver instance can be initialized in the following way:<p>
<ul> <ul>
<li>XMutex_LookupConfig (DeviceId) - Use the device identifier to find the static configuration structure defined in <a class="el" href="xmutex__g_8c.html">XMutex_g.c</a>. This is setup by the tools. For some operating systems the config structure will be initialized by the software and this call is not needed. This function returns the CfgPtr argument used by the CfgInitialize function described below.</li></ul> <li>Provide for synchronization between multiple processors in the system.</li>
<p> <li>Write to lock scheme with CPU ID encoded.</li>
<li>Multiple Mutex locks within a single instance of the device.</li>
<li>An optional user field within each Mutex that can be read or written to by software.</li>
</ul>
<p>This driver is intended to be RTOS and processor independent. Any needs for dynamic memory management, threads or thread mutual exclusion, virtual memory, or cache control must be satisfied by the layer above this driver. The effective address provided to the <a class="el" href="xmutex_8c.html#a250cfb7229128feb084799a476d423d6">XMutex_CfgInitialize()</a> function can be either the real, physical address or the remapped virtual address. The remapping of this address occurs above this driver, no remapping occurs within the driver itself.</p>
<p><b>Initialization &amp; Configuration</b></p>
<p>The <a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> structure is used by the driver to configure itself. This configuration structure is typically created by the tool-chain based on HW build properties.</p>
<p>To support multiple runtime loading and initialization strategies employed by various operating systems, the driver instance can be initialized in the following way:</p>
<ul> <ul>
<li>XMutex_CfgInitialize (InstancePtr, ConfigPtr, EffectiveAddress) - Uses a configuration structure provided by the caller. If running in a system with address translation, the provided virtual memory base address replaces the physical address present in the configuration structure. The EffectiveAddress argument is required regardless of operating system environment, i.e. in standalone, ConfigPtr-&gt;BaseAddress is recommended and not the xparameters definition..</li></ul> <li>XMutex_LookupConfig (DeviceId) - Use the device identifier to find the static configuration structure defined in XMutex_g.c. This is setup by the tools. For some operating systems the config structure will be initialized by the software and this call is not needed. This function returns the CfgPtr argument used by the CfgInitialize function described below.</li>
<p> </ul>
<ul>
<li>XMutex_CfgInitialize (InstancePtr, ConfigPtr, EffectiveAddress) - Uses a configuration structure provided by the caller. If running in a system with address translation, the provided virtual memory base address replaces the physical address present in the configuration structure. The EffectiveAddress argument is required regardless of operating system environment, i.e. in standalone, ConfigPtr-&gt;BaseAddress is recommended and not the xparameters definition..</li>
</ul>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- -------- ----------------------------------------------- ----- ---- -------- -----------------------------------------------
1.00a va First release 1.00a va First release
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS
@ -50,4 +56,9 @@ To support multiple runtime loading and initialization strategies employed by va
3.02a bss 01/31/13 Updated driver tcl to fix CR #679127 3.02a bss 01/31/13 Updated driver tcl to fix CR #679127
4.0 adk 19/12/13 Updated as per the New Tcl API's 4.0 adk 19/12/13 Updated as per the New Tcl API's
4.00a bss 03/05/14 Modified XMutex_CfgInitialize to fix CR# 770096 4.00a bss 03/05/14 Modified XMutex_CfgInitialize to fix CR# 770096
</pre> Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </pre> </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

47
XilinxProcessorIPLib/drivers/mutex/doc/html/api/struct_x_mutex-members.html
View file

@ -2,26 +2,37 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Member List Xilinx Driver mutex v4_0: Member List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XMutex Member List</h1>This is the complete list of members for <a class="el" href="struct_x_mutex.html">XMutex</a>, including all inherited members.<p><table> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_mutex.html#fa535ffb25e1fd20341652f9be21e06e">Config</a></td><td><a class="el" href="struct_x_mutex.html">XMutex</a></td><td></td></tr> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_mutex.html#217c41df00b2eee11e1009f5e63905ed">IsReady</a></td><td><a class="el" href="struct_x_mutex.html">XMutex</a></td><td></td></tr> </ul>
</table>Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
</div>
<div class="contents">
<h1>XMutex Member List</h1>This is the complete list of members for <a class="el" href="struct_x_mutex.html">XMutex</a>, including all inherited members.<table>
<tr class="memlist"><td><a class="el" href="struct_x_mutex.html#a7546022d3c935b840c762b763b94b460">Config</a></td><td><a class="el" href="struct_x_mutex.html">XMutex</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_mutex.html#aab67818beece616d3da30ef3944681e8">IsReady</a></td><td><a class="el" href="struct_x_mutex.html">XMutex</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

127
XilinxProcessorIPLib/drivers/mutex/doc/html/api/struct_x_mutex.html
View file

@ -2,85 +2,78 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
XMutex Struct Reference Xilinx Driver mutex v4_0: XMutex Struct Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XMutex Struct Reference</h1><!-- doxytag: class="XMutex" --><code>#include &lt;xmutex.h&gt;</code> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<p> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<a href="struct_x_mutex-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> </ul>
The XMutex driver instance data. The user is required to allocate a variable of this type for every Mutex device in the system. A pointer to a variable of this type is then passed to the driver API functions. </div>
<p> </div>
<div class="contents">
<h1>XMutex Struct Reference</h1><!-- doxytag: class="XMutex" -->
<p><code>#include &lt;xmutex.h&gt;</code></p>
<p><a href="struct_x_mutex-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex.html#a7546022d3c935b840c762b763b94b460">Config</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex.html#fa535ffb25e1fd20341652f9be21e06e">Config</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex.html#aab67818beece616d3da30ef3944681e8">IsReady</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex.html#217c41df00b2eee11e1009f5e63905ed">IsReady</a></td></tr>
</table> </table>
<hr><h2>Member Data Documentation</h2> <hr/><a name="_details"></a><h2>Detailed Description</h2>
<a class="anchor" name="fa535ffb25e1fd20341652f9be21e06e"></a><!-- doxytag: member="XMutex::Config" ref="fa535ffb25e1fd20341652f9be21e06e" args="" --><p> <p>The <a class="el" href="struct_x_mutex.html">XMutex</a> driver instance data. The user is required to allocate a variable of this type for every Mutex device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
<table class="mdTable" cellpadding="2" cellspacing="0"> <hr/><h2>Member Data Documentation</h2>
<tr> <a class="anchor" id="a7546022d3c935b840c762b763b94b460"></a><!-- doxytag: member="XMutex::Config" ref="a7546022d3c935b840c762b763b94b460" args="" -->
<td class="mdRow"> <div class="memitem">
<table cellpadding="0" cellspacing="0" border="0"> <div class="memproto">
<table class="memname">
<tr> <tr>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> <a class="el" href="struct_x_mutex.html#fa535ffb25e1fd20341652f9be21e06e">XMutex::Config</a> </td> <td class="memname"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> <a class="el" href="struct_x_mutex.html#a7546022d3c935b840c762b763b94b460">XMutex::Config</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Configuration data, includes base address </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Configuration data, includes base address </td> </div>
</tr> <a class="anchor" id="aab67818beece616d3da30ef3944681e8"></a><!-- doxytag: member="XMutex::IsReady" ref="aab67818beece616d3da30ef3944681e8" args="" -->
</table> <div class="memitem">
<a class="anchor" name="217c41df00b2eee11e1009f5e63905ed"></a><!-- doxytag: member="XMutex::IsReady" ref="217c41df00b2eee11e1009f5e63905ed" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_mutex.html#217c41df00b2eee11e1009f5e63905ed">XMutex::IsReady</a> </td> <td class="memname">u32 <a class="el" href="struct_x_mutex.html#aab67818beece616d3da30ef3944681e8">XMutex::IsReady</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Device is initialized and ready </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr> </div>
<td> </div>
&nbsp; <hr/>The documentation for this struct was generated from the following file:<ul>
</td> <li><a class="el" href="xmutex_8h.html">xmutex.h</a></li>
<td> </ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
Device is initialized and ready </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xmutex.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

51
XilinxProcessorIPLib/drivers/mutex/doc/html/api/struct_x_mutex___config-members.html
View file

@ -2,28 +2,39 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Member List Xilinx Driver mutex v4_0: Member List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XMutex_Config Member List</h1>This is the complete list of members for <a class="el" href="struct_x_mutex___config.html">XMutex_Config</a>, including all inherited members.<p><table> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_mutex___config.html#2fac08c24c8373333b9f2a62008c62f3">BaseAddress</a></td><td><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td></td></tr> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<tr class="memlist"><td><a class="el" href="struct_x_mutex___config.html#d0263c6cf0769cabc86cfe88226d204b">DeviceId</a></td><td><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td></td></tr> </ul>
<tr class="memlist"><td><a class="el" href="struct_x_mutex___config.html#d296e9a137bcc27fec7c06eecd30ee3e">NumMutex</a></td><td><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td></td></tr> </div>
<tr class="memlist"><td><a class="el" href="struct_x_mutex___config.html#f486f2fe492689adb9c74eee489f77d3">UserReg</a></td><td><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td></td></tr> </div>
</table>Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <div class="contents">
<h1>XMutex_Config Member List</h1>This is the complete list of members for <a class="el" href="struct_x_mutex___config.html">XMutex_Config</a>, including all inherited members.<table>
<tr class="memlist"><td><a class="el" href="struct_x_mutex___config.html#a99c7f36433d122562bc4a9e488c83250">BaseAddress</a></td><td><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_mutex___config.html#abfface1411085aac250f14a09f79877f">DeviceId</a></td><td><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_mutex___config.html#a6a5e5f976fbe7c908f0595ee6d6ed0ee">NumMutex</a></td><td><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_mutex___config.html#aee8b1e02a59b48c5b337d6701e3661ce">UserReg</a></td><td><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

191
XilinxProcessorIPLib/drivers/mutex/doc/html/api/struct_x_mutex___config.html
View file

@ -2,135 +2,108 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
XMutex_Config Struct Reference Xilinx Driver mutex v4_0: XMutex_Config Struct Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>XMutex_Config Struct Reference</h1><!-- doxytag: class="XMutex_Config" --><code>#include &lt;xmutex.h&gt;</code> <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<p> <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
<a href="struct_x_mutex___config-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> </ul>
This typedef contains configuration information for the device. </div>
<p> </div>
<div class="contents">
<h1>XMutex_Config Struct Reference</h1><!-- doxytag: class="XMutex_Config" -->
<p><code>#include &lt;xmutex.h&gt;</code></p>
<p><a href="struct_x_mutex___config-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html#abfface1411085aac250f14a09f79877f">DeviceId</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html#d0263c6cf0769cabc86cfe88226d204b">DeviceId</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html#a99c7f36433d122562bc4a9e488c83250">BaseAddress</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html#a6a5e5f976fbe7c908f0595ee6d6ed0ee">NumMutex</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html#2fac08c24c8373333b9f2a62008c62f3">BaseAddress</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html#aee8b1e02a59b48c5b337d6701e3661ce">UserReg</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html#d296e9a137bcc27fec7c06eecd30ee3e">NumMutex</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html#f486f2fe492689adb9c74eee489f77d3">UserReg</a></td></tr>
</table> </table>
<hr><h2>Member Data Documentation</h2> <hr/><a name="_details"></a><h2>Detailed Description</h2>
<a class="anchor" name="2fac08c24c8373333b9f2a62008c62f3"></a><!-- doxytag: member="XMutex_Config::BaseAddress" ref="2fac08c24c8373333b9f2a62008c62f3" args="" --><p> <p>This typedef contains configuration information for the device. </p>
<table class="mdTable" cellpadding="2" cellspacing="0"> <hr/><h2>Member Data Documentation</h2>
<tr> <a class="anchor" id="a99c7f36433d122562bc4a9e488c83250"></a><!-- doxytag: member="XMutex_Config::BaseAddress" ref="a99c7f36433d122562bc4a9e488c83250" args="" -->
<td class="mdRow"> <div class="memitem">
<table cellpadding="0" cellspacing="0" border="0"> <div class="memproto">
<table class="memname">
<tr> <tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_mutex___config.html#2fac08c24c8373333b9f2a62008c62f3">XMutex_Config::BaseAddress</a> </td> <td class="memname">u32 <a class="el" href="struct_x_mutex___config.html#a99c7f36433d122562bc4a9e488c83250">XMutex_Config::BaseAddress</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Register base address </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Register base address </td> </div>
</tr> <a class="anchor" id="abfface1411085aac250f14a09f79877f"></a><!-- doxytag: member="XMutex_Config::DeviceId" ref="abfface1411085aac250f14a09f79877f" args="" -->
</table> <div class="memitem">
<a class="anchor" name="d0263c6cf0769cabc86cfe88226d204b"></a><!-- doxytag: member="XMutex_Config::DeviceId" ref="d0263c6cf0769cabc86cfe88226d204b" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u16 <a class="el" href="struct_x_mutex___config.html#d0263c6cf0769cabc86cfe88226d204b">XMutex_Config::DeviceId</a> </td> <td class="memname">u16 <a class="el" href="struct_x_mutex___config.html#abfface1411085aac250f14a09f79877f">XMutex_Config::DeviceId</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Unique ID of device </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Unique ID of device </td> </div>
</tr> <a class="anchor" id="a6a5e5f976fbe7c908f0595ee6d6ed0ee"></a><!-- doxytag: member="XMutex_Config::NumMutex" ref="a6a5e5f976fbe7c908f0595ee6d6ed0ee" args="" -->
</table> <div class="memitem">
<a class="anchor" name="d296e9a137bcc27fec7c06eecd30ee3e"></a><!-- doxytag: member="XMutex_Config::NumMutex" ref="d296e9a137bcc27fec7c06eecd30ee3e" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_mutex___config.html#d296e9a137bcc27fec7c06eecd30ee3e">XMutex_Config::NumMutex</a> </td> <td class="memname">u32 <a class="el" href="struct_x_mutex___config.html#a6a5e5f976fbe7c908f0595ee6d6ed0ee">XMutex_Config::NumMutex</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Number of Mutexes in this device </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Number of Mutexes in this device </td> </div>
</tr> <a class="anchor" id="aee8b1e02a59b48c5b337d6701e3661ce"></a><!-- doxytag: member="XMutex_Config::UserReg" ref="aee8b1e02a59b48c5b337d6701e3661ce" args="" -->
</table> <div class="memitem">
<a class="anchor" name="f486f2fe492689adb9c74eee489f77d3"></a><!-- doxytag: member="XMutex_Config::UserReg" ref="f486f2fe492689adb9c74eee489f77d3" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">u8 <a class="el" href="struct_x_mutex___config.html#f486f2fe492689adb9c74eee489f77d3">XMutex_Config::UserReg</a> </td> <td class="memname">u8 <a class="el" href="struct_x_mutex___config.html#aee8b1e02a59b48c5b337d6701e3661ce">XMutex_Config::UserReg</a></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>User Register, access not controlled by Mutex </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr> </div>
<td> </div>
&nbsp; <hr/>The documentation for this struct was generated from the following file:<ul>
</td> <li><a class="el" href="xmutex_8h.html">xmutex.h</a></li>
<td> </ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
User Register, access not controlled by Mutex </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xmutex.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

15
XilinxProcessorIPLib/drivers/mutex/doc/html/api/tabs.css
View file

@ -32,7 +32,7 @@ DIV.tabs A
float : left; float : left;
background : url("tab_r.gif") no-repeat right top; background : url("tab_r.gif") no-repeat right top;
border-bottom : 1px solid #84B0C7; border-bottom : 1px solid #84B0C7;
font-size : x-small; font-size : 80%;
font-weight : bold; font-weight : bold;
text-decoration : none; text-decoration : none;
} }
@ -57,7 +57,7 @@ DIV.tabs SPAN
white-space : nowrap; white-space : nowrap;
} }
DIV.tabs INPUT DIV.tabs #MSearchBox
{ {
float : right; float : right;
display : inline; display : inline;
@ -66,7 +66,7 @@ DIV.tabs INPUT
DIV.tabs TD DIV.tabs TD
{ {
font-size : x-small; font-size : 80%;
font-weight : bold; font-weight : bold;
text-decoration : none; text-decoration : none;
} }
@ -82,21 +82,24 @@ DIV.tabs A:hover SPAN
background-position: 0% -150px; background-position: 0% -150px;
} }
DIV.tabs LI#current A DIV.tabs LI.current A
{ {
background-position: 100% -150px; background-position: 100% -150px;
border-width : 0px; border-width : 0px;
} }
DIV.tabs LI#current SPAN DIV.tabs LI.current SPAN
{ {
background-position: 0% -150px; background-position: 0% -150px;
padding-bottom : 6px; padding-bottom : 6px;
} }
DIV.nav DIV.navpath
{ {
background : none; background : none;
border : none; border : none;
border-bottom : 1px solid #84B0C7; border-bottom : 1px solid #84B0C7;
text-align : center;
margin : 2px;
padding : 2px;
} }

637
XilinxProcessorIPLib/drivers/mutex/doc/html/api/xmutex_8c.html
View file

@ -2,30 +2,51 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
xmutex.c File Reference Xilinx Driver mutex v4_0: xmutex.c File Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>xmutex.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
Contains required functions for the <a class="el" href="struct_x_mutex.html">XMutex</a> driver.<p> <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xmutex.c File Reference</h1><code>#include &lt;string.h&gt;</code><br/>
<code>#include &quot;<a class="el" href="xmutex_8h.html">xmutex.h</a>&quot;</code><br/>
<code>#include &quot;xparameters.h&quot;</code><br/>
<code>#include &quot;xil_types.h&quot;</code><br/>
<code>#include &quot;xil_assert.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="xmutex_8c.html#a250cfb7229128feb084799a476d423d6">XMutex_CfgInitialize</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, <a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> *ConfigPtr, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#a1255fbeea64f519d8def63e542ce8703">XMutex_Lock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#af1857cffa94ba8b3bdf491f1a0096340">XMutex_Trylock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#a82790dd21650e2b03e2c0a0f69a605d3">XMutex_Unlock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#a37302270d3c1c86dc0bffdfc7043b902">XMutex_IsLocked</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#a0fcbb23b06dc9fb716e3812696321f66">XMutex_GetStatus</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 *Locked, u32 *Owner)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#ad7d5c5cd3b24ffee6dcc093b98c8546a">XMutex_GetUser</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 *User)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#a941e13d2534884adf4926f05bae3966e">XMutex_SetUser</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 User)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Contains required functions for the <a class="el" href="struct_x_mutex.html">XMutex</a> driver.</p>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- -------- ----------------------------------------------- ----- ---- -------- -----------------------------------------------
1.00a va First release 1.00a va First release
1.00b ecm 06/01/07 Cleanup, new coding standard, check into XCS 1.00b ecm 06/01/07 Cleanup, new coding standard, check into XCS
@ -35,452 +56,372 @@ Contains required functions for the <a class="el" href="struct_x_mutex.html">XMu
3.00a hbm 10/15/09 Migrated to HAL phase 1 to use xil_io, xil_types, 3.00a hbm 10/15/09 Migrated to HAL phase 1 to use xil_io, xil_types,
and xil_assert. and xil_assert.
4.00a bss 03/05/14 Modified XMutex_CfgInitialize to fix CR# 770096 4.00a bss 03/05/14 Modified XMutex_CfgInitialize to fix CR# 770096
</pre> </pre> <hr/><h2>Function Documentation</h2>
<p> <a class="anchor" id="a250cfb7229128feb084799a476d423d6"></a><!-- doxytag: member="xmutex.c::XMutex_CfgInitialize" ref="a250cfb7229128feb084799a476d423d6" args="(XMutex *InstancePtr, XMutex_Config *ConfigPtr, u32 EffectiveAddress)" -->
<code>#include &lt;string.h&gt;</code><br> <div class="memitem">
<code>#include &quot;xmutex.h&quot;</code><br> <div class="memproto">
<code>#include &quot;xparameters.h&quot;</code><br> <table class="memname">
<code>#include &quot;xil_types.h&quot;</code><br>
<code>#include &quot;xil_assert.h&quot;</code><br>
<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">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#dc27f84b9e6ead30caefc29c5d1859f3">XMutex_CfgInitialize</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, <a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> *ConfigPtr, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#cd8ce9ec19b4e949d66f23c56fb529f5">XMutex_Lock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#4d8ec1fd7ded72c8a41252d1a01a3495">XMutex_Trylock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#40ee82db86b1d11f43092cd949b78eb3">XMutex_Unlock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#534e5652ec502b9143fa9710d6159cce">XMutex_IsLocked</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#55eae2392bd9d0db37cf219cff46807b">XMutex_GetStatus</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 *Locked, u32 *Owner)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#127d6d7fbffafcea12f60241e778a9aa">XMutex_GetUser</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 *User)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8c.html#fcbbce6ca788475a9f64a15d26da2b33">XMutex_SetUser</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 User)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="dc27f84b9e6ead30caefc29c5d1859f3"></a><!-- doxytag: member="xmutex.c::XMutex_CfgInitialize" ref="dc27f84b9e6ead30caefc29c5d1859f3" args="(XMutex *InstancePtr, XMutex_Config *ConfigPtr, u32 EffectiveAddress)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">int XMutex_CfgInitialize </td> <td class="memname">int XMutex_CfgInitialize </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td> <td class="paramname"> <em>InstancePtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>ConfigPtr</em>, </td> <td class="paramname"> <em>ConfigPtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u32&nbsp;</td> <td class="paramtype">u32&nbsp;</td>
<td class="mdname" nowrap> <em>EffectiveAddress</em></td> <td class="paramname"> <em>EffectiveAddress</em></td><td>&nbsp;</td>
</tr> </tr>
<tr> <tr>
<td class="md"></td> <td></td>
<td class="md">)&nbsp;</td> <td>)</td>
<td class="md" colspan="2"></td> <td></td><td></td><td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Initializes a specific Mutex instance/driver.</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Initializes a specific Mutex instance/driver.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ConfigPtr</em>&nbsp;</td><td>is the device configuration structure containing required HW build data. </td></tr> <tr><td valign="top"></td><td valign="top"><em>ConfigPtr</em>&nbsp;</td><td>is the device configuration structure containing required HW build data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddress</em>&nbsp;</td><td>is the Physical address of the hardware in a Virtual Memory operating system environment. It is the Base Address in a stand alone environment.</td></tr> <tr><td valign="top"></td><td valign="top"><em>EffectiveAddress</em>&nbsp;</td><td>is the Physical address of the hardware in a Virtual Memory operating system environment. It is the Base Address in a stand alone environment.</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul> <dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if initialization was successful</li></ul> <li>XST_SUCCESS if initialization was successful</li>
</ul>
</dd></dl> </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr> </div>
</table> </div>
<a class="anchor" name="55eae2392bd9d0db37cf219cff46807b"></a><!-- doxytag: member="xmutex.c::XMutex_GetStatus" ref="55eae2392bd9d0db37cf219cff46807b" args="(XMutex *InstancePtr, u8 MutexNumber, u32 *Locked, u32 *Owner)" --><p> <a class="anchor" id="a0fcbb23b06dc9fb716e3812696321f66"></a><!-- doxytag: member="xmutex.c::XMutex_GetStatus" ref="a0fcbb23b06dc9fb716e3812696321f66" args="(XMutex *InstancePtr, u8 MutexNumber, u32 *Locked, u32 *Owner)" -->
<table class="mdTable" cellpadding="2" cellspacing="0"> <div class="memitem">
<tr> <div class="memproto">
<td class="mdRow"> <table class="memname">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">void XMutex_GetStatus </td> <td class="memname">void XMutex_GetStatus </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td> <td class="paramname"> <em>InstancePtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u8&nbsp;</td> <td class="paramtype">u8&nbsp;</td>
<td class="mdname" nowrap> <em>MutexNumber</em>, </td> <td class="paramname"> <em>MutexNumber</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u32 *&nbsp;</td> <td class="paramtype">u32 *&nbsp;</td>
<td class="mdname" nowrap> <em>Locked</em>, </td> <td class="paramname"> <em>Locked</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u32 *&nbsp;</td> <td class="paramtype">u32 *&nbsp;</td>
<td class="mdname" nowrap> <em>Owner</em></td> <td class="paramname"> <em>Owner</em></td><td>&nbsp;</td>
</tr> </tr>
<tr> <tr>
<td class="md"></td> <td></td>
<td class="md">)&nbsp;</td> <td>)</td>
<td class="md" colspan="2"></td> <td></td><td></td><td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Gets the current status of a Mutex lock within a Mutex device.</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Gets the current status of a Mutex lock within a Mutex device.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1). </td></tr> <tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Locked</em>&nbsp;</td><td>is a pointer where the current lock status is stored. Sets memory pointed to by 'Locked' to 1 if the Mutex is locked and 0 if it is unlocked. </td></tr> <tr><td valign="top"></td><td valign="top"><em>Locked</em>&nbsp;</td><td>is a pointer where the current lock status is stored. Sets memory pointed to by 'Locked' to 1 if the Mutex is locked and 0 if it is unlocked. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Owner</em>&nbsp;</td><td>is a pointer where the current owner status is stored. . If the Mutex is locked, the memory pointed to by 'Owner' is updated to reflect the CPU ID that has currently locked this Mutex.</td></tr> <tr><td valign="top"></td><td valign="top"><em>Owner</em>&nbsp;</td><td>is a pointer where the current owner status is stored. . If the Mutex is locked, the memory pointed to by 'Owner' is updated to reflect the CPU ID that has currently locked this Mutex.</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl> <dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr> </div>
</table> </div>
<a class="anchor" name="127d6d7fbffafcea12f60241e778a9aa"></a><!-- doxytag: member="xmutex.c::XMutex_GetUser" ref="127d6d7fbffafcea12f60241e778a9aa" args="(XMutex *InstancePtr, u8 MutexNumber, u32 *User)" --><p> <a class="anchor" id="ad7d5c5cd3b24ffee6dcc093b98c8546a"></a><!-- doxytag: member="xmutex.c::XMutex_GetUser" ref="ad7d5c5cd3b24ffee6dcc093b98c8546a" args="(XMutex *InstancePtr, u8 MutexNumber, u32 *User)" -->
<table class="mdTable" cellpadding="2" cellspacing="0"> <div class="memitem">
<tr> <div class="memproto">
<td class="mdRow"> <table class="memname">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">int XMutex_GetUser </td> <td class="memname">int XMutex_GetUser </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td> <td class="paramname"> <em>InstancePtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u8&nbsp;</td> <td class="paramtype">u8&nbsp;</td>
<td class="mdname" nowrap> <em>MutexNumber</em>, </td> <td class="paramname"> <em>MutexNumber</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u32 *&nbsp;</td> <td class="paramtype">u32 *&nbsp;</td>
<td class="mdname" nowrap> <em>User</em></td> <td class="paramname"> <em>User</em></td><td>&nbsp;</td>
</tr> </tr>
<tr> <tr>
<td class="md"></td> <td></td>
<td class="md">)&nbsp;</td> <td>)</td>
<td class="md" colspan="2"></td> <td></td><td></td><td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Gets the USER register of a Mutex lock within a Mutex device.</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Gets the USER register of a Mutex lock within a Mutex device.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1). </td></tr> <tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>User</em>&nbsp;</td><td>is a pointer to an u32 where the current user register value is stored by this function. </td></tr> <tr><td valign="top"></td><td valign="top"><em>User</em>&nbsp;</td><td>is a pointer to an u32 where the current user register value is stored by this function. </td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul> <dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if successful. Memory pointed to by User is updated to reflect the contents of the user register.</li><li>XST_NO_FEATURE if the Mutex was not configured with a USER register.</li></ul> <li>XST_SUCCESS if successful. Memory pointed to by User is updated to reflect the contents of the user register.</li>
<li>XST_NO_FEATURE if the Mutex was not configured with a USER register.</li>
</ul>
</dd></dl> </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr> </div>
</table> </div>
<a class="anchor" name="534e5652ec502b9143fa9710d6159cce"></a><!-- doxytag: member="xmutex.c::XMutex_IsLocked" ref="534e5652ec502b9143fa9710d6159cce" args="(XMutex *InstancePtr, u8 MutexNumber)" --><p> <a class="anchor" id="a37302270d3c1c86dc0bffdfc7043b902"></a><!-- doxytag: member="xmutex.c::XMutex_IsLocked" ref="a37302270d3c1c86dc0bffdfc7043b902" args="(XMutex *InstancePtr, u8 MutexNumber)" -->
<table class="mdTable" cellpadding="2" cellspacing="0"> <div class="memitem">
<tr> <div class="memproto">
<td class="mdRow"> <table class="memname">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">int XMutex_IsLocked </td> <td class="memname">int XMutex_IsLocked </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td> <td class="paramname"> <em>InstancePtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u8&nbsp;</td> <td class="paramtype">u8&nbsp;</td>
<td class="mdname" nowrap> <em>MutexNumber</em></td> <td class="paramname"> <em>MutexNumber</em></td><td>&nbsp;</td>
</tr> </tr>
<tr> <tr>
<td class="md"></td> <td></td>
<td class="md">)&nbsp;</td> <td>)</td>
<td class="md" colspan="2"></td> <td></td><td></td><td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Gets the current lock state of a Mutex lock within a Mutex device.</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Gets the current lock state of a Mutex lock within a Mutex device.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr> <tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul> <dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>TRUE if locked</li><li>FALSE if unlocked</li></ul> <li>TRUE if locked</li>
<li>FALSE if unlocked</li>
</ul>
</dd></dl> </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr> </div>
</table> </div>
<a class="anchor" name="cd8ce9ec19b4e949d66f23c56fb529f5"></a><!-- doxytag: member="xmutex.c::XMutex_Lock" ref="cd8ce9ec19b4e949d66f23c56fb529f5" args="(XMutex *InstancePtr, u8 MutexNumber)" --><p> <a class="anchor" id="a1255fbeea64f519d8def63e542ce8703"></a><!-- doxytag: member="xmutex.c::XMutex_Lock" ref="a1255fbeea64f519d8def63e542ce8703" args="(XMutex *InstancePtr, u8 MutexNumber)" -->
<table class="mdTable" cellpadding="2" cellspacing="0"> <div class="memitem">
<tr> <div class="memproto">
<td class="mdRow"> <table class="memname">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">void XMutex_Lock </td> <td class="memname">void XMutex_Lock </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td> <td class="paramname"> <em>InstancePtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u8&nbsp;</td> <td class="paramtype">u8&nbsp;</td>
<td class="mdname" nowrap> <em>MutexNumber</em></td> <td class="paramname"> <em>MutexNumber</em></td><td>&nbsp;</td>
</tr> </tr>
<tr> <tr>
<td class="md"></td> <td></td>
<td class="md">)&nbsp;</td> <td>)</td>
<td class="md" colspan="2"></td> <td></td><td></td><td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Locks a particular Mutex lock within a Mutex device. Call blocks till the Mutex is locked.</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Locks a particular Mutex lock within a Mutex device. Call blocks till the Mutex is locked.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr> <tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd>None</dd></dl> <dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul> <dl class="note"><dt><b>Note:</b></dt><dd><ul>
<li>XMutex_Trylock is a blocking call. This call blocks until the user gets the lock.</li><li>Use XMutex_Trylock for a Non-Blocking call. The user gets the lock if it is available and returns immediately if the lock is not available. </li></ul> <li>XMutex_Trylock is a blocking call. This call blocks until the user gets the lock.</li>
<li>Use XMutex_Trylock for a Non-Blocking call. The user gets the lock if it is available and returns immediately if the lock is not available. </li>
</ul>
</dd></dl> </dd></dl>
</td>
</tr> </div>
</table> </div>
<a class="anchor" name="fcbbce6ca788475a9f64a15d26da2b33"></a><!-- doxytag: member="xmutex.c::XMutex_SetUser" ref="fcbbce6ca788475a9f64a15d26da2b33" args="(XMutex *InstancePtr, u8 MutexNumber, u32 User)" --><p> <a class="anchor" id="a941e13d2534884adf4926f05bae3966e"></a><!-- doxytag: member="xmutex.c::XMutex_SetUser" ref="a941e13d2534884adf4926f05bae3966e" args="(XMutex *InstancePtr, u8 MutexNumber, u32 User)" -->
<table class="mdTable" cellpadding="2" cellspacing="0"> <div class="memitem">
<tr> <div class="memproto">
<td class="mdRow"> <table class="memname">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">int XMutex_SetUser </td> <td class="memname">int XMutex_SetUser </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td> <td class="paramname"> <em>InstancePtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u8&nbsp;</td> <td class="paramtype">u8&nbsp;</td>
<td class="mdname" nowrap> <em>MutexNumber</em>, </td> <td class="paramname"> <em>MutexNumber</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u32&nbsp;</td> <td class="paramtype">u32&nbsp;</td>
<td class="mdname" nowrap> <em>User</em></td> <td class="paramname"> <em>User</em></td><td>&nbsp;</td>
</tr> </tr>
<tr> <tr>
<td class="md"></td> <td></td>
<td class="md">)&nbsp;</td> <td>)</td>
<td class="md" colspan="2"></td> <td></td><td></td><td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Sets the USER register of a Mutex lock within a Mutex device.</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Sets the USER register of a Mutex lock within a Mutex device.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1). </td></tr> <tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>User</em>&nbsp;</td><td>is the value to update the USER register with.</td></tr> <tr><td valign="top"></td><td valign="top"><em>User</em>&nbsp;</td><td>is the value to update the USER register with.</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul> <dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the USER register is written with the given value .</li><li>XST_NO_FEATURE if the Mutex was not configured with a USER register.</li></ul> <li>XST_SUCCESS if the USER register is written with the given value .</li>
<li>XST_NO_FEATURE if the Mutex was not configured with a USER register.</li>
</ul>
</dd></dl> </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr> </div>
</table> </div>
<a class="anchor" name="4d8ec1fd7ded72c8a41252d1a01a3495"></a><!-- doxytag: member="xmutex.c::XMutex_Trylock" ref="4d8ec1fd7ded72c8a41252d1a01a3495" args="(XMutex *InstancePtr, u8 MutexNumber)" --><p> <a class="anchor" id="af1857cffa94ba8b3bdf491f1a0096340"></a><!-- doxytag: member="xmutex.c::XMutex_Trylock" ref="af1857cffa94ba8b3bdf491f1a0096340" args="(XMutex *InstancePtr, u8 MutexNumber)" -->
<table class="mdTable" cellpadding="2" cellspacing="0"> <div class="memitem">
<tr> <div class="memproto">
<td class="mdRow"> <table class="memname">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">int XMutex_Trylock </td> <td class="memname">int XMutex_Trylock </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td> <td class="paramname"> <em>InstancePtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u8&nbsp;</td> <td class="paramtype">u8&nbsp;</td>
<td class="mdname" nowrap> <em>MutexNumber</em></td> <td class="paramname"> <em>MutexNumber</em></td><td>&nbsp;</td>
</tr> </tr>
<tr> <tr>
<td class="md"></td> <td></td>
<td class="md">)&nbsp;</td> <td>)</td>
<td class="md" colspan="2"></td> <td></td><td></td><td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Locks a particular Mutex lock within a Mutex device. Call returns immediately if the Mutex is already locked (This is Non-Blocking call).</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Locks a particular Mutex lock within a Mutex device. Call returns immediately if the Mutex is already locked (This is Non-Blocking call).<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr> <tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul> <dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if locking was successful.</li><li>XST_DEVICE_BUSY if the Mutex was found to be already locked</li></ul> <li>XST_SUCCESS if locking was successful.</li>
<li>XST_DEVICE_BUSY if the Mutex was found to be already locked</li>
</ul>
</dd></dl> </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul> <dl class="note"><dt><b>Note:</b></dt><dd><ul>
<li>This is Non-Blocking call, the user gets the lock if it is available else XST_DEVICE_BUSY is returned.</li><li>Use XMutex_Lock if you need to block until a lock is obtained. </li></ul> <li>This is Non-Blocking call, the user gets the lock if it is available else XST_DEVICE_BUSY is returned.</li>
<li>Use XMutex_Lock if you need to block until a lock is obtained. </li>
</ul>
</dd></dl> </dd></dl>
</td>
</tr> </div>
</table> </div>
<a class="anchor" name="40ee82db86b1d11f43092cd949b78eb3"></a><!-- doxytag: member="xmutex.c::XMutex_Unlock" ref="40ee82db86b1d11f43092cd949b78eb3" args="(XMutex *InstancePtr, u8 MutexNumber)" --><p> <a class="anchor" id="a82790dd21650e2b03e2c0a0f69a605d3"></a><!-- doxytag: member="xmutex.c::XMutex_Unlock" ref="a82790dd21650e2b03e2c0a0f69a605d3" args="(XMutex *InstancePtr, u8 MutexNumber)" -->
<table class="mdTable" cellpadding="2" cellspacing="0"> <div class="memitem">
<tr> <div class="memproto">
<td class="mdRow"> <table class="memname">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">int XMutex_Unlock </td> <td class="memname">int XMutex_Unlock </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td> <td class="paramname"> <em>InstancePtr</em>, </td>
</tr> </tr>
<tr> <tr>
<td class="md" nowrap align="right"></td> <td class="paramkey"></td>
<td class="md"></td> <td></td>
<td class="md" nowrap>u8&nbsp;</td> <td class="paramtype">u8&nbsp;</td>
<td class="mdname" nowrap> <em>MutexNumber</em></td> <td class="paramname"> <em>MutexNumber</em></td><td>&nbsp;</td>
</tr> </tr>
<tr> <tr>
<td class="md"></td> <td></td>
<td class="md">)&nbsp;</td> <td>)</td>
<td class="md" colspan="2"></td> <td></td><td></td><td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Unlocks a particular Mutex lock within a Mutex device.</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Unlocks a particular Mutex lock within a Mutex device.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr> <tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd></dd></dl> <dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
<ul> <ul>
<li>XST_SUCCESS if locking was successful.</li><li>XST_FAILURE if the Mutex was locked by process with different ID.</li></ul> <li>XST_SUCCESS if locking was successful.</li>
<p> <li>XST_FAILURE if the Mutex was locked by process with different ID.</li>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl> </ul>
</td> <dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</tr>
</table> </div>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

484
XilinxProcessorIPLib/drivers/mutex/doc/html/api/xmutex_8h.html Executable file
View file

@ -0,0 +1,484 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver mutex v4_0: xmutex.h File Reference
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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>xmutex.h File Reference</h1><code>#include &quot;xstatus.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="xmutex__hw_8h.html">xmutex_hw.h</a>&quot;</code><br/>
<code>#include &quot;xil_types.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex.html">XMutex</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#a12f26d74626ae4179bad889dc5a3e6c9">XMUTEX_H</a></td></tr>
<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="xmutex_8h.html#a250cfb7229128feb084799a476d423d6">XMutex_CfgInitialize</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, <a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> *ConfigPtr, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#a1255fbeea64f519d8def63e542ce8703">XMutex_Lock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#af1857cffa94ba8b3bdf491f1a0096340">XMutex_Trylock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#a82790dd21650e2b03e2c0a0f69a605d3">XMutex_Unlock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#a37302270d3c1c86dc0bffdfc7043b902">XMutex_IsLocked</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#a0fcbb23b06dc9fb716e3812696321f66">XMutex_GetStatus</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 *Locked, u32 *Owner)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#ad7d5c5cd3b24ffee6dcc093b98c8546a">XMutex_GetUser</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 *User)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#a941e13d2534884adf4926f05bae3966e">XMutex_SetUser</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 User)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#a9b36fec5e8de70e5338132b29709f76a">XMutex_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex_8h.html#a1599a86dd180f3bd789a2fc472e9aa29">XMutex_SelfTest</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a12f26d74626ae4179bad889dc5a3e6c9"></a><!-- doxytag: member="xmutex.h::XMUTEX_H" ref="a12f26d74626ae4179bad889dc5a3e6c9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XMUTEX_H</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a250cfb7229128feb084799a476d423d6"></a><!-- doxytag: member="xmutex.h::XMutex_CfgInitialize" ref="a250cfb7229128feb084799a476d423d6" args="(XMutex *InstancePtr, XMutex_Config *ConfigPtr, u32 EffectiveAddress)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMutex_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> *&nbsp;</td>
<td class="paramname"> <em>ConfigPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddress</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes a specific Mutex instance/driver.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ConfigPtr</em>&nbsp;</td><td>is the device configuration structure containing required HW build data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddress</em>&nbsp;</td><td>is the Physical address of the hardware in a Virtual Memory operating system environment. It is the Base Address in a stand alone environment.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if initialization was successful</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a0fcbb23b06dc9fb716e3812696321f66"></a><!-- doxytag: member="xmutex.h::XMutex_GetStatus" ref="a0fcbb23b06dc9fb716e3812696321f66" args="(XMutex *InstancePtr, u8 MutexNumber, u32 *Locked, u32 *Owner)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XMutex_GetStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>MutexNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 *&nbsp;</td>
<td class="paramname"> <em>Locked</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 *&nbsp;</td>
<td class="paramname"> <em>Owner</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the current status of a Mutex lock within a Mutex device.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Locked</em>&nbsp;</td><td>is a pointer where the current lock status is stored. Sets memory pointed to by 'Locked' to 1 if the Mutex is locked and 0 if it is unlocked. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Owner</em>&nbsp;</td><td>is a pointer where the current owner status is stored. . If the Mutex is locked, the memory pointed to by 'Owner' is updated to reflect the CPU ID that has currently locked this Mutex.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ad7d5c5cd3b24ffee6dcc093b98c8546a"></a><!-- doxytag: member="xmutex.h::XMutex_GetUser" ref="ad7d5c5cd3b24ffee6dcc093b98c8546a" args="(XMutex *InstancePtr, u8 MutexNumber, u32 *User)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMutex_GetUser </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>MutexNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32 *&nbsp;</td>
<td class="paramname"> <em>User</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the USER register of a Mutex lock within a Mutex device.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>User</em>&nbsp;</td><td>is a pointer to an u32 where the current user register value is stored by this function. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if successful. Memory pointed to by User is updated to reflect the contents of the user register.</li>
<li>XST_NO_FEATURE if the Mutex was not configured with a USER register.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a37302270d3c1c86dc0bffdfc7043b902"></a><!-- doxytag: member="xmutex.h::XMutex_IsLocked" ref="a37302270d3c1c86dc0bffdfc7043b902" args="(XMutex *InstancePtr, u8 MutexNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMutex_IsLocked </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>MutexNumber</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the current lock state of a Mutex lock within a Mutex device.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>TRUE if locked</li>
<li>FALSE if unlocked</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a1255fbeea64f519d8def63e542ce8703"></a><!-- doxytag: member="xmutex.h::XMutex_Lock" ref="a1255fbeea64f519d8def63e542ce8703" args="(XMutex *InstancePtr, u8 MutexNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XMutex_Lock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>MutexNumber</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Locks a particular Mutex lock within a Mutex device. Call blocks till the Mutex is locked.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd><ul>
<li>XMutex_Trylock is a blocking call. This call blocks until the user gets the lock.</li>
<li>Use XMutex_Trylock for a Non-Blocking call. The user gets the lock if it is available and returns immediately if the lock is not available. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a9b36fec5e8de70e5338132b29709f76a"></a><!-- doxytag: member="xmutex.h::XMutex_LookupConfig" ref="a9b36fec5e8de70e5338132b29709f76a" args="(u16 DeviceId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a>* XMutex_LookupConfig </td>
<td>(</td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>DeviceId</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1599a86dd180f3bd789a2fc472e9aa29"></a><!-- doxytag: member="xmutex.h::XMutex_SelfTest" ref="a1599a86dd180f3bd789a2fc472e9aa29" args="(XMutex *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMutex_SelfTest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Selftest a particular Mutex hardware core.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if test was successful.</li>
<li>XST_FAILURE if test was not successful.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
<p>This test is destructive. It will fail if the Mutex is currently being used. This is also a blocking call, if there is another process which has the Mutex, the first _lock will hand the test until the other process releases it. </p>
</div>
</div>
<a class="anchor" id="a941e13d2534884adf4926f05bae3966e"></a><!-- doxytag: member="xmutex.h::XMutex_SetUser" ref="a941e13d2534884adf4926f05bae3966e" args="(XMutex *InstancePtr, u8 MutexNumber, u32 User)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMutex_SetUser </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>MutexNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>User</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the USER register of a Mutex lock within a Mutex device.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>User</em>&nbsp;</td><td>is the value to update the USER register with.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if the USER register is written with the given value .</li>
<li>XST_NO_FEATURE if the Mutex was not configured with a USER register.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="af1857cffa94ba8b3bdf491f1a0096340"></a><!-- doxytag: member="xmutex.h::XMutex_Trylock" ref="af1857cffa94ba8b3bdf491f1a0096340" args="(XMutex *InstancePtr, u8 MutexNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMutex_Trylock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>MutexNumber</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Locks a particular Mutex lock within a Mutex device. Call returns immediately if the Mutex is already locked (This is Non-Blocking call).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if locking was successful.</li>
<li>XST_DEVICE_BUSY if the Mutex was found to be already locked</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd><ul>
<li>This is Non-Blocking call, the user gets the lock if it is available else XST_DEVICE_BUSY is returned.</li>
<li>Use XMutex_Lock if you need to block until a lock is obtained. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a82790dd21650e2b03e2c0a0f69a605d3"></a><!-- doxytag: member="xmutex.h::XMutex_Unlock" ref="a82790dd21650e2b03e2c0a0f69a605d3" args="(XMutex *InstancePtr, u8 MutexNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XMutex_Unlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>MutexNumber</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unlocks a particular Mutex lock within a Mutex device.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex lock within the device to operate on. Each device may contain multiple Mutex locks. The Mutex number is a zero based number with a range of 0 - (InstancePtr-&gt;Config.NumMutex - 1).</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
<ul>
<li>XST_SUCCESS if locking was successful.</li>
<li>XST_FAILURE if the Mutex was locked by process with different ID.</li>
</ul>
<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>

86
XilinxProcessorIPLib/drivers/mutex/doc/html/api/xmutex__g_8c.html
View file

@ -2,39 +2,71 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
xmutex_g.c File Reference Xilinx Driver mutex v4_0: xmutex_g.c File Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>xmutex_g.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
This file contains a configuration table that specifies the configuration of Mutex devices in the system.<p> <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xmutex_g.c File Reference</h1><code>#include &quot;<a class="el" href="xmutex_8h.html">xmutex.h</a>&quot;</code><br/>
<code>#include &quot;xparameters.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__g_8c.html#aa6144336e4a9674cb9a3f2c5c0f0f79c">XMutex_ConfigTable</a> []</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This file contains a configuration table that specifies the configuration of Mutex devices in the system.</p>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- -------- --------------------------------------------------- ----- ---- -------- ---------------------------------------------------
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS
</pre><p> </pre><dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl> <hr/><h2>Variable Documentation</h2>
<a class="anchor" id="aa6144336e4a9674cb9a3f2c5c0f0f79c"></a><!-- doxytag: member="xmutex_g.c::XMutex_ConfigTable" ref="aa6144336e4a9674cb9a3f2c5c0f0f79c" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> <a class="el" href="xmutex__sinit_8c.html#aa6144336e4a9674cb9a3f2c5c0f0f79c">XMutex_ConfigTable</a>[]</td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment">
{
{
XPAR_MUTEX_0_DEVICE_ID,
XPAR_MUTEX_0_BASEADDR,
XPAR_MUTEX_0_NUM_MUTEX,
XPAR_MUTEX_0_ENABLE_USER
}
}
</pre></div>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
<code>#include &quot;xmutex.h&quot;</code><br>
<code>#include &quot;xparameters.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
</table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

419
XilinxProcessorIPLib/drivers/mutex/doc/html/api/xmutex__hw_8h.html
View file

@ -2,266 +2,263 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
xmutex_hw.h File Reference Xilinx Driver mutex v4_0: xmutex_hw.h File Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>xmutex_hw.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
This header file contains identifiers/definitions and macros that can be used to access the device. The user should refer to the hardware device specification for more details of the device operation. The driver functions are defined in xmutex.h.<p> <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xmutex_hw.h File Reference</h1><code>#include &quot;xil_io.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#a60f85a9b89886d33d2e255bcf8abb0f2">XMUTEX_HW_H</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#ac14e6e73d44fa8510ea7016607af6824">XMU_MUTEX_OFFSET</a>&nbsp;&nbsp;&nbsp;256</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#ac12aae3b150f35f5b214c329ed88b0d8">XMutex_Offset</a>(i)&nbsp;&nbsp;&nbsp;(XMU_MUTEX_OFFSET * i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#ac521c86ba5c4f2bad8f73e515897a766">XMutex_ReadReg</a>(BaseAddress, MutexNumber, RegOffset)&nbsp;&nbsp;&nbsp;Xil_In32((BaseAddress) + XMutex_Offset(MutexNumber) + (RegOffset))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#a33160589a1793006209e4e259ca7de35">XMutex_WriteReg</a>(BaseAddress, MutexNumber, RegOffset, ValueToWrite)</td></tr>
<tr><td colspan="2"><div class="groupHeader">Register Offset Definitions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp73ef0a73b2ea2db0d81f41505805ece5"></a> Register offsets within a Mutex, there are multiple Mutexes within a single device </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#ac717e990a2cbe85f19525c46aefc84b6">XMU_MUTEX_REG_OFFSET</a>&nbsp;&nbsp;&nbsp;0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#a7317a6291745987d25c994702005fff2">XMU_USER_REG_OFFSET</a>&nbsp;&nbsp;&nbsp;4</td></tr>
<tr><td colspan="2"><div class="groupHeader">Mutex Register Bit Definitions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb3fca41a54398cd4a3b0aae58a737831"></a> </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#a086991b467a934c97022a305bb957977">LOCKED_BIT</a>&nbsp;&nbsp;&nbsp;0x00000001</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#a97587665957065c60155f02edb2d195d">OWNER_MASK</a>&nbsp;&nbsp;&nbsp;0x000001FE</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#ad3725eb84e9d09431334eecbcf66bcd1">OWNER_SHIFT</a>&nbsp;&nbsp;&nbsp;0x00000001</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This header file contains identifiers/definitions and macros that can be used to access the device. The user should refer to the hardware device specification for more details of the device operation. The driver functions are defined in <a class="el" href="xmutex_8h.html">xmutex.h</a>.</p>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- -------- ----------------------------------------------- ----- ---- -------- -----------------------------------------------
1.00a va First release 1.00a va First release
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS
3.00a hbm 10/15/09 Migrated to HAL phase 1 to use xil_io, xil_types, 3.00a hbm 10/15/09 Migrated to HAL phase 1 to use xil_io, xil_types,
and xil_assert. and xil_assert.
</pre> </pre> <hr/><h2>Define Documentation</h2>
<p> <a class="anchor" id="a086991b467a934c97022a305bb957977"></a><!-- doxytag: member="xmutex_hw.h::LOCKED_BIT" ref="a086991b467a934c97022a305bb957977" args="" -->
<code>#include &quot;xil_io.h&quot;</code><br> <div class="memitem">
<table border="0" cellpadding="0" cellspacing="0"> <div class="memproto">
<tr><td></td></tr> <table class="memname">
<tr><td colspan="2"><br><h2>Register Offset Definitions</h2></td></tr>
<tr><td colspan="2">Register offsets within a Mutex, there are multiple Mutexes within a single device <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#a523470c9ee0a5b3684cd6bae8c8d013">XMU_MUTEX_REG_OFFSET</a>&nbsp;&nbsp;&nbsp;0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#7292f56c48208381c8070d405d20052b">XMU_USER_REG_OFFSET</a>&nbsp;&nbsp;&nbsp;4</td></tr>
<tr><td colspan="2"><br><h2>Mutex Register Bit Definitions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#4fc77b2601b1ea7abdfb64a06b1cd1fb">LOCKED_BIT</a>&nbsp;&nbsp;&nbsp;0x00000001</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#cfe4cc17f438ed2613082cd60f49fc4d">OWNER_MASK</a>&nbsp;&nbsp;&nbsp;0x000001FE</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#8ec2c7708e3b28590514f57108cd3a81">OWNER_SHIFT</a>&nbsp;&nbsp;&nbsp;0x00000001</td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#a816305f630601c4d710b9f3e808bf51">XMutex_ReadReg</a>(BaseAddress, MutexNumber, RegOffset)&nbsp;&nbsp;&nbsp;Xil_In32((BaseAddress) + XMutex_Offset(MutexNumber) + (RegOffset))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__hw_8h.html#6758828f46a00f7d7f996c710711622f">XMutex_WriteReg</a>(BaseAddress, MutexNumber, RegOffset, ValueToWrite)</td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="4fc77b2601b1ea7abdfb64a06b1cd1fb"></a><!-- doxytag: member="xmutex_hw.h::LOCKED_BIT" ref="4fc77b2601b1ea7abdfb64a06b1cd1fb" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">#define LOCKED_BIT&nbsp;&nbsp;&nbsp;0x00000001 </td> <td class="memname">#define LOCKED_BIT&nbsp;&nbsp;&nbsp;0x00000001</td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>This is the Lock bit. Set to 1 indicates that the lock is currently owned by the processor ID specified by the CPU_ID (OWNER_MASK) in this register. Set to 0 indicates that the lock is free. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
This is the Lock bit. Set to 1 indicates that the lock is currently owned by the processor ID specified by the CPU_ID (OWNER_MASK) in this register. Set to 0 indicates that the lock is free. </td> </div>
</tr> <a class="anchor" id="a97587665957065c60155f02edb2d195d"></a><!-- doxytag: member="xmutex_hw.h::OWNER_MASK" ref="a97587665957065c60155f02edb2d195d" args="" -->
</table> <div class="memitem">
<a class="anchor" name="cfe4cc17f438ed2613082cd60f49fc4d"></a><!-- doxytag: member="xmutex_hw.h::OWNER_MASK" ref="cfe4cc17f438ed2613082cd60f49fc4d" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">#define OWNER_MASK&nbsp;&nbsp;&nbsp;0x000001FE </td> <td class="memname">#define OWNER_MASK&nbsp;&nbsp;&nbsp;0x000001FE</td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>This is CPU_ID Mask. CPU_ID indicates the ID the processor holding the lock. </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
This is CPU_ID Mask. CPU_ID indicates the ID the processor holding the lock. </td> </div>
</tr> <a class="anchor" id="ad3725eb84e9d09431334eecbcf66bcd1"></a><!-- doxytag: member="xmutex_hw.h::OWNER_SHIFT" ref="ad3725eb84e9d09431334eecbcf66bcd1" args="" -->
</table> <div class="memitem">
<a class="anchor" name="8ec2c7708e3b28590514f57108cd3a81"></a><!-- doxytag: member="xmutex_hw.h::OWNER_SHIFT" ref="8ec2c7708e3b28590514f57108cd3a81" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">#define OWNER_SHIFT&nbsp;&nbsp;&nbsp;0x00000001 </td> <td class="memname">#define OWNER_SHIFT&nbsp;&nbsp;&nbsp;0x00000001</td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>This is CPU_ID Shift </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
This is CPU_ID Shift </td> </div>
</tr> <a class="anchor" id="ac14e6e73d44fa8510ea7016607af6824"></a><!-- doxytag: member="xmutex_hw.h::XMU_MUTEX_OFFSET" ref="ac14e6e73d44fa8510ea7016607af6824" args="" -->
</table> <div class="memitem">
<a class="anchor" name="a523470c9ee0a5b3684cd6bae8c8d013"></a><!-- doxytag: member="xmutex_hw.h::XMU_MUTEX_REG_OFFSET" ref="a523470c9ee0a5b3684cd6bae8c8d013" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">#define XMU_MUTEX_REG_OFFSET&nbsp;&nbsp;&nbsp;0 </td> <td class="memname">#define XMU_MUTEX_OFFSET&nbsp;&nbsp;&nbsp;256</td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Mutex register </td> </div>
</tr> <a class="anchor" id="ac717e990a2cbe85f19525c46aefc84b6"></a><!-- doxytag: member="xmutex_hw.h::XMU_MUTEX_REG_OFFSET" ref="ac717e990a2cbe85f19525c46aefc84b6" args="" -->
</table> <div class="memitem">
<a class="anchor" name="7292f56c48208381c8070d405d20052b"></a><!-- doxytag: member="xmutex_hw.h::XMU_USER_REG_OFFSET" ref="7292f56c48208381c8070d405d20052b" args="" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">#define XMU_USER_REG_OFFSET&nbsp;&nbsp;&nbsp;4 </td> <td class="memname">#define XMU_MUTEX_REG_OFFSET&nbsp;&nbsp;&nbsp;0</td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Mutex register </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
User register </td> </div>
</tr> <a class="anchor" id="a7317a6291745987d25c994702005fff2"></a><!-- doxytag: member="xmutex_hw.h::XMU_USER_REG_OFFSET" ref="a7317a6291745987d25c994702005fff2" args="" -->
</table> <div class="memitem">
<a class="anchor" name="a816305f630601c4d710b9f3e808bf51"></a><!-- doxytag: member="xmutex_hw.h::XMutex_ReadReg" ref="a816305f630601c4d710b9f3e808bf51" args="(BaseAddress, MutexNumber, RegOffset)" --><p> <div class="memproto">
<table class="mdTable" cellpadding="2" cellspacing="0"> <table class="memname">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">#define XMutex_ReadReg </td> <td class="memname">#define XMU_USER_REG_OFFSET&nbsp;&nbsp;&nbsp;4</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">BaseAddress, <tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>MutexNumber, <tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>RegOffset&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>&nbsp;&nbsp;&nbsp;Xil_In32((BaseAddress) + XMutex_Offset(MutexNumber) + (RegOffset))</td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>User register </p>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p> </div>
Read one of the Mutex registers.<p> </div>
<dl compact><dt><b>Parameters:</b></dt><dd> <a class="anchor" id="a60f85a9b89886d33d2e255bcf8abb0f2"></a><!-- doxytag: member="xmutex_hw.h::XMUTEX_HW_H" ref="a60f85a9b89886d33d2e255bcf8abb0f2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XMUTEX_HW_H</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac12aae3b150f35f5b214c329ed88b0d8"></a><!-- doxytag: member="xmutex_hw.h::XMutex_Offset" ref="ac12aae3b150f35f5b214c329ed88b0d8" args="(i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XMutex_Offset</td>
<td>(</td>
<td class="paramtype">i&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;(XMU_MUTEX_OFFSET * i)</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac521c86ba5c4f2bad8f73e515897a766"></a><!-- doxytag: member="xmutex_hw.h::XMutex_ReadReg" ref="ac521c86ba5c4f2bad8f73e515897a766" args="(BaseAddress, MutexNumber, RegOffset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XMutex_ReadReg</td>
<td>(</td>
<td class="paramtype">BaseAddress, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MutexNumber, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RegOffset&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;Xil_In32((BaseAddress) + XMutex_Offset(MutexNumber) + (RegOffset))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read one of the Mutex registers.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>BaseAddress</em>&nbsp;</td><td>contains the base address of the Mutex device. </td></tr> <tr><td valign="top"></td><td valign="top"><em>BaseAddress</em>&nbsp;</td><td>contains the base address of the Mutex device. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>contains the specific Mutex within the device, a zero based number, 0 - (NumMutexConfigured in HW - 1). </td></tr> <tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>contains the specific Mutex within the device, a zero based number, 0 - (NumMutexConfigured in HW - 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>RegOffset</em>&nbsp;</td><td>contains the offset from the 1st register of the Mutex to select the specific register of the Mutex.</td></tr> <tr><td valign="top"></td><td valign="top"><em>RegOffset</em>&nbsp;</td><td>contains the offset from the 1st register of the Mutex to select the specific register of the Mutex.</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd>The 32 bit value read from the register.</dd></dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The 32 bit value read from the register.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>C-style signature: u32 XMutex_ReadReg(u32 BaseAddress, u8 MutexNumber, unsigned RegOffset) </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 XMutex_ReadReg(u32 BaseAddress, u8 MutexNumber, unsigned RegOffset) </dd></dl>
</td>
</tr> </div>
</table> </div>
<a class="anchor" name="6758828f46a00f7d7f996c710711622f"></a><!-- doxytag: member="xmutex_hw.h::XMutex_WriteReg" ref="6758828f46a00f7d7f996c710711622f" args="(BaseAddress, MutexNumber, RegOffset, ValueToWrite)" --><p> <a class="anchor" id="a33160589a1793006209e4e259ca7de35"></a><!-- doxytag: member="xmutex_hw.h::XMutex_WriteReg" ref="a33160589a1793006209e4e259ca7de35" args="(BaseAddress, MutexNumber, RegOffset, ValueToWrite)" -->
<table class="mdTable" cellpadding="2" cellspacing="0"> <div class="memitem">
<tr> <div class="memproto">
<td class="mdRow"> <table class="memname">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">#define XMutex_WriteReg </td> <td class="memname">#define XMutex_WriteReg</td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top">BaseAddress, <tr> <td class="paramtype">BaseAddress, </td>
<td class="md" nowrap align="right"></td> </tr>
<td class="md"></td> <tr>
<td class="md" nowrap>MutexNumber, <tr> <td class="paramkey"></td>
<td class="md" nowrap align="right"></td> <td></td>
<td class="md"></td> <td class="paramtype">MutexNumber, </td>
<td class="md" nowrap>RegOffset, <tr> </tr>
<td class="md" nowrap align="right"></td> <tr>
<td class="md"></td> <td class="paramkey"></td>
<td class="md" nowrap>ValueToWrite&nbsp;</td> <td></td>
<td class="mdname1" valign="top" nowrap> </td> <td class="paramtype">RegOffset, </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td> </tr>
<td class="md" nowrap></td> <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ValueToWrite&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <b>Value:</b><div class="fragment"><pre class="fragment">Xil_Out32(((BaseAddress) + <a class="code" href="xmutex__hw_8h.html#ac12aae3b150f35f5b214c329ed88b0d8">XMutex_Offset</a>(MutexNumber) + \
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment">Xil_Out32(((BaseAddress) + XMutex_Offset(MutexNumber) + \
(RegOffset)), (ValueToWrite)) (RegOffset)), (ValueToWrite))
</pre></div>Write a specified value to a register of a Mutex.<p> </pre></div><p>Write a specified value to a register of a Mutex.</p>
<dl compact><dt><b>Parameters:</b></dt><dd> <dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>BaseAddress</em>&nbsp;</td><td>is the base address of the Mutex device. </td></tr> <tr><td valign="top"></td><td valign="top"><em>BaseAddress</em>&nbsp;</td><td>is the base address of the Mutex device. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex within the device, a zero based number, 0 - (NumMutexConfigured in HW - 1). </td></tr> <tr><td valign="top"></td><td valign="top"><em>MutexNumber</em>&nbsp;</td><td>is the specific Mutex within the device, a zero based number, 0 - (NumMutexConfigured in HW - 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>RegOffset</em>&nbsp;</td><td>contain the offset from the 1st register of the Mutex to select the specific register of the Mutex. </td></tr> <tr><td valign="top"></td><td valign="top"><em>RegOffset</em>&nbsp;</td><td>contain the offset from the 1st register of the Mutex to select the specific register of the Mutex. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ValueToWrite</em>&nbsp;</td><td>is the 32 bit value to be written to the register.</td></tr> <tr><td valign="top"></td><td valign="top"><em>ValueToWrite</em>&nbsp;</td><td>is the 32 bit value to be written to the register.</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd>C-style signature: void XMutex_WriteReg(u32 BaseAddress, u8 MutexNumber, unsigned RegOffset, u32 ValueToWrite) </dd></dl> <dl class="return"><dt><b>Returns:</b></dt><dd>C-style signature: void XMutex_WriteReg(u32 BaseAddress, u8 MutexNumber, unsigned RegOffset, u32 ValueToWrite) </dd></dl>
</td>
</tr> </div>
</table> </div>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

124
XilinxProcessorIPLib/drivers/mutex/doc/html/api/xmutex__selftest_8c.html
View file

@ -2,84 +2,84 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
xmutex_selftest.c File Reference Xilinx Driver mutex v4_0: xmutex_selftest.c File Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>xmutex_selftest.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
Contains <a class="el" href="struct_x_mutex.html">XMutex</a> driver selftest code.<p> <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xmutex_selftest.c File Reference</h1><code>#include &quot;xstatus.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="xmutex_8h.html">xmutex.h</a>&quot;</code><br/>
<code>#include &quot;xparameters.h&quot;</code><br/>
<code>#include &quot;xil_types.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="xmutex__selftest_8c.html#a1599a86dd180f3bd789a2fc472e9aa29">XMutex_SelfTest</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Contains <a class="el" href="struct_x_mutex.html">XMutex</a> driver selftest code.</p>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- -------- ----------------------------------------------- ----- ---- -------- -----------------------------------------------
1.00a va First release 1.00a va First release
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS 1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS
3.00a hbm 10/15/09 Migrated to HAL phase 1 to use xil_io, xil_types, 3.00a hbm 10/15/09 Migrated to HAL phase 1 to use xil_io, xil_types,
and xil_assert. and xil_assert.
</pre> </pre> <hr/><h2>Function Documentation</h2>
<p> <a class="anchor" id="a1599a86dd180f3bd789a2fc472e9aa29"></a><!-- doxytag: member="xmutex_selftest.c::XMutex_SelfTest" ref="a1599a86dd180f3bd789a2fc472e9aa29" args="(XMutex *InstancePtr)" -->
<code>#include &quot;xstatus.h&quot;</code><br> <div class="memitem">
<code>#include &quot;xmutex.h&quot;</code><br> <div class="memproto">
<code>#include &quot;xparameters.h&quot;</code><br> <table class="memname">
<code>#include &quot;xil_types.h&quot;</code><br>
<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">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__selftest_8c.html#63fe6504008f00ed771e28d35de1a3c7">XMutex_SelfTest</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="63fe6504008f00ed771e28d35de1a3c7"></a><!-- doxytag: member="xmutex_selftest.c::XMutex_SelfTest" ref="63fe6504008f00ed771e28d35de1a3c7" args="(XMutex *InstancePtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr> <tr>
<td class="md" nowrap valign="top">int XMutex_SelfTest </td> <td class="memname">int XMutex_SelfTest </td>
<td class="md" valign="top">(&nbsp;</td> <td>(</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td> <td class="paramtype"><a class="el" href="struct_x_mutex.html">XMutex</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>InstancePtr</em> </td> <td class="paramname"> <em>InstancePtr</em></td>
<td class="md" valign="top">&nbsp;)&nbsp;</td> <td>&nbsp;)&nbsp;</td>
<td class="md" nowrap></td> <td></td>
</tr> </tr>
</table> </table>
</td> </div>
</tr> <div class="memdoc">
</table> <p>Selftest a particular Mutex hardware core.</p>
<table cellspacing="5" cellpadding="0" border="0"> <dl><dt><b>Parameters:</b></dt><dd>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Selftest a particular Mutex hardware core.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"> <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 the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on.</td></tr> <tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_mutex.html">XMutex</a> instance to be worked on.</td></tr>
</table> </table>
</dd>
</dl> </dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul> <dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if test was successful.</li><li>XST_FAILURE if test was not successful.</li></ul> <li>XST_SUCCESS if test was successful.</li>
<li>XST_FAILURE if test was not successful.</li>
</ul>
</dd></dl> </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd></dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
This test is destructive. It will fail if the Mutex is currently being used. This is also a blocking call, if there is another process which has the Mutex, the first _lock will hand the test until the other process releases it. </td> <p>This test is destructive. It will fail if the Mutex is currently being used. This is also a blocking call, if there is another process which has the Mutex, the first _lock will hand the test until the other process releases it. </p>
</tr>
</table> </div>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

97
XilinxProcessorIPLib/drivers/mutex/doc/html/api/xmutex__sinit_8c.html
View file

@ -2,37 +2,80 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
xmutex_sinit.c File Reference Xilinx Driver mutex v4_0: xmutex_sinit.c File Reference
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>xmutex_sinit.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
Implements static initialization See xmutex.h for more information about the driver.<p> <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<pre> </ul>
MODIFICATION HISTORY:</pre><p> </div>
<pre> Ver Who Date Changes </div>
----- ---- -------- --------------------------------------------------- <div class="contents">
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS</pre><p> <h1>xmutex_sinit.c File Reference</h1><code>#include &quot;<a class="el" href="xmutex_8h.html">xmutex.h</a>&quot;</code><br/>
<pre> </pre> <code>#include &quot;xparameters.h&quot;</code><br/>
<p>
<code>#include &quot;xmutex.h&quot;</code><br>
<code>#include &quot;xparameters.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr> <tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__sinit_8c.html#a9b36fec5e8de70e5338132b29709f76a">XMutex_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xmutex__sinit_8c.html#aa6144336e4a9674cb9a3f2c5c0f0f79c">XMutex_ConfigTable</a> []</td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Implements static initialization See <a class="el" href="xmutex_8h.html">xmutex.h</a> for more information about the driver.</p>
<pre>
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
----- ---- -------- ---------------------------------------------------
1.00a ecm 06/01/07 Cleanup, new coding standard, check into XCS</pre><pre> </pre> <hr/><h2>Function Documentation</h2>
<a class="anchor" id="a9b36fec5e8de70e5338132b29709f76a"></a><!-- doxytag: member="xmutex_sinit.c::XMutex_LookupConfig" ref="a9b36fec5e8de70e5338132b29709f76a" args="(u16 DeviceId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a>* XMutex_LookupConfig </td>
<td>(</td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>DeviceId</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="aa6144336e4a9674cb9a3f2c5c0f0f79c"></a><!-- doxytag: member="xmutex_sinit.c::XMutex_ConfigTable" ref="aa6144336e4a9674cb9a3f2c5c0f0f79c" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> <a class="el" href="xmutex__sinit_8c.html#aa6144336e4a9674cb9a3f2c5c0f0f79c">XMutex_ConfigTable</a>[]</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

41
XilinxProcessorIPLib/drivers/nandps/doc/html/api/annotated.html
View file

@ -2,25 +2,31 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class List Xilinx Driver nandps v2_1: Class List
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li id="current"><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li id="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li> </div>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<li class="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> <h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="struct____attribute____.html">__attribute__</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct____attribute____.html">__attribute__</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="struct_x_nand_ps___bad_block_pattern.html">XNandPs_BadBlockPattern</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_nand_ps___bad_block_pattern.html">XNandPs_BadBlockPattern</a></td><td class="indexvalue"></td></tr>
@ -32,4 +38,9 @@
<tr><td class="indexkey"><a class="el" href="struct_x_nand_ps___geometry.html">XNandPs_Geometry</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_nand_ps___geometry.html">XNandPs_Geometry</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="struct_x_nand_ps_tag.html">XNandPsTag</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct_x_nand_ps_tag.html">XNandPsTag</a></td><td class="indexvalue"></td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

40
XilinxProcessorIPLib/drivers/nandps/doc/html/api/classes.html Executable file
View file

@ -0,0 +1,40 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver nandps v2_1: Alphabetical List
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class Index</h1><div class="qindex"><a class="qindex" href="#letter_X">X</a>&nbsp;|&nbsp;<a class="qindex" href="#letter__">_</a></div>
<table align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
<tr><td><a name="letter_X"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&nbsp;&nbsp;X&nbsp;&nbsp;</div></td></tr></table>
</td><td><a class="el" href="struct_x_nand_ps___command_format.html">XNandPs_CommandFormat</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_nand_ps___ecc_config.html">XNandPs_EccConfig</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_nand_ps___geometry.html">XNandPs_Geometry</a>&nbsp;&nbsp;&nbsp;</td><td><a name="letter__"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&nbsp;&nbsp;_&nbsp;&nbsp;</div></td></tr></table>
</td></tr><tr><td><a class="el" href="struct_x_nand_ps___bad_block_pattern.html">XNandPs_BadBlockPattern</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_nand_ps___config.html">XNandPs_Config</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_nand_ps___features.html">XNandPs_Features</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_nand_ps_tag.html">XNandPsTag</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct____attribute____.html">__attribute__</a>&nbsp;&nbsp;&nbsp;</td></tr><tr><td><a class="el" href="struct_x_nand_ps___bbt_desc.html">XNandPs_BbtDesc</a>&nbsp;&nbsp;&nbsp;</td></tr></table><div class="qindex"><a class="qindex" href="#letter_X">X</a>&nbsp;|&nbsp;<a class="qindex" href="#letter__">_</a></div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

BIN
XilinxProcessorIPLib/drivers/nandps/doc/html/api/doxygen.png
View file

Binary file not shown.

334
XilinxProcessorIPLib/drivers/nandps/doc/html/api/driver_api_doxygen.css
View file

@ -1,334 +0,0 @@
BODY {
background-color: #FFFFFF;
font-family: Verdana, Arial, Helvetica, Sans-serif;
}
H1 {
margin-bottom: 0em;
font-size: 2.00em;
font-style: normal;
color: #990033;
}
H2 {
font-size: 1.05em;
font-style: normal;
color: #666666;
}
H3 {
font-size: 1.00em;
font-style: normal;
color: #000000;
}
H4 {
font-size: .90em;
font-style: italic;
color: #000000;
}
H5 {
font-size: .90em;
font-style: italic;
color: #000000;
}
H6 {
font-size: .90em;
font-style: italic;
color: #000000;
}
OL {
}
UL {
}
LI {
}
P {
color: #000000;
}
P.Caution {
color: #990033;
}
P.Code {
font-family: Courier New, Courier, Mono;
color: #003399;
}
P.HeadingDBox {
font-weight: bold;
}
P.HeadingGlossary {
font-weight: bold;
}
P.LinkGlossary {
margin-bottom: .50em;
}
P.Note {
}
P.SysInOut {
font-family: Courier New, Courier, Mono;
}
P.TableFootnote {
font-size: .80em;
margin-bottom: .70em;
}
P.TableHeading {
font-weight: bold;
color: #FFFFFF;
}
P.TableTitle {
font-style: italic;
font-weight: bold;
}
SPAN.aEmphasis {
font-style: italic;
}
SPAN.aFilename {
font-family: Courier New, Courier, Mono;
}
SPAN.aGUISysIn {
font-family: Verdana, Arial, Helvetica, Sans-serif;
font-weight: bold;
}
SPAN.aReference {
font-style: italic;
}
SPAN.aSysIn {
font-family: Courier New, Courier, Monospace;
font-weight: bold;
}
SPAN.aSysOut {
font-family: Courier New, Courier, Monospace;
}
SPAN.aSymbol {
font-family: Symbol;
}
CAPTION { font-weight: bold }
DIV.qindex {
width: 100%;
background-color: #eeeeff;
border: 1px solid #B0B0B0;
text-align: center;
margin: 2px;
padding: 2px;
}
A.qindex {
text-decoration: none;
font-weight: bold;
color: #1A419D;
padding: 2px;
}
A.qindex:visited {
text-decoration: none;
font-weight: bold;
color: #1A419D
padding: 2px;
}
A.qindex:hover {
text-decoration: none;
background-color: #ddddff;
padding: 2px;
}
A.qindexHL {
text-decoration: none;
font-weight: bold;
background-color: #6666cc;
color: #ffffff;
padding: 2 6px;
border: 1px double #9295C2;
}
A.qindexHL:hover {
text-decoration: none;
background-color: #6666cc;
color: #ffffff;
padding: 2px 6px;
}
A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff }
A.el { text-decoration: none; font-weight: bold }
A.elRef { font-weight: bold }
A.code { text-decoration: none; font-weight: normal; color: #1A419D}
A.codeRef { font-weight: normal; color: #1A419D}
A:hover { text-decoration: none; background-color: #f2f2ff }
DL.el { margin-left: -1cm }
PRE.fragment {
border: 1px solid #CCCCCC;
background-color: #f5f5f5;
margin-top: 4px;
margin-bottom: 4px;
margin-left: 2px;
margin-right: 8px;
padding-left: 6px;
padding-right: 6px;
padding-top: 4px;
padding-bottom: 4px;
}
DIV.fragment {
border: 1px solid #CCCCCC;
background-color: #f5f5f5;
padding: 6px;
}
DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
TD.md { background-color: #F4F4FB; font-weight: bold; }
TD.mdname1 { background-color: #F4F4FB; font-weight: bold; color: #602020; }
TD.mdname { background-color: #F4F4FB; font-weight: bold; color: #602020; width: 600px; }
DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold }
DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller }
BODY {
background: white;
color: black;
margin-right: 20px;
margin-left: 20px;
}
TD.indexkey {
background-color: #eeeeff;
font-weight: bold;
padding-right : 10px;
padding-top : 2px;
padding-left : 10px;
padding-bottom : 2px;
margin-left : 0px;
margin-right : 0px;
margin-top : 2px;
margin-bottom : 2px;
border: 1px solid #CCCCCC;
}
TD.indexvalue {
background-color: #eeeeff;
font-style: italic;
padding-right : 10px;
padding-top : 2px;
padding-left : 10px;
padding-bottom : 2px;
margin-left : 0px;
margin-right : 0px;
margin-top : 2px;
margin-bottom : 2px;
border: 1px solid #CCCCCC;
}
TR.memlist {
background-color: #f0f0f0;
}
P.formulaDsp { text-align: center; }
IMG.formulaDsp { }
IMG.formulaInl { vertical-align: middle; }
SPAN.keyword { color: #008000 }
SPAN.keywordtype { color: #604020 }
SPAN.keywordflow { color: #e08000 }
SPAN.comment { color: #800000 }
SPAN.preprocessor { color: #806020 }
SPAN.stringliteral { color: #002080 }
SPAN.charliteral { color: #008080 }
.mdTable {
border: 1px solid #868686;
background-color: #F4F4FB;
}
.mdRow {
padding: 8px 10px;
}
.mdescLeft {
font-size: smaller;
font-family: Verdana, Arial, Helvetica, sans-serif;
background-color: #FAFAFA;
padding-left: 8px;
border-top: 1px none #E0E0E0;
border-right: 1px none #E0E0E0;
border-bottom: 1px none #E0E0E0;
border-left: 1px none #E0E0E0;
margin: 0px;
}
.mdescRight {
font-size: smaller;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-style: italic;
background-color: #FAFAFA;
padding-left: 4px;
border-top: 1px none #E0E0E0;
border-right: 1px none #E0E0E0;
border-bottom: 1px none #E0E0E0;
border-left: 1px none #E0E0E0;
margin: 0px;
padding-bottom: 0px;
padding-right: 8px;
}
.memItemLeft {
padding: 1px 0px 0px 8px;
margin: 4px;
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-style: solid;
border-top-color: #E0E0E0;
border-right-color: #E0E0E0;
border-bottom-color: #E0E0E0;
border-left-color: #E0E0E0;
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
background-color: #FAFAFA;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 12px;
}
.memItemRight {
padding: 1px 0px 0px 8px;
margin: 4px;
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-style: solid;
border-top-color: #E0E0E0;
border-right-color: #E0E0E0;
border-bottom-color: #E0E0E0;
border-left-color: #E0E0E0;
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
background-color: #FAFAFA;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 13px;
}
.search { color: #003399;
font-weight: bold;
}
FORM.search {
margin-bottom: 0px;
margin-top: 0px;
}
INPUT.search { font-size: 75%;
color: #000080;
font-weight: normal;
background-color: #eeeeff;
}
TD.tiny { font-size: 75%;
}
a {
color: #252E78;
}
a:visited {
color: #3D2185;
}

44
XilinxProcessorIPLib/drivers/nandps/doc/html/api/files.html
View file

@ -2,27 +2,34 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
File Index Xilinx Driver nandps v2_1: File Index
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li id="current"><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table> <li class="current"><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>File List</h1>Here is a list of all files with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="xnandps_8c.html">xnandps.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xnandps_8c.html">xnandps.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xnandps_8h.html">xnandps.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xnandps__bbm_8c.html">xnandps_bbm.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xnandps__bbm_8c.html">xnandps_bbm.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xnandps__bbm_8h.html">xnandps_bbm.h</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xnandps__bbm_8h.html">xnandps_bbm.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xnandps__g_8c.html">xnandps_g.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xnandps__g_8c.html">xnandps_g.c</a></td><td class="indexvalue"></td></tr>
@ -31,4 +38,9 @@
<tr><td class="indexkey"><a class="el" href="xnandps__onfi_8h.html">xnandps_onfi.h</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xnandps__onfi_8h.html">xnandps_onfi.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xnandps__sinit_8c.html">xnandps_sinit.c</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="xnandps__sinit_8c.html">xnandps_sinit.c</a></td><td class="indexvalue"></td></tr>
</table> </table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

592
XilinxProcessorIPLib/drivers/nandps/doc/html/api/functions.html
View file

@ -2,194 +2,454 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_a"><span>a</span></a></li>
<li><a href="#index_b"><span>b</span></a></li>
<li><a href="#index_c"><span>c</span></a></li>
<li><a href="#index_d"><span>d</span></a></li>
<li><a href="#index_e"><span>e</span></a></li>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_g"><span>g</span></a></li>
<li><a href="#index_i"><span>i</span></a></li>
<li><a href="#index_j"><span>j</span></a></li>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_m"><span>m</span></a></li>
<li><a href="#index_n"><span>n</span></a></li>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_p"><span>p</span></a></li>
<li><a href="#index_r"><span>r</span></a></li>
<li><a href="#index_s"><span>s</span></a></li>
<li><a href="#index_t"><span>t</span></a></li>
<li><a href="#index_v"><span>v</span></a></li>
<li><a href="#index_w"><span>w</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented class members with links to the class documentation for each member: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_a">- a -</a></h3><ul> <ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_a"><span>a</span></a></li>
<li><a href="#index_b"><span>b</span></a></li>
<li><a href="#index_c"><span>c</span></a></li>
<li><a href="#index_d"><span>d</span></a></li>
<li><a href="#index_e"><span>e</span></a></li>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_g"><span>g</span></a></li>
<li><a href="#index_i"><span>i</span></a></li>
<li><a href="#index_j"><span>j</span></a></li>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_m"><span>m</span></a></li>
<li><a href="#index_n"><span>n</span></a></li>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_p"><span>p</span></a></li>
<li><a href="#index_r"><span>r</span></a></li>
<li><a href="#index_s"><span>s</span></a></li>
<li><a href="#index_t"><span>t</span></a></li>
<li><a href="#index_v"><span>v</span></a></li>
<li><a href="#index_w"><span>w</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all class members with links to the classes they belong to:
<h3><a class="anchor" id="index_a">- a -</a></h3><ul>
<li>AddrCycles <li>AddrCycles
: <a class="el" href="struct____attribute____.html#0c2e8af82a31f3234a16725209dad65b">__attribute__</a>, <a class="el" href="struct_x_nand_ps___command_format.html#0c2e8af82a31f3234a16725209dad65b">XNandPs_CommandFormat</a></ul> : <a class="el" href="struct_x_nand_ps___command_format.html#a82db80bc15a0f098854ed8034187b36e">XNandPs_CommandFormat</a>
<h3><a class="anchor" name="index_b">- b -</a></h3><ul> , <a class="el" href="struct____attribute____.html#ae1951e4ef20db63b2b855828bc9fc542">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_b">- b -</a></h3><ul>
<li>BbPattern <li>BbPattern
: <a class="el" href="struct_x_nand_ps_tag.html#43a632a52209542962e99cc6ddb51761">XNandPsTag</a><li>Bbt : <a class="el" href="struct_x_nand_ps_tag.html#a00c4968d1371e52d8236782c50e36452">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps_tag.html#bece927a02c5808965835ad67226c027">XNandPsTag</a><li>BbtDesc </li>
: <a class="el" href="struct_x_nand_ps_tag.html#ae1a292df69f5cf2cacbd6dd73664b1f">XNandPsTag</a><li>BbtMirrorDesc <li>Bbt
: <a class="el" href="struct_x_nand_ps_tag.html#5cee2006232df19ec734dd69a9a851c9">XNandPsTag</a><li>BitsPerCell : <a class="el" href="struct_x_nand_ps_tag.html#a29ecaa7b4ab49c591e0a52fa425d1ff3">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#99bfe17aeb23e0899b1cc36e5c94b82e">__attribute__</a><li>BlockEndurance </li>
: <a class="el" href="struct____attribute____.html#1e0f5e94b1a7840c33638bddbe8084ec">__attribute__</a><li>BlockEnduranceGvb <li>BbtDesc
: <a class="el" href="struct____attribute____.html#88d7580ad1c48c9e06e2dff72fc7c20d">__attribute__</a><li>BlockSize : <a class="el" href="struct_x_nand_ps_tag.html#abcecaf1e47f62b9c985a6078cf4d5fc7">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps___ecc_config.html#18d721bf398e589932630551a08d2b1a">XNandPs_EccConfig</a>, <a class="el" href="struct_x_nand_ps___geometry.html#18d721bf398e589932630551a08d2b1a">XNandPs_Geometry</a><li>BlocksPerLun </li>
: <a class="el" href="struct____attribute____.html#6182fc16827eb1645bd224dd7010dacc">__attribute__</a>, <a class="el" href="struct_x_nand_ps___geometry.html#6182fc16827eb1645bd224dd7010dacc">XNandPs_Geometry</a><li>BytesPerBlock <li>BbtMirrorDesc
: <a class="el" href="struct_x_nand_ps___ecc_config.html#53f6f16ec8e8a6b2a7ceeafebd637091">XNandPs_EccConfig</a><li>BytesPerPage : <a class="el" href="struct_x_nand_ps_tag.html#a83046030135b11b8c13c98f1c39ef2e6">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#165f81fa46ef3536db1aca966075b475">__attribute__</a>, <a class="el" href="struct_x_nand_ps___geometry.html#165f81fa46ef3536db1aca966075b475">XNandPs_Geometry</a><li>BytesPerPartialPage </li>
: <a class="el" href="struct____attribute____.html#38272d124790204286dfeb1df37c42ce">__attribute__</a></ul> <li>BitsPerCell
<h3><a class="anchor" name="index_c">- c -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a5945f046602a03542392b3d2b67bd5bd">__attribute__</a>
</li>
<li>BlockEndurance
: <a class="el" href="struct____attribute____.html#abb12fee2e9502676d868b0ba07424409">__attribute__</a>
</li>
<li>BlockEnduranceGvb
: <a class="el" href="struct____attribute____.html#a8337320278817ff137b2443d6d1b480f">__attribute__</a>
</li>
<li>BlockSize
: <a class="el" href="struct_x_nand_ps___geometry.html#a27ad012d0279b497f04a927a6632a9ea">XNandPs_Geometry</a>
, <a class="el" href="struct_x_nand_ps___ecc_config.html#a888c887728d44586c2c67620630d0573">XNandPs_EccConfig</a>
</li>
<li>BlocksPerLun
: <a class="el" href="struct_x_nand_ps___geometry.html#a31603ee2b8dd38cc703f9ab69e78e4a8">XNandPs_Geometry</a>
, <a class="el" href="struct____attribute____.html#afc90a84645c3cce9922adb92bb19d565">__attribute__</a>
</li>
<li>BytesPerBlock
: <a class="el" href="struct_x_nand_ps___ecc_config.html#a84c86def067933bad578209c5ee11015">XNandPs_EccConfig</a>
</li>
<li>BytesPerPage
: <a class="el" href="struct____attribute____.html#aee14832615a129321beabd8737df5c60">__attribute__</a>
, <a class="el" href="struct_x_nand_ps___geometry.html#a82dcd79f0e23602ab1fa79ee86ea9494">XNandPs_Geometry</a>
</li>
<li>BytesPerPartialPage
: <a class="el" href="struct____attribute____.html#a409d9c263d9d4a77124c8b3bcbbdc7ac">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_c">- c -</a></h3><ul>
<li>ClkInputPinCap <li>ClkInputPinCap
: <a class="el" href="struct____attribute____.html#d04d435be707822aa6b0cf6dcb718672">__attribute__</a><li>ColAddrCycles : <a class="el" href="struct____attribute____.html#a5c6bb5ff546f5a5a353514021e196742">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#e88802732ec95baa460691b4b6f68802">XNandPs_Geometry</a><li>CommandPhaseAddr </li>
: <a class="el" href="struct_x_nand_ps_tag.html#26a6762c7490ec921a5632b703c28a13">XNandPsTag</a><li>Config <li>ColAddrCycles
: <a class="el" href="struct_x_nand_ps_tag.html#fa535ffb25e1fd20341652f9be21e06e">XNandPsTag</a><li>Crc : <a class="el" href="struct_x_nand_ps___geometry.html#a602a44775b539f786e98dbcb50327454">XNandPs_Geometry</a>
: <a class="el" href="struct____attribute____.html#55e731c6b6315941e95a1fe250b82e37">__attribute__</a></ul> </li>
<h3><a class="anchor" name="index_d">- d -</a></h3><ul> <li>CommandPhaseAddr
: <a class="el" href="struct_x_nand_ps_tag.html#a6d919091ec87fbd2ff032ba5650ec51a">XNandPsTag</a>
</li>
<li>Config
: <a class="el" href="struct_x_nand_ps_tag.html#ab1b1e7e123f5de23692bb7f7f757061a">XNandPsTag</a>
</li>
<li>Crc
: <a class="el" href="struct____attribute____.html#a7b440addb5b34343eaf1a2a81ef62b61">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_d">- d -</a></h3><ul>
<li>DataBuf <li>DataBuf
: <a class="el" href="struct_x_nand_ps_tag.html#b35f6b8236e52aa138644276398a1f4b">XNandPsTag</a><li>DataPhaseAddr : <a class="el" href="struct_x_nand_ps_tag.html#aba2da858e8dc13045862f0da98bd0c0b">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps_tag.html#9e8dca83007c4ceeff79b3dfaa5adef1">XNandPsTag</a><li>DateCode </li>
: <a class="el" href="struct____attribute____.html#0896b0012d7bc082654bc7730ad1e234">__attribute__</a><li>DeviceId <li>DataPhaseAddr
: <a class="el" href="struct_x_nand_ps___config.html#d0263c6cf0769cabc86cfe88226d204b">XNandPs_Config</a><li>DeviceManufacturer : <a class="el" href="struct_x_nand_ps_tag.html#a4be19061947af26c314f86e19aa2b45c">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#1cadb4e726bab8fd4b83d95356899c0d">__attribute__</a><li>DeviceModel </li>
: <a class="el" href="struct____attribute____.html#4f0a09be5aa1930cda2133ac386d2382">__attribute__</a><li>DeviceSize <li>DateCode
: <a class="el" href="struct_x_nand_ps___geometry.html#630349a26bf78074d073d397715e5648">XNandPs_Geometry</a><li>DrvStrength : <a class="el" href="struct____attribute____.html#ae6458f66128e33acfae7658e25adc497">__attribute__</a>
: <a class="el" href="struct____attribute____.html#c48294c80809238a48a4f93e4a8534c5">__attribute__</a></ul> </li>
<h3><a class="anchor" name="index_e">- e -</a></h3><ul> <li>DeviceId
: <a class="el" href="struct_x_nand_ps___config.html#a26496c5a680018144f7e4ca3fc0ca549">XNandPs_Config</a>
</li>
<li>DeviceManufacturer
: <a class="el" href="struct____attribute____.html#a2524769e5c80445c6f9f77c089a178e6">__attribute__</a>
</li>
<li>DeviceModel
: <a class="el" href="struct____attribute____.html#abeed86cb486b01de6c1a9ec8ab30bc44">__attribute__</a>
</li>
<li>DeviceSize
: <a class="el" href="struct_x_nand_ps___geometry.html#a9894e2b2ad34941cc39bb93eb47546ca">XNandPs_Geometry</a>
</li>
<li>DrvStrength
: <a class="el" href="struct____attribute____.html#a44fb12f2f9cde1b6dfe83a9ddaa067b7">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_e">- e -</a></h3><ul>
<li>EccBits <li>EccBits
: <a class="el" href="struct____attribute____.html#011a3ae2484e6afd66eaec20b7f2334d">__attribute__</a><li>EccCalc : <a class="el" href="struct____attribute____.html#ae8e9fb3d1aa081291dfd6e6fbc0e9dc9">__attribute__</a>
: <a class="el" href="struct_x_nand_ps_tag.html#c53e7d8e318e6c689ef91415aafccb42">XNandPsTag</a><li>EccCode </li>
: <a class="el" href="struct_x_nand_ps_tag.html#5c8061c0a75e1694aeaacd34e943fda2">XNandPsTag</a><li>EccConfig <li>EccCalc
: <a class="el" href="struct_x_nand_ps_tag.html#0ef526e8d33de40d609ecc9ad1fc4235">XNandPsTag</a><li>EccMode : <a class="el" href="struct_x_nand_ps_tag.html#a64b4c86a9f973a2fa02aea87fc972ce2">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps_tag.html#d16a3f88e1039e6fc1bfc54c45bef84b">XNandPsTag</a><li>EccPos </li>
: <a class="el" href="struct_x_nand_ps___ecc_config.html#e3d0d0f1dc6827c417a4705301b574bb">XNandPs_EccConfig</a><li>EndCmd <li>EccCode
: <a class="el" href="struct_x_nand_ps___command_format.html#eee7807725cd1e7a0422871f51257330">XNandPs_CommandFormat</a><li>EndCmdValid : <a class="el" href="struct_x_nand_ps_tag.html#a6dd8c8d225c09d0527bc751571494686">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps___command_format.html#61d57fe30554499c1473b0d72c75317a">XNandPs_CommandFormat</a><li>ExtParamPageLen </li>
: <a class="el" href="struct____attribute____.html#d66ab0e8adf7fb0f64295c0739cf8a05">__attribute__</a><li>EzNandSupport <li>EccConfig
: <a class="el" href="struct____attribute____.html#9c13ee45a3e7945c6a23739937bfbc62">__attribute__</a></ul> : <a class="el" href="struct_x_nand_ps_tag.html#a84179f6ef408a639b0486c2df7561728">XNandPsTag</a>
<h3><a class="anchor" name="index_f">- f -</a></h3><ul> </li>
<li>EccMode
: <a class="el" href="struct_x_nand_ps_tag.html#a91ba66b90e531f68b393e22dc1e6fab5">XNandPsTag</a>
</li>
<li>EccPos
: <a class="el" href="struct_x_nand_ps___ecc_config.html#a82671615fc44f9c211b60ed0755a1cf0">XNandPs_EccConfig</a>
</li>
<li>EndCmd
: <a class="el" href="struct_x_nand_ps___command_format.html#add044f5e1abe6bf7857d6e0d678b0ae8">XNandPs_CommandFormat</a>
</li>
<li>EndCmdValid
: <a class="el" href="struct_x_nand_ps___command_format.html#a4fc076b266b7ef2cc79e059c7ef4e59b">XNandPs_CommandFormat</a>
</li>
<li>ExtParamPageLen
: <a class="el" href="struct____attribute____.html#a74ad02ef10cfd915a9fa99beab81f78a">__attribute__</a>
</li>
<li>EzNandSupport
: <a class="el" href="struct____attribute____.html#acd341699f891b28db92f92ddf17dc32d">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_f">- f -</a></h3><ul>
<li>Features <li>Features
: <a class="el" href="struct____attribute____.html#98f770b0af18ca763421bac22b4b6805">__attribute__</a>, <a class="el" href="struct_x_nand_ps_tag.html#98f770b0af18ca763421bac22b4b6805">XNandPsTag</a><li>FlashBase : <a class="el" href="struct_x_nand_ps_tag.html#aaef39c1b3d681967d9097bdae9069a27">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps___config.html#c71e109adb7711154901f91a62d417ae">XNandPs_Config</a><li>FlashWidth , <a class="el" href="struct____attribute____.html#afa3bc2bc216d4f509b79c38257d2da38">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#39d206aeb396fd25b6c8e49e01f18064">XNandPs_Geometry</a>, <a class="el" href="struct_x_nand_ps___config.html#39d206aeb396fd25b6c8e49e01f18064">XNandPs_Config</a></ul> </li>
<h3><a class="anchor" name="index_g">- g -</a></h3><ul> <li>FlashBase
: <a class="el" href="struct_x_nand_ps___config.html#a0a1930e4ef28ad9c5d05e7bebafb14e0">XNandPs_Config</a>
</li>
<li>FlashWidth
: <a class="el" href="struct_x_nand_ps___config.html#a234acdb7c26211dc2dbe1854d493e54b">XNandPs_Config</a>
, <a class="el" href="struct_x_nand_ps___geometry.html#a510a7e1a08583b34bf81a1b4752fc3c2">XNandPs_Geometry</a>
</li>
</ul>
<h3><a class="anchor" id="index_g">- g -</a></h3><ul>
<li>Geometry <li>Geometry
: <a class="el" href="struct_x_nand_ps_tag.html#d9c6333623e6357515fcbf17be806273">XNandPsTag</a><li>GuaranteedValidBlock : <a class="el" href="struct_x_nand_ps_tag.html#ae87fd6bcc9622ee7d41abdbdaad61c35">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#935df05fb3def7de3dad3e9b7d34057e">__attribute__</a></ul> </li>
<h3><a class="anchor" name="index_i">- i -</a></h3><ul> <li>GuaranteedValidBlock
: <a class="el" href="struct____attribute____.html#a162ee716b6f631331a9f1f5f3dc9de73">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_i">- i -</a></h3><ul>
<li>InputPinCap <li>InputPinCap
: <a class="el" href="struct____attribute____.html#b537ca8143d2a6f05b3c025d56da511b">__attribute__</a><li>InputPinCapMax : <a class="el" href="struct____attribute____.html#a1b09bdf83dfe5e60e526eb0d7c0eb285">__attribute__</a>
: <a class="el" href="struct____attribute____.html#543117218103df294e21e1ab7eaeca77">__attribute__</a><li>InterleavedAddrBits </li>
: <a class="el" href="struct____attribute____.html#5f48f4e49bf664bc80633d678437cb9e">__attribute__</a><li>InterleavedOperation <li>InputPinCapMax
: <a class="el" href="struct____attribute____.html#ade98ca8049de6ea938a4f9090518d2a">__attribute__</a><li>IOPinCap : <a class="el" href="struct____attribute____.html#ac9313437a55fbae9f64b9555169c19e1">__attribute__</a>
: <a class="el" href="struct____attribute____.html#a616f3e417e0d586fed81862701f55eb">__attribute__</a><li>IOPinCapacitance </li>
: <a class="el" href="struct____attribute____.html#711c2fda94df949a5da5a73ed499a6e6">__attribute__</a><li>IsReady <li>InterleavedAddrBits
: <a class="el" href="struct_x_nand_ps_tag.html#217c41df00b2eee11e1009f5e63905ed">XNandPsTag</a></ul> : <a class="el" href="struct____attribute____.html#ae8e1c8d0da86a8bb5c2437f050c71d36">__attribute__</a>
<h3><a class="anchor" name="index_j">- j -</a></h3><ul> </li>
<li>InterleavedOperation
: <a class="el" href="struct____attribute____.html#a0e6d2c37f9cfaf40e292cb5b6428e1f1">__attribute__</a>
</li>
<li>IOPinCap
: <a class="el" href="struct____attribute____.html#a96de0c9ff6cfe84624306a06fbbb1faa">__attribute__</a>
</li>
<li>IOPinCapacitance
: <a class="el" href="struct____attribute____.html#a9099f29ea4616af786fef17bf80cbe4b">__attribute__</a>
</li>
<li>IsReady
: <a class="el" href="struct_x_nand_ps_tag.html#aad4084a7b6b1ea6b1ec350dd22203e50">XNandPsTag</a>
</li>
</ul>
<h3><a class="anchor" id="index_j">- j -</a></h3><ul>
<li>JedecManufacturerId <li>JedecManufacturerId
: <a class="el" href="struct____attribute____.html#ffd0f13696d26bc4f45744c5c7053675">__attribute__</a></ul> : <a class="el" href="struct____attribute____.html#a92fa611f43f81903fea7ac3f82e74e42">__attribute__</a>
<h3><a class="anchor" name="index_l">- l -</a></h3><ul> </li>
</ul>
<h3><a class="anchor" id="index_l">- l -</a></h3><ul>
<li>Length <li>Length
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#ba2a9c6c8c77e03f83ef8bf543612275">XNandPs_BadBlockPattern</a></ul> : <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#a826e0b5484ee7377da4ca47ca45df584">XNandPs_BadBlockPattern</a>
<h3><a class="anchor" name="index_m">- m -</a></h3><ul> </li>
</ul>
<h3><a class="anchor" id="index_m">- m -</a></h3><ul>
<li>MaxBadBlocksPerLun <li>MaxBadBlocksPerLun
: <a class="el" href="struct____attribute____.html#aa46a83478a5e6564dcdbeaafb8537d1">__attribute__</a><li>MaxBlocks : <a class="el" href="struct____attribute____.html#a8f9756744faccc77aed4ad85c33ef3a0">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#f380b28c54e6fbd228eca3b4ccae07e9">XNandPs_BbtDesc</a></ul> </li>
<h3><a class="anchor" name="index_n">- n -</a></h3><ul> <li>MaxBlocks
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#ae721a5302b9ed20c4cd4eecd450cd612">XNandPs_BbtDesc</a>
</li>
</ul>
<h3><a class="anchor" id="index_n">- n -</a></h3><ul>
<li>NumBlocks <li>NumBlocks
: <a class="el" href="struct_x_nand_ps___geometry.html#37a354f54afeb6ef54b1dae06a82931f">XNandPs_Geometry</a><li>NumLun : <a class="el" href="struct_x_nand_ps___geometry.html#aba602d679c47c2a568b36b3c504dd440">XNandPs_Geometry</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#13b141ddf23a6fbcabeff26b87dcdc05">XNandPs_Geometry</a><li>NumLuns </li>
: <a class="el" href="struct____attribute____.html#ad7681b92f0dcdd959d8992b812aa088">__attribute__</a><li>NumOfParamPages <li>NumLun
: <a class="el" href="struct____attribute____.html#f2bb0945056d277ccd26b565de28e386">__attribute__</a><li>NumPages : <a class="el" href="struct_x_nand_ps___geometry.html#a10b5fb603fa6bc1dfdace2bbca647519">XNandPs_Geometry</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#3f348ae2eb8f3aa76f67cd69820dbe1b">XNandPs_Geometry</a><li>NumSteps </li>
: <a class="el" href="struct_x_nand_ps___ecc_config.html#4d23c1adf1689d6dc2f9827778015e26">XNandPs_EccConfig</a></ul> <li>NumLuns
<h3><a class="anchor" name="index_o">- o -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a8ed967064c84f7b3c6285d56a442bdbc">__attribute__</a>
</li>
<li>NumOfParamPages
: <a class="el" href="struct____attribute____.html#ad609a82ab1fdec7736a37e0cdceb4d05">__attribute__</a>
</li>
<li>NumPages
: <a class="el" href="struct_x_nand_ps___geometry.html#aab479df67abfeb4be7403b429daf53bd">XNandPs_Geometry</a>
</li>
<li>NumSteps
: <a class="el" href="struct_x_nand_ps___ecc_config.html#acd6a685e2cd2ded83e2492f419d2f02d">XNandPs_EccConfig</a>
</li>
</ul>
<h3><a class="anchor" id="index_o">- o -</a></h3><ul>
<li>Offset <li>Offset
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#dfd0a82c4bf37b1e90b690a22a20692e">XNandPs_BadBlockPattern</a><li>OptionalCmds : <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#ab867944767569bd68b27802773fded54">XNandPs_BadBlockPattern</a>
: <a class="el" href="struct____attribute____.html#3efa9f5055e82be152627141a7c21ea4">__attribute__</a><li>Options </li>
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#dae8ace18bdcbcc6ae5aece263e14fe8">XNandPs_BadBlockPattern</a></ul> <li>OptionalCmds
<h3><a class="anchor" name="index_p">- p -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a182434f8035a9e6ebfefab1531764cfc">__attribute__</a>
</li>
<li>Options
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#ace3f3a1bd6474b1db80641a24fc8490f">XNandPs_BadBlockPattern</a>
</li>
</ul>
<h3><a class="anchor" id="index_p">- p -</a></h3><ul>
<li>PagecacheTimingMode <li>PagecacheTimingMode
: <a class="el" href="struct____attribute____.html#e424f27ddeb6f19c07ac57aa4604b207">__attribute__</a><li>PageOffset : <a class="el" href="struct____attribute____.html#afc3a6d92d67b0ef939893937e2751a26">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#ce18594684dceda5bf6a4d8f1cfb97ea">XNandPs_BbtDesc</a><li>PagesPerBlock </li>
: <a class="el" href="struct____attribute____.html#ada75f6789873891f1ad59e7f2026ce1">__attribute__</a>, <a class="el" href="struct_x_nand_ps___geometry.html#ada75f6789873891f1ad59e7f2026ce1">XNandPs_Geometry</a><li>PartialProgAttr <li>PageOffset
: <a class="el" href="struct____attribute____.html#efa4e38cca92b6ceabf9e012928ed41b">__attribute__</a><li>Pattern : <a class="el" href="struct_x_nand_ps___bbt_desc.html#a16893430fad70cd5b2121e5fb331bbbb">XNandPs_BbtDesc</a>
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#f7afe1d6c68cd23c15d19eab6876938c">XNandPs_BadBlockPattern</a><li>ProgramsPerPage </li>
: <a class="el" href="struct____attribute____.html#ab6f15661e1e3a38a2d7104903855b2b">__attribute__</a></ul> <li>PagesPerBlock
<h3><a class="anchor" name="index_r">- r -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a2cbc7e269776ae14e6656c319c67b95c">__attribute__</a>
, <a class="el" href="struct_x_nand_ps___geometry.html#a576a8a74bbfb359310107c333e0682d8">XNandPs_Geometry</a>
</li>
<li>PartialProgAttr
: <a class="el" href="struct____attribute____.html#a8ce9cbe059086b9304129aa545dd4022">__attribute__</a>
</li>
<li>Pattern
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#a9c1f59c04f5e756227c129e69d1fb45f">XNandPs_BadBlockPattern</a>
</li>
<li>ProgramCache
: <a class="el" href="struct_x_nand_ps___features.html#a21e1fa3e1a5a60b4c9d1d536ce784850">XNandPs_Features</a>
</li>
<li>ProgramsPerPage
: <a class="el" href="struct____attribute____.html#a0afebd968a69e6e9b68d218bce273dc0">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_r">- r -</a></h3><ul>
<li>ReadCache
: <a class="el" href="struct_x_nand_ps___features.html#a7f600fcb3799137e1edac3af4ba6dae3">XNandPs_Features</a>
</li>
<li>ReadPage <li>ReadPage
: <a class="el" href="struct_x_nand_ps_tag.html#11c27d643a28eff41240fef2699e2af5">XNandPsTag</a><li>Reserved0 : <a class="el" href="struct_x_nand_ps_tag.html#aa589f70667fa1b52e24e2384e421aa01">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#dd0495847cb86cdcfa5479f8c5651e4b">__attribute__</a><li>Reserved1 </li>
: <a class="el" href="struct____attribute____.html#8849048a8f3f2dea95ff29eac3290ad2">__attribute__</a><li>Reserved2 <li>Reserved0
: <a class="el" href="struct____attribute____.html#aae3264f9e2eabc4244d2f1e30ec33a4">__attribute__</a><li>Reserved3 : <a class="el" href="struct____attribute____.html#ae989b1f9056c0eff058855b81e0452d3">__attribute__</a>
: <a class="el" href="struct____attribute____.html#9241a367cefcfb7119c13e08ac90a241">__attribute__</a><li>Reserved4 </li>
: <a class="el" href="struct____attribute____.html#5aa283a216335c4c4579d8b3bf596253">__attribute__</a><li>Revision <li>Reserved1
: <a class="el" href="struct____attribute____.html#32c676ac5296556c0573a301ef5ab07b">__attribute__</a><li>RowAddrCycles : <a class="el" href="struct____attribute____.html#a83e6f57b75d9e507124e5ab52d4e2c97">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#8045d3ed504a4c7bfbfca92bab087c56">XNandPs_Geometry</a></ul> </li>
<h3><a class="anchor" name="index_s">- s -</a></h3><ul> <li>Reserved2
: <a class="el" href="struct____attribute____.html#ab2aa1e8cc0bea30414fb8c2f46439323">__attribute__</a>
</li>
<li>Reserved3
: <a class="el" href="struct____attribute____.html#a76047dca77080d3976926d6b4480d6e7">__attribute__</a>
</li>
<li>Reserved4
: <a class="el" href="struct____attribute____.html#a26d31e2c37f064de471efd08ad0c1417">__attribute__</a>
</li>
<li>Revision
: <a class="el" href="struct____attribute____.html#a5ae3199072acd3156a8ec9905e5afc43">__attribute__</a>
</li>
<li>RowAddrCycles
: <a class="el" href="struct_x_nand_ps___geometry.html#afd53531e448c5db979a145ba64214cee">XNandPs_Geometry</a>
</li>
</ul>
<h3><a class="anchor" id="index_s">- s -</a></h3><ul>
<li>SigLength <li>SigLength
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#2ad4ddc964b7bae19c896fa6f22d96ba">XNandPs_BbtDesc</a><li>Signature : <a class="el" href="struct_x_nand_ps___bbt_desc.html#a3d91d5bd2b9cb468e2232dbf28339d7f">XNandPs_BbtDesc</a>
: <a class="el" href="struct____attribute____.html#d4e5ab90cd0ecc2ae59b8df05e796cbe">__attribute__</a>, <a class="el" href="struct_x_nand_ps___bbt_desc.html#d4e5ab90cd0ecc2ae59b8df05e796cbe">XNandPs_BbtDesc</a><li>SigOffset </li>
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#42e006846cf0402ee5744cbbbe3548b3">XNandPs_BbtDesc</a><li>SmcBase <li>Signature
: <a class="el" href="struct_x_nand_ps___config.html#5714d78c05a4aa34c14695b45b4e53c2">XNandPs_Config</a><li>SpareBufPtr : <a class="el" href="struct_x_nand_ps___bbt_desc.html#a91b6593abad5f5eeb8e69030110381f4">XNandPs_BbtDesc</a>
: <a class="el" href="struct_x_nand_ps_tag.html#d86271320c7fe920dabe9591a26b2b35">XNandPsTag</a><li>SpareBytesPerPage , <a class="el" href="struct____attribute____.html#a1cd060deb10d798370f555fa08adc42f">__attribute__</a>
: <a class="el" href="struct____attribute____.html#3149a0e83655bbacef7fb906ce503e7c">__attribute__</a>, <a class="el" href="struct_x_nand_ps___geometry.html#3149a0e83655bbacef7fb906ce503e7c">XNandPs_Geometry</a><li>SpareBytesPerPartialPage </li>
: <a class="el" href="struct____attribute____.html#d6f1bf058a0ccdb5c1d500bcd5a4a806">__attribute__</a><li>StartCmd <li>SigOffset
: <a class="el" href="struct_x_nand_ps___command_format.html#965491e2a72c9d387bd99c1c3c0a664b">XNandPs_CommandFormat</a><li>SynFeatures : <a class="el" href="struct_x_nand_ps___bbt_desc.html#aaeafe1d72c4c3c25ef8d81f64cc19370">XNandPs_BbtDesc</a>
: <a class="el" href="struct____attribute____.html#0a62386f4f0495ede35e0b508ed9e549">__attribute__</a><li>SynTimingMode </li>
: <a class="el" href="struct____attribute____.html#edab83dc13c82391cf7b25e59c013816">__attribute__</a></ul> <li>SmcBase
<h3><a class="anchor" name="index_t">- t -</a></h3><ul> : <a class="el" href="struct_x_nand_ps___config.html#a7fb228465433017747bbf8a9bd9601d7">XNandPs_Config</a>
</li>
<li>SpareBufPtr
: <a class="el" href="struct_x_nand_ps_tag.html#a25507ef0fe95e9b0b871e03e65731cba">XNandPsTag</a>
</li>
<li>SpareBytesPerPage
: <a class="el" href="struct____attribute____.html#a0b265523687a2dbc8d88b36ea9aab19f">__attribute__</a>
, <a class="el" href="struct_x_nand_ps___geometry.html#a204fb8075fb5a30f2919280d923e6e25">XNandPs_Geometry</a>
</li>
<li>SpareBytesPerPartialPage
: <a class="el" href="struct____attribute____.html#a2e9900f1d4f10fdc2616a6b9601d73d5">__attribute__</a>
</li>
<li>StartCmd
: <a class="el" href="struct_x_nand_ps___command_format.html#abab8ebd07b5838c58667294329488788">XNandPs_CommandFormat</a>
</li>
<li>SynFeatures
: <a class="el" href="struct____attribute____.html#a6b9677be4e5173320c812c2fd92e5c93">__attribute__</a>
</li>
<li>SynTimingMode
: <a class="el" href="struct____attribute____.html#abcfcfd60500ac0c80152c0c610ad9f38">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_t">- t -</a></h3><ul>
<li>TAdl <li>TAdl
: <a class="el" href="struct____attribute____.html#655b640db578165c755d45e3ab1f0a4f">__attribute__</a><li>TBers : <a class="el" href="struct____attribute____.html#aed6c77972ad2394ba6371b5568030683">__attribute__</a>
: <a class="el" href="struct____attribute____.html#cdb5cd34282dcb84a65ea4c129aa2e1c">__attribute__</a><li>TCcs </li>
: <a class="el" href="struct____attribute____.html#d050bc780fbb441cfccba2bd4e69b7b0">__attribute__</a><li>TEr <li>TBers
: <a class="el" href="struct____attribute____.html#42f03939f90b7ed8967c313db5a078ad">__attribute__</a><li>TimingMode : <a class="el" href="struct____attribute____.html#af64b0e7bdce25c2944d135a142526a5b">__attribute__</a>
: <a class="el" href="struct____attribute____.html#48824e0b1473f704d048423478032327">__attribute__</a><li>TMr </li>
: <a class="el" href="struct____attribute____.html#cd5d8d78fc80e71dda7fe4d014cdaefd">__attribute__</a><li>TotalBytes <li>TCcs
: <a class="el" href="struct_x_nand_ps___ecc_config.html#703b69708c417c0898b225b995d4e1d0">XNandPs_EccConfig</a><li>TProg : <a class="el" href="struct____attribute____.html#a96987ab855b89ccf5db4591c8a72d7a7">__attribute__</a>
: <a class="el" href="struct____attribute____.html#d93bdd1eced83ba52f77bf03bbc6fb93">__attribute__</a><li>TR </li>
: <a class="el" href="struct____attribute____.html#ebe021079e5a3c4f42ca6119eab92633">__attribute__</a></ul> <li>TEr
<h3><a class="anchor" name="index_v">- v -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a9f4a9983edb5d64443b73164445af364">__attribute__</a>
</li>
<li>TimingMode
: <a class="el" href="struct____attribute____.html#a1b0c4c0a0f1785b762058ae52de0fbad">__attribute__</a>
</li>
<li>TMr
: <a class="el" href="struct____attribute____.html#acd50923d29bb030b12ac8bf097f2c942">__attribute__</a>
</li>
<li>TotalBytes
: <a class="el" href="struct_x_nand_ps___ecc_config.html#af197dcee444dcc8849dba90b29308559">XNandPs_EccConfig</a>
</li>
<li>TProg
: <a class="el" href="struct____attribute____.html#aed945fe658be1350d16d0814253eb263">__attribute__</a>
</li>
<li>TR
: <a class="el" href="struct____attribute____.html#a83d29b11f7a3f746c19431dc789edbf2">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_v">- v -</a></h3><ul>
<li>Valid <li>Valid
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#3ac705f2acd51a4613f9188c05c91d0d">XNandPs_BbtDesc</a><li>VendorRevisionNum : <a class="el" href="struct_x_nand_ps___bbt_desc.html#a08bf6a3876905cc8cd8fb858a29faea4">XNandPs_BbtDesc</a>
: <a class="el" href="struct____attribute____.html#89e46d5f790a21d68cf4e0a1d1dab011">__attribute__</a><li>VendorSpecific </li>
: <a class="el" href="struct____attribute____.html#b2e9a938dd1ea610ee9e9f30723a3a7d">__attribute__</a><li>VerOffset <li>VendorRevisionNum
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#b39b437ad34324a0a55b243fd6d037dd">XNandPs_BbtDesc</a><li>Version : <a class="el" href="struct____attribute____.html#a8bfb9abf5bf7e99135d5b9ba74af74be">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#34b6cd75171affba6957e308dcbd92be">XNandPs_BbtDesc</a></ul> </li>
<h3><a class="anchor" name="index_w">- w -</a></h3><ul> <li>VendorSpecific
: <a class="el" href="struct____attribute____.html#a91f9605e84444cb08769bbd04bc0984f">__attribute__</a>
</li>
<li>VerOffset
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#afa8974f0829f8e1f72b6df0ab31002d5">XNandPs_BbtDesc</a>
</li>
<li>Version
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#a894c8610ffe5a988185cb7e3dbdd0cf9">XNandPs_BbtDesc</a>
</li>
</ul>
<h3><a class="anchor" id="index_w">- w -</a></h3><ul>
<li>WritePage <li>WritePage
: <a class="el" href="struct_x_nand_ps_tag.html#65c824de6a5d137a1b4fe7b8586e2d03">XNandPsTag</a></ul> : <a class="el" href="struct_x_nand_ps_tag.html#a8d00d94fd28aadf317edc5fa9e4e0e38">XNandPsTag</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

590
XilinxProcessorIPLib/drivers/nandps/doc/html/api/functions_vars.html
View file

@ -2,194 +2,454 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members - Variables Xilinx Driver nandps v2_1: Class Members - Variables
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="functions.html"><span>All</span></a></li>
<li id="current"><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_a"><span>a</span></a></li>
<li><a href="#index_b"><span>b</span></a></li>
<li><a href="#index_c"><span>c</span></a></li>
<li><a href="#index_d"><span>d</span></a></li>
<li><a href="#index_e"><span>e</span></a></li>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_g"><span>g</span></a></li>
<li><a href="#index_i"><span>i</span></a></li>
<li><a href="#index_j"><span>j</span></a></li>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_m"><span>m</span></a></li>
<li><a href="#index_n"><span>n</span></a></li>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_p"><span>p</span></a></li>
<li><a href="#index_r"><span>r</span></a></li>
<li><a href="#index_s"><span>s</span></a></li>
<li><a href="#index_t"><span>t</span></a></li>
<li><a href="#index_v"><span>v</span></a></li>
<li><a href="#index_w"><span>w</span></a></li>
</ul>
</div>
<p> <!-- 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="functions.html"><span>All</span></a></li>
<li class="current"><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_a"><span>a</span></a></li>
<li><a href="#index_b"><span>b</span></a></li>
<li><a href="#index_c"><span>c</span></a></li>
<li><a href="#index_d"><span>d</span></a></li>
<li><a href="#index_e"><span>e</span></a></li>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_g"><span>g</span></a></li>
<li><a href="#index_i"><span>i</span></a></li>
<li><a href="#index_j"><span>j</span></a></li>
<li><a href="#index_l"><span>l</span></a></li>
<li><a href="#index_m"><span>m</span></a></li>
<li><a href="#index_n"><span>n</span></a></li>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_p"><span>p</span></a></li>
<li><a href="#index_r"><span>r</span></a></li>
<li><a href="#index_s"><span>s</span></a></li>
<li><a href="#index_t"><span>t</span></a></li>
<li><a href="#index_v"><span>v</span></a></li>
<li><a href="#index_w"><span>w</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp; &nbsp;
<p>
<h3><a class="anchor" name="index_a">- a -</a></h3><ul> <h3><a class="anchor" id="index_a">- a -</a></h3><ul>
<li>AddrCycles <li>AddrCycles
: <a class="el" href="struct____attribute____.html#0c2e8af82a31f3234a16725209dad65b">__attribute__</a>, <a class="el" href="struct_x_nand_ps___command_format.html#0c2e8af82a31f3234a16725209dad65b">XNandPs_CommandFormat</a></ul> : <a class="el" href="struct_x_nand_ps___command_format.html#a82db80bc15a0f098854ed8034187b36e">XNandPs_CommandFormat</a>
<h3><a class="anchor" name="index_b">- b -</a></h3><ul> , <a class="el" href="struct____attribute____.html#ae1951e4ef20db63b2b855828bc9fc542">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_b">- b -</a></h3><ul>
<li>BbPattern <li>BbPattern
: <a class="el" href="struct_x_nand_ps_tag.html#43a632a52209542962e99cc6ddb51761">XNandPsTag</a><li>Bbt : <a class="el" href="struct_x_nand_ps_tag.html#a00c4968d1371e52d8236782c50e36452">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps_tag.html#bece927a02c5808965835ad67226c027">XNandPsTag</a><li>BbtDesc </li>
: <a class="el" href="struct_x_nand_ps_tag.html#ae1a292df69f5cf2cacbd6dd73664b1f">XNandPsTag</a><li>BbtMirrorDesc <li>Bbt
: <a class="el" href="struct_x_nand_ps_tag.html#5cee2006232df19ec734dd69a9a851c9">XNandPsTag</a><li>BitsPerCell : <a class="el" href="struct_x_nand_ps_tag.html#a29ecaa7b4ab49c591e0a52fa425d1ff3">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#99bfe17aeb23e0899b1cc36e5c94b82e">__attribute__</a><li>BlockEndurance </li>
: <a class="el" href="struct____attribute____.html#1e0f5e94b1a7840c33638bddbe8084ec">__attribute__</a><li>BlockEnduranceGvb <li>BbtDesc
: <a class="el" href="struct____attribute____.html#88d7580ad1c48c9e06e2dff72fc7c20d">__attribute__</a><li>BlockSize : <a class="el" href="struct_x_nand_ps_tag.html#abcecaf1e47f62b9c985a6078cf4d5fc7">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps___ecc_config.html#18d721bf398e589932630551a08d2b1a">XNandPs_EccConfig</a>, <a class="el" href="struct_x_nand_ps___geometry.html#18d721bf398e589932630551a08d2b1a">XNandPs_Geometry</a><li>BlocksPerLun </li>
: <a class="el" href="struct____attribute____.html#6182fc16827eb1645bd224dd7010dacc">__attribute__</a>, <a class="el" href="struct_x_nand_ps___geometry.html#6182fc16827eb1645bd224dd7010dacc">XNandPs_Geometry</a><li>BytesPerBlock <li>BbtMirrorDesc
: <a class="el" href="struct_x_nand_ps___ecc_config.html#53f6f16ec8e8a6b2a7ceeafebd637091">XNandPs_EccConfig</a><li>BytesPerPage : <a class="el" href="struct_x_nand_ps_tag.html#a83046030135b11b8c13c98f1c39ef2e6">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#165f81fa46ef3536db1aca966075b475">__attribute__</a>, <a class="el" href="struct_x_nand_ps___geometry.html#165f81fa46ef3536db1aca966075b475">XNandPs_Geometry</a><li>BytesPerPartialPage </li>
: <a class="el" href="struct____attribute____.html#38272d124790204286dfeb1df37c42ce">__attribute__</a></ul> <li>BitsPerCell
<h3><a class="anchor" name="index_c">- c -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a5945f046602a03542392b3d2b67bd5bd">__attribute__</a>
</li>
<li>BlockEndurance
: <a class="el" href="struct____attribute____.html#abb12fee2e9502676d868b0ba07424409">__attribute__</a>
</li>
<li>BlockEnduranceGvb
: <a class="el" href="struct____attribute____.html#a8337320278817ff137b2443d6d1b480f">__attribute__</a>
</li>
<li>BlockSize
: <a class="el" href="struct_x_nand_ps___geometry.html#a27ad012d0279b497f04a927a6632a9ea">XNandPs_Geometry</a>
, <a class="el" href="struct_x_nand_ps___ecc_config.html#a888c887728d44586c2c67620630d0573">XNandPs_EccConfig</a>
</li>
<li>BlocksPerLun
: <a class="el" href="struct_x_nand_ps___geometry.html#a31603ee2b8dd38cc703f9ab69e78e4a8">XNandPs_Geometry</a>
, <a class="el" href="struct____attribute____.html#afc90a84645c3cce9922adb92bb19d565">__attribute__</a>
</li>
<li>BytesPerBlock
: <a class="el" href="struct_x_nand_ps___ecc_config.html#a84c86def067933bad578209c5ee11015">XNandPs_EccConfig</a>
</li>
<li>BytesPerPage
: <a class="el" href="struct____attribute____.html#aee14832615a129321beabd8737df5c60">__attribute__</a>
, <a class="el" href="struct_x_nand_ps___geometry.html#a82dcd79f0e23602ab1fa79ee86ea9494">XNandPs_Geometry</a>
</li>
<li>BytesPerPartialPage
: <a class="el" href="struct____attribute____.html#a409d9c263d9d4a77124c8b3bcbbdc7ac">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_c">- c -</a></h3><ul>
<li>ClkInputPinCap <li>ClkInputPinCap
: <a class="el" href="struct____attribute____.html#d04d435be707822aa6b0cf6dcb718672">__attribute__</a><li>ColAddrCycles : <a class="el" href="struct____attribute____.html#a5c6bb5ff546f5a5a353514021e196742">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#e88802732ec95baa460691b4b6f68802">XNandPs_Geometry</a><li>CommandPhaseAddr </li>
: <a class="el" href="struct_x_nand_ps_tag.html#26a6762c7490ec921a5632b703c28a13">XNandPsTag</a><li>Config <li>ColAddrCycles
: <a class="el" href="struct_x_nand_ps_tag.html#fa535ffb25e1fd20341652f9be21e06e">XNandPsTag</a><li>Crc : <a class="el" href="struct_x_nand_ps___geometry.html#a602a44775b539f786e98dbcb50327454">XNandPs_Geometry</a>
: <a class="el" href="struct____attribute____.html#55e731c6b6315941e95a1fe250b82e37">__attribute__</a></ul> </li>
<h3><a class="anchor" name="index_d">- d -</a></h3><ul> <li>CommandPhaseAddr
: <a class="el" href="struct_x_nand_ps_tag.html#a6d919091ec87fbd2ff032ba5650ec51a">XNandPsTag</a>
</li>
<li>Config
: <a class="el" href="struct_x_nand_ps_tag.html#ab1b1e7e123f5de23692bb7f7f757061a">XNandPsTag</a>
</li>
<li>Crc
: <a class="el" href="struct____attribute____.html#a7b440addb5b34343eaf1a2a81ef62b61">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_d">- d -</a></h3><ul>
<li>DataBuf <li>DataBuf
: <a class="el" href="struct_x_nand_ps_tag.html#b35f6b8236e52aa138644276398a1f4b">XNandPsTag</a><li>DataPhaseAddr : <a class="el" href="struct_x_nand_ps_tag.html#aba2da858e8dc13045862f0da98bd0c0b">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps_tag.html#9e8dca83007c4ceeff79b3dfaa5adef1">XNandPsTag</a><li>DateCode </li>
: <a class="el" href="struct____attribute____.html#0896b0012d7bc082654bc7730ad1e234">__attribute__</a><li>DeviceId <li>DataPhaseAddr
: <a class="el" href="struct_x_nand_ps___config.html#d0263c6cf0769cabc86cfe88226d204b">XNandPs_Config</a><li>DeviceManufacturer : <a class="el" href="struct_x_nand_ps_tag.html#a4be19061947af26c314f86e19aa2b45c">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#1cadb4e726bab8fd4b83d95356899c0d">__attribute__</a><li>DeviceModel </li>
: <a class="el" href="struct____attribute____.html#4f0a09be5aa1930cda2133ac386d2382">__attribute__</a><li>DeviceSize <li>DateCode
: <a class="el" href="struct_x_nand_ps___geometry.html#630349a26bf78074d073d397715e5648">XNandPs_Geometry</a><li>DrvStrength : <a class="el" href="struct____attribute____.html#ae6458f66128e33acfae7658e25adc497">__attribute__</a>
: <a class="el" href="struct____attribute____.html#c48294c80809238a48a4f93e4a8534c5">__attribute__</a></ul> </li>
<h3><a class="anchor" name="index_e">- e -</a></h3><ul> <li>DeviceId
: <a class="el" href="struct_x_nand_ps___config.html#a26496c5a680018144f7e4ca3fc0ca549">XNandPs_Config</a>
</li>
<li>DeviceManufacturer
: <a class="el" href="struct____attribute____.html#a2524769e5c80445c6f9f77c089a178e6">__attribute__</a>
</li>
<li>DeviceModel
: <a class="el" href="struct____attribute____.html#abeed86cb486b01de6c1a9ec8ab30bc44">__attribute__</a>
</li>
<li>DeviceSize
: <a class="el" href="struct_x_nand_ps___geometry.html#a9894e2b2ad34941cc39bb93eb47546ca">XNandPs_Geometry</a>
</li>
<li>DrvStrength
: <a class="el" href="struct____attribute____.html#a44fb12f2f9cde1b6dfe83a9ddaa067b7">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_e">- e -</a></h3><ul>
<li>EccBits <li>EccBits
: <a class="el" href="struct____attribute____.html#011a3ae2484e6afd66eaec20b7f2334d">__attribute__</a><li>EccCalc : <a class="el" href="struct____attribute____.html#ae8e9fb3d1aa081291dfd6e6fbc0e9dc9">__attribute__</a>
: <a class="el" href="struct_x_nand_ps_tag.html#c53e7d8e318e6c689ef91415aafccb42">XNandPsTag</a><li>EccCode </li>
: <a class="el" href="struct_x_nand_ps_tag.html#5c8061c0a75e1694aeaacd34e943fda2">XNandPsTag</a><li>EccConfig <li>EccCalc
: <a class="el" href="struct_x_nand_ps_tag.html#0ef526e8d33de40d609ecc9ad1fc4235">XNandPsTag</a><li>EccMode : <a class="el" href="struct_x_nand_ps_tag.html#a64b4c86a9f973a2fa02aea87fc972ce2">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps_tag.html#d16a3f88e1039e6fc1bfc54c45bef84b">XNandPsTag</a><li>EccPos </li>
: <a class="el" href="struct_x_nand_ps___ecc_config.html#e3d0d0f1dc6827c417a4705301b574bb">XNandPs_EccConfig</a><li>EndCmd <li>EccCode
: <a class="el" href="struct_x_nand_ps___command_format.html#eee7807725cd1e7a0422871f51257330">XNandPs_CommandFormat</a><li>EndCmdValid : <a class="el" href="struct_x_nand_ps_tag.html#a6dd8c8d225c09d0527bc751571494686">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps___command_format.html#61d57fe30554499c1473b0d72c75317a">XNandPs_CommandFormat</a><li>ExtParamPageLen </li>
: <a class="el" href="struct____attribute____.html#d66ab0e8adf7fb0f64295c0739cf8a05">__attribute__</a><li>EzNandSupport <li>EccConfig
: <a class="el" href="struct____attribute____.html#9c13ee45a3e7945c6a23739937bfbc62">__attribute__</a></ul> : <a class="el" href="struct_x_nand_ps_tag.html#a84179f6ef408a639b0486c2df7561728">XNandPsTag</a>
<h3><a class="anchor" name="index_f">- f -</a></h3><ul> </li>
<li>EccMode
: <a class="el" href="struct_x_nand_ps_tag.html#a91ba66b90e531f68b393e22dc1e6fab5">XNandPsTag</a>
</li>
<li>EccPos
: <a class="el" href="struct_x_nand_ps___ecc_config.html#a82671615fc44f9c211b60ed0755a1cf0">XNandPs_EccConfig</a>
</li>
<li>EndCmd
: <a class="el" href="struct_x_nand_ps___command_format.html#add044f5e1abe6bf7857d6e0d678b0ae8">XNandPs_CommandFormat</a>
</li>
<li>EndCmdValid
: <a class="el" href="struct_x_nand_ps___command_format.html#a4fc076b266b7ef2cc79e059c7ef4e59b">XNandPs_CommandFormat</a>
</li>
<li>ExtParamPageLen
: <a class="el" href="struct____attribute____.html#a74ad02ef10cfd915a9fa99beab81f78a">__attribute__</a>
</li>
<li>EzNandSupport
: <a class="el" href="struct____attribute____.html#acd341699f891b28db92f92ddf17dc32d">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_f">- f -</a></h3><ul>
<li>Features <li>Features
: <a class="el" href="struct____attribute____.html#98f770b0af18ca763421bac22b4b6805">__attribute__</a>, <a class="el" href="struct_x_nand_ps_tag.html#98f770b0af18ca763421bac22b4b6805">XNandPsTag</a><li>FlashBase : <a class="el" href="struct_x_nand_ps_tag.html#aaef39c1b3d681967d9097bdae9069a27">XNandPsTag</a>
: <a class="el" href="struct_x_nand_ps___config.html#c71e109adb7711154901f91a62d417ae">XNandPs_Config</a><li>FlashWidth , <a class="el" href="struct____attribute____.html#afa3bc2bc216d4f509b79c38257d2da38">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#39d206aeb396fd25b6c8e49e01f18064">XNandPs_Geometry</a>, <a class="el" href="struct_x_nand_ps___config.html#39d206aeb396fd25b6c8e49e01f18064">XNandPs_Config</a></ul> </li>
<h3><a class="anchor" name="index_g">- g -</a></h3><ul> <li>FlashBase
: <a class="el" href="struct_x_nand_ps___config.html#a0a1930e4ef28ad9c5d05e7bebafb14e0">XNandPs_Config</a>
</li>
<li>FlashWidth
: <a class="el" href="struct_x_nand_ps___config.html#a234acdb7c26211dc2dbe1854d493e54b">XNandPs_Config</a>
, <a class="el" href="struct_x_nand_ps___geometry.html#a510a7e1a08583b34bf81a1b4752fc3c2">XNandPs_Geometry</a>
</li>
</ul>
<h3><a class="anchor" id="index_g">- g -</a></h3><ul>
<li>Geometry <li>Geometry
: <a class="el" href="struct_x_nand_ps_tag.html#d9c6333623e6357515fcbf17be806273">XNandPsTag</a><li>GuaranteedValidBlock : <a class="el" href="struct_x_nand_ps_tag.html#ae87fd6bcc9622ee7d41abdbdaad61c35">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#935df05fb3def7de3dad3e9b7d34057e">__attribute__</a></ul> </li>
<h3><a class="anchor" name="index_i">- i -</a></h3><ul> <li>GuaranteedValidBlock
: <a class="el" href="struct____attribute____.html#a162ee716b6f631331a9f1f5f3dc9de73">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_i">- i -</a></h3><ul>
<li>InputPinCap <li>InputPinCap
: <a class="el" href="struct____attribute____.html#b537ca8143d2a6f05b3c025d56da511b">__attribute__</a><li>InputPinCapMax : <a class="el" href="struct____attribute____.html#a1b09bdf83dfe5e60e526eb0d7c0eb285">__attribute__</a>
: <a class="el" href="struct____attribute____.html#543117218103df294e21e1ab7eaeca77">__attribute__</a><li>InterleavedAddrBits </li>
: <a class="el" href="struct____attribute____.html#5f48f4e49bf664bc80633d678437cb9e">__attribute__</a><li>InterleavedOperation <li>InputPinCapMax
: <a class="el" href="struct____attribute____.html#ade98ca8049de6ea938a4f9090518d2a">__attribute__</a><li>IOPinCap : <a class="el" href="struct____attribute____.html#ac9313437a55fbae9f64b9555169c19e1">__attribute__</a>
: <a class="el" href="struct____attribute____.html#a616f3e417e0d586fed81862701f55eb">__attribute__</a><li>IOPinCapacitance </li>
: <a class="el" href="struct____attribute____.html#711c2fda94df949a5da5a73ed499a6e6">__attribute__</a><li>IsReady <li>InterleavedAddrBits
: <a class="el" href="struct_x_nand_ps_tag.html#217c41df00b2eee11e1009f5e63905ed">XNandPsTag</a></ul> : <a class="el" href="struct____attribute____.html#ae8e1c8d0da86a8bb5c2437f050c71d36">__attribute__</a>
<h3><a class="anchor" name="index_j">- j -</a></h3><ul> </li>
<li>InterleavedOperation
: <a class="el" href="struct____attribute____.html#a0e6d2c37f9cfaf40e292cb5b6428e1f1">__attribute__</a>
</li>
<li>IOPinCap
: <a class="el" href="struct____attribute____.html#a96de0c9ff6cfe84624306a06fbbb1faa">__attribute__</a>
</li>
<li>IOPinCapacitance
: <a class="el" href="struct____attribute____.html#a9099f29ea4616af786fef17bf80cbe4b">__attribute__</a>
</li>
<li>IsReady
: <a class="el" href="struct_x_nand_ps_tag.html#aad4084a7b6b1ea6b1ec350dd22203e50">XNandPsTag</a>
</li>
</ul>
<h3><a class="anchor" id="index_j">- j -</a></h3><ul>
<li>JedecManufacturerId <li>JedecManufacturerId
: <a class="el" href="struct____attribute____.html#ffd0f13696d26bc4f45744c5c7053675">__attribute__</a></ul> : <a class="el" href="struct____attribute____.html#a92fa611f43f81903fea7ac3f82e74e42">__attribute__</a>
<h3><a class="anchor" name="index_l">- l -</a></h3><ul> </li>
</ul>
<h3><a class="anchor" id="index_l">- l -</a></h3><ul>
<li>Length <li>Length
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#ba2a9c6c8c77e03f83ef8bf543612275">XNandPs_BadBlockPattern</a></ul> : <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#a826e0b5484ee7377da4ca47ca45df584">XNandPs_BadBlockPattern</a>
<h3><a class="anchor" name="index_m">- m -</a></h3><ul> </li>
</ul>
<h3><a class="anchor" id="index_m">- m -</a></h3><ul>
<li>MaxBadBlocksPerLun <li>MaxBadBlocksPerLun
: <a class="el" href="struct____attribute____.html#aa46a83478a5e6564dcdbeaafb8537d1">__attribute__</a><li>MaxBlocks : <a class="el" href="struct____attribute____.html#a8f9756744faccc77aed4ad85c33ef3a0">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#f380b28c54e6fbd228eca3b4ccae07e9">XNandPs_BbtDesc</a></ul> </li>
<h3><a class="anchor" name="index_n">- n -</a></h3><ul> <li>MaxBlocks
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#ae721a5302b9ed20c4cd4eecd450cd612">XNandPs_BbtDesc</a>
</li>
</ul>
<h3><a class="anchor" id="index_n">- n -</a></h3><ul>
<li>NumBlocks <li>NumBlocks
: <a class="el" href="struct_x_nand_ps___geometry.html#37a354f54afeb6ef54b1dae06a82931f">XNandPs_Geometry</a><li>NumLun : <a class="el" href="struct_x_nand_ps___geometry.html#aba602d679c47c2a568b36b3c504dd440">XNandPs_Geometry</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#13b141ddf23a6fbcabeff26b87dcdc05">XNandPs_Geometry</a><li>NumLuns </li>
: <a class="el" href="struct____attribute____.html#ad7681b92f0dcdd959d8992b812aa088">__attribute__</a><li>NumOfParamPages <li>NumLun
: <a class="el" href="struct____attribute____.html#f2bb0945056d277ccd26b565de28e386">__attribute__</a><li>NumPages : <a class="el" href="struct_x_nand_ps___geometry.html#a10b5fb603fa6bc1dfdace2bbca647519">XNandPs_Geometry</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#3f348ae2eb8f3aa76f67cd69820dbe1b">XNandPs_Geometry</a><li>NumSteps </li>
: <a class="el" href="struct_x_nand_ps___ecc_config.html#4d23c1adf1689d6dc2f9827778015e26">XNandPs_EccConfig</a></ul> <li>NumLuns
<h3><a class="anchor" name="index_o">- o -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a8ed967064c84f7b3c6285d56a442bdbc">__attribute__</a>
</li>
<li>NumOfParamPages
: <a class="el" href="struct____attribute____.html#ad609a82ab1fdec7736a37e0cdceb4d05">__attribute__</a>
</li>
<li>NumPages
: <a class="el" href="struct_x_nand_ps___geometry.html#aab479df67abfeb4be7403b429daf53bd">XNandPs_Geometry</a>
</li>
<li>NumSteps
: <a class="el" href="struct_x_nand_ps___ecc_config.html#acd6a685e2cd2ded83e2492f419d2f02d">XNandPs_EccConfig</a>
</li>
</ul>
<h3><a class="anchor" id="index_o">- o -</a></h3><ul>
<li>Offset <li>Offset
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#dfd0a82c4bf37b1e90b690a22a20692e">XNandPs_BadBlockPattern</a><li>OptionalCmds : <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#ab867944767569bd68b27802773fded54">XNandPs_BadBlockPattern</a>
: <a class="el" href="struct____attribute____.html#3efa9f5055e82be152627141a7c21ea4">__attribute__</a><li>Options </li>
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#dae8ace18bdcbcc6ae5aece263e14fe8">XNandPs_BadBlockPattern</a></ul> <li>OptionalCmds
<h3><a class="anchor" name="index_p">- p -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a182434f8035a9e6ebfefab1531764cfc">__attribute__</a>
</li>
<li>Options
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#ace3f3a1bd6474b1db80641a24fc8490f">XNandPs_BadBlockPattern</a>
</li>
</ul>
<h3><a class="anchor" id="index_p">- p -</a></h3><ul>
<li>PagecacheTimingMode <li>PagecacheTimingMode
: <a class="el" href="struct____attribute____.html#e424f27ddeb6f19c07ac57aa4604b207">__attribute__</a><li>PageOffset : <a class="el" href="struct____attribute____.html#afc3a6d92d67b0ef939893937e2751a26">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#ce18594684dceda5bf6a4d8f1cfb97ea">XNandPs_BbtDesc</a><li>PagesPerBlock </li>
: <a class="el" href="struct____attribute____.html#ada75f6789873891f1ad59e7f2026ce1">__attribute__</a>, <a class="el" href="struct_x_nand_ps___geometry.html#ada75f6789873891f1ad59e7f2026ce1">XNandPs_Geometry</a><li>PartialProgAttr <li>PageOffset
: <a class="el" href="struct____attribute____.html#efa4e38cca92b6ceabf9e012928ed41b">__attribute__</a><li>Pattern : <a class="el" href="struct_x_nand_ps___bbt_desc.html#a16893430fad70cd5b2121e5fb331bbbb">XNandPs_BbtDesc</a>
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#f7afe1d6c68cd23c15d19eab6876938c">XNandPs_BadBlockPattern</a><li>ProgramsPerPage </li>
: <a class="el" href="struct____attribute____.html#ab6f15661e1e3a38a2d7104903855b2b">__attribute__</a></ul> <li>PagesPerBlock
<h3><a class="anchor" name="index_r">- r -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a2cbc7e269776ae14e6656c319c67b95c">__attribute__</a>
, <a class="el" href="struct_x_nand_ps___geometry.html#a576a8a74bbfb359310107c333e0682d8">XNandPs_Geometry</a>
</li>
<li>PartialProgAttr
: <a class="el" href="struct____attribute____.html#a8ce9cbe059086b9304129aa545dd4022">__attribute__</a>
</li>
<li>Pattern
: <a class="el" href="struct_x_nand_ps___bad_block_pattern.html#a9c1f59c04f5e756227c129e69d1fb45f">XNandPs_BadBlockPattern</a>
</li>
<li>ProgramCache
: <a class="el" href="struct_x_nand_ps___features.html#a21e1fa3e1a5a60b4c9d1d536ce784850">XNandPs_Features</a>
</li>
<li>ProgramsPerPage
: <a class="el" href="struct____attribute____.html#a0afebd968a69e6e9b68d218bce273dc0">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_r">- r -</a></h3><ul>
<li>ReadCache
: <a class="el" href="struct_x_nand_ps___features.html#a7f600fcb3799137e1edac3af4ba6dae3">XNandPs_Features</a>
</li>
<li>ReadPage <li>ReadPage
: <a class="el" href="struct_x_nand_ps_tag.html#11c27d643a28eff41240fef2699e2af5">XNandPsTag</a><li>Reserved0 : <a class="el" href="struct_x_nand_ps_tag.html#aa589f70667fa1b52e24e2384e421aa01">XNandPsTag</a>
: <a class="el" href="struct____attribute____.html#dd0495847cb86cdcfa5479f8c5651e4b">__attribute__</a><li>Reserved1 </li>
: <a class="el" href="struct____attribute____.html#8849048a8f3f2dea95ff29eac3290ad2">__attribute__</a><li>Reserved2 <li>Reserved0
: <a class="el" href="struct____attribute____.html#aae3264f9e2eabc4244d2f1e30ec33a4">__attribute__</a><li>Reserved3 : <a class="el" href="struct____attribute____.html#ae989b1f9056c0eff058855b81e0452d3">__attribute__</a>
: <a class="el" href="struct____attribute____.html#9241a367cefcfb7119c13e08ac90a241">__attribute__</a><li>Reserved4 </li>
: <a class="el" href="struct____attribute____.html#5aa283a216335c4c4579d8b3bf596253">__attribute__</a><li>Revision <li>Reserved1
: <a class="el" href="struct____attribute____.html#32c676ac5296556c0573a301ef5ab07b">__attribute__</a><li>RowAddrCycles : <a class="el" href="struct____attribute____.html#a83e6f57b75d9e507124e5ab52d4e2c97">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___geometry.html#8045d3ed504a4c7bfbfca92bab087c56">XNandPs_Geometry</a></ul> </li>
<h3><a class="anchor" name="index_s">- s -</a></h3><ul> <li>Reserved2
: <a class="el" href="struct____attribute____.html#ab2aa1e8cc0bea30414fb8c2f46439323">__attribute__</a>
</li>
<li>Reserved3
: <a class="el" href="struct____attribute____.html#a76047dca77080d3976926d6b4480d6e7">__attribute__</a>
</li>
<li>Reserved4
: <a class="el" href="struct____attribute____.html#a26d31e2c37f064de471efd08ad0c1417">__attribute__</a>
</li>
<li>Revision
: <a class="el" href="struct____attribute____.html#a5ae3199072acd3156a8ec9905e5afc43">__attribute__</a>
</li>
<li>RowAddrCycles
: <a class="el" href="struct_x_nand_ps___geometry.html#afd53531e448c5db979a145ba64214cee">XNandPs_Geometry</a>
</li>
</ul>
<h3><a class="anchor" id="index_s">- s -</a></h3><ul>
<li>SigLength <li>SigLength
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#2ad4ddc964b7bae19c896fa6f22d96ba">XNandPs_BbtDesc</a><li>Signature : <a class="el" href="struct_x_nand_ps___bbt_desc.html#a3d91d5bd2b9cb468e2232dbf28339d7f">XNandPs_BbtDesc</a>
: <a class="el" href="struct____attribute____.html#d4e5ab90cd0ecc2ae59b8df05e796cbe">__attribute__</a>, <a class="el" href="struct_x_nand_ps___bbt_desc.html#d4e5ab90cd0ecc2ae59b8df05e796cbe">XNandPs_BbtDesc</a><li>SigOffset </li>
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#42e006846cf0402ee5744cbbbe3548b3">XNandPs_BbtDesc</a><li>SmcBase <li>Signature
: <a class="el" href="struct_x_nand_ps___config.html#5714d78c05a4aa34c14695b45b4e53c2">XNandPs_Config</a><li>SpareBufPtr : <a class="el" href="struct_x_nand_ps___bbt_desc.html#a91b6593abad5f5eeb8e69030110381f4">XNandPs_BbtDesc</a>
: <a class="el" href="struct_x_nand_ps_tag.html#d86271320c7fe920dabe9591a26b2b35">XNandPsTag</a><li>SpareBytesPerPage , <a class="el" href="struct____attribute____.html#a1cd060deb10d798370f555fa08adc42f">__attribute__</a>
: <a class="el" href="struct____attribute____.html#3149a0e83655bbacef7fb906ce503e7c">__attribute__</a>, <a class="el" href="struct_x_nand_ps___geometry.html#3149a0e83655bbacef7fb906ce503e7c">XNandPs_Geometry</a><li>SpareBytesPerPartialPage </li>
: <a class="el" href="struct____attribute____.html#d6f1bf058a0ccdb5c1d500bcd5a4a806">__attribute__</a><li>StartCmd <li>SigOffset
: <a class="el" href="struct_x_nand_ps___command_format.html#965491e2a72c9d387bd99c1c3c0a664b">XNandPs_CommandFormat</a><li>SynFeatures : <a class="el" href="struct_x_nand_ps___bbt_desc.html#aaeafe1d72c4c3c25ef8d81f64cc19370">XNandPs_BbtDesc</a>
: <a class="el" href="struct____attribute____.html#0a62386f4f0495ede35e0b508ed9e549">__attribute__</a><li>SynTimingMode </li>
: <a class="el" href="struct____attribute____.html#edab83dc13c82391cf7b25e59c013816">__attribute__</a></ul> <li>SmcBase
<h3><a class="anchor" name="index_t">- t -</a></h3><ul> : <a class="el" href="struct_x_nand_ps___config.html#a7fb228465433017747bbf8a9bd9601d7">XNandPs_Config</a>
</li>
<li>SpareBufPtr
: <a class="el" href="struct_x_nand_ps_tag.html#a25507ef0fe95e9b0b871e03e65731cba">XNandPsTag</a>
</li>
<li>SpareBytesPerPage
: <a class="el" href="struct____attribute____.html#a0b265523687a2dbc8d88b36ea9aab19f">__attribute__</a>
, <a class="el" href="struct_x_nand_ps___geometry.html#a204fb8075fb5a30f2919280d923e6e25">XNandPs_Geometry</a>
</li>
<li>SpareBytesPerPartialPage
: <a class="el" href="struct____attribute____.html#a2e9900f1d4f10fdc2616a6b9601d73d5">__attribute__</a>
</li>
<li>StartCmd
: <a class="el" href="struct_x_nand_ps___command_format.html#abab8ebd07b5838c58667294329488788">XNandPs_CommandFormat</a>
</li>
<li>SynFeatures
: <a class="el" href="struct____attribute____.html#a6b9677be4e5173320c812c2fd92e5c93">__attribute__</a>
</li>
<li>SynTimingMode
: <a class="el" href="struct____attribute____.html#abcfcfd60500ac0c80152c0c610ad9f38">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_t">- t -</a></h3><ul>
<li>TAdl <li>TAdl
: <a class="el" href="struct____attribute____.html#655b640db578165c755d45e3ab1f0a4f">__attribute__</a><li>TBers : <a class="el" href="struct____attribute____.html#aed6c77972ad2394ba6371b5568030683">__attribute__</a>
: <a class="el" href="struct____attribute____.html#cdb5cd34282dcb84a65ea4c129aa2e1c">__attribute__</a><li>TCcs </li>
: <a class="el" href="struct____attribute____.html#d050bc780fbb441cfccba2bd4e69b7b0">__attribute__</a><li>TEr <li>TBers
: <a class="el" href="struct____attribute____.html#42f03939f90b7ed8967c313db5a078ad">__attribute__</a><li>TimingMode : <a class="el" href="struct____attribute____.html#af64b0e7bdce25c2944d135a142526a5b">__attribute__</a>
: <a class="el" href="struct____attribute____.html#48824e0b1473f704d048423478032327">__attribute__</a><li>TMr </li>
: <a class="el" href="struct____attribute____.html#cd5d8d78fc80e71dda7fe4d014cdaefd">__attribute__</a><li>TotalBytes <li>TCcs
: <a class="el" href="struct_x_nand_ps___ecc_config.html#703b69708c417c0898b225b995d4e1d0">XNandPs_EccConfig</a><li>TProg : <a class="el" href="struct____attribute____.html#a96987ab855b89ccf5db4591c8a72d7a7">__attribute__</a>
: <a class="el" href="struct____attribute____.html#d93bdd1eced83ba52f77bf03bbc6fb93">__attribute__</a><li>TR </li>
: <a class="el" href="struct____attribute____.html#ebe021079e5a3c4f42ca6119eab92633">__attribute__</a></ul> <li>TEr
<h3><a class="anchor" name="index_v">- v -</a></h3><ul> : <a class="el" href="struct____attribute____.html#a9f4a9983edb5d64443b73164445af364">__attribute__</a>
</li>
<li>TimingMode
: <a class="el" href="struct____attribute____.html#a1b0c4c0a0f1785b762058ae52de0fbad">__attribute__</a>
</li>
<li>TMr
: <a class="el" href="struct____attribute____.html#acd50923d29bb030b12ac8bf097f2c942">__attribute__</a>
</li>
<li>TotalBytes
: <a class="el" href="struct_x_nand_ps___ecc_config.html#af197dcee444dcc8849dba90b29308559">XNandPs_EccConfig</a>
</li>
<li>TProg
: <a class="el" href="struct____attribute____.html#aed945fe658be1350d16d0814253eb263">__attribute__</a>
</li>
<li>TR
: <a class="el" href="struct____attribute____.html#a83d29b11f7a3f746c19431dc789edbf2">__attribute__</a>
</li>
</ul>
<h3><a class="anchor" id="index_v">- v -</a></h3><ul>
<li>Valid <li>Valid
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#3ac705f2acd51a4613f9188c05c91d0d">XNandPs_BbtDesc</a><li>VendorRevisionNum : <a class="el" href="struct_x_nand_ps___bbt_desc.html#a08bf6a3876905cc8cd8fb858a29faea4">XNandPs_BbtDesc</a>
: <a class="el" href="struct____attribute____.html#89e46d5f790a21d68cf4e0a1d1dab011">__attribute__</a><li>VendorSpecific </li>
: <a class="el" href="struct____attribute____.html#b2e9a938dd1ea610ee9e9f30723a3a7d">__attribute__</a><li>VerOffset <li>VendorRevisionNum
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#b39b437ad34324a0a55b243fd6d037dd">XNandPs_BbtDesc</a><li>Version : <a class="el" href="struct____attribute____.html#a8bfb9abf5bf7e99135d5b9ba74af74be">__attribute__</a>
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#34b6cd75171affba6957e308dcbd92be">XNandPs_BbtDesc</a></ul> </li>
<h3><a class="anchor" name="index_w">- w -</a></h3><ul> <li>VendorSpecific
: <a class="el" href="struct____attribute____.html#a91f9605e84444cb08769bbd04bc0984f">__attribute__</a>
</li>
<li>VerOffset
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#afa8974f0829f8e1f72b6df0ab31002d5">XNandPs_BbtDesc</a>
</li>
<li>Version
: <a class="el" href="struct_x_nand_ps___bbt_desc.html#a894c8610ffe5a988185cb7e3dbdd0cf9">XNandPs_BbtDesc</a>
</li>
</ul>
<h3><a class="anchor" id="index_w">- w -</a></h3><ul>
<li>WritePage <li>WritePage
: <a class="el" href="struct_x_nand_ps_tag.html#65c824de6a5d137a1b4fe7b8586e2d03">XNandPsTag</a></ul> : <a class="el" href="struct_x_nand_ps_tag.html#a8d00d94fd28aadf317edc5fa9e4e0e38">XNandPsTag</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

101
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals.html
View file

@ -2,53 +2,68 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_b">- b -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_b">- b -</a></h3><ul>
<li>BBM_H
: <a class="el" href="xnandps__bbm_8h.html#a6ed742001748dc3dce1411716660b1e3">xnandps_bbm.h</a>
</li>
<li>BLOCK_ERASE <li>BLOCK_ERASE
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56d7c55553331c6b152df6e49eb418d0e4">xnandps_onfi.h</a></ul> : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a07c1d6a795c348f8633600a052d26dfd">xnandps_onfi.h</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

102
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_0x63.html
View file

@ -2,54 +2,68 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li id="current"><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_c">- c -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li class="current"><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_c">- c -</a></h3><ul>
<li>CHANGE_READ_COLUMN <li>CHANGE_READ_COLUMN
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56a6d12b9db1b9c74776a370b15fd4f4bc">xnandps_onfi.h</a><li>CHANGE_WRITE_COLUMN : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a93048e7702ea73781e031c18191f6aec">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56196eb21e32a58088bd0421ec5b4db361">xnandps_onfi.h</a></ul> </li>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <li>CHANGE_WRITE_COLUMN
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a7b8cd11c9f3d97de2d293b68927899d6">xnandps_onfi.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

98
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_0x67.html
View file

@ -2,53 +2,65 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li id="current"><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_g">- g -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li class="current"><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_g">- g -</a></h3><ul>
<li>GET_FEATURES <li>GET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c5606684bf154dabdcae09ce5cd3d58c1a5">xnandps_onfi.h</a></ul> : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a9bf6ffa4f6227023e81c1b4ebd1ae5a1">xnandps_onfi.h</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

106
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_0x6e.html
View file

@ -2,55 +2,71 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li id="current"><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_n">- n -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li class="current"><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_n">- n -</a></h3><ul>
<li>NandOob16 <li>NandOob16
: <a class="el" href="xnandps_8c.html#469ff8705a5ab8659ff0ee64c950073d">xnandps.c</a><li>NandOob32 : <a class="el" href="xnandps_8c.html#ae980af68044391bcf0c94bd2b35c910b">xnandps.c</a>
: <a class="el" href="xnandps_8c.html#a8fc6bf2121a9ae287b24d102061a281">xnandps.c</a><li>NandOob64 </li>
: <a class="el" href="xnandps_8c.html#f9b371cb37400b34363fa1a0a56a205e">xnandps.c</a></ul> <li>NandOob32
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. : <a class="el" href="xnandps_8c.html#ad8d144dd94afdb026486d7b34e6c58f1">xnandps.c</a>
</li>
<li>NandOob64
: <a class="el" href="xnandps_8c.html#aed173a3e7bda0d3a84e8f7d55aa4e81d">xnandps.c</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

287
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_0x6f.html
View file

@ -2,98 +2,209 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li id="current"><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_o">- o -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li class="current"><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_o">- o -</a></h3><ul>
<li>OneHot
: <a class="el" href="xnandps_8h.html#a34f4ef3f29daef5f33c6fef869b44e20">xnandps.h</a>
</li>
<li>ONFI_CMD_BLOCK_ERASE1 <li>ONFI_CMD_BLOCK_ERASE1
: <a class="el" href="xnandps__onfi_8h.html#ed455cc29ea5b20556195a8602d453ae">xnandps_onfi.h</a><li>ONFI_CMD_BLOCK_ERASE2 : <a class="el" href="xnandps__onfi_8h.html#a55dfb210683392ea30b195809ed4cbc5">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#cecab65793c9bfbad0408f1e933acfd1">xnandps_onfi.h</a><li>ONFI_CMD_BLOCK_ERASE_INTERLEAVED2 </li>
: <a class="el" href="xnandps__onfi_8h.html#d11be9cd49b03b4240cdb1bc9118f9bb">xnandps_onfi.h</a><li>ONFI_CMD_CHANGE_READ_COLUMN1 <li>ONFI_CMD_BLOCK_ERASE2
: <a class="el" href="xnandps__onfi_8h.html#a23b36953f40626296da1b9ab4959420">xnandps_onfi.h</a><li>ONFI_CMD_CHANGE_READ_COLUMN2 : <a class="el" href="xnandps__onfi_8h.html#ab86024a23180c0b1b88a78435232a6ef">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#711db19ae5c3bd7d4614f550c437a3b4">xnandps_onfi.h</a><li>ONFI_CMD_CHANGE_WRITE_COLUMN </li>
: <a class="el" href="xnandps__onfi_8h.html#b3e709ea4230d55d64a5201c96841146">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_PROGRAM1 <li>ONFI_CMD_BLOCK_ERASE_INTERLEAVED2
: <a class="el" href="xnandps__onfi_8h.html#d322b94c2036e89c0327188af6ccb9c2">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_PROGRAM2 : <a class="el" href="xnandps__onfi_8h.html#a5c37b601c4985f107409b385b02fc76f">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#bca7ed308d5a4da22bb87892c0a8893a">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_PROGRAM_INTERLEAVED2 </li>
: <a class="el" href="xnandps__onfi_8h.html#935c84c694ef6208b0f68985e8b3b0ee">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_READ1 <li>ONFI_CMD_CHANGE_READ_COLUMN1
: <a class="el" href="xnandps__onfi_8h.html#57e5408b541c9aea056c1d324280a1e7">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_READ2 : <a class="el" href="xnandps__onfi_8h.html#a2ed529448055585d56229d1371be0c0c">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#c00c28eeed20d0f780df044e3914b051">xnandps_onfi.h</a><li>ONFI_CMD_GET_FEATURES </li>
: <a class="el" href="xnandps__onfi_8h.html#00415f6b521b863faf841ee3face149a">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_CACHE_PROGRAM1 <li>ONFI_CMD_CHANGE_READ_COLUMN2
: <a class="el" href="xnandps__onfi_8h.html#e452ce37dbacecfb4000c77cd892d2f0">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_CACHE_PROGRAM2 : <a class="el" href="xnandps__onfi_8h.html#ab3332307f2dd066c0fafb7e5fd0ff7cb">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#6764e8b39f53df83622e331be510e359">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_PROG1 </li>
: <a class="el" href="xnandps__onfi_8h.html#359de76e5688863b23ca513d646c43aa">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_PROG2 <li>ONFI_CMD_CHANGE_WRITE_COLUMN
: <a class="el" href="xnandps__onfi_8h.html#861f7542a3c91cd2488ce827ad380515">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_PROGRAM_INTERLEAVED2 : <a class="el" href="xnandps__onfi_8h.html#a406d827603b7651b9278b3d366f9f0bf">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#c038b1c24f20311ba972df4415d08aaf">xnandps_onfi.h</a><li>ONFI_CMD_READ1 </li>
: <a class="el" href="xnandps__onfi_8h.html#9ba3d0494fa3133dc99df2800443b60e">xnandps_onfi.h</a><li>ONFI_CMD_READ2 <li>ONFI_CMD_COPYBACK_PROGRAM1
: <a class="el" href="xnandps__onfi_8h.html#ea0d17f2213b5f48c5c423c831cd039f">xnandps_onfi.h</a><li>ONFI_CMD_READ_CACHE : <a class="el" href="xnandps__onfi_8h.html#aa4f87be5dcf3bfe6888bacd2aa9d6171">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#32244477b6b7b6fe53fb0457ef5273c6">xnandps_onfi.h</a><li>ONFI_CMD_READ_CACHE_END </li>
: <a class="el" href="xnandps__onfi_8h.html#48112031149317cf6240d9e6086aa9e2">xnandps_onfi.h</a><li>ONFI_CMD_READ_CACHE_ENHANCED1 <li>ONFI_CMD_COPYBACK_PROGRAM2
: <a class="el" href="xnandps__onfi_8h.html#958b021498a5174eaa1f3b19f93381d8">xnandps_onfi.h</a><li>ONFI_CMD_READ_CACHE_ENHANCED2 : <a class="el" href="xnandps__onfi_8h.html#abda4e370276ed939e8f3330521a4c0c2">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#901163fabbd1cff1fa22999e684ec2b2">xnandps_onfi.h</a><li>ONFI_CMD_READ_ID </li>
: <a class="el" href="xnandps__onfi_8h.html#0f7f8263b2205d353e9b5c0b9c171a92">xnandps_onfi.h</a><li>ONFI_CMD_READ_PARAM_PAGE <li>ONFI_CMD_COPYBACK_PROGRAM_INTERLEAVED2
: <a class="el" href="xnandps__onfi_8h.html#a65f4a0a2bcd4f9dd6035b791634217f">xnandps_onfi.h</a><li>ONFI_CMD_READ_STATUS : <a class="el" href="xnandps__onfi_8h.html#a3b8aeb82674a020fcb3b856c3fdc8512">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#722543eda8df162b86f62f3376a0b276">xnandps_onfi.h</a><li>ONFI_CMD_READ_STATUS_ENHANCED </li>
: <a class="el" href="xnandps__onfi_8h.html#479fe7ed96608dfd1878c53574630d7a">xnandps_onfi.h</a><li>ONFI_CMD_READ_UNIQUEID <li>ONFI_CMD_COPYBACK_READ1
: <a class="el" href="xnandps__onfi_8h.html#cd3069d815e077878d8247acc23ccee2">xnandps_onfi.h</a><li>ONFI_CMD_RESET : <a class="el" href="xnandps__onfi_8h.html#ab10d24b1d6521d5bd855c7edec68cfad">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#810a1f8e2d878ddc20923cb97a3507c0">xnandps_onfi.h</a><li>ONFI_CMD_SET_FEATURES </li>
: <a class="el" href="xnandps__onfi_8h.html#72ee2575a9b1d89ea10190dba1cdac01">xnandps_onfi.h</a><li>Onfi_CmdReadStatus() <li>ONFI_CMD_COPYBACK_READ2
: <a class="el" href="xnandps__onfi_8c.html#242826f09f6d9cab1ab85ddf5b1419ab">xnandps_onfi.c</a>, <a class="el" href="xnandps_8c.html#242826f09f6d9cab1ab85ddf5b1419ab">xnandps.c</a><li>ONFI_CRC_INIT : <a class="el" href="xnandps__onfi_8h.html#a3f9e4b16df796e9fa5d09c1aeb689257">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#1ac4a9741368c95b2c7be6f324c38565">xnandps_onfi.h</a><li>ONFI_CRC_LEN </li>
: <a class="el" href="xnandps__onfi_8h.html#1a8d8bc2a46976c9b657e5eb62f2f714">xnandps_onfi.h</a><li>ONFI_CRC_ORDER <li>ONFI_CMD_GET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#8a6a0099fec8d4723056e4dbc32fa5fd">xnandps_onfi.h</a><li>ONFI_CRC_POLYNOM : <a class="el" href="xnandps__onfi_8h.html#adbf8afcdec47ffb5e24a9e2f580bc9e4">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#13847a28fdfb55345cc20dcef4fc61c9">xnandps_onfi.h</a><li>ONFI_ID_LEN </li>
: <a class="el" href="xnandps__onfi_8h.html#8975ba6aad69881c397426af2fbd1eed">xnandps_onfi.h</a><li>Onfi_NandInit() <li>ONFI_CMD_PAGE_CACHE_PROGRAM1
: <a class="el" href="xnandps__onfi_8c.html#71eb008eeb4b6c3b04c7889be9ef7828">xnandps_onfi.c</a>, <a class="el" href="xnandps_8c.html#71eb008eeb4b6c3b04c7889be9ef7828">xnandps.c</a><li>ONFI_PARAM_PAGE_LEN : <a class="el" href="xnandps__onfi_8h.html#a65c3a1712dbf6b78ac8fdd26f2ad4955">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#19d22049571c25b7527f551930ee90fe">xnandps_onfi.h</a><li>ONFI_SIGNATURE_LEN </li>
: <a class="el" href="xnandps__onfi_8h.html#9f1699fd85ee8d11946542c8e45f6879">xnandps_onfi.h</a><li>ONFI_STATUS_ARDY <li>ONFI_CMD_PAGE_CACHE_PROGRAM2
: <a class="el" href="xnandps__onfi_8h.html#e29164110cf75f2841a074c479c794ec">xnandps_onfi.h</a><li>ONFI_STATUS_FAIL : <a class="el" href="xnandps__onfi_8h.html#a32f44a4cba105e5588e636f6294b0f9d">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#4a7f2bf8dff894a53bf5d035ebda2c05">xnandps_onfi.h</a><li>ONFI_STATUS_FAILC </li>
: <a class="el" href="xnandps__onfi_8h.html#56797578167ce3185c058af4bf1d9b6b">xnandps_onfi.h</a><li>ONFI_STATUS_RDY <li>ONFI_CMD_PAGE_PROG1
: <a class="el" href="xnandps__onfi_8h.html#590f40931f958b7401919eab1f78e618">xnandps_onfi.h</a><li>ONFI_STATUS_WP : <a class="el" href="xnandps__onfi_8h.html#a3d0794886aabbc021e8e0f85ef9893a1">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#397cc6b858ab34d6975d472cd335ab28">xnandps_onfi.h</a><li>OnfiCommands </li>
: <a class="el" href="xnandps__onfi_8c.html#4175177d9f5cd255ff1e01f384129261">xnandps_onfi.c</a>, <a class="el" href="xnandps_8c.html#4175177d9f5cd255ff1e01f384129261">xnandps.c</a><li>OnfiCommandsEnum <li>ONFI_CMD_PAGE_PROG2
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56">xnandps_onfi.h</a></ul> : <a class="el" href="xnandps__onfi_8h.html#a3cfb6dc76ae159236b1426557f3529fb">xnandps_onfi.h</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
<li>ONFI_CMD_PAGE_PROGRAM_INTERLEAVED2
: <a class="el" href="xnandps__onfi_8h.html#a2d9b167f04107587fb8ba499179c82fd">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ1
: <a class="el" href="xnandps__onfi_8h.html#a58126625dc0ff8e6d1866433ab9342d1">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ2
: <a class="el" href="xnandps__onfi_8h.html#ab53c251758d5fd3705eee1a9337abef8">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_CACHE
: <a class="el" href="xnandps__onfi_8h.html#af2935a27b9769e1684978ba4ba96ec23">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_CACHE_END
: <a class="el" href="xnandps__onfi_8h.html#a2fc255623dd81fd29cebff096e20444d">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_CACHE_ENHANCED1
: <a class="el" href="xnandps__onfi_8h.html#a1c5c8ebf4ecb5594f01444d358048c25">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_CACHE_ENHANCED2
: <a class="el" href="xnandps__onfi_8h.html#a636d60b79e0600b0c493904f1af19360">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_ID
: <a class="el" href="xnandps__onfi_8h.html#a7a3e3490f4a700f719f343781111ddb5">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_PARAM_PAGE
: <a class="el" href="xnandps__onfi_8h.html#aeabd8cba36043b481813f654e440637e">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_STATUS
: <a class="el" href="xnandps__onfi_8h.html#acc38d697c4911db817bec7cf3e025938">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_STATUS_ENHANCED
: <a class="el" href="xnandps__onfi_8h.html#aed4869952de35132eafa69c63673addb">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_UNIQUEID
: <a class="el" href="xnandps__onfi_8h.html#a1a90e233b57cb3bc0ef3a5fc315e158f">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_RESET
: <a class="el" href="xnandps__onfi_8h.html#af2876620cfd13144b4779bf7b4a5aefe">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_SET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#a09a77a047f11adfcb8b2b226bd674adf">xnandps_onfi.h</a>
</li>
<li>Onfi_CmdReadStatus()
: <a class="el" href="xnandps_8c.html#a7f3a46694f4b3c4baffca71e6fcfebab">xnandps.c</a>
, <a class="el" href="xnandps__onfi_8c.html#a7f3a46694f4b3c4baffca71e6fcfebab">xnandps_onfi.c</a>
</li>
<li>ONFI_CRC_INIT
: <a class="el" href="xnandps__onfi_8h.html#a95404175c5c6bfeb8a98aaef9bbc551e">xnandps_onfi.h</a>
</li>
<li>ONFI_CRC_LEN
: <a class="el" href="xnandps__onfi_8h.html#a227f8d8d7d2de58dd0b2d6da3006f03e">xnandps_onfi.h</a>
</li>
<li>ONFI_CRC_ORDER
: <a class="el" href="xnandps__onfi_8h.html#ade881bc5d3ed11d19ee0af0d25e84bc0">xnandps_onfi.h</a>
</li>
<li>ONFI_CRC_POLYNOM
: <a class="el" href="xnandps__onfi_8h.html#ad5f5c897b5d63054909a7f2e7311e991">xnandps_onfi.h</a>
</li>
<li>ONFI_H
: <a class="el" href="xnandps__onfi_8h.html#a8be4d072376f082bf5ae08776da5b773">xnandps_onfi.h</a>
</li>
<li>ONFI_ID_LEN
: <a class="el" href="xnandps__onfi_8h.html#a27d88d8a093bb990046ae13730aa935e">xnandps_onfi.h</a>
</li>
<li>Onfi_NandInit()
: <a class="el" href="xnandps_8c.html#acb42515d1fa541b8ac5e785d1fb7eefd">xnandps.c</a>
, <a class="el" href="xnandps__onfi_8c.html#acb42515d1fa541b8ac5e785d1fb7eefd">xnandps_onfi.c</a>
</li>
<li>ONFI_PARAM_PAGE_LEN
: <a class="el" href="xnandps__onfi_8h.html#a8934224be62b66baa973637dd3fd4816">xnandps_onfi.h</a>
</li>
<li>ONFI_SIGNATURE_LEN
: <a class="el" href="xnandps__onfi_8h.html#a68423a0be6b6a1956b7e93fef5e50e00">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_ARDY
: <a class="el" href="xnandps__onfi_8h.html#a381ed334372bb02695d812e44ba58081">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_FAIL
: <a class="el" href="xnandps__onfi_8h.html#a44013e5fb725c1b3233359b2fb14a4d3">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_FAILC
: <a class="el" href="xnandps__onfi_8h.html#a0fffa352f5726c9d18effcd83ce7061e">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_RDY
: <a class="el" href="xnandps__onfi_8h.html#a33dc5a0d5a0593c5a2654b16ff49b38a">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_WP
: <a class="el" href="xnandps__onfi_8h.html#a8be0ae53753ead584ac71c2898d5d9e3">xnandps_onfi.h</a>
</li>
<li>OnfiCommands
: <a class="el" href="xnandps__onfi_8c.html#a6256f01deb0ca40af90a3b6ceb0aef94">xnandps_onfi.c</a>
, <a class="el" href="xnandps_8c.html#a6256f01deb0ca40af90a3b6ceb0aef94">xnandps.c</a>
</li>
<li>OnfiCommandsEnum
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975">xnandps_onfi.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

102
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_0x70.html
View file

@ -2,54 +2,68 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li id="current"><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_p">- p -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li class="current"><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_p">- p -</a></h3><ul>
<li>PAGE_CACHE_PROGRAM <li>PAGE_CACHE_PROGRAM
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c569b0b1157ee22f649e542d79194b0d073">xnandps_onfi.h</a><li>PAGE_PROGRAM : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a917fd89fc6851edcf198f44f133ddf3a">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56321de2ada4dccff8c112605f1514879c">xnandps_onfi.h</a></ul> </li>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <li>PAGE_PROGRAM
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975abe9758bc5df677605dcc22e1557c853a">xnandps_onfi.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

122
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_0x72.html
View file

@ -2,59 +2,83 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li id="current"><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_r">- r -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li class="current"><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_r">- r -</a></h3><ul>
<li>READ <li>READ
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c563466fab4975481651940ed328aa990e4">xnandps_onfi.h</a><li>READ_CACHE_END_SEQ : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975acb9be765f361bb7efb9073730aac92c6">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c565ec2b6b46ce0a4a2cd568fe8bbdeb6a3">xnandps_onfi.h</a><li>READ_CACHE_RANDOM </li>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56f0324cffdb895bb88f99790f831ee637">xnandps_onfi.h</a><li>READ_ID <li>READ_CACHE_END_SEQ
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56df8176c224240e5ddff37983de70b5d3">xnandps_onfi.h</a><li>READ_PARAM_PAGE : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975afb1d5bd781a173ff53cb79de689b1469">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56aab1ca5f082d40fbfc553c3ebc9b11ac">xnandps_onfi.h</a><li>READ_STATUS </li>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56bbb3f26b8634d11762540fcf96e99902">xnandps_onfi.h</a><li>RESET <li>READ_CACHE_RANDOM
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56b5859d8721cfdc0312b2838b9c985bc1">xnandps_onfi.h</a></ul> : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a8b269d64de6c130671c1413fd0f2bbb2">xnandps_onfi.h</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
<li>READ_ID
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a08d1641fdf7c1a20c4f1563f57d958e8">xnandps_onfi.h</a>
</li>
<li>READ_PARAM_PAGE
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a1589226dbb8a8f0493a8a6df64943518">xnandps_onfi.h</a>
</li>
<li>READ_STATUS
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a451fb3a060f895e40024da81e03fe45a">xnandps_onfi.h</a>
</li>
<li>RESET
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a589b7d94a3d91d145720e2fed0eb3a05">xnandps_onfi.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

98
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_0x73.html
View file

@ -2,53 +2,65 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li id="current"><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- Generated by Doxygen 1.6.1 -->
Here is a list of all documented file members with links to the documentation: <div class="navigation" id="top">
<p> <div class="tabs">
<h3><a class="anchor" name="index_s">- s -</a></h3><ul> <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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html#index_b"><span>b</span></a></li>
<li><a href="globals_0x63.html#index_c"><span>c</span></a></li>
<li><a href="globals_0x67.html#index_g"><span>g</span></a></li>
<li><a href="globals_0x6e.html#index_n"><span>n</span></a></li>
<li><a href="globals_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_0x70.html#index_p"><span>p</span></a></li>
<li><a href="globals_0x72.html#index_r"><span>r</span></a></li>
<li class="current"><a href="globals_0x73.html#index_s"><span>s</span></a></li>
<li><a href="globals_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_s">- s -</a></h3><ul>
<li>SET_FEATURES <li>SET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56483ba48ef7851c1f5e356302d5eb4640">xnandps_onfi.h</a></ul> : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a4dbe92307b1ecfc6eb4dfb3ee1f59cb7">xnandps_onfi.h</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

1150
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_0x78.html
View file

File diff suppressed because it is too large Load diff

127
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_defs.html
View file

@ -2,87 +2,60 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<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 id="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 id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li id="current"><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li id="current"><a href="globals_defs.html#index_o"><span>o</span></a></li>
<li><a href="globals_defs_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
<p> <!-- 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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li class="current"><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals_defs.html#index_b"><span>b</span></a></li>
<li><a href="globals_defs_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_defs_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp; &nbsp;
<p>
<h3><a class="anchor" name="index_o">- o -</a></h3><ul> <h3><a class="anchor" id="index_b">- b -</a></h3><ul>
<li>ONFI_CMD_BLOCK_ERASE1 <li>BBM_H
: <a class="el" href="xnandps__onfi_8h.html#ed455cc29ea5b20556195a8602d453ae">xnandps_onfi.h</a><li>ONFI_CMD_BLOCK_ERASE2 : <a class="el" href="xnandps__bbm_8h.html#a6ed742001748dc3dce1411716660b1e3">xnandps_bbm.h</a>
: <a class="el" href="xnandps__onfi_8h.html#cecab65793c9bfbad0408f1e933acfd1">xnandps_onfi.h</a><li>ONFI_CMD_BLOCK_ERASE_INTERLEAVED2 </li>
: <a class="el" href="xnandps__onfi_8h.html#d11be9cd49b03b4240cdb1bc9118f9bb">xnandps_onfi.h</a><li>ONFI_CMD_CHANGE_READ_COLUMN1 </ul>
: <a class="el" href="xnandps__onfi_8h.html#a23b36953f40626296da1b9ab4959420">xnandps_onfi.h</a><li>ONFI_CMD_CHANGE_READ_COLUMN2 </div>
: <a class="el" href="xnandps__onfi_8h.html#711db19ae5c3bd7d4614f550c437a3b4">xnandps_onfi.h</a><li>ONFI_CMD_CHANGE_WRITE_COLUMN <p class="Copyright">
: <a class="el" href="xnandps__onfi_8h.html#b3e709ea4230d55d64a5201c96841146">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_PROGRAM1 Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
: <a class="el" href="xnandps__onfi_8h.html#d322b94c2036e89c0327188af6ccb9c2">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_PROGRAM2 </p>
: <a class="el" href="xnandps__onfi_8h.html#bca7ed308d5a4da22bb87892c0a8893a">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_PROGRAM_INTERLEAVED2 </body>
: <a class="el" href="xnandps__onfi_8h.html#935c84c694ef6208b0f68985e8b3b0ee">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_READ1 </html>
: <a class="el" href="xnandps__onfi_8h.html#57e5408b541c9aea056c1d324280a1e7">xnandps_onfi.h</a><li>ONFI_CMD_COPYBACK_READ2
: <a class="el" href="xnandps__onfi_8h.html#c00c28eeed20d0f780df044e3914b051">xnandps_onfi.h</a><li>ONFI_CMD_GET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#00415f6b521b863faf841ee3face149a">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_CACHE_PROGRAM1
: <a class="el" href="xnandps__onfi_8h.html#e452ce37dbacecfb4000c77cd892d2f0">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_CACHE_PROGRAM2
: <a class="el" href="xnandps__onfi_8h.html#6764e8b39f53df83622e331be510e359">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_PROG1
: <a class="el" href="xnandps__onfi_8h.html#359de76e5688863b23ca513d646c43aa">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_PROG2
: <a class="el" href="xnandps__onfi_8h.html#861f7542a3c91cd2488ce827ad380515">xnandps_onfi.h</a><li>ONFI_CMD_PAGE_PROGRAM_INTERLEAVED2
: <a class="el" href="xnandps__onfi_8h.html#c038b1c24f20311ba972df4415d08aaf">xnandps_onfi.h</a><li>ONFI_CMD_READ1
: <a class="el" href="xnandps__onfi_8h.html#9ba3d0494fa3133dc99df2800443b60e">xnandps_onfi.h</a><li>ONFI_CMD_READ2
: <a class="el" href="xnandps__onfi_8h.html#ea0d17f2213b5f48c5c423c831cd039f">xnandps_onfi.h</a><li>ONFI_CMD_READ_CACHE
: <a class="el" href="xnandps__onfi_8h.html#32244477b6b7b6fe53fb0457ef5273c6">xnandps_onfi.h</a><li>ONFI_CMD_READ_CACHE_END
: <a class="el" href="xnandps__onfi_8h.html#48112031149317cf6240d9e6086aa9e2">xnandps_onfi.h</a><li>ONFI_CMD_READ_CACHE_ENHANCED1
: <a class="el" href="xnandps__onfi_8h.html#958b021498a5174eaa1f3b19f93381d8">xnandps_onfi.h</a><li>ONFI_CMD_READ_CACHE_ENHANCED2
: <a class="el" href="xnandps__onfi_8h.html#901163fabbd1cff1fa22999e684ec2b2">xnandps_onfi.h</a><li>ONFI_CMD_READ_ID
: <a class="el" href="xnandps__onfi_8h.html#0f7f8263b2205d353e9b5c0b9c171a92">xnandps_onfi.h</a><li>ONFI_CMD_READ_PARAM_PAGE
: <a class="el" href="xnandps__onfi_8h.html#a65f4a0a2bcd4f9dd6035b791634217f">xnandps_onfi.h</a><li>ONFI_CMD_READ_STATUS
: <a class="el" href="xnandps__onfi_8h.html#722543eda8df162b86f62f3376a0b276">xnandps_onfi.h</a><li>ONFI_CMD_READ_STATUS_ENHANCED
: <a class="el" href="xnandps__onfi_8h.html#479fe7ed96608dfd1878c53574630d7a">xnandps_onfi.h</a><li>ONFI_CMD_READ_UNIQUEID
: <a class="el" href="xnandps__onfi_8h.html#cd3069d815e077878d8247acc23ccee2">xnandps_onfi.h</a><li>ONFI_CMD_RESET
: <a class="el" href="xnandps__onfi_8h.html#810a1f8e2d878ddc20923cb97a3507c0">xnandps_onfi.h</a><li>ONFI_CMD_SET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#72ee2575a9b1d89ea10190dba1cdac01">xnandps_onfi.h</a><li>ONFI_CRC_INIT
: <a class="el" href="xnandps__onfi_8h.html#1ac4a9741368c95b2c7be6f324c38565">xnandps_onfi.h</a><li>ONFI_CRC_LEN
: <a class="el" href="xnandps__onfi_8h.html#1a8d8bc2a46976c9b657e5eb62f2f714">xnandps_onfi.h</a><li>ONFI_CRC_ORDER
: <a class="el" href="xnandps__onfi_8h.html#8a6a0099fec8d4723056e4dbc32fa5fd">xnandps_onfi.h</a><li>ONFI_CRC_POLYNOM
: <a class="el" href="xnandps__onfi_8h.html#13847a28fdfb55345cc20dcef4fc61c9">xnandps_onfi.h</a><li>ONFI_ID_LEN
: <a class="el" href="xnandps__onfi_8h.html#8975ba6aad69881c397426af2fbd1eed">xnandps_onfi.h</a><li>ONFI_PARAM_PAGE_LEN
: <a class="el" href="xnandps__onfi_8h.html#19d22049571c25b7527f551930ee90fe">xnandps_onfi.h</a><li>ONFI_SIGNATURE_LEN
: <a class="el" href="xnandps__onfi_8h.html#9f1699fd85ee8d11946542c8e45f6879">xnandps_onfi.h</a><li>ONFI_STATUS_ARDY
: <a class="el" href="xnandps__onfi_8h.html#e29164110cf75f2841a074c479c794ec">xnandps_onfi.h</a><li>ONFI_STATUS_FAIL
: <a class="el" href="xnandps__onfi_8h.html#4a7f2bf8dff894a53bf5d035ebda2c05">xnandps_onfi.h</a><li>ONFI_STATUS_FAILC
: <a class="el" href="xnandps__onfi_8h.html#56797578167ce3185c058af4bf1d9b6b">xnandps_onfi.h</a><li>ONFI_STATUS_RDY
: <a class="el" href="xnandps__onfi_8h.html#590f40931f958b7401919eab1f78e618">xnandps_onfi.h</a><li>ONFI_STATUS_WP
: <a class="el" href="xnandps__onfi_8h.html#397cc6b858ab34d6975d472cd335ab28">xnandps_onfi.h</a></ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

189
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_defs_0x6f.html Executable file
View file

@ -0,0 +1,189 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver nandps v2_1: Class Members
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li class="current"><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals_defs.html#index_b"><span>b</span></a></li>
<li class="current"><a href="globals_defs_0x6f.html#index_o"><span>o</span></a></li>
<li><a href="globals_defs_0x78.html#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp;
<h3><a class="anchor" id="index_o">- o -</a></h3><ul>
<li>OneHot
: <a class="el" href="xnandps_8h.html#a34f4ef3f29daef5f33c6fef869b44e20">xnandps.h</a>
</li>
<li>ONFI_CMD_BLOCK_ERASE1
: <a class="el" href="xnandps__onfi_8h.html#a55dfb210683392ea30b195809ed4cbc5">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_BLOCK_ERASE2
: <a class="el" href="xnandps__onfi_8h.html#ab86024a23180c0b1b88a78435232a6ef">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_BLOCK_ERASE_INTERLEAVED2
: <a class="el" href="xnandps__onfi_8h.html#a5c37b601c4985f107409b385b02fc76f">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_CHANGE_READ_COLUMN1
: <a class="el" href="xnandps__onfi_8h.html#a2ed529448055585d56229d1371be0c0c">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_CHANGE_READ_COLUMN2
: <a class="el" href="xnandps__onfi_8h.html#ab3332307f2dd066c0fafb7e5fd0ff7cb">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_CHANGE_WRITE_COLUMN
: <a class="el" href="xnandps__onfi_8h.html#a406d827603b7651b9278b3d366f9f0bf">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_COPYBACK_PROGRAM1
: <a class="el" href="xnandps__onfi_8h.html#aa4f87be5dcf3bfe6888bacd2aa9d6171">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_COPYBACK_PROGRAM2
: <a class="el" href="xnandps__onfi_8h.html#abda4e370276ed939e8f3330521a4c0c2">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_COPYBACK_PROGRAM_INTERLEAVED2
: <a class="el" href="xnandps__onfi_8h.html#a3b8aeb82674a020fcb3b856c3fdc8512">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_COPYBACK_READ1
: <a class="el" href="xnandps__onfi_8h.html#ab10d24b1d6521d5bd855c7edec68cfad">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_COPYBACK_READ2
: <a class="el" href="xnandps__onfi_8h.html#a3f9e4b16df796e9fa5d09c1aeb689257">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_GET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#adbf8afcdec47ffb5e24a9e2f580bc9e4">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_PAGE_CACHE_PROGRAM1
: <a class="el" href="xnandps__onfi_8h.html#a65c3a1712dbf6b78ac8fdd26f2ad4955">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_PAGE_CACHE_PROGRAM2
: <a class="el" href="xnandps__onfi_8h.html#a32f44a4cba105e5588e636f6294b0f9d">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_PAGE_PROG1
: <a class="el" href="xnandps__onfi_8h.html#a3d0794886aabbc021e8e0f85ef9893a1">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_PAGE_PROG2
: <a class="el" href="xnandps__onfi_8h.html#a3cfb6dc76ae159236b1426557f3529fb">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_PAGE_PROGRAM_INTERLEAVED2
: <a class="el" href="xnandps__onfi_8h.html#a2d9b167f04107587fb8ba499179c82fd">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ1
: <a class="el" href="xnandps__onfi_8h.html#a58126625dc0ff8e6d1866433ab9342d1">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ2
: <a class="el" href="xnandps__onfi_8h.html#ab53c251758d5fd3705eee1a9337abef8">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_CACHE
: <a class="el" href="xnandps__onfi_8h.html#af2935a27b9769e1684978ba4ba96ec23">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_CACHE_END
: <a class="el" href="xnandps__onfi_8h.html#a2fc255623dd81fd29cebff096e20444d">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_CACHE_ENHANCED1
: <a class="el" href="xnandps__onfi_8h.html#a1c5c8ebf4ecb5594f01444d358048c25">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_CACHE_ENHANCED2
: <a class="el" href="xnandps__onfi_8h.html#a636d60b79e0600b0c493904f1af19360">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_ID
: <a class="el" href="xnandps__onfi_8h.html#a7a3e3490f4a700f719f343781111ddb5">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_PARAM_PAGE
: <a class="el" href="xnandps__onfi_8h.html#aeabd8cba36043b481813f654e440637e">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_STATUS
: <a class="el" href="xnandps__onfi_8h.html#acc38d697c4911db817bec7cf3e025938">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_STATUS_ENHANCED
: <a class="el" href="xnandps__onfi_8h.html#aed4869952de35132eafa69c63673addb">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_READ_UNIQUEID
: <a class="el" href="xnandps__onfi_8h.html#a1a90e233b57cb3bc0ef3a5fc315e158f">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_RESET
: <a class="el" href="xnandps__onfi_8h.html#af2876620cfd13144b4779bf7b4a5aefe">xnandps_onfi.h</a>
</li>
<li>ONFI_CMD_SET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#a09a77a047f11adfcb8b2b226bd674adf">xnandps_onfi.h</a>
</li>
<li>ONFI_CRC_INIT
: <a class="el" href="xnandps__onfi_8h.html#a95404175c5c6bfeb8a98aaef9bbc551e">xnandps_onfi.h</a>
</li>
<li>ONFI_CRC_LEN
: <a class="el" href="xnandps__onfi_8h.html#a227f8d8d7d2de58dd0b2d6da3006f03e">xnandps_onfi.h</a>
</li>
<li>ONFI_CRC_ORDER
: <a class="el" href="xnandps__onfi_8h.html#ade881bc5d3ed11d19ee0af0d25e84bc0">xnandps_onfi.h</a>
</li>
<li>ONFI_CRC_POLYNOM
: <a class="el" href="xnandps__onfi_8h.html#ad5f5c897b5d63054909a7f2e7311e991">xnandps_onfi.h</a>
</li>
<li>ONFI_H
: <a class="el" href="xnandps__onfi_8h.html#a8be4d072376f082bf5ae08776da5b773">xnandps_onfi.h</a>
</li>
<li>ONFI_ID_LEN
: <a class="el" href="xnandps__onfi_8h.html#a27d88d8a093bb990046ae13730aa935e">xnandps_onfi.h</a>
</li>
<li>ONFI_PARAM_PAGE_LEN
: <a class="el" href="xnandps__onfi_8h.html#a8934224be62b66baa973637dd3fd4816">xnandps_onfi.h</a>
</li>
<li>ONFI_SIGNATURE_LEN
: <a class="el" href="xnandps__onfi_8h.html#a68423a0be6b6a1956b7e93fef5e50e00">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_ARDY
: <a class="el" href="xnandps__onfi_8h.html#a381ed334372bb02695d812e44ba58081">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_FAIL
: <a class="el" href="xnandps__onfi_8h.html#a44013e5fb725c1b3233359b2fb14a4d3">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_FAILC
: <a class="el" href="xnandps__onfi_8h.html#a0fffa352f5726c9d18effcd83ce7061e">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_RDY
: <a class="el" href="xnandps__onfi_8h.html#a33dc5a0d5a0593c5a2654b16ff49b38a">xnandps_onfi.h</a>
</li>
<li>ONFI_STATUS_WP
: <a class="el" href="xnandps__onfi_8h.html#a8be0ae53753ead584ac71c2898d5d9e3">xnandps_onfi.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

1041
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_defs_0x78.html
View file

File diff suppressed because it is too large Load diff

71
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_enum.html
View file

@ -2,38 +2,53 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li><a href="globals.html"><span>All</span></a></li> </ul>
<li><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li><a href="globals_vars.html"><span>Variables</span></a></li> <div class="tabs">
<li id="current"><a href="globals_enum.html"><span>Enumerations</span></a></li> <ul>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li> <li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li> <li><a href="globals_func.html"><span>Functions</span></a></li>
</ul> <li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li class="current"><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div> </div>
&nbsp; <div class="contents">
<p> &nbsp;<ul>
<ul>
<li>OnfiCommandsEnum <li>OnfiCommandsEnum
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56">xnandps_onfi.h</a></ul> : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975">xnandps_onfi.h</a>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. </li>
<li>XNandPs_EccMode
: <a class="el" href="xnandps_8h.html#a2318d7b320b74ae18f3b2b34beddd39e">xnandps.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

132
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_eval.html
View file

@ -2,51 +2,101 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li><a href="globals.html"><span>All</span></a></li> </ul>
<li><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li><a href="globals_vars.html"><span>Variables</span></a></li> <div class="tabs">
<li><a href="globals_enum.html"><span>Enumerations</span></a></li> <ul>
<li id="current"><a href="globals_eval.html"><span>Enumerator</span></a></li> <li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li> <li><a href="globals_func.html"><span>Functions</span></a></li>
</ul> <li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li class="current"><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div> </div>
&nbsp; <div class="contents">
<p> &nbsp;<ul>
<ul>
<li>BLOCK_ERASE <li>BLOCK_ERASE
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56d7c55553331c6b152df6e49eb418d0e4">xnandps_onfi.h</a><li>CHANGE_READ_COLUMN : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a07c1d6a795c348f8633600a052d26dfd">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56a6d12b9db1b9c74776a370b15fd4f4bc">xnandps_onfi.h</a><li>CHANGE_WRITE_COLUMN </li>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56196eb21e32a58088bd0421ec5b4db361">xnandps_onfi.h</a><li>GET_FEATURES <li>CHANGE_READ_COLUMN
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c5606684bf154dabdcae09ce5cd3d58c1a5">xnandps_onfi.h</a><li>PAGE_CACHE_PROGRAM : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a93048e7702ea73781e031c18191f6aec">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c569b0b1157ee22f649e542d79194b0d073">xnandps_onfi.h</a><li>PAGE_PROGRAM </li>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56321de2ada4dccff8c112605f1514879c">xnandps_onfi.h</a><li>READ <li>CHANGE_WRITE_COLUMN
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c563466fab4975481651940ed328aa990e4">xnandps_onfi.h</a><li>READ_CACHE_END_SEQ : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a7b8cd11c9f3d97de2d293b68927899d6">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c565ec2b6b46ce0a4a2cd568fe8bbdeb6a3">xnandps_onfi.h</a><li>READ_CACHE_RANDOM </li>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56f0324cffdb895bb88f99790f831ee637">xnandps_onfi.h</a><li>READ_ID <li>GET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56df8176c224240e5ddff37983de70b5d3">xnandps_onfi.h</a><li>READ_PARAM_PAGE : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a9bf6ffa4f6227023e81c1b4ebd1ae5a1">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56aab1ca5f082d40fbfc553c3ebc9b11ac">xnandps_onfi.h</a><li>READ_STATUS </li>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56bbb3f26b8634d11762540fcf96e99902">xnandps_onfi.h</a><li>RESET <li>PAGE_CACHE_PROGRAM
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56b5859d8721cfdc0312b2838b9c985bc1">xnandps_onfi.h</a><li>SET_FEATURES : <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a917fd89fc6851edcf198f44f133ddf3a">xnandps_onfi.h</a>
: <a class="el" href="xnandps__onfi_8h.html#604b42e1fe04f40f361d9a9f53e54c56483ba48ef7851c1f5e356302d5eb4640">xnandps_onfi.h</a></ul> </li>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <li>PAGE_PROGRAM
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975abe9758bc5df677605dcc22e1557c853a">xnandps_onfi.h</a>
</li>
<li>READ
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975acb9be765f361bb7efb9073730aac92c6">xnandps_onfi.h</a>
</li>
<li>READ_CACHE_END_SEQ
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975afb1d5bd781a173ff53cb79de689b1469">xnandps_onfi.h</a>
</li>
<li>READ_CACHE_RANDOM
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a8b269d64de6c130671c1413fd0f2bbb2">xnandps_onfi.h</a>
</li>
<li>READ_ID
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a08d1641fdf7c1a20c4f1563f57d958e8">xnandps_onfi.h</a>
</li>
<li>READ_PARAM_PAGE
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a1589226dbb8a8f0493a8a6df64943518">xnandps_onfi.h</a>
</li>
<li>READ_STATUS
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a451fb3a060f895e40024da81e03fe45a">xnandps_onfi.h</a>
</li>
<li>RESET
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a589b7d94a3d91d145720e2fed0eb3a05">xnandps_onfi.h</a>
</li>
<li>SET_FEATURES
: <a class="el" href="xnandps__onfi_8h.html#ac876c6eb0d6c95869f0a68dccd44b975a4dbe92307b1ecfc6eb4dfb3ee1f59cb7">xnandps_onfi.h</a>
</li>
<li>XNANDPS_ECC_HW
: <a class="el" href="xnandps_8h.html#a2318d7b320b74ae18f3b2b34beddd39ea16a7c41d3ba75cba9ee48a3ba8c4d579">xnandps.h</a>
</li>
<li>XNANDPS_ECC_NONE
: <a class="el" href="xnandps_8h.html#a2318d7b320b74ae18f3b2b34beddd39ea764dc0f2ad5c36c3c0bfe8be83352c58">xnandps.h</a>
</li>
<li>XNANDPS_ECC_ONDIE
: <a class="el" href="xnandps_8h.html#a2318d7b320b74ae18f3b2b34beddd39eaa4a36d982e1314e7221837be2a0c4671">xnandps.h</a>
</li>
<li>XNANDPS_ECC_SW
: <a class="el" href="xnandps_8h.html#a2318d7b320b74ae18f3b2b34beddd39ea1d1c061e9b23ef2b650fb39cebafef24">xnandps.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

155
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_func.html
View file

@ -2,53 +2,124 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li><a href="globals.html"><span>All</span></a></li> </ul>
<li id="current"><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li><a href="globals_vars.html"><span>Variables</span></a></li> <div class="tabs">
<li><a href="globals_enum.html"><span>Enumerations</span></a></li> <ul>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li> <li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li> <li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
</ul> <li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
</div> </div>
<div class="contents">
&nbsp; &nbsp;
<p>
<ul> <h3><a class="anchor" id="index_o">- o -</a></h3><ul>
<li>Onfi_CmdReadStatus() <li>Onfi_CmdReadStatus()
: <a class="el" href="xnandps__onfi_8c.html#242826f09f6d9cab1ab85ddf5b1419ab">xnandps_onfi.c</a>, <a class="el" href="xnandps_8c.html#242826f09f6d9cab1ab85ddf5b1419ab">xnandps.c</a><li>Onfi_NandInit() : <a class="el" href="xnandps_8c.html#a7f3a46694f4b3c4baffca71e6fcfebab">xnandps.c</a>
: <a class="el" href="xnandps__onfi_8c.html#71eb008eeb4b6c3b04c7889be9ef7828">xnandps_onfi.c</a>, <a class="el" href="xnandps_8c.html#71eb008eeb4b6c3b04c7889be9ef7828">xnandps.c</a><li>XNandPs_CfgInitialize() , <a class="el" href="xnandps__onfi_8c.html#a7f3a46694f4b3c4baffca71e6fcfebab">xnandps_onfi.c</a>
: <a class="el" href="xnandps_8c.html#640a3a6791dc60cbd8efb13873346667">xnandps.c</a><li>XNandPs_EraseBlock() </li>
: <a class="el" href="xnandps_8c.html#3aeaa22b3ea721c2ed0050abf8502df8">xnandps.c</a><li>XNandPs_InitBbtDesc() <li>Onfi_NandInit()
: <a class="el" href="xnandps__bbm_8c.html#3ac103af0005d0a9375a8617cab34ae4">xnandps_bbm.c</a>, <a class="el" href="xnandps_8c.html#3ac103af0005d0a9375a8617cab34ae4">xnandps.c</a><li>XNandPs_IsBlockBad() : <a class="el" href="xnandps_8c.html#acb42515d1fa541b8ac5e785d1fb7eefd">xnandps.c</a>
: <a class="el" href="xnandps__bbm_8h.html#5785e54eafd1d46c2abdfb566a8fdbd4">xnandps_bbm.h</a>, <a class="el" href="xnandps__bbm_8c.html#5785e54eafd1d46c2abdfb566a8fdbd4">xnandps_bbm.c</a><li>XNandPs_LookupConfig() , <a class="el" href="xnandps__onfi_8c.html#acb42515d1fa541b8ac5e785d1fb7eefd">xnandps_onfi.c</a>
: <a class="el" href="xnandps__sinit_8c.html#0b25c536026bf1e6ab4b8aa95e485600">xnandps_sinit.c</a><li>XNandPs_MarkBlockBad() </li>
: <a class="el" href="xnandps__bbm_8h.html#16947337dc8ca84a7d6c086b30e6531f">xnandps_bbm.h</a>, <a class="el" href="xnandps__bbm_8c.html#16947337dc8ca84a7d6c086b30e6531f">xnandps_bbm.c</a><li>XNandPs_Read() </ul>
: <a class="el" href="xnandps_8c.html#8771afd57c3c6b395b1232aad24b8732">xnandps.c</a><li>XNandPs_ReadCache()
: <a class="el" href="xnandps_8c.html#91048dce1286c9378b09f49786e330e3">xnandps.c</a><li>XNandPs_ReadSpareBytes()
: <a class="el" href="xnandps__bbm_8c.html#360edb6cd1a0e223d7e7f4e8c4362faa">xnandps_bbm.c</a>, <a class="el" href="xnandps_8c.html#360edb6cd1a0e223d7e7f4e8c4362faa">xnandps.c</a><li>XNandPs_ScanBbt() <h3><a class="anchor" id="index_x">- x -</a></h3><ul>
: <a class="el" href="xnandps__bbm_8c.html#ec4b8f584cd85c840f97f400be1b7f7c">xnandps_bbm.c</a>, <a class="el" href="xnandps_8c.html#ec4b8f584cd85c840f97f400be1b7f7c">xnandps.c</a><li>XNandPs_SendCommand() <li>XNandPs_CfgInitialize()
: <a class="el" href="xnandps_8c.html#5e9a9e78bf52b70288416c4f70d0a636">xnandps.c</a><li>XNandPs_Write() : <a class="el" href="xnandps_8c.html#addb9f847fae34f6d137f591375a7c962">xnandps.c</a>
: <a class="el" href="xnandps_8c.html#714b8234c64481a732be277cff36880d">xnandps.c</a><li>XNandPs_WriteCache() , <a class="el" href="xnandps_8h.html#addb9f847fae34f6d137f591375a7c962">xnandps.h</a>
: <a class="el" href="xnandps_8c.html#fa84ea36515978a94e78a1a05b829181">xnandps.c</a><li>XNandPs_WriteSpareBytes() </li>
: <a class="el" href="xnandps_8c.html#5002378514a79f56068a9e50c0f10f2c">xnandps.c</a></ul> <li>XNandPs_EraseBlock()
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. : <a class="el" href="xnandps_8h.html#a22b4e2bc1af7e4bfecd4428c25a77bb8">xnandps.h</a>
, <a class="el" href="xnandps_8c.html#a22b4e2bc1af7e4bfecd4428c25a77bb8">xnandps.c</a>
</li>
<li>XNandPs_InitBbtDesc()
: <a class="el" href="xnandps_8c.html#a92acb0aedbfa7e76759062d70a2c4a67">xnandps.c</a>
, <a class="el" href="xnandps__bbm_8c.html#a92acb0aedbfa7e76759062d70a2c4a67">xnandps_bbm.c</a>
</li>
<li>XNandPs_IsBlockBad()
: <a class="el" href="xnandps__bbm_8h.html#a5744d2e6e03eb2b815771cf660ab2e11">xnandps_bbm.h</a>
, <a class="el" href="xnandps__bbm_8c.html#a5744d2e6e03eb2b815771cf660ab2e11">xnandps_bbm.c</a>
</li>
<li>XNandPs_LookupConfig()
: <a class="el" href="xnandps_8h.html#a0eb3e99243066b9145f3c437081988b5">xnandps.h</a>
, <a class="el" href="xnandps__sinit_8c.html#a0eb3e99243066b9145f3c437081988b5">xnandps_sinit.c</a>
</li>
<li>XNandPs_MarkBlockBad()
: <a class="el" href="xnandps__bbm_8c.html#a65ec4f2496ae641d1306089dff5416b2">xnandps_bbm.c</a>
, <a class="el" href="xnandps__bbm_8h.html#a65ec4f2496ae641d1306089dff5416b2">xnandps_bbm.h</a>
</li>
<li>XNandPs_Read()
: <a class="el" href="xnandps_8c.html#a8e72425d265074f1c2f8c66edfd22857">xnandps.c</a>
, <a class="el" href="xnandps_8h.html#aaccfcbd63b9560c96c66b98c126e6d67">xnandps.h</a>
</li>
<li>XNandPs_ReadCache()
: <a class="el" href="xnandps_8h.html#a0c42ba42a40c9b567c7cc851d8bb8081">xnandps.h</a>
, <a class="el" href="xnandps_8c.html#a605bd783f065806f1d1f602f88128f9b">xnandps.c</a>
</li>
<li>XNandPs_ReadSpareBytes()
: <a class="el" href="xnandps_8c.html#af9857df5e1359875e429f66e46ca5a86">xnandps.c</a>
, <a class="el" href="xnandps_8h.html#af9857df5e1359875e429f66e46ca5a86">xnandps.h</a>
, <a class="el" href="xnandps__bbm_8c.html#af9857df5e1359875e429f66e46ca5a86">xnandps_bbm.c</a>
</li>
<li>XNandPs_ScanBbt()
: <a class="el" href="xnandps__bbm_8c.html#a454c0738c0ffe28c49ba8fced47e8d9c">xnandps_bbm.c</a>
, <a class="el" href="xnandps_8c.html#a454c0738c0ffe28c49ba8fced47e8d9c">xnandps.c</a>
</li>
<li>XNandPs_SendCommand()
: <a class="el" href="xnandps_8c.html#ae2862ccd7e9180b843d9e73e2a8c7e7b">xnandps.c</a>
, <a class="el" href="xnandps__onfi_8c.html#ae2862ccd7e9180b843d9e73e2a8c7e7b">xnandps_onfi.c</a>
</li>
<li>XNandPs_Write()
: <a class="el" href="xnandps_8h.html#a1b8dfc70a5d81f5438b5d91708f17a96">xnandps.h</a>
, <a class="el" href="xnandps_8c.html#aebab330d0fd9efef74c26a50b5829d9f">xnandps.c</a>
</li>
<li>XNandPs_WriteCache()
: <a class="el" href="xnandps_8c.html#a8ecd5bb0fc73b3011ee0ba500e0161fe">xnandps.c</a>
, <a class="el" href="xnandps_8h.html#a8ecd5bb0fc73b3011ee0ba500e0161fe">xnandps.h</a>
</li>
<li>XNandPs_WriteSpareBytes()
: <a class="el" href="xnandps_8c.html#aa987d756af43c965a6439f077a4ce158">xnandps.c</a>
, <a class="el" href="xnandps_8h.html#aa987d756af43c965a6439f077a4ce158">xnandps.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

51
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_type.html Executable file
View file

@ -0,0 +1,51 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver nandps v2_1: Class Members
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- 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 class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li class="current"><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp;<ul>
<li>XNandPs
: <a class="el" href="xnandps_8h.html#af0def4ad29325b821b3fd4127740dfbe">xnandps.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

86
XilinxProcessorIPLib/drivers/nandps/doc/html/api/globals_vars.html
View file

@ -2,42 +2,64 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
Class Members Xilinx Driver nandps v2_1: Class Members
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<div class="tabs"> <li class="current"><a href="files.html"><span>Files</span></a></li>
<ul> </ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li> </div>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li> <div class="tabs">
</ul></div> <ul>
<div class="tabs"> <li><a href="files.html"><span>File&nbsp;List</span></a></li>
<ul> <li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
<li><a href="globals.html"><span>All</span></a></li> </ul>
<li><a href="globals_func.html"><span>Functions</span></a></li> </div>
<li id="current"><a href="globals_vars.html"><span>Variables</span></a></li> <div class="tabs">
<li><a href="globals_enum.html"><span>Enumerations</span></a></li> <ul>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li> <li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li> <li><a href="globals_func.html"><span>Functions</span></a></li>
</ul> <li class="current"><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_type.html"><span>Typedefs</span></a></li>
<li><a href="globals_enum.html"><span>Enumerations</span></a></li>
<li><a href="globals_eval.html"><span>Enumerator</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div> </div>
&nbsp; <div class="contents">
<p> &nbsp;<ul>
<ul>
<li>NandOob16 <li>NandOob16
: <a class="el" href="xnandps_8c.html#469ff8705a5ab8659ff0ee64c950073d">xnandps.c</a><li>NandOob32 : <a class="el" href="xnandps_8c.html#ae980af68044391bcf0c94bd2b35c910b">xnandps.c</a>
: <a class="el" href="xnandps_8c.html#a8fc6bf2121a9ae287b24d102061a281">xnandps.c</a><li>NandOob64 </li>
: <a class="el" href="xnandps_8c.html#f9b371cb37400b34363fa1a0a56a205e">xnandps.c</a><li>OnfiCommands <li>NandOob32
: <a class="el" href="xnandps__onfi_8c.html#4175177d9f5cd255ff1e01f384129261">xnandps_onfi.c</a>, <a class="el" href="xnandps_8c.html#4175177d9f5cd255ff1e01f384129261">xnandps.c</a><li>XNandPs_ConfigTable : <a class="el" href="xnandps_8c.html#ad8d144dd94afdb026486d7b34e6c58f1">xnandps.c</a>
: <a class="el" href="xnandps__sinit_8c.html#b4c9d5d880be6a92c30c16e7dcbc8311">xnandps_sinit.c</a>, <a class="el" href="xnandps__g_8c.html#9f567a0b07898064743a08b1043f7719">xnandps_g.c</a></ul> </li>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. <li>NandOob64
: <a class="el" href="xnandps_8c.html#aed173a3e7bda0d3a84e8f7d55aa4e81d">xnandps.c</a>
</li>
<li>OnfiCommands
: <a class="el" href="xnandps_8c.html#a6256f01deb0ca40af90a3b6ceb0aef94">xnandps.c</a>
, <a class="el" href="xnandps__onfi_8c.html#a6256f01deb0ca40af90a3b6ceb0aef94">xnandps_onfi.c</a>
</li>
<li>XNandPs_ConfigTable
: <a class="el" href="xnandps__g_8c.html#ad3748e2cdbea09cf0311970db4fbf81c">xnandps_g.c</a>
, <a class="el" href="xnandps__sinit_8c.html#a9fda36b00c8235b40746d8a29361acdc">xnandps_sinit.c</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

92
XilinxProcessorIPLib/drivers/nandps/doc/html/api/index.html
View file

@ -2,50 +2,57 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> <title>
xnandps v2_0 Xilinx Driver nandps v2_1: nandps v2_1
</title> </title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css"> <link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head> </head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3> <h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl> <hl>Software Drivers</hl>
<hr class="whs1"> <hr class="whs1">
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs"> <!-- Generated by Doxygen 1.6.1 -->
<ul> <div class="navigation" id="top">
<li id="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li> <div class="tabs">
<li><a href="annotated.html"><span>Classes</span></a></li> <ul>
<li><a href="files.html"><span>Files</span></a></li> <li class="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li>
</ul></div> <li><a href="annotated.html"><span>Classes</span></a></li>
<h1>xnandps v2_0</h1> <li><a href="files.html"><span>Files</span></a></li>
<p> </ul>
This file implements a driver for the NAND flash controller.<p> </div>
<b>Driver Initialization</b><p> </div>
The function call <a class="el" href="xnandps_8c.html#640a3a6791dc60cbd8efb13873346667">XNandPs_CfgInitialize()</a> should be called by the application before any other function in the driver. The initialization function takes device specific data (like device id, instance id, and base address) and initializes the XNandPs instance with the device specific data.<p> <div class="contents">
<b>Device Geometry</b><p> <h1>nandps v2_1</h1><p>This file implements a driver for the NAND flash controller.</p>
NAND flash device is memory device and it is segmented into areas called Logical Unit(s) (LUN) and further in to blocks and pages. A NAND flash device can have multiple LUN. LUN is sequential raw of multiple blocks of the same size. A block is the smallest erasable unit of data within the Flash array of a LUN. The size of each block is based on a power of 2. There is no restriction on the number of blocks within the LUN. A block contains a number of pages. A page is the smallest addressable unit for read and program operations. The arrangement of LUN, blocks, and pages is referred to by this module as the part's geometry.<p> <p><b>Driver Initialization</b></p>
The cells within the part can be programmed from a logic 1 to a logic 0 and not the other way around. To change a cell back to a logic 1, the entire block containing that cell must be erased. When a block is erased all bytes contain the value 0xFF. The number of times a block can be erased is finite. Eventually the block will wear out and will no longer be capable of erasure. As of this writing, the typical flash block can be erased 100,000 or more times.<p> <p>The function call <a class="el" href="xnandps_8c.html#addb9f847fae34f6d137f591375a7c962">XNandPs_CfgInitialize()</a> should be called by the application before any other function in the driver. The initialization function takes device specific data (like device id, instance id, and base address) and initializes the XNandPs instance with the device specific data.</p>
The jobs done by this driver typically are:<ul> <p><b>Device Geometry</b></p>
<li>8/16 bit operational mode</li><li>Read, Write, and Erase operation</li><li>Read, Write cache operation</li><li>Read, Write Spare area operation</li><li>HW Error Check and Correction (ECC)</li></ul> <p>NAND flash device is memory device and it is segmented into areas called Logical Unit(s) (LUN) and further in to blocks and pages. A NAND flash device can have multiple LUN. LUN is sequential raw of multiple blocks of the same size. A block is the smallest erasable unit of data within the Flash array of a LUN. The size of each block is based on a power of 2. There is no restriction on the number of blocks within the LUN. A block contains a number of pages. A page is the smallest addressable unit for read and program operations. The arrangement of LUN, blocks, and pages is referred to by this module as the part's geometry.</p>
<p> <p>The cells within the part can be programmed from a logic 1 to a logic 0 and not the other way around. To change a cell back to a logic 1, the entire block containing that cell must be erased. When a block is erased all bytes contain the value 0xFF. The number of times a block can be erased is finite. Eventually the block will wear out and will no longer be capable of erasure. As of this writing, the typical flash block can be erased 100,000 or more times.</p>
<b>Write Operation</b><p> <p>The jobs done by this driver typically are:</p>
The write call can be used to write a minimum of one byte and a maximum entire flash. If the address offset specified to write is out of flash or if the number of bytes specified from the offset exceed flash boundaries an error is reported back to the user. The write is blocking in nature in that the control is returned back to user only after the write operation is completed successfully or an error is reported.<p> <ul>
<b>Read Operation</b><p> <li>8/16 bit operational mode</li>
The read call can be used to read a minimum of one byte and maximum of entire flash. If the address offset specified to read is out of flash or if the number of bytes specified from the offset exceed flash boundaries an error is reported back to the user. The read is blocking in nature in that the control is returned back to user only after the read operation is completed successfully or an error is reported.<p> <li>Read, Write, and Erase operation</li>
<b>Erase Operation</b><p> <li>Read, Write cache operation</li>
The erase operations are provided to erase a Block in the Flash memory. The erase call is blocking in nature in that the control is returned back to user only after the erase operation is completed successfully or an error is reported.<p> <li>Read, Write Spare area operation</li>
<b>Page Cache Write Operation</b><p> <li>HW Error Check and Correction (ECC)</li>
The page cache write call is same as write call except that it uses cache commands to write. This enhances the performance. This operation can't be performed on OnDie ECC with internal ECC enabled. There is no way to disable internal ECC for OnDie ECC flash parts in current driver. This operation is tested with Spansion S34ML04G100TFI00 flash. We have to use this operation only on the flash parts which supports program page cache command.<p> </ul>
<b>Page Cache Read Operation</b><p> <p><b>Write Operation</b></p>
The page cache read call is same as read call except that it uses cache commands to read. This enhances the performance. The read cache random command is used since the HW ECC block doesn't support commands without address for starting ECC. This operation can't be performed on OnDie ECC with internal ECC enabled. There is no way to disable internal ECC for OnDie ECC flash parts in current driver. This operation is tested with Spansion S34ML04G100TFI00 flash. We have to use this operation only on the flash parts which supports read page cache command (random).<p> <p>The write call can be used to write a minimum of one byte and a maximum entire flash. If the address offset specified to write is out of flash or if the number of bytes specified from the offset exceed flash boundaries an error is reported back to the user. The write is blocking in nature in that the control is returned back to user only after the write operation is completed successfully or an error is reported.</p>
<b>Write Spare Bytes Operation</b><p> <p><b>Read Operation</b></p>
This call writes to user specified buffer into spare bytes of a page.<p> <p>The read call can be used to read a minimum of one byte and maximum of entire flash. If the address offset specified to read is out of flash or if the number of bytes specified from the offset exceed flash boundaries an error is reported back to the user. The read is blocking in nature in that the control is returned back to user only after the read operation is completed successfully or an error is reported.</p>
<b>Read Spare Bytes Operation</b><p> <p><b>Erase Operation</b></p>
This call reads spare bytes of a page into user specified buffer.<p> <p>The erase operations are provided to erase a Block in the Flash memory. The erase call is blocking in nature in that the control is returned back to user only after the erase operation is completed successfully or an error is reported.</p>
<dl compact><dt><b>Note:</b></dt><dd></dd></dl> <p><b>Page Cache Write Operation</b></p>
This driver is intended to be RTOS and processor independent. It works with physical addresses only. Any needs for dynamic memory management, threads, mutual exclusion, virtual memory, cache control, or HW write protection management must be satisfied by the layer above this driver.<p> <p>The page cache write call is same as write call except that it uses cache commands to write. This enhances the performance. This operation can't be performed on OnDie ECC with internal ECC enabled. There is no way to disable internal ECC for OnDie ECC flash parts in current driver. This operation is tested with Spansion S34ML04G100TFI00 flash. We have to use this operation only on the flash parts which supports program page cache command.</p>
<p><b>Page Cache Read Operation</b></p>
<p>The page cache read call is same as read call except that it uses cache commands to read. This enhances the performance. The read cache random command is used since the HW ECC block doesn't support commands without address for starting ECC. This operation can't be performed on OnDie ECC with internal ECC enabled. There is no way to disable internal ECC for OnDie ECC flash parts in current driver. This operation is tested with Spansion S34ML04G100TFI00 flash. We have to use this operation only on the flash parts which supports read page cache command (random).</p>
<p><b>Write Spare Bytes Operation</b></p>
<p>This call writes to user specified buffer into spare bytes of a page.</p>
<p><b>Read Spare Bytes Operation</b></p>
<p>This call reads spare bytes of a page into user specified buffer.</p>
<dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
<p>This driver is intended to be RTOS and processor independent. It works with physical addresses only. Any needs for dynamic memory management, threads, mutual exclusion, virtual memory, cache control, or HW write protection management must be satisfied by the layer above this driver.</p>
<pre> <pre>
MODIFICATION HISTORY:</pre><p> MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
<pre> Ver Who Date Changes
----- ---- ---------- ----------------------------------------------- ----- ---- ---------- -----------------------------------------------
1.00a nm 12/10/2010 First release 1.00a nm 12/10/2010 First release
nm 29/09/2011 Added support for On-Die ECC NAND and Clean NAND nm 29/09/2011 Added support for On-Die ECC NAND and Clean NAND
@ -75,4 +82,11 @@ This driver is intended to be RTOS and processor independent. It works with phys
Added function prototypes for Page cache read/write Added function prototypes for Page cache read/write
and spare byte read/write API's. and spare byte read/write API's.
2.0 adk 12/10/13 Updated as per the New Tcl API's 2.0 adk 12/10/13 Updated as per the New Tcl API's
</pre> Copyright @ 1995-2014 Xilinx, Inc. All rights reserved. 2.1 kpc 07/24/13 Fixed CR#808770. Update command register twice only
if flash device requires &gt;= four address cycles.
</pre> </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show more