321 lines
17 KiB
HTML
321 lines
17 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.5"/>
|
|
<title>MCUXpresso SDK API Reference Manual: FLEXCOMM 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">MCUXpresso SDK API Reference Manual
|
|
 <span id="projectnumber">Rev 2.15.000</span>
|
|
</div>
|
|
<div id="projectbrief">NXP Semiconductors</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<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('a00244.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="#typedef-members">Typedefs</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">FLEXCOMM Driver<div class="ingroups"><a class="el" href="a00243.html">FLEXCOMM: FLEXCOMM 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="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gacc9fdd92a043129607c887924fb5091e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00244.html#gacc9fdd92a043129607c887924fb5091e">flexcomm_irq_handler_t</a> )(void *base, void *handle)</td></tr>
|
|
<tr class="memdesc:gacc9fdd92a043129607c887924fb5091e"><td class="mdescLeft"> </td><td class="mdescRight">Typedef for interrupt handler. <a href="#gacc9fdd92a043129607c887924fb5091e">More...</a><br/></td></tr>
|
|
<tr class="separator:gacc9fdd92a043129607c887924fb5091e"><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:ga41eebbb4c49103c4d42f91c8f542c2c7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00244.html#ga41eebbb4c49103c4d42f91c8f542c2c7">FLEXCOMM_PERIPH_T</a> { <br/>
|
|
  <a class="el" href="a00244.html#gga41eebbb4c49103c4d42f91c8f542c2c7a5267e78e8168917f02771e148263ae39">FLEXCOMM_PERIPH_NONE</a>,
|
|
<br/>
|
|
  <a class="el" href="a00244.html#gga41eebbb4c49103c4d42f91c8f542c2c7a521e81a10b97ae653b96bffa0599ddb7">FLEXCOMM_PERIPH_USART</a>,
|
|
<br/>
|
|
  <a class="el" href="a00244.html#gga41eebbb4c49103c4d42f91c8f542c2c7a2b729c2b97777dfed1160f0c575405ae">FLEXCOMM_PERIPH_SPI</a>,
|
|
<br/>
|
|
  <a class="el" href="a00244.html#gga41eebbb4c49103c4d42f91c8f542c2c7a40c0d12edb101f8a14391ff9ae913d5a">FLEXCOMM_PERIPH_I2C</a>,
|
|
<br/>
|
|
  <a class="el" href="a00244.html#gga41eebbb4c49103c4d42f91c8f542c2c7a76a11c2952b8cd493e9b4cbab0caf26f">FLEXCOMM_PERIPH_I2S_TX</a>,
|
|
<br/>
|
|
  <a class="el" href="a00244.html#gga41eebbb4c49103c4d42f91c8f542c2c7a0992c9fae611def028d88282a684337f">FLEXCOMM_PERIPH_I2S_RX</a>
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga41eebbb4c49103c4d42f91c8f542c2c7"><td class="mdescLeft"> </td><td class="mdescRight">FLEXCOMM peripheral modes. <a href="a00244.html#ga41eebbb4c49103c4d42f91c8f542c2c7">More...</a><br/></td></tr>
|
|
<tr class="separator:ga41eebbb4c49103c4d42f91c8f542c2c7"><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:ga59338c42d2715c76e95c4dc2c1190f08"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00244.html#ga59338c42d2715c76e95c4dc2c1190f08">FLEXCOMM_GetInstance</a> (void *base)</td></tr>
|
|
<tr class="memdesc:ga59338c42d2715c76e95c4dc2c1190f08"><td class="mdescLeft"> </td><td class="mdescRight">Returns instance number for FLEXCOMM module with given base address. <a href="#ga59338c42d2715c76e95c4dc2c1190f08">More...</a><br/></td></tr>
|
|
<tr class="separator:ga59338c42d2715c76e95c4dc2c1190f08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaff39b352ed7517521dfcece68ba34327"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00244.html#gaff39b352ed7517521dfcece68ba34327">FLEXCOMM_Init</a> (void *base, <a class="el" href="a00244.html#ga41eebbb4c49103c4d42f91c8f542c2c7">FLEXCOMM_PERIPH_T</a> periph)</td></tr>
|
|
<tr class="memdesc:gaff39b352ed7517521dfcece68ba34327"><td class="mdescLeft"> </td><td class="mdescRight">Initializes FLEXCOMM and selects peripheral mode according to the second parameter. <a href="#gaff39b352ed7517521dfcece68ba34327">More...</a><br/></td></tr>
|
|
<tr class="separator:gaff39b352ed7517521dfcece68ba34327"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaedf64691b871a2b0ea6a68fab284376a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00244.html#gaedf64691b871a2b0ea6a68fab284376a">FLEXCOMM_SetIRQHandler</a> (void *base, <a class="el" href="a00244.html#gacc9fdd92a043129607c887924fb5091e">flexcomm_irq_handler_t</a> handler, void *flexcommHandle)</td></tr>
|
|
<tr class="memdesc:gaedf64691b871a2b0ea6a68fab284376a"><td class="mdescLeft"> </td><td class="mdescRight">Sets IRQ handler for given FLEXCOMM module. <a href="#gaedf64691b871a2b0ea6a68fab284376a">More...</a><br/></td></tr>
|
|
<tr class="separator:gaedf64691b871a2b0ea6a68fab284376a"><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:gaabebf81a3461faf8346ce8c8365d09e8"><td class="memItemLeft" align="right" valign="top">IRQn_Type const </td><td class="memItemRight" valign="bottom"><a class="el" href="a00244.html#gaabebf81a3461faf8346ce8c8365d09e8">kFlexcommIrqs</a> []</td></tr>
|
|
<tr class="memdesc:gaabebf81a3461faf8346ce8c8365d09e8"><td class="mdescLeft"> </td><td class="mdescRight">Array with IRQ number for each FLEXCOMM module. <a href="#gaabebf81a3461faf8346ce8c8365d09e8">More...</a><br/></td></tr>
|
|
<tr class="separator:gaabebf81a3461faf8346ce8c8365d09e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Driver version</h2></td></tr>
|
|
<tr class="memitem:gadc55e534f6ccd8ba097cdefb6e669c50"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00244.html#gadc55e534f6ccd8ba097cdefb6e669c50">FSL_FLEXCOMM_DRIVER_VERSION</a>   (<a class="el" href="a00242.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 0, 2))</td></tr>
|
|
<tr class="memdesc:gadc55e534f6ccd8ba097cdefb6e669c50"><td class="mdescLeft"> </td><td class="mdescRight">FlexCOMM driver version 2.0.2. <a href="#gadc55e534f6ccd8ba097cdefb6e669c50">More...</a><br/></td></tr>
|
|
<tr class="separator:gadc55e534f6ccd8ba097cdefb6e669c50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="gadc55e534f6ccd8ba097cdefb6e669c50"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_FLEXCOMM_DRIVER_VERSION   (<a class="el" href="a00242.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 0, 2))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="gacc9fdd92a043129607c887924fb5091e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* flexcomm_irq_handler_t)(void *base, void *handle)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga41eebbb4c49103c4d42f91c8f542c2c7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00244.html#ga41eebbb4c49103c4d42f91c8f542c2c7">FLEXCOMM_PERIPH_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="gga41eebbb4c49103c4d42f91c8f542c2c7a5267e78e8168917f02771e148263ae39"></a>FLEXCOMM_PERIPH_NONE</em> </td><td class="fielddoc">
|
|
<p>No peripheral. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga41eebbb4c49103c4d42f91c8f542c2c7a521e81a10b97ae653b96bffa0599ddb7"></a>FLEXCOMM_PERIPH_USART</em> </td><td class="fielddoc">
|
|
<p>USART peripheral. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga41eebbb4c49103c4d42f91c8f542c2c7a2b729c2b97777dfed1160f0c575405ae"></a>FLEXCOMM_PERIPH_SPI</em> </td><td class="fielddoc">
|
|
<p>SPI Peripheral. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga41eebbb4c49103c4d42f91c8f542c2c7a40c0d12edb101f8a14391ff9ae913d5a"></a>FLEXCOMM_PERIPH_I2C</em> </td><td class="fielddoc">
|
|
<p>I2C Peripheral. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga41eebbb4c49103c4d42f91c8f542c2c7a76a11c2952b8cd493e9b4cbab0caf26f"></a>FLEXCOMM_PERIPH_I2S_TX</em> </td><td class="fielddoc">
|
|
<p>I2S TX Peripheral. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga41eebbb4c49103c4d42f91c8f542c2c7a0992c9fae611def028d88282a684337f"></a>FLEXCOMM_PERIPH_I2S_RX</em> </td><td class="fielddoc">
|
|
<p>I2S RX Peripheral. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga59338c42d2715c76e95c4dc2c1190f08"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t FLEXCOMM_GetInstance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaff39b352ed7517521dfcece68ba34327"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00242.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> FLEXCOMM_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00244.html#ga41eebbb4c49103c4d42f91c8f542c2c7">FLEXCOMM_PERIPH_T</a> </td>
|
|
<td class="paramname"><em>periph</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaedf64691b871a2b0ea6a68fab284376a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FLEXCOMM_SetIRQHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00244.html#gacc9fdd92a043129607c887924fb5091e">flexcomm_irq_handler_t</a> </td>
|
|
<td class="paramname"><em>handler</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>flexcommHandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>It is used by drivers register IRQ handler according to FLEXCOMM mode </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a class="anchor" id="gaabebf81a3461faf8346ce8c8365d09e8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">IRQn_Type const kFlexcommIrqs[]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</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>
|