Updated documentation for 0.7 release
[acer_acpi.git] / README
blob0a3f740121403cda69611daacfdf4b7a9d9ee3da
1 This is acer_acpi version 0.6
3 ### THIS IS VERY MUCH A WORK IN PROGRESS.  NO WARRANTY GIVEN.  IF YOU
4 ### BREAK YOUR LAPTOP USING THIS DRIVER, YOU GET TO KEEP THE PIECES AND
5 ### I WILL ACCEPT ABSOLUTELY NO RESPONSIBILITY.
7 acer_acpi is a driver to allow you to control various aspects of your Acer
8 laptop hardware using the proc filesystem.  It was originally developed in
9 order to activate the wireless LAN card under a 64-bit version of Linux,
10 as acerhk[1] (the previous fine solution to the problem) relied on making BIOS
11 calls which are not allowed from a 64-bit OS.
13 Please read the INSTALL file for installation instructions.
15 PLEASE NOTE: I (Mark Smith) AM NO LONGER ACTIVELY DEVELOPING ACER_ACPI.
16 (many would note that I never actively developed it! :-)
18 acer_acpi is now being maintained by Carlos Corbacho <cathectic@gmail.com>
20 [1] acerhk: http://www.cakey.de/acerhk/
22 Usage
23 *****
25 As root, modprobe acer_acpi
27 (To enable debugging, add debug=X, where X is between 0 and 2).
29 acer_acpi creates entries under /proc/acpi/acer, which enables you to control
30 some of the following (varies between models):
32 * the wireless LAN card
33 * inbuilt Bluetooth adapter
34 * mail LED of your laptop
35 * brightness of the LCD panel
37 The syntax for each is the same:
39 PLEASE NOTE: "enabled: X" is _deprecated_ - it will be dropped from 0.7
41 To enable a feature:
42 echo 1 > /proc/acpi/acer/{feature}
44 To disable a feature:
45 echo 0 > /proc/acpi/acer/{feature}
47 To enable a feature on loading the module:
48 modprobe acer_acpi {feature}=1
50 To disable a feature on loading the module (default):
51 modprobe acer_acpi {feature}=0
53 Where {feature} is either wireless, bluetooth, 3G, or mailled. (You can have 
54 multiple {feature}'s specified on the modprobe line).
56 For WMID laptops with a "brightness" option, you can write a value between 0 to
57 15 (or 0x0 to 0xF).
59 To enable support for 3G devices on WMID, you will need to edit acer_acpi.c and 
60 replace:
62 #undef EXPERIMENTAL_INTERFACES
64 with
66 #define EXPERIMENTAL_INTERFACES
68 (If you have the hardware to test this with, please report back the results)
70 Notes
71 *****
73 The behaviour of the wireless LED will depend on your hardware and driver
74 combination.
76 e.g. With the BCM4318 on the 5020 series:
78 ndiswrapper: Light blinks on when transmitting
79 bcm43xx/ 
80 bcm43xx_mac80211: Solid light, blinks off when transmitting
82 Also, acer_acpi does not yet have any means of deciding whether to
83 enable or disable entries in /proc/acpi/acer - this means that for
84 hardware that isn't there, you can still read/ write the corresponding proc
85 file.
87 So: Just because it _says_ Bluetooth in /proc/acpi/acer, doesn't mean 
88 you now actually have a Bluetooth device.
90 Also: We do not store the status of the device when you hibernate. On AMW0,
91 this will cause incorrect values to be returned from /proc (this is a known
92 issue and is being worked on).
94 Credits
95 *******
97 Olaf Tauber, who did the real hard work when he developed acerhk
98 http://www.informatik.hu-berlin.de/~tauber/acerhk
99 All the authors of laptop acpi modules in the kernel, whose work
100 was an inspiration and a source of good code, particularly John Belmonte,
101 author of the toshiba_acpi driver.
102 Mathieu Segaud, who solved the problem with having to modprobe the driver
103 twice in version 0.2 and below.
104 Jim Ramsay, who added support for the new WMID interface
106 Contact
107 *******
109 If you have problems with the driver, please file a bug on the website and
110 include the following information:
111 1. name of your laptop (e.g. Acer Aspire 5021)
112 2. contents of your ACPI DSDT (this will require acpidump).  I can disassemble
113    it if necessary, so I'll accept the binaries.
115 Please check http://code.google.com/p/aceracpi/wiki/SupportedHardware first to
116 see if your hardware is supported or unsupported.
118 The latest version of acer_acpi can be found here:
120 http://code.google.com/p/aceracpi