414 lines
29 KiB
HTML
414 lines
29 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: Peripheral Interface</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__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="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Peripheral Interface<div class="ingroups"><a class="el" href="group__bootloader.html">Bootloader</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>API for peripheral interfaces.
|
|
<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 Peripheral Interface:</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__peripheral.svg" width="276" 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:structperipheral__control__interface__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#structperipheral__control__interface__t">peripheral_control_interface_t</a></td></tr>
|
|
<tr class="memdesc:structperipheral__control__interface__t"><td class="mdescLeft"> </td><td class="mdescRight">Peripheral control interface. <a href="group__peripheral.html#structperipheral__control__interface__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structperipheral__control__interface__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structperipheral__byte__inteface__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#structperipheral__byte__inteface__t">peripheral_byte_inteface_t</a></td></tr>
|
|
<tr class="memdesc:structperipheral__byte__inteface__t"><td class="mdescLeft"> </td><td class="mdescRight">Peripheral abstract byte interface. <a href="group__peripheral.html#structperipheral__byte__inteface__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structperipheral__byte__inteface__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structperipheral__packet__interface__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#structperipheral__packet__interface__t">peripheral_packet_interface_t</a></td></tr>
|
|
<tr class="memdesc:structperipheral__packet__interface__t"><td class="mdescLeft"> </td><td class="mdescRight">Peripheral Packet Interface. <a href="group__peripheral.html#structperipheral__packet__interface__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structperipheral__packet__interface__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:struct_peripheral_descriptor"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#struct_peripheral_descriptor">peripheral_descriptor_t</a></td></tr>
|
|
<tr class="memdesc:struct_peripheral_descriptor"><td class="mdescLeft"> </td><td class="mdescRight">Peripheral descriptor. <a href="group__peripheral.html#struct_peripheral_descriptor">More...</a><br /></td></tr>
|
|
<tr class="separator:struct_peripheral_descriptor"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga8a7362bf9dc08159e1f7000890bc4ebf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8a7362bf9dc08159e1f7000890bc4ebf"></a>
|
|
typedef void(* </td><td class="memItemRight" valign="bottom"><b>serial_byte_receive_func_t</b>) (uint8_t)</td></tr>
|
|
<tr class="separator:ga8a7362bf9dc08159e1f7000890bc4ebf"><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:ga9fbe682bf20c8eb79f22dac5d876cde1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#ga9fbe682bf20c8eb79f22dac5d876cde1">_peripheral_types</a> { <br />
|
|
  <b>kPeripheralType_UART</b> = (1 << 0),
|
|
<br />
|
|
  <b>kPeripheralType_I2CSlave</b> = (1 << 1),
|
|
<br />
|
|
  <b>kPeripheralType_SPISlave</b> = (1 << 2),
|
|
<br />
|
|
  <b>kPeripheralType_CAN</b> = (1 << 3),
|
|
<br />
|
|
  <b>kPeripheralType_USB_HID</b> = (1 << 4),
|
|
<br />
|
|
  <b>kPeripheralType_USB_CDC</b> = (1 << 5),
|
|
<br />
|
|
  <b>kPeripheralType_USB_DFU</b> = (1 << 6),
|
|
<br />
|
|
  <b>kPeripheralType_USB_MSC</b> = (1 << 7)
|
|
<br />
|
|
}<tr class="memdesc:ga9fbe682bf20c8eb79f22dac5d876cde1"><td class="mdescLeft"> </td><td class="mdescRight">Peripheral type bit mask definitions. <a href="group__peripheral.html#ga9fbe682bf20c8eb79f22dac5d876cde1">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga9fbe682bf20c8eb79f22dac5d876cde1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa37d9314ea323173c2e6a8852ed971db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa37d9314ea323173c2e6a8852ed971db"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#gaa37d9314ea323173c2e6a8852ed971db">pinmux_type_t</a> { <br />
|
|
  <b>kPinmuxType_Default</b> = 0,
|
|
<br />
|
|
  <b>kPinmuxType_GPIO</b> = 1,
|
|
<br />
|
|
  <b>kPinmuxType_Peripheral</b> = 2
|
|
<br />
|
|
}<tr class="memdesc:gaa37d9314ea323173c2e6a8852ed971db"><td class="mdescLeft"> </td><td class="mdescRight">Pinmux types. <br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gaa37d9314ea323173c2e6a8852ed971db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga864fc0d1fbad74e37628f58051c8e3f7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#ga864fc0d1fbad74e37628f58051c8e3f7">packet_type_t</a> { <br />
|
|
  <a class="el" href="group__peripheral.html#gga864fc0d1fbad74e37628f58051c8e3f7ac6247e577f9548697d503ced8a809a60">kPacketType_Command</a>,
