xref: /freebsd/share/man/man4/umass.4 (revision c0b9f4fe659b6839541970eb5675e57f4d814969) 
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.\" 3. Neither the name of the author nor the names of any co-contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"   without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY NICK HIBMA 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 NICK HIBMA OR THE VOICES IN HIS HEAD
20.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
26.\" THE POSSIBILITY OF SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd December 17, 2004
31.Dt UMASS 4
32.Os
33.Sh NAME
34.Nm umass
35.Nd USB Mass Storage Devices driver
36.Sh SYNOPSIS
37.Cd "device umass"
38.Sh DESCRIPTION
39The
40.Nm
41driver provides support for Mass Storage devices that attach to the USB
42port.
43.Pp
44To use the
45.Nm
46driver,
47.Xr usb 4
48and one of
49.Xr uhci 4
50or
51.Xr ohci 4
52must be configured in the kernel.
53Additionally, since
54.Nm
55uses the SCSI subsystem and sometimes acts as a SCSI device, it
56requires
57.Xr da 4
58and
59.Xr scbus 4
60to be included in the kernel.
61.Sh HARDWARE
62The
63.Nm
64driver supports USB Mass Storage devices, including:
65.Pp
66.Bl -bullet -compact
67.It
68ADTEC Stick Drive AD-UST32M, 64M, 128M, 256M
69.It
70Denno FireWire/USB2 Removable 2.5-inch HDD Case MIFU-25CB20
71.It
72FujiFilm Zip USB Drive ZDR100 USB A
73.It
74GREEN HOUSE USB Flash Memory "PicoDrive" GH-UFD32M, 64M, 128M
75.It
76IBM 32MB USB Memory Key (P/N 22P5296)
77.It
78IBM 256MB USB Drive (MSYSTEM DiskOnKey2)
79.It
80IBM ThinkPad USB Portable CD-ROM Drive (P/N 33L5151)
81.It
82I-O DATA USB CD/CD-R/CD-RW/DVD-R/DVD-RW/DVD-RAM/DVD-ROM Drive DVR-iUH2 (CDROM, DVD-RAM only)
83.It
84I-O DATA USB x6 CD-RW Drive CDRW-i64/USB (CDROM only)
85.It
86I-O DATA USB/IEEE1394 Portable HD Drive HDP-i30P/CI, HDP-i40P/CI
87.It
88Iomega USB Zip 100/250 drive
89.It
90Iomega Zip750 USB2.0 drive
91.It
92Keian USB1.1/2.0 3.5-inch HDD Case KU350A
93.It
94Kurouto Shikou USB 2.5-inch HDD Case GAWAP2.5PS-USB2.0
95.It
96LaCie P3 HardDrive USB 200GB
97.It
98Logitec LDR-H443U2 DVD-RAM/-R/+R/-RW/+RW drive
99.It
100Logitec Mobile USB Memory LMC-256UD
101.It
102Logitec USB1.1/2.0 HDD Unit SHD-E60U2
103.It
104Logitec USB Double-Speed Floppy Drive LFD-31U2
105.It
106Logitec USB/IEEE1394 DVD-RAM/R/RW Unit LDR-N21FU2 (CDROM only)
107.It
108MELCO USB Flash Disk "ClipDrive", RUF-C32M, -C64M, -C128M, -C256M, -C512M
109.It
110MELCO USB Flash Disk "PetitDrive", RUF-32M, -64M, -128M, -256Mm
111.It
112MELCO USB2.0 Flash Disk "PetitDrive2", RUF-256M/U2, -512M/U2
113.It
114MELCO USB2.0 MO Drive MO-CH640U2
115.It
116Matshita CF-VFDU03 floppy drive
117.It
118Microtech International, Inc.\& USB-SCSI-HD 50 USB to SCSI cable
119.It
120Motorola E398 Mobile Phone (TransFlash memory card)
121.It
122NOVAC USB2.0 2.5/3.5-inch HDD Case NV-HD351U
123.It
124PNY Attache Flash Drive
125.It
126Panasonic ("Matshita FDD CF-VFDU03")
127.It
128Panasonic KXL-CB20AN Portable DVD-ROM/CD-R/RW
129.It
130Panasonic KXL-CB35AN (DVD-ROM & CD-R/RW)
131.It
132Panasonic USB2.0 Portable CD-RW Drive KXL-RW40AN (CDROM only)
133.It
134Panasonic floppy drive
135.It
136RATOC Systems USB2.0 Removable HDD Case U2-MDK1, U2-MDK1B
137.It
138SanDisk SDDR-31 (Compact Flash)
139.It
140SanDisk SDDR-75 (only Compact Flash port works)
141.It
142Sitecom CN-300 MultiFlash (MMC/SD, SmartMedia, CF, MemoryStick)
143.It
144Sony Portable CD-R/RW Drive CRX10U (CDROM only)
145.It
146TEAC Portable USB CD-ROM Unit CD-110PU/210PU
147.It
148Trek Thumbdrive 8MB
149.It
150VAIO floppy drive (includes Y-E Data Flashbuster-U)
151.It
152Y-E Data floppy drive (720/1.44/2.88Mb)
153.El
154.Pp
155Among the supported digital cameras are:
156.Pp
157.Bl -bullet -compact
158.It
159Asahi Optical (PENTAX) Optio 230 & 330
160.El
161.Sh EXAMPLES
162.Bd -literal -offset indent
163device umass
164device scbus
165device da
166device pass
167.Ed
168.Pp
169Add the
170.Nm
171driver to the kernel.
172.Pp
173.Dl "camcontrol rescan 0"
174.Pp
175Rescan a Zip drive that was added after boot.
176The command above
177assumes that the Zip drive is on the first SCSI bus in the system.
178.Bd -literal -offset indent
179camcontrol rescan 0:0:0
180camcontrol rescan 0:0:1
181camcontrol rescan 0:0:2
182camcontrol rescan 0:0:3
183.Ed
184.Pp
185Rescan all slots on a multi-slot flash reader, where the slots map to separate
186LUNs on a single SCSI ID.
187Typically only the first slot will be enabled at boot time.
188Again, this assumes that the flash reader is the first SCSI bus in the system.
189.Bd -literal -offset indent
190bsdlabel -w da0 zip100
191newfs da0c
192mount -t ufs /dev/da0c /mnt
193.Ed
194.Pp
195Write a disklabel to the Zip drive (see
196.Xr vpo 4
197for the
198.Xr disktab 5
199entry), creates the file system and mounts the new file system on /mnt.
200.Pp
201.Dl "newfs_msdos /dev/da0"
202.Pp
203Create a new FAT type file system.
204Care should be taken not to run
205.Xr newfs 8
206on devices that already contain data, as this will result in the
207information being lost.
208.Pp
209Many consumer devices such as digital cameras automatically create
210.Tn MS-DOS
211based file systems when storing information such as images and
212videos.
213These file systems can be accessed by specifying the file system
214type as
215.Cm msdos
216when using
217.Xr mount 8 .
218.Sh SEE ALSO
219.Xr ehci 4 ,
220.Xr ohci 4 ,
221.Xr uhci 4 ,
222.Xr usb 4 ,
223.Xr vpo 4 ,
224.Xr disktab 5 ,
225.Xr bsdlabel 8 ,
226.Xr camcontrol 8
227.\".Sh HISTORY
228.Sh AUTHORS
229.An -nosplit
230The
231.Nm
232driver was written by
233.An MAEKAWA Masahide Aq bishop@rr.iij4u.or.jp
234and
235.An Nick Hibma Aq n_hibma@FreeBSD.org .
236.Pp
237This manual page was written by
238.An Nick Hibma Aq n_hibma@FreeBSD.org .
239