1*a7ceaa31SSascha Wildner.\" $FreeBSD: head/share/man/man4/usb_template.4 263292 2014-03-18 06:43:21Z hselasky $ 2*a7ceaa31SSascha Wildner.\" 3*a7ceaa31SSascha Wildner.\" Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4*a7ceaa31SSascha Wildner.\" 5*a7ceaa31SSascha Wildner.\" Redistribution and use in source and binary forms, with or without 6*a7ceaa31SSascha Wildner.\" modification, are permitted provided that the following conditions 7*a7ceaa31SSascha Wildner.\" are met: 8*a7ceaa31SSascha Wildner.\" 1. Redistributions of source code must retain the above copyright 9*a7ceaa31SSascha Wildner.\" notice, this list of conditions and the following disclaimer. 10*a7ceaa31SSascha Wildner.\" 2. Redistributions in binary form must reproduce the above copyright 11*a7ceaa31SSascha Wildner.\" notice, this list of conditions and the following disclaimer in the 12*a7ceaa31SSascha Wildner.\" documentation and/or other materials provided with the distribution. 13*a7ceaa31SSascha Wildner.\" 14*a7ceaa31SSascha Wildner.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15*a7ceaa31SSascha Wildner.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16*a7ceaa31SSascha Wildner.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17*a7ceaa31SSascha Wildner.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18*a7ceaa31SSascha Wildner.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19*a7ceaa31SSascha Wildner.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20*a7ceaa31SSascha Wildner.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21*a7ceaa31SSascha Wildner.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22*a7ceaa31SSascha Wildner.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23*a7ceaa31SSascha Wildner.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24*a7ceaa31SSascha Wildner.\" SUCH DAMAGE. 25*a7ceaa31SSascha Wildner.\" 26*a7ceaa31SSascha Wildner.Dd March 18, 2014 27*a7ceaa31SSascha Wildner.Dt USB_TEMPLATE 4 28*a7ceaa31SSascha Wildner.Os 29*a7ceaa31SSascha Wildner. 30*a7ceaa31SSascha Wildner.Sh NAME 31*a7ceaa31SSascha Wildner. 32*a7ceaa31SSascha Wildner. 33*a7ceaa31SSascha Wildner.Nm usb_template 34*a7ceaa31SSascha Wildner. 35*a7ceaa31SSascha Wildner.Nd "USB templates" 36*a7ceaa31SSascha Wildner. 37*a7ceaa31SSascha Wildner. 38*a7ceaa31SSascha Wildner.Sh SYNOPSIS 39*a7ceaa31SSascha WildnerTo compile this module into the kernel, place the following line in 40*a7ceaa31SSascha Wildneryour kernel configuration file: 41*a7ceaa31SSascha Wildner.Bd -ragged -offset indent 42*a7ceaa31SSascha Wildner.Cd "device usb_template" 43*a7ceaa31SSascha Wildner.Ed 44*a7ceaa31SSascha Wildner.Pp 45*a7ceaa31SSascha WildnerTo load the module at boot time, place the following line in 46*a7ceaa31SSascha Wildner.Xr loader.conf 5 : 47*a7ceaa31SSascha Wildner.Bd -literal -offset indent 48*a7ceaa31SSascha Wildnerusb_template_load="YES" 49*a7ceaa31SSascha Wildner.Ed 50*a7ceaa31SSascha Wildner. 51*a7ceaa31SSascha Wildner.Sh DESCRIPTION 52*a7ceaa31SSascha WildnerThe 53*a7ceaa31SSascha Wildner.Nm 54*a7ceaa31SSascha Wildnermodule implements various USB templates that are needed when 55*a7ceaa31SSascha Wildnerprogramming an USB device side driver. 56*a7ceaa31SSascha Wildner. 57*a7ceaa31SSascha WildnerA USB template consists of an USB device descriptor, one or more USB 58*a7ceaa31SSascha Wildnerconfiguration descriptors, one or more USB interface descriptors, one 59*a7ceaa31SSascha Wildneror more USB endpoint descriptors, USB strings and additional USB 60*a7ceaa31SSascha Wildnerdescriptors. 61*a7ceaa31SSascha Wildner. 62*a7ceaa31SSascha WildnerThe USB template module currently has templates for USB Mass Storage, 63*a7ceaa31SSascha WildnerUSB CDC Ethernet and Message Transfer Protocol. 64*a7ceaa31SSascha Wildner. 65*a7ceaa31SSascha WildnerUSB templates are currently selected using the "hw.usb.template" 66*a7ceaa31SSascha Wildnersysctl. 67*a7ceaa31SSascha Wildner. 68*a7ceaa31SSascha WildnerThe "hw.usb.template" value can be changed at any time, but will not 69*a7ceaa31SSascha Wildnerhave any effect until the USB device has been re-enumerated. 70*a7ceaa31SSascha Wildner. 71*a7ceaa31SSascha Wildner. 72*a7ceaa31SSascha Wildner. 73*a7ceaa31SSascha Wildner.Sh SEE ALSO 74*a7ceaa31SSascha Wildner.Xr usb 4 75*a7ceaa31SSascha Wildner.Sh STANDARDS 76*a7ceaa31SSascha WildnerThe 77*a7ceaa31SSascha Wildner.Nm 78*a7ceaa31SSascha Wildnermodule complies to the USB 1.0, 2.0 and 3.0 standard. 79*a7ceaa31SSascha Wildner.Sh HISTORY 80*a7ceaa31SSascha WildnerThe 81*a7ceaa31SSascha Wildner.Nm 82*a7ceaa31SSascha Wildnermodule was written by 83*a7ceaa31SSascha Wildner.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org . 84