ghoscht/xmclib
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
xmclib/CMSIS/Documentation/Driver/html/group__i2c__control__codes.html

214 lines
11 KiB
HTML
Raw Normal View History

Init xmclib
2024-10-17 17:09:59 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>I2C Control Codes</title>
<title>CMSIS-Driver: I2C Control Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-Driver
&#160;<span id="projectnumber">Version 2.05</span>
</div>
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
<li><a href="modules.html"><span>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__i2c__control__codes.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">I2C Control Codes<div class="ingroups"><a class="el" href="group__i2c__control__gr.html">I2C Control Codes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Specify operation parameters and various controls.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<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;(0x01)</td></tr>
<tr class="memdesc:ga69d130b9f8aa34d6df5334ab67c74307"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Own Slave Address; arg = address. <a href="#ga69d130b9f8aa34d6df5334ab67c74307">More...</a><br/></td></tr>
<tr class="separator:ga69d130b9f8aa34d6df5334ab67c74307"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x02)</td></tr>
<tr class="memdesc:ga35733133237d65146abd9449f5353a7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Bus Speed; arg = speed. <a href="#ga35733133237d65146abd9449f5353a7f">More...</a><br/></td></tr>
<tr class="separator:ga35733133237d65146abd9449f5353a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x03)</td></tr>
<tr class="memdesc:gadacf04578770faca4b3eaae34b2c5f03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute Bus clear: send nine clock pulses. <a href="#gadacf04578770faca4b3eaae34b2c5f03">More...</a><br/></td></tr>
<tr class="separator:gadacf04578770faca4b3eaae34b2c5f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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;(0x04)</td></tr>
<tr class="memdesc:ga661e91aaa642d10ba80e3cc72f263040"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort Master/Slave Transmit/Receive. <a href="#ga661e91aaa642d10ba80e3cc72f263040">More...</a><br/></td></tr>
<tr class="separator:ga661e91aaa642d10ba80e3cc72f263040"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Specify operation parameters and various controls. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga69d130b9f8aa34d6df5334ab67c74307"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_OWN_ADDRESS&#160;&#160;&#160;(0x01)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Own Slave Address; arg = address. </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>
</div>
</div>
<a class="anchor" id="ga35733133237d65146abd9449f5353a7f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_BUS_SPEED&#160;&#160;&#160;(0x02)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Bus Speed; arg = speed. </p>
<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>
</div>
</div>
<a class="anchor" id="gadacf04578770faca4b3eaae34b2c5f03"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_BUS_CLEAR&#160;&#160;&#160;(0x03)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute Bus clear: send nine clock pulses. </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>
</div>
</div>
<a class="anchor" id="ga661e91aaa642d10ba80e3cc72f263040"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARM_I2C_ABORT_TRANSFER&#160;&#160;&#160;(0x04)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort Master/Slave Transmit/Receive. </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>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Feb 8 2017 10:20:44 for CMSIS-Driver by ARM Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
Reference in a new issue Copy permalink