cdd5258afb
for USB OTG-capable hardware to implement device side of USB Mass Storage, ie pretend it's a flash drive. It's configured in the same way as other CTL frontends, using ctladm(8) or ctld(8). Differently from usfs(4), all the configuration can be done without rebuilding the kernel. Testing and review is welcome. Right now I'm still moving, and I don't have access to my test environment, so I'm somewhat reluctant to making larger changes to this code; on the other hand I don't want to let it sit on Phab until my testing setup is back, because I want to get it into 11.1-RELEASE. Reviewed by: emaste (cursory), wblock (man page) MFC after: 2 weeks Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D8787
99 lines
2.9 KiB
Groff
99 lines
2.9 KiB
Groff
.\" $FreeBSD$
|
|
.\"
|
|
.\" Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.Dd June 8, 2016
|
|
.Dt USB_TEMPLATE 4
|
|
.Os
|
|
.
|
|
.Sh NAME
|
|
.
|
|
.
|
|
.Nm usb_template
|
|
.
|
|
.Nd "USB device side templates"
|
|
.
|
|
.
|
|
.Sh SYNOPSIS
|
|
To compile this module into the kernel, place the following line in
|
|
your kernel configuration file:
|
|
.Bd -ragged -offset indent
|
|
.Cd "device usb_template"
|
|
.Ed
|
|
.Pp
|
|
To load the module at boot time, place the following line in
|
|
.Xr loader.conf 5 :
|
|
.Bd -literal -offset indent
|
|
usb_template_load="YES"
|
|
.Ed
|
|
.
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
module implements various USB templates that are needed when
|
|
programming an USB device side driver.
|
|
.
|
|
A USB template consists of an USB device descriptor, one or more USB
|
|
configuration descriptors, one or more USB interface descriptors, one
|
|
or more USB endpoint descriptors, USB strings and additional USB
|
|
descriptors.
|
|
.
|
|
USB templates are selected using the
|
|
.Va hw.usb.template
|
|
sysctl and tunable.
|
|
.
|
|
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 cfumass 4 ,
|
|
.Xr usb 4 ,
|
|
.Xr usfs 4
|
|
.Sh STANDARDS
|
|
The
|
|
.Nm
|
|
module complies to the USB 1.0, 2.0 and 3.0 standard.
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
module was written by
|
|
.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .
|