acer_acpi - Fix setting backlight on AMW0 V1
[acer_acpi.git] / README
blobadfa0f2c53deefa524cbe5ff30d95906602aa14b
1 This is acer_acpi version 0.11
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 <carlos@strangeworlds.co.uk>
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 (This will also load the module 'wmi-acer', which is responsible for converting
27 ACPI-WMI calls to ACPI calls).
29 acer_acpi creates entries under /proc/acpi/acer (deprecated),
30 /sys/devices/platform/acer_acpi, /sys/class/backlight (2.6.20 and above only)
31 and /sys/class/led, which enables you to control some of the following (varies
32 between models):
34 * the wireless LAN card
35 * inbuilt Bluetooth adapter
36 * mail LED of your laptop
37 * brightness of the LCD panel
39 The entries for each device will only be created if the device exists on your
40 system.
42 The syntax for each is the same:
44 PLEASE NOTE: "enabled: X" support has now been removed
46 To read the status of a device (0=off, 1=on):
47 cat /proc/acpi/acer/{device}
49 cat /sys/devices/platform/acer_acpi/{device}
51 To enable a feature:
52 echo 1 > /proc/acpi/acer/{feature}
54 echo 1 > /sys/devices/platform/acer_acpi/{device}
56 To disable a feature:
57 echo 0 > /proc/acpi/acer/{feature}
58 echo 0 > /sys/devices/platform/acer_acpi/{device}
60 (brightness and mail LED are not visible in /sys/devices/platform - these are
61 properly registered with the relevant kernel subsystem).
63 To enable a feature on loading the module:
64 modprobe acer_acpi {feature}=1
66 To disable a feature on loading the module (default):
67 modprobe acer_acpi {feature}=0
69 Where {feature} is either wireless, bluetooth, 3G, or mailled. (You can have
70 multiple {feature}'s specified on the modprobe line).
72 For laptops with a "brightness" option, you can write a value between 0 to 9 or
73 15 (or 0x0 to 0x9 or 0xF - the maximum brightness varies between laptops).
75 Notes
76 *****
78 The behaviour of the wireless LED will depend on your hardware and driver
79 combination.
81 e.g. With the BCM4318 on the 5020 series:
83 ndiswrapper: Light blinks on when transmitting
84 bcm43xx/b43: Solid light, blinks off when transmitting
86 Credits
87 *******
89 Olaf Tauber, who did the real hard work when he developed acerhk
90 http://www.informatik.hu-berlin.de/~tauber/acerhk
91 All the authors of laptop acpi modules in the kernel, whose work
92 was an inspiration and a source of good code, particularly John Belmonte,
93 author of the toshiba_acpi driver.
94 Mathieu Segaud, who solved the problem with having to modprobe the driver
95 twice in version 0.2 and below.
96 Jim Ramsay, who added support for the new WMID interface
98 Contact
99 *******
101 If you have problems with the driver, please file a bug on the website and
102 include the following information:
103 1. name of your laptop (e.g. Acer Aspire 5021)
104 2. contents of your ACPI DSDT (cat /proc/acpi/dsdt).  I can disassemble
105    it if necessary, so I'll accept the binaries.
107 Please check http://code.google.com/p/aceracpi/wiki/SupportedHardware first to
108 see if your hardware is supported or unsupported.
110 The latest version of acer_acpi can be found here:
112 http://code.google.com/p/aceracpi