[PATCH 5/9] USB: cxacru: add Documentation file
From: Greg Kroah-Hartman
Date: Fri Jun 08 2007 - 20:05:29 EST
From: Simon Arlott <simon@xxxxxxxxxxx>
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@xxxxxxxxxxx>
Cc: Duncan Sands <duncan.sands@xxxxxxxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
Signed-off-by: Greg Kroah-Hartman <gregkh@xxxxxxx>
Documentation/networking/00-INDEX | 2 +
Documentation/networking/cxacru.txt | 84 +++++++++++++++++++++++++++++++++++
2 files changed, 86 insertions(+), 0 deletions(-)
create mode 100644 Documentation/networking/cxacru.txt
diff --git a/Documentation/networking/00-INDEX b/Documentation/networking/00-INDEX
index e06b6e3..153d84d 100644
@@ -32,6 +32,8 @@ cops.txt
- info on the COPS LocalTalk Linux driver
- the Crystal LAN (CS8900/20-based) Ethernet ISA adapter driver
+ - Conexant AccessRunner USB ADSL Modem
- the Digital EtherWORKS DE4?? and DE5?? PCI Ethernet driver
diff --git a/Documentation/networking/cxacru.txt b/Documentation/networking/cxacru.txt
new file mode 100644
@@ -0,0 +1,84 @@
+Firmware is required for this device: http://accessrunner.sourceforge.net/
+While it is capable of managing/maintaining the ADSL connection without the
+module loaded, the device will sometimes stop responding after unloading the
+driver and it is necessary to unplug/remove power to the device to fix this.
+Detected devices will appear as ATM devices named "cxacru". In /sys/class/atm/
+these are directories named cxacruN where N is the device number. A symlink
+named device points to the USB interface device's directory which contains
+several sysfs attribute files for retrieving device statistics:
+ Information about the remote headend.
+* downstream_attenuation (dB)
+* downstream_rate (kbps)
+* downstream_snr_margin (dB)
+ Downstream stats.
+* upstream_attenuation (dB)
+* upstream_rate (kbps)
+* upstream_snr_margin (dB)
+* transmitter_power (dBm/Hz)
+ Upstream stats.
+ Error counts.
+ Indicates that ADSL support on the device
+ is/can be enabled, see adsl_start.
+ "attempting to activate"
+ "channel analysis"
+ Changes between "down" and "attempting to activate"
+ if there is no signal.
+ "not connected"
+ "ANSI T1.413"
+ "ITU-T G.992.1 (G.DMT)"
+ "ITU-T G.992.2 (G.LITE)"
+ Count of total attempts to initialise ADSL.
+To enable/disable ADSL, the following can be written to the adsl_state file:
+ "restart" (stops, waits 1.5s, then starts)
+ "poll" (used to resume status polling if it was disabled due to failure)
+Changes in adsl/line state are reported via kernel log messages:
+ [4942145.150704] ATM dev 0: ADSL state: running
+ [4942243.663766] ATM dev 0: ADSL line: down
+ [4942249.665075] ATM dev 0: ADSL line: attempting to activate
+ [4942253.654954] ATM dev 0: ADSL line: training
+ [4942255.666387] ATM dev 0: ADSL line: channel analysis
+ [4942259.656262] ATM dev 0: ADSL line: exchange
+ [2635357.696901] ATM dev 0: ADSL line: up (8128 kb/s down | 832 kb/s up)
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/