.TH udsl "4" "January 2004" "udsl 2004-01-18" "System Commands"
.\" Copyright 2004 Peter G..
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
.SH NAME
udsl \- driver for ADSL USB modems based on the Conexant
AccessRunner chipset
.SH SYNOPSIS
.na
.B udsl
.RB [ speed= [ 0 | 1 ]]
.RB [ open= \c
.IR mode ]
.RS 2m
.RB [ num_rcv_urbs= \c
.IR nru ]
.RB [ num_snd_urbs= \c
.IR nsu ]
.RB [ num_rcv_bufs= \c
.IR nrrbu ]
.RB [ num_snd_bufs= \c
.IR nsb ]
.RB [ rcv_buf_size= \c
.IR sbs ]
.RB [ snd_buf_size= \c
.IR rbs ]
.RE
.ad
.SH DESCRIPTION
.I udsl
is a driver for a number of ADSL USB modems based on the Conexant
AccessRunner chipset.
.LP
These modems are essentially USB to ATM network interfaces; the driver's
role is to transfer packets it reads over the USB bus from the modem to
the kernel's ATM subsystem and viceversa.
.LP
The driver also offers a few commands via
.IR ioctl (2)
to query or change the state of the modem.
.LP
The driver does not load the firmware or setup the modem, for this you
you need the
.IR udslctl (8)
utility, which also allows you to issue the
.IR ioctl (2)
commands supported by the driver.
.SH OPTIONS
.TP
.B speed
When this option is set to
.B 0
the driver will operate in normal speed mode, when set to
.B 1
it will operate in higher speed mode. In normal speed mode it can
collect some extra statistics.
.TP
.B mode
The value assigned to this option is ignored.
.TP
.B num_rcv_urbs
Number of urbs used for reception.
.TP
.B num_snd_urbs
Number of urbs used for transmission.
.TP
.B num_rcv_bufs
Number of buffers used for reception.
.TP
.B num_snd_bufs
Number of buffers used for transmission.
.TP
.B rcv_buf_size
Size of the buffers used for reception.
.TP
.B snd_buf_size
Size of the buffers used for transmission.
.SH USE
Usually the driver will be installed as a module, and loaded into the
kernel with a command like:
.RS 2m
.B modprobe udsl speed=0
.RE
.LP
Usually the driver will require loading also the
.B atm
and
.B pppoatm
modules too. The
.B atm
module will usually be loaded automagically, but the
.B ppptoatm
module will usually have to be loaded manually.
.LP
A typical sequence for bringing up a connection is:
.LP
.RS 2m
.nf
.B "udslctl -v -m auto-G.HS -f /usr/local/lib/cxfirm5.bin --init"
.B "modprobe ppp pppoatm"
.B "modprobe udsl"
.B "udslctl --atm-on"
.BI "pppd defaultroute name " user " plugin pppoatm.so " vpi . vci
.fi
.RE
.SH BUGS
.LP
The
.IR ioctl(2)
interface is a bit haphazard.
.LP
The modem can only be initialized when the driver is not loaded, which
means that it can only be used as a module.
.LP
The statistics available from the
.B /proc
files are a bit sparse.
.SH NOTES
This driver used to be called
.BR xdslusb .
.SH SEE ALSO
.nf
.IR udslcxa (4)
.IR udslctl (8)
.B http://AccessRunner.SourceForge.net/
.B http://SpeedTouch.SourceForge.net/
.fi
.SH AUTHORS
.nf
Johan Verrept and collaborators.
Josep Comas and collaborators.