📄 usbapi_8h.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>LPCUSB: usbapi.h File Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.1 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li id="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul></div><h1>usbapi.h File Reference</h1><code>#include "<a class="el" href="type_8h-source.html">type.h</a>"</code><br><code>#include "usbstruct.h"</code><br><p>Include dependency graph for usbapi.h:<p><center><img src="usbapi_8h__incl.png" border="0" usemap="#usbapi.h_map" alt=""></center><map name="usbapi.h_map"><area href="type_8h.html" shape="rect" coords="263,31,321,57" alt=""><area href="usbstruct_8h-source.html" shape="rect" coords="125,56,213,83" alt=""></map><p>This graph shows which files directly or indirectly include this file:<p><center><img src="usbapi_8h__dep__incl.png" border="0" usemap="#usbapi.hdep_map" alt=""></center><map name="usbapi.hdep_map"><area href="usbcontrol_8c.html" shape="rect" coords="127,5,220,32" alt=""><area href="usbhw__lpc_8c.html" shape="rect" coords="126,56,222,83" alt=""><area href="usbinit_8c.html" shape="rect" coords="139,107,208,133" alt=""><area href="usbstdreq_8c.html" shape="rect" coords="128,157,219,184" alt=""></map><p><a href="usbapi_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Defines</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#b7e5d4c768cffeb25caeb0eebd6e77bc">MAX_PACKET_SIZE0</a> 64</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#ce295e880dc250a5278ad2cc90dfef15">EP_STATUS_DATA</a> (1<<0)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#fccd8c04f59fefd8b8cf75113d001886">EP_STATUS_STALLED</a> (1<<1)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#6ebc9fb24fca839d011f0e3a147cadb1">EP_STATUS_SETUP</a> (1<<2)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#507ad58f61d97e988b1c08e8c7faea75">EP_STATUS_ERROR</a> (1<<3)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#3b5672d712003b603017f0038d89af8d">EP_STATUS_NACKED</a> (1<<4)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#904d40cf292e1f12cc4d3b7c7666666e">DEV_STATUS_CONNECT</a> (1<<0)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#784b097c39a3dcc59823875baf8aaf72">DEV_STATUS_SUSPEND</a> (1<<2)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#f729f83d20bde6063a51f9087c47c4d5">DEV_STATUS_RESET</a> (1<<4)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#2373a6cd98b9e12c0c27bad4bfa26b62">INACK_CI</a> (1<<1)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#7a67de4b7201035f58a7fe6dd2f1b1ce">INACK_CO</a> (1<<2)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#b425f2a8c8f4f5b199990463a1f641c3">INACK_II</a> (1<<3)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#5f0f398a699228526bdb0b97cc2089f3">INACK_IO</a> (1<<4)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#ab9e78ead636fd86786f8ad7fe6751b7">INACK_BI</a> (1<<5)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#e5fcbeddb5535126e69bd0f18eb86d9f">INACK_BO</a> (1<<6)</td></tr><tr><td colspan="2"><br><h2>Typedefs</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void( </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#9f0289bc183dac1d5606b9d65ed4570a">TFnEPIntHandler</a> )(<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEP, <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEPStatus)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void( </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#3c28198dfc59c12995260c2432d6e81d">TFnDevIntHandler</a> )(<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bDevStatus)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void( </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#b23495399cf12995fade53dd265a0b9f">TFnFrameHandler</a> )(<a class="el" href="type_8h.html#c4de1ae30664d5bd186fb6b2ae44e725">U16</a> wFrame)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a>( </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#cdc2d456f793c62f73c83a684b9eb67d">TFnHandleRequest</a> )(<a class="el" href="structTSetupPacket.html">TSetupPacket</a> *pSetup, int *piLen, <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> **ppbData)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a>( </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#3ec03d2dae3682f9654338f69da3e501">TFnGetDescriptor</a> )(<a class="el" href="type_8h.html#c4de1ae30664d5bd186fb6b2ae44e725">U16</a> wTypeIndex, <a class="el" href="type_8h.html#c4de1ae30664d5bd186fb6b2ae44e725">U16</a> wLangID, int *piLen, <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> **ppbData)</td></tr><tr><td colspan="2"><br><h2>Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#1dfca6c758c755918d5bc1be85cdac51">USBHwInit</a> (void)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#6f1d4fe24123509bb7e6164c6826a08e">USBHwISR</a> (void)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#4887b1838764c8e463d5a032089f0d05">USBHwNakIntEnable</a> (<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bIntBits)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#539f89b5ac053db030cb222aac269e50">USBHwConnect</a> (<a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a> fConnect)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#216e35f2dda04232ef6aaa4ad9d408ec">USBHwSetAddress</a> (<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bAddr)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#cb24f45e62a6a4818cebb3738d9b3399">USBHwConfigDevice</a> (<a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a> fConfigured)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#5ada0136922486ee6dc717e03efede55">USBHwEPConfig</a> (<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEP, <a class="el" href="type_8h.html#c4de1ae30664d5bd186fb6b2ae44e725">U16</a> wMaxPacketSize)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#f7ac95bd8fcbdd75e699ce965a3fabdf">USBHwEPRead</a> (<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEP, <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> *pbBuf, int iMaxLen)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#8732fefd72cb8989d4a06094cd9e5841">USBHwEPWrite</a> (<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEP, <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> *pbBuf, int iLen)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#bf9ed734b1ea9fd15bb8db33484e76be">USBHwEPStall</a> (<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEP, <a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a> fStall)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#91f2b13376bc9bae21a4b06a770ef44d">USBHwEPGetStatus</a> (<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEP)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#85fbcc30e3f2c1a15cd35ffe286b4776">USBHwRegisterEPIntHandler</a> (<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEP, <a class="el" href="usbapi_8h.html#9f0289bc183dac1d5606b9d65ed4570a">TFnEPIntHandler</a> *pfnHandler)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#cb6cdbd30764f387eb33b8e62ab0afa6">USBHwRegisterDevIntHandler</a> (<a class="el" href="usbapi_8h.html#3c28198dfc59c12995260c2432d6e81d">TFnDevIntHandler</a> *pfnHandler)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#1e0e4a449cf9334f86b813a31345c3b0">USBHwRegisterFrameHandler</a> (<a class="el" href="usbapi_8h.html#b23495399cf12995fade53dd265a0b9f">TFnFrameHandler</a> *pfnHandler)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#e1428ee7fc4beeeff51661d76933b95e">USBInit</a> (void)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#baee648abed6949546fc94714e49d91c">USBRegisterRequestHandler</a> (int iType, <a class="el" href="usbapi_8h.html#cdc2d456f793c62f73c83a684b9eb67d">TFnHandleRequest</a> *pfnHandler, <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> *pbDataStore)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#b1f2c8f7c767971f6806c4ef42332f04">USBRegisterCustomReqHandler</a> (<a class="el" href="usbapi_8h.html#cdc2d456f793c62f73c83a684b9eb67d">TFnHandleRequest</a> *pfnHandler)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#ecf69d28f0af6dd53bd812a42e7c26f4">USBHandleStandardRequest</a> (<a class="el" href="structTSetupPacket.html">TSetupPacket</a> *pSetup, int *piLen, <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> **ppbData)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#a315d521825a97d3693f82ec48aa5282">USBHandleControlTransfer</a> (<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEP, <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bEPStat)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#24ad9054d459b37459e409ab05754325">USBRegisterDescriptors</a> (const <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> *pabDescriptors)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="usbapi_8h.html#1576cdc9478c52fb9837103a8b0c8677">USBGetDescriptor</a> (<a class="el" href="type_8h.html#c4de1ae30664d5bd186fb6b2ae44e725">U16</a> wTypeIndex, <a class="el" href="type_8h.html#c4de1ae30664d5bd186fb6b2ae44e725">U16</a> wLangID, int *piLen, <a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> **ppbData)</td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2><hr><h2>Define Documentation</h2><a class="anchor" name="904d40cf292e1f12cc4d3b7c7666666e"></a><!-- doxytag: member="usbapi.h::DEV_STATUS_CONNECT" ref="904d40cf292e1f12cc4d3b7c7666666e" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define DEV_STATUS_CONNECT (1<<0) </td> </tr> </table></div><div class="memdoc"><p>device just got connected </div></div><p><a class="anchor" name="f729f83d20bde6063a51f9087c47c4d5"></a><!-- doxytag: member="usbapi.h::DEV_STATUS_RESET" ref="f729f83d20bde6063a51f9087c47c4d5" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define DEV_STATUS_RESET (1<<4) </td> </tr> </table></div><div class="memdoc"><p>device just got reset </div></div><p><a class="anchor" name="784b097c39a3dcc59823875baf8aaf72"></a><!-- doxytag: member="usbapi.h::DEV_STATUS_SUSPEND" ref="784b097c39a3dcc59823875baf8aaf72" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define DEV_STATUS_SUSPEND (1<<2) </td> </tr> </table></div><div class="memdoc"><p>device entered suspend state </div></div><p><a class="anchor" name="ce295e880dc250a5278ad2cc90dfef15"></a><!-- doxytag: member="usbapi.h::EP_STATUS_DATA" ref="ce295e880dc250a5278ad2cc90dfef15" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define EP_STATUS_DATA (1<<0) </td> </tr> </table></div><div class="memdoc"><p>EP has data </div></div><p><a class="anchor" name="507ad58f61d97e988b1c08e8c7faea75"></a><!-- doxytag: member="usbapi.h::EP_STATUS_ERROR" ref="507ad58f61d97e988b1c08e8c7faea75" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define EP_STATUS_ERROR (1<<3) </td> </tr> </table></div><div class="memdoc"><p>EP data was overwritten by setup packet </div></div><p><a class="anchor" name="3b5672d712003b603017f0038d89af8d"></a><!-- doxytag: member="usbapi.h::EP_STATUS_NACKED" ref="3b5672d712003b603017f0038d89af8d" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define EP_STATUS_NACKED (1<<4) </td> </tr> </table></div><div class="memdoc"><p>EP sent NAK </div></div><p><a class="anchor" name="6ebc9fb24fca839d011f0e3a147cadb1"></a><!-- doxytag: member="usbapi.h::EP_STATUS_SETUP" ref="6ebc9fb24fca839d011f0e3a147cadb1" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define EP_STATUS_SETUP (1<<2) </td> </tr> </table></div><div class="memdoc"><p>EP received setup packet </div></div><p><a class="anchor" name="fccd8c04f59fefd8b8cf75113d001886"></a><!-- doxytag: member="usbapi.h::EP_STATUS_STALLED" ref="fccd8c04f59fefd8b8cf75113d001886" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define EP_STATUS_STALLED (1<<1) </td> </tr> </table></div><div class="memdoc"><p>EP is stalled </div></div><p><a class="anchor" name="ab9e78ead636fd86786f8ad7fe6751b7"></a><!-- doxytag: member="usbapi.h::INACK_BI" ref="ab9e78ead636fd86786f8ad7fe6751b7" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define INACK_BI (1<<5) </td> </tr> </table></div><div class="memdoc"><p>interrupt on NACK for bulk in </div></div><p><a class="anchor" name="e5fcbeddb5535126e69bd0f18eb86d9f"></a><!-- doxytag: member="usbapi.h::INACK_BO" ref="e5fcbeddb5535126e69bd0f18eb86d9f" args="" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">#define INACK_BO (1<<6) </td> </tr> </table></div><div class="memdoc"><p>interrupt on NACK for bulk out </div></div><p>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -