eabe30fc9c
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
143 lines
5.3 KiB
C
143 lines
5.3 KiB
C
/*-
|
|
* Copyright (c) 1997, 1998, 1999, 2000
|
|
* Bill Paul <wpaul@ee.columbia.edu>. 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.
|
|
* 3. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
* This product includes software developed by Bill Paul.
|
|
* 4. Neither the name of the author nor the names of any co-contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD
|
|
* 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.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
/*
|
|
* Definitions for the KLSI KL5KUSB101B USB to ethernet controller.
|
|
* The KLSI part is controlled via vendor control requests, the structure
|
|
* of which depend a bit on the firmware running on the internal
|
|
* microcontroller. The one exception is the 'send scan data' command,
|
|
* which is used to load the firmware.
|
|
*/
|
|
|
|
#define KUE_CMD_GET_ETHER_DESCRIPTOR 0x00
|
|
#define KUE_CMD_SET_MCAST_FILTERS 0x01
|
|
#define KUE_CMD_SET_PKT_FILTER 0x02
|
|
#define KUE_CMD_GET_ETHERSTATS 0x03
|
|
#define KUE_CMD_GET_GPIO 0x04
|
|
#define KUE_CMD_SET_GPIO 0x05
|
|
#define KUE_CMD_SET_MAC 0x06
|
|
#define KUE_CMD_GET_MAC 0x07
|
|
#define KUE_CMD_SET_URB_SIZE 0x08
|
|
#define KUE_CMD_SET_SOFS 0x09
|
|
#define KUE_CMD_SET_EVEN_PKTS 0x0A
|
|
#define KUE_CMD_SEND_SCAN 0xFF
|
|
|
|
struct kue_ether_desc {
|
|
uint8_t kue_len;
|
|
uint8_t kue_rsvd0;
|
|
uint8_t kue_rsvd1;
|
|
uint8_t kue_macaddr[ETHER_ADDR_LEN];
|
|
uint8_t kue_etherstats[4];
|
|
uint8_t kue_maxseg[2];
|
|
uint8_t kue_mcastfilt[2];
|
|
uint8_t kue_rsvd2;
|
|
} __packed;
|
|
|
|
#define KUE_ETHERSTATS(x) UGETDW((x)->sc_desc.kue_etherstats)
|
|
#define KUE_MAXSEG(x) UGETW((x)->sc_desc.kue_maxseg)
|
|
#define KUE_MCFILTCNT(x) (UGETW((x)->sc_desc.kue_mcastfilt) & 0x7FFF)
|
|
#define KUE_MCFILT_MAX (USB_ETHER_HASH_MAX / ETHER_ADDR_LEN)
|
|
|
|
#define KUE_STAT_TX_OK 0x00000001
|
|
#define KUE_STAT_RX_OK 0x00000002
|
|
#define KUE_STAT_TX_ERR 0x00000004
|
|
#define KUE_STAT_RX_ERR 0x00000008
|
|
#define KUE_STAT_RX_NOBUF 0x00000010
|
|
#define KUE_STAT_TX_UCAST_BYTES 0x00000020
|
|
#define KUE_STAT_TX_UCAST_FRAMES 0x00000040
|
|
#define KUE_STAT_TX_MCAST_BYTES 0x00000080
|
|
#define KUE_STAT_TX_MCAST_FRAMES 0x00000100
|
|
#define KUE_STAT_TX_BCAST_BYTES 0x00000200
|
|
#define KUE_STAT_TX_BCAST_FRAMES 0x00000400
|
|
#define KUE_STAT_RX_UCAST_BYTES 0x00000800
|
|
#define KUE_STAT_RX_UCAST_FRAMES 0x00001000
|
|
#define KUE_STAT_RX_MCAST_BYTES 0x00002000
|
|
#define KUE_STAT_RX_MCAST_FRAMES 0x00004000
|
|
#define KUE_STAT_RX_BCAST_BYTES 0x00008000
|
|
#define KUE_STAT_RX_BCAST_FRAMES 0x00010000
|
|
#define KUE_STAT_RX_CRCERR 0x00020000
|
|
#define KUE_STAT_TX_QUEUE_LENGTH 0x00040000
|
|
#define KUE_STAT_RX_ALIGNERR 0x00080000
|
|
#define KUE_STAT_TX_SINGLECOLL 0x00100000
|
|
#define KUE_STAT_TX_MULTICOLL 0x00200000
|
|
#define KUE_STAT_TX_DEFERRED 0x00400000
|
|
#define KUE_STAT_TX_MAXCOLLS 0x00800000
|
|
#define KUE_STAT_RX_OVERRUN 0x01000000
|
|
#define KUE_STAT_TX_UNDERRUN 0x02000000
|
|
#define KUE_STAT_TX_SQE_ERR 0x04000000
|
|
#define KUE_STAT_TX_CARRLOSS 0x08000000
|
|
#define KUE_STAT_RX_LATECOLL 0x10000000
|
|
|
|
#define KUE_RXFILT_PROMISC 0x0001
|
|
#define KUE_RXFILT_ALLMULTI 0x0002
|
|
#define KUE_RXFILT_UNICAST 0x0004
|
|
#define KUE_RXFILT_BROADCAST 0x0008
|
|
#define KUE_RXFILT_MULTICAST 0x0010
|
|
|
|
#define KUE_TIMEOUT 1000
|
|
#define KUE_MIN_FRAMELEN 60
|
|
|
|
#define KUE_CTL_READ 0x01
|
|
#define KUE_CTL_WRITE 0x02
|
|
|
|
#define KUE_CONFIG_IDX 0 /* config number 1 */
|
|
#define KUE_IFACE_IDX 0
|
|
|
|
/* The interrupt endpoint is currently unused by the KLSI part. */
|
|
#define KUE_ENDPT_MAX 4
|
|
|
|
struct kue_softc {
|
|
void *sc_evilhack; /* XXX this pointer must be first */
|
|
|
|
struct usb2_config_td sc_config_td;
|
|
struct usb2_callout sc_watchdog;
|
|
struct mtx sc_mtx;
|
|
struct kue_ether_desc sc_desc;
|
|
|
|
struct ifnet *sc_ifp;
|
|
device_t sc_dev;
|
|
struct usb2_device *sc_udev;
|
|
struct usb2_xfer *sc_xfer[KUE_ENDPT_MAX];
|
|
|
|
uint32_t sc_unit;
|
|
|
|
uint16_t sc_mcfilt_max;
|
|
uint16_t sc_flags;
|
|
#define KUE_FLAG_READ_STALL 0x0010 /* wait for clearing of stall */
|
|
#define KUE_FLAG_WRITE_STALL 0x0020 /* wait for clearing of stall */
|
|
#define KUE_FLAG_LL_READY 0x0040 /* Lower Layer Ready */
|
|
#define KUE_FLAG_HL_READY 0x0080 /* Higher Layer Ready */
|
|
#define KUE_FLAG_INTR_STALL 0x0100 /* wait for clearing of stall */
|
|
};
|