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