share/man/man4/umass.4

   1 .\" Copyright (c) 1999
   2 .\"     Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 27, 2020
  28 .Dt UMASS 4
  29 .Os
  30 .Sh NAME
  31 .Nm umass
  32 .Nd USB Mass Storage Devices driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following line in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device scbus"
  39 .Cd "device usb"
  40 .Cd "device umass"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 umass_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver provides support for Mass Storage devices that attach to the USB
  53 port.
  54 .Pp
  55 To use the
  56 .Nm
  57 driver,
  58 .Xr usb 4
  59 and one of
  60 .Xr uhci 4
  61 or
  62 .Xr ohci 4
  63 or
  64 .Xr ehci 4
  65 or
  66 .Xr xhci 4
  67 must be configured in the kernel.
  68 Additionally, since
  69 .Nm
  70 uses the SCSI subsystem and sometimes acts as a SCSI device, it
  71 requires
  72 .Xr da 4
  73 and
  74 .Xr scbus 4
  75 to be included in the kernel.
  76 .Sh EXAMPLES
  77 .Bd -literal -offset indent
  78 device umass
  79 device scbus
  80 device da
  81 device pass
  82 .Ed
  83 .Pp
  84 Add the
  85 .Nm
  86 driver to the kernel.
  87 .Pp
  88 .Bd -literal -offset indent
  89 camcontrol rescan 0:0:0
  90 camcontrol rescan 0:0:1
  91 camcontrol rescan 0:0:2
  92 camcontrol rescan 0:0:3
  93 .Ed
  94 .Pp
  95 Rescan all slots on a multi-slot flash reader, where the slots map to separate
  96 LUNs on a single SCSI ID.
  97 Typically only the first slot will be enabled at boot time.
  98 This assumes that the flash reader is the first SCSI bus in the system and has 4 slots.
  99 .Sh SEE ALSO
 100 .Xr cfumass 4 ,
 101 .Xr ehci 4 ,
 102 .Xr ohci 4 ,
 103 .Xr uhci 4 ,
 104 .Xr usb 4 ,
 105 .Xr xhci 4 ,
 106 .Xr camcontrol 8
 107 .\".Sh HISTORY
 108 .Sh AUTHORS
 109 .An -nosplit
 110 The
 111 .Nm
 112 driver was written by
 113 .An MAEKAWA Masahide Aq Mt bishop@rr.iij4u.or.jp
 114 and
 115 .An Nick Hibma Aq Mt n_hibma@FreeBSD.org .
 116 .Pp
 117 This manual page was written by
 118 .An Nick Hibma Aq Mt n_hibma@FreeBSD.org .