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