| 1 |
4 |
DFC |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
| 2 |
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
| 3 |
|
|
<head>
|
| 4 |
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
| 5 |
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
| 6 |
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
| 7 |
|
|
<title>iic_v3_4: xiic_l.h File Reference</title>
|
| 8 |
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
| 9 |
|
|
<script type="text/javascript" src="jquery.js"></script>
|
| 10 |
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
| 11 |
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
| 12 |
|
|
<script type="text/javascript" src="resize.js"></script>
|
| 13 |
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
| 14 |
|
|
<script type="text/javascript" src="navtree.js"></script>
|
| 15 |
|
|
<script type="text/javascript">
|
| 16 |
|
|
$(document).ready(initResizable);
|
| 17 |
|
|
$(window).load(resizeHeight);
|
| 18 |
|
|
</script>
|
| 19 |
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
| 20 |
|
|
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
|
| 21 |
|
|
</head>
|
| 22 |
|
|
<body>
|
| 23 |
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
| 24 |
|
|
<div id="titlearea">
|
| 25 |
|
|
<table cellspacing="0" cellpadding="0">
|
| 26 |
|
|
<tbody>
|
| 27 |
|
|
<tr style="height: 56px;">
|
| 28 |
|
|
<td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
|
| 29 |
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
| 30 |
|
|
<div id="projectname">iic_v3_4
|
| 31 |
|
|
</div>
|
| 32 |
|
|
<div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
|
| 33 |
|
|
</td>
|
| 34 |
|
|
</tr>
|
| 35 |
|
|
</tbody>
|
| 36 |
|
|
</table>
|
| 37 |
|
|
</div>
|
| 38 |
|
|
<!-- end header part -->
|
| 39 |
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
| 40 |
|
|
<div id="navrow1" class="tabs">
|
| 41 |
|
|
<ul class="tablist">
|
| 42 |
|
|
<li><a href="index.html"><span>Overview</span></a></li>
|
| 43 |
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
| 44 |
|
|
<li><a href="globals.html"><span>APIs</span></a></li>
|
| 45 |
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
| 46 |
|
|
</ul>
|
| 47 |
|
|
</div>
|
| 48 |
|
|
</div><!-- top -->
|
| 49 |
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
| 50 |
|
|
<div id="nav-tree">
|
| 51 |
|
|
<div id="nav-tree-contents">
|
| 52 |
|
|
<div id="nav-sync" class="sync"></div>
|
| 53 |
|
|
</div>
|
| 54 |
|
|
</div>
|
| 55 |
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
| 56 |
|
|
class="ui-resizable-handle">
|
| 57 |
|
|
</div>
|
| 58 |
|
|
</div>
|
| 59 |
|
|
<script type="text/javascript">
|
| 60 |
|
|
$(document).ready(function(){initNavTree('xiic__l_8h.html','');});
|
| 61 |
|
|
</script>
|
| 62 |
|
|
<div id="doc-content">
|
| 63 |
|
|
<div class="header">
|
| 64 |
|
|
<div class="summary">
|
| 65 |
|
|
<a href="#define-members">Macros</a> |
|
| 66 |
|
|
<a href="#func-members">Functions</a> </div>
|
| 67 |
|
|
<div class="headertitle">
|
| 68 |
|
|
<div class="title">xiic_l.h File Reference</div> </div>
|
| 69 |
|
|
</div><!--header-->
|
| 70 |
|
|
<div class="contents">
|
| 71 |
|
|
<table class="memberdecls">
|
| 72 |
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
| 73 |
|
|
Macros</h2></td></tr>
|
| 74 |
|
|
<tr class="memitem:gab81f7edf097fc4a885fd6134a288a817"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gab81f7edf097fc4a885fd6134a288a817">XIIC_READ_OPERATION</a>   1</td></tr>
|
| 75 |
|
|
<tr class="separator:gab81f7edf097fc4a885fd6134a288a817"><td class="memSeparator" colspan="2"> </td></tr>
|
| 76 |
|
|
<tr class="memitem:gaa0040c82cb3f8c0bbff61cbbad86e1ac"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gaa0040c82cb3f8c0bbff61cbbad86e1ac">XIIC_MASTER_ROLE</a>   1</td></tr>
|
| 77 |
|
|
<tr class="separator:gaa0040c82cb3f8c0bbff61cbbad86e1ac"><td class="memSeparator" colspan="2"> </td></tr>
|
| 78 |
|
|
<tr class="memitem:gacdf6b790e752c7f789c81ee4721bafe8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gacdf6b790e752c7f789c81ee4721bafe8">XIIC_STOP</a>   0x00</td></tr>
|
| 79 |
|
|
<tr class="separator:gacdf6b790e752c7f789c81ee4721bafe8"><td class="memSeparator" colspan="2"> </td></tr>
|
| 80 |
|
|
<tr class="memitem:gab28be58b11c65ecc54fc2f0c300412c1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gab28be58b11c65ecc54fc2f0c300412c1">XIic_ReadReg</a>(BaseAddress, RegOffset)   XIic_In32((BaseAddress) + (RegOffset))</td></tr>
|
| 81 |
|
|
<tr class="separator:gab28be58b11c65ecc54fc2f0c300412c1"><td class="memSeparator" colspan="2"> </td></tr>
|
| 82 |
|
|
<tr class="memitem:ga7a9318f43afc81c1dbd30a27587ba51d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga7a9318f43afc81c1dbd30a27587ba51d">XIic_WriteReg</a>(BaseAddress, RegOffset, RegisterValue)   XIic_Out32((BaseAddress) + (RegOffset), (RegisterValue))</td></tr>
|
| 83 |
|
|
<tr class="separator:ga7a9318f43afc81c1dbd30a27587ba51d"><td class="memSeparator" colspan="2"> </td></tr>
|
| 84 |
|
|
<tr class="memitem:ga17d0df7020d5264d20bbc36d276e276e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga17d0df7020d5264d20bbc36d276e276e">XIic_IntrGlobalDisable</a>(BaseAddress)   <a class="el" href="group__iic__v3__1.html#ga7a9318f43afc81c1dbd30a27587ba51d">XIic_WriteReg</a>((BaseAddress), <a class="el" href="group__iic__v3__1.html#gaa27d0e422717f97fac36688f403d320a">XIIC_DGIER_OFFSET</a>, 0)</td></tr>
|
| 85 |
|
|
<tr class="separator:ga17d0df7020d5264d20bbc36d276e276e"><td class="memSeparator" colspan="2"> </td></tr>
|
| 86 |
|
|
<tr class="memitem:ga7071fcf4cf60d65fd862653fa34faa21"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga7071fcf4cf60d65fd862653fa34faa21">XIic_IntrGlobalEnable</a>(BaseAddress)</td></tr>
|
| 87 |
|
|
<tr class="separator:ga7071fcf4cf60d65fd862653fa34faa21"><td class="memSeparator" colspan="2"> </td></tr>
|
| 88 |
|
|
<tr class="memitem:gaa839067df3b55f3181db24ebd8db3187"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gaa839067df3b55f3181db24ebd8db3187">XIic_IsIntrGlobalEnabled</a>(BaseAddress)</td></tr>
|
| 89 |
|
|
<tr class="separator:gaa839067df3b55f3181db24ebd8db3187"><td class="memSeparator" colspan="2"> </td></tr>
|
| 90 |
|
|
<tr class="memitem:ga3bc448908013aceb690c84fdbb7d66a8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga3bc448908013aceb690c84fdbb7d66a8">XIic_WriteIisr</a>(BaseAddress, Status)   <a class="el" href="group__iic__v3__1.html#ga7a9318f43afc81c1dbd30a27587ba51d">XIic_WriteReg</a>((BaseAddress), <a class="el" href="group__iic__v3__1.html#gafe67d115440977750c9a7299eb499798">XIIC_IISR_OFFSET</a>, (Status))</td></tr>
|
| 91 |
|
|
<tr class="separator:ga3bc448908013aceb690c84fdbb7d66a8"><td class="memSeparator" colspan="2"> </td></tr>
|
| 92 |
|
|
<tr class="memitem:gaf69a6487ad62b105aa3bb8d0e25b7fe7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gaf69a6487ad62b105aa3bb8d0e25b7fe7">XIic_ReadIisr</a>(BaseAddress)   <a class="el" href="group__iic__v3__1.html#gab28be58b11c65ecc54fc2f0c300412c1">XIic_ReadReg</a>((BaseAddress), <a class="el" href="group__iic__v3__1.html#gafe67d115440977750c9a7299eb499798">XIIC_IISR_OFFSET</a>)</td></tr>
|
| 93 |
|
|
<tr class="separator:gaf69a6487ad62b105aa3bb8d0e25b7fe7"><td class="memSeparator" colspan="2"> </td></tr>
|
| 94 |
|
|
<tr class="memitem:ga2f926a076e9a6b80bea46664d2e55ee9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga2f926a076e9a6b80bea46664d2e55ee9">XIic_WriteIier</a>(BaseAddress, Enable)   <a class="el" href="group__iic__v3__1.html#ga7a9318f43afc81c1dbd30a27587ba51d">XIic_WriteReg</a>((BaseAddress), <a class="el" href="group__iic__v3__1.html#ga6a6353babc7347287755655c810a1758">XIIC_IIER_OFFSET</a>, (Enable))</td></tr>
|
| 95 |
|
|
<tr class="separator:ga2f926a076e9a6b80bea46664d2e55ee9"><td class="memSeparator" colspan="2"> </td></tr>
|
| 96 |
|
|
<tr class="memitem:gaee17ffc86a8270abeb1319e8c67ccce5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gaee17ffc86a8270abeb1319e8c67ccce5">XIic_ReadIier</a>(BaseAddress)   <a class="el" href="group__iic__v3__1.html#gab28be58b11c65ecc54fc2f0c300412c1">XIic_ReadReg</a>((BaseAddress), <a class="el" href="group__iic__v3__1.html#ga6a6353babc7347287755655c810a1758">XIIC_IIER_OFFSET</a>)</td></tr>
|
| 97 |
|
|
<tr class="separator:gaee17ffc86a8270abeb1319e8c67ccce5"><td class="memSeparator" colspan="2"> </td></tr>
|
| 98 |
|
|
<tr class="memitem:gaf8fa6ffa77af5942fa1dbd1b5a666d55"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gaf8fa6ffa77af5942fa1dbd1b5a666d55">XIic_ClearIisr</a>(BaseAddress, InterruptMask)</td></tr>
|
| 99 |
|
|
<tr class="separator:gaf8fa6ffa77af5942fa1dbd1b5a666d55"><td class="memSeparator" colspan="2"> </td></tr>
|
| 100 |
|
|
<tr class="memitem:ga89d095e79795958bcbc15238a7bbfa32"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga89d095e79795958bcbc15238a7bbfa32">XIic_Send7BitAddress</a>(BaseAddress, SlaveAddress, Operation)</td></tr>
|
| 101 |
|
|
<tr class="separator:ga89d095e79795958bcbc15238a7bbfa32"><td class="memSeparator" colspan="2"> </td></tr>
|
| 102 |
|
|
<tr class="memitem:ga81d32f9fd29736e9f9c7ef345527386b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga81d32f9fd29736e9f9c7ef345527386b">XIic_DynSend7BitAddress</a>(BaseAddress, SlaveAddress, Operation)</td></tr>
|
| 103 |
|
|
<tr class="separator:ga81d32f9fd29736e9f9c7ef345527386b"><td class="memSeparator" colspan="2"> </td></tr>
|
| 104 |
|
|
<tr class="memitem:ga682d21ed5020daa5b5a863bbffb35cc5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga682d21ed5020daa5b5a863bbffb35cc5">XIic_DynSendStartStopAddress</a>(BaseAddress, SlaveAddress, Operation)</td></tr>
|
| 105 |
|
|
<tr class="separator:ga682d21ed5020daa5b5a863bbffb35cc5"><td class="memSeparator" colspan="2"> </td></tr>
|
| 106 |
|
|
<tr class="memitem:ga22446f72b705b950e4b485ab9cdd2ae6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga22446f72b705b950e4b485ab9cdd2ae6">XIic_DynSendStop</a>(BaseAddress, ByteCount)</td></tr>
|
| 107 |
|
|
<tr class="separator:ga22446f72b705b950e4b485ab9cdd2ae6"><td class="memSeparator" colspan="2"> </td></tr>
|
| 108 |
|
|
<tr><td colspan="2"><div class="groupHeader">Register Map</div></td></tr>
|
| 109 |
|
|
<tr><td colspan="2"><div class="groupText"><p>Register offsets for the <a class="el" href="struct_x_iic.html" title="The XIic driver instance data. ">XIic</a> device. </p>
|
| 110 |
|
|
</div></td></tr>
|
| 111 |
|
|
<tr><td colspan="2"><div class="groupHeader">Device Global Interrupt Enable Register masks (CR) mask(s)</div></td></tr>
|
| 112 |
|
|
<tr><td colspan="2"><div class="groupHeader">IIC Device Interrupt Status/Enable (INTR) Register Masks</div></td></tr>
|
| 113 |
|
|
<tr><td colspan="2"><div class="groupText"><p><b> Interrupt Status Register (IISR) </b></p>
|
| 114 |
|
|
<p>This register holds the interrupt status flags for the Spi device.</p>
|
| 115 |
|
|
<p><b> Interrupt Enable Register (IIER) </b></p>
|
| 116 |
|
|
<p>This register is used to enable interrupt sources for the IIC device. Writing a '1' to a bit in this register enables the corresponding Interrupt. Writing a '0' to a bit in this register disables the corresponding Interrupt.</p>
|
| 117 |
|
|
<p>IISR/IIER registers have the same bit definitions and are only defined once. </p>
|
| 118 |
|
|
</div></td></tr>
|
| 119 |
|
|
<tr><td colspan="2"><div class="groupHeader">Reset Register mask</div></td></tr>
|
| 120 |
|
|
<tr><td colspan="2"><div class="groupHeader">Control Register masks (CR) mask(s)</div></td></tr>
|
| 121 |
|
|
<tr class="memitem:gaefca9cb59ce820ea4fbb4c35f5a1fa55"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gaefca9cb59ce820ea4fbb4c35f5a1fa55">XIIC_CR_DIR_IS_TX_MASK</a>   0x00000008</td></tr>
|
| 122 |
|
|
<tr class="separator:gaefca9cb59ce820ea4fbb4c35f5a1fa55"><td class="memSeparator" colspan="2"> </td></tr>
|
| 123 |
|
|
<tr class="memitem:ga79990adaa6f077302644d7b787b19c53"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga79990adaa6f077302644d7b787b19c53">XIIC_CR_NO_ACK_MASK</a>   0x00000010</td></tr>
|
| 124 |
|
|
<tr class="separator:ga79990adaa6f077302644d7b787b19c53"><td class="memSeparator" colspan="2"> </td></tr>
|
| 125 |
|
|
<tr><td colspan="2"><div class="groupHeader">Status Register masks (SR) mask(s)</div></td></tr>
|
| 126 |
|
|
<tr><td colspan="2"><div class="groupHeader">Data Tx Register (DTR) mask(s)</div></td></tr>
|
| 127 |
|
|
<tr><td colspan="2"><div class="groupHeader">Data Rx Register (DRR) mask(s)</div></td></tr>
|
| 128 |
|
|
</table><table class="memberdecls">
|
| 129 |
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
| 130 |
|
|
Functions</h2></td></tr>
|
| 131 |
|
|
<tr class="memitem:ga7a848238d75ff57837afa5a58f11f326"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga7a848238d75ff57837afa5a58f11f326">XIic_Recv</a> (UINTPTR BaseAddress, u8 Address, u8 *BufferPtr, unsigned ByteCount, u8 Option)</td></tr>
|
| 132 |
|
|
<tr class="separator:ga7a848238d75ff57837afa5a58f11f326"><td class="memSeparator" colspan="2"> </td></tr>
|
| 133 |
|
|
<tr class="memitem:ga907c577b53407fb0bfc98d0ca37ee221"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga907c577b53407fb0bfc98d0ca37ee221">XIic_Send</a> (UINTPTR BaseAddress, u8 Address, u8 *BufferPtr, unsigned ByteCount, u8 Option)</td></tr>
|
| 134 |
|
|
<tr class="separator:ga907c577b53407fb0bfc98d0ca37ee221"><td class="memSeparator" colspan="2"> </td></tr>
|
| 135 |
|
|
<tr class="memitem:ga9979fbd483e1c8c495c9eb2bfd7ad6e9"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga9979fbd483e1c8c495c9eb2bfd7ad6e9">XIic_DynRecv</a> (UINTPTR BaseAddress, u8 Address, u8 *BufferPtr, u8 ByteCount)</td></tr>
|
| 136 |
|
|
<tr class="separator:ga9979fbd483e1c8c495c9eb2bfd7ad6e9"><td class="memSeparator" colspan="2"> </td></tr>
|
| 137 |
|
|
<tr class="memitem:gadeaf11cda2466ae1c6036a3de0f52874"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#gadeaf11cda2466ae1c6036a3de0f52874">XIic_DynSend</a> (UINTPTR BaseAddress, u16 Address, u8 *BufferPtr, u8 ByteCount, u8 Option)</td></tr>
|
| 138 |
|
|
<tr class="separator:gadeaf11cda2466ae1c6036a3de0f52874"><td class="memSeparator" colspan="2"> </td></tr>
|
| 139 |
|
|
<tr class="memitem:ga90f3806cf4817250596f6f68f2c066a3"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__iic__v3__1.html#ga90f3806cf4817250596f6f68f2c066a3">XIic_WaitBusFree</a> (UINTPTR BaseAddress)</td></tr>
|
| 140 |
|
|
<tr class="separator:ga90f3806cf4817250596f6f68f2c066a3"><td class="memSeparator" colspan="2"> </td></tr>
|
| 141 |
|
|
</table>
|
| 142 |
|
|
</div><!-- contents -->
|
| 143 |
|
|
</div><!-- doc-content -->
|
| 144 |
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
| 145 |
|
|
<ul>
|
| 146 |
|
|
<li class="footer">Copyright © 2015 Xilinx Inc. All rights reserved.</li>
|
| 147 |
|
|
</ul>
|
| 148 |
|
|
</div>
|
| 149 |
|
|
</body>
|
| 150 |
|
|
</html>
|
