d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation for usfs(4) and usb_template(4).

Browse Source 
Reviewed by:	hselasky (earlier version)
MFC after:	1 month
Differential Revision:	https://reviews.freebsd.org/D6740
This commit is contained in:
trasz 2016-06-08 07:39:55 +00:00
parent ef1223ed0d
commit caa02adc0d
2 changed files with 32 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
share/man/man4/usb_template.4
View File

@ -23,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd March 18, 2014
.Dd June 8, 2016
.Dt USB_TEMPLATE 4
.Os
.
@ -32,7 +32,7 @@
.
.Nm usb_template
.
.Nd "USB templates"
.Nd "USB device side templates"
.
.
.Sh SYNOPSIS
@ -59,19 +59,33 @@ configuration descriptors, one or more USB interface descriptors, one
or more USB endpoint descriptors, USB strings and additional USB
descriptors.
.
The USB template module currently has templates for USB Mass Storage,
USB CDC Ethernet and Message Transfer Protocol.
USB templates are selected using the
.Va hw.usb.template
sysctl and tunable.
.
USB templates are currently selected using the "hw.usb.template"
sysctl.
.
The "hw.usb.template" value can be changed at any time, but will not
The
.Va hw.usb.template
value can be changed at any time, but will not
have any effect until the USB device has been re-enumerated.
.
.
Available templates are:
.Bl -column -offset 3n "Value"
.It Em Value Ta Em Description
.It Dv 0 Ta USB Mass Storage
.It Dv 1 Ta CDC Ethernet
.It Dv 2 Ta Media Transfer Protocol (MTP)
.It Dv 3 Ta USB serial port
.It Dv 4 Ta USB audio
.It Dv 5 Ta USB keyboard
.It Dv 6 Ta USB mouse
.It Dv 7 Ta USB phone
.It Dv 8 Ta CDC Ethernet and serial port
.It Dv 9 Ta USB MIDI
.El
.
.Sh SEE ALSO
.Xr usb 4
.Xr usb 4 ,
.Xr usfs 4
.Sh STANDARDS
The
.Nm

11
share/man/man4/usfs.4
View File

@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd March 18, 2014
.Dd June 8, 2016
.Dt USFS 4
.Os
.Sh NAME
@ -50,12 +50,17 @@ usfs_load="YES"
The
.Nm
driver provides support for emulating an USB mass storage device when
the USB stack is activated in USB device side mode.
the USB stack is activated in USB device side mode (the
.Xr usb_template 4
module is loaded and the
.Va hw.usb.template
sysctl is set to 0).
.Pp
Upon attach the driver creates a RAM disk which can be read and written.
.Sh SEE ALSO
.Xr umass 4 ,
.Xr usb 4
.Xr usb 4 ,
.Xr usb_template 4
.Sh HISTORY
The
.Nm