1/* $FreeBSD: releng/11.0/sys/dev/usb/quirk/usb_quirk.h 282577 2015-05-07 12:54:27Z hselasky $ */
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
27#ifndef _USB_QUIRK_H_
28#define	_USB_QUIRK_H_
29
30enum {
31	/*
32	 * Keep in sync with usb_quirk_str in usb_quirk.c, and with
33	 * share/man/man4/usb_quirk.4
34	 */
35	UQ_NONE,		/* not a valid quirk */
36
37	UQ_MATCH_VENDOR_ONLY,	/* match quirk on vendor only */
38
39	/* Various quirks */
40
41	UQ_AUDIO_SWAP_LR,	/* left and right sound channels are swapped */
42	UQ_AU_INP_ASYNC,	/* input is async despite claim of adaptive */
43	UQ_AU_NO_FRAC,		/* don't adjust for fractional samples */
44	UQ_AU_NO_XU,		/* audio device has broken extension unit */
45	UQ_BAD_ADC,		/* bad audio spec version number */
46	UQ_BAD_AUDIO,		/* device claims audio class, but isn't */
47	UQ_BROKEN_BIDIR,	/* printer has broken bidir mode */
48	UQ_BUS_POWERED,		/* device is bus powered, despite claim */
49	UQ_HID_IGNORE,		/* device should be ignored by hid class */
50	UQ_KBD_IGNORE,		/* device should be ignored by kbd class */
51	UQ_KBD_BOOTPROTO,	/* device should set the boot protocol */
52	UQ_UMS_IGNORE,          /* device should be ignored by ums class */
53	UQ_MS_BAD_CLASS,	/* doesn't identify properly */
54	UQ_MS_LEADING_BYTE,	/* mouse sends an unknown leading byte */
55	UQ_MS_REVZ,		/* mouse has Z-axis reversed */
56	UQ_NO_STRINGS,		/* string descriptors are broken */
57	UQ_POWER_CLAIM,		/* hub lies about power status */
58	UQ_SPUR_BUT_UP,		/* spurious mouse button up events */
59	UQ_SWAP_UNICODE,	/* has some Unicode strings swapped */
60	UQ_CFG_INDEX_1,		/* select configuration index 1 by default */
61	UQ_CFG_INDEX_2,		/* select configuration index 2 by default */
62	UQ_CFG_INDEX_3,		/* select configuration index 3 by default */
63	UQ_CFG_INDEX_4,		/* select configuration index 4 by default */
64	UQ_CFG_INDEX_0,		/* select configuration index 0 by default */
65	UQ_ASSUME_CM_OVER_DATA,	/* assume cm over data feature */
66
67	/*
68	 * USB Mass Storage Quirks. See "storage/umass.c" for a
69	 * detailed description.
70	 */
71	UQ_MSC_NO_TEST_UNIT_READY,	/* send start/stop instead of TUR */
72	UQ_MSC_NO_RS_CLEAR_UA,		/* does not reset Unit Att. */
73	UQ_MSC_NO_START_STOP,		/* does not support start/stop */
74	UQ_MSC_NO_GETMAXLUN,		/* does not support get max LUN */
75	UQ_MSC_NO_INQUIRY,		/* fake generic inq response */
76	UQ_MSC_NO_INQUIRY_EVPD,		/* does not support inq EVPD */
77	UQ_MSC_NO_PREVENT_ALLOW,	/* does not support medium removal */
78	UQ_MSC_NO_SYNC_CACHE,		/* does not support sync cache */
79	UQ_MSC_SHUTTLE_INIT,		/* requires Shuttle init sequence */
80	UQ_MSC_ALT_IFACE_1,		/* switch to alternate interface 1 */
81	UQ_MSC_FLOPPY_SPEED,		/* does floppy speeds (20kb/s) */
82	UQ_MSC_IGNORE_RESIDUE,		/* gets residue wrong */
83	UQ_MSC_WRONG_CSWSIG,		/* uses wrong CSW signature */
84	UQ_MSC_RBC_PAD_TO_12,		/* pad RBC requests to 12 bytes */
85	UQ_MSC_READ_CAP_OFFBY1,		/* reports sector count, not max sec. */
86	UQ_MSC_FORCE_SHORT_INQ,		/* does not support full inq. */
87	UQ_MSC_FORCE_WIRE_BBB,		/* force BBB wire protocol */
88	UQ_MSC_FORCE_WIRE_CBI,		/* force CBI wire protocol */
89	UQ_MSC_FORCE_WIRE_CBI_I,	/* force CBI with int. wire protocol */
90	UQ_MSC_FORCE_PROTO_SCSI,	/* force SCSI command protocol */
91	UQ_MSC_FORCE_PROTO_ATAPI,	/* force ATAPI command protocol */
92	UQ_MSC_FORCE_PROTO_UFI,		/* force UFI command protocol */
93	UQ_MSC_FORCE_PROTO_RBC,		/* force RBC command protocol */
94
95	/* Ejection of mass storage (driver disk) */
96	UQ_MSC_EJECT_HUAWEI,		/* ejects after Huawei USB command */
97	UQ_MSC_EJECT_SIERRA,		/* ejects after Sierra USB command */
98	UQ_MSC_EJECT_SCSIEJECT,		/* ejects after SCSI eject command */
99	UQ_MSC_EJECT_REZERO,		/* ejects after SCSI rezero command */
100	UQ_MSC_EJECT_ZTESTOR,		/* ejects after ZTE SCSI command */
101	UQ_MSC_EJECT_CMOTECH,		/* ejects after C-motech SCSI cmd */
102	UQ_MSC_EJECT_WAIT,		/* wait for the device to eject */
103	UQ_MSC_EJECT_SAEL_M460,		/* ejects after Sael USB commands */
104	UQ_MSC_EJECT_HUAWEISCSI,	/* ejects after Huawei SCSI command */
105	UQ_MSC_EJECT_HUAWEISCSI2,	/* ejects after Huawei SCSI 2 command */
106	UQ_MSC_EJECT_TCT,		/* ejects after TCT SCSI command */
107
108	UQ_BAD_MIDI,		/* device claims MIDI class, but isn't */
109	UQ_AU_VENDOR_CLASS,	/* audio device uses vendor and not audio class */
110	UQ_SINGLE_CMD_MIDI,	/* at most one command per USB packet */
111	UQ_MSC_DYMO_EJECT,	/* ejects Dymo MSC device */
112
113	USB_QUIRK_MAX
114};
115
116uint8_t	usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk);
117
118#endif					/* _USB_QUIRK_H_ */
119