390 lines
28 KiB
HTML
390 lines
28 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.11"/>
|
|
<title>Kinetis Bootloader: I2C Peripheral</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="navtreedata.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/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.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="nxp_logo_small.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Kinetis Bootloader
|
|
 <span id="projectnumber">2.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">Common bootloader for Kinetis devices</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<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>Introduction</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('group__i2c__peripheral.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)">
|
|
</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="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">I2C Peripheral<div class="ingroups"><a class="el" href="group__bootloader.html">Bootloader</a> » <a class="el" href="group__peripherals.html">Peripheral Definitions</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>I2C peripheral interface.
|
|
<a href="#details">More...</a></p>
|
|
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for I2C Peripheral:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<center><table><tr><td><div class="center"><iframe scrolling="no" frameborder="0" src="group__i2c__peripheral.svg" width="306" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
</td></tr></table></center>
|
|
</div>
|
|
<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:structi2c__transfer__info__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#structi2c__transfer__info__t">i2c_transfer_info_t</a></td></tr>
|
|
<tr class="memdesc:structi2c__transfer__info__t"><td class="mdescLeft"> </td><td class="mdescRight">Synchronization state between I2C ISR and read/write functions. <a href="group__i2c__peripheral.html#structi2c__transfer__info__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structi2c__transfer__info__t"><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:ga0411cd49bb5b71852cecd93bcbf0ca2d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="group__i2c__peripheral.html#gga0411cd49bb5b71852cecd93bcbf0ca2dab6105f7327afb940ba6b2af59429f0ab">kI2CGlitchFilterWidth_ns</a> = 50
|
|
}<tr class="memdesc:ga0411cd49bb5b71852cecd93bcbf0ca2d"><td class="mdescLeft"> </td><td class="mdescRight">Default width of glitches to filter in nanoseconds. <a href="group__i2c__peripheral.html#ga0411cd49bb5b71852cecd93bcbf0ca2d">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga0411cd49bb5b71852cecd93bcbf0ca2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabed82baf7f470b522273a3e37c24c600"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="group__i2c__peripheral.html#ggabed82baf7f470b522273a3e37c24c600a8b19cb6a742e8302498f7df11d36ad49">kI2CGlitchFilterMaxCycles</a> = 31
|
|
}</td></tr>
|
|
<tr class="separator:gabed82baf7f470b522273a3e37c24c600"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga4e2e81e05c7c8ac22c7aa514a7b0a6ad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4e2e81e05c7c8ac22c7aa514a7b0a6ad"></a>
|
|
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#ga4e2e81e05c7c8ac22c7aa514a7b0a6ad">i2c_poll_for_activity</a> (const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="memdesc:ga4e2e81e05c7c8ac22c7aa514a7b0a6ad"><td class="mdescLeft"> </td><td class="mdescRight">I2C slave poll for activity function. <br /></td></tr>
|
|
<tr class="separator:ga4e2e81e05c7c8ac22c7aa514a7b0a6ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf0e2fb5643dce51aafc8263b05057d28"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf0e2fb5643dce51aafc8263b05057d28"></a>
|
|
static <a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#gaf0e2fb5643dce51aafc8263b05057d28">i2c_full_init</a> (const peripheral_descriptor_t *self, serial_byte_receive_func_t function)</td></tr>
|
|
<tr class="memdesc:gaf0e2fb5643dce51aafc8263b05057d28"><td class="mdescLeft"> </td><td class="mdescRight">I2C slave init function. <br /></td></tr>
|
|
<tr class="separator:gaf0e2fb5643dce51aafc8263b05057d28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga083369e0b81321bdf797fc8b6e133c9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga083369e0b81321bdf797fc8b6e133c9b"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#ga083369e0b81321bdf797fc8b6e133c9b">i2c_full_shutdown</a> (const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="memdesc:ga083369e0b81321bdf797fc8b6e133c9b"><td class="mdescLeft"> </td><td class="mdescRight">I2C slave shutdown function. <br /></td></tr>
|
|
<tr class="separator:ga083369e0b81321bdf797fc8b6e133c9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf3812c8b057fe052a6d80e26db9efffc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf3812c8b057fe052a6d80e26db9efffc"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#gaf3812c8b057fe052a6d80e26db9efffc">i2c_peripheral_init</a> (uint32_t instance)</td></tr>
|
|
<tr class="memdesc:gaf3812c8b057fe052a6d80e26db9efffc"><td class="mdescLeft"> </td><td class="mdescRight">I2C slave internal init function. <br /></td></tr>
|
|
<tr class="separator:gaf3812c8b057fe052a6d80e26db9efffc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9b3ac0e43867f89f0e4304bd17827476"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9b3ac0e43867f89f0e4304bd17827476"></a>
|
|
<a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#ga9b3ac0e43867f89f0e4304bd17827476">i2c_write</a> (const peripheral_descriptor_t *self, const uint8_t *buffer, uint32_t byteCount)</td></tr>
|
|
<tr class="memdesc:ga9b3ac0e43867f89f0e4304bd17827476"><td class="mdescLeft"> </td><td class="mdescRight">I2C slave writing data function. <br /></td></tr>
|
|
<tr class="separator:ga9b3ac0e43867f89f0e4304bd17827476"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9a4bb3d711713f1b2204cc95bc0505e3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9a4bb3d711713f1b2204cc95bc0505e3"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>i2c_initial_data_sink</b> (uint8_t sink_byte, uint32_t instance)</td></tr>
|
|
<tr class="separator:ga9a4bb3d711713f1b2204cc95bc0505e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga187ef02a79d191b159925475de48922d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga187ef02a79d191b159925475de48922d"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>i2c_data_sink</b> (uint8_t sink_byte, uint32_t instance)</td></tr>
|
|
<tr class="separator:ga187ef02a79d191b159925475de48922d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga70be7494f02ceccbd11733d9019f2bfc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70be7494f02ceccbd11733d9019f2bfc"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>i2c_data_source</b> (uint8_t *source_byte)</td></tr>
|
|
<tr class="separator:ga70be7494f02ceccbd11733d9019f2bfc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaad7e60fdcc85aa4e9e931450ae7e2e1e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaad7e60fdcc85aa4e9e931450ae7e2e1e"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>i2c_set_glitch_filter_width</b> (I2C_Type *base, uint32_t busClock_Hz, uint32_t glitchWidth_ns)</td></tr>
|
|
<tr class="separator:gaad7e60fdcc85aa4e9e931450ae7e2e1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae35d2526a62e5325a7e3f40be69b893d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae35d2526a62e5325a7e3f40be69b893d"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>i2c_SlaveIRQHandler</b> (uint32_t instance)</td></tr>
|
|
<tr class="separator:gae35d2526a62e5325a7e3f40be69b893d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8e817e99d2a59e5f48e4ff0c79e7eef5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#ga8e817e99d2a59e5f48e4ff0c79e7eef5">I2C0_IRQHandler</a> (void)</td></tr>
|
|
<tr class="memdesc:ga8e817e99d2a59e5f48e4ff0c79e7eef5"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of I2C0 handler named in startup code. <a href="#ga8e817e99d2a59e5f48e4ff0c79e7eef5">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8e817e99d2a59e5f48e4ff0c79e7eef5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac45e5675f6f4e6e1dee2273baf245219"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#gac45e5675f6f4e6e1dee2273baf245219">I2C1_IRQHandler</a> (void)</td></tr>
|
|
<tr class="memdesc:gac45e5675f6f4e6e1dee2273baf245219"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of I2C1 handler named in startup code. <a href="#gac45e5675f6f4e6e1dee2273baf245219">More...</a><br /></td></tr>
|
|
<tr class="separator:gac45e5675f6f4e6e1dee2273baf245219"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0dc70b06beaeba460958c48e241ee8e3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0dc70b06beaeba460958c48e241ee8e3"></a>
|
|
static uint8_t </td><td class="memItemRight" valign="bottom"><b>i2c_DummyRead</b> (volatile I2C_Type *base)</td></tr>
|
|
<tr class="separator:ga0dc70b06beaeba460958c48e241ee8e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:ga150594762dd84b152638fbb10ec88b6c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__peripheral.html#structperipheral__control__interface__t">peripheral_control_interface_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#ga150594762dd84b152638fbb10ec88b6c">g_i2cControlInterface</a></td></tr>
|
|
<tr class="memdesc:ga150594762dd84b152638fbb10ec88b6c"><td class="mdescLeft"> </td><td class="mdescRight">I2C slave control interface information. <a href="#ga150594762dd84b152638fbb10ec88b6c">More...</a><br /></td></tr>
|
|
<tr class="separator:ga150594762dd84b152638fbb10ec88b6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga57538591c22c8ecd0e1a832d60882608"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__peripheral.html#structperipheral__byte__inteface__t">peripheral_byte_inteface_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#ga57538591c22c8ecd0e1a832d60882608">g_i2cByteInterface</a> = {.init = NULL, .write = <a class="el" href="group__i2c__peripheral.html#ga9b3ac0e43867f89f0e4304bd17827476">i2c_write</a> }</td></tr>
|
|
<tr class="memdesc:ga57538591c22c8ecd0e1a832d60882608"><td class="mdescLeft"> </td><td class="mdescRight">I2C slave byte interface information. <a href="#ga57538591c22c8ecd0e1a832d60882608">More...</a><br /></td></tr>
|
|
<tr class="separator:ga57538591c22c8ecd0e1a832d60882608"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga30ab4538764b03ace5af3845ac5fbcf2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__i2c__peripheral.html#structi2c__transfer__info__t">i2c_transfer_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#ga30ab4538764b03ace5af3845ac5fbcf2">s_i2cInfo</a></td></tr>
|
|
<tr class="memdesc:ga30ab4538764b03ace5af3845ac5fbcf2"><td class="mdescLeft"> </td><td class="mdescRight">Global state for the I2C slave peripheral interface. <a href="#ga30ab4538764b03ace5af3845ac5fbcf2">More...</a><br /></td></tr>
|
|
<tr class="separator:ga30ab4538764b03ace5af3845ac5fbcf2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafde1a2c1c78c9b402b79125aa8b81823"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafde1a2c1c78c9b402b79125aa8b81823"></a>
|
|
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#gafde1a2c1c78c9b402b79125aa8b81823">s_i2cActivity</a> [FSL_FEATURE_SOC_I2C_COUNT] = { false }</td></tr>
|
|
<tr class="memdesc:gafde1a2c1c78c9b402b79125aa8b81823"><td class="mdescLeft"> </td><td class="mdescRight">Global state for the I2C slave peripheral interface. <br /></td></tr>
|
|
<tr class="separator:gafde1a2c1c78c9b402b79125aa8b81823"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1f7ca60dd181244623de9309501fc546"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1f7ca60dd181244623de9309501fc546"></a>
|
|
static const uint32_t </td><td class="memItemRight" valign="bottom"><b>g_i2cBaseAddr</b> [] = I2C_BASE_ADDRS</td></tr>
|
|
<tr class="separator:ga1f7ca60dd181244623de9309501fc546"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3cdb887371de915625a78d68a07ef24f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3cdb887371de915625a78d68a07ef24f"></a>
|
|
static bool </td><td class="memItemRight" valign="bottom"><b>s_i2cIntialized</b> [FSL_FEATURE_SOC_I2C_COUNT] = { false }</td></tr>
|
|
<tr class="separator:ga3cdb887371de915625a78d68a07ef24f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa2088c9d248f90a696c308a99e7a358c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa2088c9d248f90a696c308a99e7a358c"></a>
|
|
static serial_byte_receive_func_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#gaa2088c9d248f90a696c308a99e7a358c">s_i2c_app_data_sink_callback</a></td></tr>
|
|
<tr class="memdesc:gaa2088c9d248f90a696c308a99e7a358c"><td class="mdescLeft"> </td><td class="mdescRight">I2C slave receiving data call back function. <br /></td></tr>
|
|
<tr class="separator:gaa2088c9d248f90a696c308a99e7a358c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Usage Information</h2>
|
|
<p>I2C peripheral interface. </p>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="structi2c__transfer__info__t" id="structi2c__transfer__info__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct i2c_transfer_info_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Synchronization state between I2C ISR and read/write functions. </p>
|
|
</div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a3a4b30eae7b109b07563f393896fec3e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a4b30eae7b109b07563f393896fec3e"></a>
|
|
const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#a3a4b30eae7b109b07563f393896fec3e">writeData</a></td></tr>
|
|
<tr class="memdesc:a3a4b30eae7b109b07563f393896fec3e"><td class="mdescLeft"> </td><td class="mdescRight">The applications data to write. <br /></td></tr>
|
|
<tr class="separator:a3a4b30eae7b109b07563f393896fec3e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65a142e258c9eb8e52e2d680356c4c53"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65a142e258c9eb8e52e2d680356c4c53"></a>
|
|
volatile uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c__peripheral.html#a65a142e258c9eb8e52e2d680356c4c53">bytesToTransfer</a></td></tr>
|
|
<tr class="memdesc:a65a142e258c9eb8e52e2d680356c4c53"><td class="mdescLeft"> </td><td class="mdescRight">The total number of bytes to be transmitted. <br /></td></tr>
|
|
<tr class="separator:a65a142e258c9eb8e52e2d680356c4c53"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad973e4d60775400f9aca1b2d19d2e3ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad973e4d60775400f9aca1b2d19d2e3ee"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>data_source</b> )(uint8_t *source_byte)</td></tr>
|
|
<tr class="separator:ad973e4d60775400f9aca1b2d19d2e3ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af95157416dd54acf148383b734ce5a4e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af95157416dd54acf148383b734ce5a4e"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>data_sink</b> )(uint8_t sink_byte, uint32_t instance)</td></tr>
|
|
<tr class="separator:af95157416dd54acf148383b734ce5a4e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga0411cd49bb5b71852cecd93bcbf0ca2d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default width of glitches to filter in nanoseconds. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga0411cd49bb5b71852cecd93bcbf0ca2dab6105f7327afb940ba6b2af59429f0ab"></a>kI2CGlitchFilterWidth_ns </td><td class="fielddoc">
|
|
<p>Width of glitches to filter in nanoseconds. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gabed82baf7f470b522273a3e37c24c600"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggabed82baf7f470b522273a3e37c24c600a8b19cb6a742e8302498f7df11d36ad49"></a>kI2CGlitchFilterMaxCycles </td><td class="fielddoc">
|
|
<p>Max cycles supported to set glitch filter. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga8e817e99d2a59e5f48e4ff0c79e7eef5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2C0_IRQHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implementation of I2C0 handler named in startup code. </p>
|
|
<p>Passes instance to generic I2C IRQ handler. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac45e5675f6f4e6e1dee2273baf245219"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void I2C1_IRQHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implementation of I2C1 handler named in startup code. </p>
|
|
<p>Passes instance to generic I2C IRQ handler. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a class="anchor" id="ga57538591c22c8ecd0e1a832d60882608"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="group__peripheral.html#structperipheral__byte__inteface__t">peripheral_byte_inteface_t</a> g_i2cByteInterface = {.init = NULL, .write = <a class="el" href="group__i2c__peripheral.html#ga9b3ac0e43867f89f0e4304bd17827476">i2c_write</a> }</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>I2C slave byte interface information. </p>
|
|
<p>Byte I/O interface for the I2C peripheral driver. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga150594762dd84b152638fbb10ec88b6c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="group__peripheral.html#structperipheral__control__interface__t">peripheral_control_interface_t</a> g_i2cControlInterface</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">= {</div><div class="line"> .pollForActivity = <a class="code" href="group__i2c__peripheral.html#ga4e2e81e05c7c8ac22c7aa514a7b0a6ad">i2c_poll_for_activity</a>, .init = <a class="code" href="group__i2c__peripheral.html#gaf0e2fb5643dce51aafc8263b05057d28">i2c_full_init</a>, .shutdown = <a class="code" href="group__i2c__peripheral.html#ga083369e0b81321bdf797fc8b6e133c9b">i2c_full_shutdown</a>, .pump = 0</div><div class="line">}</div><div class="ttc" id="group__i2c__peripheral_html_ga4e2e81e05c7c8ac22c7aa514a7b0a6ad"><div class="ttname"><a href="group__i2c__peripheral.html#ga4e2e81e05c7c8ac22c7aa514a7b0a6ad">i2c_poll_for_activity</a></div><div class="ttdeci">static bool i2c_poll_for_activity(const peripheral_descriptor_t *self)</div><div class="ttdoc">I2C slave poll for activity function. </div><div class="ttdef"><b>Definition:</b> i2c_peripheral_interface.c:162</div></div>
|
|
<div class="ttc" id="group__i2c__peripheral_html_ga083369e0b81321bdf797fc8b6e133c9b"><div class="ttname"><a href="group__i2c__peripheral.html#ga083369e0b81321bdf797fc8b6e133c9b">i2c_full_shutdown</a></div><div class="ttdeci">static void i2c_full_shutdown(const peripheral_descriptor_t *self)</div><div class="ttdoc">I2C slave shutdown function. </div><div class="ttdef"><b>Definition:</b> i2c_peripheral_interface.c:279</div></div>
|
|
<div class="ttc" id="group__i2c__peripheral_html_gaf0e2fb5643dce51aafc8263b05057d28"><div class="ttname"><a href="group__i2c__peripheral.html#gaf0e2fb5643dce51aafc8263b05057d28">i2c_full_init</a></div><div class="ttdeci">static status_t i2c_full_init(const peripheral_descriptor_t *self, serial_byte_receive_func_t function)</div><div class="ttdoc">I2C slave init function. </div><div class="ttdef"><b>Definition:</b> i2c_peripheral_interface.c:259</div></div>
|
|
</div><!-- fragment -->
|
|
<p>I2C slave control interface information. </p>
|
|
<p>Control interface for the I2C peripheral driver. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga30ab4538764b03ace5af3845ac5fbcf2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__i2c__peripheral.html#structi2c__transfer__info__t">i2c_transfer_info_t</a> s_i2cInfo</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">= {</div><div class="line"> .writeData = 0, .bytesToTransfer = 0, .data_source = i2c_data_source, .data_sink = i2c_initial_data_sink</div><div class="line">}</div></div><!-- fragment -->
|
|
<p>Global state for the I2C slave peripheral interface. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated on Mon Mar 7 2016 16:48:23 for Kinetis Bootloader by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|