0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003 ========================
0004 ATM cxacru device driver
0005 ========================
0006
0007 Firmware is required for this device: http://accessrunner.sourceforge.net/
0008
0009 While it is capable of managing/maintaining the ADSL connection without the
0010 module loaded, the device will sometimes stop responding after unloading the
0011 driver and it is necessary to unplug/remove power to the device to fix this.
0012
0013 Note: support for cxacru-cf.bin has been removed. It was not loaded correctly
0014 so it had no effect on the device configuration. Fixing it could have stopped
0015 existing devices working when an invalid configuration is supplied.
0016
0017 There is a script cxacru-cf.py to convert an existing file to the sysfs form.
0018
0019 Detected devices will appear as ATM devices named "cxacru". In /sys/class/atm/
0020 these are directories named cxacruN where N is the device number. A symlink
0021 named device points to the USB interface device's directory which contains
0022 several sysfs attribute files for retrieving device statistics:
0023
0024 * adsl_controller_version
0025
0026 * adsl_headend
0027 * adsl_headend_environment
0028
0029 - Information about the remote headend.
0030
0031 * adsl_config
0032
0033 - Configuration writing interface.
0034 - Write parameters in hexadecimal format <index>=<value>,
0035 separated by whitespace, e.g.:
0036
0037 "1=0 a=5"
0038
0039 - Up to 7 parameters at a time will be sent and the modem will restart
0040 the ADSL connection when any value is set. These are logged for future
0041 reference.
0042
0043 * downstream_attenuation (dB)
0044 * downstream_bits_per_frame
0045 * downstream_rate (kbps)
0046 * downstream_snr_margin (dB)
0047
0048 - Downstream stats.
0049
0050 * upstream_attenuation (dB)
0051 * upstream_bits_per_frame
0052 * upstream_rate (kbps)
0053 * upstream_snr_margin (dB)
0054 * transmitter_power (dBm/Hz)
0055
0056 - Upstream stats.
0057
0058 * downstream_crc_errors
0059 * downstream_fec_errors
0060 * downstream_hec_errors
0061 * upstream_crc_errors
0062 * upstream_fec_errors
0063 * upstream_hec_errors
0064
0065 - Error counts.
0066
0067 * line_startable
0068
0069 - Indicates that ADSL support on the device
0070 is/can be enabled, see adsl_start.
0071
0072 * line_status
0073
0074 - "initialising"
0075 - "down"
0076 - "attempting to activate"
0077 - "training"
0078 - "channel analysis"
0079 - "exchange"
0080 - "waiting"
0081 - "up"
0082
0083 Changes between "down" and "attempting to activate"
0084 if there is no signal.
0085
0086 * link_status
0087
0088 - "not connected"
0089 - "connected"
0090 - "lost"
0091
0092 * mac_address
0093
0094 * modulation
0095
0096 - "" (when not connected)
0097 - "ANSI T1.413"
0098 - "ITU-T G.992.1 (G.DMT)"
0099 - "ITU-T G.992.2 (G.LITE)"
0100
0101 * startup_attempts
0102
0103 - Count of total attempts to initialise ADSL.
0104
0105 To enable/disable ADSL, the following can be written to the adsl_state file:
0106
0107 - "start"
0108 - "stop
0109 - "restart" (stops, waits 1.5s, then starts)
0110 - "poll" (used to resume status polling if it was disabled due to failure)
0111
0112 Changes in adsl/line state are reported via kernel log messages::
0113
0114 [4942145.150704] ATM dev 0: ADSL state: running
0115 [4942243.663766] ATM dev 0: ADSL line: down
0116 [4942249.665075] ATM dev 0: ADSL line: attempting to activate
0117 [4942253.654954] ATM dev 0: ADSL line: training
0118 [4942255.666387] ATM dev 0: ADSL line: channel analysis
0119 [4942259.656262] ATM dev 0: ADSL line: exchange
0120 [2635357.696901] ATM dev 0: ADSL line: up (8128 kb/s down | 832 kb/s up)
