From 3bae022a7617a0306134fc811b307be27d128a9a Mon Sep 17 00:00:00 2001 From: Carlos Corbacho Date: Fri, 6 Jul 2007 00:21:06 +0000 Subject: [PATCH] Updated documentation for 0.7 release --- ChangeLog | 13 ++++--- NEWS | 5 +-- README | 120 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 132 insertions(+), 6 deletions(-) create mode 100644 README diff --git a/ChangeLog b/ChangeLog index 079a83c..d548263 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,11 +1,16 @@ -2007-??-?? Version 0.6 +2007-07-06 Version 0.6 * Ran code through lindent (Kernel coding style) -* Simplified write_{feature} method calls +* Deprecated "enabled : X" - "X" will now just work -* Patched Makefile to stop complaining on kernels 2.6.17 - (Thanks to Subbu) +* Patched Makefile to stop complaining on kernels <= 2.6.17 + (thanks to Subbu) + +* Added support for new "WMID" interface (thanks to Jim Ramsay) + +* Rewrote backend code for all interfaces and /proc (thanks to + Jim Ramsay) 2007-05-05 Version 0.5 diff --git a/NEWS b/NEWS index 7f2043f..4d7c6b0 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,6 @@ -200?-??-?? Version 0.6 - Cleaned up code in line with kernel coding conventions +2007-07-06 Version 0.6 + Cleaned up code + Added WMID support Makefile no longer gives harmless errors on older 2.6 kernels 2007-05-05 Version 0.5 diff --git a/README b/README new file mode 100644 index 0000000..0a3f740 --- /dev/null +++ b/README @@ -0,0 +1,120 @@ +This is acer_acpi version 0.6 + +### THIS IS VERY MUCH A WORK IN PROGRESS. NO WARRANTY GIVEN. IF YOU +### BREAK YOUR LAPTOP USING THIS DRIVER, YOU GET TO KEEP THE PIECES AND +### I WILL ACCEPT ABSOLUTELY NO RESPONSIBILITY. + +acer_acpi is a driver to allow you to control various aspects of your Acer +laptop hardware using the proc filesystem. It was originally developed in +order to activate the wireless LAN card under a 64-bit version of Linux, +as acerhk[1] (the previous fine solution to the problem) relied on making BIOS +calls which are not allowed from a 64-bit OS. + +Please read the INSTALL file for installation instructions. + +PLEASE NOTE: I (Mark Smith) AM NO LONGER ACTIVELY DEVELOPING ACER_ACPI. +(many would note that I never actively developed it! :-) + +acer_acpi is now being maintained by Carlos Corbacho + +[1] acerhk: http://www.cakey.de/acerhk/ + +Usage +***** + +As root, modprobe acer_acpi + +(To enable debugging, add debug=X, where X is between 0 and 2). + +acer_acpi creates entries under /proc/acpi/acer, which enables you to control +some of the following (varies between models): + +* the wireless LAN card +* inbuilt Bluetooth adapter +* mail LED of your laptop +* brightness of the LCD panel + +The syntax for each is the same: + +PLEASE NOTE: "enabled: X" is _deprecated_ - it will be dropped from 0.7 + +To enable a feature: +echo 1 > /proc/acpi/acer/{feature} + +To disable a feature: +echo 0 > /proc/acpi/acer/{feature} + +To enable a feature on loading the module: +modprobe acer_acpi {feature}=1 + +To disable a feature on loading the module (default): +modprobe acer_acpi {feature}=0 + +Where {feature} is either wireless, bluetooth, 3G, or mailled. (You can have +multiple {feature}'s specified on the modprobe line). + +For WMID laptops with a "brightness" option, you can write a value between 0 to +15 (or 0x0 to 0xF). + +To enable support for 3G devices on WMID, you will need to edit acer_acpi.c and +replace: + +#undef EXPERIMENTAL_INTERFACES + +with + +#define EXPERIMENTAL_INTERFACES + +(If you have the hardware to test this with, please report back the results) + +Notes +***** + +The behaviour of the wireless LED will depend on your hardware and driver +combination. + +e.g. With the BCM4318 on the 5020 series: + +ndiswrapper: Light blinks on when transmitting +bcm43xx/ +bcm43xx_mac80211: Solid light, blinks off when transmitting + +Also, acer_acpi does not yet have any means of deciding whether to +enable or disable entries in /proc/acpi/acer - this means that for +hardware that isn't there, you can still read/ write the corresponding proc +file. + +So: Just because it _says_ Bluetooth in /proc/acpi/acer, doesn't mean +you now actually have a Bluetooth device. + +Also: We do not store the status of the device when you hibernate. On AMW0, +this will cause incorrect values to be returned from /proc (this is a known +issue and is being worked on). + +Credits +******* + +Olaf Tauber, who did the real hard work when he developed acerhk +http://www.informatik.hu-berlin.de/~tauber/acerhk +All the authors of laptop acpi modules in the kernel, whose work +was an inspiration and a source of good code, particularly John Belmonte, +author of the toshiba_acpi driver. +Mathieu Segaud, who solved the problem with having to modprobe the driver +twice in version 0.2 and below. +Jim Ramsay, who added support for the new WMID interface + +Contact +******* + +If you have problems with the driver, please file a bug on the website and +include the following information: +1. name of your laptop (e.g. Acer Aspire 5021) +2. contents of your ACPI DSDT (this will require acpidump). I can disassemble + it if necessary, so I'll accept the binaries. + +Please check http://code.google.com/p/aceracpi/wiki/SupportedHardware first to +see if your hardware is supported or unsupported. + +The latest version of acer_acpi can be found here: + +http://code.google.com/p/aceracpi -- 2.11.4.GIT