From owner-svn-src-all@freebsd.org Wed Jun 8 07:39:57 2016 Return-Path: Delivered-To: svn-src-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 30EAFB6EAC9; Wed, 8 Jun 2016 07:39:57 +0000 (UTC) (envelope-from trasz@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id E606F1B32; Wed, 8 Jun 2016 07:39:56 +0000 (UTC) (envelope-from trasz@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id u587duki007986; Wed, 8 Jun 2016 07:39:56 GMT (envelope-from trasz@FreeBSD.org) Received: (from trasz@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id u587ducq007984; Wed, 8 Jun 2016 07:39:56 GMT (envelope-from trasz@FreeBSD.org) Message-Id: <201606080739.u587ducq007984@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: trasz set sender to trasz@FreeBSD.org using -f From: Edward Tomasz Napierala Date: Wed, 8 Jun 2016 07:39:56 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r301587 - head/share/man/man4 X-SVN-Group: head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 08 Jun 2016 07:39:57 -0000 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