diff options
Diffstat (limited to 'CMSIS/Documentation/Driver/html/group___u_s_b_h__pipe__events.html')
| -rw-r--r-- | CMSIS/Documentation/Driver/html/group___u_s_b_h__pipe__events.html | 261 |
1 files changed, 261 insertions, 0 deletions
diff --git a/CMSIS/Documentation/Driver/html/group___u_s_b_h__pipe__events.html b/CMSIS/Documentation/Driver/html/group___u_s_b_h__pipe__events.html new file mode 100644 index 0000000..b7ab526 --- /dev/null +++ b/CMSIS/Documentation/Driver/html/group___u_s_b_h__pipe__events.html @@ -0,0 +1,261 @@ +<!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>USBH Pipe Events</title> +<title>CMSIS-Driver: USBH Pipe Events</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); +</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="stylsheetf" 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: 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.04</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.2 --> +<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('group___u_s_b_h__pipe__events.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="#define-members">Macros</a> </div> + <div class="headertitle"> +<div class="title">USBH Pipe Events</div> </div> +<div class="ingroups"><a class="el" href="group__usbh__host__gr.html">USB Host</a></div></div><!--header--> +<div class="contents"> + +<p>The USB Host driver generates Pipe call back events that are notified via the function <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a>. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:gab161955b1ab0b7928befe446ef78634b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___u_s_b_h__pipe__events.html#gab161955b1ab0b7928befe446ef78634b">ARM_USBH_EVENT_TRANSFER_COMPLETE</a>   (1UL << 0)</td></tr> +<tr class="memdesc:gab161955b1ab0b7928befe446ef78634b"><td class="mdescLeft"> </td><td class="mdescRight">Transfer completed. <a href="#gab161955b1ab0b7928befe446ef78634b"></a><br/></td></tr> +<tr class="separator:gab161955b1ab0b7928befe446ef78634b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3895b82193855d9a6f0b7e8a9b65e2c0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___u_s_b_h__pipe__events.html#ga3895b82193855d9a6f0b7e8a9b65e2c0">ARM_USBH_EVENT_HANDSHAKE_NAK</a>   (1UL << 1)</td></tr> +<tr class="memdesc:ga3895b82193855d9a6f0b7e8a9b65e2c0"><td class="mdescLeft"> </td><td class="mdescRight">NAK Handshake received. <a href="#ga3895b82193855d9a6f0b7e8a9b65e2c0"></a><br/></td></tr> +<tr class="separator:ga3895b82193855d9a6f0b7e8a9b65e2c0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga62ae214576c923ce737a16098e9836e5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___u_s_b_h__pipe__events.html#ga62ae214576c923ce737a16098e9836e5">ARM_USBH_EVENT_HANDSHAKE_NYET</a>   (1UL << 2)</td></tr> +<tr class="memdesc:ga62ae214576c923ce737a16098e9836e5"><td class="mdescLeft"> </td><td class="mdescRight">NYET Handshake received. <a href="#ga62ae214576c923ce737a16098e9836e5"></a><br/></td></tr> +<tr class="separator:ga62ae214576c923ce737a16098e9836e5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga681ce0983f8c77c41f3cc5df1af8d010"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___u_s_b_h__pipe__events.html#ga681ce0983f8c77c41f3cc5df1af8d010">ARM_USBH_EVENT_HANDSHAKE_MDATA</a>   (1UL << 3)</td></tr> +<tr class="memdesc:ga681ce0983f8c77c41f3cc5df1af8d010"><td class="mdescLeft"> </td><td class="mdescRight">MDATA Handshake received. <a href="#ga681ce0983f8c77c41f3cc5df1af8d010"></a><br/></td></tr> +<tr class="separator:ga681ce0983f8c77c41f3cc5df1af8d010"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4fdc44fc78f342576dd11ad7cb84b4b8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___u_s_b_h__pipe__events.html#ga4fdc44fc78f342576dd11ad7cb84b4b8">ARM_USBH_EVENT_HANDSHAKE_STALL</a>   (1UL << 4)</td></tr> +<tr class="memdesc:ga4fdc44fc78f342576dd11ad7cb84b4b8"><td class="mdescLeft"> </td><td class="mdescRight">STALL Handshake received. <a href="#ga4fdc44fc78f342576dd11ad7cb84b4b8"></a><br/></td></tr> +<tr class="separator:ga4fdc44fc78f342576dd11ad7cb84b4b8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac7cc573f879fbab678dc7d1347c68614"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___u_s_b_h__pipe__events.html#gac7cc573f879fbab678dc7d1347c68614">ARM_USBH_EVENT_HANDSHAKE_ERR</a>   (1UL << 5)</td></tr> +<tr class="memdesc:gac7cc573f879fbab678dc7d1347c68614"><td class="mdescLeft"> </td><td class="mdescRight">ERR Handshake received. <a href="#gac7cc573f879fbab678dc7d1347c68614"></a><br/></td></tr> +<tr class="separator:gac7cc573f879fbab678dc7d1347c68614"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7bd871b1e5c059bee398c32429370724"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___u_s_b_h__pipe__events.html#ga7bd871b1e5c059bee398c32429370724">ARM_USBH_EVENT_BUS_ERROR</a>   (1UL << 6)</td></tr> +<tr class="memdesc:ga7bd871b1e5c059bee398c32429370724"><td class="mdescLeft"> </td><td class="mdescRight">Bus Error detected. <a href="#ga7bd871b1e5c059bee398c32429370724"></a><br/></td></tr> +<tr class="separator:ga7bd871b1e5c059bee398c32429370724"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Description</h2> +<p>The USB Host driver generates Pipe call back events that are notified via the function <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a>. </p> +<p>This section provides the event values for the <a class="el" href="group__usbh__host__gr.html#gae58d36afd83a0e32b07e89fb7145c9de">ARM_USBH_SignalPipeEvent</a> callback function.</p> +<p>The following call back notification events are generated: </p> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a class="anchor" id="gab161955b1ab0b7928befe446ef78634b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_USBH_EVENT_TRANSFER_COMPLETE   (1UL << 0)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Transfer completed. </p> + +</div> +</div> +<a class="anchor" id="ga3895b82193855d9a6f0b7e8a9b65e2c0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_NAK   (1UL << 1)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>NAK Handshake received. </p> + +</div> +</div> +<a class="anchor" id="ga62ae214576c923ce737a16098e9836e5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_NYET   (1UL << 2)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>NYET Handshake received. </p> + +</div> +</div> +<a class="anchor" id="ga681ce0983f8c77c41f3cc5df1af8d010"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_MDATA   (1UL << 3)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>MDATA Handshake received. </p> + +</div> +</div> +<a class="anchor" id="ga4fdc44fc78f342576dd11ad7cb84b4b8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_STALL   (1UL << 4)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>STALL Handshake received. </p> + +</div> +</div> +<a class="anchor" id="gac7cc573f879fbab678dc7d1347c68614"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_USBH_EVENT_HANDSHAKE_ERR   (1UL << 5)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>ERR Handshake received. </p> + +</div> +</div> +<a class="anchor" id="ga7bd871b1e5c059bee398c32429370724"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARM_USBH_EVENT_BUS_ERROR   (1UL << 6)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Bus Error detected. </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 Oct 27 2015 14:35:25 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.2 + --> + </li> + </ul> +</div> +</body> +</html> |