214 lines
20 KiB
HTML
214 lines
20 KiB
HTML
<!-- HTML header for doxygen 1.8.6-->
|
|
<!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.6"/>
|
|
<title>tinyusb: tinyusb/host/usbh_hcd.h Source File</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="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 width="100%" cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">tinyusb
|
|
 <span id="projectnumber">0.4</span>
|
|
</div>
|
|
</td>
|
|
<td align="right">
|
|
<a href="https://pledgie.com/campaigns/24694"><img border="0" src="https://pledgie.com/campaigns/24694.png?skin_name=chrome" alt="Click here to lend your support to tinyusb donation and make a donation at pledgie.com"></a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<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><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><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="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('usbh__hcd_8h_source.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)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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="headertitle">
|
|
<div class="title">usbh_hcd.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="usbh__hcd_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> <span class="comment">/**************************************************************************/</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/**************************************************************************/</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#ifndef _TUSB_USBH_HCD_H_</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span><span class="preprocessor">#define _TUSB_USBH_HCD_H_</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// INCLUDE</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#include "<a class="code" href="common_8h.html">common/common.h</a>"</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#ifdef _TEST_</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="hcd_8h.html">hcd.h</a>"</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#include "<a class="code" href="osal_8h.html">osal.h</a>"</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// USBH-HCD common data structure</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structusbh__enumerate__t.html"> 62</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group___group___variable_attr.html#ga2438155e62fe9b0185e856ade620cd5d">ATTR_ALIGNED</a>(4){</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  uint8_t core_id;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  uint8_t hub_addr;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  uint8_t hub_port;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  uint8_t reserve;</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <a class="code" href="structusbh__enumerate__t.html">usbh_enumerate_t</a>;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="structusbh__device__info__t.html"> 69</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">//------------- port -------------//</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  uint8_t core_id;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  uint8_t hub_addr;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  uint8_t hub_port;</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  uint8_t speed;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">//------------- device descriptor -------------//</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  uint16_t vendor_id;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  uint16_t product_id;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  uint8_t configure_count; <span class="comment">// bNumConfigurations alias</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">//------------- configuration descriptor -------------//</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  uint8_t interface_count; <span class="comment">// bNumInterfaces alias</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">//------------- device -------------//</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">volatile</span> uint8_t state; <span class="comment">// device state, value from enum tusbh_device_state_t</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  uint32_t flag_supported_class; <span class="comment">// a bitmap of supported class</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">//------------- control pipe -------------//</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">volatile</span> uint8_t pipe_status;</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// uint8_t xferred_bytes; TODO not yet necessary</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="structtusb__control__request__t.html">tusb_control_request_t</a> request;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  OSAL_SEM_DEF(semaphore); <span class="comment">// TODO move to semaphore pool ?</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  osal_semaphore_handle_t sem_hdl; <span class="comment">// used to synchronize with HCD when control xfer complete</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  OSAL_MUTEX_DEF(mutex); <span class="comment">// TODO move to mutex pool ?</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  osal_mutex_handle_t mutex_hdl; <span class="comment">// used to exclusively occupy control pipe</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  } control;</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> } <a class="code" href="structusbh__device__info__t.html">usbh_device_info_t</a>;</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">extern</span> <a class="code" href="structusbh__device__info__t.html">usbh_device_info_t</a> usbh_devices[<a class="code" href="group___t_u_s_b___c_f_g___h_o_s_t.html#gafc4906ab5cb44b1931d4ae55894440c1">TUSB_CFG_HOST_DEVICE_MAX</a>+1]; <span class="comment">// including zero-address</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">// callback from HCD ISR</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">//--------------------------------------------------------------------+</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keywordtype">void</span> usbh_xfer_isr(<a class="code" href="structpipe__handle__t.html">pipe_handle_t</a> pipe_hdl, uint8_t class_code, tusb_event_t event, uint32_t xferred_bytes);</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">void</span> usbh_hcd_rhport_plugged_isr(uint8_t hostid);</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">void</span> usbh_hcd_rhport_unplugged_isr(uint8_t hostid);</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor"></span> }</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#endif </span><span class="comment">/* _TUSB_USBH_HCD_H_ */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"></span></div>
|
|
<div class="ttc" id="osal_8h_html"><div class="ttname"><a href="osal_8h.html">osal.h</a></div></div>
|
|
<div class="ttc" id="structtusb__control__request__t_html"><div class="ttname"><a href="structtusb__control__request__t.html">tusb_control_request_t</a></div><div class="ttdef"><b>Definition:</b> <a href="std__request_8h_source.html#l00049">std_request.h:49</a></div></div>
|
|
<div class="ttc" id="structpipe__handle__t_html"><div class="ttname"><a href="structpipe__handle__t.html">pipe_handle_t</a></div><div class="ttdef"><b>Definition:</b> <a href="hcd_8h_source.html#l00063">hcd.h:63</a></div></div>
|
|
<div class="ttc" id="group___t_u_s_b___c_f_g___h_o_s_t_html_gafc4906ab5cb44b1931d4ae55894440c1"><div class="ttname"><a href="group___t_u_s_b___c_f_g___h_o_s_t.html#gafc4906ab5cb44b1931d4ae55894440c1">TUSB_CFG_HOST_DEVICE_MAX</a></div><div class="ttdeci">#define TUSB_CFG_HOST_DEVICE_MAX</div><div class="ttdoc">Maximum number of device host stack can manage If hub class is not enabled, set this equal to numbe...</div><div class="ttdef"><b>Definition:</b> <a href="configuration_8txt_source.html#l00035">configuration.txt:35</a></div></div>
|
|
<div class="ttc" id="structusbh__enumerate__t_html"><div class="ttname"><a href="structusbh__enumerate__t.html">usbh_enumerate_t</a></div><div class="ttdef"><b>Definition:</b> <a href="usbh__hcd_8h_source.html#l00062">usbh_hcd.h:62</a></div></div>
|
|
<div class="ttc" id="hcd_8h_html"><div class="ttname"><a href="hcd_8h.html">hcd.h</a></div></div>
|
|
<div class="ttc" id="structusbh__device__info__t_html"><div class="ttname"><a href="structusbh__device__info__t.html">usbh_device_info_t</a></div><div class="ttdef"><b>Definition:</b> <a href="usbh__hcd_8h_source.html#l00069">usbh_hcd.h:69</a></div></div>
|
|
<div class="ttc" id="group___group___variable_attr_html_ga2438155e62fe9b0185e856ade620cd5d"><div class="ttname"><a href="group___group___variable_attr.html#ga2438155e62fe9b0185e856ade620cd5d">ATTR_ALIGNED</a></div><div class="ttdeci">#define ATTR_ALIGNED(Bytes)</div><div class="ttdoc">This attribute specifies a minimum alignment for the variable or structure field, measured in bytes...</div><div class="ttdef"><b>Definition:</b> <a href="compiler__gcc_8h_source.html#l00072">compiler_gcc.h:72</a></div></div>
|
|
<div class="ttc" id="common_8h_html"><div class="ttname"><a href="common_8h.html">common.h</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_f44c0f1c8d3a85cc1de1e7f4648a56e6.html">tinyusb</a></li><li class="navelem"><a class="el" href="dir_b871d914c1cc8934d54bd26c3ab0c17f.html">host</a></li><li class="navelem"><a class="el" href="usbh__hcd_8h.html">usbh_hcd.h</a></li>
|
|
<li class="footer">Generated on Thu Apr 17 2014 13:05:24 for tinyusb by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|