217 lines
13 KiB
HTML
217 lines
13 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: UART 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__uart__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="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">UART 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>UART 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 UART 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__uart__peripheral.svg" width="322" 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="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga4056a1a2108d637a04cf5eb8a6b56de7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4056a1a2108d637a04cf5eb8a6b56de7"></a>
|
|
static UART_Type * </td><td class="memItemRight" valign="bottom"><b>get_uart_baseAddr</b> (uint32_t instance)</td></tr>
|
|
<tr class="separator:ga4056a1a2108d637a04cf5eb8a6b56de7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga965fc1f1ac06f402b648f1acc861de9e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga965fc1f1ac06f402b648f1acc861de9e"></a>
|
|
static bool </td><td class="memItemRight" valign="bottom"><b>uart_poll_for_activity</b> (const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:ga965fc1f1ac06f402b648f1acc861de9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac4ba7f0222d552dea89d57474adde864"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac4ba7f0222d552dea89d57474adde864"></a>
|
|
static <a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><b>uart_full_init</b> (const peripheral_descriptor_t *self, serial_byte_receive_func_t function)</td></tr>
|
|
<tr class="separator:gac4ba7f0222d552dea89d57474adde864"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa1db5f732ec65757452200871f483c30"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uart__peripheral.html#gaa1db5f732ec65757452200871f483c30">uart_full_shutdown</a> (const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:gaa1db5f732ec65757452200871f483c30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2ec0b416a087dc5ba420232d545e9792"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2ec0b416a087dc5ba420232d545e9792"></a>
|
|
static <a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><b>uart_write</b> (const peripheral_descriptor_t *self, const uint8_t *buffer, uint32_t byteCount)</td></tr>
|
|
<tr class="separator:ga2ec0b416a087dc5ba420232d545e9792"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1c0544b06d54b198d8c50f507e399a91"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1c0544b06d54b198d8c50f507e399a91"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>UART0_IRQHandler</b> (void)</td></tr>
|
|
<tr class="separator:ga1c0544b06d54b198d8c50f507e399a91"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga81be101f2729b7893235f704f583533e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga81be101f2729b7893235f704f583533e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>UART1_IRQHandler</b> (void)</td></tr>
|
|
<tr class="separator:ga81be101f2729b7893235f704f583533e"><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:gaf3ea77b21700171cc78084a493d622da"><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__uart__peripheral.html#gaf3ea77b21700171cc78084a493d622da">g_uartControlInterface</a></td></tr>
|
|
<tr class="memdesc:gaf3ea77b21700171cc78084a493d622da"><td class="mdescLeft"> </td><td class="mdescRight">Control interface for the UART peripheral driver. <a href="#gaf3ea77b21700171cc78084a493d622da">More...</a><br /></td></tr>
|
|
<tr class="separator:gaf3ea77b21700171cc78084a493d622da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga68ca852206d23d21c667b1ec268ecf06"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga68ca852206d23d21c667b1ec268ecf06"></a>
|
|
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__uart__peripheral.html#ga68ca852206d23d21c667b1ec268ecf06">g_uartByteInterface</a> = {.init = NULL, .write = uart_write }</td></tr>
|
|
<tr class="memdesc:ga68ca852206d23d21c667b1ec268ecf06"><td class="mdescLeft"> </td><td class="mdescRight">Byte I/O interface for the UART peripheral driver. <br /></td></tr>
|
|
<tr class="separator:ga68ca852206d23d21c667b1ec268ecf06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4e26ec9b57cff3125c5385d8191d7a3d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4e26ec9b57cff3125c5385d8191d7a3d"></a>
|
|
static serial_byte_receive_func_t </td><td class="memItemRight" valign="bottom"><b>s_uart_byte_receive_callback</b></td></tr>
|
|
<tr class="separator:ga4e26ec9b57cff3125c5385d8191d7a3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga07d5bd15ee64a0dfd4a026d086867b70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga07d5bd15ee64a0dfd4a026d086867b70"></a>
|
|
static bool </td><td class="memItemRight" valign="bottom"><b>g_uartInitDone</b> = false</td></tr>
|
|
<tr class="separator:ga07d5bd15ee64a0dfd4a026d086867b70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Usage Information</h2>
|
|
<p>UART peripheral interface. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gaa1db5f732ec65757452200871f483c30"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void uart_full_shutdown </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const peripheral_descriptor_t * </td>
|
|
<td class="paramname"><em>self</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Note: if not deinit autobaud(IRQ method), user app may encounters hardfault if it doesn't provide related pin interrupt service routine. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a class="anchor" id="gaf3ea77b21700171cc78084a493d622da"></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_uartControlInterface</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">= {</div><div class="line"> .pollForActivity = uart_poll_for_activity, .init = uart_full_init, .shutdown = <a class="code" href="group__uart__peripheral.html#gaa1db5f732ec65757452200871f483c30">uart_full_shutdown</a>, .pump = 0</div><div class="line">}</div><div class="ttc" id="group__uart__peripheral_html_gaa1db5f732ec65757452200871f483c30"><div class="ttname"><a href="group__uart__peripheral.html#gaa1db5f732ec65757452200871f483c30">uart_full_shutdown</a></div><div class="ttdeci">static void uart_full_shutdown(const peripheral_descriptor_t *self)</div><div class="ttdef"><b>Definition:</b> uart_peripheral_interface.c:152</div></div>
|
|
</div><!-- fragment -->
|
|
<p>Control interface for the UART peripheral driver. </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>
|