README

   1 This is acer_acpi version 0.10
   2
   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.
   6
   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.
  12
  13 Please read the INSTALL file for installation instructions.
  14
  15 acer_acpi is now being maintained by Carlos Corbacho <cathectic@gmail.com>
  16
  17 [1] acerhk: http://www.cakey.de/acerhk/
  18
  19 Usage
  20 *****
  21
  22 As root, modprobe acer_acpi
  23
  24 (To enable debugging, add debug=X, where X is between 0 and 2).
  25
  26 (This will also load the module 'wmi-acer', which is responsible for converting
  27 WMI-ACPI calls to ACPI calls).
  28
  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):
  33
  34 * the wireless LAN card
  35 * inbuilt Bluetooth adapter
  36 * mail LED of your laptop
  37 * brightness of the LCD panel
  38
  39 The syntax for each is the same:
  40
  41 PLEASE NOTE: "enabled: X" support has now been removed
  42
  43 To read the status of a device (0=off, 1=on):
  44 cat /proc/acpi/acer/{device}
  45 or
  46 cat /sys/devices/platform/acer_acpi/{device}
  47
  48 To enable a feature:
  49 echo 1 > /proc/acpi/acer/{feature}
  50 or
  51 echo 1 > /sys/devices/platform/acer_acpi/{device}
  52
  53 To disable a feature:
  54 echo 0 > /proc/acpi/acer/{feature}
  55 echo 0 > /sys/devices/platform/acer_acpi/{device}
  56
  57 (brightness and mail LED are not visible in /sys/devices/platform - these are
  58 properly registered with the relevant kernel subsystem).
  59
  60 To enable a feature on loading the module:
  61 modprobe acer_acpi {feature}=1
  62
  63 To disable a feature on loading the module (default):
  64 modprobe acer_acpi {feature}=0
  65
  66 Where {feature} is either wireless, bluetooth, 3G, or mailled. (You can have
  67 multiple {feature}'s specified on the modprobe line).
  68
  69 For laptops with a "brightness" option, you can write a value between 0 to 15
  70 (or 0x0 to 0xF).
  71
  72 Notes
  73 *****
  74
  75 The behaviour of the wireless LED will depend on your hardware and driver
  76 combination.
  77
  78 e.g. With the BCM4318 on the 5020 series:
  79
  80 ndiswrapper: Light blinks on when transmitting
  81 bcm43xx/b43: Solid light, blinks off when transmitting
  82
  83 Also, acer_acpi does not yet have any means of deciding whether to
  84 enable or disable entries in proc or sysfs - this means that for
  85 hardware that isn't there, you can still read/ write the corresponding file.
  86
  87 So: Just because it _says_ "bluetooth" in /proc/acpi/acer, doesn't mean
  88 you now actually have a Bluetooth device.
  89
  90 Credits
  91 *******
  92
  93 Olaf Tauber, who did the real hard work when he developed acerhk
  94 http://www.informatik.hu-berlin.de/~tauber/acerhk
  95 All the authors of laptop acpi modules in the kernel, whose work
  96 was an inspiration and a source of good code, particularly John Belmonte,
  97 author of the toshiba_acpi driver.
  98 Mathieu Segaud, who solved the problem with having to modprobe the driver
  99 twice in version 0.2 and below.
 100 Jim Ramsay, who added support for the new WMID interface
 101
 102 Contact
 103 *******
 104
 105 If you have problems with the driver, please file a bug on the website and
 106 include the following information:
 107 1. name of your laptop (e.g. Acer Aspire 5021)
 108 2. contents of your ACPI DSDT (cat /proc/acpi/dsdt).  I can disassemble
 109    it if necessary, so I'll accept the binaries.
 110
 111 Please check http://code.google.com/p/aceracpi/wiki/SupportedHardware first to
 112 see if your hardware is supported or unsupported.
 113
 114 The latest version of acer_acpi can be found here:
 115
 116 http://code.google.com/p/aceracpi