xref: /freebsd-src/share/man/man4/usfs.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
162b91c73SHans Petter Selasky.\"
262b91c73SHans Petter Selasky.\" Copyright (c) 2014 Hans Petter Selasky
362b91c73SHans Petter Selasky.\" All rights reserved.
462b91c73SHans Petter Selasky.\"
562b91c73SHans Petter Selasky.\" Redistribution and use in source and binary forms, with or without
662b91c73SHans Petter Selasky.\" modification, are permitted provided that the following conditions
762b91c73SHans Petter Selasky.\" are met:
862b91c73SHans Petter Selasky.\" 1. Redistributions of source code must retain the above copyright
962b91c73SHans Petter Selasky.\"    notice, this list of conditions and the following disclaimer.
1062b91c73SHans Petter Selasky.\" 2. Redistributions in binary form must reproduce the above copyright
1162b91c73SHans Petter Selasky.\"    notice, this list of conditions and the following disclaimer in the
1262b91c73SHans Petter Selasky.\"    documentation and/or other materials provided with the distribution.
1362b91c73SHans Petter Selasky.\"
14f1261466SEd Maste.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15f1261466SEd Maste.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16f1261466SEd Maste.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17f1261466SEd Maste.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18f1261466SEd Maste.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19f1261466SEd Maste.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20f1261466SEd Maste.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21f1261466SEd Maste.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22f1261466SEd Maste.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23f1261466SEd Maste.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24f1261466SEd Maste.\" SUCH DAMAGE.
2562b91c73SHans Petter Selasky.\"
26*97e77ae9SEdward Tomasz Napierala.Dd May 17, 2018
2762b91c73SHans Petter Selasky.Dt USFS 4
2862b91c73SHans Petter Selasky.Os
2962b91c73SHans Petter Selasky.Sh NAME
3062b91c73SHans Petter Selasky.Nm usfs
3162b91c73SHans Petter Selasky.Nd USB device side support for bulk only transport mass storage
3262b91c73SHans Petter Selasky.Sh SYNOPSIS
3362b91c73SHans Petter SelaskyTo compile this driver into the kernel,
3462b91c73SHans Petter Selaskyplace the following lines in your
3562b91c73SHans Petter Selaskykernel configuration file:
3662b91c73SHans Petter Selasky.Bd -ragged -offset indent
3762b91c73SHans Petter Selasky.Cd "device usb"
3862b91c73SHans Petter Selasky.Cd "device usfs"
3962b91c73SHans Petter Selasky.Ed
4062b91c73SHans Petter Selasky.Pp
4162b91c73SHans Petter SelaskyAlternatively, to load the driver as a
4262b91c73SHans Petter Selaskymodule at boot time, place the following line in
4362b91c73SHans Petter Selasky.Xr loader.conf 5 :
4462b91c73SHans Petter Selasky.Bd -literal -offset indent
4562b91c73SHans Petter Selaskyusfs_load="YES"
4662b91c73SHans Petter Selasky.Ed
4762b91c73SHans Petter Selasky.Sh DESCRIPTION
48*97e77ae9SEdward Tomasz Napierala.Bf -symbolic
49*97e77ae9SEdward Tomasz NapieralaThis driver is obsolete.
50*97e77ae9SEdward Tomasz NapieralaUsers are advised to use
51*97e77ae9SEdward Tomasz Napierala.Xr cfumass 4
52*97e77ae9SEdward Tomasz Napieralainstead.
53*97e77ae9SEdward Tomasz Napierala.Ef
54*97e77ae9SEdward Tomasz Napierala.Pp
5562b91c73SHans Petter SelaskyThe
5662b91c73SHans Petter Selasky.Nm
5762b91c73SHans Petter Selaskydriver provides support for emulating an USB mass storage device when
585c785643SEdward Tomasz Napieralathe USB stack is activated in USB device side mode (the
595c785643SEdward Tomasz Napierala.Xr usb_template 4
605c785643SEdward Tomasz Napieralamodule is loaded and the
615c785643SEdward Tomasz Napierala.Va hw.usb.template
625c785643SEdward Tomasz Napieralasysctl is set to 0).
6362b91c73SHans Petter Selasky.Pp
6462b91c73SHans Petter SelaskyUpon attach the driver creates a RAM disk which can be read and written.
6562b91c73SHans Petter Selasky.Sh SEE ALSO
66cc5bbcb2SEdward Tomasz Napierala.Xr cfumass 4 ,
670b3504fdSChristian Brueffer.Xr umass 4 ,
685c785643SEdward Tomasz Napierala.Xr usb 4 ,
695c785643SEdward Tomasz Napierala.Xr usb_template 4
7062b91c73SHans Petter Selasky.Sh HISTORY
7162b91c73SHans Petter SelaskyThe
7262b91c73SHans Petter Selasky.Nm
739e9a6101SAlan Somersdriver appeared in
749e9a6101SAlan Somers.Fx 8.0 .
75