xref: /dragonfly/share/man/man4/cue.4 (revision 7d3e9a5b)
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 May 27, 2021
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 uether"
48.Cd "device cue"
49.Ed
50.Pp
51Alternatively, to load the driver as a
52module at boot time, place the following line in
53.Xr loader.conf 5 :
54.Bd -literal -offset indent
55if_cue_load="YES"
56.Ed
57.Sh DESCRIPTION
58The
59.Nm
60driver provides support for USB Ethernet adapters based on the Computer
61Access Technology Corporation's USB-EL1210A chipset.
62.Pp
63The USB-EL1210A supports a 512-bit multicast hash filter, single perfect
64filter entry for the station address and promiscuous mode.
65Packets are
66received and transmitted over separate USB bulk transfer endpoints.
67.Pp
68The CATC chipset supports only 10Mbps half-duplex mode, hence there
69are no
70.Xr ifmedia 4
71modes to select.
72.Pp
73For more information on configuring this device, see
74.Xr ifconfig 8 .
75.Sh HARDWARE
76The
77.Nm
78driver supports CATC USB-EL1210A based USB Ethernet
79adapters including:
80.Pp
81.Bl -bullet -compact
82.It
83Belkin F5U011/F5U111
84.It
85CATC Netmate
86.It
87CATC Netmate II
88.It
89SmartBridges SmartLink
90.El
91.Sh DIAGNOSTICS
92.Bl -diag
93.It "cue%d: watchdog timeout"
94A packet was queued for transmission and a transmit command was
95issued, however the device failed to acknowledge the transmission
96before a timeout expired.
97.It "cue%d: no memory for rx list"
98The driver failed to allocate an mbuf for the receiver ring.
99.El
100.Sh SEE ALSO
101.Xr arp 4 ,
102.Xr ifmedia 4 ,
103.Xr netintro 4 ,
104.Xr ng_ether 4 ,
105.Xr usb 4 ,
106.Xr ifconfig 8
107.Sh HISTORY
108The
109.Nm
110device driver first appeared in
111.Fx 4.0 .
112.Sh AUTHORS
113The
114.Nm
115driver was written by
116.An Bill Paul Aq Mt wpaul@ee.columbia.edu .
117