USB_Host_Shield_2.0/adk_8h_source.html

119 lines
40 KiB
HTML
Raw Normal View History

2013-01-30 22:00:18 +01:00
<!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"/>
2018-10-13 15:47:19 +02:00
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: adk.h Source File</title>
2013-01-30 22:00:18 +01:00
<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"/>
2015-04-07 16:07:33 +02:00
<script type="text/javascript" src="search/searchdata.js"></script>
2013-01-30 22:00:18 +01:00
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.css" rel="stylesheet" type="text/css"/>
2013-01-30 22:00:18 +01:00
</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;">
2016-04-19 18:16:46 +02:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
2013-01-30 22:00:18 +01:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2018-10-13 15:47:19 +02:00
<!-- Generated by Doxygen 1.8.14 -->
2013-01-30 22:00:18 +01:00
<script type="text/javascript">
2018-10-13 15:47:19 +02:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2013-01-30 22:00:18 +01:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2018-10-13 15:47:19 +02:00
/* @license-end */
2013-01-30 22:00:18 +01:00
</script>
2018-10-13 15:47:19 +02:00
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
2013-01-30 22:00:18 +01:00
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2015-04-07 16:07:33 +02:00
</div>
2013-01-30 22:00:18 +01:00
<!-- 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 id="nav-path" class="navpath">
<ul>
2016-04-19 18:16:46 +02:00
<li class="navelem"><a class="el" href="dir_69161428018e52ad84691a5947f27cc9.html">Github</a></li><li class="navelem"><a class="el" href="dir_ee762931928e29ae94e054d18c99dc9e.html">USB_Host_Shield_2_0</a></li> </ul>
2013-01-30 22:00:18 +01:00
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">adk.h</div> </div>
</div><!--header-->
<div class="contents">
2018-10-13 15:47:19 +02:00
<a href="adk_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">This software may be distributed and modified under the terms of the GNU</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">General Public License version 2 (GPL2) as published by the Free Software</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">Foundation and appearing in the file GPL2.TXT included in the packaging of</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">this file. Please note that GPL2 Section 2[b] requires that all works based</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">on this software must also be made publicly available under the terms of</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">the GPL2 (&quot;Copyleft&quot;).</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">Contact information</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">-------------------</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">Circuits At Home, LTD</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">Web : http://www.circuitsathome.com</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">e-mail : support@circuitsathome.com</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">/* Google ADK interface support header */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#if !defined(_ADK_H_)</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define _ADK_H_</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_usb_8h.html">Usb.h</a>&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="adk_8h.html#a37223416b6c1bba6b86ab17211bc9af2"> 25</a></span>&#160;<span class="preprocessor">#define ADK_VID 0x18D1</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="adk_8h.html#a32e861258886323d4dbcf066641597a4"> 26</a></span>&#160;<span class="preprocessor">#define ADK_PID 0x2D00</span></div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="adk_8h.html#a355cd5e5557b754645d4e1bfffabbf99"> 27</a></span>&#160;<span class="preprocessor">#define ADB_PID 0x2D01</span></div><div cl
<div class="ttc" id="class_a_d_k_html_a964ec80ac133bf8d65cf0274e37b29da"><div class="ttname"><a href="class_a_d_k.html#a964ec80ac133bf8d65cf0274e37b29da">ADK::epDataInIndex</a></div><div class="ttdeci">static const uint8_t epDataInIndex</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00069">adk.h:69</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_a_d_k_html_a66b9943dfa89f783a8cdeb655e6fe9b1"><div class="ttname"><a href="class_a_d_k.html#a66b9943dfa89f783a8cdeb655e6fe9b1">ADK::RcvData</a></div><div class="ttdeci">uint8_t RcvData(uint16_t *nbytesptr, uint8_t *dataptr)</div><div class="ttdef"><b>Definition:</b> <a href="adk_8cpp_source.html#l00347">adk.cpp:347</a></div></div>
<div class="ttc" id="class_a_d_k_html_a7f64af34d7890f87ceab5d144f6c26ef"><div class="ttname"><a href="class_a_d_k.html#a7f64af34d7890f87ceab5d144f6c26ef">ADK::Release</a></div><div class="ttdeci">uint8_t Release()</div><div class="ttdef"><b>Definition:</b> <a href="adk_8cpp_source.html#l00337">adk.cpp:337</a></div></div>
<div class="ttc" id="class_a_d_k_html_ac37bde02b6ed1436712d3619afb07c84"><div class="ttname"><a href="class_a_d_k.html#ac37bde02b6ed1436712d3619afb07c84">ADK::SndData</a></div><div class="ttdeci">uint8_t SndData(uint16_t nbytes, uint8_t *dataptr)</div><div class="ttdef"><b>Definition:</b> <a href="adk_8cpp_source.html#l00353">adk.cpp:353</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r_html"><div class="ttname"><a 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></div><div class="ttdef"><b>Definition:</b> <a href="usb__ch9_8h_source.html#l00148">usb_ch9.h:148</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_a_d_k_html_aac2fac5410faea0e439b4f7e688b3d75"><div class="ttname"><a href="class_a_d_k.html#aac2fac5410faea0e439b4f7e688b3d75">ADK::EndpointXtract</a></div><div class="ttdeci">void EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep)</div><div class="ttdef"><b>Definition:</b> <a href="adk_8cpp_source.html#l00312">adk.cpp:312</a></div></div>
<div class="ttc" id="class_a_d_k_html_ab28e3a19569c27f3ed5362e9800065c1"><div class="ttname"><a href="class_a_d_k.html#ab28e3a19569c27f3ed5362e9800065c1">ADK::pUsb</a></div><div class="ttdeci">USB * pUsb</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00073">adk.h:73</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_a_d_k_html_a14f24ca8246c5b6126a5aa72cf6ee120"><div class="ttname"><a href="class_a_d_k.html#a14f24ca8246c5b6126a5aa72cf6ee120">ADK::ConfigureDevice</a></div><div class="ttdeci">uint8_t ConfigureDevice(uint8_t parent, uint8_t port, bool lowspeed)</div><div class="ttdef"><b>Definition:</b> <a href="adk_8cpp_source.html#l00059">adk.cpp:59</a></div></div>
<div class="ttc" id="adk_8h_html_a4c3e43d4d2955f93260f3e5ffe207e41"><div class="ttname"><a href="adk_8h.html#a4c3e43d4d2955f93260f3e5ffe207e41">ADK_GETPROTO</a></div><div class="ttdeci">#define ADK_GETPROTO</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00035">adk.h:35</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="class_u_s_b_device_config_html"><div class="ttname"><a href="class_u_s_b_device_config.html">USBDeviceConfig</a></div><div class="ttdef"><b>Definition:</b> <a href="_usb_core_8h_source.html#l00132">UsbCore.h:132</a></div></div>
2013-10-21 21:15:43 +02:00
<div class="ttc" id="_usb_8h_html"><div class="ttname"><a href="_usb_8h.html">Usb.h</a></div></div>
<div class="ttc" id="class_a_d_k_html_a1dee02856625dfcac4b0cdd4e8672cef"><div class="ttname"><a href="class_a_d_k.html#a1dee02856625dfcac4b0cdd4e8672cef">ADK::isReady</a></div><div class="ttdeci">virtual bool isReady()</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00111">adk.h:111</a></div></div>
<div class="ttc" id="class_a_d_k_html_acfc5a7e45f15bba7ff8cd42552796624"><div class="ttname"><a href="class_a_d_k.html#acfc5a7e45f15bba7ff8cd42552796624">ADK::epDataOutIndex</a></div><div class="ttdeci">static const uint8_t epDataOutIndex</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00070">adk.h:70</a></div></div>
<div class="ttc" id="class_a_d_k_html"><div class="ttname"><a href="class_a_d_k.html">ADK</a></div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00053">adk.h:53</a></div></div>
<div class="ttc" id="adk_8h_html_a6ebdba027fb7072f681e6445a385e8f2"><div class="ttname"><a href="adk_8h.html#a6ebdba027fb7072f681e6445a385e8f2">ADK_ACCSTART</a></div><div class="ttdeci">#define ADK_ACCSTART</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00037">adk.h:37</a></div></div>
2013-10-21 21:15:43 +02:00
<div class="ttc" id="adk_8h_html_a32e861258886323d4dbcf066641597a4"><div class="ttname"><a href="adk_8h.html#a32e861258886323d4dbcf066641597a4">ADK_PID</a></div><div class="ttdeci">#define ADK_PID</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00026">adk.h:26</a></div></div>
<div class="ttc" id="class_a_d_k_html_af3784434ee6a1c6f3dc5b591f467e703"><div class="ttname"><a href="class_a_d_k.html#af3784434ee6a1c6f3dc5b591f467e703">ADK::Poll</a></div><div class="ttdeci">virtual uint8_t Poll()</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00103">adk.h:103</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="class_u_s_b_html_a636695a5c3d35cd6b9e31c54edfacd7c"><div class="ttname"><a href="class_u_s_b.html#a636695a5c3d35cd6b9e31c54edfacd7c">USB::ctrlReq</a></div><div class="ttdeci">uint8_t ctrlReq(uint8_t addr, uint8_t ep, uint8_t bmReqType, uint8_t bRequest, uint8_t wValLo, uint8_t wValHi, uint16_t wInd, uint16_t total, uint16_t nbytes, uint8_t *dataptr, USBReadParser *p)</div><div class="ttdef"><b>Definition:</b> <a href="_usb_8cpp_source.html#l00133">Usb.cpp:133</a></div></div>
<div class="ttc" id="adk_8h_html_a4ab0e7e3adbc8bfc1bcdf29887c9a455"><div class="ttname"><a href="adk_8h.html#a4ab0e7e3adbc8bfc1bcdf29887c9a455">ADK_SENDSTR</a></div><div class="ttdeci">#define ADK_SENDSTR</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00036">adk.h:36</a></div></div>
<div class="ttc" id="adk_8h_html_a67b2829fb8d9f0e52eebef518ec6ebb0"><div class="ttname"><a href="adk_8h.html#a67b2829fb8d9f0e52eebef518ec6ebb0">bmREQ_ADK_GET</a></div><div class="ttdeci">#define bmREQ_ADK_GET</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00039">adk.h:39</a></div></div>
<div class="ttc" id="class_a_d_k_html_a135db75b9e8cdd59b89f46c44dd83dd4"><div class="ttname"><a href="class_a_d_k.html#a135db75b9e8cdd59b89f46c44dd83dd4">ADK::ready</a></div><div class="ttdeci">bool ready</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00078">adk.h:78</a></div></div>
<div class="ttc" id="class_a_d_k_html_a1a972e8dc98b60ab27528db3af2618c3"><div class="ttname"><a href="class_a_d_k.html#a1a972e8dc98b60ab27528db3af2618c3">ADK::GetAddress</a></div><div class="ttdeci">virtual uint8_t GetAddress()</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00107">adk.h:107</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="struct_ep_info_html"><div class="ttname"><a href="struct_ep_info.html">EpInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00039">address.h:39</a></div></div>
2013-10-21 21:15:43 +02:00
<div class="ttc" id="class_a_d_k_html_a29492dcd9b7f6023b7866cd05188d61c"><div class="ttname"><a href="class_a_d_k.html#a29492dcd9b7f6023b7866cd05188d61c">ADK::ADK</a></div><div class="ttdeci">ADK(USB *pUsb, const char *manufacturer, const char *model, const char *description, const char *version, const char *uri, const char *serial)</div><div class="ttdef"><b>Definition:</b> <a href="adk_8cpp_source.html#l00025">adk.cpp:25</a></div></div>
<div class="ttc" id="class_a_d_k_html_a6ffc693d731ddeb9499c11e893fc467d"><div class="ttname"><a href="class_a_d_k.html#a6ffc693d731ddeb9499c11e893fc467d">ADK::epInfo</a></div><div class="ttdeci">EpInfo epInfo[ADK_MAX_ENDPOINTS]</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00081">adk.h:81</a></div></div>
<div class="ttc" id="adk_8h_html_a7da9c6adbc669b65ca3e4bd3f90c4c7b"><div class="ttname"><a href="adk_8h.html#a7da9c6adbc669b65ca3e4bd3f90c4c7b">bmREQ_ADK_SEND</a></div><div class="ttdeci">#define bmREQ_ADK_SEND</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00040">adk.h:40</a></div></div>
<div class="ttc" id="adk_8h_html_ac39da606ffc273bd855152107297d6a1"><div class="ttname"><a href="adk_8h.html#ac39da606ffc273bd855152107297d6a1">ADK_MAX_ENDPOINTS</a></div><div class="ttdeci">#define ADK_MAX_ENDPOINTS</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00049">adk.h:49</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="class_usb_config_xtracter_html"><div class="ttname"><a href="class_usb_config_xtracter.html">UsbConfigXtracter</a></div><div class="ttdef"><b>Definition:</b> <a href="confdescparser_8h_source.html#l00030">confdescparser.h:30</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_a_d_k_html_ac4bd3303b99921289c3f59e2df219e50"><div class="ttname"><a href="class_a_d_k.html#ac4bd3303b99921289c3f59e2df219e50">ADK::PrintEndpointDescriptor</a></div><div class="ttdeci">void PrintEndpointDescriptor(const USB_ENDPOINT_DESCRIPTOR *ep_ptr)</div><div class="ttdef"><b>Definition:</b> <a href="adk_8cpp_source.html#l00357">adk.cpp:357</a></div></div>
2015-04-07 16:07:33 +02:00
<div class="ttc" id="class_a_d_k_html_a9ad9aa3153c4cd1e083251bf42ab536f"><div class="ttname"><a href="class_a_d_k.html#a9ad9aa3153c4cd1e083251bf42ab536f">ADK::VIDPIDOK</a></div><div class="ttdeci">virtual bool VIDPIDOK(uint16_t vid, uint16_t pid)</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00115">adk.h:115</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_a_d_k_html_a8c5c2e212c748966ccd863499d202063"><div class="ttname"><a href="class_a_d_k.html#a8c5c2e212c748966ccd863499d202063">ADK::Init</a></div><div class="ttdeci">uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed)</div><div class="ttdef"><b>Definition:</b> <a href="adk_8cpp_source.html#l00064">adk.cpp:64</a></div></div>
2018-10-13 15:47:19 +02:00
<div class="ttc" id="class_u_s_b_html"><div class="ttname"><a href="class_u_s_b.html">USB</a></div><div class="ttdef"><b>Definition:</b> <a href="_usb_core_8h_source.html#l00208">UsbCore.h:208</a></div></div>
<div class="ttc" id="class_a_d_k_html_adf969d306da15baecd5c59bbb568053e"><div class="ttname"><a href="class_a_d_k.html#adf969d306da15baecd5c59bbb568053e">ADK::bNumEP</a></div><div class="ttdeci">uint8_t bNumEP</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00077">adk.h:77</a></div></div>
2013-10-21 21:15:43 +02:00
<div class="ttc" id="adk_8h_html_a37223416b6c1bba6b86ab17211bc9af2"><div class="ttname"><a href="adk_8h.html#a37223416b6c1bba6b86ab17211bc9af2">ADK_VID</a></div><div class="ttdeci">#define ADK_VID</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00025">adk.h:25</a></div></div>
<div class="ttc" id="class_a_d_k_html_ae8fcc6a6fccab61116cea10dd1f17738"><div class="ttname"><a href="class_a_d_k.html#ae8fcc6a6fccab61116cea10dd1f17738">ADK::bConfNum</a></div><div class="ttdeci">uint8_t bConfNum</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00075">adk.h:75</a></div></div>
<div class="ttc" id="class_a_d_k_html_ab22a7c60cec56823727d4ff2cf2c4edf"><div class="ttname"><a href="class_a_d_k.html#ab22a7c60cec56823727d4ff2cf2c4edf">ADK::bAddress</a></div><div class="ttdeci">uint8_t bAddress</div><div class="ttdef"><b>Definition:</b> <a href="adk_8h_source.html#l00074">adk.h:74</a></div></div>
2013-01-30 22:00:18 +01:00
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
2013-01-30 22:00:18 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
2018-10-13 15:47:19 +02:00
</a> 1.8.14
2013-01-30 22:00:18 +01:00
</small></address>
</body>
</html>