174 lines
11 KiB
HTML
174 lines
11 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: USB Device Core (USBD)</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><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><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('group__group__usbd.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="summary">
|
|
<a href="#groups">Modules</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">USB Device Core (USBD)</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
|
|
Modules</h2></td></tr>
|
|
<tr class="memitem:group__group__dcd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__dcd.html">Device Controller Driver (DCD)</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6161098dcbbe1fe652d4970f84c10764"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6161098dcbbe1fe652d4970f84c10764"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>ATTR_USB_MIN_ALIGNMENT</b>   <a class="el" href="group___group___variable_attr.html#ga2438155e62fe9b0185e856ade620cd5d">ATTR_ALIGNED</a>(64)</td></tr>
|
|
<tr class="separator:ga6161098dcbbe1fe652d4970f84c10764"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2a5230d87078cc1195f93f00f6198ae8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structtusbd__descriptor__pointer__t.html">tusbd_descriptor_pointer_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbd.html#ga2a5230d87078cc1195f93f00f6198ae8">tusbd_descriptor_pointers</a></td></tr>
|
|
<tr class="separator:ga2a5230d87078cc1195f93f00f6198ae8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8d86084d5766c5063ff00688b334ac36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8d86084d5766c5063ff00688b334ac36"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>tusbd_is_configured</b> (uint8_t coreid) <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></td></tr>
|
|
<tr class="separator:ga8d86084d5766c5063ff00688b334ac36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga94798fdadfbf49a7c658ace669a1d310"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <b>USBD_INTERFACE_NUM_MAX</b> = 16
|
|
}</td></tr>
|
|
<tr class="separator:ga94798fdadfbf49a7c658ace669a1d310"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4506d73a814065777fbc54e087911a77"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>usbd_bus_event_type_t</b> { <b>USBD_BUS_EVENT_RESET</b> = 1,
|
|
<b>USBD_BUS_EVENT_UNPLUGGED</b>,
|
|
<b>USBD_BUS_EVENT_SUSPENDED</b>,
|
|
<b>USBD_BUS_EVENT_RESUME</b>
|
|
}</td></tr>
|
|
<tr class="separator:ga4506d73a814065777fbc54e087911a77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga24f6a3bd9e88882d5282d3bd841df122"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga24f6a3bd9e88882d5282d3bd841df122"></a>
|
|
<a class="el" href="structusbd__device__info__t.html">usbd_device_info_t</a> </td><td class="memItemRight" valign="bottom"><b>usbd_devices</b> [CONTROLLER_DEVICE_NUMBER]</td></tr>
|
|
<tr class="separator:ga24f6a3bd9e88882d5282d3bd841df122"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga40619cfb0da5f88590f32920909166f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga40619cfb0da5f88590f32920909166f6"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>usbd_dcd_bus_event_isr</b> (uint8_t coreid, usbd_bus_event_type_t bus_event)</td></tr>
|
|
<tr class="separator:ga40619cfb0da5f88590f32920909166f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab83ea9ac2e87dc69bd251aeca2c5580e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab83ea9ac2e87dc69bd251aeca2c5580e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>usbd_setup_received_isr</b> (uint8_t coreid, <a class="el" href="structtusb__control__request__t.html">tusb_control_request_t</a> *p_request)</td></tr>
|
|
<tr class="separator:gab83ea9ac2e87dc69bd251aeca2c5580e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga33209cd68b132db49cbe5d82f417165b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga33209cd68b132db49cbe5d82f417165b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>usbd_xfer_isr</b> (<a class="el" href="structendpoint__handle__t.html">endpoint_handle_t</a> edpt_hdl, tusb_event_t event, uint32_t xferred_bytes)</td></tr>
|
|
<tr class="separator:ga33209cd68b132db49cbe5d82f417165b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a class="anchor" id="ga2a5230d87078cc1195f93f00f6198ae8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structtusbd__descriptor__pointer__t.html">tusbd_descriptor_pointer_t</a> tusbd_descriptor_pointers</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Application MUST define this variable and initialize its pointers's member to all required USB descriptors including Device Descriptor, Configuration Descriptor, String Descriptors, HID Report Descriptors etc ... </p>
|
|
|
|
<p>Definition at line <a class="el" href="configuration_8txt_source.html#l00064">64</a> of file <a class="el" href="configuration_8txt_source.html">configuration.txt</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 on Tue Apr 15 2014 10:49:27 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>
|