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