687 lines
36 KiB
HTML
687 lines
36 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: LPC_ACOMP: Analog comparator 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.11.0</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('a00008.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="#files">Files</a> |
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">LPC_ACOMP: Analog comparator Driver</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<p>The MCUXpresso SDK provides a peripheral driver for the Analog comparator (LPC_ACOMP) module of MCUXpresso SDK devices.</p>
|
|
<h1><a class="anchor" id="LPCACOMPTpyUC"></a>
|
|
Typical use case</h1>
|
|
<h2><a class="anchor" id="LPCACOMPBasicConfig"></a>
|
|
Polling Configuration</h2>
|
|
<p>Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/acomp/acomp_basic </p>
|
|
<h2><a class="anchor" id="LPCACOMPIntConfig"></a>
|
|
Interrupt Configuration</h2>
|
|
<p>Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/acomp/acomp_interrupt </p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
|
|
Files</h2></td></tr>
|
|
<tr class="memitem:a00049"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00049.html">fsl_acomp.h</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00106"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#a00106">acomp_config_t</a></td></tr>
|
|
<tr class="memdesc:a00106"><td class="mdescLeft"> </td><td class="mdescRight">The structure for ACOMP basic configuration. <a href="a00008.html#a00106">More...</a><br/></td></tr>
|
|
<tr class="separator:a00106"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00107"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#a00107">acomp_ladder_config_t</a></td></tr>
|
|
<tr class="memdesc:a00107"><td class="mdescLeft"> </td><td class="mdescRight">The structure for ACOMP voltage ladder. <a href="a00008.html#a00107">More...</a><br/></td></tr>
|
|
<tr class="separator:a00107"><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:ga7ad629d52b0a70f95cd2ddb3bee8ab5f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#ga7ad629d52b0a70f95cd2ddb3bee8ab5f">acomp_ladder_reference_voltage_t</a> { <br/>
|
|
  <a class="el" href="a00008.html#gga7ad629d52b0a70f95cd2ddb3bee8ab5fa70a5aa61894fc8d2195652c2fa3423aa">kACOMP_LadderRefVoltagePinVDD</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00008.html#gga7ad629d52b0a70f95cd2ddb3bee8ab5fa56718eb64fdbbd04648466547b326c35">kACOMP_LadderRefVoltagePinVDDCMP</a> = 1U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga7ad629d52b0a70f95cd2ddb3bee8ab5f"><td class="mdescLeft"> </td><td class="mdescRight">The ACOMP ladder reference voltage. <a href="a00008.html#ga7ad629d52b0a70f95cd2ddb3bee8ab5f">More...</a><br/></td></tr>
|
|
<tr class="separator:ga7ad629d52b0a70f95cd2ddb3bee8ab5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga178d521ca2ee7f33d518b30dfb627d20"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#ga178d521ca2ee7f33d518b30dfb627d20">acomp_interrupt_enable_t</a> { <br/>
|
|
  <a class="el" href="a00008.html#gga178d521ca2ee7f33d518b30dfb627d20ad015e6ad9b09be27a6de122fde6b3997">kACOMP_InterruptsFallingEdgeEnable</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00008.html#gga178d521ca2ee7f33d518b30dfb627d20a25801b009aba402b9810189eb8545b8b">kACOMP_InterruptsRisingEdgeEnable</a> = 1U,
|
|
<br/>
|
|
  <a class="el" href="a00008.html#gga178d521ca2ee7f33d518b30dfb627d20a23743234a07f6c25a2b14cca0cd863c7">kACOMP_InterruptsBothEdgesEnable</a> = 2U,
|
|
<br/>
|
|
  <a class="el" href="a00008.html#gga178d521ca2ee7f33d518b30dfb627d20a629a3a054d3fde07b8f1d4974a9d070d">kACOMP_InterruptsDisable</a> = 3U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga178d521ca2ee7f33d518b30dfb627d20"><td class="mdescLeft"> </td><td class="mdescRight">The ACOMP interrupts enable. <a href="a00008.html#ga178d521ca2ee7f33d518b30dfb627d20">More...</a><br/></td></tr>
|
|
<tr class="separator:ga178d521ca2ee7f33d518b30dfb627d20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa7c0a15052b6421941faad3c6ea3a5ac"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#gaa7c0a15052b6421941faad3c6ea3a5ac">acomp_hysteresis_selection_t</a> { <br/>
|
|
  <a class="el" href="a00008.html#ggaa7c0a15052b6421941faad3c6ea3a5acae003c683374deba88f335221e4f6c62b">kACOMP_HysteresisNoneSelection</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00008.html#ggaa7c0a15052b6421941faad3c6ea3a5acae6c2b1547a7e476425962d46b44a00f9">kACOMP_Hysteresis5MVSelection</a> = 1U,
|
|
<br/>
|
|
  <a class="el" href="a00008.html#ggaa7c0a15052b6421941faad3c6ea3a5aca25ed95469736b1383c06835f1a59a6f7">kACOMP_Hysteresis10MVSelection</a> = 2U,
|
|
<br/>
|
|
  <a class="el" href="a00008.html#ggaa7c0a15052b6421941faad3c6ea3a5acab609612c0f5c6987b71f287d0ab8e02c">kACOMP_Hysteresis20MVSelection</a> = 3U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gaa7c0a15052b6421941faad3c6ea3a5ac"><td class="mdescLeft"> </td><td class="mdescRight">The ACOMP hysteresis selection. <a href="a00008.html#gaa7c0a15052b6421941faad3c6ea3a5ac">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa7c0a15052b6421941faad3c6ea3a5ac"><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:ga856c35b78deb42642464ecfdb8dfa8aa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#ga856c35b78deb42642464ecfdb8dfa8aa">FSL_ACOMP_DRIVER_VERSION</a>   (<a class="el" href="a00087.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 0))</td></tr>
|
|
<tr class="memdesc:ga856c35b78deb42642464ecfdb8dfa8aa"><td class="mdescLeft"> </td><td class="mdescRight">ACOMP driver version 2.1.0. <a href="#ga856c35b78deb42642464ecfdb8dfa8aa">More...</a><br/></td></tr>
|
|
<tr class="separator:ga856c35b78deb42642464ecfdb8dfa8aa"><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>
|
|
Initialization</h2></td></tr>
|
|
<tr class="memitem:gae8afb04a61cd16f74eba67061409cd30"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#gae8afb04a61cd16f74eba67061409cd30">ACOMP_Init</a> (ACOMP_Type *base, const <a class="el" href="a00008.html#a00106">acomp_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:gae8afb04a61cd16f74eba67061409cd30"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the ACOMP module. <a href="#gae8afb04a61cd16f74eba67061409cd30">More...</a><br/></td></tr>
|
|
<tr class="separator:gae8afb04a61cd16f74eba67061409cd30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4e2589a3a011cb833649e301be7fff8c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#ga4e2589a3a011cb833649e301be7fff8c">ACOMP_Deinit</a> (ACOMP_Type *base)</td></tr>
|
|
<tr class="memdesc:ga4e2589a3a011cb833649e301be7fff8c"><td class="mdescLeft"> </td><td class="mdescRight">De-initialize the ACOMP module. <a href="#ga4e2589a3a011cb833649e301be7fff8c">More...</a><br/></td></tr>
|
|
<tr class="separator:ga4e2589a3a011cb833649e301be7fff8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae217e6b6f23e998b1bfa387e1f3f4181"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#gae217e6b6f23e998b1bfa387e1f3f4181">ACOMP_GetDefaultConfig</a> (<a class="el" href="a00008.html#a00106">acomp_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:gae217e6b6f23e998b1bfa387e1f3f4181"><td class="mdescLeft"> </td><td class="mdescRight">Gets an available pre-defined settings for the ACOMP's configuration. <a href="#gae217e6b6f23e998b1bfa387e1f3f4181">More...</a><br/></td></tr>
|
|
<tr class="separator:gae217e6b6f23e998b1bfa387e1f3f4181"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga33fc82023d54cc469fc62ed866a3ca19"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#ga33fc82023d54cc469fc62ed866a3ca19">ACOMP_EnableInterrupts</a> (ACOMP_Type *base, <a class="el" href="a00008.html#ga178d521ca2ee7f33d518b30dfb627d20">acomp_interrupt_enable_t</a> enable)</td></tr>
|
|
<tr class="memdesc:ga33fc82023d54cc469fc62ed866a3ca19"><td class="mdescLeft"> </td><td class="mdescRight">Enable ACOMP interrupts. <a href="#ga33fc82023d54cc469fc62ed866a3ca19">More...</a><br/></td></tr>
|
|
<tr class="separator:ga33fc82023d54cc469fc62ed866a3ca19"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga331e1a82fe5f3d36ee0b10ddea928cd0"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#ga331e1a82fe5f3d36ee0b10ddea928cd0">ACOMP_GetInterruptsStatusFlags</a> (ACOMP_Type *base)</td></tr>
|
|
<tr class="memdesc:ga331e1a82fe5f3d36ee0b10ddea928cd0"><td class="mdescLeft"> </td><td class="mdescRight">Get interrupts status flags. <a href="#ga331e1a82fe5f3d36ee0b10ddea928cd0">More...</a><br/></td></tr>
|
|
<tr class="separator:ga331e1a82fe5f3d36ee0b10ddea928cd0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga013efc3edfbbd3f7f5044fc7bc2ce802"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#ga013efc3edfbbd3f7f5044fc7bc2ce802">ACOMP_ClearInterruptsStatusFlags</a> (ACOMP_Type *base)</td></tr>
|
|
<tr class="memdesc:ga013efc3edfbbd3f7f5044fc7bc2ce802"><td class="mdescLeft"> </td><td class="mdescRight">Clear the ACOMP interrupts status flags. <a href="#ga013efc3edfbbd3f7f5044fc7bc2ce802">More...</a><br/></td></tr>
|
|
<tr class="separator:ga013efc3edfbbd3f7f5044fc7bc2ce802"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0ea4f61940e0c270858758d51ae1a4d3"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#ga0ea4f61940e0c270858758d51ae1a4d3">ACOMP_GetOutputStatusFlags</a> (ACOMP_Type *base)</td></tr>
|
|
<tr class="memdesc:ga0ea4f61940e0c270858758d51ae1a4d3"><td class="mdescLeft"> </td><td class="mdescRight">Get ACOMP output status flags. <a href="#ga0ea4f61940e0c270858758d51ae1a4d3">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0ea4f61940e0c270858758d51ae1a4d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaff80c9cfc3eb8114fcdb525b507f7ba3"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#gaff80c9cfc3eb8114fcdb525b507f7ba3">ACOMP_SetInputChannel</a> (ACOMP_Type *base, uint32_t postiveInputChannel, uint32_t negativeInputChannel)</td></tr>
|
|
<tr class="memdesc:gaff80c9cfc3eb8114fcdb525b507f7ba3"><td class="mdescLeft"> </td><td class="mdescRight">Set the ACOMP postive and negative input channel. <a href="#gaff80c9cfc3eb8114fcdb525b507f7ba3">More...</a><br/></td></tr>
|
|
<tr class="separator:gaff80c9cfc3eb8114fcdb525b507f7ba3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6b5b26d4b5e00361635aede71b048ffb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#ga6b5b26d4b5e00361635aede71b048ffb">ACOMP_SetLadderConfig</a> (ACOMP_Type *base, const <a class="el" href="a00008.html#a00107">acomp_ladder_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga6b5b26d4b5e00361635aede71b048ffb"><td class="mdescLeft"> </td><td class="mdescRight">Set the voltage ladder configuration. <a href="#ga6b5b26d4b5e00361635aede71b048ffb">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6b5b26d4b5e00361635aede71b048ffb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00106" id="a00106"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct acomp_config_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:a6f9542645b06542277cb07ea138e5064"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#a6f9542645b06542277cb07ea138e5064">enableSyncToBusClk</a></td></tr>
|
|
<tr class="memdesc:a6f9542645b06542277cb07ea138e5064"><td class="mdescLeft"> </td><td class="mdescRight">If true, Comparator output is synchronized to the bus clock for output to other modules. <a href="#a6f9542645b06542277cb07ea138e5064">More...</a><br/></td></tr>
|
|
<tr class="separator:a6f9542645b06542277cb07ea138e5064"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46ecb6f7efe54967d816deafdf1c65ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00008.html#gaa7c0a15052b6421941faad3c6ea3a5ac">acomp_hysteresis_selection_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#a46ecb6f7efe54967d816deafdf1c65ce">hysteresisSelection</a></td></tr>
|
|
<tr class="memdesc:a46ecb6f7efe54967d816deafdf1c65ce"><td class="mdescLeft"> </td><td class="mdescRight">Controls the hysteresis of the comparator. <a href="#a46ecb6f7efe54967d816deafdf1c65ce">More...</a><br/></td></tr>
|
|
<tr class="separator:a46ecb6f7efe54967d816deafdf1c65ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a6f9542645b06542277cb07ea138e5064"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool acomp_config_t::enableSyncToBusClk</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If false, Comparator output is used directly. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a46ecb6f7efe54967d816deafdf1c65ce"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00008.html#gaa7c0a15052b6421941faad3c6ea3a5ac">acomp_hysteresis_selection_t</a> acomp_config_t::hysteresisSelection</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00107" id="a00107"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct acomp_ladder_config_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:a8271667393096dad310f8b2e486b1c4b"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#a8271667393096dad310f8b2e486b1c4b">ladderValue</a></td></tr>
|
|
<tr class="memdesc:a8271667393096dad310f8b2e486b1c4b"><td class="mdescLeft"> </td><td class="mdescRight">Voltage ladder value. <a href="#a8271667393096dad310f8b2e486b1c4b">More...</a><br/></td></tr>
|
|
<tr class="separator:a8271667393096dad310f8b2e486b1c4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66356c0246938695521e8a0ece69cf11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00008.html#ga7ad629d52b0a70f95cd2ddb3bee8ab5f">acomp_ladder_reference_voltage_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#a66356c0246938695521e8a0ece69cf11">referenceVoltage</a></td></tr>
|
|
<tr class="memdesc:a66356c0246938695521e8a0ece69cf11"><td class="mdescLeft"> </td><td class="mdescRight">Selects the reference voltage(Vref) for the voltage ladder. <a href="#a66356c0246938695521e8a0ece69cf11">More...</a><br/></td></tr>
|
|
<tr class="separator:a66356c0246938695521e8a0ece69cf11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a8271667393096dad310f8b2e486b1c4b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t acomp_ladder_config_t::ladderValue</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>00000 = Vss, 00001 = 1*Vref/31, ..., 11111 = Vref. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a66356c0246938695521e8a0ece69cf11"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00008.html#ga7ad629d52b0a70f95cd2ddb3bee8ab5f">acomp_ladder_reference_voltage_t</a> acomp_ladder_config_t::referenceVoltage</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga856c35b78deb42642464ecfdb8dfa8aa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_ACOMP_DRIVER_VERSION   (<a class="el" href="a00087.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 0))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga7ad629d52b0a70f95cd2ddb3bee8ab5f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00008.html#ga7ad629d52b0a70f95cd2ddb3bee8ab5f">acomp_ladder_reference_voltage_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="gga7ad629d52b0a70f95cd2ddb3bee8ab5fa70a5aa61894fc8d2195652c2fa3423aa"></a>kACOMP_LadderRefVoltagePinVDD</em> </td><td class="fielddoc">
|
|
<p>Supply from pin VDD. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga7ad629d52b0a70f95cd2ddb3bee8ab5fa56718eb64fdbbd04648466547b326c35"></a>kACOMP_LadderRefVoltagePinVDDCMP</em> </td><td class="fielddoc">
|
|
<p>Supply from pin VDDCMP. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga178d521ca2ee7f33d518b30dfb627d20"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00008.html#ga178d521ca2ee7f33d518b30dfb627d20">acomp_interrupt_enable_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="gga178d521ca2ee7f33d518b30dfb627d20ad015e6ad9b09be27a6de122fde6b3997"></a>kACOMP_InterruptsFallingEdgeEnable</em> </td><td class="fielddoc">
|
|
<p>Enable the falling edge interrupts. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga178d521ca2ee7f33d518b30dfb627d20a25801b009aba402b9810189eb8545b8b"></a>kACOMP_InterruptsRisingEdgeEnable</em> </td><td class="fielddoc">
|
|
<p>Enable the rising edge interrupts. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga178d521ca2ee7f33d518b30dfb627d20a23743234a07f6c25a2b14cca0cd863c7"></a>kACOMP_InterruptsBothEdgesEnable</em> </td><td class="fielddoc">
|
|
<p>Enable the both edges interrupts. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga178d521ca2ee7f33d518b30dfb627d20a629a3a054d3fde07b8f1d4974a9d070d"></a>kACOMP_InterruptsDisable</em> </td><td class="fielddoc">
|
|
<p>Disable the interrupts. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa7c0a15052b6421941faad3c6ea3a5ac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00008.html#gaa7c0a15052b6421941faad3c6ea3a5ac">acomp_hysteresis_selection_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="ggaa7c0a15052b6421941faad3c6ea3a5acae003c683374deba88f335221e4f6c62b"></a>kACOMP_HysteresisNoneSelection</em> </td><td class="fielddoc">
|
|
<p>None (the output will switch as the voltages cross). </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaa7c0a15052b6421941faad3c6ea3a5acae6c2b1547a7e476425962d46b44a00f9"></a>kACOMP_Hysteresis5MVSelection</em> </td><td class="fielddoc">
|
|
<p>5mV. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaa7c0a15052b6421941faad3c6ea3a5aca25ed95469736b1383c06835f1a59a6f7"></a>kACOMP_Hysteresis10MVSelection</em> </td><td class="fielddoc">
|
|
<p>10mV. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaa7c0a15052b6421941faad3c6ea3a5acab609612c0f5c6987b71f287d0ab8e02c"></a>kACOMP_Hysteresis20MVSelection</em> </td><td class="fielddoc">
|
|
<p>20mV. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gae8afb04a61cd16f74eba67061409cd30"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ACOMP_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ACOMP_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="a00008.html#a00106">acomp_config_t</a> * </td>
|
|
<td class="paramname"><em>config</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="paramname">base</td><td>ACOMP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">config</td><td>Pointer to "acomp_config_t" structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga4e2589a3a011cb833649e301be7fff8c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ACOMP_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ACOMP_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>ACOMP peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae217e6b6f23e998b1bfa387e1f3f4181"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ACOMP_GetDefaultConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00008.html#a00106">acomp_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initializes the converter configuration structure with available settings. The default values are: </p>
|
|
<div class="fragment"><div class="line">* config->enableSyncToBusClk = <span class="keyword">false</span>;</div>
|
|
<div class="line">* config->hysteresisSelection = kACOMP_hysteresisNoneSelection;</div>
|
|
<div class="line">* </div>
|
|
</div><!-- fragment --><p> In default configuration, the ACOMP's output would be used directly and switch as the voltages cross.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to the configuration structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga33fc82023d54cc469fc62ed866a3ca19"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ACOMP_EnableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ACOMP_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00008.html#ga178d521ca2ee7f33d518b30dfb627d20">acomp_interrupt_enable_t</a> </td>
|
|
<td class="paramname"><em>enable</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="paramname">base</td><td>ACOMP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Enable/Disable interrupt feature. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga331e1a82fe5f3d36ee0b10ddea928cd0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool ACOMP_GetInterruptsStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ACOMP_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>ACOMP peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reflect the state ACOMP edge-detect status, true or false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga013efc3edfbbd3f7f5044fc7bc2ce802"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void ACOMP_ClearInterruptsStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ACOMP_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>ACOMP peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0ea4f61940e0c270858758d51ae1a4d3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool ACOMP_GetOutputStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ACOMP_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>ACOMP peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reflect the state of the comparator output, true or false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaff80c9cfc3eb8114fcdb525b507f7ba3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void ACOMP_SetInputChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ACOMP_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>postiveInputChannel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>negativeInputChannel</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>ACOMP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">postiveInputChannel</td><td>The index of postive input channel. </td></tr>
|
|
<tr><td class="paramname">negativeInputChannel</td><td>The index of negative input channel. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6b5b26d4b5e00361635aede71b048ffb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ACOMP_SetLadderConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ACOMP_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="a00008.html#a00107">acomp_ladder_config_t</a> * </td>
|
|
<td class="paramname"><em>config</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="paramname">base</td><td>ACOMP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">config</td><td>The structure for voltage ladder. If the config is NULL, voltage ladder would be diasbled, otherwise the voltage ladder would be configured and enabled. </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>
|