USB: cxacru: add write-only sysfs attribute for modem configuration
[linux-2.6-block.git] / Documentation / networking / cxacru.txt
CommitLineData
64b85006
SA
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
4ac37208
SA
18* adsl_config
19 Configuration writing interface.
20 Write parameters in hexadecimal format <index>=<value>,
21 separated by whitespace, e.g.:
22 "1=0 a=5"
23 Up to 7 parameters at a time will be sent and the modem will restart
24 the ADSL connection when any value is set. These are logged for future
25 reference.
26
64b85006
SA
27* downstream_attenuation (dB)
28* downstream_bits_per_frame
29* downstream_rate (kbps)
30* downstream_snr_margin (dB)
31 Downstream stats.
32
33* upstream_attenuation (dB)
34* upstream_bits_per_frame
35* upstream_rate (kbps)
36* upstream_snr_margin (dB)
37* transmitter_power (dBm/Hz)
38 Upstream stats.
39
40* downstream_crc_errors
41* downstream_fec_errors
42* downstream_hec_errors
43* upstream_crc_errors
44* upstream_fec_errors
45* upstream_hec_errors
46 Error counts.
47
48* line_startable
49 Indicates that ADSL support on the device
50 is/can be enabled, see adsl_start.
51
52* line_status
53 "initialising"
54 "down"
55 "attempting to activate"
56 "training"
57 "channel analysis"
58 "exchange"
59 "waiting"
60 "up"
61
62 Changes between "down" and "attempting to activate"
63 if there is no signal.
64
65* link_status
66 "not connected"
67 "connected"
68 "lost"
69
70* mac_address
71
72* modulation
1bfbd283 73 "" (when not connected)
64b85006
SA
74 "ANSI T1.413"
75 "ITU-T G.992.1 (G.DMT)"
76 "ITU-T G.992.2 (G.LITE)"
77
78* startup_attempts
79 Count of total attempts to initialise ADSL.
80
81To enable/disable ADSL, the following can be written to the adsl_state file:
82 "start"
83 "stop
84 "restart" (stops, waits 1.5s, then starts)
85 "poll" (used to resume status polling if it was disabled due to failure)
86
87Changes in adsl/line state are reported via kernel log messages:
88 [4942145.150704] ATM dev 0: ADSL state: running
89 [4942243.663766] ATM dev 0: ADSL line: down
90 [4942249.665075] ATM dev 0: ADSL line: attempting to activate
91 [4942253.654954] ATM dev 0: ADSL line: training
92 [4942255.666387] ATM dev 0: ADSL line: channel analysis
93 [4942259.656262] ATM dev 0: ADSL line: exchange
94 [2635357.696901] ATM dev 0: ADSL line: up (8128 kb/s down | 832 kb/s up)