Bring in USB4BSD, Hans Petter Selasky rework of the USB stack
that includes significant features and SMP safety.
This commit includes a more or less complete rewrite of the *BSD USB
stack, including Host Controller and Device Controller drivers and
updating all existing USB drivers to use the new USB API:
1) A brief feature list:
- A new and mutex enabled USB API.
- Many USB drivers are now running Giant free.
- Linux USB kernel compatibility layer.
- New UGEN backend and libusb library, finally solves the "driver
unloading" problem. The new BSD licensed libusb20 library is fully
compatible with libusb-0.1.12 from sourceforge.
- New "usbconfig" utility, for easy configuration of USB.
- Full support for Split transactions, which means you can use your
full speed USB audio device on a high speed USB HUB.
- Full support for HS ISOC transactions, which makes writing drivers
for various HS webcams possible, for example.
- Full support for USB on embedded platforms, mostly cache flushing
and buffer invalidating stuff.
- Safer parsing of USB descriptors.
- Autodetect of annoying USB install disks.
- Support for USB device side mode, also called USB gadget mode,
using the same API like the USB host side. In other words the new
USB stack is symmetric with regard to host and device side.
- Support for USB transfers like I/O vectors, means more throughput
and less interrupts.
- ... see the FreeBSD quarterly status reports under "USB project"
2) To enable the driver in the default kernel build:
2.a) Remove all existing USB device options from your kernel config
file.
2.b) Add the following USB device options to your kernel configuration
file:
# USB core support
device usb2_core
# USB controller support
device usb2_controller
device usb2_controller_ehci
device usb2_controller_ohci
device usb2_controller_uhci
# USB mass storage support
device usb2_storage
device usb2_storage_mass
# USB ethernet support, requires miibus
device usb2_ethernet
device usb2_ethernet_aue
device usb2_ethernet_axe
device usb2_ethernet_cdce
device usb2_ethernet_cue
device usb2_ethernet_kue
device usb2_ethernet_rue
device usb2_ethernet_dav
# USB wireless LAN support
device usb2_wlan
device usb2_wlan_rum
device usb2_wlan_ral
device usb2_wlan_zyd
# USB serial device support
device usb2_serial
device usb2_serial_ark
device usb2_serial_bsa
device usb2_serial_bser
device usb2_serial_chcom
device usb2_serial_cycom
device usb2_serial_foma
device usb2_serial_ftdi
device usb2_serial_gensa
device usb2_serial_ipaq
device usb2_serial_lpt
device usb2_serial_mct
device usb2_serial_modem
device usb2_serial_moscom
device usb2_serial_plcom
device usb2_serial_visor
device usb2_serial_vscom
# USB bluetooth support
device usb2_bluetooth
device usb2_bluetooth_ng
# USB input device support
device usb2_input
device usb2_input_hid
device usb2_input_kbd
device usb2_input_ms
# USB sound and MIDI device support
device usb2_sound
2) To enable the driver at runtime:
2.a) Unload all existing USB modules. If USB is compiled into the
kernel then you might have to build a new kernel.
2.b) Load the "usb2_xxx.ko" modules under /boot/kernel having the same
base name like the kernel device option.
Submitted by: Hans Petter Selasky hselasky at c2i dot net
Reviewed by: imp, alfred
2008-11-04 02:31:03 +00:00
|
|
|
/* $FreeBSD$ */
|
|
|
|
/*-
|
|
|
|
* Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
*/
|
|
|
|
|
2009-06-15 01:09:19 +00:00
|
|
|
#ifndef _USB_QUIRK_H_
|
|
|
|
#define _USB_QUIRK_H_
|
Bring in USB4BSD, Hans Petter Selasky rework of the USB stack
that includes significant features and SMP safety.
This commit includes a more or less complete rewrite of the *BSD USB
stack, including Host Controller and Device Controller drivers and
updating all existing USB drivers to use the new USB API:
1) A brief feature list:
- A new and mutex enabled USB API.
- Many USB drivers are now running Giant free.
- Linux USB kernel compatibility layer.
- New UGEN backend and libusb library, finally solves the "driver
unloading" problem. The new BSD licensed libusb20 library is fully
compatible with libusb-0.1.12 from sourceforge.
- New "usbconfig" utility, for easy configuration of USB.
- Full support for Split transactions, which means you can use your
full speed USB audio device on a high speed USB HUB.
- Full support for HS ISOC transactions, which makes writing drivers
for various HS webcams possible, for example.
- Full support for USB on embedded platforms, mostly cache flushing
and buffer invalidating stuff.
- Safer parsing of USB descriptors.
- Autodetect of annoying USB install disks.
- Support for USB device side mode, also called USB gadget mode,
using the same API like the USB host side. In other words the new
USB stack is symmetric with regard to host and device side.
- Support for USB transfers like I/O vectors, means more throughput
and less interrupts.
- ... see the FreeBSD quarterly status reports under "USB project"
2) To enable the driver in the default kernel build:
2.a) Remove all existing USB device options from your kernel config
file.
2.b) Add the following USB device options to your kernel configuration
file:
# USB core support
device usb2_core
# USB controller support
device usb2_controller
device usb2_controller_ehci
device usb2_controller_ohci
device usb2_controller_uhci
# USB mass storage support
device usb2_storage
device usb2_storage_mass
# USB ethernet support, requires miibus
device usb2_ethernet
device usb2_ethernet_aue
device usb2_ethernet_axe
device usb2_ethernet_cdce
device usb2_ethernet_cue
device usb2_ethernet_kue
device usb2_ethernet_rue
device usb2_ethernet_dav
# USB wireless LAN support
device usb2_wlan
device usb2_wlan_rum
device usb2_wlan_ral
device usb2_wlan_zyd
# USB serial device support
device usb2_serial
device usb2_serial_ark
device usb2_serial_bsa
device usb2_serial_bser
device usb2_serial_chcom
device usb2_serial_cycom
device usb2_serial_foma
device usb2_serial_ftdi
device usb2_serial_gensa
device usb2_serial_ipaq
device usb2_serial_lpt
device usb2_serial_mct
device usb2_serial_modem
device usb2_serial_moscom
device usb2_serial_plcom
device usb2_serial_visor
device usb2_serial_vscom
# USB bluetooth support
device usb2_bluetooth
device usb2_bluetooth_ng
# USB input device support
device usb2_input
device usb2_input_hid
device usb2_input_kbd
device usb2_input_ms
# USB sound and MIDI device support
device usb2_sound
2) To enable the driver at runtime:
2.a) Unload all existing USB modules. If USB is compiled into the
kernel then you might have to build a new kernel.
2.b) Load the "usb2_xxx.ko" modules under /boot/kernel having the same
base name like the kernel device option.
Submitted by: Hans Petter Selasky hselasky at c2i dot net
Reviewed by: imp, alfred
2008-11-04 02:31:03 +00:00
|
|
|
|
2010-11-10 23:45:44 +00:00
|
|
|
enum {
|
|
|
|
/*
|
2012-09-17 19:06:35 +00:00
|
|
|
* Keep in sync with usb_quirk_str in usb_quirk.c, and with
|
2010-11-10 23:45:44 +00:00
|
|
|
* share/man/man4/usb_quirk.4
|
|
|
|
*/
|
|
|
|
UQ_NONE, /* not a valid quirk */
|
2009-12-23 01:16:24 +00:00
|
|
|
|
2010-11-10 23:45:44 +00:00
|
|
|
UQ_MATCH_VENDOR_ONLY, /* match quirk on vendor only */
|
2009-12-23 01:16:24 +00:00
|
|
|
|
|
|
|
/* Various quirks */
|
|
|
|
|
2009-02-03 05:50:36 +00:00
|
|
|
UQ_AUDIO_SWAP_LR, /* left and right sound channels are swapped */
|
|
|
|
UQ_AU_INP_ASYNC, /* input is async despite claim of adaptive */
|
|
|
|
UQ_AU_NO_FRAC, /* don't adjust for fractional samples */
|
|
|
|
UQ_AU_NO_XU, /* audio device has broken extension unit */
|
|
|
|
UQ_BAD_ADC, /* bad audio spec version number */
|
|
|
|
UQ_BAD_AUDIO, /* device claims audio class, but isn't */
|
|
|
|
UQ_BROKEN_BIDIR, /* printer has broken bidir mode */
|
|
|
|
UQ_BUS_POWERED, /* device is bus powered, despite claim */
|
|
|
|
UQ_HID_IGNORE, /* device should be ignored by hid class */
|
|
|
|
UQ_KBD_IGNORE, /* device should be ignored by kbd class */
|
2010-02-14 19:56:05 +00:00
|
|
|
UQ_KBD_BOOTPROTO, /* device should set the boot protocol */
|
2012-09-17 19:06:35 +00:00
|
|
|
UQ_UMS_IGNORE, /* device should be ignored by ums class */
|
2009-02-03 05:50:36 +00:00
|
|
|
UQ_MS_BAD_CLASS, /* doesn't identify properly */
|
|
|
|
UQ_MS_LEADING_BYTE, /* mouse sends an unknown leading byte */
|
|
|
|
UQ_MS_REVZ, /* mouse has Z-axis reversed */
|
|
|
|
UQ_NO_STRINGS, /* string descriptors are broken */
|
|
|
|
UQ_POWER_CLAIM, /* hub lies about power status */
|
|
|
|
UQ_SPUR_BUT_UP, /* spurious mouse button up events */
|
|
|
|
UQ_SWAP_UNICODE, /* has some Unicode strings swapped */
|
|
|
|
UQ_CFG_INDEX_1, /* select configuration index 1 by default */
|
|
|
|
UQ_CFG_INDEX_2, /* select configuration index 2 by default */
|
|
|
|
UQ_CFG_INDEX_3, /* select configuration index 3 by default */
|
|
|
|
UQ_CFG_INDEX_4, /* select configuration index 4 by default */
|
|
|
|
UQ_CFG_INDEX_0, /* select configuration index 0 by default */
|
2010-11-10 18:41:38 +00:00
|
|
|
UQ_ASSUME_CM_OVER_DATA, /* assume cm over data feature */
|
2009-12-23 01:16:24 +00:00
|
|
|
|
2012-09-17 19:06:35 +00:00
|
|
|
/*
|
|
|
|
* USB Mass Storage Quirks. See "storage/umass.c" for a
|
|
|
|
* detailed description.
|
|
|
|
*/
|
2010-11-10 18:41:38 +00:00
|
|
|
UQ_MSC_NO_TEST_UNIT_READY, /* send start/stop instead of TUR */
|
|
|
|
UQ_MSC_NO_RS_CLEAR_UA, /* does not reset Unit Att. */
|
|
|
|
UQ_MSC_NO_START_STOP, /* does not support start/stop */
|
|
|
|
UQ_MSC_NO_GETMAXLUN, /* does not support get max LUN */
|
|
|
|
UQ_MSC_NO_INQUIRY, /* fake generic inq response */
|
|
|
|
UQ_MSC_NO_INQUIRY_EVPD, /* does not support inq EVPD */
|
2012-11-05 21:03:38 +00:00
|
|
|
UQ_MSC_NO_PREVENT_ALLOW, /* does not support medium removal */
|
2010-11-10 18:41:38 +00:00
|
|
|
UQ_MSC_NO_SYNC_CACHE, /* does not support sync cache */
|
|
|
|
UQ_MSC_SHUTTLE_INIT, /* requires Shuttle init sequence */
|
|
|
|
UQ_MSC_ALT_IFACE_1, /* switch to alternate interface 1 */
|
|
|
|
UQ_MSC_FLOPPY_SPEED, /* does floppy speeds (20kb/s) */
|
|
|
|
UQ_MSC_IGNORE_RESIDUE, /* gets residue wrong */
|
|
|
|
UQ_MSC_WRONG_CSWSIG, /* uses wrong CSW signature */
|
|
|
|
UQ_MSC_RBC_PAD_TO_12, /* pad RBC requests to 12 bytes */
|
|
|
|
UQ_MSC_READ_CAP_OFFBY1, /* reports sector count, not max sec. */
|
|
|
|
UQ_MSC_FORCE_SHORT_INQ, /* does not support full inq. */
|
|
|
|
UQ_MSC_FORCE_WIRE_BBB, /* force BBB wire protocol */
|
|
|
|
UQ_MSC_FORCE_WIRE_CBI, /* force CBI wire protocol */
|
|
|
|
UQ_MSC_FORCE_WIRE_CBI_I, /* force CBI with int. wire protocol */
|
|
|
|
UQ_MSC_FORCE_PROTO_SCSI, /* force SCSI command protocol */
|
|
|
|
UQ_MSC_FORCE_PROTO_ATAPI, /* force ATAPI command protocol */
|
|
|
|
UQ_MSC_FORCE_PROTO_UFI, /* force UFI command protocol */
|
|
|
|
UQ_MSC_FORCE_PROTO_RBC, /* force RBC command protocol */
|
|
|
|
|
|
|
|
/* Ejection of mass storage (driver disk) */
|
|
|
|
UQ_MSC_EJECT_HUAWEI, /* ejects after Huawei USB command */
|
|
|
|
UQ_MSC_EJECT_SIERRA, /* ejects after Sierra USB command */
|
|
|
|
UQ_MSC_EJECT_SCSIEJECT, /* ejects after SCSI eject command */
|
|
|
|
UQ_MSC_EJECT_REZERO, /* ejects after SCSI rezero command */
|
|
|
|
UQ_MSC_EJECT_ZTESTOR, /* ejects after ZTE SCSI command */
|
|
|
|
UQ_MSC_EJECT_CMOTECH, /* ejects after C-motech SCSI cmd */
|
|
|
|
UQ_MSC_EJECT_WAIT, /* wait for the device to eject */
|
|
|
|
UQ_MSC_EJECT_SAEL_M460, /* ejects after Sael USB commands */
|
|
|
|
UQ_MSC_EJECT_HUAWEISCSI, /* ejects after Huawei SCSI command */
|
|
|
|
UQ_MSC_EJECT_TCT, /* ejects after TCT SCSI command */
|
2009-12-23 01:16:24 +00:00
|
|
|
|
2011-02-24 09:13:47 +00:00
|
|
|
UQ_BAD_MIDI, /* device claims MIDI class, but isn't */
|
|
|
|
UQ_AU_VENDOR_CLASS, /* audio device uses vendor and not audio class */
|
2011-07-03 13:27:23 +00:00
|
|
|
UQ_SINGLE_CMD_MIDI, /* at most one command per USB packet */
|
2011-02-24 09:13:47 +00:00
|
|
|
|
2009-02-03 05:50:36 +00:00
|
|
|
USB_QUIRK_MAX
|
|
|
|
};
|
Bring in USB4BSD, Hans Petter Selasky rework of the USB stack
that includes significant features and SMP safety.
This commit includes a more or less complete rewrite of the *BSD USB
stack, including Host Controller and Device Controller drivers and
updating all existing USB drivers to use the new USB API:
1) A brief feature list:
- A new and mutex enabled USB API.
- Many USB drivers are now running Giant free.
- Linux USB kernel compatibility layer.
- New UGEN backend and libusb library, finally solves the "driver
unloading" problem. The new BSD licensed libusb20 library is fully
compatible with libusb-0.1.12 from sourceforge.
- New "usbconfig" utility, for easy configuration of USB.
- Full support for Split transactions, which means you can use your
full speed USB audio device on a high speed USB HUB.
- Full support for HS ISOC transactions, which makes writing drivers
for various HS webcams possible, for example.
- Full support for USB on embedded platforms, mostly cache flushing
and buffer invalidating stuff.
- Safer parsing of USB descriptors.
- Autodetect of annoying USB install disks.
- Support for USB device side mode, also called USB gadget mode,
using the same API like the USB host side. In other words the new
USB stack is symmetric with regard to host and device side.
- Support for USB transfers like I/O vectors, means more throughput
and less interrupts.
- ... see the FreeBSD quarterly status reports under "USB project"
2) To enable the driver in the default kernel build:
2.a) Remove all existing USB device options from your kernel config
file.
2.b) Add the following USB device options to your kernel configuration
file:
# USB core support
device usb2_core
# USB controller support
device usb2_controller
device usb2_controller_ehci
device usb2_controller_ohci
device usb2_controller_uhci
# USB mass storage support
device usb2_storage
device usb2_storage_mass
# USB ethernet support, requires miibus
device usb2_ethernet
device usb2_ethernet_aue
device usb2_ethernet_axe
device usb2_ethernet_cdce
device usb2_ethernet_cue
device usb2_ethernet_kue
device usb2_ethernet_rue
device usb2_ethernet_dav
# USB wireless LAN support
device usb2_wlan
device usb2_wlan_rum
device usb2_wlan_ral
device usb2_wlan_zyd
# USB serial device support
device usb2_serial
device usb2_serial_ark
device usb2_serial_bsa
device usb2_serial_bser
device usb2_serial_chcom
device usb2_serial_cycom
device usb2_serial_foma
device usb2_serial_ftdi
device usb2_serial_gensa
device usb2_serial_ipaq
device usb2_serial_lpt
device usb2_serial_mct
device usb2_serial_modem
device usb2_serial_moscom
device usb2_serial_plcom
device usb2_serial_visor
device usb2_serial_vscom
# USB bluetooth support
device usb2_bluetooth
device usb2_bluetooth_ng
# USB input device support
device usb2_input
device usb2_input_hid
device usb2_input_kbd
device usb2_input_ms
# USB sound and MIDI device support
device usb2_sound
2) To enable the driver at runtime:
2.a) Unload all existing USB modules. If USB is compiled into the
kernel then you might have to build a new kernel.
2.b) Load the "usb2_xxx.ko" modules under /boot/kernel having the same
base name like the kernel device option.
Submitted by: Hans Petter Selasky hselasky at c2i dot net
Reviewed by: imp, alfred
2008-11-04 02:31:03 +00:00
|
|
|
|
2009-06-23 02:19:59 +00:00
|
|
|
uint8_t usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk);
|
|
|
|
|
2009-06-15 01:09:19 +00:00
|
|
|
#endif /* _USB_QUIRK_H_ */
|