xref: /dragonfly/share/man/man4/umass.4 (revision 6e5c5008)
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: head/share/man/man4/umass.4 230656 2012-01-28 21:21:05Z scf $
26.\"
27.Dd March 11, 2014
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
63must be configured in the kernel.
64Additionally, since
65.Nm
66uses the SCSI subsystem and sometimes acts as a SCSI device, it
67requires
68.Xr da 4
69and
70.Xr scbus 4
71to be included in the kernel.
72.Sh HARDWARE
73The
74.Nm
75driver supports USB Mass Storage devices, including:
76.Pp
77.Bl -bullet -compact
78.It
79ADTEC Stick Drive AD-UST32M, 64M, 128M, 256M
80.It
81Denno FireWire/USB2 Removable 2.5-inch HDD Case MIFU-25CB20
82.It
83FujiFilm Zip USB Drive ZDR100 USB A
84.It
85GREEN HOUSE USB Flash Memory "PicoDrive" GH-UFD32M, 64M, 128M
86.It
87Huawei Mobile (SD slot)
88.It
89IBM 32MB USB Memory Key (P/N 22P5296)
90.It
91IBM 256MB USB Drive (MSYSTEM DiskOnKey2)
92.It
93IBM ThinkPad USB Portable CD-ROM Drive (P/N 33L5151)
94.It
95I-O DATA USB CD/CD-R/CD-RW/DVD-R/DVD-RW/DVD-RAM/DVD-ROM Drive DVR-iUH2 (CDROM, DVD-RAM only)
96.It
97I-O DATA USB x6 CD-RW Drive CDRW-i64/USB (CDROM only)
98.It
99I-O DATA USB/IEEE1394 Portable HD Drive HDP-i30P/CI, HDP-i40P/CI
100.It
101Iomega USB Zip 100/250 drive
102.It
103Iomega Zip750 USB2.0 drive
104.It
105Keian USB1.1/2.0 3.5-inch HDD Case KU350A
106.It
107Kurouto Shikou USB 2.5-inch HDD Case GAWAP2.5PS-USB2.0
108.It
109LaCie P3 HardDrive USB 200GB
110.It
111Logitec LDR-H443U2 DVD-RAM/-R/+R/-RW/+RW drive
112.It
113Logitec Mobile USB Memory LMC-256UD
114.It
115Logitec USB1.1/2.0 HDD Unit SHD-E60U2
116.It
117Logitec USB Double-Speed Floppy Drive LFD-31U2
118.It
119Logitec USB/IEEE1394 DVD-RAM/R/RW Unit LDR-N21FU2 (CDROM only)
120.It
121MELCO USB Flash Disk "ClipDrive", RUF-C32M, -C64M, -C128M, -C256M, -C512M
122.It
123MELCO USB Flash Disk "PetitDrive", RUF-32M, -64M, -128M, -256Mm
124.It
125MELCO USB2.0 Flash Disk "PetitDrive2", RUF-256M/U2, -512M/U2
126.It
127MELCO USB2.0 MO Drive MO-CH640U2
128.It
129Matshita CF-VFDU03 floppy drive
130.It
131Merlin SM300 MP3/WMA Player (256Mb)
132.It
133Microtech International, Inc.\& USB-SCSI-HD 50 USB to SCSI cable
134.It
135Motorola E398 Mobile Phone (TransFlash memory card)
136.It
137NOVAC USB2.0 2.5/3.5-inch HDD Case NV-HD351U
138.It
139PNY Attache Flash Drive
140.It
141Panasonic ("Matshita FDD CF-VFDU03")
142.It
143Panasonic KXL-CB20AN Portable DVD-ROM/CD-R/RW
144.It
145Panasonic KXL-CB35AN (DVD-ROM & CD-R/RW)
146.It
147Panasonic USB2.0 Portable CD-RW Drive KXL-RW40AN (CDROM only)
148.It
149Panasonic floppy drive
150.It
151Qware BeatZkey!\& Pro
152.It
153RATOC Systems USB2.0 Removable HDD Case U2-MDK1, U2-MDK1B
154.It
155SanDisk SDDR-31 (Compact Flash)
156.It
157SanDisk SDDR-75 (only Compact Flash port works)
158.It
159Sitecom CN-300 MultiFlash (MMC/SD, SmartMedia, CF, MemoryStick)
160.It
161Sony Portable CD-R/RW Drive CRX10U (CDROM only)
162.It
163TEAC Portable USB CD-ROM Unit CD-110PU/210PU
164.It
165Time DPA20B MP3 Player (1Gb)
166.It
167Trek Thumbdrive 8MB
168.It
169VAIO floppy drive (includes Y-E Data Flashbuster-U)
170.It
171Y-E Data floppy drive (720/1.44/2.88Mb)
172.El
173.Pp
174Among the supported digital cameras are:
175.Pp
176.Bl -bullet -compact
177.It
178Asahi Optical (PENTAX) Optio 230 & 330
179.El
180.Sh EXAMPLES
181.Bd -literal -offset indent
182device umass
183device scbus
184device da
185device pass
186.Ed
187.Pp
188Add the
189.Nm
190driver to the kernel.
191.Pp
192.Dl "camcontrol rescan 0"
193.Pp
194Rescan a Zip drive that was added after boot.
195The command above
196assumes that the Zip drive is on the first SCSI bus in the system.
197.Bd -literal -offset indent
198camcontrol rescan 0:0:0
199camcontrol rescan 0:0:1
200camcontrol rescan 0:0:2
201camcontrol rescan 0:0:3
202.Ed
203.Pp
204Rescan all slots on a multi-slot flash reader, where the slots map to separate
205LUNs on a single SCSI ID.
206Typically only the first slot will be enabled at boot time.
207Again, this assumes that the flash reader is the first SCSI bus in the system.
208.Bd -literal -offset indent
209disklabel -w -r da0s0 zip100
210newfs da0s0c
211mount -t ufs /dev/da0s0c /mnt
212.Ed
213.Pp
214Write a disklabel to the Zip drive (see
215.Xr vpo 4
216for the
217.Xr disktab 5
218entry), creates the file system and mounts the new file system on /mnt.
219.Pp
220.Dl "newfs_msdos /dev/da0"
221.Pp
222Create a new FAT type file system.
223Care should be taken not to run
224.Xr newfs 8
225on devices that already contain data, as this will result in the
226information being lost.
227.Pp
228Many consumer devices such as digital cameras automatically create
229.Tn MS-DOS
230based file systems when storing information such as images and
231videos.
232These file systems can be accessed by specifying the file system
233type as
234.Cm msdos
235when using
236.Xr mount 8 .
237.Sh SEE ALSO
238.Xr ehci 4 ,
239.Xr ohci 4 ,
240.Xr uhci 4 ,
241.Xr usb 4 ,
242.Xr vpo 4 ,
243.Xr disktab 5 ,
244.Xr camcontrol 8 ,
245.Xr disklabel 8
246.\".Sh HISTORY
247.Sh AUTHORS
248.An -nosplit
249The
250.Nm
251driver was written by
252.An MAEKAWA Masahide Aq Mt bishop@rr.iij4u.or.jp
253and
254.An Nick Hibma Aq Mt n_hibma@FreeBSD.org .
255.Pp
256This manual page was written by
257.An Nick Hibma Aq Mt n_hibma@FreeBSD.org .
258