share/man/man4/usfs.4

   1 .\"
   2 .\" Copyright (c) 2014 Hans Petter Selasky
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd May 17, 2018
  27 .Dt USFS 4
  28 .Os
  29 .Sh NAME
  30 .Nm usfs
  31 .Nd USB device side support for bulk only transport mass storage
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device usb"
  38 .Cd "device usfs"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 usfs_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 .Bf -symbolic
  49 This driver is obsolete.
  50 Users are advised to use
  51 .Xr cfumass 4
  52 instead.
  53 .Ef
  54 .Pp
  55 The
  56 .Nm
  57 driver provides support for emulating an USB mass storage device when
  58 the USB stack is activated in USB device side mode (the
  59 .Xr usb_template 4
  60 module is loaded and the
  61 .Va hw.usb.template
  62 sysctl is set to 0).
  63 .Pp
  64 Upon attach the driver creates a RAM disk which can be read and written.
  65 .Sh SEE ALSO
  66 .Xr cfumass 4 ,
  67 .Xr umass 4 ,
  68 .Xr usb 4 ,
  69 .Xr usb_template 4
  70 .Sh HISTORY
  71 The
  72 .Nm
  73 driver appeared in
  74 .Fx 8.0 .