1 .\" Copyright (c) 2017 The FreeBSD Foundation
2 .\" All rights reserved.
4 .\" This software was developed by Edward Tomasz Napierala under sponsorship
5 .\" from the FreeBSD Foundation.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .Nd USB device side support for Mass Storage Class Transport
36 This driver can be compiled into the kernel by placing these lines in
37 the kernel configuration file:
38 .Bd -ragged -offset indent
40 .Cd "device usb_template"
45 The driver module can also be loaded at boot by adding this line to
47 .Bd -literal -offset indent
53 driver provides device side support for emulating an USB mass storage
54 device compliant with the USB Mass Storage Class Bulk-Only (BBB) Transport
55 specification, implemented as a
64 must be loaded as a module or compiled into the kernel.
66 The USB Mass Storage template must be chosen by setting the
70 The USB OTG port must be working in USB device-side mode.
71 This happens automatically upon connection to a USB host.
75 LUN configured for the
80 Upon loading, the driver creates a
84 presenting the first LUN mapped for that port - usually LUN 0 - to
90 for details on configuring the LUN.
98 for an automated way to configure it at boot.
100 These variables are available as both
105 .Bl -tag -width indent
106 .It Va hw.usb.cfumass.debug
107 Verbosity level for log messages from the
110 Set to 0 to disable logging or 1 to warn about potential problems.
111 Larger values enable debugging output.
113 .It Va hw.usb.cfumass.ignore_stop
114 Ignore START STOP UNIT SCSI commands with START and LOEJ bits cleared.
115 Some initiators send that command to stop the target when the user
116 attempts to gracefully eject the drive, but fail to start it when the
117 drive is reconnected.
118 Set to 0 to handle the command in a standards-compliant way,
119 1 to ignore it and log a warning, or 2 to ignore it silently.
121 .It Va hw.usb.cfumass.max_lun
122 Max LUN number to report to the initiator (USB host).
123 Must be between 0 and 15.
124 Some initiators incorrectly handle values larger than 0.
137 driver first appeared in
142 driver was developed by
143 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
144 under sponsorship from the FreeBSD Foundation.