usbmodules(8) [redhat man page]

usbmodules(8)							Linux USB Utilities						     usbmodules(8)

NAME

       usbmodules - List kernel driver modules available for a plugged in USB device

SYNOPSIS

       usbmodules [--device /proc/bus/bus/NNN/NNN] [--check modulename] [--help] [--mapfile pathname] [--version pathname]

DESCRIPTION

       usbmodules  lists  driver  modules  that  may  be able to manage interfaces on currently plugged in USB devices.  usbmodules may be used by
       /sbin/hotplug or one of its agents (normally /etc/hotplug/usb.agent) when USB devices are "hot plugged" into the system.  This can be  done
       by the following Bourne shell syntax:

		   for module in $(usbmodules --device $DEVICE) ; do

			modprobe -s -k "$module"

		   done

       The DEVICE environment variable is passed from the kernel to /sbin/hotplug during USB hotplugging if the kernel was configured using usbde-
       vfs.  usbmodules currently requires usbdevfs to operate.

       When a USB device is removed from the system, the Linux kernel will decrement a usage count on USB driver module.  If this count  drops	to
       zero  (i.e.,  there  are  no  clients for the USB device driver), then the modprobe -r process that is normally configured to run from cron
       every few minutes will eventually remove the unneeded module.

OPTIONS

       --check modulename
	      Instead of listing the relevant modules, just exit with code 0 (success) if the given module's exported  USB  ID	patterns  matches.
	      Otherwise, return failure.  usbmodules emits no output either way.

       --device /proc/bus/usb/MMM/NNN
	      Selects which device usbmodules will examine.  The argument is currently mandatory.

       --help, -h
	      Print a help message

       --mapfile /etc/hotplug/usb.handmap
	      Use the specified file instead of the /lib/modules/.../modules.usbmap file corresponding to the running kernel.

       --version
	      Identifies the version of usbutils this tool was built with.

FILES

       /lib/modules/<kernel-version>/modules.usbmap
	      This  file is automatically generated by depmod, versions 2.4.2 and later, and is used by usbmodules to determine which modules cor-
	      respond to which USB ID's.

       /proc/bus/usb
	      An optional interface to USB devices provided by Linux kernels with versions of the 2.4 USB support. Contains per-bus subdirectories
	      with  per-device	files  (offering  a usermode driver API as well as access to device and configuration descriptors), a devices file
	      containing a list of all USB devices, and a drivers file listing USB device drivers known to the USB subsystem.

SEE ALSO

       lsusb(8), http://linux-hotplug.sourceforge.net

AUTHOR

       usbmodules was written by Adam J. Richter <adam@yggdrasil.com>, and  is	based  partly  on  lsusb,  which  was  written	by  Thomas  Sailer
       <sailer@ife.ee.ethz.ch>.

COPYRIGHT

       usbmodules is copyright 2000, Yggdrasil Computing, Incorporated, and copyright 1999, Thomas Sailer.  usbmodules may may be copied under the
       terms and conditions of version 2 of the GNU General Public License as published by the Free Software Foundation (Cambrige,  Massachusetts,
       United States of America).

usbutils-0.8							   12 June 2001 						     usbmodules(8)

USB(4)							   BSD Kernel Interfaces Manual 						    USB(4)

NAME

     usb -- Universal Serial Bus

SYNOPSIS

     To compile this driver into the kernel, place the following line in your kernel configuration file:

	   device usb

     Alternatively, to load the driver as a module at boot time, place the following line in loader.conf(5):

	   usb_load="YES"

USERLAND PROGRAMMING

     USB functions can be accessed from userland through the libusb library.  See libusb(3) for more information.

DESCRIPTION

     FreeBSD provides machine-independent bus support and drivers for USB devices in host and device side mode.

     The usb driver has three layers:

     USB Controller (Bus)

     USB Device

     USB Driver

     The controller attaches to a physical bus like pci(4).  The USB bus attaches to the controller, and the root hub attaches to the controller.
     Any devices attached to the bus will attach to the root hub or another hub attached to the USB bus.

     The uhub device will always be present as it is needed for the root hub.

INTRODUCTION TO USB

     The USB is a system where external devices can be connected to a PC.  The most common USB speeds are:

     Low Speed (1.5MBit/sec)

     Full Speed (12MBit/sec)

     High Speed (480MBit/sec)

     Each USB has a USB controller that is the master of the bus.  The physical communication is simplex which means the host controller only com-
     municates with one USB device at a time.

     There can be up to 127 devices connected to an USB HUB tree.  The addresses are assigned dynamically by the host when each device is attached
     to the bus.

     Within each device there can be up to 16 endpoints.  Each endpoint is individually addressed and the addresses are static.  Each of these
     endpoints will communicate in one of four different modes: control, isochronous, bulk, or interrupt.  A device always has at least one end-
     point.  This endpoint has address 0 and is a control endpoint and is used to give commands to and extract basic data, such as descriptors,
     from the device.  Each endpoint, except the control endpoint, is unidirectional.

     The endpoints in a device are grouped into interfaces.  An interface is a logical unit within a device; e.g. a compound device with both a
     keyboard and a trackball would present one interface for each.  An interface can sometimes be set into different modes, called alternate set-
     tings, which affects how it operates.  Different alternate settings can have different endpoints within it.

     A device may operate in different configurations.	Depending on the configuration, the device may present different sets of endpoints and
     interfaces.

     The bus enumeration of the USB bus proceeds in several steps:

     1.   Any interface specific driver can attach to the device.

     2.   If none is found, generic interface class drivers can attach.

SEE ALSO

     The USB specifications can be found at:

	   http://www.usb.org/developers/docs/

     libusb(3), usbdi(4), aue(4), axe(4), cue(4), ehci(4), kue(4), ohci(4), pci(4), rue(4), ucom(4), udav(4), uhci(4), uhid(4), ukbd(4), ulpt(4),
     umass(4), ums(4), uplcom(4), urio(4), uvscom(4), usbconfig(8)

STANDARDS

     The usb module complies with the USB 2.0 standard.

HISTORY

     The usb module has been inspired by the NetBSD USB stack initially written by Lennart Augustsson. The usb module was written by Hans Petter
     Selasky <hselasky@freebsd.org>.

BSD
								   May 20, 2009 							       BSD