.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "USB_DRIVER" "9" "17 July 2003" "" ""

.SH NAME
struct usb_driver \- identifies USB driver to usbcore
.SH SYNOPSIS

.nf
struct usb_driver {
  struct module * owner;
  const char * name;
  int (* probe (struct usb_interface *intf,const struct usb_device_id *id);
  void (* disconnect (struct usb_interface *intf);
  int (* ioctl (struct usb_interface *intf, unsigned int code, void *buf);
  const struct usb_device_id * id_table;
};  
.fi
.SH "MEMBERS"
.TP
\fBowner\fR
Pointer to the module owner of this driver; initialize
it using THIS_MODULE.
.TP
\fBname\fR
The driver name should be unique among USB drivers,
and should normally be the same as the module name.
.TP
\fBprobe\fR
Called to see if the driver is willing to manage a particular
interface on a device.  If it is, probe returns zero and uses
\fBdev_set_drvdata\fR to associate driver-specific data with the
interface.  It may also use \fBusb_set_interface\fR to specify the
appropriate altsetting.  If unwilling to manage the interface,
return a negative errno value.
.TP
\fBdisconnect\fR
Called when the interface is no longer accessible, usually
because its device has been (or is being) disconnected or the
driver module is being unloaded.
.TP
\fBioctl\fR
Used for drivers that want to talk to userspace through
the ``usbfs'' filesystem.  This lets devices provide ways to
expose information to user space regardless of where they
do (or don't) show up otherwise in the filesystem.
.TP
\fBid_table\fR
USB drivers use ID table to support hotplugging.
Export this with MODULE_DEVICE_TABLE(usb,...).  This must be set
or your driver's probe function will never get called. 
.SH "DESCRIPTION"
.PP
USB drivers must provide a name, \fBprobe\fR and \fBdisconnect\fR methods,
and an id_table.  Other driver fields are optional.
.PP
The id_table is used in hotplugging.  It holds a set of descriptors,
and specialized data may be associated with each entry.  That table
is used by both user and kernel mode hotplugging support.
.PP
The \fBprobe\fR and \fBdisconnect\fR methods are called in a context where
they can sleep, but they should avoid abusing the privilege.  Most
work to connect to a device should be done when the device is opened,
and undone at the last close.  The disconnect code needs to address
concurrency issues with respect to \fBopen\fR and \fBclose\fR methods, as
well as forcing all pending I/O requests to complete (by unlinking
them as necessary, and blocking until the unlinks complete).
.SH "ABOUT THIS DOCUMENT"
.PP
This documentation is free software; you can redistribute
it and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later
version.
.PP
This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public
License along with this program; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
MA 02111-1307 USA
.PP
For more details see the file COPYING in the source
distribution of Linux.
.PP
If you have comments on the formatting of this manpage, then please contact
Michael Still (mikal@stillhq.com).
.PP
This documentation was generated with kernel version 2.5.75.