<?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>Core Objects and Methods</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="USB Gadget API for Linux" /><link rel="up" href="ch03.html" title="Chapter 3. Kernel Mode Gadget API" /><link rel="prev" href="re15.html" title="usb_endpoint_is_isoc_out" /><link rel="next" href="re16.html" title="struct usb_request" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Core Objects and Methods</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re15.html">Prev</a> </td><th width="60%" align="center">Chapter 3. Kernel Mode Gadget API</th><td width="20%" align="right"> <a accesskey="n" href="re16.html">Next</a></td></tr></table><hr /></div><div class="sect1" title="Core Objects and Methods"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="core"></a>Core Objects and Methods</h2></div></div></div><div class="toc"><dl><dt><span class="refentrytitle"><a href="re16.html"><span>struct usb_request</span></a></span><span class="refpurpose"> —
describes one i/o request
</span></dt><dt><span class="refentrytitle"><a href="re17.html"><span>struct usb_ep</span></a></span><span class="refpurpose"> —
device side representation of USB endpoint
</span></dt><dt><span class="refentrytitle"><a href="re18.html"><span>usb_ep_enable</span></a></span><span class="refpurpose"> —
configure endpoint, making it usable
</span></dt><dt><span class="refentrytitle"><a href="re19.html"><span>usb_ep_disable</span></a></span><span class="refpurpose"> —
endpoint is no longer usable
</span></dt><dt><span class="refentrytitle"><a href="re20.html"><span>usb_ep_alloc_request</span></a></span><span class="refpurpose"> —
allocate a request object to use with this endpoint
</span></dt><dt><span class="refentrytitle"><a href="re21.html"><span>usb_ep_free_request</span></a></span><span class="refpurpose"> —
frees a request object
</span></dt><dt><span class="refentrytitle"><a href="re22.html"><span>usb_ep_queue</span></a></span><span class="refpurpose"> —
queues (submits) an I/O request to an endpoint.
</span></dt><dt><span class="refentrytitle"><a href="re23.html"><span>usb_ep_dequeue</span></a></span><span class="refpurpose"> —
dequeues (cancels, unlinks) an I/O request from an endpoint
</span></dt><dt><span class="refentrytitle"><a href="re24.html"><span>usb_ep_set_halt</span></a></span><span class="refpurpose"> —
sets the endpoint halt feature.
</span></dt><dt><span class="refentrytitle"><a href="re25.html"><span>usb_ep_clear_halt</span></a></span><span class="refpurpose"> —
clears endpoint halt, and resets toggle
</span></dt><dt><span class="refentrytitle"><a href="re26.html"><span>usb_ep_set_wedge</span></a></span><span class="refpurpose"> —
sets the halt feature and ignores clear requests
</span></dt><dt><span class="refentrytitle"><a href="re27.html"><span>usb_ep_fifo_status</span></a></span><span class="refpurpose"> —
returns number of bytes in fifo, or error
</span></dt><dt><span class="refentrytitle"><a href="re28.html"><span>usb_ep_fifo_flush</span></a></span><span class="refpurpose"> —
flushes contents of a fifo
</span></dt><dt><span class="refentrytitle"><a href="re29.html"><span>struct usb_gadget</span></a></span><span class="refpurpose"> —
represents a usb slave device
</span></dt><dt><span class="refentrytitle"><a href="re30.html"><span>gadget_is_dualspeed</span></a></span><span class="refpurpose"> —
return true iff the hardware handles high speed
</span></dt><dt><span class="refentrytitle"><a href="re31.html"><span>gadget_is_otg</span></a></span><span class="refpurpose"> —
return true iff the hardware is OTG-ready
</span></dt><dt><span class="refentrytitle"><a href="re32.html"><span>usb_gadget_frame_number</span></a></span><span class="refpurpose"> —
returns the current frame number
</span></dt><dt><span class="refentrytitle"><a href="re33.html"><span>usb_gadget_wakeup</span></a></span><span class="refpurpose"> —
tries to wake up the host connected to this gadget
</span></dt><dt><span class="refentrytitle"><a href="re34.html"><span>usb_gadget_set_selfpowered</span></a></span><span class="refpurpose"> —
sets the device selfpowered feature.
</span></dt><dt><span class="refentrytitle"><a href="re35.html"><span>usb_gadget_clear_selfpowered</span></a></span><span class="refpurpose"> —
clear the device selfpowered feature.
</span></dt><dt><span class="refentrytitle"><a href="re36.html"><span>usb_gadget_vbus_connect</span></a></span><span class="refpurpose"> —
Notify controller that VBUS is powered
</span></dt><dt><span class="refentrytitle"><a href="re37.html"><span>usb_gadget_vbus_draw</span></a></span><span class="refpurpose"> —
constrain controller's VBUS power usage
</span></dt><dt><span class="refentrytitle"><a href="re38.html"><span>usb_gadget_vbus_disconnect</span></a></span><span class="refpurpose"> —
notify controller about VBUS session end
</span></dt><dt><span class="refentrytitle"><a href="re39.html"><span>usb_gadget_connect</span></a></span><span class="refpurpose"> —
software-controlled connect to USB host
</span></dt><dt><span class="refentrytitle"><a href="re40.html"><span>usb_gadget_disconnect</span></a></span><span class="refpurpose"> —
software-controlled disconnect from USB host
</span></dt><dt><span class="refentrytitle"><a href="re41.html"><span>struct usb_gadget_driver</span></a></span><span class="refpurpose"> —
driver for usb 'slave' devices
</span></dt><dt><span class="refentrytitle"><a href="re42.html"><span>usb_gadget_register_driver</span></a></span><span class="refpurpose"> —
register a gadget driver
</span></dt><dt><span class="refentrytitle"><a href="re43.html"><span>usb_gadget_unregister_driver</span></a></span><span class="refpurpose"> —
unregister a gadget driver
</span></dt><dt><span class="refentrytitle"><a href="re44.html"><span>struct usb_string</span></a></span><span class="refpurpose"> —
wraps a C string and its USB id
</span></dt><dt><span class="refentrytitle"><a href="re45.html"><span>struct usb_gadget_strings</span></a></span><span class="refpurpose"> —
a set of USB strings in a given language
</span></dt><dt><span class="refentrytitle"><a href="re46.html"><span>usb_free_descriptors</span></a></span><span class="refpurpose"> —
free descriptors returned by <code class="function">usb_copy_descriptors</code>
</span></dt></dl></div><p>These are declared in
<code class="filename"><linux/usb/gadget.h></code>,
and are used by gadget drivers to interact with
USB peripheral controller drivers.
</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re15.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re16.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>usb_endpoint_is_isoc_out</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span>struct usb_request</span></td></tr></table></div></body></html>
