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