1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#ifndef _USB_QUIRK_H_
29#define	_USB_QUIRK_H_
30
31enum {
32	/*
33	 * Keep in sync with usb_quirk_str in usb_quirk.c, and with
34	 * share/man/man4/usb_quirk.4
35	 */
36	UQ_NONE,		/* not a valid quirk */
37
38	UQ_MATCH_VENDOR_ONLY,	/* match quirk on vendor only */
39
40	/* Various quirks */
41
42	UQ_AUDIO_SWAP_LR,	/* left and right sound channels are swapped */
43	UQ_AU_INP_ASYNC,	/* input is async despite claim of adaptive */
44	UQ_AU_NO_FRAC,		/* don't adjust for fractional samples */
45	UQ_AU_NO_XU,		/* audio device has broken extension unit */
46	UQ_BAD_ADC,		/* bad audio spec version number */
47	UQ_BAD_AUDIO,		/* device claims audio class, but isn't */
48	UQ_BROKEN_BIDIR,	/* printer has broken bidir mode */
49	UQ_BUS_POWERED,		/* device is bus powered, despite claim */
50	UQ_HID_IGNORE,		/* device should be ignored by hid class */
51	UQ_KBD_IGNORE,		/* device should be ignored by kbd class */
52	UQ_KBD_BOOTPROTO,	/* device should set the boot protocol */
53	UQ_UMS_IGNORE,          /* device should be ignored by ums class */
54	UQ_MS_BAD_CLASS,	/* doesn't identify properly */
55	UQ_MS_LEADING_BYTE,	/* mouse sends an unknown leading byte */
56	UQ_MS_REVZ,		/* mouse has Z-axis reversed */
57	UQ_MS_VENDOR_BTN,	/* mouse has buttons in vendor usage page */
58	UQ_NO_STRINGS,		/* string descriptors are broken */
59	UQ_POWER_CLAIM,		/* hub lies about power status */
60	UQ_SPUR_BUT_UP,		/* spurious mouse button up events */
61	UQ_SWAP_UNICODE,	/* has some Unicode strings swapped */
62	UQ_CFG_INDEX_1,		/* select configuration index 1 by default */
63	UQ_CFG_INDEX_2,		/* select configuration index 2 by default */
64	UQ_CFG_INDEX_3,		/* select configuration index 3 by default */
65	UQ_CFG_INDEX_4,		/* select configuration index 4 by default */
66	UQ_CFG_INDEX_0,		/* select configuration index 0 by default */
67	UQ_ASSUME_CM_OVER_DATA,	/* assume cm over data feature */
68	UQ_IGNORE_CDC_CM,	/* ignore cm descriptor */
69
70	/*
71	 * USB Mass Storage Quirks. See "storage/umass.c" for a
72	 * detailed description.
73	 */
74	UQ_MSC_NO_TEST_UNIT_READY,	/* send start/stop instead of TUR */
75	UQ_MSC_NO_RS_CLEAR_UA,		/* does not reset Unit Att. */
76	UQ_MSC_NO_START_STOP,		/* does not support start/stop */
77	UQ_MSC_NO_GETMAXLUN,		/* does not support get max LUN */
78	UQ_MSC_NO_INQUIRY,		/* fake generic inq response */
79	UQ_MSC_NO_INQUIRY_EVPD,		/* does not support inq EVPD */
80	UQ_MSC_NO_PREVENT_ALLOW,	/* does not support medium removal */
81	UQ_MSC_NO_SYNC_CACHE,		/* does not support sync cache */
82	UQ_MSC_SHUTTLE_INIT,		/* requires Shuttle init sequence */
83	UQ_MSC_ALT_IFACE_1,		/* switch to alternate interface 1 */
84	UQ_MSC_FLOPPY_SPEED,		/* does floppy speeds (20kb/s) */
85	UQ_MSC_IGNORE_RESIDUE,		/* gets residue wrong */
86	UQ_MSC_WRONG_CSWSIG,		/* uses wrong CSW signature */
87	UQ_MSC_RBC_PAD_TO_12,		/* pad RBC requests to 12 bytes */
88	UQ_MSC_READ_CAP_OFFBY1,		/* reports sector count, not max sec. */
89	UQ_MSC_FORCE_SHORT_INQ,		/* does not support full inq. */
90	UQ_MSC_FORCE_WIRE_BBB,		/* force BBB wire protocol */
91	UQ_MSC_FORCE_WIRE_CBI,		/* force CBI wire protocol */
92	UQ_MSC_FORCE_WIRE_CBI_I,	/* force CBI with int. wire protocol */
93	UQ_MSC_FORCE_PROTO_SCSI,	/* force SCSI command protocol */
94	UQ_MSC_FORCE_PROTO_ATAPI,	/* force ATAPI command protocol */
95	UQ_MSC_FORCE_PROTO_UFI,		/* force UFI command protocol */
96	UQ_MSC_FORCE_PROTO_RBC,		/* force RBC command protocol */
97	UQ_MSC_IGNORE,			/* device should be ignored by umass */
98
99	/* Ejection of mass storage (driver disk) */
100	UQ_MSC_EJECT_HUAWEI,		/* ejects after Huawei USB command */
101	UQ_MSC_EJECT_SIERRA,		/* ejects after Sierra USB command */
102	UQ_MSC_EJECT_SCSIEJECT,		/* ejects after SCSI eject command */
103	UQ_MSC_EJECT_REZERO,		/* ejects after SCSI rezero command */
104	UQ_MSC_EJECT_ZTESTOR,		/* ejects after ZTE SCSI command */
105	UQ_MSC_EJECT_CMOTECH,		/* ejects after C-motech SCSI cmd */
106	UQ_MSC_EJECT_WAIT,		/* wait for the device to eject */
107	UQ_MSC_EJECT_SAEL_M460,		/* ejects after Sael USB commands */
108	UQ_MSC_EJECT_HUAWEISCSI,	/* ejects after Huawei SCSI command */
109	UQ_MSC_EJECT_HUAWEISCSI2,	/* ejects after Huawei SCSI 2 command */
110	UQ_MSC_EJECT_HUAWEISCSI3,	/* ejects after Huawei SCSI 3 command */
111	UQ_MSC_EJECT_HUAWEISCSI4,	/* ejects after Huawei SCSI 4 command */
112	UQ_MSC_EJECT_TCT,		/* ejects after TCT SCSI command */
113
114	UQ_BAD_MIDI,		/* device claims MIDI class, but isn't */
115	UQ_AU_VENDOR_CLASS,	/* audio device uses vendor and not audio class */
116	UQ_SINGLE_CMD_MIDI,	/* at most one command per USB packet */
117	UQ_MSC_DYMO_EJECT,	/* ejects Dymo MSC device */
118	UQ_AU_SET_SPDIF_CM6206,	/* enable S/PDIF audio output */
119	UQ_WMT_IGNORE,          /* device should be ignored by wmt driver */
120
121	USB_QUIRK_MAX
122};
123
124uint8_t usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk);
125extern void usb_quirk_init(void *arg);
126
127#endif					/* _USB_QUIRK_H_ */
128