|
|
<br />
|
|
  <a class="el" href="group__peripheral.html#gga864fc0d1fbad74e37628f58051c8e3f7a72e7fc42591ecec5ab6b3857a318113a">kPacketType_Data</a>
|
|
<br />
|
|
}<tr class="memdesc:ga864fc0d1fbad74e37628f58051c8e3f7"><td class="mdescLeft"> </td><td class="mdescRight">Packet types. <a href="group__peripheral.html#ga864fc0d1fbad74e37628f58051c8e3f7">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga864fc0d1fbad74e37628f58051c8e3f7"><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:ga22fd965b66d458850f2f8ab9c594f56a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga22fd965b66d458850f2f8ab9c594f56a"></a>
|
|
const peripheral_descriptor_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#ga22fd965b66d458850f2f8ab9c594f56a">g_peripherals</a> []</td></tr>
|
|
<tr class="memdesc:ga22fd965b66d458850f2f8ab9c594f56a"><td class="mdescLeft"> </td><td class="mdescRight">Array of all peripherals available in this device. <br /></td></tr>
|
|
<tr class="separator:ga22fd965b66d458850f2f8ab9c594f56a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Usage Information</h2>
|
|
<p>API for peripheral interfaces. </p>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="structperipheral__control__interface__t" id="structperipheral__control__interface__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct peripheral_control_interface_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Peripheral control interface. </p>
|
|
</div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:ac9e0249195af7428635fca3bb0dfa4c1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9e0249195af7428635fca3bb0dfa4c1"></a>
|
|
bool(* </td><td class="memItemRight" valign="bottom"><b>pollForActivity</b> )(const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:ac9e0249195af7428635fca3bb0dfa4c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85a3f4a1ef65ac1ffc03b033c4aaf164"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85a3f4a1ef65ac1ffc03b033c4aaf164"></a>
|
|
<a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>(* </td><td class="memItemRight" valign="bottom"><b>init</b> )(const peripheral_descriptor_t *self, serial_byte_receive_func_t function)</td></tr>
|
|
<tr class="separator:a85a3f4a1ef65ac1ffc03b033c4aaf164"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a918c657cd918dea7d4e129b999601f71"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a918c657cd918dea7d4e129b999601f71"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>shutdown</b> )(const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:a918c657cd918dea7d4e129b999601f71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a533e42f93861074cf43ef1532e932f6a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a533e42f93861074cf43ef1532e932f6a"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>pump</b> )(const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:a533e42f93861074cf43ef1532e932f6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="structperipheral__byte__inteface__t" id="structperipheral__byte__inteface__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct peripheral_byte_inteface_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Peripheral abstract byte interface. </p>
|
|
</div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a6df8bfa7ec72e0c0de7257fd63469985"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6df8bfa7ec72e0c0de7257fd63469985"></a>
|
|
<a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>(* </td><td class="memItemRight" valign="bottom"><b>init</b> )(const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:a6df8bfa7ec72e0c0de7257fd63469985"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a847a57c39f924f2468afdc4cb156803d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a847a57c39f924f2468afdc4cb156803d"></a>
|
|
<a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>(* </td><td class="memItemRight" valign="bottom"><b>read</b> )(const peripheral_descriptor_t *self, uint8_t *buffer, uint32_t requestedBytes)</td></tr>
|
|
<tr class="separator:a847a57c39f924f2468afdc4cb156803d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af730fbd40c38df64fecae440f76f5eec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af730fbd40c38df64fecae440f76f5eec"></a>
|
|
<a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>(* </td><td class="memItemRight" valign="bottom"><b>write</b> )(const peripheral_descriptor_t *self, const uint8_t *buffer, uint32_t byteCount)</td></tr>
|
|
<tr class="separator:af730fbd40c38df64fecae440f76f5eec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="structperipheral__packet__interface__t" id="structperipheral__packet__interface__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct peripheral_packet_interface_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Peripheral Packet Interface. </p>
|
|
</div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a6df8bfa7ec72e0c0de7257fd63469985"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6df8bfa7ec72e0c0de7257fd63469985"></a>
|
|
<a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>(* </td><td class="memItemRight" valign="bottom"><b>init</b> )(const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:a6df8bfa7ec72e0c0de7257fd63469985"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73463596a34227f500d15a667c184776"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73463596a34227f500d15a667c184776"></a>
|
|
<a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>(* </td><td class="memItemRight" valign="bottom"><b>readPacket</b> )(const peripheral_descriptor_t *self, uint8_t **packet, uint32_t *packetLength, <a class="el" href="group__peripheral.html#ga864fc0d1fbad74e37628f58051c8e3f7">packet_type_t</a> packetType)</td></tr>
|
|
<tr class="separator:a73463596a34227f500d15a667c184776"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf57f6c4300fbe02da8c97085bae0a6b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf57f6c4300fbe02da8c97085bae0a6b"></a>
|
|
<a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>(* </td><td class="memItemRight" valign="bottom"><b>writePacket</b> )(const peripheral_descriptor_t *self, const uint8_t *packet, uint32_t byteCount, <a class="el" href="group__peripheral.html#ga864fc0d1fbad74e37628f58051c8e3f7">packet_type_t</a> packetType)</td></tr>
|
|
<tr class="separator:abf57f6c4300fbe02da8c97085bae0a6b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af77ad57cd18d75ac0d63708629d5c0f9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af77ad57cd18d75ac0d63708629d5c0f9"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>abortDataPhase</b> )(const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:af77ad57cd18d75ac0d63708629d5c0f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ff7c06938106af90a65312b898c3b37"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ff7c06938106af90a65312b898c3b37"></a>
|
|
<a class="el" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>(* </td><td class="memItemRight" valign="bottom"><b>finalize</b> )(const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:a1ff7c06938106af90a65312b898c3b37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8396ad839cc9fcd6ed507c43e758b2d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8396ad839cc9fcd6ed507c43e758b2d0"></a>
|
|
uint32_t(* </td><td class="memItemRight" valign="bottom"><b>getMaxPacketSize</b> )(const peripheral_descriptor_t *self)</td></tr>
|
|
<tr class="separator:a8396ad839cc9fcd6ed507c43e758b2d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6cbfe871a99814cf3631b199fd3a2334"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cbfe871a99814cf3631b199fd3a2334"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><b>byteReceivedCallback</b> )(uint8_t byte)</td></tr>
|
|
<tr class="separator:a6cbfe871a99814cf3631b199fd3a2334"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="struct_peripheral_descriptor" id="struct_peripheral_descriptor"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct PeripheralDescriptor</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Peripheral descriptor. </p>
|
|
<p>Instances of this struct describe a particular instance of a peripheral that is available for bootloading. </p>
|
|
</div><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for peripheral_descriptor_t:</div>
|
|
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="struct_peripheral_descriptor__coll__graph.svg" width="496" height="155"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:aebff96e4421ee84530b46588d1fecc06"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#aebff96e4421ee84530b46588d1fecc06">typeMask</a></td></tr>
|
|
<tr class="memdesc:aebff96e4421ee84530b46588d1fecc06"><td class="mdescLeft"> </td><td class="mdescRight">Bit mask identifying the peripheral type. <a href="#aebff96e4421ee84530b46588d1fecc06">More...</a><br /></td></tr>
|
|
<tr class="separator:aebff96e4421ee84530b46588d1fecc06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ed36c4f5392e9f1819ec7c9eb9aff80"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ed36c4f5392e9f1819ec7c9eb9aff80"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#a9ed36c4f5392e9f1819ec7c9eb9aff80">instance</a></td></tr>
|
|
<tr class="memdesc:a9ed36c4f5392e9f1819ec7c9eb9aff80"><td class="mdescLeft"> </td><td class="mdescRight">The instance number of the peripheral. <br /></td></tr>
|
|
<tr class="separator:a9ed36c4f5392e9f1819ec7c9eb9aff80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a93b4acdd53176451155aadc527ad940f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93b4acdd53176451155aadc527ad940f"></a>
|
|
void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#a93b4acdd53176451155aadc527ad940f">pinmuxConfig</a> )(uint32_t <a class="el" href="group__peripheral.html#a9ed36c4f5392e9f1819ec7c9eb9aff80">instance</a>, <a class="el" href="group__peripheral.html#gaa37d9314ea323173c2e6a8852ed971db">pinmux_type_t</a> pinmux)</td></tr>
|
|
<tr class="memdesc:a93b4acdd53176451155aadc527ad940f"><td class="mdescLeft"> </td><td class="mdescRight">Configure pinmux setting for the peripheral. <br /></td></tr>
|
|
<tr class="separator:a93b4acdd53176451155aadc527ad940f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06427f58a1a1304383cb326b476083ec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06427f58a1a1304383cb326b476083ec"></a>
|
|
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__peripheral.html#a06427f58a1a1304383cb326b476083ec">controlInterface</a></td></tr>
|
|
<tr class="memdesc:a06427f58a1a1304383cb326b476083ec"><td class="mdescLeft"> </td><td class="mdescRight">Control interface for the peripheral. <br /></td></tr>
|
|
<tr class="separator:a06427f58a1a1304383cb326b476083ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79163bbbd9e86ab8351ee29f989c7899"><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__peripheral.html#a79163bbbd9e86ab8351ee29f989c7899">byteInterface</a></td></tr>
|
|
<tr class="memdesc:a79163bbbd9e86ab8351ee29f989c7899"><td class="mdescLeft"> </td><td class="mdescRight">Byte-level interface for the peripheral. <a href="#a79163bbbd9e86ab8351ee29f989c7899">More...</a><br /></td></tr>
|
|
<tr class="separator:a79163bbbd9e86ab8351ee29f989c7899"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26772fc6678c309201c894a6e903e4b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26772fc6678c309201c894a6e903e4b5"></a>
|
|
const <a class="el" href="group__peripheral.html#structperipheral__packet__interface__t">peripheral_packet_interface_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__peripheral.html#a26772fc6678c309201c894a6e903e4b5">packetInterface</a></td></tr>
|
|
<tr class="memdesc:a26772fc6678c309201c894a6e903e4b5"><td class="mdescLeft"> </td><td class="mdescRight">Packet level interface for the peripheral. <br /></td></tr>
|
|
<tr class="separator:a26772fc6678c309201c894a6e903e4b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a79163bbbd9e86ab8351ee29f989c7899"></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>* byteInterface</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Byte-level interface for the peripheral. </p>
|
|
<p>May be NULL since not all periperhals support this interface. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aebff96e4421ee84530b46588d1fecc06"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t typeMask</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Bit mask identifying the peripheral type. </p>
|
|
<p>See <a class="el" href="group__peripheral.html#ga9fbe682bf20c8eb79f22dac5d876cde1" title="Peripheral type bit mask definitions. ">_peripheral_types</a> for a list of valid bits. </p>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga9fbe682bf20c8eb79f22dac5d876cde1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__peripheral.html#ga9fbe682bf20c8eb79f22dac5d876cde1">_peripheral_types</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Peripheral type bit mask definitions. </p>
|
|
<p>These bit mask constants serve multiple purposes. They are each a unique value that identifies a peripheral type. They are also the mask for the bits used in the bootloader configuration flash region to list available peripherals and control which peripherals are enabled. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga864fc0d1fbad74e37628f58051c8e3f7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__peripheral.html#ga864fc0d1fbad74e37628f58051c8e3f7">packet_type_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Packet types. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga864fc0d1fbad74e37628f58051c8e3f7ac6247e577f9548697d503ced8a809a60"></a>kPacketType_Command </td><td class="fielddoc">
|
|
<p>Send or expect a command packet. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga864fc0d1fbad74e37628f58051c8e3f7a72e7fc42591ecec5ab6b3857a318113a"></a>kPacketType_Data </td><td class="fielddoc">
|
|
<p>Send or expect a data packet. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</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>
|