201 lines
17 KiB
HTML
201 lines
17 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"/>
|
|
<title>Driver_USBD.h File Reference</title>
|
|
<title>CMSIS-Driver: Driver_USBD.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="cmsis.css" rel="stylesheet" type="text/css" />
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="printComponentTabs.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>
|
|
</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: 46px;">
|
|
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">CMSIS-Driver
|
|
 <span id="projectnumber">Version 2.6.0</span>
|
|
</div>
|
|
<div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<div id="CMSISnav" class="tabs1">
|
|
<ul class="tablist">
|
|
<script type="text/javascript">
|
|
<!--
|
|
writeComponentTabs.call(this);
|
|
//-->
|
|
</script>
|
|
</ul>
|
|
</div>
|
|
<!-- 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>Usage and Description</span></a></li>
|
|
<li><a href="modules.html"><span>Reference</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('Driver__USBD_8h.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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Driver_USBD.h File Reference</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:structARM__USBD__STATE"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__STATE">ARM_USBD_STATE</a></td></tr>
|
|
<tr class="memdesc:structARM__USBD__STATE"><td class="mdescLeft"> </td><td class="mdescRight">USB Device State. <a href="group__usbd__interface__gr.html#structARM__USBD__STATE">More...</a><br/></td></tr>
|
|
<tr class="separator:structARM__USBD__STATE"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structARM__USBD__CAPABILITIES"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">ARM_USBD_CAPABILITIES</a></td></tr>
|
|
<tr class="memdesc:structARM__USBD__CAPABILITIES"><td class="mdescLeft"> </td><td class="mdescRight">USB Device Driver Capabilities. <a href="group__usbd__interface__gr.html#structARM__USBD__CAPABILITIES">More...</a><br/></td></tr>
|
|
<tr class="separator:structARM__USBD__CAPABILITIES"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structARM__DRIVER__USBD"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">ARM_DRIVER_USBD</a></td></tr>
|
|
<tr class="memdesc:structARM__DRIVER__USBD"><td class="mdescLeft"> </td><td class="mdescRight">Access structure of the USB Device Driver. <a href="group__usbd__interface__gr.html#structARM__DRIVER__USBD">More...</a><br/></td></tr>
|
|
<tr class="separator:structARM__DRIVER__USBD"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a71df406694e557f19cae5e43ff1960ba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__USBD_8h.html#a71df406694e557f19cae5e43ff1960ba">ARM_USBD_API_VERSION</a>   <a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(2,2) /* API version */</td></tr>
|
|
<tr class="separator:a71df406694e557f19cae5e43ff1960ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga32546413cfe55154351f74fb56de1045"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga32546413cfe55154351f74fb56de1045">ARM_USBD_EVENT_VBUS_ON</a>   (1UL << 0)</td></tr>
|
|
<tr class="memdesc:ga32546413cfe55154351f74fb56de1045"><td class="mdescLeft"> </td><td class="mdescRight">USB Device VBUS On. <a href="group__USBD__dev__events.html#ga32546413cfe55154351f74fb56de1045">More...</a><br/></td></tr>
|
|
<tr class="separator:ga32546413cfe55154351f74fb56de1045"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga6810c08a6e6a46ba443899e5ba9c3aec">ARM_USBD_EVENT_VBUS_OFF</a>   (1UL << 1)</td></tr>
|
|
<tr class="memdesc:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="mdescLeft"> </td><td class="mdescRight">USB Device VBUS Off. <a href="group__USBD__dev__events.html#ga6810c08a6e6a46ba443899e5ba9c3aec">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6810c08a6e6a46ba443899e5ba9c3aec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga489e1b88f7b0361494ca3a8dc73c227a">ARM_USBD_EVENT_RESET</a>   (1UL << 2)</td></tr>
|
|
<tr class="memdesc:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="mdescLeft"> </td><td class="mdescRight">USB Reset occurred. <a href="group__USBD__dev__events.html#ga489e1b88f7b0361494ca3a8dc73c227a">More...</a><br/></td></tr>
|
|
<tr class="separator:ga489e1b88f7b0361494ca3a8dc73c227a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga689d1e031013d0e66aeef4243490d843"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga689d1e031013d0e66aeef4243490d843">ARM_USBD_EVENT_HIGH_SPEED</a>   (1UL << 3)</td></tr>
|
|
<tr class="memdesc:ga689d1e031013d0e66aeef4243490d843"><td class="mdescLeft"> </td><td class="mdescRight">USB switch to High Speed occurred. <a href="group__USBD__dev__events.html#ga689d1e031013d0e66aeef4243490d843">More...</a><br/></td></tr>
|
|
<tr class="separator:ga689d1e031013d0e66aeef4243490d843"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga74dc7c0ba71baf285400d5a555224653"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga74dc7c0ba71baf285400d5a555224653">ARM_USBD_EVENT_SUSPEND</a>   (1UL << 4)</td></tr>
|
|
<tr class="memdesc:ga74dc7c0ba71baf285400d5a555224653"><td class="mdescLeft"> </td><td class="mdescRight">USB Suspend occurred. <a href="group__USBD__dev__events.html#ga74dc7c0ba71baf285400d5a555224653">More...</a><br/></td></tr>
|
|
<tr class="separator:ga74dc7c0ba71baf285400d5a555224653"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5b1c9884b237ba7778f79761e5db9f45"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__dev__events.html#ga5b1c9884b237ba7778f79761e5db9f45">ARM_USBD_EVENT_RESUME</a>   (1UL << 5)</td></tr>
|
|
<tr class="memdesc:ga5b1c9884b237ba7778f79761e5db9f45"><td class="mdescLeft"> </td><td class="mdescRight">USB Resume occurred. <a href="group__USBD__dev__events.html#ga5b1c9884b237ba7778f79761e5db9f45">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5b1c9884b237ba7778f79761e5db9f45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa0814f6880f4c0ac302ac9ebc8170739"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html#gaa0814f6880f4c0ac302ac9ebc8170739">ARM_USBD_EVENT_SETUP</a>   (1UL << 0)</td></tr>
|
|
<tr class="memdesc:gaa0814f6880f4c0ac302ac9ebc8170739"><td class="mdescLeft"> </td><td class="mdescRight">SETUP Packet. <a href="group__USBD__ep__events.html#gaa0814f6880f4c0ac302ac9ebc8170739">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa0814f6880f4c0ac302ac9ebc8170739"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga35f7340508acb5fe7a5f43bbcac1887a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html#ga35f7340508acb5fe7a5f43bbcac1887a">ARM_USBD_EVENT_OUT</a>   (1UL << 1)</td></tr>
|
|
<tr class="memdesc:ga35f7340508acb5fe7a5f43bbcac1887a"><td class="mdescLeft"> </td><td class="mdescRight">OUT Packet(s) <a href="group__USBD__ep__events.html#ga35f7340508acb5fe7a5f43bbcac1887a">More...</a><br/></td></tr>
|
|
<tr class="separator:ga35f7340508acb5fe7a5f43bbcac1887a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga375d3d8f363a056ff607c5ab3b92a864"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__USBD__ep__events.html#ga375d3d8f363a056ff607c5ab3b92a864">ARM_USBD_EVENT_IN</a>   (1UL << 2)</td></tr>
|
|
<tr class="memdesc:ga375d3d8f363a056ff607c5ab3b92a864"><td class="mdescLeft"> </td><td class="mdescRight">IN Packet(s) <a href="group__USBD__ep__events.html#ga375d3d8f363a056ff607c5ab3b92a864">More...</a><br/></td></tr>
|
|
<tr class="separator:ga375d3d8f363a056ff607c5ab3b92a864"><td class="memSeparator" colspan="2"> </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:ga7c1878799699ddd34cec696da499f7bd"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">ARM_USBD_SignalDeviceEvent_t</a> )(uint32_t event)</td></tr>
|
|
<tr class="memdesc:ga7c1878799699ddd34cec696da499f7bd"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#gafe58a4db1d26b21ca5d418ee49e103a5">ARM_USBD_SignalDeviceEvent</a> : Signal USB Device Event. <a href="group__usbd__interface__gr.html#ga7c1878799699ddd34cec696da499f7bd">More...</a><br/></td></tr>
|
|
<tr class="separator:ga7c1878799699ddd34cec696da499f7bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaae754763700fc5059a6bde57ea2d4e2c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">ARM_USBD_SignalEndpointEvent_t</a> )(uint8_t ep_addr, uint32_t event)</td></tr>
|
|
<tr class="memdesc:gaae754763700fc5059a6bde57ea2d4e2c"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to <a class="el" href="group__usbd__interface__gr.html#ga9aa5bc5cb45084194a77fae1457f6575">ARM_USBD_SignalEndpointEvent</a> : Signal USB Endpoint Event. <a href="group__usbd__interface__gr.html#gaae754763700fc5059a6bde57ea2d4e2c">More...</a><br/></td></tr>
|
|
<tr class="separator:gaae754763700fc5059a6bde57ea2d4e2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="a71df406694e557f19cae5e43ff1960ba"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ARM_USBD_API_VERSION   <a class="el" href="Driver__Common_8h.html#a43c7ca1eb0786d818624246c09932a74">ARM_DRIVER_VERSION_MAJOR_MINOR</a>(2,2) /* API version */</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</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="navelem"><a class="el" href="dir_7151b3cc910409bb744bd274374c738d.html">Driver</a></li><li class="navelem"><a class="el" href="dir_9c39448ea46a8e15f1aabc7dec307fcf.html">Include</a></li><li class="navelem"><a class="el" href="Driver__USBD_8h.html">Driver_USBD.h</a></li>
|
|
<li class="footer">Generated on Wed Aug 1 2018 17:12:13 for CMSIS-Driver by Arm Ltd. All rights reserved.
|
|
<!--
|
|
<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>
|