dmitrystu
/
libusbdev
mirror of https://github.com/dmitrystu/libusb_stm32


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553
							<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Lightweight USB stack: USB hardware 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="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</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>
<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="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Lightweight USB stack
   &#160;<span id="projectnumber">1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></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('d5/d1e/a00103.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> &#124;
<a href="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle">
<div class="title">USB hardware driver<div class="ingroups"><a class="el" href="../../d9/dcc/a00102.html">USB Device HW driver and core API</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<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:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d17/a00304.html">usbd_driver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a hardware USB driver call table.  <a href="../../d8/d17/a00304.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:ga9a3d5b843f2cefc83d90a8da3151b3e8"><td class="memItemLeft" align="right" valign="top">typedef uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga9a3d5b843f2cefc83d90a8da3151b3e8">usbd_hw_getinfo</a>) (void)</td></tr>
<tr class="memdesc:ga9a3d5b843f2cefc83d90a8da3151b3e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get USB device status and capabilities.  <a href="#ga9a3d5b843f2cefc83d90a8da3151b3e8">More...</a><br /></td></tr>
<tr class="separator:ga9a3d5b843f2cefc83d90a8da3151b3e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga521e6e03cdee1a357298e3f851698cf5"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga521e6e03cdee1a357298e3f851698cf5">usbd_hw_enable</a>) (bool enable)</td></tr>
<tr class="memdesc:ga521e6e03cdee1a357298e3f851698cf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables USB hardware.  <a href="#ga521e6e03cdee1a357298e3f851698cf5">More...</a><br /></td></tr>
<tr class="separator:ga521e6e03cdee1a357298e3f851698cf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51ab95cc32891731c1ff52acd088d374"><td class="memItemLeft" align="right" valign="top">typedef uint8_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga51ab95cc32891731c1ff52acd088d374">usbd_hw_connect</a>) (bool connect)</td></tr>
<tr class="separator:ga51ab95cc32891731c1ff52acd088d374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0dfb3a13355c4775e0e1681d76585bdf"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga0dfb3a13355c4775e0e1681d76585bdf">usbd_hw_setaddr</a>) (uint8_t address)</td></tr>
<tr class="memdesc:ga0dfb3a13355c4775e0e1681d76585bdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets USB hardware address.  <a href="#ga0dfb3a13355c4775e0e1681d76585bdf">More...</a><br /></td></tr>
<tr class="separator:ga0dfb3a13355c4775e0e1681d76585bdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga56dcaff98bac6a4c564bab6825f12da3"><td class="memItemLeft" align="right" valign="top">typedef bool(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga56dcaff98bac6a4c564bab6825f12da3">usbd_hw_ep_config</a>) (uint8_t ep, uint8_t eptype, uint16_t epsize)</td></tr>
<tr class="memdesc:ga56dcaff98bac6a4c564bab6825f12da3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures endpoint.  <a href="#ga56dcaff98bac6a4c564bab6825f12da3">More...</a><br /></td></tr>
<tr class="separator:ga56dcaff98bac6a4c564bab6825f12da3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9322c08c36d05121e7d998e1345fe46e"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga9322c08c36d05121e7d998e1345fe46e">usbd_hw_ep_deconfig</a>) (uint8_t ep)</td></tr>
<tr class="memdesc:ga9322c08c36d05121e7d998e1345fe46e"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-configures, cleans and disables endpoint.  <a href="#ga9322c08c36d05121e7d998e1345fe46e">More...</a><br /></td></tr>
<tr class="separator:ga9322c08c36d05121e7d998e1345fe46e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1488f8a6dee0c985f5abd38396b3a867"><td class="memItemLeft" align="right" valign="top">typedef int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga1488f8a6dee0c985f5abd38396b3a867">usbd_hw_ep_read</a>) (uint8_t ep, void *buf, uint16_t blen)</td></tr>
<tr class="memdesc:ga1488f8a6dee0c985f5abd38396b3a867"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads data from OUT or control endpoint.  <a href="#ga1488f8a6dee0c985f5abd38396b3a867">More...</a><br /></td></tr>
<tr class="separator:ga1488f8a6dee0c985f5abd38396b3a867"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga17f18cf2982e5a482a39603a4dd64f03"><td class="memItemLeft" align="right" valign="top">typedef int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga17f18cf2982e5a482a39603a4dd64f03">usbd_hw_ep_write</a>) (uint8_t ep, void *buf, uint16_t blen)</td></tr>
<tr class="memdesc:ga17f18cf2982e5a482a39603a4dd64f03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes data to IN or control endpoint.  <a href="#ga17f18cf2982e5a482a39603a4dd64f03">More...</a><br /></td></tr>
<tr class="separator:ga17f18cf2982e5a482a39603a4dd64f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab728331c31cfbd74d48606fe754f664b"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gab728331c31cfbd74d48606fe754f664b">usbd_hw_ep_setstall</a>) (uint8_t ep, bool stall)</td></tr>
<tr class="separator:gab728331c31cfbd74d48606fe754f664b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0d66682a43cc9a4a4657bae7b37d1721"><td class="memItemLeft" align="right" valign="top">typedef bool(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga0d66682a43cc9a4a4657bae7b37d1721">usbd_hw_ep_isstalled</a>) (uint8_t ep)</td></tr>
<tr class="memdesc:ga0d66682a43cc9a4a4657bae7b37d1721"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks endpoint for stalled state.  <a href="#ga0d66682a43cc9a4a4657bae7b37d1721">More...</a><br /></td></tr>
<tr class="separator:ga0d66682a43cc9a4a4657bae7b37d1721"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad661412e0f66de317eea9c3784629096"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gad661412e0f66de317eea9c3784629096">usbd_hw_poll</a>) (usbd_device *dev, <a class="el" href="../../d0/dc2/a00104.html#ga2992d1e12544a788bf2e1d774d68f3f7">usbd_evt_callback</a> callback)</td></tr>
<tr class="memdesc:gad661412e0f66de317eea9c3784629096"><td class="mdescLeft">&#160;</td><td class="mdescRight">Polls USB hardware for the events.  <a href="#gad661412e0f66de317eea9c3784629096">More...</a><br /></td></tr>
<tr class="separator:gad661412e0f66de317eea9c3784629096"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac4c9def5578968e903439f15bc64ab5b"><td class="memItemLeft" align="right" valign="top"><a id="gac4c9def5578968e903439f15bc64ab5b"></a>
typedef uint16_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gac4c9def5578968e903439f15bc64ab5b">usbd_hw_get_frameno</a>) (void)</td></tr>
<tr class="memdesc:gac4c9def5578968e903439f15bc64ab5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets frame number from usb hardware. <br /></td></tr>
<tr class="separator:gac4c9def5578968e903439f15bc64ab5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga521aa5ada654934cb97e12d73a315030"><td class="memItemLeft" align="right" valign="top">typedef uint16_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga521aa5ada654934cb97e12d73a315030">usbd_hw_get_serialno</a>) (void *buffer)</td></tr>
<tr class="memdesc:ga521aa5ada654934cb97e12d73a315030"><td class="mdescLeft">&#160;</td><td class="mdescRight">Makes a string descriptor contains unique serial number from hardware ID's.  <a href="#ga521aa5ada654934cb97e12d73a315030">More...</a><br /></td></tr>
<tr class="separator:ga521aa5ada654934cb97e12d73a315030"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
USB device events</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp91797fa22f30247a4066e30df4691aa0"></a><a class="anchor" id="USB_EVENTS"></a></p>
</td></tr>
<tr class="memitem:gaf25977e760d8d3eccf624a1fff5e39e1"><td class="memItemLeft" align="right" valign="top"><a id="gaf25977e760d8d3eccf624a1fff5e39e1"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gaf25977e760d8d3eccf624a1fff5e39e1">usbd_evt_reset</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:gaf25977e760d8d3eccf624a1fff5e39e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset. <br /></td></tr>
<tr class="separator:gaf25977e760d8d3eccf624a1fff5e39e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabce59583f6428a435be226fa766fc78a"><td class="memItemLeft" align="right" valign="top"><a id="gabce59583f6428a435be226fa766fc78a"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gabce59583f6428a435be226fa766fc78a">usbd_evt_sof</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:gabce59583f6428a435be226fa766fc78a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start of frame. <br /></td></tr>
<tr class="separator:gabce59583f6428a435be226fa766fc78a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafd35f0af68691fe11e8c1186e56eac06"><td class="memItemLeft" align="right" valign="top"><a id="gafd35f0af68691fe11e8c1186e56eac06"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gafd35f0af68691fe11e8c1186e56eac06">usbd_evt_susp</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:gafd35f0af68691fe11e8c1186e56eac06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suspend. <br /></td></tr>
<tr class="separator:gafd35f0af68691fe11e8c1186e56eac06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1eda629ed9bb286a15d2d98b1e523e1b"><td class="memItemLeft" align="right" valign="top"><a id="ga1eda629ed9bb286a15d2d98b1e523e1b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga1eda629ed9bb286a15d2d98b1e523e1b">usbd_evt_wkup</a>&#160;&#160;&#160;3</td></tr>
<tr class="memdesc:ga1eda629ed9bb286a15d2d98b1e523e1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wakeup. <br /></td></tr>
<tr class="separator:ga1eda629ed9bb286a15d2d98b1e523e1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa849dea26fab624e3aef5c766cc66d6b"><td class="memItemLeft" align="right" valign="top"><a id="gaa849dea26fab624e3aef5c766cc66d6b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gaa849dea26fab624e3aef5c766cc66d6b">usbd_evt_eptx</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:gaa849dea26fab624e3aef5c766cc66d6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data packet transmitted. <br /></td></tr>
<tr class="separator:gaa849dea26fab624e3aef5c766cc66d6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6cb788d0654c976a38121721fcff08fb"><td class="memItemLeft" align="right" valign="top"><a id="ga6cb788d0654c976a38121721fcff08fb"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga6cb788d0654c976a38121721fcff08fb">usbd_evt_eprx</a>&#160;&#160;&#160;5</td></tr>
<tr class="memdesc:ga6cb788d0654c976a38121721fcff08fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data packet received. <br /></td></tr>
<tr class="separator:ga6cb788d0654c976a38121721fcff08fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga711dd3a71e6c92ec7e7814bded9ed7e4"><td class="memItemLeft" align="right" valign="top"><a id="ga711dd3a71e6c92ec7e7814bded9ed7e4"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga711dd3a71e6c92ec7e7814bded9ed7e4">usbd_evt_epsetup</a>&#160;&#160;&#160;6</td></tr>
<tr class="memdesc:ga711dd3a71e6c92ec7e7814bded9ed7e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup packet received. <br /></td></tr>
<tr class="separator:ga711dd3a71e6c92ec7e7814bded9ed7e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa87a9dd3df80bb341668aeb002338ca3"><td class="memItemLeft" align="right" valign="top"><a id="gaa87a9dd3df80bb341668aeb002338ca3"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gaa87a9dd3df80bb341668aeb002338ca3">usbd_evt_error</a>&#160;&#160;&#160;7</td></tr>
<tr class="memdesc:gaa87a9dd3df80bb341668aeb002338ca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data error. <br /></td></tr>
<tr class="separator:gaa87a9dd3df80bb341668aeb002338ca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3a0a8d6f95fd56d722d2647d7c8ce62b"><td class="memItemLeft" align="right" valign="top"><a id="ga3a0a8d6f95fd56d722d2647d7c8ce62b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>usbd_evt_count</b>&#160;&#160;&#160;8</td></tr>
<tr class="separator:ga3a0a8d6f95fd56d722d2647d7c8ce62b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
USB lanes connection states</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpcec5ad7a93e4e65717bb866372b1bb69"></a><a class="anchor" id="USB_LANES_STATUS"></a></p>
</td></tr>
<tr class="memitem:ga4437d82eaf8bde6cf024a67296e2405b"><td class="memItemLeft" align="right" valign="top"><a id="ga4437d82eaf8bde6cf024a67296e2405b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga4437d82eaf8bde6cf024a67296e2405b">usbd_lane_unk</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:ga4437d82eaf8bde6cf024a67296e2405b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unknown or proprietary charger. <br /></td></tr>
<tr class="separator:ga4437d82eaf8bde6cf024a67296e2405b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafb52ee5b26f0b788957c43f35445e55c"><td class="memItemLeft" align="right" valign="top"><a id="gafb52ee5b26f0b788957c43f35445e55c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gafb52ee5b26f0b788957c43f35445e55c">usbd_lane_dsc</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:gafb52ee5b26f0b788957c43f35445e55c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lanes disconnected. <br /></td></tr>
<tr class="separator:gafb52ee5b26f0b788957c43f35445e55c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8480fbe534da4cc848d6636e741b9778"><td class="memItemLeft" align="right" valign="top"><a id="ga8480fbe534da4cc848d6636e741b9778"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga8480fbe534da4cc848d6636e741b9778">usbd_lane_sdp</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:ga8480fbe534da4cc848d6636e741b9778"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lanes connected to standard downstream port. <br /></td></tr>
<tr class="separator:ga8480fbe534da4cc848d6636e741b9778"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8dc6c9b7a25ef86dba25e14546f88f34"><td class="memItemLeft" align="right" valign="top"><a id="ga8dc6c9b7a25ef86dba25e14546f88f34"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga8dc6c9b7a25ef86dba25e14546f88f34">usbd_lane_cdp</a>&#160;&#160;&#160;3</td></tr>
<tr class="memdesc:ga8dc6c9b7a25ef86dba25e14546f88f34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lanes connected to charging downstream port. <br /></td></tr>
<tr class="separator:ga8dc6c9b7a25ef86dba25e14546f88f34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaff50a39e429ae6aae936de75602dcc0"><td class="memItemLeft" align="right" valign="top"><a id="gaaff50a39e429ae6aae936de75602dcc0"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gaaff50a39e429ae6aae936de75602dcc0">usbd_lane_dcp</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:gaaff50a39e429ae6aae936de75602dcc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lanes connected to dedicated charging port. <br /></td></tr>
<tr class="separator:gaaff50a39e429ae6aae936de75602dcc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
USB HW capabilities and status</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpb2b88f77919d50aa04a6a1fcdec387f7"></a><a class="anchor" id="USBD_HW_CAPS"></a></p>
</td></tr>
<tr class="memitem:ga878641d0cbb440926a46e75c7cb0d075"><td class="memItemLeft" align="right" valign="top"><a id="ga878641d0cbb440926a46e75c7cb0d075"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga878641d0cbb440926a46e75c7cb0d075">USBD_HW_ADDRFST</a>&#160;&#160;&#160;(1 &lt;&lt; 0)</td></tr>
<tr class="memdesc:ga878641d0cbb440926a46e75c7cb0d075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set address before STATUS_OUT. <br /></td></tr>
<tr class="separator:ga878641d0cbb440926a46e75c7cb0d075"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf25fc6cc0ba90f9107bb98ca358ed927"><td class="memItemLeft" align="right" valign="top"><a id="gaf25fc6cc0ba90f9107bb98ca358ed927"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gaf25fc6cc0ba90f9107bb98ca358ed927">USBD_HW_BC</a>&#160;&#160;&#160;(1 &lt;&lt; 1)</td></tr>
<tr class="memdesc:gaf25fc6cc0ba90f9107bb98ca358ed927"><td class="mdescLeft">&#160;</td><td class="mdescRight">Battery charging detection supported. <br /></td></tr>
<tr class="separator:gaf25fc6cc0ba90f9107bb98ca358ed927"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga10e25b69e3a7b97c825cd46a9f1f4bbd"><td class="memItemLeft" align="right" valign="top"><a id="ga10e25b69e3a7b97c825cd46a9f1f4bbd"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga10e25b69e3a7b97c825cd46a9f1f4bbd">USND_HW_HS</a>&#160;&#160;&#160;(1 &lt;&lt; 2)</td></tr>
<tr class="memdesc:ga10e25b69e3a7b97c825cd46a9f1f4bbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">High speed supported. <br /></td></tr>
<tr class="separator:ga10e25b69e3a7b97c825cd46a9f1f4bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e29fc787f9aa849155bbdbae9e817f7"><td class="memItemLeft" align="right" valign="top"><a id="ga1e29fc787f9aa849155bbdbae9e817f7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga1e29fc787f9aa849155bbdbae9e817f7">USBD_HW_ENABLED</a>&#160;&#160;&#160;(1 &lt;&lt; 3)</td></tr>
<tr class="memdesc:ga1e29fc787f9aa849155bbdbae9e817f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB device enabled. <br /></td></tr>
<tr class="separator:ga1e29fc787f9aa849155bbdbae9e817f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5112d4b1479addaa3a60ebd828f32b9b"><td class="memItemLeft" align="right" valign="top"><a id="ga5112d4b1479addaa3a60ebd828f32b9b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga5112d4b1479addaa3a60ebd828f32b9b">USBD_HW_ENUMSPEED</a>&#160;&#160;&#160;(2 &lt;&lt; 4)</td></tr>
<tr class="memdesc:ga5112d4b1479addaa3a60ebd828f32b9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">USB device enumeration speed mask. <br /></td></tr>
<tr class="separator:ga5112d4b1479addaa3a60ebd828f32b9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafd067eab59c16235070140a11712c4e7"><td class="memItemLeft" align="right" valign="top"><a id="gafd067eab59c16235070140a11712c4e7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gafd067eab59c16235070140a11712c4e7">USBD_HW_SPEED_NC</a>&#160;&#160;&#160;(0 &lt;&lt; 4)</td></tr>
<tr class="memdesc:gafd067eab59c16235070140a11712c4e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Not connected. <br /></td></tr>
<tr class="separator:gafd067eab59c16235070140a11712c4e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad42752675174a74f80d32caf3d4c1d61"><td class="memItemLeft" align="right" valign="top"><a id="gad42752675174a74f80d32caf3d4c1d61"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#gad42752675174a74f80d32caf3d4c1d61">USBD_HW_SPEED_LS</a>&#160;&#160;&#160;(1 &lt;&lt; 4)</td></tr>
<tr class="memdesc:gad42752675174a74f80d32caf3d4c1d61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Low speed. <br /></td></tr>
<tr class="separator:gad42752675174a74f80d32caf3d4c1d61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7318c4caa84875d5bf18a2df32ae3a19"><td class="memItemLeft" align="right" valign="top"><a id="ga7318c4caa84875d5bf18a2df32ae3a19"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga7318c4caa84875d5bf18a2df32ae3a19">USBD_HW_SPEED_FS</a>&#160;&#160;&#160;(2 &lt;&lt; 4)</td></tr>
<tr class="memdesc:ga7318c4caa84875d5bf18a2df32ae3a19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Full speed. <br /></td></tr>
<tr class="separator:ga7318c4caa84875d5bf18a2df32ae3a19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3705fd63440184507905ad1396c43f1d"><td class="memItemLeft" align="right" valign="top"><a id="ga3705fd63440184507905ad1396c43f1d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d1e/a00103.html#ga3705fd63440184507905ad1396c43f1d">USBD_HW_SPEED_HS</a>&#160;&#160;&#160;(3 &lt;&lt; 4)</td></tr>
<tr class="memdesc:ga3705fd63440184507905ad1396c43f1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">High speed. <br /></td></tr>
<tr class="separator:ga3705fd63440184507905ad1396c43f1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga9a3d5b843f2cefc83d90a8da3151b3e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a3d5b843f2cefc83d90a8da3151b3e8">&#9670;&nbsp;</a></span>usbd_hw_getinfo</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef uint32_t(* usbd_hw_getinfo) (void)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get USB device status and capabilities. </p>
<dl class="section return"><dt>Returns</dt><dd>Hardware status and capabilities <a class="el" href="../../d5/d1e/a00103.html#USBD_HW_CAPS">USBD_HW_CAPS</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00227">227</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="ga521e6e03cdee1a357298e3f851698cf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga521e6e03cdee1a357298e3f851698cf5">&#9670;&nbsp;</a></span>usbd_hw_enable</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* usbd_hw_enable) (bool enable)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables or disables USB hardware. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>Enables USB when TRUE disables otherwise. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00232">232</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="ga51ab95cc32891731c1ff52acd088d374"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga51ab95cc32891731c1ff52acd088d374">&#9670;&nbsp;</a></span>usbd_hw_connect</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef uint8_t(* usbd_hw_connect) (bool connect)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Connects or disconnects USB hardware to/from usb host </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">connect</td><td>Connects USB to host if TRUE, disconnects otherwise </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>lanes connection status. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00238">238</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="ga0dfb3a13355c4775e0e1681d76585bdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0dfb3a13355c4775e0e1681d76585bdf">&#9670;&nbsp;</a></span>usbd_hw_setaddr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* usbd_hw_setaddr) (uint8_t address)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets USB hardware address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">address</td><td>USB address </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00243">243</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="ga56dcaff98bac6a4c564bab6825f12da3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga56dcaff98bac6a4c564bab6825f12da3">&#9670;&nbsp;</a></span>usbd_hw_ep_config</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool(* usbd_hw_ep_config) (uint8_t ep, uint8_t eptype, uint16_t epsize)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configures endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ep</td><td>endpoint address. Use USB_EPDIR_ macros to set endpoint direction </td></tr>
    <tr><td class="paramname">eptype</td><td>endpoint type. Use USB_EPTYPE_* macros. </td></tr>
    <tr><td class="paramname">epsize</td><td>endpoint size in bytes </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if success </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00251">251</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="ga9322c08c36d05121e7d998e1345fe46e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9322c08c36d05121e7d998e1345fe46e">&#9670;&nbsp;</a></span>usbd_hw_ep_deconfig</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* usbd_hw_ep_deconfig) (uint8_t ep)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>De-configures, cleans and disables endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ep</td><td>endpoint index </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>if you have two one-direction single-buffered endpoints with same index (i.e. 0x02 and 0x82) both will be deconfigured. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00258">258</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="ga1488f8a6dee0c985f5abd38396b3a867"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1488f8a6dee0c985f5abd38396b3a867">&#9670;&nbsp;</a></span>usbd_hw_ep_read</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef int32_t(* usbd_hw_ep_read) (uint8_t ep, void *buf, uint16_t blen)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads data from OUT or control endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ep</td><td>endpoint index, should belong to OUT or CONTROL endpoint. </td></tr>
    <tr><td class="paramname">buf</td><td>pointer to read buffer </td></tr>
    <tr><td class="paramname">blen</td><td>size of the read buffer in bytes </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of the actually received data, -1 on error. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>if data does not fit buffer it will be truncated </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00267">267</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="ga17f18cf2982e5a482a39603a4dd64f03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga17f18cf2982e5a482a39603a4dd64f03">&#9670;&nbsp;</a></span>usbd_hw_ep_write</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef int32_t(* usbd_hw_ep_write) (uint8_t ep, void *buf, uint16_t blen)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Writes data to IN or control endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ep</td><td>endpoint index, hould belong to IN or CONTROL endpoint </td></tr>
    <tr><td class="paramname">buf</td><td>pointer to data buffer </td></tr>
    <tr><td class="paramname">blen</td><td>size of data will be written </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of written bytes </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00275">275</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="gab728331c31cfbd74d48606fe754f664b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab728331c31cfbd74d48606fe754f664b">&#9670;&nbsp;</a></span>usbd_hw_ep_setstall</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* usbd_hw_ep_setstall) (uint8_t ep, bool stall)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Stalls and unstalls endpoint </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ep</td><td>endpoint address </td></tr>
    <tr><td class="paramname">stall</td><td>endpoint will be stalled if TRUE and unstalled otherwise. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Has no effect on inactive endpoints. </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00282">282</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="ga0d66682a43cc9a4a4657bae7b37d1721"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0d66682a43cc9a4a4657bae7b37d1721">&#9670;&nbsp;</a></span>usbd_hw_ep_isstalled</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool(* usbd_hw_ep_isstalled) (uint8_t ep)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checks endpoint for stalled state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ep</td><td>endpoint address </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if endpoint is stalled </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00288">288</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="gad661412e0f66de317eea9c3784629096"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad661412e0f66de317eea9c3784629096">&#9670;&nbsp;</a></span>usbd_hw_poll</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* usbd_hw_poll) (usbd_device *dev, <a class="el" href="../../d0/dc2/a00104.html#ga2992d1e12544a788bf2e1d774d68f3f7">usbd_evt_callback</a> callback)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Polls USB hardware for the events. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>pointer to usb device structure </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">callback</td><td>callback to event processing subroutine </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00294">294</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</p>

</div>
</div>
<a id="ga521aa5ada654934cb97e12d73a315030"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga521aa5ada654934cb97e12d73a315030">&#9670;&nbsp;</a></span>usbd_hw_get_serialno</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef uint16_t(* usbd_hw_get_serialno) (void *buffer)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Makes a string descriptor contains unique serial number from hardware ID's. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>pointer to buffer for the descriptor </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>of the descriptor in bytes </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../db/db6/a00074_source.html#l00304">304</a> of file <a class="el" href="../../db/db6/a00074_source.html">usbd_core.h</a>.</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 by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>