Sophie: kernel-doc-3.11.10-100.fc18 noarch

kernel-doc-3.11.10-100.fc18.noarch.rpm

<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!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/html; charset=ANSI_X3.4-1968" /><title>usb_interrupt_msg</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="The Linux-USB Host Side API" /><link rel="up" href="usbcore.html" title="Chapter&#160;5.&#160;USB Core APIs" /><link rel="prev" href="API-usb-control-msg.html" title="usb_control_msg" /><link rel="next" href="API-usb-bulk-msg.html" title="usb_bulk_msg" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">usb_interrupt_msg</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-usb-control-msg.html">Prev</a>&#160;</td><th width="60%" align="center">Chapter&#160;5.&#160;USB Core APIs</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-usb-bulk-msg.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="API-usb-interrupt-msg"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>usb_interrupt_msg &#8212; 
     Builds an interrupt urb, sends it off and waits for completion
 </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <strong class="fsfunc">usb_interrupt_msg </strong>(</code></td><td>struct usb_device * <var class="pdparam">usb_dev</var>, </td></tr><tr><td>&#160;</td><td>unsigned int <var class="pdparam">pipe</var>, </td></tr><tr><td>&#160;</td><td>void * <var class="pdparam">data</var>, </td></tr><tr><td>&#160;</td><td>int <var class="pdparam">len</var>, </td></tr><tr><td>&#160;</td><td>int * <var class="pdparam">actual_length</var>, </td></tr><tr><td>&#160;</td><td>int <var class="pdparam">timeout</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a id="idm140259812219360"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>usb_dev</code></em></span></dt><dd><p>
     pointer to the usb device to send the message to
    </p></dd><dt><span class="term"><em class="parameter"><code>pipe</code></em></span></dt><dd><p>
     endpoint <span class="quote">&#8220;<span class="quote">pipe</span>&#8221;</span> to send the message to
    </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
     pointer to the data to send
    </p></dd><dt><span class="term"><em class="parameter"><code>len</code></em></span></dt><dd><p>
     length in bytes of the data to send
    </p></dd><dt><span class="term"><em class="parameter"><code>actual_length</code></em></span></dt><dd><p>
     pointer to a location to put the actual length transferred
     in bytes
    </p></dd><dt><span class="term"><em class="parameter"><code>timeout</code></em></span></dt><dd><p>
     time in msecs to wait for the message to complete before
     timing out (if 0 the wait is forever)
    </p></dd></dl></div></div><div class="refsect1"><a id="idm140259812206096"></a><h2>Context</h2><p>
   !in_interrupt ()
</p></div><div class="refsect1"><a id="idm140259812204944"></a><h2>Description</h2><p>
   This function sends a simple interrupt message to a specified endpoint and
   waits for the message to complete, or timeout.
   </p><p>

   If successful, it returns 0, otherwise a negative error number.  The number
   of actual bytes transferred will be stored in the actual_length paramater.
   </p><p>

   Don't use this function from within an interrupt context, like a bottom half
   handler.  If you need an asynchronous message, or need to send a message
   from within interrupt context, use <code class="function">usb_submit_urb</code> If a thread in your
   driver uses this call, make sure your <code class="function">disconnect</code> method can wait for it to
   complete.  Since you don't have a handle on the URB used, you can't cancel
   the request.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-usb-control-msg.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="usbcore.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="API-usb-bulk-msg.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">usb_control_msg</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span class="phrase">usb_bulk_msg</span></td></tr></table></div></body></html>