]> begriffs open source - cmsis-driver-validation/blob - docs/html/_d_v___i2_c_8c.html
added missing index file for online docs
[cmsis-driver-validation] / docs / html / _d_v___i2_c_8c.html
1 <!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 <title>C:/Projects/ARMGit/CMSIS-Driver_Validation/Source/DV_I2C.c File Reference</title>
7 <title>CMSIS-Driver Validation: C:/Projects/ARMGit/CMSIS-Driver_Validation/Source/DV_I2C.c File Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="drv.css" rel="stylesheet" type="text/css" />
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="printComponentTabs.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtree.js"></script>
16 <script type="text/javascript">
17   $(document).ready(initResizable);
18   $(window).load(resizeHeight);
19 </script>
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23   $(document).ready(function() { searchBox.OnSelectItem(0); });
24 </script>
25 <link href="stylsheetf" rel="stylesheet" type="text/css" />
26 </head>
27 <body>
28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29 <div id="titlearea">
30 <table cellspacing="0" cellpadding="0">
31  <tbody>
32  <tr style="height: 46px;">
33   <td id="projectlogo"><img alt="Logo" src="keilarm.png"/></td>
34   <td style="padding-left: 0.5em;">
35    <div id="projectname">CMSIS-Driver Validation
36    &#160;<span id="projectnumber">Version 1.2.0</span>
37    </div>
38    <div id="projectbrief">Driver Validation</div>
39   </td>
40  </tr>
41  </tbody>
42 </table>
43 </div>
44 <!-- end header part -->
45 <div id="DRVnav" class="tabs1">
46     <ul class="tablist">
47       <script type="text/javascript">
48                 <!--
49                 writeComponentTabs.call(this);
50                 //-->
51       </script>
52           </ul>
53 </div>
54 <!-- Generated by Doxygen 1.8.6 -->
55 <script type="text/javascript">
56 var searchBox = new SearchBox("searchBox", "search",false,'Search');
57 </script>
58   <div id="navrow1" class="tabs">
59     <ul class="tablist">
60       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
61       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
62       <li><a href="modules.html"><span>Reference</span></a></li>
63       <li>
64         <div id="MSearchBox" class="MSearchBoxInactive">
65         <span class="left">
66           <img id="MSearchSelect" src="search/mag_sel.png"
67                onmouseover="return searchBox.OnSearchSelectShow()"
68                onmouseout="return searchBox.OnSearchSelectHide()"
69                alt=""/>
70           <input type="text" id="MSearchField" value="Search" accesskey="S"
71                onfocus="searchBox.OnSearchFieldFocus(true)" 
72                onblur="searchBox.OnSearchFieldFocus(false)" 
73                onkeyup="searchBox.OnSearchFieldChange(event)"/>
74           </span><span class="right">
75             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
76           </span>
77         </div>
78       </li>
79     </ul>
80   </div>
81 </div><!-- top -->
82 <div id="side-nav" class="ui-resizable side-nav-resizable">
83   <div id="nav-tree">
84     <div id="nav-tree-contents">
85       <div id="nav-sync" class="sync"></div>
86     </div>
87   </div>
88   <div id="splitbar" style="-moz-user-select:none;" 
89        class="ui-resizable-handle">
90   </div>
91 </div>
92 <script type="text/javascript">
93 $(document).ready(function(){initNavTree('_d_v___i2_c_8c.html','');});
94 </script>
95 <div id="doc-content">
96 <!-- window showing the filter options -->
97 <div id="MSearchSelectWindow"
98      onmouseover="return searchBox.OnSearchSelectShow()"
99      onmouseout="return searchBox.OnSearchSelectHide()"
100      onkeydown="return searchBox.OnSearchSelectKey(event)">
101 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>
102
103 <!-- iframe showing the search results (closed by default) -->
104 <div id="MSearchResultsWindow">
105 <iframe src="javascript:void(0)" frameborder="0" 
106         name="MSearchResults" id="MSearchResults">
107 </iframe>
108 </div>
109
110 <div class="header">
111   <div class="summary">
112 <a href="#func-members">Functions</a> &#124;
113 <a href="#var-members">Variables</a>  </div>
114   <div class="headertitle">
115 <div class="title">DV_I2C.c File Reference</div>  </div>
116 </div><!--header-->
117 <div class="contents">
118 <div class="textblock"><code>#include &quot;cmsis_dv.h&quot;</code><br/>
119 <code>#include &quot;DV_Config.h&quot;</code><br/>
120 <code>#include &quot;DV_Framework.h&quot;</code><br/>
121 <code>#include &quot;Driver_I2C.h&quot;</code><br/>
122 <code>#include &lt;stdio.h&gt;</code><br/>
123 <code>#include &lt;stdlib.h&gt;</code><br/>
124 <code>#include &lt;string.h&gt;</code><br/>
125 </div><table class="memberdecls">
126 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
127 Functions</h2></td></tr>
128 <tr class="memitem:ae68ec77720fb50ac15862f1c200dcbde"><td class="memItemLeft" align="right" valign="top">ARM_DRIVER_I2C&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_d_v___i2_c_8c.html#ae68ec77720fb50ac15862f1c200dcbde">CREATE_SYMBOL</a> (Driver_I2C, DRV_I2C)</td></tr>
129 <tr class="separator:ae68ec77720fb50ac15862f1c200dcbde"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <tr class="memitem:aded65ff5f605855780a73d5dad941930"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_d_v___i2_c_8c.html#aded65ff5f605855780a73d5dad941930">I2C_DrvEvent</a> (uint32_t event)</td></tr>
131 <tr class="separator:aded65ff5f605855780a73d5dad941930"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 <tr class="memitem:ga2c6a116bb2cb38f7b5350a2fbf75bcad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__funcs.html#ga2c6a116bb2cb38f7b5350a2fbf75bcad">I2C_GetCapabilities</a> (void)</td></tr>
133 <tr class="memdesc:ga2c6a116bb2cb38f7b5350a2fbf75bcad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_GetCapabilities.  <a href="group__i2c__funcs.html#ga2c6a116bb2cb38f7b5350a2fbf75bcad">More...</a><br/></td></tr>
134 <tr class="separator:ga2c6a116bb2cb38f7b5350a2fbf75bcad"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:ga09f2e10deffff7b99ddf09609e097b60"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__funcs.html#ga09f2e10deffff7b99ddf09609e097b60">I2C_Initialization</a> (void)</td></tr>
136 <tr class="memdesc:ga09f2e10deffff7b99ddf09609e097b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_Initialization.  <a href="group__i2c__funcs.html#ga09f2e10deffff7b99ddf09609e097b60">More...</a><br/></td></tr>
137 <tr class="separator:ga09f2e10deffff7b99ddf09609e097b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:gaf35718402630c8b5f21c87a9c979d2e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__funcs.html#gaf35718402630c8b5f21c87a9c979d2e1">I2C_CheckInvalidInit</a> (void)</td></tr>
139 <tr class="memdesc:gaf35718402630c8b5f21c87a9c979d2e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_CheckInvalidInit.  <a href="group__i2c__funcs.html#gaf35718402630c8b5f21c87a9c979d2e1">More...</a><br/></td></tr>
140 <tr class="separator:gaf35718402630c8b5f21c87a9c979d2e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:ga2d1b9fddc155cb2984f280b07ee7d76f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__funcs.html#ga2d1b9fddc155cb2984f280b07ee7d76f">I2C_PowerControl</a> (void)</td></tr>
142 <tr class="memdesc:ga2d1b9fddc155cb2984f280b07ee7d76f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_PowerControl.  <a href="group__i2c__funcs.html#ga2d1b9fddc155cb2984f280b07ee7d76f">More...</a><br/></td></tr>
143 <tr class="separator:ga2d1b9fddc155cb2984f280b07ee7d76f"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:ga8e2f94421465a76d51223866616c7b71"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__funcs.html#ga8e2f94421465a76d51223866616c7b71">I2C_SetBusSpeed</a> (void)</td></tr>
145 <tr class="memdesc:ga8e2f94421465a76d51223866616c7b71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_SetBusSpeed.  <a href="group__i2c__funcs.html#ga8e2f94421465a76d51223866616c7b71">More...</a><br/></td></tr>
146 <tr class="separator:ga8e2f94421465a76d51223866616c7b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:gac0486a6829258541dbbaa3636e764203"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__funcs.html#gac0486a6829258541dbbaa3636e764203">I2C_SetOwnAddress</a> (void)</td></tr>
148 <tr class="memdesc:gac0486a6829258541dbbaa3636e764203"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_SetOwnAddress.  <a href="group__i2c__funcs.html#gac0486a6829258541dbbaa3636e764203">More...</a><br/></td></tr>
149 <tr class="separator:gac0486a6829258541dbbaa3636e764203"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:gac83fdb0bd0691665d45baf41c4b8f592"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__funcs.html#gac83fdb0bd0691665d45baf41c4b8f592">I2C_BusClear</a> (void)</td></tr>
151 <tr class="memdesc:gac83fdb0bd0691665d45baf41c4b8f592"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_BusClear.  <a href="group__i2c__funcs.html#gac83fdb0bd0691665d45baf41c4b8f592">More...</a><br/></td></tr>
152 <tr class="separator:gac83fdb0bd0691665d45baf41c4b8f592"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:gacb9a0dd8262bfc61e8c20a5ad346cd20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__funcs.html#gacb9a0dd8262bfc61e8c20a5ad346cd20">I2C_AbortTransfer</a> (void)</td></tr>
154 <tr class="memdesc:gacb9a0dd8262bfc61e8c20a5ad346cd20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_AbortTransfer.  <a href="group__i2c__funcs.html#gacb9a0dd8262bfc61e8c20a5ad346cd20">More...</a><br/></td></tr>
155 <tr class="separator:gacb9a0dd8262bfc61e8c20a5ad346cd20"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 </table><table class="memberdecls">
157 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
158 Variables</h2></td></tr>
159 <tr class="memitem:a3059d503b9adf6e71af4dcc6a04b26e9"><td class="memItemLeft" align="right" valign="top">static ARM_DRIVER_I2C *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_d_v___i2_c_8c.html#a3059d503b9adf6e71af4dcc6a04b26e9">drv</a> = &amp;<a class="el" href="_d_v___u_s_b_h_8c.html#ad61f68c22694705aea6cc26b439e9358">CREATE_SYMBOL</a>(Driver_I2C, DRV_I2C)</td></tr>
160 <tr class="separator:a3059d503b9adf6e71af4dcc6a04b26e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <tr class="memitem:adedf5e7ac65bd5f1408c1152f00c938a"><td class="memItemLeft" align="right" valign="top">static ARM_I2C_CAPABILITIES&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_d_v___i2_c_8c.html#adedf5e7ac65bd5f1408c1152f00c938a">capab</a></td></tr>
162 <tr class="separator:adedf5e7ac65bd5f1408c1152f00c938a"><td class="memSeparator" colspan="2">&#160;</td></tr>
163 <tr class="memitem:ab5135011ec160c4988c8469051a56838"><td class="memItemLeft" align="right" valign="top">static uint8_t volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_d_v___i2_c_8c.html#ab5135011ec160c4988c8469051a56838">Event</a></td></tr>
164 <tr class="separator:ab5135011ec160c4988c8469051a56838"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 </table>
166 <h2 class="groupheader">Function Documentation</h2>
167 <a class="anchor" id="ae68ec77720fb50ac15862f1c200dcbde"></a>
168 <div class="memitem">
169 <div class="memproto">
170       <table class="memname">
171         <tr>
172           <td class="memname">ARM_DRIVER_I2C CREATE_SYMBOL </td>
173           <td>(</td>
174           <td class="paramtype">Driver_I2C&#160;</td>
175           <td class="paramname">, </td>
176         </tr>
177         <tr>
178           <td class="paramkey"></td>
179           <td></td>
180           <td class="paramtype">DRV_I2C&#160;</td>
181           <td class="paramname">&#160;</td>
182         </tr>
183         <tr>
184           <td></td>
185           <td>)</td>
186           <td></td><td></td>
187         </tr>
188       </table>
189 </div><div class="memdoc">
190
191 </div>
192 </div>
193 <a class="anchor" id="aded65ff5f605855780a73d5dad941930"></a>
194 <div class="memitem">
195 <div class="memproto">
196 <table class="mlabels">
197   <tr>
198   <td class="mlabels-left">
199       <table class="memname">
200         <tr>
201           <td class="memname">static void I2C_DrvEvent </td>
202           <td>(</td>
203           <td class="paramtype">uint32_t&#160;</td>
204           <td class="paramname"><em>event</em></td><td>)</td>
205           <td></td>
206         </tr>
207       </table>
208   </td>
209   <td class="mlabels-right">
210 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
211   </tr>
212 </table>
213 </div><div class="memdoc">
214
215 </div>
216 </div>
217 <h2 class="groupheader">Variable Documentation</h2>
218 <a class="anchor" id="adedf5e7ac65bd5f1408c1152f00c938a"></a>
219 <div class="memitem">
220 <div class="memproto">
221 <table class="mlabels">
222   <tr>
223   <td class="mlabels-left">
224       <table class="memname">
225         <tr>
226           <td class="memname">ARM_I2C_CAPABILITIES capab</td>
227         </tr>
228       </table>
229   </td>
230   <td class="mlabels-right">
231 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
232   </tr>
233 </table>
234 </div><div class="memdoc">
235
236 </div>
237 </div>
238 <a class="anchor" id="a3059d503b9adf6e71af4dcc6a04b26e9"></a>
239 <div class="memitem">
240 <div class="memproto">
241 <table class="mlabels">
242   <tr>
243   <td class="mlabels-left">
244       <table class="memname">
245         <tr>
246           <td class="memname">ARM_DRIVER_I2C* drv = &amp;<a class="el" href="_d_v___u_s_b_h_8c.html#ad61f68c22694705aea6cc26b439e9358">CREATE_SYMBOL</a>(Driver_I2C, DRV_I2C)</td>
247         </tr>
248       </table>
249   </td>
250   <td class="mlabels-right">
251 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
252   </tr>
253 </table>
254 </div><div class="memdoc">
255
256 </div>
257 </div>
258 <a class="anchor" id="ab5135011ec160c4988c8469051a56838"></a>
259 <div class="memitem">
260 <div class="memproto">
261 <table class="mlabels">
262   <tr>
263   <td class="mlabels-left">
264       <table class="memname">
265         <tr>
266           <td class="memname">uint8_t volatile Event</td>
267         </tr>
268       </table>
269   </td>
270   <td class="mlabels-right">
271 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
272   </tr>
273 </table>
274 </div><div class="memdoc">
275
276 </div>
277 </div>
278 </div><!-- contents -->
279 </div><!-- doc-content -->
280 <!-- start footer part -->
281 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
282   <ul>
283     <li class="navelem"><a class="el" href="dir_74389ed8173ad57b461b9d623a1f3867.html">Source</a></li><li class="navelem"><a class="el" href="_d_v___i2_c_8c.html">DV_I2C.c</a></li>
284     <li class="footer">Generated on Thu Feb 21 2019 15:24:48 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
285         <!--
286     <a href="http://www.doxygen.org/index.html">
287     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
288         -->
289         </li>
290   </ul>
291 </div>
292 </body>
293 </html>