mirror of
https://github.com/felis/USB_Host_Shield_2.0.git
synced 2024-03-22 11:31:26 +01:00
802 lines
35 KiB
HTML
802 lines
35 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>USB Host Shield 2.0: ADK Class Reference</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="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" />
|
|
<link href="imageStyle.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">USB Host Shield 2.0
|
|
</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>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</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 id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- 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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="#pro-static-attribs">Static Protected Attributes</a> |
|
|
<a href="class_a_d_k-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ADK Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="adk_8h_source.html">adk.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ADK:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_a_d_k__inherit__graph.png" border="0" usemap="#_a_d_k_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="_a_d_k_inherit__map" id="_a_d_k_inherit__map">
|
|
<area shape="rect" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,5,133,31"/>
|
|
<area shape="rect" id="node3" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="158,5,288,31"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ADK:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_a_d_k__coll__graph.png" border="0" usemap="#_a_d_k_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="_a_d_k_coll__map" id="_a_d_k_coll__map">
|
|
<area shape="rect" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,80,133,105"/>
|
|
<area shape="rect" id="node3" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="158,80,288,105"/>
|
|
<area shape="rect" id="node4" href="class_u_s_b.html" title="USB" alt="" coords="312,80,360,105"/>
|
|
<area shape="rect" id="node5" href="class_m_a_x3421e.html" title="MAX3421E" alt="" coords="292,5,380,31"/>
|
|
<area shape="rect" id="node6" href="struct_ep_info.html" title="EpInfo" alt="" coords="385,80,445,105"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a29492dcd9b7f6023b7866cd05188d61c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a29492dcd9b7f6023b7866cd05188d61c">ADK</a> (<a class="el" href="class_u_s_b.html">USB</a> *<a class="el" href="class_a_d_k.html#ab28e3a19569c27f3ed5362e9800065c1">pUsb</a>, const char *manufacturer, const char *model, const char *description, const char *version, const char *uri, const char *serial)</td></tr>
|
|
<tr class="separator:a29492dcd9b7f6023b7866cd05188d61c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66b9943dfa89f783a8cdeb655e6fe9b1"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a66b9943dfa89f783a8cdeb655e6fe9b1">RcvData</a> (uint16_t *nbytesptr, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a66b9943dfa89f783a8cdeb655e6fe9b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac37bde02b6ed1436712d3619afb07c84"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#ac37bde02b6ed1436712d3619afb07c84">SndData</a> (uint16_t nbytes, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:ac37bde02b6ed1436712d3619afb07c84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14f24ca8246c5b6126a5aa72cf6ee120"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a14f24ca8246c5b6126a5aa72cf6ee120">ConfigureDevice</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
|
|
<tr class="separator:a14f24ca8246c5b6126a5aa72cf6ee120"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c5c2e212c748966ccd863499d202063"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a8c5c2e212c748966ccd863499d202063">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
|
|
<tr class="separator:a8c5c2e212c748966ccd863499d202063"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f64af34d7890f87ceab5d144f6c26ef"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a7f64af34d7890f87ceab5d144f6c26ef">Release</a> ()</td></tr>
|
|
<tr class="separator:a7f64af34d7890f87ceab5d144f6c26ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3784434ee6a1c6f3dc5b591f467e703"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#af3784434ee6a1c6f3dc5b591f467e703">Poll</a> ()</td></tr>
|
|
<tr class="separator:af3784434ee6a1c6f3dc5b591f467e703"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a972e8dc98b60ab27528db3af2618c3"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a1a972e8dc98b60ab27528db3af2618c3">GetAddress</a> ()</td></tr>
|
|
<tr class="separator:a1a972e8dc98b60ab27528db3af2618c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dee02856625dfcac4b0cdd4e8672cef"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a1dee02856625dfcac4b0cdd4e8672cef">isReady</a> ()</td></tr>
|
|
<tr class="separator:a1dee02856625dfcac4b0cdd4e8672cef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ad9aa3153c4cd1e083251bf42ab536f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a9ad9aa3153c4cd1e083251bf42ab536f">VIDPIDOK</a> (uint16_t vid, uint16_t pid)</td></tr>
|
|
<tr class="separator:a9ad9aa3153c4cd1e083251bf42ab536f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac2fac5410faea0e439b4f7e688b3d75"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#aac2fac5410faea0e439b4f7e688b3d75">EndpointXtract</a> (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep)</td></tr>
|
|
<tr class="separator:aac2fac5410faea0e439b4f7e688b3d75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_u_s_b_device_config"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_u_s_b_device_config')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_u_s_b_device_config.html">USBDeviceConfig</a></td></tr>
|
|
<tr class="memitem:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a12bb63558ded5bb6661bb173b07ff391">ResetHubPort</a> (uint8_t port)</td></tr>
|
|
<tr class="separator:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a2bb3e09cf128c8ecd04ea0dfce2126e1">DEVCLASSOK</a> (uint8_t klass)</td></tr>
|
|
<tr class="separator:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#ad2d535af92d0b97e4445a6bd51d35c57">DEVSUBCLASSOK</a> (uint8_t subklass)</td></tr>
|
|
<tr class="separator:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:ac4bd3303b99921289c3f59e2df219e50"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#ac4bd3303b99921289c3f59e2df219e50">PrintEndpointDescriptor</a> (const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep_ptr)</td></tr>
|
|
<tr class="separator:ac4bd3303b99921289c3f59e2df219e50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:ab28e3a19569c27f3ed5362e9800065c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_s_b.html">USB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#ab28e3a19569c27f3ed5362e9800065c1">pUsb</a></td></tr>
|
|
<tr class="separator:ab28e3a19569c27f3ed5362e9800065c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab22a7c60cec56823727d4ff2cf2c4edf"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#ab22a7c60cec56823727d4ff2cf2c4edf">bAddress</a></td></tr>
|
|
<tr class="separator:ab22a7c60cec56823727d4ff2cf2c4edf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8fcc6a6fccab61116cea10dd1f17738"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#ae8fcc6a6fccab61116cea10dd1f17738">bConfNum</a></td></tr>
|
|
<tr class="separator:ae8fcc6a6fccab61116cea10dd1f17738"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf969d306da15baecd5c59bbb568053e"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#adf969d306da15baecd5c59bbb568053e">bNumEP</a></td></tr>
|
|
<tr class="separator:adf969d306da15baecd5c59bbb568053e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a135db75b9e8cdd59b89f46c44dd83dd4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a135db75b9e8cdd59b89f46c44dd83dd4">ready</a></td></tr>
|
|
<tr class="separator:a135db75b9e8cdd59b89f46c44dd83dd4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ffc693d731ddeb9499c11e893fc467d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ep_info.html">EpInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a6ffc693d731ddeb9499c11e893fc467d">epInfo</a> [<a class="el" href="adk_8h.html#ac39da606ffc273bd855152107297d6a1">ADK_MAX_ENDPOINTS</a>]</td></tr>
|
|
<tr class="separator:a6ffc693d731ddeb9499c11e893fc467d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
|
|
Static Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a964ec80ac133bf8d65cf0274e37b29da"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#a964ec80ac133bf8d65cf0274e37b29da">epDataInIndex</a> = 1</td></tr>
|
|
<tr class="separator:a964ec80ac133bf8d65cf0274e37b29da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfc5a7e45f15bba7ff8cd42552796624"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_k.html#acfc5a7e45f15bba7ff8cd42552796624">epDataOutIndex</a> = 2</td></tr>
|
|
<tr class="separator:acfc5a7e45f15bba7ff8cd42552796624"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00053">53</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a29492dcd9b7f6023b7866cd05188d61c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ADK::ADK </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> * </td>
|
|
<td class="paramname"><em>pUsb</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>manufacturer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>model</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>description</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>version</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>uri</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>serial</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8cpp_source.html#l00025">25</a> of file <a class="el" href="adk_8cpp_source.html">adk.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ac4bd3303b99921289c3f59e2df219e50"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ADK::PrintEndpointDescriptor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> * </td>
|
|
<td class="paramname"><em>ep_ptr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8cpp_source.html#l00357">357</a> of file <a class="el" href="adk_8cpp_source.html">adk.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a66b9943dfa89f783a8cdeb655e6fe9b1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t ADK::RcvData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t * </td>
|
|
<td class="paramname"><em>nbytesptr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dataptr</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8cpp_source.html#l00347">347</a> of file <a class="el" href="adk_8cpp_source.html">adk.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac37bde02b6ed1436712d3619afb07c84"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t ADK::SndData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>nbytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dataptr</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8cpp_source.html#l00353">353</a> of file <a class="el" href="adk_8cpp_source.html">adk.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a14f24ca8246c5b6126a5aa72cf6ee120"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t ADK::ConfigureDevice </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>parent</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>port</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>lowspeed</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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#aef77a1e62f78c04a1aad53e8795ec89e">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="adk_8cpp_source.html#l00059">59</a> of file <a class="el" href="adk_8cpp_source.html">adk.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8c5c2e212c748966ccd863499d202063"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t ADK::Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>parent</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>port</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>lowspeed</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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a3706cf6b18785aff823171e280bab738">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="adk_8cpp_source.html#l00064">64</a> of file <a class="el" href="adk_8cpp_source.html">adk.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7f64af34d7890f87ceab5d144f6c26ef"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t ADK::Release </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a61e301efedae55c6ac12c6cce154e432">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="adk_8cpp_source.html#l00337">337</a> of file <a class="el" href="adk_8cpp_source.html">adk.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af3784434ee6a1c6f3dc5b591f467e703"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual uint8_t ADK::Poll </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a893ea73deab98be837c257201e7da25a">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00103">103</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1a972e8dc98b60ab27528db3af2618c3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual uint8_t ADK::GetAddress </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a2bfde6c290d32888a6f4e97fa1e222f1">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00107">107</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1dee02856625dfcac4b0cdd4e8672cef"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ADK::isReady </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00111">111</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9ad9aa3153c4cd1e083251bf42ab536f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ADK::VIDPIDOK </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>vid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>pid</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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#af920743379d8c133dda4335d11601141">USBDeviceConfig</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00115">115</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aac2fac5410faea0e439b4f7e688b3d75"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ADK::EndpointXtract </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>conf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>iface</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>alt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>proto</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> * </td>
|
|
<td class="paramname"><em>ep</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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="class_usb_config_xtracter.html#a7717ea27bb756568e0deb544d8331370">UsbConfigXtracter</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="adk_8cpp_source.html#l00312">312</a> of file <a class="el" href="adk_8cpp_source.html">adk.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a964ec80ac133bf8d65cf0274e37b29da"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint8_t ADK::epDataInIndex = 1</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00069">69</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acfc5a7e45f15bba7ff8cd42552796624"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint8_t ADK::epDataOutIndex = 2</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00070">70</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab28e3a19569c27f3ed5362e9800065c1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_u_s_b.html">USB</a>* ADK::pUsb</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00073">73</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab22a7c60cec56823727d4ff2cf2c4edf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t ADK::bAddress</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00074">74</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae8fcc6a6fccab61116cea10dd1f17738"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t ADK::bConfNum</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00075">75</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adf969d306da15baecd5c59bbb568053e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t ADK::bNumEP</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00077">77</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a135db75b9e8cdd59b89f46c44dd83dd4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ADK::ready</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00078">78</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6ffc693d731ddeb9499c11e893fc467d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_ep_info.html">EpInfo</a> ADK::epInfo[<a class="el" href="adk_8h.html#ac39da606ffc273bd855152107297d6a1">ADK_MAX_ENDPOINTS</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="adk_8h_source.html#l00081">81</a> of file <a class="el" href="adk_8h_source.html">adk.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="adk_8h_source.html">adk.h</a></li>
|
|
<li><a class="el" href="adk_8cpp_source.html">adk.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|