Documentation/hwmon/lis3lv02d

   1 Kernel driver lis3lv02d
   2 =======================
   3
   4 Supported chips:
   5
   6   * STMicroelectronics LIS3LV02DL, LIS3LV02DQ (12 bits precision)
   7   * STMicroelectronics LIS302DL, LIS3L02DQ, LIS331DL (8 bits)
   8
   9 Authors:
  10         Yan Burman <burman.yan@gmail.com>
  11         Eric Piel <eric.piel@tremplin-utc.net>
  12
  13
  14 Description
  15 -----------
  16
  17 This driver provides support for the accelerometer found in various HP laptops
  18 sporting the feature officially called "HP Mobile Data Protection System 3D" or
  19 "HP 3D DriveGuard". It detects automatically laptops with this sensor. Known
  20 models (full list can be found in drivers/hwmon/hp_accel.c) will have their
  21 axis automatically oriented on standard way (eg: you can directly play
  22 neverball). The accelerometer data is readable via
  23 /sys/devices/platform/lis3lv02d.
  24
  25 Sysfs attributes under /sys/devices/platform/lis3lv02d/:
  26 position - 3D position that the accelerometer reports. Format: "(x,y,z)"
  27 calibrate - read: values (x, y, z) that are used as the base for input
  28                   class device operation.
  29             write: forces the base to be recalibrated with the current
  30                    position.
  31 rate - reports the sampling rate of the accelerometer device in HZ
  32
  33 This driver also provides an absolute input class device, allowing
  34 the laptop to act as a pinball machine-esque joystick.
  35
  36 On HP laptops, if the led infrastructure is activated, support for a led
  37 indicating disk protection will be provided as /sys/class/leds/hp::hddprotect.
  38
  39 Another feature of the driver is misc device called "freefall" that
  40 acts similar to /dev/rtc and reacts on free-fall interrupts received
  41 from the device. It supports blocking operations, poll/select and
  42 fasync operation modes. You must read 1 bytes from the device.  The
  43 result is number of free-fall interrupts since the last successful
  44 read (or 255 if number of interrupts would not fit). See the hpfall.c
  45 file for an example on using the device.
  46
  47
  48 Axes orientation
  49 ----------------
  50
  51 For better compatibility between the various laptops. The values reported by
  52 the accelerometer are converted into a "standard" organisation of the axes
  53 (aka "can play neverball out of the box"):
  54  * When the laptop is horizontal the position reported is about 0 for X and Y
  55         and a positive value for Z
  56  * If the left side is elevated, X increases (becomes positive)
  57  * If the front side (where the touchpad is) is elevated, Y decreases
  58         (becomes negative)
  59  * If the laptop is put upside-down, Z becomes negative
  60
  61 If your laptop model is not recognized (cf "dmesg"), you can send an
  62 email to the maintainer to add it to the database.  When reporting a new
  63 laptop, please include the output of "dmidecode" plus the value of
  64 /sys/devices/platform/lis3lv02d/position in these four cases.
  65
  66 Q&A
  67 ---
  68
  69 Q: How do I safely simulate freefall? I have an HP "portable
  70 workstation" which has about 3.5kg and a plastic case, so letting it
  71 fall to the ground is out of question...
  72
  73 A: The sensor is pretty sensitive, so your hands can do it. Lift it
  74 into free space, follow the fall with your hands for like 10
  75 centimeters. That should be enough to trigger the detection.