OpenCores
URL https://opencores.org/ocsvn/xenie/xenie/trunk

Subversion Repositories xenie

[/] [xenie/] [trunk/] [examples/] [Eth_example/] [mb_fw/] [drivers/] [iic_v3_4/] [doc/] [html/] [api/] [xiic__slave__example_8c.html] - Blame information for rev 4

Details | Compare with Previous | View Log

Line No. Rev Author Line
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_slave_example.c 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&#160;Structures</span></a></li>
44 
      <li><a href="globals.html"><span>APIs</span></a></li>
45 
      <li><a href="files.html"><span>File&#160;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__slave__example_8c.html','');});
61 
</script>
62 
<div id="doc-content">
63 
<div class="header">
64 
  <div class="summary">
65 
<a href="#func-members">Functions</a>  </div>
66 
  <div class="headertitle">
67 
<div class="title">xiic_slave_example.c File Reference</div>  </div>
68 
</div><!--header-->
69 
<div class="contents">
70 
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
71 
<div class="textblock"><p>The <a class="el" href="group__iic__v3__1.html#ga24873473751e355c82bb074a0d42ddbc" title="This function sends data as a slave on the IIC bus and should not be called until an event has occurr...">XIic_SlaveSend()</a> API is used to transmit the data and <a class="el" href="group__iic__v3__1.html#ga25dc714d97f71049154461e1ff16bcad" title="This function sends data as a slave on the IIC bus and should not be called until an event has occurr...">XIic_SlaveRecv()</a> API is used to receive the data.</p>
72 
<p>The example is tested on ML300/ML310/ML403/ML501 Xilinx boards.</p>
73 
<p>The IIC devices that are present on the Xilinx boards donot support the Master functionality. This example has been tested with an off board external IIC Master device and the IIC device configured as a Slave.</p>
74 
<p>This code assumes that no Operating System is being used.</p>
75 
<dl class="section note"><dt>Note</dt><dd></dd></dl>
76 
<p>None.</p>
77 
<pre>
78 
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date  Changes
79 
----- ---- -------- -----------------------------------------------
80 
1.00a mta  03/01/06 Created.
81 
2.00a ktn  11/17/09 Updated to use the HAL APIs and replaced call to
82 
              XIic_Initialize API with XIic_LookupConfig and
83 
              XIic_CfgInitialize. Some of the macros have been
84 
              renamed in the IIC driver and some renamed macros are
85 
              used in this example.
86 
</pre> </div><table class="memberdecls">
87 
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
88 
Functions</h2></td></tr>
89 
<tr class="memitem:a7e5861a531fd6b82942e66d668dfe54f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiic__slave__example_8c.html#a7e5861a531fd6b82942e66d668dfe54f">IicSlaveExample</a> ()</td></tr>
90 
<tr class="separator:a7e5861a531fd6b82942e66d668dfe54f"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 
<tr class="memitem:a0f41d940d34ed71035e6f6aeb24bdf67"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiic__slave__example_8c.html#a0f41d940d34ed71035e6f6aeb24bdf67">SlaveWriteData</a> (u16 ByteCount)</td></tr>
92 
<tr class="separator:a0f41d940d34ed71035e6f6aeb24bdf67"><td class="memSeparator" colspan="2">&#160;</td></tr>
93 
<tr class="memitem:a91e062862cf2b2bf6c6f8120baa882be"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiic__slave__example_8c.html#a91e062862cf2b2bf6c6f8120baa882be">SlaveReadData</a> (u8 *BufferPtr, u16 ByteCount)</td></tr>
94 
<tr class="separator:a91e062862cf2b2bf6c6f8120baa882be"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiic__slave__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
96 
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 
</table>
98 
<h2 class="groupheader">Function Documentation</h2>
99 
<a class="anchor" id="a7e5861a531fd6b82942e66d668dfe54f"></a>
100 
<div class="memitem">
101 
<div class="memproto">
102 
      <table class="memname">
103 
        <tr>
104 
          <td class="memname">int IicSlaveExample </td>
105 
          <td>(</td>
106 
          <td class="paramname"></td><td>)</td>
107 
          <td></td>
108 
        </tr>
109 
      </table>
110 
</div><div class="memdoc">
111 
 
112 
<p>This function writes and reads the data as a slave. </p>
113 
<p>The IIC master on the bus initiates the transfers.</p>
114 
<dl class="params"><dt>Parameters</dt><dd>
115 
  <table class="params">
116 
    <tr><td class="paramname">None.</td><td></td></tr>
117 
  </table>
118 
  </dd>
119 
</dl>
120 
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
121 
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>
122 
 
123 
<p>References <a class="el" href="struct_x_iic___config.html#ae783f76b6713be6d9b77060d77328102">XIic_Config::BaseAddress</a>, <a class="el" href="xiic__slave__example_8c.html#a91e062862cf2b2bf6c6f8120baa882be">SlaveReadData()</a>, <a class="el" href="xiic__slave__example_8c.html#a0f41d940d34ed71035e6f6aeb24bdf67">SlaveWriteData()</a>, <a class="el" href="group__iic__v3__1.html#gab3f6ec08afcad8f35f9ee2c9e2531366">XII_ADDR_TO_RESPOND_TYPE</a>, <a class="el" href="group__iic__v3__1.html#ga301f08e1fa6e74bf4c2885702bf0ff70">XIic_CfgInitialize()</a>, <a class="el" href="group__iic__v3__1.html#ga1dcc65dd7cb7863bf6769aed5d785304">XIic_LookupConfig()</a>, <a class="el" href="group__iic__v3__1.html#gad944f42c3d9972fc2c986a7eed726297">XIic_SetAddress()</a>, <a class="el" href="group__iic__v3__1.html#ga86b4b2b307df26df2ecac39337c78bed">XIic_SetRecvHandler()</a>, <a class="el" href="group__iic__v3__1.html#gad33428830e9016ef50c1deae59d1e604">XIic_SetSendHandler()</a>, <a class="el" href="group__iic__v3__1.html#gaa74a6884f6dfc826a10768d7d0333991">XIic_SetStatusHandler()</a>, and <a class="el" href="group__iic__v3__1.html#gab7349458691aa658d69fa3ee2875daea">XIic_SlaveInclude()</a>.</p>
124 
 
125 
<p>Referenced by <a class="el" href="xiic__slave__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>
126 
 
127 
</div>
128 
</div>
129 
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
130 
<div class="memitem">
131 
<div class="memproto">
132 
      <table class="memname">
133 
        <tr>
134 
          <td class="memname">int main </td>
135 
          <td>(</td>
136 
          <td class="paramtype">void&#160;</td>
137 
          <td class="paramname"></td><td>)</td>
138 
          <td></td>
139 
        </tr>
140 
      </table>
141 
</div><div class="memdoc">
142 
 
143 
<p>Main function to call the IIC Slave example. </p>
144 
<dl class="params"><dt>Parameters</dt><dd>
145 
  <table class="params">
146 
    <tr><td class="paramname">None.</td><td></td></tr>
147 
  </table>
148 
  </dd>
149 
</dl>
150 
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
151 
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>
152 
 
153 
<p>References <a class="el" href="xiic__slave__example_8c.html#a7e5861a531fd6b82942e66d668dfe54f">IicSlaveExample()</a>.</p>
154 
 
155 
</div>
156 
</div>
157 
<a class="anchor" id="a91e062862cf2b2bf6c6f8120baa882be"></a>
158 
<div class="memitem">
159 
<div class="memproto">
160 
      <table class="memname">
161 
        <tr>
162 
          <td class="memname">int SlaveReadData </td>
163 
          <td>(</td>
164 
          <td class="paramtype">u8 *&#160;</td>
165 
          <td class="paramname"><em>BufferPtr</em>, </td>
166 
        </tr>
167 
        <tr>
168 
          <td class="paramkey"></td>
169 
          <td></td>
170 
          <td class="paramtype">u16&#160;</td>
171 
          <td class="paramname"><em>ByteCount</em>&#160;</td>
172 
        </tr>
173 
        <tr>
174 
          <td></td>
175 
          <td>)</td>
176 
          <td></td><td></td>
177 
        </tr>
178 
      </table>
179 
</div><div class="memdoc">
180 
 
181 
<p>This function reads a buffer of bytes when the IIC Master on the bus writes data to the slave device. </p>
182 
<dl class="params"><dt>Parameters</dt><dd>
183 
  <table class="params">
