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__selftest__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_selftest_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__selftest__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_selftest_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"><dl class="section note"><dt>Note</dt><dd></dd></dl>
72 
<p>None</p>
73 
<pre>
74 
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date  Changes
75 
----- ---- -------- -----------------------------------------------
76 
1.00a sv   05/09/05 Initial release for TestApp integration.
77 
2.00a sdm  09/22/09 Updated to use the HAL APIs, replaced call to
78 
              XIic_Initialize API with XIic_LookupConfig and
79 
              XIic_CfgInitialize. Minor changes made as per
80 
              coding guidelines.
81 
</pre> </div><table class="memberdecls">
82 
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
83 
Functions</h2></td></tr>
84 
<tr class="memitem:a224c2ffaa2e5f65cbab83fd243077048"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiic__selftest__example_8c.html#a224c2ffaa2e5f65cbab83fd243077048">IicSelfTestExample</a> (u16 DeviceId)</td></tr>
85 
<tr class="separator:a224c2ffaa2e5f65cbab83fd243077048"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiic__selftest__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
87 
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 
</table>
89 
<h2 class="groupheader">Function Documentation</h2>
90 
<a class="anchor" id="a224c2ffaa2e5f65cbab83fd243077048"></a>
91 
<div class="memitem">
92 
<div class="memproto">
93 
      <table class="memname">
94 
        <tr>
95 
          <td class="memname">int IicSelfTestExample </td>
96 
          <td>(</td>
97 
          <td class="paramtype">u16&#160;</td>
98 
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
99 
          <td></td>
100 
        </tr>
101 
      </table>
102 
</div><div class="memdoc">
103 
 
104 
<p>This function does a selftest on the IIC device and <a class="el" href="struct_x_iic.html" title="The XIic driver instance data. ">XIic</a> driver as an example. </p>
105 
<dl class="params"><dt>Parameters</dt><dd>
106 
  <table class="params">
107 
    <tr><td class="paramname">DeviceId</td><td>is the XPAR_&lt;IIC_instance&gt;_DEVICE_ID value from xparameters.h.</td></tr>
108 
  </table>
109 
  </dd>
110 
</dl>
111 
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, XST_FAILURE if unsuccessful.</dd></dl>
112 
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>
113 
 
114 
<p>References <a class="el" href="struct_x_iic___config.html#ae783f76b6713be6d9b77060d77328102">XIic_Config::BaseAddress</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>, and <a class="el" href="group__iic__v3__1.html#ga0a4d9b646c26bcf932561699d69d52b1">XIic_SelfTest()</a>.</p>
115 
 
116 
<p>Referenced by <a class="el" href="xiic__selftest__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>
117 
 
118 
</div>
119 
</div>
120 
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
121 
<div class="memitem">
122 
<div class="memproto">
123 
      <table class="memname">
124 
        <tr>
125 
          <td class="memname">int main </td>
126 
          <td>(</td>
127 
          <td class="paramtype">void&#160;</td>
128 
          <td class="paramname"></td><td>)</td>
129 
          <td></td>
130 
        </tr>
131 
      </table>
132 
</div><div class="memdoc">
133 
 
134 
<p>Main function to call the example. </p>
135 
<p>This function is not included if the example is generated from the TestAppGen test tool.</p>
136 
<dl class="params"><dt>Parameters</dt><dd>
137 
  <table class="params">
138 
    <tr><td class="paramname">None.</td><td></td></tr>
139 
  </table>
140 
  </dd>
141 
</dl>
142 
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, XST_FAILURE if unsuccessful.</dd></dl>
143 
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>
144 
 
145 
<p>References <a class="el" href="xiic__selftest__example_8c.html#a224c2ffaa2e5f65cbab83fd243077048">IicSelfTestExample()</a>.</p>
146 
 
147 
</div>
148 
</div>
149 
</div><!-- contents -->
150 
</div><!-- doc-content -->
151 
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
152 
  <ul>
153 
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
154 
  </ul>
155 
</div>
156 
</body>
157 
</html>

powered by: WebSVN 2.1.0

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