embeddedsw/XilinxProcessorIPLib/drivers/iicps/doc/html/api/xiicps_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

126 lines
16 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>iicps: xiicps.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">iicps
</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_625e7d7c34d1f3307c735c32380fbfb9.html">iicps</a></li><li class="navelem"><a class="el" href="dir_f8dcf1893dee9376765a46cd3951f6bc.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> </div>
<div class="headertitle">
<div class="title">xiicps.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_iic_ps___config.html">XIicPs_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_iic_ps.html">XIicPs</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="member-group"></a>
Role constants</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp9bbef19594e2bb00213beebd85d0861a"></a>These constants are used to pass into the device setup routines to set up the device according to transfer direction. </p>
</td></tr>
<tr class="memitem:gaabcfd3b5d9ed949a553a992242237cba"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gaabcfd3b5d9ed949a553a992242237cba">XIicPs_IntrHandler</a>) (void *CallBackRef, u32 StatusEvent)</td></tr>
<tr class="separator:gaabcfd3b5d9ed949a553a992242237cba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga14c7ff4f51185d8aab0028c0eeb3c336"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_iic_ps___config.html">XIicPs_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga14c7ff4f51185d8aab0028c0eeb3c336">XIicPs_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="separator:ga14c7ff4f51185d8aab0028c0eeb3c336"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae97ad9c202953c7e49bfb56533c47079"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gae97ad9c202953c7e49bfb56533c47079">XIicPs_CfgInitialize</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, <a class="el" href="struct_x_iic_ps___config.html">XIicPs_Config</a> *ConfigPtr, u32 EffectiveAddr)</td></tr>
<tr class="separator:gae97ad9c202953c7e49bfb56533c47079"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3eaa694ecd774beca05bf79c1f9df6c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga3eaa694ecd774beca05bf79c1f9df6c0">XIicPs_Abort</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga3eaa694ecd774beca05bf79c1f9df6c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1169a92eb8594d6f038816b5740916f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga1169a92eb8594d6f038816b5740916f7">XIicPs_Reset</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga1169a92eb8594d6f038816b5740916f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b67ad96b8c40bdd47c2c2f8a57f170c"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga5b67ad96b8c40bdd47c2c2f8a57f170c">XIicPs_BusIsBusy</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga5b67ad96b8c40bdd47c2c2f8a57f170c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacfb0d8f18f8105db7708669ddb186e19"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gacfb0d8f18f8105db7708669ddb186e19">TransmitFifoFill</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:gacfb0d8f18f8105db7708669ddb186e19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab2581047e7d5607fe96fe0dac9673527"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gab2581047e7d5607fe96fe0dac9673527">XIicPs_SetStatusHandler</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, void *CallBackRef, <a class="el" href="group__iicps__v3__0.html#gaabcfd3b5d9ed949a553a992242237cba">XIicPs_IntrHandler</a> FunctionPtr)</td></tr>
<tr class="separator:gab2581047e7d5607fe96fe0dac9673527"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3027c1eb6ece3193a978a2da8e06c011"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga3027c1eb6ece3193a978a2da8e06c011">XIicPs_MasterSend</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount, u16 SlaveAddr)</td></tr>
<tr class="separator:ga3027c1eb6ece3193a978a2da8e06c011"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4817f45c28341cea4ab8960dc1203acb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga4817f45c28341cea4ab8960dc1203acb">XIicPs_MasterRecv</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount, u16 SlaveAddr)</td></tr>
<tr class="separator:ga4817f45c28341cea4ab8960dc1203acb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71584f1a7e675cde41cfd9d1bd4320b4"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga71584f1a7e675cde41cfd9d1bd4320b4">XIicPs_MasterSendPolled</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount, u16 SlaveAddr)</td></tr>
<tr class="separator:ga71584f1a7e675cde41cfd9d1bd4320b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21bdb2f8a1f09e027aa8b0e9d6648d75"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga21bdb2f8a1f09e027aa8b0e9d6648d75">XIicPs_MasterRecvPolled</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount, u16 SlaveAddr)</td></tr>
<tr class="separator:ga21bdb2f8a1f09e027aa8b0e9d6648d75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga597faa64ccaf3d8034e3e92989048f06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga597faa64ccaf3d8034e3e92989048f06">XIicPs_EnableSlaveMonitor</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u16 SlaveAddr)</td></tr>
<tr class="separator:ga597faa64ccaf3d8034e3e92989048f06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga15f2e8071ff8d8e1ec1dc56d29ab202b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga15f2e8071ff8d8e1ec1dc56d29ab202b">XIicPs_DisableSlaveMonitor</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga15f2e8071ff8d8e1ec1dc56d29ab202b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad64f0389aa694ecf21ca8a39e44cf13f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gad64f0389aa694ecf21ca8a39e44cf13f">XIicPs_MasterInterruptHandler</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:gad64f0389aa694ecf21ca8a39e44cf13f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1c7ffa09df93fb59f97b0a3bf5baaa7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gad1c7ffa09df93fb59f97b0a3bf5baaa7">XIicPs_SetupSlave</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u16 SlaveAddr)</td></tr>
<tr class="separator:gad1c7ffa09df93fb59f97b0a3bf5baaa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4478d1d94f349deda02c0191a7529113"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga4478d1d94f349deda02c0191a7529113">XIicPs_SlaveSend</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount)</td></tr>
<tr class="separator:ga4478d1d94f349deda02c0191a7529113"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1840936a940459c5a71858f94915f933"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga1840936a940459c5a71858f94915f933">XIicPs_SlaveRecv</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount)</td></tr>
<tr class="separator:ga1840936a940459c5a71858f94915f933"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ca49d9131b13d66f58de0b5a23faea4"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga5ca49d9131b13d66f58de0b5a23faea4">XIicPs_SlaveSendPolled</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount)</td></tr>
<tr class="separator:ga5ca49d9131b13d66f58de0b5a23faea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga74b0af9e4395c8de724dc377e3504d0d"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga74b0af9e4395c8de724dc377e3504d0d">XIicPs_SlaveRecvPolled</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u8 *MsgPtr, s32 ByteCount)</td></tr>
<tr class="separator:ga74b0af9e4395c8de724dc377e3504d0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga716cdb9f63e56269824866872958dd78"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga716cdb9f63e56269824866872958dd78">XIicPs_SlaveInterruptHandler</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga716cdb9f63e56269824866872958dd78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f9db7651cd6ee0232dc9fdaca3f976a"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga6f9db7651cd6ee0232dc9fdaca3f976a">XIicPs_SelfTest</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga6f9db7651cd6ee0232dc9fdaca3f976a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec1dc5be2be8a7394263cfe56af976c5"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gaec1dc5be2be8a7394263cfe56af976c5">XIicPs_SetOptions</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u32 Options)</td></tr>
<tr class="separator:gaec1dc5be2be8a7394263cfe56af976c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga87cbf2622a9c6ad66b18d4c3f9575a76"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga87cbf2622a9c6ad66b18d4c3f9575a76">XIicPs_ClearOptions</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u32 Options)</td></tr>
<tr class="separator:ga87cbf2622a9c6ad66b18d4c3f9575a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga20964e35a74f4e16f90e78510c9b4337"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga20964e35a74f4e16f90e78510c9b4337">XIicPs_GetOptions</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga20964e35a74f4e16f90e78510c9b4337"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafb24cfdacf6cf28d80126862dc1cfbe5"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#gafb24cfdacf6cf28d80126862dc1cfbe5">XIicPs_SetSClk</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr, u32 FsclHz)</td></tr>
<tr class="separator:gafb24cfdacf6cf28d80126862dc1cfbe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f2d2d3d11c2c9125a5bc8a0d95593cb"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iicps__v3__0.html#ga9f2d2d3d11c2c9125a5bc8a0d95593cb">XIicPs_GetSClk</a> (<a class="el" href="struct_x_iic_ps.html">XIicPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga9f2d2d3d11c2c9125a5bc8a0d95593cb"><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>