usbapi_8h.html

Free Usb Stack for NXP LPC2xxx microcontrollers.

<a class="anchor" name="2373a6cd98b9e12c0c27bad4bfa26b62"></a><!-- doxytag: member="usbapi.h::INACK_CI" ref="2373a6cd98b9e12c0c27bad4bfa26b62" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define INACK_CI&nbsp;&nbsp;&nbsp;(1&lt;&lt;1)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
interrupt on NACK for control in 
</div>
</div><p>
<a class="anchor" name="7a67de4b7201035f58a7fe6dd2f1b1ce"></a><!-- doxytag: member="usbapi.h::INACK_CO" ref="7a67de4b7201035f58a7fe6dd2f1b1ce" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define INACK_CO&nbsp;&nbsp;&nbsp;(1&lt;&lt;2)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
interrupt on NACK for control out 
</div>
</div><p>
<a class="anchor" name="b425f2a8c8f4f5b199990463a1f641c3"></a><!-- doxytag: member="usbapi.h::INACK_II" ref="b425f2a8c8f4f5b199990463a1f641c3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define INACK_II&nbsp;&nbsp;&nbsp;(1&lt;&lt;3)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
interrupt on NACK for interrupt in 
</div>
</div><p>
<a class="anchor" name="5f0f398a699228526bdb0b97cc2089f3"></a><!-- doxytag: member="usbapi.h::INACK_IO" ref="5f0f398a699228526bdb0b97cc2089f3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define INACK_IO&nbsp;&nbsp;&nbsp;(1&lt;&lt;4)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
interrupt on NACK for interrupt out 
</div>
</div><p>
<a class="anchor" name="b7e5d4c768cffeb25caeb0eebd6e77bc"></a><!-- doxytag: member="usbapi.h::MAX_PACKET_SIZE0" ref="b7e5d4c768cffeb25caeb0eebd6e77bc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MAX_PACKET_SIZE0&nbsp;&nbsp;&nbsp;64          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
maximum packet size for EP 0 
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="3c28198dfc59c12995260c2432d6e81d"></a><!-- doxytag: member="usbapi.h::TFnDevIntHandler" ref="3c28198dfc59c12995260c2432d6e81d" args=")(U8 bDevStatus)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void( <a class="el" href="usbapi_8h.html#3c28198dfc59c12995260c2432d6e81d">TFnDevIntHandler</a>)(<a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> bDevStatus)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Device status handler callback 
</div>
</div><p>
<a class="anchor" name="9f0289bc183dac1d5606b9d65ed4570a"></a><!-- doxytag: member="usbapi.h::TFnEPIntHandler" ref="9f0289bc183dac1d5606b9d65ed4570a" args=")(U8 bEP, U8 bEPStatus)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void( <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>
      </table>
</div>
<div class="memdoc">

<p>
Endpoint interrupt handler callback 
</div>
</div><p>
<a class="anchor" name="b23495399cf12995fade53dd265a0b9f"></a><!-- doxytag: member="usbapi.h::TFnFrameHandler" ref="b23495399cf12995fade53dd265a0b9f" args=")(U16 wFrame)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void( <a class="el" href="usbapi_8h.html#b23495399cf12995fade53dd265a0b9f">TFnFrameHandler</a>)(<a class="el" href="type_8h.html#c4de1ae30664d5bd186fb6b2ae44e725">U16</a> wFrame)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Frame event handler callback 
</div>
</div><p>
<a class="anchor" name="3ec03d2dae3682f9654338f69da3e501"></a><!-- doxytag: member="usbapi.h::TFnGetDescriptor" ref="3ec03d2dae3682f9654338f69da3e501" args=")(U16 wTypeIndex, U16 wLangID, int *piLen, U8 **ppbData)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a>( <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>
      </table>
</div>
<div class="memdoc">

<p>
Descriptor handler callback 
</div>
</div><p>
<a class="anchor" name="cdc2d456f793c62f73c83a684b9eb67d"></a><!-- doxytag: member="usbapi.h::TFnHandleRequest" ref="cdc2d456f793c62f73c83a684b9eb67d" args=")(TSetupPacket *pSetup, int *piLen, U8 **ppbData)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a>( <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>
      </table>
</div>
<div class="memdoc">

<p>
Request handler callback (standard, vendor, class) 
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="1576cdc9478c52fb9837103a8b0c8677"></a><!-- doxytag: member="usbapi.h::USBGetDescriptor" ref="1576cdc9478c52fb9837103a8b0c8677" args="(U16 wTypeIndex, U16 wLangID, int *piLen, U8 **ppbData)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a> USBGetDescriptor           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="type_8h.html#c4de1ae30664d5bd186fb6b2ae44e725">U16</a>&nbsp;</td>
          <td class="paramname"> <em>wTypeIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="type_8h.html#c4de1ae30664d5bd186fb6b2ae44e725">U16</a>&nbsp;</td>
          <td class="paramname"> <em>wLangID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&nbsp;</td>
          <td class="paramname"> <em>piLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> **&nbsp;</td>
          <td class="paramname"> <em>ppbData</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Parses the list of installed USB descriptors and attempts to find the specified USB descriptor.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>wTypeIndex</em>&nbsp;</td><td>Type and index of the descriptor </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>wLangID</em>&nbsp;</td><td>Language ID of the descriptor (currently unused) </td></tr>
    <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>*piLen</em>&nbsp;</td><td>Descriptor length </td></tr>
    <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>*ppbData</em>&nbsp;</td><td>Descriptor data</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if the descriptor was found, FALSE otherwise </dd></dl>

</div>
</div><p>
<a class="anchor" name="a315d521825a97d3693f82ec48aa5282"></a><!-- doxytag: member="usbapi.h::USBHandleControlTransfer" ref="a315d521825a97d3693f82ec48aa5282" args="(U8 bEP, U8 bEPStat)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void USBHandleControlTransfer           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a>&nbsp;</td>
          <td class="paramname"> <em>bEP</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a>&nbsp;</td>
          <td class="paramname"> <em>bEPStat</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Handles IN/OUT transfers on EP0<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>bEP</em>&nbsp;</td><td>Endpoint address </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>bEPStat</em>&nbsp;</td><td>Endpoint status </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="ecf69d28f0af6dd53bd812a42e7c26f4"></a><!-- doxytag: member="usbapi.h::USBHandleStandardRequest" ref="ecf69d28f0af6dd53bd812a42e7c26f4" args="(TSetupPacket *pSetup, int *piLen, U8 **ppbData)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="type_8h.html#050c65e107f0c828f856a231f4b4e788">BOOL</a> USBHandleStandardRequest           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structTSetupPacket.html">TSetupPacket</a> *&nbsp;</td>
          <td class="paramname"> <em>pSetup</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&nbsp;</td>
          <td class="paramname"> <em>piLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="type_8h.html#3cb25ca6f51f003950f9625ff05536fc">U8</a> **&nbsp;</td>
          <td class="paramname"> <em>ppbData</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default handler for standard ('chapter 9') requests<p>
If a custom request handler was installed, this handler is called first.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>pSetup</em>&nbsp;</td><td>The setup packet </td></tr>
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>*piLen</em>&nbsp;</td><td>Pointer to data length </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>ppbData</em>&nbsp;</td><td>Data buffer.</td></tr>
  </table>