summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/umass.4 3.html
blob: 89a51751c034b9eeae14fbc9fb6d6b7a34c89122 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<table class="head">
  <tr>
    <td class="head-ltitle">UMASS(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">UMASS(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">umass</code> &#x2014; <span class="Nd">USB Mass
    Storage Devices driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">device da</code>
  <br/>
  <code class="Cd">device scbus</code>
  <br/>
  <code class="Cd">device pass</code>
  <br/>
  <code class="Cd">device usb</code>
  <br/>
  <code class="Cd">device umass</code></p>
<p class="Pp">In <a class="Xr">loader.conf(5)</a>:
  <br/>
  <code class="Cd">umass_load</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">umass</code> driver provides support for Mass
    Storage devices that attach to the USB interface.</p>
<p class="Pp">If the appropriate hardware is detected, the driver will be loaded
    automatically by <a class="Xr">devmatch(8)</a>. To load the driver manually
    at boot time, use the <code class="Cm">umass_load</code> command at the
    <a class="Xr">loader(8)</a> prompt, or add it to
    <a class="Xr">loader.conf(5)</a>.</p>
<p class="Pp">To use the driver in a custom kernel, <a class="Xr">usb(4)</a> and
    at least one of <a class="Xr">uhci(4)</a>, <a class="Xr">ohci(4)</a>,
    <a class="Xr">ehci(4)</a>, or <a class="Xr">xhci(4)</a> must be configured
    in the kernel. Additionally, since <code class="Nm">umass</code> uses the
    SCSI subsystem and sometimes acts as a SCSI device, it requires
    <a class="Xr">da(4)</a> and <a class="Xr">scbus(4)</a> to be included in the
    kernel.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">umass</code> driver supports USB Mass Storage
    devices such as:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
  <li>USB thumb drives</li>
  <li>USB hard disk drives</li>
  <li>USB floppy drives</li>
</ul>
<p class="Pp" id="USB">The <code class="Nm">umass</code> driver tries its best
    to avoid issues with the drives, not all issues can be handled
    automatically, so quirks may be necessary. See the
    <a class="permalink" href="#USB"><i class="Em">USB Mass Sotrage
    quirks</i></a> section of <a class="Xr">usb_quirk(4)</a> for quirks for the
    drives. The <code class="Cd">add_dev_quirk_vplh</code> and
    <code class="Cd">add_quirk</code> commands of <a class="Xr">usbconfig(8)</a>
    can manage these dynamically. Quirks can be specified via tuables, as
    described in <a class="Xr">usb_quirk(4)</a>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
<p class="Pp">Rescan all slots on a multi-slot flash reader, where the slots map
    to separate LUNs on a single SCSI ID:</p>
<div class="Bd Pp Bd-indent Li">
<pre>camcontrol rescan 0:0:0
camcontrol rescan 0:0:1
camcontrol rescan 0:0:2
camcontrol rescan 0:0:3</pre>
</div>
<p class="Pp">Typically only the first slot will be enabled at boot time. This
    assumes that the flash reader is the first SCSI bus in the system and has 4
    slots.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">cfumass(4)</a>, <a class="Xr">ehci(4)</a>,
    <a class="Xr">ohci(4)</a>, <a class="Xr">uhci(4)</a>,
    <a class="Xr">usb(4)</a>, <a class="Xr">usb_quirk(4)</a>,
    <a class="Xr">xhci(4)</a>, <a class="Xr">camcontrol(8)</a>,
    <a class="Xr">usbconfig(8)</a>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">umass</code> driver appeared in
    <span class="Ux">FreeBSD 4.3</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">umass</code> driver was written by
    <span class="An">MAEKAWA Masahide</span>
    &lt;<a class="Mt" href="mailto:bishop@rr.iij4u.or.jp">bishop@rr.iij4u.or.jp</a>&gt;
    and <span class="An">Nick Hibma</span>
    &lt;<a class="Mt" href="mailto:n_hibma@FreeBSD.org">n_hibma@FreeBSD.org</a>&gt;.</p>
<p class="Pp">This manual page was written by <span class="An">Nick Hibma</span>
    &lt;<a class="Mt" href="mailto:n_hibma@FreeBSD.org">n_hibma@FreeBSD.org</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">November 28, 2025</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>