Merge git://git.kernel.org/pub/scm/linux/kernel/git/sfrench/cifs-2.6
[linux-2.6] / Documentation / networking / cxacru.txt
1 Firmware is required for this device: http://accessrunner.sourceforge.net/
2
3 While it is capable of managing/maintaining the ADSL connection without the
4 module loaded, the device will sometimes stop responding after unloading the
5 driver and it is necessary to unplug/remove power to the device to fix this.
6
7 Detected devices will appear as ATM devices named "cxacru". In /sys/class/atm/
8 these are directories named cxacruN where N is the device number. A symlink
9 named device points to the USB interface device's directory which contains
10 several sysfs attribute files for retrieving device statistics:
11
12 * adsl_controller_version
13
14 * adsl_headend
15 * adsl_headend_environment
16         Information about the remote headend.
17
18 * downstream_attenuation (dB)
19 * downstream_bits_per_frame
20 * downstream_rate (kbps)
21 * downstream_snr_margin (dB)
22         Downstream stats.
23
24 * upstream_attenuation (dB)
25 * upstream_bits_per_frame
26 * upstream_rate (kbps)
27 * upstream_snr_margin (dB)
28 * transmitter_power (dBm/Hz)
29         Upstream stats.
30
31 * downstream_crc_errors
32 * downstream_fec_errors
33 * downstream_hec_errors
34 * upstream_crc_errors
35 * upstream_fec_errors
36 * upstream_hec_errors
37         Error counts.
38
39 * line_startable
40         Indicates that ADSL support on the device
41         is/can be enabled, see adsl_start.
42
43 * line_status
44         "initialising"
45         "down"
46         "attempting to activate"
47         "training"
48         "channel analysis"
49         "exchange"
50         "waiting"
51         "up"
52
53         Changes between "down" and "attempting to activate"
54         if there is no signal.
55
56 * link_status
57         "not connected"
58         "connected"
59         "lost"
60
61 * mac_address
62
63 * modulation
64         "ANSI T1.413"
65         "ITU-T G.992.1 (G.DMT)"
66         "ITU-T G.992.2 (G.LITE)"
67
68 * startup_attempts
69         Count of total attempts to initialise ADSL.
70
71 To enable/disable ADSL, the following can be written to the adsl_state file:
72         "start"
73         "stop
74         "restart" (stops, waits 1.5s, then starts)
75         "poll" (used to resume status polling if it was disabled due to failure)
76
77 Changes in adsl/line state are reported via kernel log messages:
78         [4942145.150704] ATM dev 0: ADSL state: running
79         [4942243.663766] ATM dev 0: ADSL line: down
80         [4942249.665075] ATM dev 0: ADSL line: attempting to activate
81         [4942253.654954] ATM dev 0: ADSL line: training
82         [4942255.666387] ATM dev 0: ADSL line: channel analysis
83         [4942259.656262] ATM dev 0: ADSL line: exchange
84         [2635357.696901] ATM dev 0: ADSL line: up (8128 kb/s down | 832 kb/s up)