2 .\" Copyright (c) 2010 AnyWi Technologies
3 .\" All rights reserved.
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 .\" $FreeBSD: head/share/man/man4/usb_quirk.4 322695 2017-08-19 17:00:10Z wulf $
26 To compile this module into the kernel,
27 place the following line in your
28 kernel configuration file:
29 .Bd -ragged -offset indent
33 Alternatively, to load the module at boot
34 time, place the following line in
36 .Bd -literal -offset indent
42 module provides support for dynamically adding and removing quirks for
48 swap left and right channels
50 input is async despite claim of adaptive
52 do not adjust for fractional samples
54 audio device has broken extension unit
55 .It UQ_AU_VENDOR_CLASS
56 audio device uses vendor class to identify itself
57 .It UQ_AU_SET_SPDIF_CM6206
58 audio device needs special programming to enable S/PDIF audio output
60 bad audio spec version number
62 device claims audio class, but is not
64 printer has broken bidir mode
66 device is bus powered, despite claim
68 device should be ignored by hid class
70 device should be ignored by kbd class
72 device should set the boot protocol
74 device should be ignored by ums class
76 does not identify properly
77 .It UQ_MS_LEADING_BYTE
78 mouse sends an unknown leading byte
80 mouse has Z-axis reversed
82 string descriptors are broken
84 hub lies about power status
86 spurious mouse button up events
88 has some Unicode strings swapped
90 select configuration index 1 by default
92 select configuration index 2 by default
94 select configuration index 3 by default
96 select configuration index 4 by default
98 select configuration index 0 by default
99 .It UQ_ASSUME_CM_OVER_DATA
100 assume cm over data feature
102 device should be ignored by wmt driver
104 .Sh USB Mass Storage quirks:
106 .It UQ_MSC_NO_TEST_UNIT_READY
107 send start/stop instead of TUR
108 .It UQ_MSC_NO_RS_CLEAR_UA
109 does not reset Unit Att.
110 .It UQ_MSC_NO_START_STOP
111 does not support start/stop
112 .It UQ_MSC_NO_GETMAXLUN
113 does not support get max LUN
114 .It UQ_MSC_NO_INQUIRY
115 fake generic inq response
116 .It UQ_MSC_NO_INQUIRY_EVPD
117 does not support inq EVPD
118 .It UQ_MSC_NO_SYNC_CACHE
119 does not support sync cache
120 .It UQ_MSC_SHUTTLE_INIT
121 requires Shuttle init sequence
122 .It UQ_MSC_ALT_IFACE_1
123 switch to alternate interface 1
124 .It UQ_MSC_FLOPPY_SPEED
125 does floppy speeds (20kb/s)
126 .It UQ_MSC_IGNORE_RESIDUE
128 .It UQ_MSC_WRONG_CSWSIG
129 uses wrong CSW signature
130 .It UQ_MSC_RBC_PAD_TO_12
131 pad RBC requests to 12 bytes
132 .It UQ_MSC_READ_CAP_OFFBY1
133 reports sector count, not max sec.
134 .It UQ_MSC_FORCE_SHORT_INQ
135 does not support full inq.
136 .It UQ_MSC_FORCE_WIRE_BBB
137 force BBB wire protocol
138 .It UQ_MSC_FORCE_WIRE_CBI
139 force CBI wire protocol
140 .It UQ_MSC_FORCE_WIRE_CBI_I
141 force CBI with int. wire protocol
142 .It UQ_MSC_FORCE_PROTO_SCSI
143 force SCSI command protocol
144 .It UQ_MSC_FORCE_PROTO_ATAPI
145 force ATAPI command protocol
146 .It UQ_MSC_FORCE_PROTO_UFI
147 force UFI command protocol
148 .It UQ_MSC_FORCE_PROTO_RBC
149 force RBC command protocol
151 .Sh 3G Datacard (u3g) quirks:
153 .It UQ_MSC_EJECT_HUAWEI
154 ejects after Huawei USB command
155 .It UQ_MSC_EJECT_SIERRA
156 ejects after Sierra USB command
157 .It UQ_MSC_EJECT_SCSIEJECT
158 ejects after SCSI eject command
160 .It UQ_MSC_EJECT_REZERO
161 ejects after SCSI rezero command
163 .It UQ_MSC_EJECT_ZTESTOR
164 ejects after ZTE SCSI command
165 .Dv 0x850101011801010101010000
166 .It UQ_MSC_EJECT_CMOTECH
167 ejects after C-motech SCSI command
168 .Dv 0xff52444556434847
169 .It UQ_MSC_EJECT_WAIT
170 wait for the device to eject
171 .It UQ_MSC_EJECT_SAEL_M460
172 ejects after Sael USB commands
173 .It UQ_MSC_EJECT_HUAWEISCSI
174 ejects after Huawei SCSI command
175 .Dv 0x11060000000000000000000000000000
177 ejects after TCT SCSI command
179 .It UQ_MSC_DYMO_EJECT
180 ejects after HID command
185 .Pa /sys/dev/usb/quirk/usb_quirk.h
186 or run "usbconfig dump_quirk_names" for the complete list of supported quirks.
188 The following tunable can be set at the
190 prompt before booting the kernel, or stored in
192 .Bl -tag -width indent
193 .It Va hw.usb.quirk.%d
194 The value is a string whose format is:
195 .Bd -literal -offset indent
196 .Qo VendorId ProductId LowRevision HighRevision UQ_QUIRK,... Qc
201 for all USB devices matching
205 which have a hardware revision between and including
215 are all 16 bits numbers which can be decimal or hexadecimal based.
217 A maximum of 100 variables
218 .Ic hw.usb.quirk.0, .1, ..., .99
221 If a matching entry is found in the kernel's internal quirks table, it
222 is replaced by the new definition.
224 Else a new entry is created given that the quirk table is not full.
226 The kernel iterates over the
228 variables starting at
232 or the first non-existing one.
237 device which appears as a USB device on
239 .Bd -literal -offset indent
240 usbconfig -d ugen0.3 add_quirk UQ_MSC_EJECT_WAIT
243 Enable a Holtec/Keep Out F85 gaming keyboard on
245 .Bd -literal -offset indent
246 usbconfig -d ugen1.4 add_quirk UQ_KBD_BOOTPROTO
249 To install a quirk at boot time, place one or several lines like the
252 .Bd -literal -offset indent
253 hw.usb.quirk.0="0x04d9 0xfa50 0 0xffff UQ_KBD_IGNORE"
263 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .
264 This manual page was written by
265 .An Nick Hibma Aq Mt n_hibma@FreeBSD.org .