share/man/man4/umass.4

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