begriffs open source - cmsis-driver-validation/blob - docs/html/group__i2c__funcs.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>I2C Validation</title>
   7 <title>CMSIS-Driver Validation: I2C Validation</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.3.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('group__i2c__funcs.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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><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>  </div>
 113   <div class="headertitle">
 114 <div class="title">I2C Validation</div>  </div>
 115 </div><!--header-->
 116 <div class="contents">
 117
 118 <p>I2C test cases.
 119 <a href="#details">More...</a></p>
 120 <table class="memberdecls">
 121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 122 Functions</h2></td></tr>
 123 <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>
 124 <tr class="memdesc:ga2c6a116bb2cb38f7b5350a2fbf75bcad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_GetCapabilities.  <a href="#ga2c6a116bb2cb38f7b5350a2fbf75bcad">More...</a><br/></td></tr>
 125 <tr class="separator:ga2c6a116bb2cb38f7b5350a2fbf75bcad"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 <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>
 127 <tr class="memdesc:ga09f2e10deffff7b99ddf09609e097b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_Initialization.  <a href="#ga09f2e10deffff7b99ddf09609e097b60">More...</a><br/></td></tr>
 128 <tr class="separator:ga09f2e10deffff7b99ddf09609e097b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 <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>
 130 <tr class="memdesc:gaf35718402630c8b5f21c87a9c979d2e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_CheckInvalidInit.  <a href="#gaf35718402630c8b5f21c87a9c979d2e1">More...</a><br/></td></tr>
 131 <tr class="separator:gaf35718402630c8b5f21c87a9c979d2e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 132 <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>
 133 <tr class="memdesc:ga2d1b9fddc155cb2984f280b07ee7d76f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_PowerControl.  <a href="#ga2d1b9fddc155cb2984f280b07ee7d76f">More...</a><br/></td></tr>
 134 <tr class="separator:ga2d1b9fddc155cb2984f280b07ee7d76f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <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>
 136 <tr class="memdesc:ga8e2f94421465a76d51223866616c7b71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_SetBusSpeed.  <a href="#ga8e2f94421465a76d51223866616c7b71">More...</a><br/></td></tr>
 137 <tr class="separator:ga8e2f94421465a76d51223866616c7b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <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>
 139 <tr class="memdesc:gac0486a6829258541dbbaa3636e764203"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_SetOwnAddress.  <a href="#gac0486a6829258541dbbaa3636e764203">More...</a><br/></td></tr>
 140 <tr class="separator:gac0486a6829258541dbbaa3636e764203"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <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>
 142 <tr class="memdesc:gac83fdb0bd0691665d45baf41c4b8f592"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_BusClear.  <a href="#gac83fdb0bd0691665d45baf41c4b8f592">More...</a><br/></td></tr>
 143 <tr class="separator:gac83fdb0bd0691665d45baf41c4b8f592"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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>
 145 <tr class="memdesc:gacb9a0dd8262bfc61e8c20a5ad346cd20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test case: I2C_AbortTransfer.  <a href="#gacb9a0dd8262bfc61e8c20a5ad346cd20">More...</a><br/></td></tr>
 146 <tr class="separator:gacb9a0dd8262bfc61e8c20a5ad346cd20"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 </table>
 148 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 149 <p>The I2C validation test checks the API interface compliance only. </p>
 150 <h2 class="groupheader">Function Documentation</h2>
 151 <a class="anchor" id="gacb9a0dd8262bfc61e8c20a5ad346cd20"></a>
 152 <div class="memitem">
 153 <div class="memproto">
 154       <table class="memname">
 155         <tr>
 156           <td class="memname">void I2C_AbortTransfer </td>
 157           <td>(</td>
 158           <td class="paramtype">void&#160;</td>
 159           <td class="paramname"></td><td>)</td>
 160           <td></td>
 161         </tr>
 162       </table>
 163 </div><div class="memdoc">
 164 <p>The test case <b>I2C_AbortTransfer</b> verifies the <b>Control</b> function with the sequence:</p>
 165 <ul>
 166 <li>Initialize</li>
 167 <li>Power on</li>
 168 <li>Abort transfer</li>
 169 <li>Power off</li>
 170 <li>Uninitialize </li>
 171 </ul>
 172
 173 </div>
 174 </div>
 175 <a class="anchor" id="gac83fdb0bd0691665d45baf41c4b8f592"></a>
 176 <div class="memitem">
 177 <div class="memproto">
 178       <table class="memname">
 179         <tr>
 180           <td class="memname">void I2C_BusClear </td>
 181           <td>(</td>
 182           <td class="paramtype">void&#160;</td>
 183           <td class="paramname"></td><td>)</td>
 184           <td></td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188 <p>The test case <b>I2C_BusClear</b> verifies the <b>Control</b> function with the sequence:</p>
 189 <ul>
 190 <li>Initialize</li>
 191 <li>Power on</li>
 192 <li>Clear Bus</li>
 193 <li>Power off</li>
 194 <li>Uninitialize </li>
 195 </ul>
 196
 197 </div>
 198 </div>
 199 <a class="anchor" id="gaf35718402630c8b5f21c87a9c979d2e1"></a>
 200 <div class="memitem">
 201 <div class="memproto">
 202       <table class="memname">
 203         <tr>
 204           <td class="memname">void I2C_CheckInvalidInit </td>
 205           <td>(</td>
 206           <td class="paramtype">void&#160;</td>
 207           <td class="paramname"></td><td>)</td>
 208           <td></td>
 209         </tr>
 210       </table>
 211 </div><div class="memdoc">
 212 <p>The test case <b>I2C_CheckInvalidInit</b> verifies the driver behaviour when receiving an invalid initialization sequence:</p>
 213 <ul>
 214 <li><b>Uninitialize</b> </li>
 215 <li><b>PowerControl</b> with Power off</li>
 216 <li><b>PowerControl</b> with Power on</li>
 217 <li><b>Control</b> with bus speed fast</li>
 218 <li><b>PowerControl</b> with Power off</li>
 219 <li><b>Uninitialize</b> </li>
 220 </ul>
 221
 222 </div>
 223 </div>
 224 <a class="anchor" id="ga2c6a116bb2cb38f7b5350a2fbf75bcad"></a>
 225 <div class="memitem">
 226 <div class="memproto">
 227       <table class="memname">
 228         <tr>
 229           <td class="memname">void I2C_GetCapabilities </td>
 230           <td>(</td>
 231           <td class="paramtype">void&#160;</td>
 232           <td class="paramname"></td><td>)</td>
 233           <td></td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237 <p>The test case <b>I2C_GetCapabilities</b> verifies the function <b>GetCapabilities</b>. </p>
 238
 239 </div>
 240 </div>
 241 <a class="anchor" id="ga09f2e10deffff7b99ddf09609e097b60"></a>
 242 <div class="memitem">
 243 <div class="memproto">
 244       <table class="memname">
 245         <tr>
 246           <td class="memname">void I2C_Initialization </td>
 247           <td>(</td>
 248           <td class="paramtype">void&#160;</td>
 249           <td class="paramname"></td><td>)</td>
 250           <td></td>
 251         </tr>
 252       </table>
 253 </div><div class="memdoc">
 254 <p>The test case <b>I2C_Initialization</b> verifies the I2C functions with the sequence:</p>
 255 <ul>
 256 <li><b>Initialize</b> without callback</li>
 257 <li><b>Uninitialize</b> </li>
 258 <li><b>Initialize</b> with callback</li>
 259 <li><b>Uninitialize</b> </li>
 260 </ul>
 261
 262 </div>
 263 </div>
 264 <a class="anchor" id="ga2d1b9fddc155cb2984f280b07ee7d76f"></a>
 265 <div class="memitem">
 266 <div class="memproto">
 267       <table class="memname">
 268         <tr>
 269           <td class="memname">void I2C_PowerControl </td>
 270           <td>(</td>
 271           <td class="paramtype">void&#160;</td>
 272           <td class="paramname"></td><td>)</td>
 273           <td></td>
 274         </tr>
 275       </table>
 276 </div><div class="memdoc">
 277 <p>The test case <b>I2C_PowerControl</b> verifies the <b>PowerControl</b> function with the sequence:</p>
 278 <ul>
 279 <li>Initialize</li>
 280 <li>Power on</li>
 281 <li>Power low</li>
 282 <li>Power off</li>
 283 <li>Uninitialize </li>
 284 </ul>
 285
 286 </div>
 287 </div>
 288 <a class="anchor" id="ga8e2f94421465a76d51223866616c7b71"></a>
 289 <div class="memitem">
 290 <div class="memproto">
 291       <table class="memname">
 292         <tr>
 293           <td class="memname">void I2C_SetBusSpeed </td>
 294           <td>(</td>
 295           <td class="paramtype">void&#160;</td>
 296           <td class="paramname"></td><td>)</td>
 297           <td></td>
 298         </tr>
 299       </table>
 300 </div><div class="memdoc">
 301 <p>The test case <b>I2C_SetBusSpeed</b> verifies the <b>Control</b> function with the sequence:</p>
 302 <ul>
 303 <li>Initialize</li>
 304 <li>Power on</li>
 305 <li>Set bus speed standard</li>
 306 <li>Set bus speed fast</li>
 307 <li>Set bus speed fast plus</li>
 308 <li>Set bus speed high</li>
 309 <li>Power off</li>
 310 <li>Uninitialize </li>
 311 </ul>
 312
 313 </div>
 314 </div>
 315 <a class="anchor" id="gac0486a6829258541dbbaa3636e764203"></a>
 316 <div class="memitem">
 317 <div class="memproto">
 318       <table class="memname">
 319         <tr>
 320           <td class="memname">void I2C_SetOwnAddress </td>
 321           <td>(</td>
 322           <td class="paramtype">void&#160;</td>
 323           <td class="paramname"></td><td>)</td>
 324           <td></td>
 325         </tr>
 326       </table>
 327 </div><div class="memdoc">
 328 <p>The test case <b>I2C_SetOwnAddress</b> verifies the <b>Control</b> function with the sequence:</p>
 329 <ul>
 330 <li>Initialize</li>
 331 <li>Power on</li>
 332 <li>Set slave own address <span class="XML-Token">0x0000</span></li>
 333 <li>Set slave own address <span class="XML-Token">0x0001</span></li>
 334 <li>Set slave own address <span class="XML-Token">0x00FF</span></li>
 335 <li>Set slave own address <span class="XML-Token">0x03FF</span></li>
 336 <li>Power off</li>
 337 <li>Uninitialize </li>
 338 </ul>
 339
 340 </div>
 341 </div>
 342 </div><!-- contents -->
 343 </div><!-- doc-content -->
 344 <!-- start footer part -->
 345 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 346   <ul>
 347     <li class="footer">Generated on Fri Oct 4 2019 14:13:04 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
 348         <!--
 349     <a href="http://www.doxygen.org/index.html">
 350     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 351         -->
 352         </li>
 353   </ul>
 354 </div>
 355 </body>
 356 </html>