begriffs open source - cmsis/blob - dev/v6.0.0-dev35/Driver/html/group__i2c__control__codes.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Driver: I2C Control Codes</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Driver
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this);
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__i2c__control__codes.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#define-members">Macros</a>  </div>
 132   <div class="headertitle"><div class="title">I2C Control Codes<div class="ingroups"><a class="el" href="group__i2c__interface__gr.html">I2C Interface</a> &raquo; <a class="el" href="group__i2c__control__gr.html">I2C Control Codes</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Specify operation parameters and various controls.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <tr class="memitem:ga69d130b9f8aa34d6df5334ab67c74307"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__codes.html#ga69d130b9f8aa34d6df5334ab67c74307">ARM_I2C_OWN_ADDRESS</a>&#160;&#160;&#160;(0x01UL)</td></tr>
 142 <tr class="memdesc:ga69d130b9f8aa34d6df5334ab67c74307"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Own Slave Address; arg = address.  <br /></td></tr>
 143 <tr class="separator:ga69d130b9f8aa34d6df5334ab67c74307"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga35733133237d65146abd9449f5353a7f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__codes.html#ga35733133237d65146abd9449f5353a7f">ARM_I2C_BUS_SPEED</a>&#160;&#160;&#160;(0x02UL)</td></tr>
 145 <tr class="memdesc:ga35733133237d65146abd9449f5353a7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Bus Speed; arg = speed.  <br /></td></tr>
 146 <tr class="separator:ga35733133237d65146abd9449f5353a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:gadacf04578770faca4b3eaae34b2c5f03"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__codes.html#gadacf04578770faca4b3eaae34b2c5f03">ARM_I2C_BUS_CLEAR</a>&#160;&#160;&#160;(0x03UL)</td></tr>
 148 <tr class="memdesc:gadacf04578770faca4b3eaae34b2c5f03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute Bus clear: send nine clock pulses.  <br /></td></tr>
 149 <tr class="separator:gadacf04578770faca4b3eaae34b2c5f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ga661e91aaa642d10ba80e3cc72f263040"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__control__codes.html#ga661e91aaa642d10ba80e3cc72f263040">ARM_I2C_ABORT_TRANSFER</a>&#160;&#160;&#160;(0x04UL)</td></tr>
 151 <tr class="memdesc:ga661e91aaa642d10ba80e3cc72f263040"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort Master/Slave Transmit/Receive.  <br /></td></tr>
 152 <tr class="separator:ga661e91aaa642d10ba80e3cc72f263040"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table>
 154 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 155 <p>Specify operation parameters and various controls. </p>
 156 <h2 class="groupheader">Macro Definition Documentation</h2>
 157 <a id="ga69d130b9f8aa34d6df5334ab67c74307" name="ga69d130b9f8aa34d6df5334ab67c74307"></a>
 158 <h2 class="memtitle"><span class="permalink"><a href="#ga69d130b9f8aa34d6df5334ab67c74307">&#9670;&#160;</a></span>ARM_I2C_OWN_ADDRESS</h2>
 159
 160 <div class="memitem">
 161 <div class="memproto">
 162       <table class="memname">
 163         <tr>
 164           <td class="memname">#define ARM_I2C_OWN_ADDRESS&#160;&#160;&#160;(0x01UL)</td>
 165         </tr>
 166       </table>
 167 </div><div class="memdoc">
 168
 169 <p>Set Own Slave Address; arg = address. </p>
 170 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface.">ARM_I2C_Control</a> </dd></dl>
 171
 172 </div>
 173 </div>
 174 <a id="ga35733133237d65146abd9449f5353a7f" name="ga35733133237d65146abd9449f5353a7f"></a>
 175 <h2 class="memtitle"><span class="permalink"><a href="#ga35733133237d65146abd9449f5353a7f">&#9670;&#160;</a></span>ARM_I2C_BUS_SPEED</h2>
 176
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">#define ARM_I2C_BUS_SPEED&#160;&#160;&#160;(0x02UL)</td>
 182         </tr>
 183       </table>
 184 </div><div class="memdoc">
 185
 186 <p>Set Bus Speed; arg = speed. </p>
 187 <p>Speed is specified using the following values: <a class="el" href="group__i2c__bus__speed__ctrls.html">I2C Bus Speed</a> </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface.">ARM_I2C_Control</a> </dd></dl>
 188
 189 </div>
 190 </div>
 191 <a id="gadacf04578770faca4b3eaae34b2c5f03" name="gadacf04578770faca4b3eaae34b2c5f03"></a>
 192 <h2 class="memtitle"><span class="permalink"><a href="#gadacf04578770faca4b3eaae34b2c5f03">&#9670;&#160;</a></span>ARM_I2C_BUS_CLEAR</h2>
 193
 194 <div class="memitem">
 195 <div class="memproto">
 196       <table class="memname">
 197         <tr>
 198           <td class="memname">#define ARM_I2C_BUS_CLEAR&#160;&#160;&#160;(0x03UL)</td>
 199         </tr>
 200       </table>
 201 </div><div class="memdoc">
 202
 203 <p>Execute Bus clear: send nine clock pulses. </p>
 204 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface.">ARM_I2C_Control</a> </dd></dl>
 205
 206 </div>
 207 </div>
 208 <a id="ga661e91aaa642d10ba80e3cc72f263040" name="ga661e91aaa642d10ba80e3cc72f263040"></a>
 209 <h2 class="memtitle"><span class="permalink"><a href="#ga661e91aaa642d10ba80e3cc72f263040">&#9670;&#160;</a></span>ARM_I2C_ABORT_TRANSFER</h2>
 210
 211 <div class="memitem">
 212 <div class="memproto">
 213       <table class="memname">
 214         <tr>
 215           <td class="memname">#define ARM_I2C_ABORT_TRANSFER&#160;&#160;&#160;(0x04UL)</td>
 216         </tr>
 217       </table>
 218 </div><div class="memdoc">
 219
 220 <p>Abort Master/Slave Transmit/Receive. </p>
 221 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__i2c__interface__gr.html#ga828f5fa289d065675ef78a9a73d129dc" title="Control I2C Interface.">ARM_I2C_Control</a> </dd></dl>
 222
 223 </div>
 224 </div>
 225 </div><!-- contents -->
 226 </div><!-- doc-content -->
 227 <!-- start footer part -->
 228 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 229   <ul>
 230     <li class="footer">
 231       <script type="text/javascript">
 232         <!--
 233         writeFooter.call(this);
 234         //-->
 235       </script>
 236     </li>
 237   </ul>
 238 </div>
 239 </body>
 240 </html>