usr.sbin/usbd/usbd.8

   1 .\" Copyright (c) 1998 The NetBSD Foundation, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Author: Lennart Augustsson
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"        This product includes software developed by the NetBSD
  17 .\"        Foundation, Inc. and its contributors.
  18 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  19 .\"    contributors may be used to endorse or promote products derived
  20 .\"    from this software without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  23 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  24 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  26 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32 .\" POSSIBILITY OF SUCH DAMAGE.
  33 .\"
  34 .\" $NetBSD: usbd.8,v 1.2 1998/07/13 11:01:50 augustss Exp $
  35 .\" $FreeBSD: src/usr.sbin/usbd/usbd.8,v 1.20 2003/05/04 22:13:00 murray Exp $
  36 .\" $DragonFly: src/usr.sbin/usbd/usbd.8,v 1.3 2003/12/30 01:01:48 dillon Exp $
  37 .\"
  38 .Dd July 12, 1998
  39 .Dt USBD 8
  40 .Os
  41 .Sh NAME
  42 .Nm usbd
  43 .Nd supervise USB attach/detach
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl c Ar configfile
  47 .Op Fl d
  48 .Op Fl e
  49 .Op Fl f Ar device
  50 .Op Fl n
  51 .Op Fl t Ar timeout
  52 .Op Fl v
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility handles USB device attachment and detachment.
  57 It does two things.
  58 Through opening the
  59 .Pa /dev/usb0 ,
  60 .Pa /dev/usb1 ,
  61 etc. devices, it enables the kernel to handle change requests from
  62 attached hubs.
  63 This functionality will be removed when the kernel has
  64 kernel threads.
  65 The (multiple)
  66 .Fl f Ar device
  67 command line options specify which controllers it should handle.
  68 Normally this option is not needed.
  69 .Pp
  70 If the
  71 .Dq usb ,
  72 .Dq ohci
  73 and
  74 .Dq uhci
  75 modules are not loaded,
  76 .Nm
  77 will load them automatically.
  78 .Pp
  79 The second part is the handling of the attachment and detachment of USB
  80 devices.
  81 The device
  82 .Pa /dev/usb
  83 is opened and events are read from it.
  84 Whenever a device is attached or
  85 detached the list of actions read from
  86 .Pa /etc/usbd.conf
  87 is searched for a matching entry.
  88 If found, the corresponding action is
  89 executed.
  90 .Pp
  91 The command line options are as follows:
  92 .Bl -tag -width Ds
  93 .It Fl c Ar filename
  94 Name of configuration file.
  95 The default is
  96 .Pa /etc/usbd.conf .
  97 .It Fl d
  98 Enable debugging to the standard output,
  99 and do not disassociate from the controlling terminal.
 100 .It Fl e
 101 Do one device tree exploration, no event queue handling and then exit.
 102 .It Fl f Ar device
 103 Specify the pathname of a USB controller device file.
 104 The flag may be repeated to watch more than one USB controller.
 105 The default is
 106 .Pa /dev/usb0
 107 through
 108 .Pa /dev/usb3 .
 109 Do not specify the device
 110 .Pa /dev/usb
 111 here.
 112 It is used for events only.
 113 .It Fl n
 114 Do not handle the event queue on /dev/usb.
 115 .It Fl t Ar timeout
 116 Set the timeout interval (in seconds) before an exploration happens
 117 without being triggered by a connect or disconnect.
 118 A timeout of 0 means that there is no timeout.  The default is 30.
 119 .It Fl v
 120 Be verbose.
 121 Repeating the flag makes
 122 .Nm
 123 more verbose.
 124 .El
 125 .Sh FILES
 126 .Bl -tag -width /etc/usbd.conf -compact
 127 .It Pa /etc/usbd.conf
 128 .It Pa /dev/usb
 129 .It Pa /dev/usb0
 130 .It Pa /dev/usb1
 131 .It etc .
 132 .El
 133 .Sh SEE ALSO
 134 .Xr usb 4 ,
 135 .Xr usbd.conf 5
 136 .Sh HISTORY
 137 The
 138 .Nm
 139 utility appeared in
 140 .Nx 1.4 .
 141 .Sh AUTHORS
 142 .An -nosplit
 143 The
 144 .Nm
 145 driver was written by
 146 .An Lennart Augustsson Aq augustss@carlstedt.se
 147 for the
 148 .Nx
 149 project.
 150 The event queue handling in
 151 .Nm
 152 was added by
 153 .An Nick Hibma Aq n_hibma@FreeBSD.org .