summaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
authorDamien Bergamini <damien@cvs.openbsd.org>2005-04-16 14:55:11 +0000
committerDamien Bergamini <damien@cvs.openbsd.org>2005-04-16 14:55:11 +0000
commit291c8f565a8265a970ea5c13f4fd28c60b35c9ab (patch)
tree5dd7e68ab8f9c2532e8cc46c496251654e30adf1 /share/man
parent134ff4e75d9718004af8606850074df5a52017a4 (diff)
Driver for Analog Devices Eagle chipset.
ok deraadt@
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/Makefile4
-rw-r--r--share/man/man4/ueagle.4108
2 files changed, 110 insertions, 2 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index e98e8732eef..cfff15a71e2 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.293 2005/04/14 20:33:24 brad Exp $
+# $OpenBSD: Makefile,v 1.294 2005/04/16 14:55:04 damien Exp $
MAN= aac.4 ac97.4 acphy.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 ahd.4 \
aic.4 amdpm.4 ami.4 amphy.4 an.4 aria.4 ast.4 atalk.4 \
@@ -30,7 +30,7 @@ MAN= aac.4 ac97.4 acphy.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 ahd.4 \
systrace.4 tb.4 tcic.4 tcp.4 termios.4 ti.4 tl.4 \
tlphy.4 tqphy.4 trm.4 tty.4 tun.4 twe.4 tx.4 txp.4 \
txphy.4 uaudio.4 ubsa.4 ubsec.4 ubt.4 ucom.4 udav.4 udp.4 udsbr.4 \
- uftdi.4 ugen.4 uhci.4 uhid.4 uhidev.4 uk.4 ukbd.4 \
+ ueagle.4 uftdi.4 ugen.4 uhci.4 uhid.4 uhidev.4 uk.4 ukbd.4 \
ukphy.4 ulpt.4 umass.4 umct.4 umidi.4 umodem.4 ums.4 \
unix.4 upl.4 uplcom.4 urio.4 url.4 urlphy.4 usb.4 \
uscanner.4 usscanner.4 uvisor.4 uvscom.4 uyap.4 vga.4 vge.4 \
diff --git a/share/man/man4/ueagle.4 b/share/man/man4/ueagle.4
new file mode 100644
index 00000000000..f67eed8ac38
--- /dev/null
+++ b/share/man/man4/ueagle.4
@@ -0,0 +1,108 @@
+.\" $OpenBSD: ueagle.4,v 1.1 2005/04/16 14:55:04 damien Exp $
+.\"
+.\" Copyright (c) 2003-2005
+.\" Damien Bergamini <damien.bergamini@free.fr>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd April 16, 2005
+.Os
+.Dt UEAGLE 4
+.Sh NAME
+.Nm ueagle
+.Nd Analog Devices Eagle chipset driver
+.Sh SYNOPSIS
+.Cd "ueagle* at uhub? port ?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for USB ADSL modems based on the Analog Devices Eagle
+chipset (revision I, II and III).
+.Pp
+The
+.Nm
+driver can only manage a single ATM AAL5 virtual circuit. The segmentation and
+reassembly (SAR) of ATM cells is done by software.
+.Pp
+To achieve high rate downstream transfer with fast ADSL connections, the
+.Nm
+driver uses USB isochronous pipes instead of standard bulk pipes.
+.Sh HARDWARE
+The following modems should work:
+.Pp
+.\" .Bl -tag -width Ds -offset indent -compact
+.Bl -column "Modem " "Chip" -compact -offset 6n
+.It Em "Modem Chip"
+.It Li "Aethra Starmodem" Ta Eagle II
+.It Li "Allied Telesyn AT-AR215" Ta Eagle I
+.It Li "Arescom NDS1060" Ta Eagle II
+.It Li "Aztech 206U" Ta Eagle II
+.It Li "Comtrend CT-350" Ta Eagle I
+.It Li "Comtrend CT-361" Ta Eagle I
+.It Li "D-Link DSL-200I" Ta Eagle I
+.It Li "ECI B-FOCuS USB 150" Ta Eagle II
+.It Li "Elcon 111U" Ta Eagle II
+.It Li "Elcon 131U" Ta Eagle II
+.It Li "ELSA MicroLink ADSL FUN USB" Ta Eagle I
+.It Li "Huawei SmartAX MT810" Ta Eagle II
+.It Li "Sagem F@st 800" Ta Eagle I
+.It Li "Sagem F@st 800 PE/E2" Ta Eagle II
+.It Li "Sagem F@st 800 E3" Ta Eagle III
+.It Li "Sagem F@st 908" Ta Eagle I
+.It Li "Teledat 300 USB" Ta Eagle I
+.It Li "Telindus ND 220" Ta Eagle II
+.It Li "Telindus ND 220b" Ta Eagle II
+.It Li "US Robotics USR9000" Ta Eagle I
+.El
+.Sh FILES
+The adapter needs some firmware files, which are loaded on demand:
+.Pp
+.Bl -tag -width Ds -offset indent -compact
+.It /etc/firmware/ueagleI
+.It /etc/firmware/ueagleII
+.It /etc/firmware/ueagleIII
+.It /etc/firmware/ueagle-dsp
+.El
+.Sh EXAMPLES
+To establish a PVC (vpi=8, vci=35, vcmux) with host 192.168.1.2:
+.Bd -literal -offset indent
+# route add -iface 192.168.1.2 -link ueagle0:1.8.0.23
+.Ed
+.Pp
+To establish a PVC (vpi=0, vci=6, llc/snap) with host 192.168.1.3:
+.Bd -literal -offset indent
+# route add -iface 192.168.1.3 -link ueagle0:3.0.0.6
+.Ed
+.Sh SEE ALSO
+.Xr uhub 4 ,
+.Xr usb 4
+.Rs
+.%T The uEagle Web Page
+.%O http://damien.bergamini.free.fr/ueagle/
+.Re
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 3.8 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Damien Bergamini Aq damien@openbsd.org .
+.Sh CAVEATS
+The
+.Nm
+driver only supports ADSL over POTS. ADSL over ISDN is not supported.
+G.Lite modulation (aka splitterless) has never been tested and probably won't
+work.