releases/upstream/2.6.30-rc1/0005-thinkpad-acpi-documentation-cleanup.patch

   1 From 078ac19ed8f476a7c2d729712e15f5ab516ff491 Mon Sep 17 00:00:00 2001
   2 From: Henrique de Moraes Holschuh <hmh@hmh.eng.br>
   3 Date: Sat, 4 Apr 2009 04:25:44 +0000
   4 Subject: thinkpad-acpi: documentation cleanup
   5
   6 Some cleanups to the documentation of the driver.
   7
   8 Signed-off-by: Henrique de Moraes Holschuh <hmh@hmh.eng.br>
   9 Signed-off-by: Len Brown <len.brown@intel.com>
  10 ---
  11  Documentation/laptops/thinkpad-acpi.txt |   76 +++++++++++++++++++++----------
  12  1 files changed, 52 insertions(+), 24 deletions(-)
  13
  14 diff --git a/Documentation/laptops/thinkpad-acpi.txt b/Documentation/laptops/thinkpad-acpi.txt
  15 index 41bc99f..f6e6bc6 100644
  16 --- a/Documentation/laptops/thinkpad-acpi.txt
  17 +++ b/Documentation/laptops/thinkpad-acpi.txt
  18 @@ -20,7 +20,8 @@ moved to the drivers/misc tree and renamed to thinkpad-acpi for kernel
  19  kernel 2.6.29 and release 0.22.
  20
  21  The driver is named "thinkpad-acpi".  In some places, like module
  22 -names, "thinkpad_acpi" is used because of userspace issues.
  23 +names and log messages, "thinkpad_acpi" is used because of userspace
  24 +issues.
  25
  26  "tpacpi" is used as a shorthand where "thinkpad-acpi" would be too
  27  long due to length limitations on some Linux kernel versions.
  28 @@ -37,7 +38,7 @@ detailed description):
  29         - ThinkLight on and off
  30         - limited docking and undocking
  31         - UltraBay eject
  32 -       - CMOS control
  33 +       - CMOS/UCMS control
  34         - LED control
  35         - ACPI sounds
  36         - temperature sensors
  37 @@ -46,6 +47,7 @@ detailed description):
  38         - Volume control
  39         - Fan control and monitoring: fan speed, fan enable/disable
  40         - WAN enable and disable
  41 +       - UWB enable and disable
  42
  43  A compatibility table by model and feature is maintained on the web
  44  site, http://ibm-acpi.sf.net/. I appreciate any success or failure
  45 @@ -53,7 +55,7 @@ reports, especially if they add to or correct the compatibility table.
  46  Please include the following information in your report:
  47
  48         - ThinkPad model name
  49 -       - a copy of your DSDT, from /proc/acpi/dsdt
  50 +       - a copy of your ACPI tables, using the "acpidump" utility
  51         - a copy of the output of dmidecode, with serial numbers
  52           and UUIDs masked off
  53         - which driver features work and which don't
  54 @@ -66,17 +68,18 @@ Installation
  55  ------------
  56
  57  If you are compiling this driver as included in the Linux kernel
  58 -sources, simply enable the CONFIG_THINKPAD_ACPI option, and optionally
  59 -enable the CONFIG_THINKPAD_ACPI_BAY option if you want the
  60 -thinkpad-specific bay functionality.
  61 +sources, look for the CONFIG_THINKPAD_ACPI Kconfig option.
  62 +It is located on the menu path: "Device Drivers" -> "X86 Platform
  63 +Specific Device Drivers" -> "ThinkPad ACPI Laptop Extras".
  64 +
  65
  66  Features
  67  --------
  68
  69  The driver exports two different interfaces to userspace, which can be
  70  used to access the features it provides.  One is a legacy procfs-based
  71 -interface, which will be removed at some time in the distant future.
  72 -The other is a new sysfs-based interface which is not complete yet.
  73 +interface, which will be removed at some time in the future.  The other
  74 +is a new sysfs-based interface which is not complete yet.
  75
  76  The procfs interface creates the /proc/acpi/ibm directory.  There is a
  77  file under that directory for each feature it supports.  The procfs
  78 @@ -111,15 +114,17 @@ The version of thinkpad-acpi's sysfs interface is exported by the driver
  79  as a driver attribute (see below).
  80
  81  Sysfs driver attributes are on the driver's sysfs attribute space,
  82 -for 2.6.23 this is /sys/bus/platform/drivers/thinkpad_acpi/ and
  83 +for 2.6.23+ this is /sys/bus/platform/drivers/thinkpad_acpi/ and
  84  /sys/bus/platform/drivers/thinkpad_hwmon/
  85
  86  Sysfs device attributes are on the thinkpad_acpi device sysfs attribute
  87 -space, for 2.6.23 this is /sys/devices/platform/thinkpad_acpi/.
  88 +space, for 2.6.23+ this is /sys/devices/platform/thinkpad_acpi/.
  89
  90  Sysfs device attributes for the sensors and fan are on the
  91  thinkpad_hwmon device's sysfs attribute space, but you should locate it
  92 -looking for a hwmon device with the name attribute of "thinkpad".
  93 +looking for a hwmon device with the name attribute of "thinkpad", or
  94 +better yet, through libsensors.
  95 +
  96
  97  Driver version
  98  --------------
  99 @@ -129,6 +134,7 @@ sysfs driver attribute: version
 100
 101  The driver name and version. No commands can be written to this file.
 102
 103 +
 104  Sysfs interface version
 105  -----------------------
 106
 107 @@ -160,6 +166,7 @@ expect that an attribute might not be there, and deal with it properly
 108  (an attribute not being there *is* a valid way to make it clear that a
 109  feature is not available in sysfs).
 110
 111 +
 112  Hot keys
 113  --------
 114
 115 @@ -618,6 +625,7 @@ For Lenovo models *with* ACPI backlight control:
 116     and map them to KEY_BRIGHTNESS_UP and KEY_BRIGHTNESS_DOWN.  Process
 117     these keys on userspace somehow (e.g. by calling xbacklight).
 118
 119 +
 120  Bluetooth
 121  ---------
 122
 123 @@ -628,6 +636,9 @@ sysfs rfkill class: switch "tpacpi_bluetooth_sw"
 124  This feature shows the presence and current state of a ThinkPad
 125  Bluetooth device in the internal ThinkPad CDC slot.
 126
 127 +If the ThinkPad supports it, the Bluetooth state is stored in NVRAM,
 128 +so it is kept across reboots and power-off.
 129 +
 130  Procfs notes:
 131
 132  If Bluetooth is installed, the following commands can be used:
 133 @@ -652,6 +663,7 @@ Sysfs notes:
 134         rfkill controller switch "tpacpi_bluetooth_sw": refer to
 135         Documentation/rfkill.txt for details.
 136
 137 +
 138  Video output control -- /proc/acpi/ibm/video
 139  --------------------------------------------
 140
 141 @@ -693,11 +705,8 @@ Fn-F7 from working. This also disables the video output switching
 142  features of this driver, as it uses the same ACPI methods as
 143  Fn-F7. Video switching on the console should still work.
 144
 145 -UPDATE: There's now a patch for the X.org Radeon driver which
 146 -addresses this issue. Some people are reporting success with the patch
 147 -while others are still having problems. For more information:
 148 +UPDATE: refer to https://bugs.freedesktop.org/show_bug.cgi?id=2000
 149
 150 -https://bugs.freedesktop.org/show_bug.cgi?id=2000
 151
 152  ThinkLight control
 153  ------------------
 154 @@ -720,10 +729,11 @@ The ThinkLight sysfs interface is documented by the LED class
 155  documentation, in Documentation/leds-class.txt.  The ThinkLight LED name
 156  is "tpacpi::thinklight".
 157
 158 -Due to limitations in the sysfs LED class, if the status of the thinklight
 159 +Due to limitations in the sysfs LED class, if the status of the ThinkLight
 160  cannot be read or if it is unknown, thinkpad-acpi will report it as "off".
 161  It is impossible to know if the status returned through sysfs is valid.
 162
 163 +
 164  Docking / undocking -- /proc/acpi/ibm/dock
 165  ------------------------------------------
 166
 167 @@ -784,6 +794,7 @@ the only docking stations currently supported are the X-series
 168  UltraBase docks and "dumb" port replicators like the Mini Dock (the
 169  latter don't need any ACPI support, actually).
 170
 171 +
 172  UltraBay eject -- /proc/acpi/ibm/bay
 173  ------------------------------------
 174
 175 @@ -847,8 +858,9 @@ supported. Use "eject2" instead of "eject" for the second bay.
 176  Note: the UltraBay eject support on the 600e/x, A22p and A3x is
 177  EXPERIMENTAL and may not work as expected. USE WITH CAUTION!
 178
 179 -CMOS control
 180 -------------
 181 +
 182 +CMOS/UCMS control
 183 +-----------------
 184
 185  procfs: /proc/acpi/ibm/cmos
 186  sysfs device attribute: cmos_command
 187 @@ -882,6 +894,7 @@ The cmos command interface is prone to firmware split-brain problems, as
 188  in newer ThinkPads it is just a compatibility layer.  Do not use it, it is
 189  exported just as a debug tool.
 190
 191 +
 192  LED control
 193  -----------
 194
 195 @@ -939,6 +952,7 @@ ThinkPad indicator LED should blink in hardware accelerated mode, use the
 196  "timer" trigger, and leave the delay_on and delay_off parameters set to
 197  zero (to request hardware acceleration autodetection).
 198
 199 +
 200  ACPI sounds -- /proc/acpi/ibm/beep
 201  ----------------------------------
 202
 203 @@ -968,6 +982,7 @@ X40:
 204         16 - one medium-pitched beep repeating constantly, stop with 17
 205         17 - stop 16
 206
 207 +
 208  Temperature sensors
 209  -------------------
 210
 211 @@ -1115,6 +1130,7 @@ registers contain the current battery capacity, etc. If you experiment
 212  with this, do send me your results (including some complete dumps with
 213  a description of the conditions when they were taken.)
 214
 215 +
 216  LCD brightness control
 217  ----------------------
 218
 219 @@ -1124,10 +1140,9 @@ sysfs backlight device "thinkpad_screen"
 220  This feature allows software control of the LCD brightness on ThinkPad
 221  models which don't have a hardware brightness slider.
 222
 223 -It has some limitations: the LCD backlight cannot be actually turned on or
 224 -off by this interface, and in many ThinkPad models, the "dim while on
 225 -battery" functionality will be enabled by the BIOS when this interface is
 226 -used, and cannot be controlled.
 227 +It has some limitations: the LCD backlight cannot be actually turned
 228 +on or off by this interface, it just controls the backlight brightness
 229 +level.
 230
 231  On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control
 232  has eight brightness levels, ranging from 0 to 7.  Some of the levels
 233 @@ -1201,6 +1216,7 @@ WARNING:
 234      and maybe reduce the life of the backlight lamps by needlessly kicking
 235      its level up and down at every change.
 236
 237 +
 238  Volume control -- /proc/acpi/ibm/volume
 239  ---------------------------------------
 240
 241 @@ -1217,6 +1233,11 @@ distinct. The unmute the volume after the mute command, use either the
 242  up or down command (the level command will not unmute the volume).
 243  The current volume level and mute state is shown in the file.
 244
 245 +The ALSA mixer interface to this feature is still missing, but patches
 246 +to add it exist.  That problem should be addressed in the not so
 247 +distant future.
 248 +
 249 +
 250  Fan control and monitoring: fan speed, fan enable/disable
 251  ---------------------------------------------------------
 252
 253 @@ -1383,8 +1404,11 @@ procfs: /proc/acpi/ibm/wan
 254  sysfs device attribute: wwan_enable (deprecated)
 255  sysfs rfkill class: switch "tpacpi_wwan_sw"
 256
 257 -This feature shows the presence and current state of a W-WAN (Sierra
 258 -Wireless EV-DO) device.
 259 +This feature shows the presence and current state of the built-in
 260 +Wireless WAN device.
 261 +
 262 +If the ThinkPad supports it, the WWAN state is stored in NVRAM,
 263 +so it is kept across reboots and power-off.
 264
 265  It was tested on a Lenovo ThinkPad X60. It should probably work on other
 266  ThinkPad models which come with this module installed.
 267 @@ -1413,6 +1437,7 @@ Sysfs notes:
 268         rfkill controller switch "tpacpi_wwan_sw": refer to
 269         Documentation/rfkill.txt for details.
 270
 271 +
 272  EXPERIMENTAL: UWB
 273  -----------------
 274
 275 @@ -1431,6 +1456,7 @@ Sysfs notes:
 276         rfkill controller switch "tpacpi_uwb_sw": refer to
 277         Documentation/rfkill.txt for details.
 278
 279 +
 280  Multiple Commands, Module Parameters
 281  ------------------------------------
 282
 283 @@ -1445,6 +1471,7 @@ for example:
 284
 285         modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
 286
 287 +
 288  Enabling debugging output
 289  -------------------------
 290
 291 @@ -1467,6 +1494,7 @@ The level of debugging information output by the driver can be changed
 292  at runtime through sysfs, using the driver attribute debug_level.  The
 293  attribute takes the same bitmask as the debug module parameter above.
 294
 295 +
 296  Force loading of module
 297  -----------------------
 298
 299 --
 300 1.6.2.1
 301