231 lines
15 KiB
HTML
231 lines
15 KiB
HTML
<!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"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>Kinetis SDK v.2.0 API Reference Manual: LPI2C: Low Power I2C Driver</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.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>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
</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: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="fs_logo.gif"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Kinetis SDK v.2.0 API Reference Manual
|
|
 <span id="projectnumber">Rev. 0</span>
|
|
</div>
|
|
<div id="projectbrief">Freescale Semiconductor, Inc.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- 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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>API 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__lpi2c__driver.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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="#groups">Modules</a> |
|
|
<a href="#files">Files</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">LPI2C: Low Power I2C Driver</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
|
|
Modules</h2></td></tr>
|
|
<tr class="memitem:group__lpi2c__freertos__driver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__freertos__driver.html">LPI2C FreeRTOS Driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__lpi2c__master__edma__driver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__master__edma__driver.html">LPI2C Master DMA Driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__lpi2c__master__driver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__master__driver.html">LPI2C Master Driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__lpi2c__slave__edma__driver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__edma__driver.html">LPI2C Slave DMA Driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__lpi2c__slave__driver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html">LPI2C Slave Driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__lpi2c__ucosii__driver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__ucosii__driver.html">LPI2C µCOS/II Driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__lpi2c__ucosiii__driver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__ucosiii__driver.html">LPI2C µCOS/III Driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
|
|
Files</h2></td></tr>
|
|
<tr class="memitem:fsl__lpi2c_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="fsl__lpi2c_8h.html">fsl_lpi2c.h</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga424746e0c18108c3c7233c77899a57c8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__driver.html#ga424746e0c18108c3c7233c77899a57c8">_lpi2c_status</a> { <br/>
|
|
  <a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8af52a270e301641b8855edf3fcc843814">kStatus_LPI2C_Busy</a> = MAKE_STATUS(kStatusGroup_LPI2C, 0),
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8a6603ec1135f58532c9d4accc3661bc27">kStatus_LPI2C_Idle</a> = MAKE_STATUS(kStatusGroup_LPI2C, 1),
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8a75dbc01ed590c24e787fadb97ba2f684">kStatus_LPI2C_Nak</a> = MAKE_STATUS(kStatusGroup_LPI2C, 2),
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8a5b3634e1fedb0ad8cc38476aac29477e">kStatus_LPI2C_FifoError</a> = MAKE_STATUS(kStatusGroup_LPI2C, 3),
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8aa08b2b2938831610ff303e2415291be6">kStatus_LPI2C_BitError</a> = MAKE_STATUS(kStatusGroup_LPI2C, 4),
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8a5169d7e655df8bde3b4fc6d49ae8777a">kStatus_LPI2C_ArbitrationLost</a> = MAKE_STATUS(kStatusGroup_LPI2C, 5),
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8aa8c558fc024cbde751d7861ea6efca78">kStatus_LPI2C_PinLowTimeout</a>,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8aa301f3640e63a3d3d951429b9b7ee866">kStatus_LPI2C_NoTransferInProgress</a>,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8a14d70db977f150497fd4a9d232dc2cd8">kStatus_LPI2C_DmaRequestFail</a> = MAKE_STATUS(kStatusGroup_LPI2C, 7)
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga424746e0c18108c3c7233c77899a57c8"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C status return codes. <a href="group__lpi2c__driver.html#ga424746e0c18108c3c7233c77899a57c8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga424746e0c18108c3c7233c77899a57c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Driver version</h2></td></tr>
|
|
<tr class="memitem:gad5469acd31ed336234c60b02cf7c424a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__driver.html#gad5469acd31ed336234c60b02cf7c424a">FSL_LPI2C_DRIVER_VERSION</a>   (<a class="el" href="group__flash__driver.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 0))</td></tr>
|
|
<tr class="memdesc:gad5469acd31ed336234c60b02cf7c424a"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C driver version 2.1.0. <a href="#gad5469acd31ed336234c60b02cf7c424a">More...</a><br/></td></tr>
|
|
<tr class="separator:gad5469acd31ed336234c60b02cf7c424a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="gad5469acd31ed336234c60b02cf7c424a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_LPI2C_DRIVER_VERSION   (<a class="el" href="group__flash__driver.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 0))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga424746e0c18108c3c7233c77899a57c8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__lpi2c__driver.html#ga424746e0c18108c3c7233c77899a57c8">_lpi2c_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga424746e0c18108c3c7233c77899a57c8af52a270e301641b8855edf3fcc843814"></a>kStatus_LPI2C_Busy</em> </td><td class="fielddoc">
|
|
<p>The master is already performing a transfer. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga424746e0c18108c3c7233c77899a57c8a6603ec1135f58532c9d4accc3661bc27"></a>kStatus_LPI2C_Idle</em> </td><td class="fielddoc">
|
|
<p>The slave driver is idle. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga424746e0c18108c3c7233c77899a57c8a75dbc01ed590c24e787fadb97ba2f684"></a>kStatus_LPI2C_Nak</em> </td><td class="fielddoc">
|
|
<p>The slave device sent a NAK in response to a byte. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga424746e0c18108c3c7233c77899a57c8a5b3634e1fedb0ad8cc38476aac29477e"></a>kStatus_LPI2C_FifoError</em> </td><td class="fielddoc">
|
|
<p>FIFO under run or overrun. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga424746e0c18108c3c7233c77899a57c8aa08b2b2938831610ff303e2415291be6"></a>kStatus_LPI2C_BitError</em> </td><td class="fielddoc">
|
|
<p>Transferred bit was not seen on the bus. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga424746e0c18108c3c7233c77899a57c8a5169d7e655df8bde3b4fc6d49ae8777a"></a>kStatus_LPI2C_ArbitrationLost</em> </td><td class="fielddoc">
|
|
<p>Arbitration lost error. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga424746e0c18108c3c7233c77899a57c8aa8c558fc024cbde751d7861ea6efca78"></a>kStatus_LPI2C_PinLowTimeout</em> </td><td class="fielddoc">
|
|
<p>SCL or SDA were held low longer than the timeout. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga424746e0c18108c3c7233c77899a57c8aa301f3640e63a3d3d951429b9b7ee866"></a>kStatus_LPI2C_NoTransferInProgress</em> </td><td class="fielddoc">
|
|
<p>Attempt to abort a transfer when one is not in progress. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga424746e0c18108c3c7233c77899a57c8a14d70db977f150497fd4a9d232dc2cd8"></a>kStatus_LPI2C_DmaRequestFail</em> </td><td class="fielddoc">
|
|
<p>DMA request failed. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.5-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul class="foot">
|
|
<li class="footer">© 2016 NXP Semiconductors. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|