Date: Wed, 8 Jun 2016 07:39:56 +0000 (UTC) From: Edward Tomasz Napierala <trasz@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r301587 - head/share/man/man4 Message-ID: <201606080739.u587ducq007984@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: trasz Date: Wed Jun 8 07:39:55 2016 New Revision: 301587 URL: https://svnweb.freebsd.org/changeset/base/301587 Log: Improve documentation for usfs(4) and usb_template(4). Reviewed by: hselasky (earlier version) MFC after: 1 month Differential Revision: https://reviews.freebsd.org/D6740 Modified: head/share/man/man4/usb_template.4 head/share/man/man4/usfs.4 Modified: head/share/man/man4/usb_template.4 ============================================================================== --- head/share/man/man4/usb_template.4 Wed Jun 8 07:36:00 2016 (r301586) +++ head/share/man/man4/usb_template.4 Wed Jun 8 07:39:55 2016 (r301587) @@ -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 U 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 Modified: head/share/man/man4/usfs.4 ============================================================================== --- head/share/man/man4/usfs.4 Wed Jun 8 07:36:00 2016 (r301586) +++ head/share/man/man4/usfs.4 Wed Jun 8 07:39:55 2016 (r301587) @@ -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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201606080739.u587ducq007984>