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