xref: /dragonfly/share/man/man4/cue.4 (revision ed36d35d)
1.\" Copyright (c) 1997, 1998, 1999, 2000
2.\"	Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"   without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29.\" THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $FreeBSD: head/share/man/man4/cue.4 267938 2014-06-26 21:46:14Z bapt $
32.\"
33.Dd November 10, 2014
34.Dt CUE 4
35.Os
36.Sh NAME
37.Nm cue
38.Nd "CATC USB-EL1210A USB Ethernet driver"
39.Sh SYNOPSIS
40To compile this driver into the kernel,
41place the following lines in your
42kernel configuration file:
43.Bd -ragged -offset indent
44.Cd "device uhci"
45.Cd "device ohci"
46.Cd "device usb"
47.Cd "device cue"
48.Ed
49.Pp
50Alternatively, to load the driver as a
51module at boot time, place the following line in
52.Xr loader.conf 5 :
53.Bd -literal -offset indent
54if_cue_load="YES"
55.Ed
56.Sh DESCRIPTION
57The
58.Nm
59driver provides support for USB Ethernet adapters based on the Computer
60Access Technology Corporation's USB-EL1210A chipset.
61.Pp
62The USB-EL1210A supports a 512-bit multicast hash filter, single perfect
63filter entry for the station address and promiscuous mode.
64Packets are
65received and transmitted over separate USB bulk transfer endpoints.
66.Pp
67The CATC chipset supports only 10Mbps half-duplex mode, hence there
68are no
69.Xr ifmedia 4
70modes to select.
71.Pp
72For more information on configuring this device, see
73.Xr ifconfig 8 .
74.Sh HARDWARE
75The
76.Nm
77driver supports CATC USB-EL1210A based USB Ethernet
78adapters including:
79.Pp
80.Bl -bullet -compact
81.It
82Belkin F5U011/F5U111
83.It
84CATC Netmate
85.It
86CATC Netmate II
87.It
88SmartBridges SmartLink
89.El
90.Sh DIAGNOSTICS
91.Bl -diag
92.It "cue%d: watchdog timeout"
93A packet was queued for transmission and a transmit command was
94issued, however the device failed to acknowledge the transmission
95before a timeout expired.
96.It "cue%d: no memory for rx list"
97The driver failed to allocate an mbuf for the receiver ring.
98.El
99.Sh SEE ALSO
100.Xr arp 4 ,
101.Xr ifmedia 4 ,
102.Xr netintro 4 ,
103.Xr ng_ether 4 ,
104.Xr ifconfig 8
105.Sh HISTORY
106The
107.Nm
108device driver first appeared in
109.Fx 4.0 .
110.Sh AUTHORS
111The
112.Nm
113driver was written by
114.An Bill Paul Aq Mt wpaul@ee.columbia.edu .
115