xref: /freebsd/share/man/man4/usfs.4 (revision cbd30a72ca196976c1c700400ecd424baa1b9c16)
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.\" $FreeBSD$
27.\"
28.Dd June 8, 2016
29.Dt USFS 4
30.Os
31.Sh NAME
32.Nm usfs
33.Nd USB device side support for bulk only transport mass storage
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device usb"
40.Cd "device usfs"
41.Ed
42.Pp
43Alternatively, to load the driver as a
44module at boot time, place the following line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47usfs_load="YES"
48.Ed
49.Sh DESCRIPTION
50The
51.Nm
52driver provides support for emulating an USB mass storage device when
53the USB stack is activated in USB device side mode (the
54.Xr usb_template 4
55module is loaded and the
56.Va hw.usb.template
57sysctl is set to 0).
58.Pp
59Upon attach the driver creates a RAM disk which can be read and written.
60.Sh SEE ALSO
61.Xr cfumass 4 ,
62.Xr umass 4 ,
63.Xr usb 4 ,
64.Xr usb_template 4
65.Sh HISTORY
66The
67.Nm
68driver appeared in FreeBSD 8.
69