xref: /freebsd/share/man/man4/umass.4 (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
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.Dd January 27, 2020
26.Dt UMASS 4
27.Os
28.Sh NAME
29.Nm umass
30.Nd USB Mass Storage Devices driver
31.Sh SYNOPSIS
32To compile this driver into the kernel,
33place the following line in your
34kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device scbus"
37.Cd "device usb"
38.Cd "device umass"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45umass_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver provides support for Mass Storage devices that attach to the USB
51port.
52.Pp
53To use the
54.Nm
55driver,
56.Xr usb 4
57and one of
58.Xr uhci 4
59or
60.Xr ohci 4
61or
62.Xr ehci 4
63or
64.Xr xhci 4
65must be configured in the kernel.
66Additionally, since
67.Nm
68uses the SCSI subsystem and sometimes acts as a SCSI device, it
69requires
70.Xr da 4
71and
72.Xr scbus 4
73to be included in the kernel.
74.Sh EXAMPLES
75.Bd -literal -offset indent
76device umass
77device scbus
78device da
79device pass
80.Ed
81.Pp
82Add the
83.Nm
84driver to the kernel.
85.Bd -literal -offset indent
86camcontrol rescan 0:0:0
87camcontrol rescan 0:0:1
88camcontrol rescan 0:0:2
89camcontrol rescan 0:0:3
90.Ed
91.Pp
92Rescan all slots on a multi-slot flash reader, where the slots map to separate
93LUNs on a single SCSI ID.
94Typically only the first slot will be enabled at boot time.
95This assumes that the flash reader is the first SCSI bus in the system and has 4 slots.
96.Sh SEE ALSO
97.Xr cfumass 4 ,
98.Xr ehci 4 ,
99.Xr ohci 4 ,
100.Xr uhci 4 ,
101.Xr usb 4 ,
102.Xr xhci 4 ,
103.Xr camcontrol 8
104.\".Sh HISTORY
105.Sh AUTHORS
106.An -nosplit
107The
108.Nm
109driver was written by
110.An MAEKAWA Masahide Aq Mt bishop@rr.iij4u.or.jp
111and
112.An Nick Hibma Aq Mt n_hibma@FreeBSD.org .
113.Pp
114This manual page was written by
115.An Nick Hibma Aq Mt n_hibma@FreeBSD.org .
116