.TH udslctl "8" "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
udslctl \- control the operation of the \fBudsl\fR modem drivers
.SH SYNOPSIS
.B udslctl
.BR - [ hV ]
.br
.B udslctl
.BR - [ Dv ]
.RB [ -m
.IR mode ]
.RB [ -f
.IR firmware ]
.B -i
.RI [ modemno ]
.br
.B udslctl
.BR - [ v ]
.BR - [ laAIsSxXz ]
.RI [ modemno ]
.SH DESCRIPTION
.I udslctl
controls the operation of one of the
.I udsl
family of drivers for ADSL USB modems, usually based on the 
Conexant AccessRunner chipset.
.LP
The only argument that the command can have, and it is optional, is
.I modemno
which is the cardinal number of the supported modem. You can use the
.B -l
option to list the supported modems present on your system and their
cardinal numbers. Usually there will be only one of them, and it will
be number 0, and that's the default, so the modem number can be omitted.
.SH OPTIONS
.TP
.BR -h | --help
Just print some helpful information on the command syntax.
.TP
.BR -V | --version
Just print the version of the command.
.TP
.BR -v | --verbose
Perform its operation with greater verbosity.
.TP
.BR -m | --mode " \fImode\fP"
If the
.B --initialize
option is given, initialize the ADSL line
using the handshake
.IR mode .
The mode can be one of:
.B auto-G.HS
(automatic negotiation, preferring G.Handshake),
.B auto-T1.143
(automatic negotiation, preferring ANSI T1.143),
.B G.HS
(G.Handshake),
.B T1.413
(ANSI T1.413),
.B G.DMT
(G.handshake or G.DMT)
.B G.Lite
(G.handshake or G.Lite). The default is
.BR "auto-G.HS" .
.TP
.BR -f | --firmware " \fIfirmware\fP"
Use the file
.I firmware
to initialize the modem if the
.B --initialize
option is given. If this option is not specified, a system
and modem dependent file is autoselected.
.TP
.BR -i | --initialize
Initialize the modem, by loading firmware and making it handshake with
the DSLAM.
.TP
.BR -a | --atm-on
Enable the driver, that is let ATM cells flow betwen the modem and the
kernel's ATM subsystem. It is similar in function to
.BI ifconfig " if"
.BR up .
.TP
.BR -A | --atm-off
Tell the driver to stop passing ATM cells between the modem and the
kernel's ATM subsystem. It is similar in function to
.BI ifconfig " if"
.BR down .
.TP
.BR -I | --info
Print various bits of information, including statistics.
Extra statistics will be printed if available (see option
Not all drivers return information.
.BR -n ).
.TP
.BR -s | --adsl-on
Start the ADSL line and try to connect to the DSLAM.
.TP
.BR -S | --adsl-off
Stop the ADSL line and break the connection to the DSLAM.
.TP
.BR -x | --extra-on
Start collecting some extra information on the connection.
This can only be enabled if the modem driver is in normal,
not high, speed mode.
.TP
.BR -X | --extra-off
Stop collecting the extra information on the connection.
.TP
.BR -z | --zero
Reset to zero some of the statistics counters.
.SH USE
This command is used to control an USB XDSL modem driver, usually
the
.B udslcxa
.RB ( cxacru )
or
.B udsl
.RB ( xdslusb )
ones.
.LP
Usually it is needed at least twice: before loading the driver to load
the modem's firmware, which also enables the ADSL connection, with
option
.BR --initialize ,
and after the driver is loaded to enable the ATM connection, with option
.BR --atm-on.
After this one might want to switch off the ADSL and/or the ATM
connections, and to swtich them on again, or to check the status of the
modem and associated connection, with option
.BR --info .
.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 udslcxa"
.B "udslctl --atm-on"
.BI "pppd defaultroute name " user " plugin pppoatm.so " vpi . vci
.B "udslctl --info"
.fi
.RE
.SH EXAMPLES
.TP
.B "udslctl --list"
List the available, supported modems: \c
.TP
.B "udslctl -v -m G.DMT --init"
Initialize the default modem, with verbose progress messages, and with
the ADSL line protocol being full G.DMT. 
.TP
.B "udslctl --info"
Print information about the modem, the ATM connection and the xDSL connection.
.TP
.B "udslctl --atm-on"
Tell the driver to activate the modem with respect to the kernel's ATM
subsystem. After this it possible to initiate an ATM connection to the
DSLAM.
.TP
.B "udslctl --info"
Print the status of the modem, of the ATM connection, and of the ADSL link.
.fi
.SH BUGS
There are going to be some.
.SH SEE ALSO
.nf
.IR udsl (4)
.IR udslcxa (4)
.B http://AccessRunner.SourceForge.net/
.fi
.SH AUTHORS
.nf
Peter G.
.fi