184 
    <tr><td class="paramname">BufferPtr</td><td>contains the address of the data buffer to be filled. </td></tr>
185 
    <tr><td class="paramname">ByteCount</td><td>contains the number of bytes in the buffer to be read.</td></tr>
186 
  </table>
187 
  </dd>
188 
</dl>
189 
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
190 
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>
191 
 
192 
<p>References <a class="el" href="struct_x_iic.html#a389e4b8500329c37d7835098408b5ed3">XIic::BaseAddress</a>, <a class="el" href="group__iic__v3__1.html#ga17d0df7020d5264d20bbc36d276e276e">XIic_IntrGlobalDisable</a>, <a class="el" href="group__iic__v3__1.html#ga7071fcf4cf60d65fd862653fa34faa21">XIic_IntrGlobalEnable</a>, <a class="el" href="group__iic__v3__1.html#ga25dc714d97f71049154461e1ff16bcad">XIic_SlaveRecv()</a>, <a class="el" href="group__iic__v3__1.html#ga5f4e497710a9c3719f27d40faa74a10f">XIic_Start()</a>, and <a class="el" href="group__iic__v3__1.html#gaaa989e0128057bf11803825d774d496f">XIic_Stop()</a>.</p>
193 
 
194 
<p>Referenced by <a class="el" href="xiic__slave__example_8c.html#a7e5861a531fd6b82942e66d668dfe54f">IicSlaveExample()</a>.</p>
195 
 
196 
</div>
197 
</div>
198 
<a class="anchor" id="a0f41d940d34ed71035e6f6aeb24bdf67"></a>
199 
<div class="memitem">
200 
<div class="memproto">
201 
      <table class="memname">
202 
        <tr>
203 
          <td class="memname">int SlaveWriteData </td>
204 
          <td>(</td>
205 
          <td class="paramtype">u16&#160;</td>
206 
          <td class="paramname"><em>ByteCount</em></td><td>)</td>
207 
          <td></td>
208 
        </tr>
209 
      </table>
210 
</div><div class="memdoc">
211 
 
212 
<p>This function writes a buffer of bytes to the IIC bus when the IIC master initiates a read operation. </p>
213 
<dl class="params"><dt>Parameters</dt><dd>
214 
  <table class="params">
215 
    <tr><td class="paramname">ByteCount</td><td>contains the number of bytes in the buffer to be written.</td></tr>
216 
  </table>
217 
  </dd>
218 
</dl>
219 
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
220 
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>
221 
 
222 
<p>References <a class="el" href="struct_x_iic.html#a389e4b8500329c37d7835098408b5ed3">XIic::BaseAddress</a>, <a class="el" href="group__iic__v3__1.html#gab24f56a64912a6f65c6c87005c9ce892">XII_MASTER_WRITE_EVENT</a>, <a class="el" href="group__iic__v3__1.html#ga50c5aa4448e8993c80ef7b6a87b1aaea">XIic_InterruptHandler()</a>, <a class="el" href="group__iic__v3__1.html#ga17d0df7020d5264d20bbc36d276e276e">XIic_IntrGlobalDisable</a>, <a class="el" href="group__iic__v3__1.html#ga7071fcf4cf60d65fd862653fa34faa21">XIic_IntrGlobalEnable</a>, <a class="el" href="group__iic__v3__1.html#ga24873473751e355c82bb074a0d42ddbc">XIic_SlaveSend()</a>, <a class="el" href="group__iic__v3__1.html#ga5f4e497710a9c3719f27d40faa74a10f">XIic_Start()</a>, and <a class="el" href="group__iic__v3__1.html#gaaa989e0128057bf11803825d774d496f">XIic_Stop()</a>.</p>
223 
 
224 
<p>Referenced by <a class="el" href="xiic__slave__example_8c.html#a7e5861a531fd6b82942e66d668dfe54f">IicSlaveExample()</a>.</p>
225 
 
226 
</div>
227 
</div>
228 
</div><!-- contents -->
229 
</div><!-- doc-content -->
230 
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
231 
  <ul>
232 
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
233 
  </ul>
234 
</div>
235 
</body>
236 
</html>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.