Merge rewrite branch, prepare for 0.9 release
[acer_acpi.git] / README
blob274185845522a661861a1ff9bffc9626f38262eb
1 This is acer_acpi version 0.9.0
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 by Mark
9 Smith, in order to activate the wireless LAN card under a 64-bit version of
10 Linux, as acerhk[1] (the previous fine solution to the problem) relied on making
11 BIOS calls which are not allowed from a 64-bit OS.
13 Please read the INSTALL file for installation instructions.
15 acer_acpi is now being maintained by Carlos Corbacho <cathectic@gmail.com>
17 [1] acerhk: http://www.cakey.de/acerhk/
19 Usage
20 *****
22 As root, modprobe acer_acpi
24 (To enable debugging, add debug=X, where X is between 0 and 2).
26 acer_acpi creates entries under /proc/acpi/acer (deprecated),
27 /sys/devices/platform/acer_acpi, /sys/class/backlight (2.6.20 and above only)
28 and /sys/class/led, which enables you to control some of the following (varies
29 between models):
31 * the wireless LAN card
32 * inbuilt Bluetooth adapter
33 * mail LED of your laptop
34 * brightness of the LCD panel
36 The syntax for each is the same:
38 PLEASE NOTE: "enabled: X" support has now been removed
40 To read the status of a device (0=off, 1=on):
41 cat /proc/acpi/acer/{device}
43 cat /sys/devices/platform/acer_acpi/{device}
45 To enable a feature:
46 echo 1 > /proc/acpi/acer/{feature}
48 echo 1 > /sys/devices/platform/acer_acpi/{device}
50 To disable a feature:
51 echo 0 > /proc/acpi/acer/{feature}
52 echo 0 > /sys/devices/platform/acer_acpi/{device}
54 (brightness and mail LED are not visible in /sys/devices/platform - these are
55 properly registered with the relevant kernel subsystem).
57 To enable a feature on loading the module:
58 modprobe acer_acpi {feature}=1
60 To disable a feature on loading the module (default):
61 modprobe acer_acpi {feature}=0
63 Where {feature} is either wireless, bluetooth, 3G, or mailled. (You can have 
64 multiple {feature}'s specified on the modprobe line).
66 For laptops with a "brightness" option, you can write a value between 0 to 15 
67 (or 0x0 to 0xF).
69 Notes
70 *****
72 The behaviour of the wireless LED will depend on your hardware and driver
73 combination.
75 e.g. With the BCM4318 on the 5020 series:
77 ndiswrapper: Light blinks on when transmitting
78 bcm43xx/b43: Solid light, blinks off when transmitting
80 Also, acer_acpi does not yet have any means of deciding whether to
81 enable or disable entries in proc or sysfs - this means that for
82 hardware that isn't there, you can still read/ write the corresponding file.
84 So: Just because it _says_ "bluetooth" in /proc/acpi/acer, doesn't mean 
85 you now actually have a Bluetooth device.
87 Credits
88 *******
90 Olaf Tauber, who did the real hard work when he developed acerhk
91 http://www.informatik.hu-berlin.de/~tauber/acerhk
92 All the authors of laptop acpi modules in the kernel, whose work
93 was an inspiration and a source of good code, particularly John Belmonte,
94 author of the toshiba_acpi driver.
95 Mathieu Segaud, who solved the problem with having to modprobe the driver
96 twice in version 0.2 and below.
97 Jim Ramsay, who added support for the new WMID interface
99 Contact
100 *******
102 If you have problems with the driver, please file a bug on the website and
103 include the following information:
104 1. name of your laptop (e.g. Acer Aspire 5021)
105 2. contents of your ACPI DSDT (cat /proc/acpi/dsdt).  I can disassemble
106    it if necessary, so I'll accept the binaries.
108 Please check http://code.google.com/p/aceracpi/wiki/SupportedHardware first to
109 see if your hardware is supported or unsupported.
111 The latest version of acer_acpi can be found here:
113 http://code.google.com/p/aceracpi