aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/networking
diff options
context:
space:
mode:
authorSimon Arlott <simon@fire.lp0.eu>2007-05-11 02:04:09 -0400
committerGreg Kroah-Hartman <gregkh@suse.de>2007-06-08 19:24:31 -0400
commit64b85006f5d473fefc181dece9473710b55966e0 (patch)
treed02b0aa670fe3f50398477c684931e8c67c5a9fc /Documentation/networking
parent67fa10627ec0d8aa16f1cf38cf527e67d8097d3c (diff)
USB: cxacru: add Documentation file
The sysfs attributes for exposing cxacru statistics/status information with possible values is now explained in Documentation/networking/cxacru.txt including information on the writable adsl_state attribute's commands and a sample of the kernel log format. Signed-off-by: Simon Arlott <simon@fire.lp0.eu> Cc: Duncan Sands <duncan.sands@math.u-psud.fr> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'Documentation/networking')
-rw-r--r--Documentation/networking/00-INDEX2
-rw-r--r--Documentation/networking/cxacru.txt84
2 files changed, 86 insertions, 0 deletions
diff --git a/Documentation/networking/00-INDEX b/Documentation/networking/00-INDEX
index e06b6e3c1db5..153d84d281e6 100644
--- a/Documentation/networking/00-INDEX
+++ b/Documentation/networking/00-INDEX
@@ -32,6 +32,8 @@ cops.txt
32 - info on the COPS LocalTalk Linux driver 32 - info on the COPS LocalTalk Linux driver
33cs89x0.txt 33cs89x0.txt
34 - the Crystal LAN (CS8900/20-based) Ethernet ISA adapter driver 34 - the Crystal LAN (CS8900/20-based) Ethernet ISA adapter driver
35cxacru.txt
36 - Conexant AccessRunner USB ADSL Modem
35de4x5.txt 37de4x5.txt
36 - the Digital EtherWORKS DE4?? and DE5?? PCI Ethernet driver 38 - the Digital EtherWORKS DE4?? and DE5?? PCI Ethernet driver
37decnet.txt 39decnet.txt
diff --git a/Documentation/networking/cxacru.txt b/Documentation/networking/cxacru.txt
new file mode 100644
index 000000000000..b074681a963e
--- /dev/null
+++ b/Documentation/networking/cxacru.txt
@@ -0,0 +1,84 @@
1Firmware is required for this device: http://accessrunner.sourceforge.net/
2
3While it is capable of managing/maintaining the ADSL connection without the
4module loaded, the device will sometimes stop responding after unloading the
5driver and it is necessary to unplug/remove power to the device to fix this.
6
7Detected devices will appear as ATM devices named "cxacru". In /sys/class/atm/
8these are directories named cxacruN where N is the device number. A symlink
9named device points to the USB interface device's directory which contains
10several 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
71To 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
77Changes 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)