1774 lines
108 KiB
HTML
1774 lines
108 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 Slave 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__slave__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="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">LPI2C Slave Driver<div class="ingroups"><a class="el" href="group__lpi2c__driver.html">LPI2C: Low Power I2C Driver</a></div></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="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:structlpi2c__slave__config__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__config__t">lpi2c_slave_config_t</a></td></tr>
|
|
<tr class="memdesc:structlpi2c__slave__config__t"><td class="mdescLeft"> </td><td class="mdescRight">Structure with settings to initialize the LPI2C slave module. <a href="group__lpi2c__slave__driver.html#structlpi2c__slave__config__t">More...</a><br/></td></tr>
|
|
<tr class="separator:structlpi2c__slave__config__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structlpi2c__slave__transfer__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__transfer__t">lpi2c_slave_transfer_t</a></td></tr>
|
|
<tr class="memdesc:structlpi2c__slave__transfer__t"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C slave transfer structure. <a href="group__lpi2c__slave__driver.html#structlpi2c__slave__transfer__t">More...</a><br/></td></tr>
|
|
<tr class="separator:structlpi2c__slave__transfer__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:struct__lpi2c__slave__handle"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#struct__lpi2c__slave__handle">lpi2c_slave_handle_t</a></td></tr>
|
|
<tr class="memdesc:struct__lpi2c__slave__handle"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C slave handle structure. <a href="group__lpi2c__slave__driver.html#struct__lpi2c__slave__handle">More...</a><br/></td></tr>
|
|
<tr class="separator:struct__lpi2c__slave__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga2640285a708842a5e0e7c4c0090a2f58"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga2640285a708842a5e0e7c4c0090a2f58">lpi2c_slave_transfer_callback_t</a> )(LPI2C_Type *base, <a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__transfer__t">lpi2c_slave_transfer_t</a> *transfer, void *userData)</td></tr>
|
|
<tr class="memdesc:ga2640285a708842a5e0e7c4c0090a2f58"><td class="mdescLeft"> </td><td class="mdescRight">Slave event callback function pointer type. <a href="#ga2640285a708842a5e0e7c4c0090a2f58">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2640285a708842a5e0e7c4c0090a2f58"><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:gabd50effc706692c03b42faa72c34269b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#gabd50effc706692c03b42faa72c34269b">_lpi2c_slave_flags</a> { <br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba80486f66e12276c945b8813269b90c0e">kLPI2C_SlaveTxReadyFlag</a> = LPI2C_SSR_TDF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba01265ce6645e4a978b823b1f130a419f">kLPI2C_SlaveRxReadyFlag</a> = LPI2C_SSR_RDF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269baf34a60fee419e0b3d387b353a38b4772">kLPI2C_SlaveAddressValidFlag</a> = LPI2C_SSR_AVF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba37386d33a28e37352a8e3151f027fdff">kLPI2C_SlaveTransmitAckFlag</a> = LPI2C_SSR_TAF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba5c5dcad526309c44aa390c13ae53ca3e">kLPI2C_SlaveRepeatedStartDetectFlag</a> = LPI2C_SSR_RSF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269baaaa1d719607915d0b1251727900018a7">kLPI2C_SlaveStopDetectFlag</a> = LPI2C_SSR_SDF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba41375eeb82c399aff15daba1e8bbff03">kLPI2C_SlaveBitErrFlag</a> = LPI2C_SSR_BEF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba6eb9dd96bad287dcb7e2f23f73d961a8">kLPI2C_SlaveFifoErrFlag</a> = LPI2C_SSR_FEF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba9fb3f57d810e280effee1dae37d062bb">kLPI2C_SlaveAddressMatch0Flag</a> = LPI2C_SSR_AM0F_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba62cc9694d6891b21af074122eeedca85">kLPI2C_SlaveAddressMatch1Flag</a> = LPI2C_SSR_AM1F_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba6a0fa821b530336ea8d1f19aadcbe1dc">kLPI2C_SlaveGeneralCallFlag</a> = LPI2C_SSR_GCF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269baffa3195deae58fc6ea15d062b465ac5d">kLPI2C_SlaveBusyFlag</a> = LPI2C_SSR_SBF_MASK,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba2531ffa96faa3086714e8a069508867b">kLPI2C_SlaveBusBusyFlag</a> = LPI2C_SSR_BBF_MASK
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gabd50effc706692c03b42faa72c34269b"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C slave peripheral flags. <a href="group__lpi2c__slave__driver.html#gabd50effc706692c03b42faa72c34269b">More...</a><br/></td></tr>
|
|
<tr class="separator:gabd50effc706692c03b42faa72c34269b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac3564395ccab19eb1ce6ab46b36bb5bb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#gac3564395ccab19eb1ce6ab46b36bb5bb">lpi2c_slave_address_match_t</a> { <br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggac3564395ccab19eb1ce6ab46b36bb5bbaaa16a731881882d10f48ebde416f54c5">kLPI2C_MatchAddress0</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggac3564395ccab19eb1ce6ab46b36bb5bba2941f8a06a17205294e7d0fa5f305675">kLPI2C_MatchAddress0OrAddress1</a> = 2U,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#ggac3564395ccab19eb1ce6ab46b36bb5bba59e460fdd7075191f69e047ef35557eb">kLPI2C_MatchAddress0ThroughAddress1</a> = 6U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gac3564395ccab19eb1ce6ab46b36bb5bb"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C slave address match options. <a href="group__lpi2c__slave__driver.html#gac3564395ccab19eb1ce6ab46b36bb5bb">More...</a><br/></td></tr>
|
|
<tr class="separator:gac3564395ccab19eb1ce6ab46b36bb5bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0d99b4dba3841a4e02f7c431a59006c8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga0d99b4dba3841a4e02f7c431a59006c8">lpi2c_slave_transfer_event_t</a> { <br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8a10fb8d9bb6ba9cd44fde85466e6eabef">kLPI2C_SlaveAddressMatchEvent</a> = 0x01U,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8a976c8c9aa85026224a46cf5ec742eb49">kLPI2C_SlaveTransmitEvent</a> = 0x02U,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8ac737ba9e4e62880a6e2d8aac98ae8f18">kLPI2C_SlaveReceiveEvent</a> = 0x04U,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8a112af4cf8f8a374407d7c784f024b8e0">kLPI2C_SlaveTransmitAckEvent</a> = 0x08U,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8ae0995aac6808b3726b7577c2d283e4c4">kLPI2C_SlaveRepeatedStartEvent</a> = 0x10U,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8a06ef7422d9edf9b914864a2d689f042c">kLPI2C_SlaveCompletionEvent</a> = 0x20U,
|
|
<br/>
|
|
  <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8aeed0927f4e909cb161b44434b6f01aec">kLPI2C_SlaveAllEvents</a>
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga0d99b4dba3841a4e02f7c431a59006c8"><td class="mdescLeft"> </td><td class="mdescRight">Set of events sent to the callback for non blocking slave transfers. <a href="group__lpi2c__slave__driver.html#ga0d99b4dba3841a4e02f7c431a59006c8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0d99b4dba3841a4e02f7c431a59006c8"><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>
|
|
Slave initialization and deinitialization</h2></td></tr>
|
|
<tr class="memitem:gadf34085d4557ceb3081fff9fe0e3189a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#gadf34085d4557ceb3081fff9fe0e3189a">LPI2C_SlaveGetDefaultConfig</a> (<a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__config__t">lpi2c_slave_config_t</a> *slaveConfig)</td></tr>
|
|
<tr class="memdesc:gadf34085d4557ceb3081fff9fe0e3189a"><td class="mdescLeft"> </td><td class="mdescRight">Provides a default configuration for the LPI2C slave peripheral. <a href="#gadf34085d4557ceb3081fff9fe0e3189a">More...</a><br/></td></tr>
|
|
<tr class="separator:gadf34085d4557ceb3081fff9fe0e3189a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae5cc8a03c784a99bb58b69852dfda5a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#gae5cc8a03c784a99bb58b69852dfda5a5">LPI2C_SlaveInit</a> (LPI2C_Type *base, const <a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__config__t">lpi2c_slave_config_t</a> *slaveConfig, uint32_t sourceClock_Hz)</td></tr>
|
|
<tr class="memdesc:gae5cc8a03c784a99bb58b69852dfda5a5"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the LPI2C slave peripheral. <a href="#gae5cc8a03c784a99bb58b69852dfda5a5">More...</a><br/></td></tr>
|
|
<tr class="separator:gae5cc8a03c784a99bb58b69852dfda5a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa1a5cfe78acec0e1f8dd4af63a0f87f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#gaa1a5cfe78acec0e1f8dd4af63a0f87f8">LPI2C_SlaveDeinit</a> (LPI2C_Type *base)</td></tr>
|
|
<tr class="memdesc:gaa1a5cfe78acec0e1f8dd4af63a0f87f8"><td class="mdescLeft"> </td><td class="mdescRight">Deinitializes the LPI2C slave peripheral. <a href="#gaa1a5cfe78acec0e1f8dd4af63a0f87f8">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa1a5cfe78acec0e1f8dd4af63a0f87f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf58f9ebf437d62936c45c201a68fb5d7"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#gaf58f9ebf437d62936c45c201a68fb5d7">LPI2C_SlaveReset</a> (LPI2C_Type *base)</td></tr>
|
|
<tr class="memdesc:gaf58f9ebf437d62936c45c201a68fb5d7"><td class="mdescLeft"> </td><td class="mdescRight">Performs a software reset of the LPI2C slave peripheral. <a href="#gaf58f9ebf437d62936c45c201a68fb5d7">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf58f9ebf437d62936c45c201a68fb5d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae83a936eb8303218278cd704d8238a08"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#gae83a936eb8303218278cd704d8238a08">LPI2C_SlaveEnable</a> (LPI2C_Type *base, bool enable)</td></tr>
|
|
<tr class="memdesc:gae83a936eb8303218278cd704d8238a08"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the LPI2C module as slave. <a href="#gae83a936eb8303218278cd704d8238a08">More...</a><br/></td></tr>
|
|
<tr class="separator:gae83a936eb8303218278cd704d8238a08"><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>
|
|
Slave status</h2></td></tr>
|
|
<tr class="memitem:ga18055724e510f601f35cc00940e9155c"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga18055724e510f601f35cc00940e9155c">LPI2C_SlaveGetStatusFlags</a> (LPI2C_Type *base)</td></tr>
|
|
<tr class="memdesc:ga18055724e510f601f35cc00940e9155c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the LPI2C slave status flags. <a href="#ga18055724e510f601f35cc00940e9155c">More...</a><br/></td></tr>
|
|
<tr class="separator:ga18055724e510f601f35cc00940e9155c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3b5306231d96d7fa38ef26d9ca6526b1"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga3b5306231d96d7fa38ef26d9ca6526b1">LPI2C_SlaveClearStatusFlags</a> (LPI2C_Type *base, uint32_t statusMask)</td></tr>
|
|
<tr class="memdesc:ga3b5306231d96d7fa38ef26d9ca6526b1"><td class="mdescLeft"> </td><td class="mdescRight">Clears the LPI2C status flag state. <a href="#ga3b5306231d96d7fa38ef26d9ca6526b1">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3b5306231d96d7fa38ef26d9ca6526b1"><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>
|
|
Slave interrupts</h2></td></tr>
|
|
<tr class="memitem:gaf5b7a33a341fd95ca77dcb6fe7f1bf3c"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#gaf5b7a33a341fd95ca77dcb6fe7f1bf3c">LPI2C_SlaveEnableInterrupts</a> (LPI2C_Type *base, uint32_t interruptMask)</td></tr>
|
|
<tr class="memdesc:gaf5b7a33a341fd95ca77dcb6fe7f1bf3c"><td class="mdescLeft"> </td><td class="mdescRight">Enables the LPI2C slave interrupt requests. <a href="#gaf5b7a33a341fd95ca77dcb6fe7f1bf3c">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf5b7a33a341fd95ca77dcb6fe7f1bf3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9422103623a9866f350dd03aea984741"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga9422103623a9866f350dd03aea984741">LPI2C_SlaveDisableInterrupts</a> (LPI2C_Type *base, uint32_t interruptMask)</td></tr>
|
|
<tr class="memdesc:ga9422103623a9866f350dd03aea984741"><td class="mdescLeft"> </td><td class="mdescRight">Disables the LPI2C slave interrupt requests. <a href="#ga9422103623a9866f350dd03aea984741">More...</a><br/></td></tr>
|
|
<tr class="separator:ga9422103623a9866f350dd03aea984741"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3d1fb84d337b8eb5cc19cbeced06c2a1"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga3d1fb84d337b8eb5cc19cbeced06c2a1">LPI2C_SlaveGetEnabledInterrupts</a> (LPI2C_Type *base)</td></tr>
|
|
<tr class="memdesc:ga3d1fb84d337b8eb5cc19cbeced06c2a1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of currently enabled LPI2C slave interrupt requests. <a href="#ga3d1fb84d337b8eb5cc19cbeced06c2a1">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3d1fb84d337b8eb5cc19cbeced06c2a1"><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>
|
|
Slave DMA control</h2></td></tr>
|
|
<tr class="memitem:gaa13d0c04083818cf91af19a6add0e08f"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#gaa13d0c04083818cf91af19a6add0e08f">LPI2C_SlaveEnableDMA</a> (LPI2C_Type *base, bool enableAddressValid, bool enableRx, bool enableTx)</td></tr>
|
|
<tr class="memdesc:gaa13d0c04083818cf91af19a6add0e08f"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the LPI2C slave peripheral DMA requests. <a href="#gaa13d0c04083818cf91af19a6add0e08f">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa13d0c04083818cf91af19a6add0e08f"><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>
|
|
Slave bus operations</h2></td></tr>
|
|
<tr class="memitem:ga155ee1b5bc8c621b60b349b191c078fc"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga155ee1b5bc8c621b60b349b191c078fc">LPI2C_SlaveGetBusIdleState</a> (LPI2C_Type *base)</td></tr>
|
|
<tr class="memdesc:ga155ee1b5bc8c621b60b349b191c078fc"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the bus is idle. <a href="#ga155ee1b5bc8c621b60b349b191c078fc">More...</a><br/></td></tr>
|
|
<tr class="separator:ga155ee1b5bc8c621b60b349b191c078fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga417e07e45369a955f7fecaa26e13b335"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga417e07e45369a955f7fecaa26e13b335">LPI2C_SlaveTransmitAck</a> (LPI2C_Type *base, bool ackOrNack)</td></tr>
|
|
<tr class="memdesc:ga417e07e45369a955f7fecaa26e13b335"><td class="mdescLeft"> </td><td class="mdescRight">Transmits either an ACK or NAK on the I2C bus in response to a byte from the master. <a href="#ga417e07e45369a955f7fecaa26e13b335">More...</a><br/></td></tr>
|
|
<tr class="separator:ga417e07e45369a955f7fecaa26e13b335"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8219a79b748dc59c982c7c3a8470c3a6"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga8219a79b748dc59c982c7c3a8470c3a6">LPI2C_SlaveGetReceivedAddress</a> (LPI2C_Type *base)</td></tr>
|
|
<tr class="memdesc:ga8219a79b748dc59c982c7c3a8470c3a6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the slave address sent by the I2C master. <a href="#ga8219a79b748dc59c982c7c3a8470c3a6">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8219a79b748dc59c982c7c3a8470c3a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6762c41a46ca9cdc9c749e83f1a9f17d"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga6762c41a46ca9cdc9c749e83f1a9f17d">LPI2C_SlaveSend</a> (LPI2C_Type *base, const void *txBuff, size_t txSize, size_t *actualTxSize)</td></tr>
|
|
<tr class="memdesc:ga6762c41a46ca9cdc9c749e83f1a9f17d"><td class="mdescLeft"> </td><td class="mdescRight">Performs a polling send transfer on the I2C bus. <a href="#ga6762c41a46ca9cdc9c749e83f1a9f17d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6762c41a46ca9cdc9c749e83f1a9f17d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga36dd1b211a7fe488bfc062a1d8e74fc8"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga36dd1b211a7fe488bfc062a1d8e74fc8">LPI2C_SlaveReceive</a> (LPI2C_Type *base, void *rxBuff, size_t rxSize, size_t *actualRxSize)</td></tr>
|
|
<tr class="memdesc:ga36dd1b211a7fe488bfc062a1d8e74fc8"><td class="mdescLeft"> </td><td class="mdescRight">Performs a polling receive transfer on the I2C bus. <a href="#ga36dd1b211a7fe488bfc062a1d8e74fc8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga36dd1b211a7fe488bfc062a1d8e74fc8"><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>
|
|
Slave non-blocking</h2></td></tr>
|
|
<tr class="memitem:ga6afdc286db9c700bc057038518a19285"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga6afdc286db9c700bc057038518a19285">LPI2C_SlaveTransferCreateHandle</a> (LPI2C_Type *base, lpi2c_slave_handle_t *handle, <a class="el" href="group__lpi2c__slave__driver.html#ga2640285a708842a5e0e7c4c0090a2f58">lpi2c_slave_transfer_callback_t</a> callback, void *userData)</td></tr>
|
|
<tr class="memdesc:ga6afdc286db9c700bc057038518a19285"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new handle for the LPI2C slave non-blocking APIs. <a href="#ga6afdc286db9c700bc057038518a19285">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6afdc286db9c700bc057038518a19285"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1ba7c9d0c254de8fe8c04091c007edff"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga1ba7c9d0c254de8fe8c04091c007edff">LPI2C_SlaveTransferNonBlocking</a> (LPI2C_Type *base, lpi2c_slave_handle_t *handle, uint32_t eventMask)</td></tr>
|
|
<tr class="memdesc:ga1ba7c9d0c254de8fe8c04091c007edff"><td class="mdescLeft"> </td><td class="mdescRight">Starts accepting slave transfers. <a href="#ga1ba7c9d0c254de8fe8c04091c007edff">More...</a><br/></td></tr>
|
|
<tr class="separator:ga1ba7c9d0c254de8fe8c04091c007edff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga755b38638cbade1b05587146e9f7267d"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga755b38638cbade1b05587146e9f7267d">LPI2C_SlaveTransferGetCount</a> (LPI2C_Type *base, lpi2c_slave_handle_t *handle, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga755b38638cbade1b05587146e9f7267d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the slave transfer status during a non-blocking transfer. <a href="#ga755b38638cbade1b05587146e9f7267d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga755b38638cbade1b05587146e9f7267d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7d46d488aa043ab93bfa1574277a3985"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga7d46d488aa043ab93bfa1574277a3985">LPI2C_SlaveTransferAbort</a> (LPI2C_Type *base, lpi2c_slave_handle_t *handle)</td></tr>
|
|
<tr class="memdesc:ga7d46d488aa043ab93bfa1574277a3985"><td class="mdescLeft"> </td><td class="mdescRight">Aborts the slave non-blocking transfers. <a href="#ga7d46d488aa043ab93bfa1574277a3985">More...</a><br/></td></tr>
|
|
<tr class="separator:ga7d46d488aa043ab93bfa1574277a3985"><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>
|
|
Slave IRQ handler</h2></td></tr>
|
|
<tr class="memitem:ga712654857bc4490644b46220c0c460bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ga712654857bc4490644b46220c0c460bf">LPI2C_SlaveTransferHandleIRQ</a> (LPI2C_Type *base, lpi2c_slave_handle_t *handle)</td></tr>
|
|
<tr class="memdesc:ga712654857bc4490644b46220c0c460bf"><td class="mdescLeft"> </td><td class="mdescRight">Reusable routine to handle slave interrupts. <a href="#ga712654857bc4490644b46220c0c460bf">More...</a><br/></td></tr>
|
|
<tr class="separator:ga712654857bc4490644b46220c0c460bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="structlpi2c__slave__config__t" id="structlpi2c__slave__config__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct lpi2c_slave_config_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>This structure holds configuration settings for the LPI2C slave peripheral. To initialize this structure to reasonable defaults, call the <a class="el" href="group__lpi2c__slave__driver.html#gadf34085d4557ceb3081fff9fe0e3189a" title="Provides a default configuration for the LPI2C slave peripheral. ">LPI2C_SlaveGetDefaultConfig()</a> function and pass a pointer to your configuration structure instance.</p>
|
|
<p>The configuration structure can be made constant so it resides in flash. </p>
|
|
</div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:ad220cfa81b4117fd1d952b43ff0d5511"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ad220cfa81b4117fd1d952b43ff0d5511">enableSlave</a></td></tr>
|
|
<tr class="memdesc:ad220cfa81b4117fd1d952b43ff0d5511"><td class="mdescLeft"> </td><td class="mdescRight">Enable slave mode. <a href="#ad220cfa81b4117fd1d952b43ff0d5511">More...</a><br/></td></tr>
|
|
<tr class="separator:ad220cfa81b4117fd1d952b43ff0d5511"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16f171990f815872142d3fe73eb74ff4"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a16f171990f815872142d3fe73eb74ff4">address0</a></td></tr>
|
|
<tr class="memdesc:a16f171990f815872142d3fe73eb74ff4"><td class="mdescLeft"> </td><td class="mdescRight">Slave's 7-bit address. <a href="#a16f171990f815872142d3fe73eb74ff4">More...</a><br/></td></tr>
|
|
<tr class="separator:a16f171990f815872142d3fe73eb74ff4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb3035cd87a9746bdbe5c6618a492034"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#afb3035cd87a9746bdbe5c6618a492034">address1</a></td></tr>
|
|
<tr class="memdesc:afb3035cd87a9746bdbe5c6618a492034"><td class="mdescLeft"> </td><td class="mdescRight">Alternate slave 7-bit address. <a href="#afb3035cd87a9746bdbe5c6618a492034">More...</a><br/></td></tr>
|
|
<tr class="separator:afb3035cd87a9746bdbe5c6618a492034"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dc82ff6416b69128c0d6d78d533b093"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__lpi2c__slave__driver.html#gac3564395ccab19eb1ce6ab46b36bb5bb">lpi2c_slave_address_match_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a1dc82ff6416b69128c0d6d78d533b093">addressMatchMode</a></td></tr>
|
|
<tr class="memdesc:a1dc82ff6416b69128c0d6d78d533b093"><td class="mdescLeft"> </td><td class="mdescRight">Address matching options. <a href="#a1dc82ff6416b69128c0d6d78d533b093">More...</a><br/></td></tr>
|
|
<tr class="separator:a1dc82ff6416b69128c0d6d78d533b093"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4cbbafe55351cb52d25b3de1a71e2231"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a4cbbafe55351cb52d25b3de1a71e2231">filterDozeEnable</a></td></tr>
|
|
<tr class="memdesc:a4cbbafe55351cb52d25b3de1a71e2231"><td class="mdescLeft"> </td><td class="mdescRight">Enable digital glitch filter in doze mode. <a href="#a4cbbafe55351cb52d25b3de1a71e2231">More...</a><br/></td></tr>
|
|
<tr class="separator:a4cbbafe55351cb52d25b3de1a71e2231"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fcca02d50a48b5a3a2923ea449316ce"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a6fcca02d50a48b5a3a2923ea449316ce">filterEnable</a></td></tr>
|
|
<tr class="memdesc:a6fcca02d50a48b5a3a2923ea449316ce"><td class="mdescLeft"> </td><td class="mdescRight">Enable digital glitch filter. <a href="#a6fcca02d50a48b5a3a2923ea449316ce">More...</a><br/></td></tr>
|
|
<tr class="separator:a6fcca02d50a48b5a3a2923ea449316ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a061ed35a72d6e8ffe9a02be00f633f87"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a061ed35a72d6e8ffe9a02be00f633f87">enableGeneralCall</a></td></tr>
|
|
<tr class="memdesc:a061ed35a72d6e8ffe9a02be00f633f87"><td class="mdescLeft"> </td><td class="mdescRight">Enable general call address matching. <a href="#a061ed35a72d6e8ffe9a02be00f633f87">More...</a><br/></td></tr>
|
|
<tr class="separator:a061ed35a72d6e8ffe9a02be00f633f87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae68493537f90f7bff4a421ff534fb7a1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ae68493537f90f7bff4a421ff534fb7a1">ignoreAck</a></td></tr>
|
|
<tr class="memdesc:ae68493537f90f7bff4a421ff534fb7a1"><td class="mdescLeft"> </td><td class="mdescRight">Continue transfers after a NACK is detected. <a href="#ae68493537f90f7bff4a421ff534fb7a1">More...</a><br/></td></tr>
|
|
<tr class="separator:ae68493537f90f7bff4a421ff534fb7a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac273a825233fe937aa16d98e38664812"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ac273a825233fe937aa16d98e38664812">enableReceivedAddressRead</a></td></tr>
|
|
<tr class="memdesc:ac273a825233fe937aa16d98e38664812"><td class="mdescLeft"> </td><td class="mdescRight">Enable reading the address received address as the first byte of data. <a href="#ac273a825233fe937aa16d98e38664812">More...</a><br/></td></tr>
|
|
<tr class="separator:ac273a825233fe937aa16d98e38664812"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c28ef56af23d2e059942e8d80e5cd15"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a7c28ef56af23d2e059942e8d80e5cd15">sdaGlitchFilterWidth_ns</a></td></tr>
|
|
<tr class="memdesc:a7c28ef56af23d2e059942e8d80e5cd15"><td class="mdescLeft"> </td><td class="mdescRight">Width in nanoseconds of the digital filter on the SDA signal. <a href="#a7c28ef56af23d2e059942e8d80e5cd15">More...</a><br/></td></tr>
|
|
<tr class="separator:a7c28ef56af23d2e059942e8d80e5cd15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a793ea7dd26bfb1f68daae2523e70d5a5"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a793ea7dd26bfb1f68daae2523e70d5a5">sclGlitchFilterWidth_ns</a></td></tr>
|
|
<tr class="memdesc:a793ea7dd26bfb1f68daae2523e70d5a5"><td class="mdescLeft"> </td><td class="mdescRight">Width in nanoseconds of the digital filter on the SCL signal. <a href="#a793ea7dd26bfb1f68daae2523e70d5a5">More...</a><br/></td></tr>
|
|
<tr class="separator:a793ea7dd26bfb1f68daae2523e70d5a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a920288e7667b3b363f019384ebc58606"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a920288e7667b3b363f019384ebc58606">dataValidDelay_ns</a></td></tr>
|
|
<tr class="memdesc:a920288e7667b3b363f019384ebc58606"><td class="mdescLeft"> </td><td class="mdescRight">Width in nanoseconds of the data valid delay. <a href="#a920288e7667b3b363f019384ebc58606">More...</a><br/></td></tr>
|
|
<tr class="separator:a920288e7667b3b363f019384ebc58606"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e672f5446e7d86eb9d74bdc785df0fb"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a2e672f5446e7d86eb9d74bdc785df0fb">clockHoldTime_ns</a></td></tr>
|
|
<tr class="memdesc:a2e672f5446e7d86eb9d74bdc785df0fb"><td class="mdescLeft"> </td><td class="mdescRight">Width in nanoseconds of the clock hold time. <a href="#a2e672f5446e7d86eb9d74bdc785df0fb">More...</a><br/></td></tr>
|
|
<tr class="separator:a2e672f5446e7d86eb9d74bdc785df0fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2cd4a19f68523031122851dd0ab1386"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ab2cd4a19f68523031122851dd0ab1386">enableAck</a></td></tr>
|
|
<tr class="memdesc:ab2cd4a19f68523031122851dd0ab1386"><td class="mdescLeft"> </td><td class="mdescRight">Enables SCL clock stretching during slave-transmit address byte(s) and slave-receiver address and data byte(s) to allow software to write the Transmit ACK Register before the ACK or NACK is transmitted. <a href="#ab2cd4a19f68523031122851dd0ab1386">More...</a><br/></td></tr>
|
|
<tr class="separator:ab2cd4a19f68523031122851dd0ab1386"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0fea92e29e7afff3d7072ab3c722bc8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ad0fea92e29e7afff3d7072ab3c722bc8">enableTx</a></td></tr>
|
|
<tr class="memdesc:ad0fea92e29e7afff3d7072ab3c722bc8"><td class="mdescLeft"> </td><td class="mdescRight">Enables SCL clock stretching when the transmit data flag is set during a slave-transmit transfer. <a href="#ad0fea92e29e7afff3d7072ab3c722bc8">More...</a><br/></td></tr>
|
|
<tr class="separator:ad0fea92e29e7afff3d7072ab3c722bc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff856d2084ff0ede49f0ff25e6cf5529"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#aff856d2084ff0ede49f0ff25e6cf5529">enableRx</a></td></tr>
|
|
<tr class="memdesc:aff856d2084ff0ede49f0ff25e6cf5529"><td class="mdescLeft"> </td><td class="mdescRight">Enables SCL clock stretching when receive data flag is set during a slave-receive transfer. <a href="#aff856d2084ff0ede49f0ff25e6cf5529">More...</a><br/></td></tr>
|
|
<tr class="separator:aff856d2084ff0ede49f0ff25e6cf5529"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ec794389bd9fb5e51c802bb0b9ee26b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a6ec794389bd9fb5e51c802bb0b9ee26b">enableAddress</a></td></tr>
|
|
<tr class="memdesc:a6ec794389bd9fb5e51c802bb0b9ee26b"><td class="mdescLeft"> </td><td class="mdescRight">Enables SCL clock stretching when the address valid flag is asserted. <a href="#a6ec794389bd9fb5e51c802bb0b9ee26b">More...</a><br/></td></tr>
|
|
<tr class="separator:a6ec794389bd9fb5e51c802bb0b9ee26b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="ad220cfa81b4117fd1d952b43ff0d5511"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::enableSlave</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a16f171990f815872142d3fe73eb74ff4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t lpi2c_slave_config_t::address0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afb3035cd87a9746bdbe5c6618a492034"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t lpi2c_slave_config_t::address1</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1dc82ff6416b69128c0d6d78d533b093"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__lpi2c__slave__driver.html#gac3564395ccab19eb1ce6ab46b36bb5bb">lpi2c_slave_address_match_t</a> lpi2c_slave_config_t::addressMatchMode</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4cbbafe55351cb52d25b3de1a71e2231"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::filterDozeEnable</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6fcca02d50a48b5a3a2923ea449316ce"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::filterEnable</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a061ed35a72d6e8ffe9a02be00f633f87"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::enableGeneralCall</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab2cd4a19f68523031122851dd0ab1386"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::enableAck</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Clock stretching occurs when transmitting the 9th bit. When enableAckSCLStall is enabled, there is no need to set either enableRxDataSCLStall or enableAddressSCLStall. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad0fea92e29e7afff3d7072ab3c722bc8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::enableTx</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aff856d2084ff0ede49f0ff25e6cf5529"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::enableRx</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6ec794389bd9fb5e51c802bb0b9ee26b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::enableAddress</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae68493537f90f7bff4a421ff534fb7a1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::ignoreAck</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac273a825233fe937aa16d98e38664812"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_config_t::enableReceivedAddressRead</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7c28ef56af23d2e059942e8d80e5cd15"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t lpi2c_slave_config_t::sdaGlitchFilterWidth_ns</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a793ea7dd26bfb1f68daae2523e70d5a5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t lpi2c_slave_config_t::sclGlitchFilterWidth_ns</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a920288e7667b3b363f019384ebc58606"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t lpi2c_slave_config_t::dataValidDelay_ns</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2e672f5446e7d86eb9d74bdc785df0fb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t lpi2c_slave_config_t::clockHoldTime_ns</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="structlpi2c__slave__transfer__t" id="structlpi2c__slave__transfer__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct lpi2c_slave_transfer_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a19df3bc5c35ed8ae03a927dcc89daa48"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__lpi2c__slave__driver.html#ga0d99b4dba3841a4e02f7c431a59006c8">lpi2c_slave_transfer_event_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a19df3bc5c35ed8ae03a927dcc89daa48">event</a></td></tr>
|
|
<tr class="memdesc:a19df3bc5c35ed8ae03a927dcc89daa48"><td class="mdescLeft"> </td><td class="mdescRight">Reason the callback is being invoked. <a href="#a19df3bc5c35ed8ae03a927dcc89daa48">More...</a><br/></td></tr>
|
|
<tr class="separator:a19df3bc5c35ed8ae03a927dcc89daa48"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a336e15a483043ed7ace990517fff6686"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a336e15a483043ed7ace990517fff6686">receivedAddress</a></td></tr>
|
|
<tr class="memdesc:a336e15a483043ed7ace990517fff6686"><td class="mdescLeft"> </td><td class="mdescRight">Matching address send by master. <a href="#a336e15a483043ed7ace990517fff6686">More...</a><br/></td></tr>
|
|
<tr class="separator:a336e15a483043ed7ace990517fff6686"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54436075594000b4d56471b29dd6734f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54436075594000b4d56471b29dd6734f"></a>
|
|
uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a54436075594000b4d56471b29dd6734f">data</a></td></tr>
|
|
<tr class="memdesc:a54436075594000b4d56471b29dd6734f"><td class="mdescLeft"> </td><td class="mdescRight">Transfer buffer. <br/></td></tr>
|
|
<tr class="separator:a54436075594000b4d56471b29dd6734f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afcd4de20f8efd725bd93d72180b32f2d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcd4de20f8efd725bd93d72180b32f2d"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#afcd4de20f8efd725bd93d72180b32f2d">dataSize</a></td></tr>
|
|
<tr class="memdesc:afcd4de20f8efd725bd93d72180b32f2d"><td class="mdescLeft"> </td><td class="mdescRight">Transfer size. <br/></td></tr>
|
|
<tr class="separator:afcd4de20f8efd725bd93d72180b32f2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aafd14bc835c1c23de6bf06834d1a0b3c"><td class="memItemLeft" align="right" valign="top">status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#aafd14bc835c1c23de6bf06834d1a0b3c">completionStatus</a></td></tr>
|
|
<tr class="memdesc:aafd14bc835c1c23de6bf06834d1a0b3c"><td class="mdescLeft"> </td><td class="mdescRight">Success or error code describing how the transfer completed. <a href="#aafd14bc835c1c23de6bf06834d1a0b3c">More...</a><br/></td></tr>
|
|
<tr class="separator:aafd14bc835c1c23de6bf06834d1a0b3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67e03ab90367cb1d48d42b718e6438f5"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a67e03ab90367cb1d48d42b718e6438f5">transferredCount</a></td></tr>
|
|
<tr class="memdesc:a67e03ab90367cb1d48d42b718e6438f5"><td class="mdescLeft"> </td><td class="mdescRight">Number of bytes actually transferred since start or last repeated start. <a href="#a67e03ab90367cb1d48d42b718e6438f5">More...</a><br/></td></tr>
|
|
<tr class="separator:a67e03ab90367cb1d48d42b718e6438f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a19df3bc5c35ed8ae03a927dcc89daa48"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__lpi2c__slave__driver.html#ga0d99b4dba3841a4e02f7c431a59006c8">lpi2c_slave_transfer_event_t</a> lpi2c_slave_transfer_t::event</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a336e15a483043ed7ace990517fff6686"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t lpi2c_slave_transfer_t::receivedAddress</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aafd14bc835c1c23de6bf06834d1a0b3c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t lpi2c_slave_transfer_t::completionStatus</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Only applies for <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8a06ef7422d9edf9b914864a2d689f042c" title="A stop was detected, completing the transfer. ">kLPI2C_SlaveCompletionEvent</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a67e03ab90367cb1d48d42b718e6438f5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t lpi2c_slave_transfer_t::transferredCount</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="struct__lpi2c__slave__handle" id="struct__lpi2c__slave__handle"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _lpi2c_slave_handle</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><dl class="section note"><dt>Note</dt><dd>The contents of this structure are private and subject to change. </dd></dl>
|
|
</div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:aed2dec763e40c6caa129c082603852d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__transfer__t">lpi2c_slave_transfer_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#aed2dec763e40c6caa129c082603852d5">transfer</a></td></tr>
|
|
<tr class="memdesc:aed2dec763e40c6caa129c082603852d5"><td class="mdescLeft"> </td><td class="mdescRight">LPI2C slave transfer copy. <a href="#aed2dec763e40c6caa129c082603852d5">More...</a><br/></td></tr>
|
|
<tr class="separator:aed2dec763e40c6caa129c082603852d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f0662c2c78df7b8e8b5ed4c1119823d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a8f0662c2c78df7b8e8b5ed4c1119823d">isBusy</a></td></tr>
|
|
<tr class="memdesc:a8f0662c2c78df7b8e8b5ed4c1119823d"><td class="mdescLeft"> </td><td class="mdescRight">Whether transfer is busy. <a href="#a8f0662c2c78df7b8e8b5ed4c1119823d">More...</a><br/></td></tr>
|
|
<tr class="separator:a8f0662c2c78df7b8e8b5ed4c1119823d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0a187d43f251bc67fb9c34dedbf9253"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#af0a187d43f251bc67fb9c34dedbf9253">wasTransmit</a></td></tr>
|
|
<tr class="memdesc:af0a187d43f251bc67fb9c34dedbf9253"><td class="mdescLeft"> </td><td class="mdescRight">Whether the last transfer was a transmit. <a href="#af0a187d43f251bc67fb9c34dedbf9253">More...</a><br/></td></tr>
|
|
<tr class="separator:af0a187d43f251bc67fb9c34dedbf9253"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5bceee16dd6f07c8cb6918580e45e540"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a5bceee16dd6f07c8cb6918580e45e540">eventMask</a></td></tr>
|
|
<tr class="memdesc:a5bceee16dd6f07c8cb6918580e45e540"><td class="mdescLeft"> </td><td class="mdescRight">Mask of enabled events. <a href="#a5bceee16dd6f07c8cb6918580e45e540">More...</a><br/></td></tr>
|
|
<tr class="separator:a5bceee16dd6f07c8cb6918580e45e540"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9f4d0665e8ec4c56eb89e816c4b5324"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#ac9f4d0665e8ec4c56eb89e816c4b5324">transferredCount</a></td></tr>
|
|
<tr class="memdesc:ac9f4d0665e8ec4c56eb89e816c4b5324"><td class="mdescLeft"> </td><td class="mdescRight">Count of bytes transferred. <a href="#ac9f4d0665e8ec4c56eb89e816c4b5324">More...</a><br/></td></tr>
|
|
<tr class="separator:ac9f4d0665e8ec4c56eb89e816c4b5324"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e16ba71a57adfe84058af632a604e40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__lpi2c__slave__driver.html#ga2640285a708842a5e0e7c4c0090a2f58">lpi2c_slave_transfer_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#a0e16ba71a57adfe84058af632a604e40">callback</a></td></tr>
|
|
<tr class="memdesc:a0e16ba71a57adfe84058af632a604e40"><td class="mdescLeft"> </td><td class="mdescRight">Callback function called at transfer event. <a href="#a0e16ba71a57adfe84058af632a604e40">More...</a><br/></td></tr>
|
|
<tr class="separator:a0e16ba71a57adfe84058af632a604e40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa394f46d8677c977aa39b64fb0c353ce"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lpi2c__slave__driver.html#aa394f46d8677c977aa39b64fb0c353ce">userData</a></td></tr>
|
|
<tr class="memdesc:aa394f46d8677c977aa39b64fb0c353ce"><td class="mdescLeft"> </td><td class="mdescRight">Callback parameter passed to callback. <a href="#aa394f46d8677c977aa39b64fb0c353ce">More...</a><br/></td></tr>
|
|
<tr class="separator:aa394f46d8677c977aa39b64fb0c353ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="aed2dec763e40c6caa129c082603852d5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__transfer__t">lpi2c_slave_transfer_t</a> lpi2c_slave_handle_t::transfer</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8f0662c2c78df7b8e8b5ed4c1119823d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_handle_t::isBusy</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af0a187d43f251bc67fb9c34dedbf9253"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool lpi2c_slave_handle_t::wasTransmit</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5bceee16dd6f07c8cb6918580e45e540"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t lpi2c_slave_handle_t::eventMask</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac9f4d0665e8ec4c56eb89e816c4b5324"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t lpi2c_slave_handle_t::transferredCount</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0e16ba71a57adfe84058af632a604e40"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__lpi2c__slave__driver.html#ga2640285a708842a5e0e7c4c0090a2f58">lpi2c_slave_transfer_callback_t</a> lpi2c_slave_handle_t::callback</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa394f46d8677c977aa39b64fb0c353ce"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* lpi2c_slave_handle_t::userData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="ga2640285a708842a5e0e7c4c0090a2f58"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* lpi2c_slave_transfer_callback_t)(LPI2C_Type *base, <a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__transfer__t">lpi2c_slave_transfer_t</a> *transfer, void *userData)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This callback is used only for the slave non-blocking transfer API. To install a callback, use the LPI2C_SlaveSetCallback() function after you have created a handle.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Base address for the LPI2C instance on which the event occurred. </td></tr>
|
|
<tr><td class="paramname">transfer</td><td>Pointer to transfer descriptor containing values passed to and/or from the callback. </td></tr>
|
|
<tr><td class="paramname">userData</td><td>Arbitrary pointer-sized value passed from the application. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="gabd50effc706692c03b42faa72c34269b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__lpi2c__slave__driver.html#gabd50effc706692c03b42faa72c34269b">_lpi2c_slave_flags</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The following status register flags can be cleared:</p>
|
|
<ul>
|
|
<li><a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba5c5dcad526309c44aa390c13ae53ca3e" title="Repeated start detect flag. ">kLPI2C_SlaveRepeatedStartDetectFlag</a></li>
|
|
<li><a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269baaaa1d719607915d0b1251727900018a7" title="Stop detect flag. ">kLPI2C_SlaveStopDetectFlag</a></li>
|
|
<li><a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba41375eeb82c399aff15daba1e8bbff03" title="Bit error flag. ">kLPI2C_SlaveBitErrFlag</a></li>
|
|
<li><a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba6eb9dd96bad287dcb7e2f23f73d961a8" title="FIFO error flag. ">kLPI2C_SlaveFifoErrFlag</a></li>
|
|
</ul>
|
|
<p>All flags except <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269baffa3195deae58fc6ea15d062b465ac5d" title="Master busy flag. ">kLPI2C_SlaveBusyFlag</a> and <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba2531ffa96faa3086714e8a069508867b" title="Bus busy flag. ">kLPI2C_SlaveBusBusyFlag</a> can be enabled as interrupts.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>These enumerations are meant to be OR'd together to form a bit mask. </dd></dl>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba80486f66e12276c945b8813269b90c0e"></a>kLPI2C_SlaveTxReadyFlag</em> </td><td class="fielddoc">
|
|
<p>Transmit data flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba01265ce6645e4a978b823b1f130a419f"></a>kLPI2C_SlaveRxReadyFlag</em> </td><td class="fielddoc">
|
|
<p>Receive data flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269baf34a60fee419e0b3d387b353a38b4772"></a>kLPI2C_SlaveAddressValidFlag</em> </td><td class="fielddoc">
|
|
<p>Address valid flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba37386d33a28e37352a8e3151f027fdff"></a>kLPI2C_SlaveTransmitAckFlag</em> </td><td class="fielddoc">
|
|
<p>Transmit ACK flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba5c5dcad526309c44aa390c13ae53ca3e"></a>kLPI2C_SlaveRepeatedStartDetectFlag</em> </td><td class="fielddoc">
|
|
<p>Repeated start detect flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269baaaa1d719607915d0b1251727900018a7"></a>kLPI2C_SlaveStopDetectFlag</em> </td><td class="fielddoc">
|
|
<p>Stop detect flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba41375eeb82c399aff15daba1e8bbff03"></a>kLPI2C_SlaveBitErrFlag</em> </td><td class="fielddoc">
|
|
<p>Bit error flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba6eb9dd96bad287dcb7e2f23f73d961a8"></a>kLPI2C_SlaveFifoErrFlag</em> </td><td class="fielddoc">
|
|
<p>FIFO error flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba9fb3f57d810e280effee1dae37d062bb"></a>kLPI2C_SlaveAddressMatch0Flag</em> </td><td class="fielddoc">
|
|
<p>Address match 0 flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba62cc9694d6891b21af074122eeedca85"></a>kLPI2C_SlaveAddressMatch1Flag</em> </td><td class="fielddoc">
|
|
<p>Address match 1 flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba6a0fa821b530336ea8d1f19aadcbe1dc"></a>kLPI2C_SlaveGeneralCallFlag</em> </td><td class="fielddoc">
|
|
<p>General call flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269baffa3195deae58fc6ea15d062b465ac5d"></a>kLPI2C_SlaveBusyFlag</em> </td><td class="fielddoc">
|
|
<p>Master busy flag. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggabd50effc706692c03b42faa72c34269ba2531ffa96faa3086714e8a069508867b"></a>kLPI2C_SlaveBusBusyFlag</em> </td><td class="fielddoc">
|
|
<p>Bus busy flag. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac3564395ccab19eb1ce6ab46b36bb5bb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__lpi2c__slave__driver.html#gac3564395ccab19eb1ce6ab46b36bb5bb">lpi2c_slave_address_match_t</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="ggac3564395ccab19eb1ce6ab46b36bb5bbaaa16a731881882d10f48ebde416f54c5"></a>kLPI2C_MatchAddress0</em> </td><td class="fielddoc">
|
|
<p>Match only address 0. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggac3564395ccab19eb1ce6ab46b36bb5bba2941f8a06a17205294e7d0fa5f305675"></a>kLPI2C_MatchAddress0OrAddress1</em> </td><td class="fielddoc">
|
|
<p>Match either address 0 or address 1. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggac3564395ccab19eb1ce6ab46b36bb5bba59e460fdd7075191f69e047ef35557eb"></a>kLPI2C_MatchAddress0ThroughAddress1</em> </td><td class="fielddoc">
|
|
<p>Match a range of slave addresses from address 0 through address 1. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0d99b4dba3841a4e02f7c431a59006c8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__lpi2c__slave__driver.html#ga0d99b4dba3841a4e02f7c431a59006c8">lpi2c_slave_transfer_event_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>These event enumerations are used for two related purposes. First, a bit mask created by OR'ing together events is passed to <a class="el" href="group__lpi2c__slave__driver.html#ga1ba7c9d0c254de8fe8c04091c007edff" title="Starts accepting slave transfers. ">LPI2C_SlaveTransferNonBlocking()</a> in order to specify which events to enable. Then, when the slave callback is invoked, it is passed the current event through its <em>transfer</em> parameter.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>These enumerations are meant to be OR'd together to form a bit mask of events. </dd></dl>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga0d99b4dba3841a4e02f7c431a59006c8a10fb8d9bb6ba9cd44fde85466e6eabef"></a>kLPI2C_SlaveAddressMatchEvent</em> </td><td class="fielddoc">
|
|
<p>Received the slave address after a start or repeated start. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0d99b4dba3841a4e02f7c431a59006c8a976c8c9aa85026224a46cf5ec742eb49"></a>kLPI2C_SlaveTransmitEvent</em> </td><td class="fielddoc">
|
|
<p>Callback is requested to provide data to transmit (slave-transmitter role). </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0d99b4dba3841a4e02f7c431a59006c8ac737ba9e4e62880a6e2d8aac98ae8f18"></a>kLPI2C_SlaveReceiveEvent</em> </td><td class="fielddoc">
|
|
<p>Callback is requested to provide a buffer in which to place received data (slave-receiver role). </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0d99b4dba3841a4e02f7c431a59006c8a112af4cf8f8a374407d7c784f024b8e0"></a>kLPI2C_SlaveTransmitAckEvent</em> </td><td class="fielddoc">
|
|
<p>Callback needs to either transmit an ACK or NACK. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0d99b4dba3841a4e02f7c431a59006c8ae0995aac6808b3726b7577c2d283e4c4"></a>kLPI2C_SlaveRepeatedStartEvent</em> </td><td class="fielddoc">
|
|
<p>A repeated start was detected. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0d99b4dba3841a4e02f7c431a59006c8a06ef7422d9edf9b914864a2d689f042c"></a>kLPI2C_SlaveCompletionEvent</em> </td><td class="fielddoc">
|
|
<p>A stop was detected, completing the transfer. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0d99b4dba3841a4e02f7c431a59006c8aeed0927f4e909cb161b44434b6f01aec"></a>kLPI2C_SlaveAllEvents</em> </td><td class="fielddoc">
|
|
<p>Bit mask of all available events. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gadf34085d4557ceb3081fff9fe0e3189a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LPI2C_SlaveGetDefaultConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__config__t">lpi2c_slave_config_t</a> * </td>
|
|
<td class="paramname"><em>slaveConfig</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function provides the following default configuration for the LPI2C slave peripheral: </p>
|
|
<div class="fragment"><div class="line">slaveConfig-><a class="code" href="group__i2c__driver.html#a92d20835618a946b8f7702455877ef7a">enableSlave</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line">slaveConfig->address0 = 0U;</div>
|
|
<div class="line">slaveConfig->address1 = 0U;</div>
|
|
<div class="line">slaveConfig->addressMatchMode = <a class="code" href="group__lpi2c__slave__driver.html#ggac3564395ccab19eb1ce6ab46b36bb5bbaaa16a731881882d10f48ebde416f54c5">kLPI2C_MatchAddress0</a>;</div>
|
|
<div class="line">slaveConfig->filterDozeEnable = <span class="keyword">true</span>;</div>
|
|
<div class="line">slaveConfig->filterEnable = <span class="keyword">true</span>;</div>
|
|
<div class="line">slaveConfig-><a class="code" href="group__i2c__driver.html#a5a99d99a0891526a625aba15da4605df">enableGeneralCall</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line">slaveConfig->sclStall.enableAck = <span class="keyword">false</span>;</div>
|
|
<div class="line">slaveConfig->sclStall.enableTx = <span class="keyword">true</span>;</div>
|
|
<div class="line">slaveConfig->sclStall.enableRx = <span class="keyword">true</span>;</div>
|
|
<div class="line">slaveConfig->sclStall.enableAddress = <span class="keyword">true</span>;</div>
|
|
<div class="line">slaveConfig->ignoreAck = <span class="keyword">false</span>;</div>
|
|
<div class="line">slaveConfig->enableReceivedAddressRead = <span class="keyword">false</span>;</div>
|
|
<div class="line">slaveConfig->sdaGlitchFilterWidth_ns = 0; <span class="comment">// TODO determine default width values</span></div>
|
|
<div class="line">slaveConfig->sclGlitchFilterWidth_ns = 0;</div>
|
|
<div class="line">slaveConfig->dataValidDelay_ns = 0;</div>
|
|
<div class="line">slaveConfig->clockHoldTime_ns = 0;</div>
|
|
</div><!-- fragment --><p>After calling this function, override any settings to customize the configuration, prior to initializing the master driver with <a class="el" href="group__lpi2c__slave__driver.html#gae5cc8a03c784a99bb58b69852dfda5a5" title="Initializes the LPI2C slave peripheral. ">LPI2C_SlaveInit()</a>. Be sure to override at least the <em>address0</em> member of the configuration structure with the desired slave address.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">slaveConfig</td><td>User provided configuration structure that is set to default values. Refer to <a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__config__t" title="Structure with settings to initialize the LPI2C slave module. ">lpi2c_slave_config_t</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae5cc8a03c784a99bb58b69852dfda5a5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LPI2C_SlaveInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__config__t">lpi2c_slave_config_t</a> * </td>
|
|
<td class="paramname"><em>slaveConfig</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>sourceClock_Hz</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function enables the peripheral clock and initializes the LPI2C slave peripheral as described by the user provided configuration.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">slaveConfig</td><td>User provided peripheral configuration. Use <a class="el" href="group__lpi2c__slave__driver.html#gadf34085d4557ceb3081fff9fe0e3189a" title="Provides a default configuration for the LPI2C slave peripheral. ">LPI2C_SlaveGetDefaultConfig()</a> to get a set of defaults that you can override. </td></tr>
|
|
<tr><td class="paramname">sourceClock_Hz</td><td>Frequency in Hertz of the LPI2C functional clock. Used to calculate the filter widths, data valid delay, and clock hold time. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa1a5cfe78acec0e1f8dd4af63a0f87f8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LPI2C_SlaveDeinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function disables the LPI2C slave peripheral and gates the clock. It also performs a software reset to restore the peripheral to reset conditions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf58f9ebf437d62936c45c201a68fb5d7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void LPI2C_SlaveReset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae83a936eb8303218278cd704d8238a08"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void LPI2C_SlaveEnable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Pass true to enable or false to disable the specified LPI2C as slave. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga18055724e510f601f35cc00940e9155c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t LPI2C_SlaveGetStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>A bit mask with the state of all LPI2C slave status flags is returned. For each flag, the corresponding bit in the return value is set if the flag is asserted.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>State of the status flags:<ul>
|
|
<li>1: related status flag is set.</li>
|
|
<li>0: related status flag is not set. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__lpi2c__slave__driver.html#gabd50effc706692c03b42faa72c34269b" title="LPI2C slave peripheral flags. ">_lpi2c_slave_flags</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3b5306231d96d7fa38ef26d9ca6526b1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void LPI2C_SlaveClearStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>statusMask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The following status register flags can be cleared:</p>
|
|
<ul>
|
|
<li><a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba5c5dcad526309c44aa390c13ae53ca3e" title="Repeated start detect flag. ">kLPI2C_SlaveRepeatedStartDetectFlag</a></li>
|
|
<li><a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269baaaa1d719607915d0b1251727900018a7" title="Stop detect flag. ">kLPI2C_SlaveStopDetectFlag</a></li>
|
|
<li><a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba41375eeb82c399aff15daba1e8bbff03" title="Bit error flag. ">kLPI2C_SlaveBitErrFlag</a></li>
|
|
<li><a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba6eb9dd96bad287dcb7e2f23f73d961a8" title="FIFO error flag. ">kLPI2C_SlaveFifoErrFlag</a></li>
|
|
</ul>
|
|
<p>Attempts to clear other flags has no effect.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">statusMask</td><td>A bitmask of status flags that are to be cleared. The mask is composed of <a class="el" href="group__lpi2c__slave__driver.html#gabd50effc706692c03b42faa72c34269b" title="LPI2C slave peripheral flags. ">_lpi2c_slave_flags</a> enumerators OR'd together. You may pass the result of a previous call to <a class="el" href="group__lpi2c__slave__driver.html#ga18055724e510f601f35cc00940e9155c" title="Gets the LPI2C slave status flags. ">LPI2C_SlaveGetStatusFlags()</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__lpi2c__slave__driver.html#gabd50effc706692c03b42faa72c34269b" title="LPI2C slave peripheral flags. ">_lpi2c_slave_flags</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf5b7a33a341fd95ca77dcb6fe7f1bf3c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void LPI2C_SlaveEnableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>interruptMask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>All flags except <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269baffa3195deae58fc6ea15d062b465ac5d" title="Master busy flag. ">kLPI2C_SlaveBusyFlag</a> and <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba2531ffa96faa3086714e8a069508867b" title="Bus busy flag. ">kLPI2C_SlaveBusBusyFlag</a> can be enabled as interrupts.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">interruptMask</td><td>Bit mask of interrupts to enable. See <a class="el" href="group__lpi2c__slave__driver.html#gabd50effc706692c03b42faa72c34269b" title="LPI2C slave peripheral flags. ">_lpi2c_slave_flags</a> for the set of constants that should be OR'd together to form the bit mask. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9422103623a9866f350dd03aea984741"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void LPI2C_SlaveDisableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>interruptMask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>All flags except <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269baffa3195deae58fc6ea15d062b465ac5d" title="Master busy flag. ">kLPI2C_SlaveBusyFlag</a> and <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba2531ffa96faa3086714e8a069508867b" title="Bus busy flag. ">kLPI2C_SlaveBusBusyFlag</a> can be enabled as interrupts.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">interruptMask</td><td>Bit mask of interrupts to disable. See <a class="el" href="group__lpi2c__slave__driver.html#gabd50effc706692c03b42faa72c34269b" title="LPI2C slave peripheral flags. ">_lpi2c_slave_flags</a> for the set of constants that should be OR'd together to form the bit mask. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3d1fb84d337b8eb5cc19cbeced06c2a1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t LPI2C_SlaveGetEnabledInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A bitmask composed of <a class="el" href="group__lpi2c__slave__driver.html#gabd50effc706692c03b42faa72c34269b" title="LPI2C slave peripheral flags. ">_lpi2c_slave_flags</a> enumerators OR'd together to indicate the set of enabled interrupts. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa13d0c04083818cf91af19a6add0e08f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void LPI2C_SlaveEnableDMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enableAddressValid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enableRx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enableTx</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">enableAddressValid</td><td>Enable flag for the address valid DMA request. Pass true for enable, false for disable. The address valid DMA request is shared with the receive data DMA request. </td></tr>
|
|
<tr><td class="paramname">enableRx</td><td>Enable flag for the receive data DMA request. Pass true for enable, false for disable. </td></tr>
|
|
<tr><td class="paramname">enableTx</td><td>Enable flag for the transmit data DMA request. Pass true for enable, false for disable. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga155ee1b5bc8c621b60b349b191c078fc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool LPI2C_SlaveGetBusIdleState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Requires the slave mode to be enabled.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">true</td><td>Bus is busy. </td></tr>
|
|
<tr><td class="paramname">false</td><td>Bus is idle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga417e07e45369a955f7fecaa26e13b335"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void LPI2C_SlaveTransmitAck </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>ackOrNack</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Use this function to send an ACK or NAK when the <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269ba37386d33a28e37352a8e3151f027fdff" title="Transmit ACK flag. ">kLPI2C_SlaveTransmitAckFlag</a> is asserted. This only happens if you enable the sclStall.enableAck field of the <a class="el" href="group__lpi2c__slave__driver.html#structlpi2c__slave__config__t" title="Structure with settings to initialize the LPI2C slave module. ">lpi2c_slave_config_t</a> configuration structure used to initialize the slave peripheral.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">ackOrNack</td><td>Pass true for an ACK or false for a NAK. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8219a79b748dc59c982c7c3a8470c3a6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint32_t LPI2C_SlaveGetReceivedAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function should only be called if the <a class="el" href="group__lpi2c__slave__driver.html#ggabd50effc706692c03b42faa72c34269baf34a60fee419e0b3d387b353a38b4772" title="Address valid flag. ">kLPI2C_SlaveAddressValidFlag</a> is asserted.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The 8-bit address matched by the LPI2C slave. Bit 0 contains the R/w direction bit, and the 7-bit slave address is in the upper 7 bits. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6762c41a46ca9cdc9c749e83f1a9f17d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t LPI2C_SlaveSend </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>txBuff</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>txSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>actualTxSize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">txBuff</td><td>The pointer to the data to be transferred. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">txSize</td><td>The length in bytes of the data to be transferred. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">actualTxSize</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Error or success status returned by API. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga36dd1b211a7fe488bfc062a1d8e74fc8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t LPI2C_SlaveReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>rxBuff</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>rxSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>actualRxSize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">rxBuff</td><td>The pointer to the data to be transferred. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">rxSize</td><td>The length in bytes of the data to be transferred. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">actualRxSize</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Error or success status returned by API. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6afdc286db9c700bc057038518a19285"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LPI2C_SlaveTransferCreateHandle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">lpi2c_slave_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__lpi2c__slave__driver.html#ga2640285a708842a5e0e7c4c0090a2f58">lpi2c_slave_transfer_callback_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>userData</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The creation of a handle is for use with the non-blocking APIs. Once a handle is created, there is not a corresponding destroy handle. If the user wants to terminate a transfer, the <a class="el" href="group__lpi2c__slave__driver.html#ga7d46d488aa043ab93bfa1574277a3985" title="Aborts the slave non-blocking transfers. ">LPI2C_SlaveTransferAbort()</a> API shall be called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">handle</td><td>Pointer to the LPI2C slave driver handle. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">callback</td><td>User provided pointer to the asynchronous callback function. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">userData</td><td>User provided pointer to the application callback data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga1ba7c9d0c254de8fe8c04091c007edff"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t LPI2C_SlaveTransferNonBlocking </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">lpi2c_slave_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>eventMask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Call this API after calling <a class="el" href="group__i2c__driver.html#gae6e155a5aadb43d527418e2965e39123" title="Initializes the I2C peripheral. ">I2C_SlaveInit()</a> and <a class="el" href="group__lpi2c__slave__driver.html#ga6afdc286db9c700bc057038518a19285" title="Creates a new handle for the LPI2C slave non-blocking APIs. ">LPI2C_SlaveTransferCreateHandle()</a> to start processing transactions driven by an I2C master. The slave monitors the I2C bus and pass events to the callback that was passed into the call to <a class="el" href="group__lpi2c__slave__driver.html#ga6afdc286db9c700bc057038518a19285" title="Creates a new handle for the LPI2C slave non-blocking APIs. ">LPI2C_SlaveTransferCreateHandle()</a>. The callback is always invoked from the interrupt context.</p>
|
|
<p>The set of events received by the callback is customizable. To do so, set the <em>eventMask</em> parameter to the OR'd combination of <a class="el" href="group__lpi2c__slave__driver.html#ga0d99b4dba3841a4e02f7c431a59006c8" title="Set of events sent to the callback for non blocking slave transfers. ">lpi2c_slave_transfer_event_t</a> enumerators for the events you wish to receive. The <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8a976c8c9aa85026224a46cf5ec742eb49" title="Callback is requested to provide data to transmit (slave-transmitter role). ">kLPI2C_SlaveTransmitEvent</a> and <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8ac737ba9e4e62880a6e2d8aac98ae8f18" title="Callback is requested to provide a buffer in which to place received data (slave-receiver role)...">kLPI2C_SlaveReceiveEvent</a> events are always enabled and do not need to be included in the mask. Alternatively, you can pass 0 to get a default set of only the transmit and receive events that are always enabled. In addition, the <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8aeed0927f4e909cb161b44434b6f01aec" title="Bit mask of all available events. ">kLPI2C_SlaveAllEvents</a> constant is provided as a convenient way to enable all events.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to #lpi2c_slave_handle_t structure which stores the transfer state. </td></tr>
|
|
<tr><td class="paramname">eventMask</td><td>Bit mask formed by OR'ing together <a class="el" href="group__lpi2c__slave__driver.html#ga0d99b4dba3841a4e02f7c431a59006c8" title="Set of events sent to the callback for non blocking slave transfers. ">lpi2c_slave_transfer_event_t</a> enumerators to specify which events to send to the callback. Other accepted values are 0 to get a default set of only the transmit and receive events, and <a class="el" href="group__lpi2c__slave__driver.html#gga0d99b4dba3841a4e02f7c431a59006c8aeed0927f4e909cb161b44434b6f01aec" title="Bit mask of all available events. ">kLPI2C_SlaveAllEvents</a> to enable all events.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">#kStatus_Success</td><td>Slave transfers were successfully started. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8af52a270e301641b8855edf3fcc843814" title="The master is already performing a transfer. ">kStatus_LPI2C_Busy</a></td><td>Slave transfers have already been started on this handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga755b38638cbade1b05587146e9f7267d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">status_t LPI2C_SlaveTransferGetCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">lpi2c_slave_handle_t * </td>
|
|
<td class="paramname"><em>handle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">handle</td><td>Pointer to i2c_slave_handle_t structure. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">count</td><td>Pointer to a value to hold the number of bytes transferred. May be NULL if the count is not required. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">#kStatus_Success</td><td></td></tr>
|
|
<tr><td class="paramname">#kStatus_NoTransferInProgress</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7d46d488aa043ab93bfa1574277a3985"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LPI2C_SlaveTransferAbort </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">lpi2c_slave_handle_t * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>This API could be called at any time to stop slave for handling the bus events. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to #lpi2c_slave_handle_t structure which stores the transfer state. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">#kStatus_Success</td><td></td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__lpi2c__driver.html#gga424746e0c18108c3c7233c77899a57c8a6603ec1135f58532c9d4accc3661bc27" title="The slave driver is idle. ">kStatus_LPI2C_Idle</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga712654857bc4490644b46220c0c460bf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LPI2C_SlaveTransferHandleIRQ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">LPI2C_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">lpi2c_slave_handle_t * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>This function does not need to be called unless you are reimplementing the non blocking API's interrupt handler routines to add special functionality. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>The LPI2C peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Pointer to #lpi2c_slave_handle_t structure which stores the transfer state. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</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>
|