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