embeddedsw/XilinxProcessorIPLib/drivers/uartns550/doc/html/api/xuartns550_8h.html
Nava kishore Manne d18411f597 Drivers: Doxygen changes for 2015.4
Signed-off-by: Nava kishore Manne <navam@xilinx.com>
2015-12-01 11:51:28 +05:30

140 lines
17 KiB
HTML
Executable file

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>uartns550: xuartns550.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">uartns550
</div>
<div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Overview</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="globals.html"><span>APIs</span></a></li>
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_8b63a9313bec1a2f440e35c7d8548f42.html">uartns550</a></li><li class="navelem"><a class="el" href="dir_8705d3aa92229a3548f3d406d104c70d.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xuartns550.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550_buffer.html">XUartNs550Buffer</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550_format.html">XUartNs550Format</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550_stats.html">XUartNs550Stats</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Configuration options</div></td></tr>
<tr class="memitem:ga08a745fcffbdb351b5bac16197578eba"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga08a745fcffbdb351b5bac16197578eba">XUN_OPTION_RXLINE_INTR</a>&#160;&#160;&#160;0x0800</td></tr>
<tr class="separator:ga08a745fcffbdb351b5bac16197578eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Data format values</div></td></tr>
<tr class="memitem:ga7d074166a6d63f05a7f5b4d8600eef81"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga7d074166a6d63f05a7f5b4d8600eef81">XUN_FORMAT_8_BITS</a>&#160;&#160;&#160;3</td></tr>
<tr class="separator:ga7d074166a6d63f05a7f5b4d8600eef81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">FIFO trigger values</div></td></tr>
<tr><td colspan="2"><div class="groupHeader">Modem status values</div></td></tr>
<tr class="memitem:gab901a667c0092c479c5d9010ed7502d2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gab901a667c0092c479c5d9010ed7502d2">XUN_MODEM_DCD_DELTA_MASK</a>&#160;&#160;&#160;0x08</td></tr>
<tr class="separator:gab901a667c0092c479c5d9010ed7502d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Callback events</div></td></tr>
<tr class="memitem:gabc9845fc2ec5078c1beea2b1e1f8458c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gabc9845fc2ec5078c1beea2b1e1f8458c">XUN_EVENT_RECV_DATA</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:gabc9845fc2ec5078c1beea2b1e1f8458c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Error values</div></td></tr>
<tr class="memitem:ga30f8d32289eefb7b8f4144e702da0248"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga30f8d32289eefb7b8f4144e702da0248">XUN_ERROR_BREAK_MASK</a>&#160;&#160;&#160;0x10</td></tr>
<tr class="separator:ga30f8d32289eefb7b8f4144e702da0248"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga21a8c40dd3f55a6a052d91bfe2ad8228"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga21a8c40dd3f55a6a052d91bfe2ad8228">XUartNs550_Handler</a>) (void *CallBackRef, u32 Event, unsigned int EventData)</td></tr>
<tr class="separator:ga21a8c40dd3f55a6a052d91bfe2ad8228"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga97009bf7b2508c14225b0d5835c256d0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga97009bf7b2508c14225b0d5835c256d0">XUartNs550_Initialize</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="separator:ga97009bf7b2508c14225b0d5835c256d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c5e715e9e90bd93e68c47e1cd398be5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga2c5e715e9e90bd93e68c47e1cd398be5">XUartNs550_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="separator:ga2c5e715e9e90bd93e68c47e1cd398be5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga37a67d6e3901ba6bee3df7c51dab093b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a> *Config, u32 EffectiveAddr)</td></tr>
<tr class="separator:ga37a67d6e3901ba6bee3df7c51dab093b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga421921af6a8df7c51ddbfa5d2301ad1b"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u8 *BufferPtr, unsigned int NumBytes)</td></tr>
<tr class="separator:ga421921af6a8df7c51ddbfa5d2301ad1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga35fc171801e394fce29cbcb09dc1ff99"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga35fc171801e394fce29cbcb09dc1ff99">XUartNs550_Recv</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u8 *BufferPtr, unsigned int NumBytes)</td></tr>
<tr class="separator:ga35fc171801e394fce29cbcb09dc1ff99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac2270082fbb7d7b2c32bd9208dae5be3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gac2270082fbb7d7b2c32bd9208dae5be3">XUartNs550_SetOptions</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u16 Options)</td></tr>
<tr class="separator:gac2270082fbb7d7b2c32bd9208dae5be3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga120797e7b4fc719c827c4378e387efe4"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga120797e7b4fc719c827c4378e387efe4">XUartNs550_GetOptions</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga120797e7b4fc719c827c4378e387efe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaedd1056b9f1283ee15c1a3c349acb845"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u8 TriggerLevel)</td></tr>
<tr class="separator:gaedd1056b9f1283ee15c1a3c349acb845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f7c185a91f28f3490fa8ef71dab1059"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga4f7c185a91f28f3490fa8ef71dab1059">XUartNs550_GetFifoThreshold</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga4f7c185a91f28f3490fa8ef71dab1059"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab822fbaed4a57714779e35b6be6f090"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gaab822fbaed4a57714779e35b6be6f090">XUartNs550_IsSending</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:gaab822fbaed4a57714779e35b6be6f090"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab5c78c74113daef4f74aefbc57e92b3a"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gab5c78c74113daef4f74aefbc57e92b3a">XUartNs550_GetLastErrors</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:gab5c78c74113daef4f74aefbc57e92b3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga541b6125f67b83adfe5f508215d59ea6"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga541b6125f67b83adfe5f508215d59ea6">XUartNs550_GetModemStatus</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga541b6125f67b83adfe5f508215d59ea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b3eb97421a6a66e7029e9afafd8a74b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="struct_x_uart_ns550_format.html">XUartNs550Format</a> *FormatPtr)</td></tr>
<tr class="separator:ga4b3eb97421a6a66e7029e9afafd8a74b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7928b4629d2a36d5f771040176746f10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="struct_x_uart_ns550_format.html">XUartNs550Format</a> *FormatPtr)</td></tr>
<tr class="separator:ga7928b4629d2a36d5f771040176746f10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadf7c4826f92d5e8fd70763f4448a360d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gadf7c4826f92d5e8fd70763f4448a360d">XUartNs550_SetHandler</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="group__uartns550__v3__3.html#ga21a8c40dd3f55a6a052d91bfe2ad8228">XUartNs550_Handler</a> FuncPtr, void *CallBackRef)</td></tr>
<tr class="separator:gadf7c4826f92d5e8fd70763f4448a360d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e8579fcf317e1f30d61b4fb7fe60434"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga6e8579fcf317e1f30d61b4fb7fe60434">XUartNs550_InterruptHandler</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga6e8579fcf317e1f30d61b4fb7fe60434"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad859e54c9baab85a7dd46b6851384ff6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gad859e54c9baab85a7dd46b6851384ff6">XUartNs550_GetStats</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="struct_x_uart_ns550_stats.html">XUartNs550Stats</a> *StatsPtr)</td></tr>
<tr class="separator:gad859e54c9baab85a7dd46b6851384ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga67e2cea916214f246e449b8438d01384"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga67e2cea916214f246e449b8438d01384">XUartNs550_ClearStats</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga67e2cea916214f246e449b8438d01384"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ec86252a3b83b8d7b4815ffb960562d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga2ec86252a3b83b8d7b4815ffb960562d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
</ul>
</div>
</body>
</html>