1.\" $FreeBSD$ 2.\" 3.\" Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.Dd May 24, 2018 27.Dt USB_TEMPLATE 4 28.Os 29. 30.Sh NAME 31. 32. 33.Nm usb_template 34. 35.Nd "USB device side templates" 36. 37. 38.Sh SYNOPSIS 39To compile this module into the kernel, place the following line in 40your kernel configuration file: 41.Bd -ragged -offset indent 42.Cd "device usb_template" 43.Ed 44.Pp 45To load the module at boot time, place the following line in 46.Xr loader.conf 5 : 47.Bd -literal -offset indent 48usb_template_load="YES" 49.Ed 50. 51.Sh DESCRIPTION 52The 53.Nm 54module implements various USB templates that are needed when 55programming an USB device side driver. 56. 57A USB template consists of an USB device descriptor, one or more USB 58configuration descriptors, one or more USB interface descriptors, one 59or more USB endpoint descriptors, USB strings and additional USB 60descriptors. 61. 62USB templates are selected using the 63.Va hw.usb.template 64sysctl and tunable, 65or by using the 66.Xr usbconfig 8 67.Cm set_template 68subcommand. 69Changing the 70.Va hw.usb.template 71sysctl triggers reenumeration by the USB host; changes to other sysctls 72may not be visible to the host until reenumeration is performed. 73.Pp 74Available templates are: 75.Bl -column -offset 3n "Value" 76.It Em Value Ta Em Description 77.It Dv 0 Ta USB Mass Storage, see 78.Xr cfumass 4 79.It Dv 1 Ta CDC Ethernet, see 80.Xr cdce 4 81.It Dv 2 Ta Media Transfer Protocol (MTP) 82.It Dv 3 Ta USB serial port, see 83.Xr umodem 4 84.It Dv 4 Ta USB audio 85.It Dv 5 Ta USB keyboard 86.It Dv 6 Ta USB mouse 87.It Dv 7 Ta USB phone 88.It Dv 8 Ta CDC Ethernet and serial port 89.It Dv 9 Ta USB MIDI 90.It Dv 10 Ta CDC Ethernet, serial port, and storage 91.El 92. 93.Sh SYSCTL VARIABLES 94The following variables are available as both 95.Xr sysctl 8 96variables and 97.Xr loader 8 98tunables: 99.Bl -tag -width indent 100.It Va hw.usb.template 101Currently selected template. 102Set to -1 to make the device disappear from the USB host point of view. 103.It Va hw.usb.template_power 104USB bus power consumption in mA at 5V. 105Must be between 0 and 500. 106Setting to 0 marks the device as self-powered. 107Defaults to 500mA. 108.It Va hw.usb.templates.N 109Configuration for template number 110.Va N . 111.It Va hw.usb.templates.N.vendor_id 11216-bit vendor identifier (VID), usually assigned by USB-IF. 113.It Va hw.usb.templates.N.product_id 11416-bit product identifier (PID). 115.It Va hw.usb.templates.N.manufacturer 116String containing human-readable manufacturer name. 117.It Va hw.usb.templates.N.product 118String containing human-readable product name. 119.El 120.Sh SEE ALSO 121.Xr cfumass 4 , 122.Xr usb 4 , 123.Xr usfs 4 , 124.Xr usbconfig 8 125.Sh STANDARDS 126The 127.Nm 128module complies to the USB 1.0, 2.0 and 3.0 standard. 129.Sh HISTORY 130The 131.Nm 132module was written by 133.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org . 134